Class to build a label field. More...

#include <MeshViz/graph/PoLabelField.h>

Inheritance diagram for PoLabelField:

Public Types
enum	Justification { LEFT , RIGHT , CENTER }

enum	VerticalJustification { TOP , CAP , HALF , BASE , BOTTOM }

enum	CoordinateType { COORDINATE_IN_DOMAIN , COORDINATE_IN_CURRENT_UNIT }
	Type of coordinates. More...

enum	ConcatType { STRING_BEFORE_VALUE , VALUE_BEFORE_STRING , STRING_ABOVE_VALUE , VALUE_ABOVE_STRING }
	Type of string concatenation. More...

Public Types inherited from PoBase
enum	UpdateMethodType { UPDATE_METHOD_IMMEDIATE , UPDATE_METHOD_ON_ACTION }
	Type of update method. More...

enum	NodeWriteFormat { FOLD_NODE_WRITE_FORMAT , UNFOLD_NODE_WRITE_FORMAT }
	Type of write format. More...

enum	TextType { SO_TEXT3 , SO_ANNO_TEXT3 }
	Type of Text. More...

typedef void	PoRebuildCB(void userData, PoBase base)

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance.

	PoLabelField ()
	Default constructor.

	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)
	Constructor.

void	setFormat (PbNumericDisplayFormat *format)
	Sets a reference to a PbNumericDisplayFormat object for the numeric display format for the values.

const PbNumericDisplayFormat *	getFormat () const
	Gets a reference to a PbNumericDisplayFormat object for the numeric display format for the values.

virtual void	rebuild ()
	Forces node-kit rebuilding.

Public Member Functions inherited from PoBase
void	setUpdateMethod (UpdateMethodType type)
	Sets scene graph update method.

UpdateMethodType	getUpdateMethod () const
	Gets update method.

void	setDomain (PbDomain *dom)
	Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated.

const PbDomain *	getDomain () const
	Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated.

void	touchKit ()
	Indicates the node kit is modified.

SbBool	isModified () const
	Return TRUE, if the kit has been modified, else otherwise.

SbBool	isBuilt () const
	Indicates if the node kit has been built at least once.

void	addPreRebuildCallback (PoRebuildCB cb, void data)
	Add a callback function to call when the node kit is rebuilt.

void	addPostRebuildCallback (PoRebuildCB cb, void data)
	Add a callback function to call when the node kit is rebuilt.

void	removePreRebuildCallback (PoRebuildCB cb, void data=NULL)
	Remove a callback function to call when the node kit is rebuilt.

void	removePostRebuildCallback (PoRebuildCB cb, void data)
	Remove a callback function to call when the node kit is rebuilt.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Copy method.

virtual SbBool	affectsState () const
	See SoNode::affectsState() for explanations.

Public Member Functions inherited from SoBaseKit
	SoBaseKit ()
	Constructor.

