SoInteractiveSwitch Class Reference

Group node that traverses one chosen child depending on scene interaction. More...

#include <Inventor/nodes/SoInteractiveSwitch.h>

Inheritance diagram for SoInteractiveSwitch:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoInteractiveSwitch ()
	Creates an interactive-switch node with default settings.
	SoInteractiveSwitch (int nChildren)
	Constructor that takes approximate number of children.
virtual SbBool	affectsState () const
	Overrides method in SoSwitch to return FALSE if there is no selected child or the selected child does not affect the state.
Public Member Functions inherited from SoSwitch
	SoSwitch ()
	Creates a switch node with default settings.
	SoSwitch (int nChildren)
	Constructor that takes approximate number of children.
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 SoSwitch
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
SoSFInt32	whichInteractiveChild
	Index of the child to traverse during interaction, (or one of SO_SWITCH_NONE, SO_SWITCH_INHERIT, or SO_SWITCH_ALL).
Public Attributes inherited from SoSwitch
SoSFInt32	whichChild
	Index of the child to traverse, or one of SO_SWITCH_NONE, SO_SWITCH_INHERIT, or SO_SWITCH_ALL.
Public Attributes inherited from SoGroup
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Additional Inherited Members
Related Symbols inherited from SoSwitch
#define	SO_SWITCH_NONE   (-1)
	Possible value of SoSwitch::whichChild : Don't traverse any children.
#define	SO_SWITCH_INHERIT   (-2)
	Possible value of SoSwitch::whichChild : Inherit value from state.
#define	SO_SWITCH_ALL   (-3)
	Possible value of SoSwitch::whichChild : Traverse all children.

Detailed Description

Group node that traverses one chosen child depending on scene interaction.

This group node has the same base behavior as the SoSwitch node for its inherited whichChild field.

It has the additional feature of (optionally) traversing a different (or no) child during an "interaction". This allows the application to provide higher performance during an interaction by switching to a less complex version of a geomtry or not rendering the geometry at all. Interaction includes moving the camera (navigating around the scene) and interacting with a dragger (see SoDragger), for example dragging a slice through a volume data set.

The whichInteractiveChild field specifies the index of the child to traverse (where the first child has index 0), when a user interaction, for example moving the camera, is in progress. This means that while the camera is moving, the traversed children will be the children defined by the whichInteractiveChild field, and when interaction is stopped, the standard SoSwitch whichChild field value will again be used as the index to traverse.

NOTES:

• Remember that the default value for both whichChild and whichInteractiveChild is SO_SWITCH_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

InteractiveSwitch {

whichChild	-1
whichInteractiveChild	-1

}

ACTION BEHAVIOR

inherited from SoSwitch. While interacting, traverses the chosen (from whichInteractiveChild) child or children. Sets: SoInteractiveSwitchElement. While not interacting, traverses the chosen (from whichChild) child or children. Sets: SoSwitchElement.

SEE ALSO

SoArray, SoLevelOfDetail, SoMultiPathSwitch, SoMultipleCopy, SoPathSwitch, SoSwitch

Definition at line 96 of file SoInteractiveSwitch.h.

Constructor & Destructor Documentation

SoInteractiveSwitch() [1/2]

SoInteractiveSwitch::SoInteractiveSwitch

(

)

Creates an interactive-switch node with default settings.

SoInteractiveSwitch() [2/2]

SoInteractiveSwitch::SoInteractiveSwitch

(

int

nChildren

)

Constructor that takes approximate number of children.

Member Function Documentation

affectsState()

virtual SbBool SoInteractiveSwitch::affectsState ( ) const

virtual

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

Reimplemented from SoSwitch.

getClassTypeId()

static SoType SoInteractiveSwitch::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoInteractiveSwitch::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoSwitch.

Member Data Documentation

whichInteractiveChild

SoSFInt32 SoInteractiveSwitch::whichInteractiveChild

Index of the child to traverse during interaction, (or one of SO_SWITCH_NONE, SO_SWITCH_INHERIT, or SO_SWITCH_ALL).

Definition at line 106 of file SoInteractiveSwitch.h.

---

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

• Inventor/nodes/SoInteractiveSwitch.h