PoLabelField Class Reference
[Scatter]

Class to build a label field. More...

#include <MeshViz/graph/PoLabelField.h>

Inheritance diagram for PoLabelField:

List of all members.

Public Types
enum	Justification {   LEFT,   RIGHT,   CENTER }
enum	VerticalJustification {   TOP,   CAP,   HALF,   BASE,   BOTTOM }
enum	CoordinateType {   COORDINATE_IN_DOMAIN,   COORDINATE_IN_CURRENT_UNIT }
enum	ConcatType {   STRING_BEFORE_VALUE,   VALUE_BEFORE_STRING,   STRING_ABOVE_VALUE,   VALUE_ABOVE_STRING }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoLabelField ()
	PoLabelField (int numPoints, const SbVec2f *_point, const char **_string, const float *_value, float _fontSize, ConcatType type=STRING_BEFORE_VALUE, Justification _justification=LEFT, VerticalJustification _verticalJustification=BASE)
void	setFormat (PbNumericDisplayFormat *format)
const PbNumericDisplayFormat *	getFormat () const
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoMFVec2f	point
SoMFString	string
SoMFFloat	value
SoSFEnum	concatType
SoSFFloat	fontSize
SoSFEnum	justification
SoSFEnum	verticalJustification
SoSFEnum	coordinateType

---

Detailed Description

Class to build a label field.

Class to build a label field in the plane XY. This class represents a set of 2D points annotated by a string and a value.

All numerical values (if there are visible) depend on the current numerical display format. If the method setFormat(format) is called, the current numeric display format is "format". Otherwise the current numeric display format is specified in the current inherited state (cf property node PoNumericDisplayFormat).

FILE FORMAT/DEFAULT

PoLabelField {

point	0 0
string	""
value	0
concatType	STRING_BEFORE_VALUE
fontSize	1
justification	LEFT
verticalJustification	BASE
coordinateType	COORDINATE_IN_CURRENT_UNIT

}

CATALOG PARTS

PoLabelField {
Separator alternateRep (from PoBase) {

AppearanceKit appearance (from PoBase)
Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR and drawStyle.style=LINES.
font.size is set to the field fontSize.
MatrixTransform domainTransform (from PoBase)
Corresponds to the domain transformation.
Group labelField
Contains a list of SoAnnoText3 shapes.
}
}


---

Member Enumeration Documentation

enum PoLabelField::ConcatType

Type of string concatenation.

Enumerator:

STRING_BEFORE_VALUE	Strings are concatenated before values.
VALUE_BEFORE_STRING	Values are concatenated before strings.
STRING_ABOVE_VALUE	Strings are concatenated above values.
VALUE_ABOVE_STRING	Values are concatenated above strings.

enum PoLabelField::CoordinateType

Type of coordinates.

Enumerator:

COORDINATE_IN_DOMAIN	Coordinates are in the current domain.
COORDINATE_IN_CURRENT_UNIT	Coordinates are in current unit.

enum PoLabelField::Justification

Enumerator:

LEFT	Left edges of all string are aligned.
RIGHT	Right edges of all string are aligned.
CENTER	Centered of all strings are aligned.

enum PoLabelField::VerticalJustification

Enumerator:

TOP	Strings are aligned on the top of its characters.
CAP	Strings are aligned on the capital of its characters.
HALF	Strings are aligned on the half of its characters.
BASE	Strings are aligned on the base of its characters.
BOTTOM	Strings are aligned on the bottom of its characters.

---

Constructor & Destructor Documentation

PoLabelField::PoLabelField

(

)

[inline]

Default constructor.

PoLabelField::PoLabelField	(	int	numPoints,
		const SbVec2f *	_point,
		const char **	_string,
		const float *	_value,
		float	_fontSize,
		ConcatType	type = STRING_BEFORE_VALUE,
		Justification	_justification = LEFT,
		VerticalJustification	_verticalJustification = BASE
	)			[inline]

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoLabelField::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoGraphMaster.

static SoType PoLabelField::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoGraphMaster.

const PbNumericDisplayFormat* PoLabelField::getFormat

(

)

const

Gets a reference to a PbNumericDisplayFormat object for the numeric display format for the values.

virtual const SoNodekitCatalog* PoLabelField::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

virtual SoType PoLabelField::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

virtual void PoLabelField::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

void PoLabelField::setFormat

(

PbNumericDisplayFormat *

format

)

Sets a reference to a PbNumericDisplayFormat object for the numeric display format for the values.

If this method is not called (or called passing NULL as argument), this is the numeric display format defined in the current inherited state (defined with the property node PoNumericDisplayFormat) which is used.

---

Member Data Documentation

SoSFEnum PoLabelField::concatType

Concatenation type between values and strings.

SoSFEnum PoLabelField::coordinateType

Type of coordinates.

• coordinateType = COORDINATE_IN_DOMAIN: coordinates are expressed in the current domain (cf PoBase description),
• coordinateType = COORDINATE_IN_CURRENT_UNIT: coordinates are expressed in the current unit.

SoSFFloat PoLabelField::fontSize

Font size for strings to display.

SoSFEnum PoLabelField::justification

Horizontal justification.

SoMFVec2f PoLabelField::point

List of points which are the coordinates of the strings.

SoMFString PoLabelField::string

List of strings to display.

To be displayed, the number of strings must be equal to the number of points of point.

SoMFFloat PoLabelField::value

List of values to display.

The values are converted into strings according to the current numerical display format. To be displayed, the number of values must be equal to the number of points of point.

SoSFEnum PoLabelField::verticalJustification

Vertical justification.

Use enum VerticalJustification.

---

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