HVR::LowPassSoundFilter Class Reference

The LowPassSoundFilter is a filter that lowpass filters the associated sound or effect. More...

Inheritance diagram for HVR::LowPassSoundFilter:

Classes
struct	Updater

Public Member Functions
	LowPassSoundFilter (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< Updater > _updater=0, H3D::Inst< H3D::SFFloat > _lowFrequencyGain=0, H3D::Inst< H3D::SFFloat > _highFrequencyGain=0)
Public Member Functions inherited from HVR::HVRSoundFilterNode
	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...

Public Attributes
std::auto_ptr< H3D::SFFloat >	lowFrequencyGain
	(0.0–1.0) (1.0) This is the filter's gain for low frequency sound, in the range 0-1. More...
std::auto_ptr< H3D::SFFloat >	highFrequencyGain
	(0.0–1.0) (1.0) This is the filter's gain for high frequency sound, in the range 0-1. More...

Static Public Attributes
static H3D::H3DNodeDatabase	database
Static Public Attributes inherited from HVR::HVRSoundFilterNode
static H3D::H3DNodeDatabase	database

Protected Member Functions
void	updateParameters (float lowFrequencyGain, float highFrequencyGain)
Protected Member Functions inherited from HVR::HVRSoundFilterNode
void	pushParameterChanges ()

Protected Attributes
struct HVR_API	Updater
std::auto_ptr< Updater >	updater
Protected Attributes inherited from HVR::HVRSoundFilterNode
ALuint	filter_id
source_list_t	sources
	Associated OpenAL identifiers. More...
source_slot_list_t	source_slots
	Associated OpenAL identifiers. More...

Additional Inherited Members
Protected Types inherited from HVR::HVRSoundFilterNode
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

Detailed Description

The LowPassSoundFilter is a filter that lowpass filters the associated sound or effect.

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

std::auto_ptr<H3D::SFFloat> HVR::LowPassSoundFilter::highFrequencyGain

(0.0–1.0) (1.0) This is the filter's gain for high frequency sound, in the range 0-1.

This corresponds to AL_LOWPASS_GAINHF in the EFX standard.

std::auto_ptr<H3D::SFFloat> HVR::LowPassSoundFilter::lowFrequencyGain

(0.0–1.0) (1.0) This is the filter's gain for low frequency sound, in the range 0-1.

This corresponds to AL_LOWPASS_GAIN in the EFX standard.