sosoundelement(3)
NAME
SoSoundElement - The SoSoundElement is used for optimizing audio rendering and for turning off inactive SoVRMLSound nodes.
SYNOPSIS
#include <Inventor/elements/SoSoundElement.h> Inherits SoReplacedElement. Public Member Functions virtual void init (SoState *state) virtual void push (SoState *state) virtual void pop (SoState *state, const SoElement *prevTopElement) virtual void print (FILE *file) const Prints contents of element (not implemented). Static Public Member Functions static SoType getClassTypeId (void) static int getClassStackIndex (void) static void * createInstance (void) static void initClass (void) static void set (SoState *const state, SoNode *const node, SbBool scenegraphhassoundnode, SbBool soundnodeisplaying, SbBool ispartofactivescenegraph) static SbBool setSceneGraphHasSoundNode (SoState *const state, SoNode *const node, SbBool flag) static SbBool sceneGraphHasSoundNode (SoState *const state) static SbBool setSoundNodeIsPlaying (SoState *const state, SoNode *const node, SbBool flag) static SbBool soundNodeIsPlaying (SoState *const state) static SbBool setIsPartOfActiveSceneGraph (SoState *const state, SoNode *const node, SbBool flag) static SbBool isPartOfActiveSceneGraph (SoState *const state) Protected Member Functions virtual ~SoSoundElement () void setDefaultValues () Protected Attributes SbBool scenegraphhassoundnode SbBool soundnodeisplaying SbBool ispartofactivescenegraph
Detailed Description
The SoSoundElement is used for optimizing audio rendering and for
turning off inactive SoVRMLSound nodes.
- Since:
- Coin 2.0
Constructor & Destructor Documentation
- SoSoundElement::~SoSoundElement (void) [protected, virtual]
- The destructor.
Member Function Documentation
- SoType SoSoundElement::getClassTypeId (void) [static]
- This static method returns the class type.
- Reimplemented from SoReplacedElement.
- int SoSoundElement::getClassStackIndex (void) [static]
- This static method returns the state stack index for the class.
- Reimplemented from SoReplacedElement.
- void * SoSoundElement::createInstance (void) [static]
- This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
- void SoSoundElement::initClass (void) [static]
- This static method initializes static data for the SoSoundElement class.
- Reimplemented from SoReplacedElement.
- void SoSoundElement::init (SoState * state) [virtual]
- Initializes the element to it's default value.
- Reimplemented from SoReplacedElement.
- SbBool SoSoundElement::sceneGraphHasSoundNode (SoState *const state)
- [static]
Returns the value of the sceneGraphHasSoundNode flag. - SbBool SoSoundElement::soundNodeIsPlaying (SoState *const state) [static]
- Returns the value of the soundNodeIsPlaying flag.
- SbBool SoSoundElement::isPartOfActiveSceneGraph (SoState *const state)
- [static]
Returns the value of the isPartOfActiveSceneGraph flag. - void SoSoundElement::push (SoState * state) [virtual]
- Calls the superclass' push method. Initializes the element to the
default values. Uses previous element's isPartOfActiveSceneGraph flag. - Reimplemented from SoElement.
- void SoSoundElement::setDefaultValues () [protected]
- Initializes the element to the default values. The default values for
the sceneGraphHasSoundNode is FALSE. The default value for the
isPartOfActiveSceneGraph flag is TRUE. the default value for the
soundNodeIsPlaying flag is FALSE.
Author
- Generated automatically by Doxygen for Coin from the source code.