PoLabelHints Class Reference

Node to define common label hints. More...

#include <MeshViz/nodes/PoLabelHints.h>

Inheritance diagram for PoLabelHints:

Public Types
enum	LabelPath {   PATH_RIGHT ,   PATH_LEFT ,   PATH_UP ,   PATH_DOWN ,   PATH_DEPEND }
	Label path type. More...
enum	Justification {   LEFT ,   CENTER ,   RIGHT ,   DEPEND }
	Label justification type. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	PoLabelHints ()
	Constructor.
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 SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
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.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from PoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
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
SoSFEnum	labelPath
	Defines the path used to display label.
SoSFEnum	justification
	Defines the justification used to display label.
SoSFString	addString
	Defines a string to concat to the label to display.
SoSFBool	isLabelLineVisible
	Defines the visibility of a line from the label and the part to be annotated.

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

}

Definition at line 55 of file PoLabelHints.h.

Member Enumeration Documentation

Justification

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.

Definition at line 96 of file PoLabelHints.h.

LabelPath

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.

Definition at line 65 of file PoLabelHints.h.

Constructor & Destructor Documentation

PoLabelHints()

PoLabelHints::PoLabelHints

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType PoLabelHints::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType PoLabelHints::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoNode.

Member Data Documentation

addString

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.

Definition at line 137 of file PoLabelHints.h.

isLabelLineVisible

SoSFBool PoLabelHints::isLabelLineVisible

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

Definition at line 143 of file PoLabelHints.h.

justification

SoSFEnum PoLabelHints::justification

Defines the justification used to display label.

Definition at line 130 of file PoLabelHints.h.

labelPath

SoSFEnum PoLabelHints::labelPath

Defines the path used to display label.

Definition at line 125 of file PoLabelHints.h.

---

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

• MeshViz/nodes/PoLabelHints.h