MoStringSet Class Reference

Property node that stores any kind of string set. More...

#include <MeshVizXLM/mapping/nodes/MoStringSet.h>

Inheritance diagram for MoStringSet:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	MoStringSet ()
	Constructor.
virtual void	setStringSet (const MiStringSet *StringSet)
	Provides a common interface for setting any string set type (MiStringSetI, MiStringSetIj or MiStringSetIjk) and marks the node as modified by calling touch().
virtual void	reset ()
	Reset the associated string set to null (as if setStringSet was called with null).
virtual const MiStringSet *	getStringSet ()
	Gets the associated string set interface.
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 MoActionNode
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.

Detailed Description

Property node that stores any kind of string set.

This node adds a reference to an object implementing the MiStringSetI, MiStringSetIj or MiStringSetIjk interface to the list of string sets in the traversal state.

Subsequent MoMeshCellShape instance will be able to use this string set. During traversal of the scene graph, MoStringSet nodes are accumulated into a list so that an extraction can use multiple string sets during the same computation.

Note:

• Any time the associated object MiStringSet is updated, touch() must also be called to mark the node as modified. In addition, MiStringSet::getTimeStamp() must return a different value than before to actually trigger a new rendering.

FILE FORMAT/DEFAULT

StringSet { }

ACTION BEHAVIOR

Adds a string set to the string set list. See MoStringSetElement.

SEE ALSO

MoStringSetElement, MiStringSetI, MiStringSetIj, MiStringSetIjk

Definition at line 63 of file MoStringSet.h.

Constructor & Destructor Documentation

MoStringSet()

MoStringSet::MoStringSet

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType MoStringSet::getClassTypeId ( )

static

Returns the type identifier for this class.

getStringSet()

virtual const MiStringSet * MoStringSet::getStringSet ( )

virtual

Gets the associated string set interface.

Use RTTI to find out which derived class it is.

getTypeId()

virtual SoType MoStringSet::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from MoActionNode.

reset()

virtual void MoStringSet::reset ( )

virtual

Reset the associated string set to null (as if setStringSet was called with null).

Marks the node as modified by calling touch()

setStringSet()

virtual void MoStringSet::setStringSet ( const MiStringSet *  StringSet )

virtual

Provides a common interface for setting any string set type (MiStringSetI, MiStringSetIj or MiStringSetIjk) and marks the node as modified by calling touch().

The given StringSet is checked to ensure that a required type is provided. If not, NULL is set instead.

Note

When setting a new string set, the MiStringSet::getTimeStamp() must return a different value than previously to actually take into account the change of string set.

---

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

• MeshVizXLM/mapping/nodes/MoStringSet.h