Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SoVRMLSwitch Class Reference
[VRML97 classes]

The SoVRMLSwitch class is a group node for traversing selected children. More...

#include <Inventor/VRMLnodes/SoVRMLSwitch.h>

Inheritance diagram for SoVRMLSwitch:

SoGroup SoNode SoFieldContainer SoBase List of all members.

Public Methods

 SoVRMLSwitch (void)
 SoVRMLSwitch (int choices)
virtual SbBool affectsState (void) const
void addChoice (SoNode *choice)
void insertChoice (SoNode *choice, int idx)
SoNodegetChoice (int idx) const
int findChoice (SoNode *choice) const
int getNumChoices (void) const
void removeChoice (int idx)
void removeChoice (SoNode *node)
void removeAllChoices (void)
void replaceChoice (int idx, SoNode *choice)
void replaceChoice (SoNode *old, SoNode *choice)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void pick (SoPickAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
void addChild (SoNode *child)
void insertChild (SoNode *child, int idx)
SoNodegetChild (int idx) const
int findChild (const SoNode *child) const
int getNumChildren (void) const
void removeChild (int idx)
void removeChild (SoNode *child)
void removeAllChildren (void)
void replaceChild (int idx, SoNode *node)
void replaceChild (SoNode *old, SoNode *node)
virtual SoChildListgetChildren (void) const

Static Public Methods

void initClass (void)

Public Attributes

SoMFNode choice
SoSFInt32 whichChoice

Protected Methods

virtual ~SoVRMLSwitch (void)
virtual void notify (SoNotList *list)
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

Detailed Description

The SoVRMLSwitch class is a group node for traversing selected children.

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

  Switch {
    exposedField    MFNode  choice      []
    exposedField    SFInt32 whichChoice -1    # [-1, inf)
  }
  

The Switch grouping node traverses zero or one of the nodes specified in the choice field. 4.6.5, Grouping and children nodes (<http://www.web3d.org/technicalinfo/specifications/vrml97/part1/concepts.html#4.6.5>), describes details on the types of nodes that are legal values for choice.

The whichChoice field specifies the index of the child to traverse, with the first child having index 0. If whichChoice is less than zero or greater than the number of nodes in the choice field, nothing is chosen. All nodes under a Switch continue to receive and send events regardless of the value of whichChoice. For example, if an active SoVRMLTimeSensor is contained within an inactive choice of an Switch, the SoVRMLTimeSensor sends events regardless of the Switch's state.


Constructor & Destructor Documentation

SoVRMLSwitch::SoVRMLSwitch void   
 

Constructor.

SoVRMLSwitch::SoVRMLSwitch int    choices
 

Constructor. choices is the expected number of children.

SoVRMLSwitch::~SoVRMLSwitch void    [protected, virtual]
 

Destructor.


Member Function Documentation

void SoVRMLSwitch::initClass void    [static]
 

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoGroup.

SbBool SoVRMLSwitch::affectsState void    const [virtual]
 

Returns TRUE if the node could have any effect on the state during traversal.

If it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state.

The default method returns TRUE, on a "better safe than sorry" philosophy.

Reimplemented from SoNode.

void SoVRMLSwitch::addChoice SoNode   choice
 

Adds choice to the choice field.

void SoVRMLSwitch::insertChoice SoNode   choice,
int    idx
 

Inserts choice at index idx.

SoNode * SoVRMLSwitch::getChoice int    idx const
 

Returns the choice at index idx.

int SoVRMLSwitch::findChoice SoNode   choice const
 

Finds the index for choice, or -1 if not found.

int SoVRMLSwitch::getNumChoices void    const
 

Returns the number of choices.

void SoVRMLSwitch::removeChoice int    idx
 

Removes the choice at index idx.

void SoVRMLSwitch::removeChoice SoNode   choice
 

If choice is found, remove it.

void SoVRMLSwitch::removeAllChoices void   
 

Removes all choices.

void SoVRMLSwitch::replaceChoice int    idx,
SoNode   choice
 

Replace the choice at index idx with choice.

void SoVRMLSwitch::replaceChoice SoNode   old,
SoNode   choice
 

Find old, and replace it with choice.

void SoVRMLSwitch::doAction SoAction   action [virtual]
 

This function performs the typical operation of a node for any action.

Reimplemented from SoGroup.

void SoVRMLSwitch::callback SoCallbackAction   action [virtual]
 

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoGroup.

void SoVRMLSwitch::GLRender SoGLRenderAction   action [virtual]
 

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoGroup.

void SoVRMLSwitch::pick SoPickAction   action [virtual]
 

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoGroup.

void SoVRMLSwitch::getBoundingBox SoGetBoundingBoxAction   action [virtual]
 

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoGroup.

void SoVRMLSwitch::handleEvent SoHandleEventAction   action [virtual]
 

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to.

Nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from SoGroup.

void SoVRMLSwitch::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 SoVRMLSwitch::search SoSearchAction   action [virtual]
 

Action method for SoSearchAction.

Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction -- if any of the requested criteria is a miss, the search is not deemed successful for the node.

See also:
SoSearchAction

Reimplemented from SoGroup.

void SoVRMLSwitch::write SoWriteAction   action [virtual]
 

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented from SoGroup.

void SoVRMLSwitch::audioRender SoAudioRenderAction   action [virtual]
 

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances.

Reimplemented from SoGroup.

void SoVRMLSwitch::addChild SoNode   child [virtual]
 

Append a child node to the list of children nodes this group node is managing.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

void SoVRMLSwitch::insertChild SoNode   child,
int    idx
[virtual]
 

Insert a child node at position newchildindex.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

SoNode * SoVRMLSwitch::getChild int    idx const [virtual]
 

Returns pointer to child node at index.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

int SoVRMLSwitch::findChild const SoNode   child const [virtual]
 

Returns index in our list of children for child node, or -1 if node is not a child of this group node.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

int SoVRMLSwitch::getNumChildren void    const [virtual]
 

Returns number of child nodes managed by this group.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

void SoVRMLSwitch::removeChild int    idx [virtual]
 

Remove node at childindex in our list of children.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

void SoVRMLSwitch::removeChild SoNode   child [virtual]
 

Remove child from the set of children managed by this group node. Will decrease the reference count of child by 1.

This is a convenience method. It will simply call findChild() with child as argument, and then call removeChild(int) if the child is found.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

void SoVRMLSwitch::removeAllChildren void    [virtual]
 

Do not manage the children anymore. Will dereference all children by 1 as they are removed.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

void SoVRMLSwitch::replaceChild int    idx,
SoNode   child
[virtual]
 

Replace child at index with newChild.

Dereferences the child previously at index, and increases the reference count of newChild by 1.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

void SoVRMLSwitch::replaceChild SoNode   old,
SoNode   child
[virtual]
 

Replace oldchild with newchild.

Dereferences oldchild by 1, and increases the reference count of newchild by 1.

This is a convenience method. It will simply call findChild() with oldchild as argument, and call replaceChild(int, SoNode*) if the child is found.

Please note that this method is not virtual in the original SGI Inventor API.

Reimplemented from SoGroup.

SoChildList * SoVRMLSwitch::getChildren void    const [virtual]
 

Returns list of children.

Reimplemented from SoGroup.

void SoVRMLSwitch::notify SoNotList   list [protected, virtual]
 

Notifies all auditors for this instance when changes are made.

Reimplemented from SoNode.

SbBool SoVRMLSwitch::readInstance SoInput   in,
unsigned short    flags
[protected, virtual]
 

This method is mainly intended for internal use during file import operations.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoGroup.

void SoVRMLSwitch::copyContents const SoFieldContainer   from,
SbBool    copyConn
[protected, virtual]
 

Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

This is the method that should be overridden by subclasses which needs to account for internal data that are not handled automatically.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

  void
  MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                    SbBool copyconnections)
  {
    // let parent superclasses do their thing (copy fields, copy
    // instance name, etc etc)
    SoNode::copyContents(from, copyconnections);

    // [..then copy internal data..]
  }

Reimplemented from SoGroup.


Member Data Documentation

SoMFNode SoVRMLSwitch::choice
 

Contains the children.

SoSFInt32 SoVRMLSwitch::whichChoice
 

Selected choice. Can be a positive number from 0 to <num children-1>, or one of the constants SO_SWITCH_NODE, SO_SWITCH_ALL or SO_SWITCH_INHERIT. Default value is SO_SWITCH_NONE.


The documentation for this class was generated from the following files:
Generated on Sat May 24 22:39:55 2003 for Coin by doxygen1.2.18