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

Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions
SoAudioRenderAction Class Reference

The SoAudioRenderAction class renders the aural parts of the scene graph.Applying this method at a root node for a scene graph, path or pathlist will render all sound-related nodes contained within that instance to the current SoAudioDevice. More...

#include <Inventor/actions/SoAudioRenderAction.h>

Inheritance diagram for SoAudioRenderAction:
SoAction

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
- Public Member Functions inherited from SoAction
virtual ~SoAction ()
virtual SbBool isOfType (SoType type) const
virtual void apply (SoNode *root)
virtual void apply (SoPath *path)
virtual void apply (const SoPathList &pathlist, SbBool obeysrules=0)
void apply (SoAction *beingApplied)
virtual void invalidateState (void)
AppliedCode getWhatAppliedTo (void) const
SoNodegetNodeAppliedTo (void) const
SoPathgetPathAppliedTo (void) const
const SoPathListgetPathListAppliedTo (void) const
const SoPathListgetOriginalPathListAppliedTo (void) const
SbBool isLastPathListAppliedTo (void) const
PathCode getPathCode (int &numindices, const int *&indices)
void traverse (SoNode *const node)
SbBool hasTerminated (void) const
const SoPathgetCurPath (void)
SoStategetState (void) const
PathCode getCurPathCode (void) const
virtual SoNodegetCurPathTail (void)
void usePathCode (int &numindices, const int *&indices)
void pushCurPath (const int childindex, SoNode *node=NULL)
void popCurPath (const PathCode prevpathcode)
void pushCurPath (void)
void popPushCurPath (const int childindex, SoNode *node=NULL)
void popCurPath (void)
void switchToPathTraversal (SoPath *path)
void switchToNodeTraversal (SoNode *node)

Static Public Member Functions

static SoType getClassTypeId (void)
static void addMethod (const SoType type, SoActionMethod method)
static void enableElement (const SoType type, const int stackindex)
static void initClass ()
static void callDoAction (SoAction *action, SoNode *node)
static void callAudioRender (SoAction *action, SoNode *node)
- Static Public Member Functions inherited from SoAction
static void initClasses (void)
static void nullAction (SoAction *action, SoNode *node)

Protected Member Functions

virtual const
SoEnabledElementsList
getEnabledElements (void) const
virtual void beginTraversal (SoNode *node)
- Protected Member Functions inherited from SoAction
 SoAction (void)
virtual void endTraversal (SoNode *node)
void setTerminated (const SbBool flag)
virtual SbBool shouldCompactPathList (void) const

Static Protected Member Functions

static SoEnabledElementsListgetClassEnabledElements (void)
static SoActionMethodListgetClassActionMethods (void)

Additional Inherited Members

- Public Types inherited from SoAction
enum  AppliedCode { NODE = 0, PATH = 1, PATH_LIST = 2 }
enum  PathCode { NO_PATH = 0, IN_PATH = 1, BELOW_PATH = 2, OFF_PATH = 3 }
- Protected Attributes inherited from SoAction
SoStatestate
SoActionMethodListtraversalMethods

Detailed Description

The SoAudioRenderAction class renders the aural parts of the scene graph.

Applying this method at a root node for a scene graph, path or pathlist will render all sound-related nodes contained within that instance to the current SoAudioDevice.


Member Function Documentation

SoType SoAudioRenderAction::getTypeId ( void  ) const
virtual

Returns the type identification of an action derived from a class inheriting SoAction. This is used for run-time type checking and "downward" casting.

Usage example:

void bar(SoAction * action)
{
// safe downward cast, know the type
SoGLRenderAction * glrender = (SoGLRenderAction *)action;
}
return; // ignore if not renderaction
}

For application programmers wanting to extend the library with new actions: 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 Inventor/nodes/SoSubAction.h: SO_ACTION_SOURCE, SO_ACTION_INIT_CLASS and SO_ACTION_CONSTRUCTOR.

For more information on writing Coin extensions, see the SoAction class documentation.

Returns the actual type id of an object derived from a class inheriting SoAction. Needs to be overridden in all subclasses.

Implements SoAction.

SoType SoAudioRenderAction::getClassTypeId ( void  )
static

Returns the run-time type object associated with instances of this class.

Reimplemented from SoAction.

Referenced by SoNode::audioRenderS().

void SoAudioRenderAction::addMethod ( const SoType  type,
SoActionMethod  method 
)
static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Referenced by SoNodeKitListPart::initClass(), SoVRMLSound::initClass(), SoVRMLInline::initClass(), and SoBaseKit::initClass().

void SoAudioRenderAction::enableElement ( const SoType  type,
const int  stackindex 
)
static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

const SoEnabledElementsList & SoAudioRenderAction::getEnabledElements ( void  ) const
protectedvirtual

Returns a list of the elements used by action instances of this class upon traversal operations.

Reimplemented from SoAction.

SoEnabledElementsList * SoAudioRenderAction::getClassEnabledElements ( void  )
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

This method not available in the original OIV API, see SoSubAction.h for explanation.

Reimplemented from SoAction.

SoActionMethodList * SoAudioRenderAction::getClassActionMethods ( void  )
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

This method not available in the original OIV API, see SoSubAction.h for explanation.

Reimplemented from SoAction.

void SoAudioRenderAction::initClass ( void  )
static

Initializes the run-time type system for this class, and sets up the enabled elements and action method list.

Reimplemented from SoAction.

void SoAudioRenderAction::beginTraversal ( SoNode node)
protectedvirtual

This virtual method is called from SoAction::apply(), and is the entry point for the actual scenegraph traversal.

It can be overridden to initialize the action at traversal start, for specific initializations in the action subclasses inheriting SoAction.

Default method just calls traverse(), which any overridden implementation of the method must do too (or call SoAction::beginTraversal()) to trigger the scenegraph traversal.

Reimplemented from SoAction.

References SoAction::traverse().


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

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

Generated on Wed Jul 18 2012 for Coin by Doxygen. 1.8.1.1