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

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

SoSoundElement Class Reference

The SoSoundElement is used for optimizing audio rendering and for turning off inactive SoVRMLSound nodes. More...

#include <Inventor/elements/SoSoundElement.h>

Inheritance diagram for SoSoundElement:
SoReplacedElement SoElement

List of all members.

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

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::setSceneGraphHasSoundNode ( SoState *const  state,
SoNode *const  node,
SbBool  flag 
) [static]

Sets the sceneGraphHasSoundNode flag.

SbBool SoSoundElement::sceneGraphHasSoundNode ( SoState *const  state) [static]

The sceneGraphHasSoundNode flag is used to stop the SoAudioRenderAction in SoSeparator and SoVRMLGroup nodes for cases where the sub-graph doesn not contain any SoVRMLSound nodes.

Returns the value of the sceneGraphHasSoundNode flag.

SbBool SoSoundElement::setSoundNodeIsPlaying ( SoState *const  state,
SoNode *const  node,
SbBool  flag 
) [static]

Sets the soundNodeIsPlaying flag.

SbBool SoSoundElement::soundNodeIsPlaying ( SoState *const  state) [static]

The soundNodeIsPlaying flag is currently unused.

Returns the value of the soundNodeIsPlaying flag.

SbBool SoSoundElement::setIsPartOfActiveSceneGraph ( SoState *const  state,
SoNode *const  node,
SbBool  flag 
) [static]

Sets the isPartOfActiveSceneGraph flag.

SbBool SoSoundElement::isPartOfActiveSceneGraph ( SoState *const  state) [static]

The isPartOfActiveSceneGraph flag is used to make SoVRMLSound that are below inactive parts of the scenegraph (i.e. below a SoSwitch or SoLOD node) stop playing.

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.


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

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated for Coin by Doxygen 1.7.3.