text: SoSwitch.3coin3 - Man Page
  The SoSwitch class is a group node which selects one child subgraph for traversal.
  Synopsis
  #include <Inventor/nodes/SoSwitch.h>
  Inherits SoGroup.
  Inherited by SoBlinker.
  Public Member Functions
  virtual SoType getTypeId (void) const
  SoSwitch (void)
  SoSwitch (int numchildren)
  virtual SbBool affectsState (void) const
  SoSFInt32 whichChild
  Protected Member Functions
  virtual const SoFieldData * getFieldData (void) const
  virtual ~SoSwitch ()
  void traverseChildren (SoAction *action)
  Static Protected Member Functions
  static const SoFieldData ** getFieldDataPtr (void)
  Additional Inherited Members
  Detailed Description
  The SoSwitch class is a group node which selects one child subgraph for traversal.
  Which child to traverse is controlled by the application programmer by using the SoSwitch::whichChild field. In addition to picking out a single child for traversal, it is also possible to flip all children on or off for traversal.
  This node is very useful for conditionally turning on or off parts of the scenegraph based on the current application processing mode, visualizing mode, or whatever else the application can do.
  FILE FORMAT/DEFAULTS:
  Switch { whichChild -1 }
  Constructor & Destructor Documentation
  SoSwitch::SoSwitch (void)
  Default constructor.
  SoSwitch::SoSwitch (int numchildren)
  Constructor.
  The argument should be the approximate number of children which is expected to be inserted below this node. The number need not be exact, as it is only used as a hint for better memory resource allocation.
  SoSwitch::~SoSwitch () [protected], [virtual]
  Destructor.
  Member Function Documentation
  SoType SoSwitch:oGroup.
  Reimplemented in SoBlinker.
  const SoFieldData * SoSwitch::getFieldData (void) const [protected], [virtual]
  Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns
  NULL.
  Reimplemented from SoGroup.
  Reimplemented in SoBlinker.
  SbBool SoSwitch: SoSwitch::doAction (SoAction * action) [virtual]
  This function performs the typical operation of a node for any action.
  Reimplemented from SoGroup.
  void SoSwitch: SoGroup.
  void SoSwitch:oGroup.
  void SoSwitch::pick (SoPickAction * action) [virtual]
  Action method for SoPickAction.
  Does common processing for SoPickAction action instances.
  Reimplemented from SoGroup.
  void SoSwitch:oGroup.
  Reimplemented in SoBlinker.
  void SoSwitch: SoGroup.
  void SoSwitch::getMatrix (SoGetMatrixAction * action) [virtual]
  Action method for SoGetMatrixAction.
  Updates action by accumulating with the transformation matrix of this node (if any).
  Reimplemented from SoGroup.
  void SoSwitch: SoGroup.
  void SoSwitch::write (SoWriteAction * action) [virtual]
  Action method for SoWriteAction.
  Writes out a node object, and any connected nodes, engines etc, if necessary.
  Reimplemented from SoGroup.
  Reimplemented in SoBlinker.
  void SoSwitch:oGroup.
  void SoSwitch::audioRender (SoAudioRenderAction * action) [virtual]
  Action method for SoAudioRenderAction.
  Does common processing for SoAudioRenderAction action instances.
  Reimplemented from SoGroup.
  void SoSwitch::notify (SoNotList * l) [virtual]
  Notifies all auditors for this instance when changes are made.
  Reimplemented from SoNode.
  Reimplemented in SoBlinker.
  void SoSwitch::traverseChildren (SoAction * action) [protected]
  This function was part of the original SGI Inventor API, but it is not supported in Coin, as it looks like it should probably have been private in Inventor.
  Member Data Documentation
  SoSFInt32 SoSwitch::whichChild
  Selects which child to traverse during rendering (and some other) actions.
  The value should be either
  SO_SWITCH_NONE (for traversing no children, like it was an empty SoGroup node),
  SO_SWITCH_ALL (for traversing like if we were an SoGroup node),
  SO_SWITCH_INHERIT (for traversing the same child as the last SoSwitch node), or an index value for a child.
  When using
  SO_SWITCH_INHERIT, it is important to understand how the SoSwitch-node is affected by other SoSwitch-nodes. If you have several switches in the scenegraph, the last switch with its
  whichChild field set to anything but
  SO_SWITCH_INHERIT will be used. The switch does not only inherit from its parent switch node, but also from its siblings, located anywhere before it in the scenegraph. An example will help clarify this:
  #Inventor V2.1 ascii Separator { Switch { whichChild 0 Group { Switch { whichChild 1 BaseColor { rgb 1 0 0 } # red BaseColor { rgb 1 1 0 } # yellow } Switch { whichChild -2 # SO_SWITCH_INHERIT BaseColor { rgb 0 1 0 } # green BaseColor { rgb 0 0 1 } # blue } Cube { } } } }
  This results in a blue cube on the screen. The reason being that the value of the previous
  whichChild field was inherited by the final switch, making it select child 1 - the blue BaseColor.
  When constructing ascii Inventor files, the integer values for the keywords must be used instead of their names. They are -1 for
  SO_SWITCH_NONE, -2 for
  SO_SWITCH_INHERIT, and -3 for
  SO_SWITCH_ALL.
  Default value for the field is
  SO_SWITCH_NONE.
  Author
  Generated automatically by Doxygen for Coin from the source code.
  Referenced By
  The man page SoSwitch.3coin2(3) is an alias of SoSwitch.3coin3(3).