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

The VRSound is a positionable source of sounds. More...

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

Classes

struct  MFSoundEffect
 
struct  SFSoundFilter
 

Public Member Functions

 VRSound (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< H3D::SFVec3f > _direction=0, H3D::Inst< H3D::SFFloat > _intensity=0, H3D::Inst< H3D::SFVec3f > _location=0, H3D::Inst< H3D::SFFloat > _maxBack=0, H3D::Inst< H3D::SFFloat > _maxFront=0, H3D::Inst< H3D::SFFloat > _minBack=0, H3D::Inst< H3D::SFFloat > _minFront=0, H3D::Inst< H3D::SFFloat > _priority=0, H3D::Inst< SFSoundSourceNode > _source=0, H3D::Inst< H3D::SFBool > _spatialize=0, H3D::Inst< ALSoundSetup > _soundSetup=0, H3D::Inst< SFSoundFilter > _soundFilter=0, H3D::Inst< MFSoundEffect > _soundEffect=0)
 
- Public Member Functions inherited from H3D::Sound
 Sound (Inst< SFNode > _metadata=0, Inst< SFVec3f > _direction=0, Inst< SFFloat > _intensity=0, Inst< SFVec3f > _location=0, Inst< SFFloat > _maxBack=0, Inst< SFFloat > _maxFront=0, Inst< SFFloat > _minBack=0, Inst< SFFloat > _minFront=0, Inst< SFFloat > _priority=0, Inst< SFSoundSourceNode > _source=0, Inst< SFBool > _spatialize=0, Inst< ALSoundSetup > _soundSetup=0)
 
virtual void traverseSG (TraverseInfo &ti)
 
virtual void ALrender ()
 
 X3DSoundNode (Inst< SFNode > _metadata=0)
 
ALuint getALSourceId ()
 

Public Attributes

std::auto_ptr< SFSoundFiltersoundFilter
  (input/output) (Null) This is a HVRSoundFilterNode that, if set, will filter the sound played by this sound node. More...
 
std::auto_ptr< MFSoundEffectsoundEffect
  (input/output) (Null) This is a list of HVRSoundEffectNode effects that can be used to produce additional paths of sound, one path for each attached effect. More...
 
- Public Attributes inherited from H3D::Sound
auto_ptr< SFVec3fdirection
 
auto_ptr< SFFloatintensity
 
auto_ptr< SFVec3flocation
 
auto_ptr< SFFloatmaxBack
 
auto_ptr< SFFloatmaxFront
 
auto_ptr< SFFloatminBack
 
auto_ptr< SFFloatminFront
 
auto_ptr< SFFloatpriority
 
auto_ptr< SFSoundSourceNodesource
 
auto_ptr< SFBoolspatialize
 
auto_ptr< ALSoundSetupsoundSetup
 
auto_ptr< SFMatrix4faccForwardMatrix
 

Static Public Attributes

static H3D::H3DNodeDatabase database
 
- Static Public Attributes inherited from H3D::Sound
static H3DNodeDatabase database
 

Detailed Description

The VRSound is a positionable source of sounds.

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

std::auto_ptr<MFSoundEffect> HVR::VRSound::soundEffect

(input/output) (Null) This is a list of HVRSoundEffectNode effects that can be used to produce additional paths of sound, one path for each attached effect.

Individual filters can be applied to the effects.

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

(input/output) (Null) This is a HVRSoundFilterNode that, if set, will filter the sound played by this sound node.

This is the "direct filter", filtering the sound going directly from the source to the ear.