SoMultiSwitch Class Reference
[Groups]

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

#include <Inventor/nodes/SoMultiSwitch.h>

Inheritance diagram for SoMultiSwitch:
SoGroup SoNode SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.

Public Types

enum  TraversalMode {
  NONE = 0,
  ALL = 1,
  INCLUDE = 2,
  EXCLUDE = 3
}
enum  InheritMode {
  NO = 1 << 0,
  MODE = 1 << 1,
  LIST = 1 << 2,
  ANY = MODE | LIST
}

Public Member Functions

virtual SoType getTypeId () const
 SoMultiSwitch ()
 SoMultiSwitch (int nChildren)
virtual SbBool affectsState () const

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoMFInt32 whichChildren
SoSFEnum traversalMode
SoSFEnum inheritMode

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:

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

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

See related examples:

InteractiveSwitch, MultiPathSwitch, MultiSwitch, PathSwitch


Member Enumeration Documentation

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.

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.


Constructor & Destructor Documentation

SoMultiSwitch::SoMultiSwitch (  ) 

Creates a multi-switch node with default settings.

SoMultiSwitch::SoMultiSwitch ( int  nChildren  ) 

Constructor that takes approximate number of children.


Member Function Documentation

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.

static SoType SoMultiSwitch::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoGroup.

virtual SoType SoMultiSwitch::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoGroup.


Member Data Documentation

Defines the way this node inherit values from the state.

Use enum InheritMode. Default is NO.

Defines the way the children list must be managed.

Use enum TraversalMode. Default is NONE.

Indices of the children to traverse.

Default is empty.


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

Open Inventor Toolkit reference manual, generated on 28 Oct 2019
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/