PoLabelHints Class Reference
[Property]

Node to define common label hints. More...

#include <MeshViz/nodes/PoLabelHints.h>

Inheritance diagram for PoLabelHints:

List of all members.

Public Types
enum	LabelPath {   PATH_RIGHT,   PATH_LEFT,   PATH_UP,   PATH_DOWN,   PATH_DEPEND }
enum	Justification {   LEFT,   CENTER,   RIGHT,   DEPEND }
Public Member Functions
virtual SoType	getTypeId () const
	PoLabelHints ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFEnum	labelPath
SoSFEnum	justification
SoSFString	addString
SoSFBool	isLabelLineVisible

---

Detailed Description

Node to define common label hints.

This node defines the current hints to display label of all subsequent MeshViz representations inhering from PoChart.

FILE FORMAT/DEFAULT

PoLabelHints {

labelPath	DEPEND
justification	DEPEND
addString	""
isLabelLineVisible	FALSE

}

---

Member Enumeration Documentation

enum PoLabelHints::Justification

Label justification type.

Enumerator:

LEFT	Left edges of all labels are aligned.
CENTER	Centers of all labels are aligned.
RIGHT	Right edges of all labels are aligned.
DEPEND	Automatic choice of path depending on. the representation type which uses this node.

enum PoLabelHints::LabelPath

Label path type.

Enumerator:

PATH_RIGHT	Writing labels from left to right.
PATH_LEFT	Writing labels from right to left.
PATH_UP	Writing labels from bottom to top.
PATH_DOWN	Writing labels from top to bottom.
PATH_DEPEND	Automatic choice of writing path depending on. the representation type which uses this node.

---

Constructor & Destructor Documentation

PoLabelHints::PoLabelHints

(

)

Constructor.

---

Member Function Documentation

static SoType PoLabelHints::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoNode.

virtual SoType PoLabelHints::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoNode.

---

Member Data Documentation

SoSFString PoLabelHints::addString

Defines a string to concat to the label to display.

If you want to ignore the string to concat, remember to call the method setIgnored(TRUE) (method of SoField) on this field.

SoSFBool PoLabelHints::isLabelLineVisible

Defines the visibility of a line from the label and the part to be annotated.

SoSFEnum PoLabelHints::justification

Defines the justification used to display label.

SoSFEnum PoLabelHints::labelPath

Defines the path used to display label.

---

The documentation for this class was generated from the following file:
• MeshViz/nodes/PoLabelHints.h