Candy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
HVR::HVRSoundFilterNode Class Reference

The HVRSoundFilterNode is the base type for all sound filters. More...

Inheritance diagram for HVR::HVRSoundFilterNode:
Inheritance graph
[legend]

Public Member Functions

 HVRSoundFilterNode (H3D::Inst< H3D::SFNode > _metadata=0)
 
virtual std::string defaultXMLContainerField ()
 
void addSource (ALuint source_id)
 Add an OpenAL source id to use this filter. More...
 
void removeSource (ALuint source_id)
 Remove a previously added OpenAL source id from this filter. More...
 
void addEffect (ALuint source_id, ALuint effect_slot_id)
 Add an OpenAL effect to use this filter. More...
 
void removeEffect (ALuint source_id, ALuint effect_slot_id)
 Remove a previously added OpenAL effect from this filter. More...
 

Static Public Attributes

static H3D::H3DNodeDatabase database
 

Protected Types

typedef std::set< ALuint > source_list_t
 
typedef std::pair< ALuint, ALuint > source_slot_t
 
typedef std::set< source_slot_t > source_slot_list_t
 

Protected Member Functions

void pushParameterChanges ()
 

Protected Attributes

ALuint filter_id
 
source_list_t sources
 Associated OpenAL identifiers. More...
 
source_slot_list_t source_slots
 Associated OpenAL identifiers. More...
 

Detailed Description

The HVRSoundFilterNode is the base type for all sound filters.

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

Member Function Documentation

void HVR::HVRSoundFilterNode::addEffect ( ALuint  source_id,
ALuint  effect_slot_id 
)

Add an OpenAL effect to use this filter.

void HVR::HVRSoundFilterNode::addSource ( ALuint  source_id)

Add an OpenAL source id to use this filter.

void HVR::HVRSoundFilterNode::removeEffect ( ALuint  source_id,
ALuint  effect_slot_id 
)

Remove a previously added OpenAL effect from this filter.

void HVR::HVRSoundFilterNode::removeSource ( ALuint  source_id)

Remove a previously added OpenAL source id from this filter.

Member Data Documentation

source_slot_list_t HVR::HVRSoundFilterNode::source_slots
protected

Associated OpenAL identifiers.

source_list_t HVR::HVRSoundFilterNode::sources
protected

Associated OpenAL identifiers.