HVR::HVRSoundEffectNode Class Reference

The HVRSoundEffectNode is the base type for all sound effects. More...

Inheritance diagram for HVR::HVRSoundEffectNode:

Classes
struct	SFSoundFilter

Public Member Functions
	HVRSoundEffectNode (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< SFSoundFilter > _soundFilter=0)
virtual std::string	defaultXMLContainerField ()
void	addSource (ALuint source_id)
	Add an OpenAL source id to use this effect. More...
void	removeSource (ALuint source_id)
	Remove a previously added OpenAL source id from this effect. More...

Public Attributes
std::auto_ptr< SFSoundFilter >	soundFilter
	(Null) This is a HVRSoundFilterNode that, if set, will filter the sound played through this effect node. More...

Static Public Attributes
static H3D::H3DNodeDatabase	database

Protected Member Functions
void	pushParameterChanges ()

Protected Attributes
std::map< ALuint, ALuint >	effectslot_per_source
	Associated OpenAL identifiers. More...
ALuint	effect_id
	Associated OpenAL effect identifier. More...

Friends
struct	SFSoundFilter

Detailed Description

The HVRSoundEffectNode is the base type for all sound effects.

This node is a part of a sound node structure based on the OpenAL/EFX standards. It supports sound spatialization, sound effects and filtering.

Member Function Documentation

void HVR::HVRSoundEffectNode::addSource

(

ALuint

source_id

)

Add an OpenAL source id to use this effect.

void HVR::HVRSoundEffectNode::removeSource

(

ALuint

source_id

)

Remove a previously added OpenAL source id from this effect.

Member Data Documentation

ALuint HVR::HVRSoundEffectNode::effect_id

protected

Associated OpenAL effect identifier.

std::map<ALuint,ALuint> HVR::HVRSoundEffectNode::effectslot_per_source

protected

Associated OpenAL identifiers.

std::auto_ptr<SFSoundFilter> HVR::HVRSoundEffectNode::soundFilter

(Null) This is a HVRSoundFilterNode that, if set, will filter the sound played through this effect node.