SoAudioRenderAction Class Reference

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

#include <Inventor/actions/SoAudioRenderAction.h>

Inheritance diagram for SoAudioRenderAction:

Public Member Functions
SoType	getTypeId (void) const override
Public Member Functions inherited from SoAction
virtual	~SoAction (void)
virtual void	apply (const SoPathList &pathlist, SbBool obeysrules=FALSE)
void	apply (SoAction *beingApplied)
virtual void	apply (SoNode *root)
virtual void	apply (SoPath *path)
const SoPath *	getCurPath (void)
PathCode	getCurPathCode (void) const
virtual SoNode *	getCurPathTail (void)
SoNode *	getNodeAppliedTo (void) const
const SoPathList *	getOriginalPathListAppliedTo (void) const
SoPath *	getPathAppliedTo (void) const
PathCode	getPathCode (int &numindices, const int *&indices)
const SoPathList *	getPathListAppliedTo (void) const
SoState *	getState (void) const
AppliedCode	getWhatAppliedTo (void) const
SbBool	hasTerminated (void) const
virtual void	invalidateState (void)
SbBool	isLastPathListAppliedTo (void) const
virtual SbBool	isOfType (SoType type) const
void	popCurPath (const PathCode prevpathcode)
void	popCurPath (void)
void	popPushCurPath (const int childindex, SoNode *node=NULL)
void	pushCurPath (const int childindex, SoNode *node=NULL)
void	pushCurPath (void)
void	switchToNodeTraversal (SoNode *node)
void	switchToPathTraversal (SoPath *path)
void	traverse (SoNode *const node)
void	usePathCode (int &numindices, const int *&indices)

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

Protected Member Functions
void	beginTraversal (SoNode *node) override
const SoEnabledElementsList &	getEnabledElements (void) const override
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 SoActionMethodList *	getClassActionMethods (void)
static SoEnabledElementsList *	getClassEnabledElements (void)
Static Protected Member Functions inherited from SoAction
static SoActionMethodList *	getClassActionMethods (void)
static SoEnabledElementsList *	getClassEnabledElements (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
SoState *	state
SoActionMethodList *	traversalMethods

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 path list will render all sound-related nodes contained within that instance to the current SoAudioDevice.

Member Function Documentation

addMethod()

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.

beginTraversal()

void SoAudioRenderAction::beginTraversal ( SoNode * node )

overrideprotectedvirtual

This virtual method is called from SoAction::apply(), and is the entry point for the actual scene graph 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 scene graph traversal.

Reimplemented from SoAction.

enableElement()

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.

getClassActionMethods()

SoActionMethodList * SoAudioRenderAction::getClassActionMethods ( void )

staticprotected

Returns list of action methods for this class. The enabledElements and methods variables are protected in the original OIV API. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

getClassEnabledElements()

SoEnabledElementsList * SoAudioRenderAction::getClassEnabledElements ( void )

staticprotected

Returns list of enabled elements for this class. The enabledElements and methods variables are protected in the original OIV API. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

getClassTypeId()

SoType SoAudioRenderAction::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

getEnabledElements()

const SoEnabledElementsList & SoAudioRenderAction::getEnabledElements ( void ) const

overrideprotectedvirtual

Returns list of enabled elements.

Reimplemented from SoAction.

getTypeId()

SoType SoAudioRenderAction::getTypeId ( void ) const

overridevirtual

Returns the type identification of an object derived from a class inheriting SoAction. This is used for runtime type checking and "downward" casting.

Implements SoAction.

---

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

• SoAudioRenderAction.h
• SoAudioRenderAction.cpp