fluidvis
Public Member Functions | List of all members
sx::AudioListener Class Reference

#include <SXCore.h>

Inheritance diagram for sx::AudioListener:
sx::SXResource

Public Member Functions

EX AudioListener (const string &id)
 
EX ~AudioListener ()
 
EX void load ()
 
EX void unload ()
 
EX bool isLoaded () const
 
EX void setPosition (const UniformVector *pos)
 
EX void setView (const UniformVector *view)
 
EX void setUp (const UniformVector *up)
 
EX void setVelocity (const UniformVector *vel)
 
EX void setVolume (const UniformFloat *v)
 
EX void update ()
 
- Public Member Functions inherited from sx::SXResource
virtual EX ~SXResource ()
 
EX const string & getID () const
 

Additional Inherited Members

- Protected Attributes inherited from sx::SXResource
string id
 

Detailed Description

Class specifying the state of the listener listening to the SoundObjects. At each particular moment of time, only one listener can exist. Sound is always perceived from the state of the AudioListener object, which was used the last time to invoke update.

Constructor & Destructor Documentation

EX sx::AudioListener::AudioListener ( const string &  id)

constructor

EX sx::AudioListener::~AudioListener ( )

deconstructor

Member Function Documentation

EX bool sx::AudioListener::isLoaded ( ) const
virtual

returns true iff this is loaded

Implements sx::SXResource.

EX void sx::AudioListener::load ( )
virtual

Loads the resources needed to update the listener's state.

Implements sx::SXResource.

EX void sx::AudioListener::setPosition ( const UniformVector pos)

setter

EX void sx::AudioListener::setUp ( const UniformVector up)

setter

EX void sx::AudioListener::setVelocity ( const UniformVector vel)

setter

EX void sx::AudioListener::setView ( const UniformVector view)

setter

EX void sx::AudioListener::setVolume ( const UniformFloat v)

setter

EX void sx::AudioListener::unload ( )

unloads the resources loaded by load, and leaves this unloaded

EX void sx::AudioListener::update ( )

Updates this copying the content from position, velocity, view, up and volume. In between two update calls, the change of those parameters won't influence the sound! Hence update must be called periodically!


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