Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions

SoPathSwitch Class Reference

The SoPathSwitch class traverses only when current path matches a configurable path.FILE FORMAT/DEFAULTS: More...

#include <Inventor/nodes/SoPathSwitch.h>

Inheritance diagram for SoPathSwitch:
SoGroup SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

 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 getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void audioRender (SoAudioRenderAction *action)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFPath path

Protected Member Functions

virtual ~SoPathSwitch ()

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 ( 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.

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

Destructor.


Member Function Documentation

void SoPathSwitch::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.

void SoPathSwitch::doAction ( SoAction action) [virtual]

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

Reimplemented from SoGroup.

References SoGroup::doAction(), SoAction::getCurPath(), and path.

Referenced by search().

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.

References SoAction::getCurPath(), SoGroup::GLRender(), and path.

void SoPathSwitch::pick ( SoPickAction action) [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoGroup.

References SoAction::getCurPath(), path, and SoGroup::pick().

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.

References SoGroup::getBoundingBox(), SoAction::getCurPath(), and path.

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.

References SoAction::getCurPath(), SoGroup::handleEvent(), and path.

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.

References SoAction::getCurPath(), SoGroup::getMatrix(), and path.

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.

References doAction(), SoSearchAction::isFound(), SoSearchAction::isSearchingAll(), and SoGroup::search().

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.

References SoAction::getCurPath(), SoGroup::getPrimitiveCount(), and path.

void SoPathSwitch::audioRender ( SoAudioRenderAction action) [virtual]

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances.

Reimplemented from SoGroup.

References SoGroup::audioRender(), SoAction::getCurPath(), and path.


Member Data Documentation

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.

Referenced by audioRender(), doAction(), getBoundingBox(), getMatrix(), getPrimitiveCount(), GLRender(), handleEvent(), and pick().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:17 for Coin by Doxygen. 1.7.3