SoMultiSwitch Class Reference

Group node that traverses a set of chosen children. More...

#include <Inventor/nodes/SoMultiSwitch.h>

Inheritance diagram for SoMultiSwitch:

Public Types
enum	TraversalMode {   NONE = 0 ,   ALL = 1 ,   INCLUDE = 2 ,   EXCLUDE = 3 }
	Traversal Mode enumerated values. More...
enum	InheritMode {   NO = 1 << 0 ,   MODE = 1 << 1 ,   LIST = 1 << 2 ,   ANY = MODE | LIST }
	Inheritance Mode enumerated values. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoMultiSwitch ()
	Creates a multi-switch node with default settings.
	SoMultiSwitch (int nChildren)
	Constructor that takes approximate number of children.
virtual SbBool	affectsState () const
	Overrides method in SoNode to return FALSE if there is no selected child or the selected child does not affect the state.
Public Member Functions inherited from SoGroup
	SoGroup ()
	Creates an empty group node.
	SoGroup (int nChildren)
	Constructor that takes approximate number of children.
virtual void	addChild (SoNode *child)
	Adds a child as last one in group.
virtual void	insertChild (SoNode *child, int newChildIndex)
	Adds a child so that it becomes the one with the given index.
virtual SoNode *	getChild (int index) const
	Returns pointer the child node with the given index.
virtual int	findChild (const SoNode *child) const
	Finds index of given child within group.
virtual int	getNumChildren () const
	Returns number of children.
virtual void	removeChild (int index)
	Removes child with given index from group.
virtual void	removeChild (SoNode *child)
	Removes first instance of given child from group.
virtual void	removeAllChildren ()
	Removes all children from group.
virtual void	replaceChild (int index, SoNode *newChild)
	Replaces child with given index with new child.
virtual void	replaceChild (SoNode *oldChild, SoNode *newChild)
	Replaces first instance of given child with new child.
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 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 SoGroup
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
SoMFInt32	whichChildren
	Indices of the children to traverse.
SoSFEnum	traversalMode
	Defines the way the children list must be managed.
SoSFEnum	inheritMode
	Defines the way this node inherit values from the state.
Public Attributes inherited from SoGroup
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Detailed Description

Group node that traverses a set of chosen children.

This group node traverses none, all or a specified list of its children. Effectively it is an extended version of the SoSwitch node.

The whichChildren field specifies a list of children (by index) to traverse, where the first child has index 0. The traversalMode field can specify to traverse none of the children, all of the children, the children in the list or all the children not in the list.

NOTES:

• Remember that the default value for traversalMode is NONE, meaning that nothing is displayed by default.
• Remember that this node is an SoGroup, NOT an SoSeparator, and therefore does not provide render caching. Generally if the children contain geometry, it is good practice to make each child an SoSeparator to make render caching more effective.

FILE FORMAT/DEFAULT

MultiSwitch {

whichChildren	[ ]
traversalMode	NONE
inherit	NO

}

ACTION BEHAVIOR

SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoHandleEventAction, SoRayPickAction
Traverses the chosen child or children. Sets: SoSwitchElement

SoSearchAction
If the action's Searching-All flag is set, always traverses all children. Otherwise, traverses just the chosen child or children.

SEE ALSO

SoArray, SoLevelOfDetail, SoMultipleCopy, SoPathSwitch, SoMultiPathSwitch, SoSwitch, SoInteractiveSwitch

Definition at line 83 of file SoMultiSwitch.h.

Member Enumeration Documentation

InheritMode

enum SoMultiSwitch::InheritMode

Inheritance Mode enumerated values.

Enumerator
NO	Current SoMultiSwitch node does not inherit its behavior from state value.
MODE	traversalMode field value is inherited from the state.
LIST	whichChildren field value is inherited from the state.
ANY	whichChildren and traversalMode fields values are inherited from the state.

Definition at line 113 of file SoMultiSwitch.h.

TraversalMode

enum SoMultiSwitch::TraversalMode

Traversal Mode enumerated values.

Enumerator
NONE	None of the children are traversed.
ALL	All the children are traversed.
INCLUDE	Traverse children defined by the whichChildren field.
EXCLUDE	Traverse all children except those defined by the whichChildren field.

Definition at line 94 of file SoMultiSwitch.h.

Constructor & Destructor Documentation

SoMultiSwitch() [1/2]

SoMultiSwitch::SoMultiSwitch

(

)

Creates a multi-switch node with default settings.

SoMultiSwitch() [2/2]

SoMultiSwitch::SoMultiSwitch

(

int

nChildren

)

Constructor that takes approximate number of children.

Member Function Documentation

affectsState()

virtual SbBool SoMultiSwitch::affectsState ( ) const

virtual

Overrides method in SoNode to return FALSE if there is no selected child or the selected child does not affect the state.

Reimplemented from SoNode.

getClassTypeId()

static SoType SoMultiSwitch::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoMultiSwitch::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoGroup.

Member Data Documentation

inheritMode

SoSFEnum SoMultiSwitch::inheritMode

Defines the way this node inherit values from the state.

Use enum InheritMode. Default is NO.

Definition at line 129 of file SoMultiSwitch.h.

traversalMode

SoSFEnum SoMultiSwitch::traversalMode

Defines the way the children list must be managed.

Use enum TraversalMode. Default is NONE.

Definition at line 110 of file SoMultiSwitch.h.

whichChildren

SoMFInt32 SoMultiSwitch::whichChildren

Indices of the children to traverse.

Default is empty.

Definition at line 91 of file SoMultiSwitch.h.

---

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

• Inventor/nodes/SoMultiSwitch.h