NAME

       SoPathSwitch -

       The SoPathSwitch class traverses only when current path matches a configurable path.

       FILE FORMAT/DEFAULTS:

SYNOPSIS

       #include <Inventor/nodes/SoPathSwitch.h>

       Inherits SoGroup.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase. This is used for
           run-time type checking and 'downward' casting.
       SoPathSwitch (void)
       SoPathSwitch (int numchildren)
       virtual void doAction (SoAction *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 callback (SoCallbackAction *action)
       virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
       virtual void audioRender (SoAudioRenderAction *action)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoSFPath path

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoPathSwitch ()

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoPathSwitch class traverses only when current path matches a configurable path.

       FILE FORMAT/DEFAULTS:

       PathSwitch {
           path NULL
       }

Constructor & Destructor Documentation

   SoPathSwitch::SoPathSwitch (void)
       Default constructor.

   SoPathSwitch::SoPathSwitch (intnumchildren)
       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.

   SoPathSwitch::~SoPathSwitch () [protected],  [virtual]
       Destructor.

Member Function Documentation

   SoType SoPathSwitch::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This is used for
       run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or
       others: this method needs to be overridden in all subclasses. This is typically done as part of setting
       up the full type system for extension classes, which is usually accomplished by using the pre-defined
       macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and
       SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the toplevel superclasses
       for the various class groups.

       Reimplemented from SoGroup.

   const SoFieldData * SoPathSwitch::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.

   void SoPathSwitch::doAction (SoAction *action) [virtual]
       This function performs the typical operation of a node for any action.

       Reimplemented from SoGroup.

   void SoPathSwitch::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 SoPathSwitch::pick (SoPickAction *action) [virtual]
       Action method for SoPickAction.

       Does common processing for SoPickAction action instances.

       Reimplemented from SoGroup.

   void SoPathSwitch::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 SoPathSwitch::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 SoPathSwitch::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 SoPathSwitch::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 SoPathSwitch::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 SoPathSwitch::getPrimitiveCount (SoGetPrimitiveCountAction *action) [virtual]
       Action method for the SoGetPrimitiveCountAction.

       Calculates the number of triangle, line segment and point primitives for the node and adds these to the
       counters of the action.

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

       Reimplemented from SoGroup.

   void SoPathSwitch::audioRender (SoAudioRenderAction *action) [virtual]
       Action method for SoAudioRenderAction.

       Does common processing for SoAudioRenderAction action instances.

       Reimplemented from SoGroup.

Member Data Documentation

   SoSFPath SoPathSwitch::path
       The path that must match the current action path. A NULL path will never match. An empty path will always
       match. The path should go up to (not including) the SoPathSwitch node, but need not go all the way back
       to the root node.

Author

       Generated automatically by Doxygen for Coin from the source code.