NAME

       SoAudioRenderAction -

       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.

SYNOPSIS

       #include <Inventor/actions/SoAudioRenderAction.h>

       Inherits SoAction.

   Public Member Functions
       virtual SoType getTypeId (void) const

   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 (void)
       static void callDoAction (SoAction *action, SoNode *node)
       static void callAudioRender (SoAction *action, SoNode *node)

   Protected Member Functions
       virtual const
           SoEnabledElementsList & getEnabledElements (void) const "
       virtual void beginTraversal (SoNode *node)

   Static Protected Member Functions
       static SoEnabledElementsList * getClassEnabledElements (void)
       static SoActionMethodList * getClassActionMethods (void)

   Additional Inherited Members

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)
       {
         if (action->getTypeId() == SoGLRenderAction::getClassTypeId()) {
           // 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.

   void SoAudioRenderAction::addMethod (const SoTypetype, SoActionMethodmethod) [static]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

   void SoAudioRenderAction::enableElement (const SoTypetype, const intstackindex) [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
       [protected],  [virtual]
       Returns a list of the elements used by action instances of this class upon traversal
       operations.

       Reimplemented from SoAction.

   void SoAudioRenderAction::beginTraversal (SoNode *node) [protected],  [virtual]
       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.

Author

       Generated automatically by Doxygen for Coin from the source code.