virtual SoNode *	getPart (const SbName &partName, SbBool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

template<typename PartType >
PartType *	getPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.

template<typename PartType >
PartType *	checkPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.

SbString	getPartString (const SoBase *part)
	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.

virtual SoNodeKitPath *	createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.

virtual SbBool	setPart (const SbName &partName, SoNode *newPart)
	Inserts the given node (not a copy) as the new part specified by partName.

SoNONUNICODE SbBool	set (char *nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SbBool	set (const SbString &nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SoNONUNICODE SbBool	set (const char partNameString, const char parameterString)
	This function allows field values of parts (nodes) to be set.

SbBool	set (const SbString &partNameString, const SbString &parameterString)
	This function allows field values of parts (nodes) to be set.

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Public Member Functions inherited from SoGetView
	SoGetView ()
	Default constructor.

virtual	~SoGetView ()

virtual SbBool	getViewportIsEnabled () const
	Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.

virtual const SbVec2f	getViewportOrigin () const
	Returns SbViewportRegion origin.

virtual const SbVec2f	getViewportSize () const
	Returns SbViewportRegion size.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from PoGraphMaster
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from PoBase
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

static void	setNodeWriteFormat (NodeWriteFormat format)
	Sets the node write format.

static NodeWriteFormat	getNodeWriteFormat ()
	Gets the node write format.

static void	setTextType (TextType type)
	Sets the type of text used.

static TextType	getTextType ()
	Gets the type of text used.

static void	setVRML2Mode (SbBool flag)
	Set the VRML2 mode.

static SbBool	isVRML2Mode ()
	Gets the VRML2 mode (TRUE = VRML2 mode, FALSE Inventor mode)

Static Public Member Functions inherited from SoBaseKit
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.

static void	setSearchingChildren (SbBool newVal)
	Sets if nodekit children are searched during SoSearchAction traversal.

static SbBool	isSearchingChildren ()
	Returns TRUE if nodekit children are searched during SoSearchAction traversal.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoMFVec2f	point
	List of points which are the coordinates of the strings.

SoMFString	string
	List of strings to display.

SoMFFloat	value
	List of values to display.

SoSFEnum	concatType
	Concatenation type between values and strings.

SoSFFloat	fontSize
	Font size for strings to display.

SoSFEnum	justification
	Horizontal justification.

SoSFEnum	verticalJustification
	Vertical justification.

SoSFEnum	coordinateType
	Type of coordinates.

Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

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

AppearanceKit

appearance

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

Corresponds to the domain transformation.

Group

labelField

Contains a list of SoAnnoText3 shapes.

}

Definition at line 72 of file PoLabelField.h.

Member Enumeration Documentation

◆ ConcatType

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.

Definition at line 142 of file PoLabelField.h.

◆ CoordinateType

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.

Definition at line 128 of file PoLabelField.h.

◆ Justification

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.

Definition at line 83 of file PoLabelField.h.

◆ VerticalJustification

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.

Definition at line 100 of file PoLabelField.h.

Constructor & Destructor Documentation

◆ PoLabelField() [1/2]

PoLabelField::PoLabelField ( )

inline

Default constructor.

Definition at line 220 of file PoLabelField.h.

◆ PoLabelField() [2/2]

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.

Definition at line 227 of file PoLabelField.h.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoLabelField::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoLabelField::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getFormat()

const PbNumericDisplayFormat * PoLabelField::getFormat ( ) const

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

◆ getNodekitCatalog()

virtual const SoNodekitCatalog * PoLabelField::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

◆ getTypeId()

virtual SoType PoLabelField::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

◆ rebuild()

virtual void PoLabelField::rebuild ( )

virtual

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

◆ setFormat()

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

◆ concatType

SoSFEnum PoLabelField::concatType

Concatenation type between values and strings.

Definition at line 187 of file PoLabelField.h.

◆ coordinateType

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.

Definition at line 213 of file PoLabelField.h.

◆ fontSize

SoSFFloat PoLabelField::fontSize

Font size for strings to display.

Definition at line 192 of file PoLabelField.h.

◆ justification

SoSFEnum PoLabelField::justification

Horizontal justification.

Definition at line 197 of file PoLabelField.h.

◆ point

SoMFVec2f PoLabelField::point

List of points which are the coordinates of the strings.

Definition at line 168 of file PoLabelField.h.

◆ string

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.

Definition at line 174 of file PoLabelField.h.

◆ value

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.

Definition at line 182 of file PoLabelField.h.

◆ verticalJustification

SoSFEnum PoLabelField::verticalJustification

Vertical justification.

Use enum VerticalJustification.

Definition at line 203 of file PoLabelField.h.

The documentation for this class was generated from the following file:

MeshViz/graph/PoLabelField.h

Open Inventor Release 2024.2.1

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

CATALOG PARTS

Member Enumeration Documentation

◆ ConcatType

◆ CoordinateType

◆ Justification

◆ VerticalJustification

Constructor & Destructor Documentation

◆ PoLabelField() [1/2]

◆ PoLabelField() [2/2]

Member Function Documentation

◆ getClassNodekitCatalog()

◆ getClassTypeId()

◆ getFormat()

◆ getNodekitCatalog()

◆ getTypeId()

◆ rebuild()

◆ setFormat()

Member Data Documentation

◆ concatType

◆ coordinateType

◆ fontSize

◆ justification

◆ point

◆ string

◆ value

◆ verticalJustification