openalpp::Listener Class Reference

Inheritance diagram for openalpp::Listener:

openalpp::PositionedObject openalpp::AudioBase

List of all members.

Public Member Functions

 Listener ()
 Listener (const Listener &listener)
 Listener (float x, float y, float z, float directionx, float directiony, float directionz, float upx, float upy, float upz)
 Listener (float x, float y, float z)
void select ()
bool isSelected ()
void setOrientation (float directionx, float directiony, float directionz, float upx, float upy, float upz)
void getOrientation (float &directionx, float &directiony, float &directionz, float &upx, float &upy, float &upz) const
Listeneroperator= (const Listener &listener)
void setPosition (float x, float y, float z)
void getPosition (float &x, float &y, float &z) const
void setVelocity (float vx, float vy, float vz)
void getVelocity (float &vx, float &vy, float &vz) const

Protected Member Functions

virtual ~Listener ()


Detailed Description

Class for listeners.

Constructor & Destructor Documentation

virtual openalpp::Listener::~Listener (  )  [protected, virtual]

Destructor.

openalpp::Listener::Listener (  ) 

Constructor. Creates the listener at the default position.

openalpp::Listener::Listener ( const Listener listener  ) 

Copy constructor.

openalpp::Listener::Listener ( float  x,
float  y,
float  z,
float  directionx,
float  directiony,
float  directionz,
float  upx,
float  upy,
float  upz 
)

Constructor. Creates the listener at the specified position and orientation.

Parameters:
x x coordinate
y y coordinate
z z coordinate
directionx x value of the direction vector
directiony y value of the direction vector
directionz z value of the direction vector
upx x value of the up vector
upy y value of the up vector
upz z value of the up vector

openalpp::Listener::Listener ( float  x,
float  y,
float  z 
)

Constructor. Creates the listener at the specified position.

Parameters:
x x coordinate
y y coordinate
z z coordinate


Member Function Documentation

void openalpp::Listener::select (  ) 

Select this listener.

bool openalpp::Listener::isSelected (  ) 

Check if this listener is currently selected.

Returns:
true if this listener is selected, false otherwise.

void openalpp::Listener::setOrientation ( float  directionx,
float  directiony,
float  directionz,
float  upx,
float  upy,
float  upz 
)

Set the current orientation of this listener.

Parameters:
directionx x value of the direction vector
directiony y value of the direction vector
directionz z value of the direction vector
upx x value of the up vector
upy y value of the up vector
upz z value of the up vector

void openalpp::Listener::getOrientation ( float &  directionx,
float &  directiony,
float &  directionz,
float &  upx,
float &  upy,
float &  upz 
) const

Get the current orientation of this listener.

Parameters:
directionx x value of the direction vector
directiony y value of the direction vector
directionz z value of the direction vector
upx x value of the up vector
upy y value of the up vector
upz z value of the up vector

Listener& openalpp::Listener::operator= ( const Listener listener  ) 

Assignment operator.

Parameters:
listener is the object to make a copy of.

void openalpp::Listener::setPosition ( float  x,
float  y,
float  z 
) [virtual]

Inherited from PositionedObject.

Implements openalpp::PositionedObject.

void openalpp::Listener::getPosition ( float &  x,
float &  y,
float &  z 
) const [virtual]

Inherited from PositionedObject.

Implements openalpp::PositionedObject.

void openalpp::Listener::setVelocity ( float  vx,
float  vy,
float  vz 
) [virtual]

Inherited from PositionedObject.

Implements openalpp::PositionedObject.

void openalpp::Listener::getVelocity ( float &  vx,
float &  vy,
float &  vz 
) const [virtual]

Inherited from PositionedObject.

Implements openalpp::PositionedObject.


The documentation for this class was generated from the following file:
Generated on Mon Oct 8 10:42:12 2007 for osgAL by  doxygen 1.5.3