I3DDevice Interface Reference

The I3DDevice interface represents an output device for 3D sound. More...

#include <I3DDevice.h>

Inheritance diagram for I3DDevice:

Public Member Functions
virtual Vector3	getListenerLocation () const =0
	Retrieves the listener location.
virtual void	setListenerLocation (const Vector3 &location)=0
	Sets the listener location.
virtual Vector3	getListenerVelocity () const =0
	Retrieves the listener velocity.
virtual void	setListenerVelocity (const Vector3 &velocity)=0
	Sets the listener velocity.
virtual Quaternion	getListenerOrientation () const =0
	Retrieves the listener orientation.
virtual void	setListenerOrientation (const Quaternion &orientation)=0
	Sets the listener orientation.
virtual float	getSpeedOfSound () const =0
	Retrieves the speed of sound.
virtual void	setSpeedOfSound (float speed)=0
	Sets the speed of sound.
virtual float	getDopplerFactor () const =0
	Retrieves the doppler factor.
virtual void	setDopplerFactor (float factor)=0
	Sets the doppler factor.
virtual DistanceModel	getDistanceModel () const =0
	Retrieves the distance model.
virtual void	setDistanceModel (DistanceModel model)=0
	Sets the distance model.

Detailed Description

The I3DDevice interface represents an output device for 3D sound.

The interface has been modelled after the OpenAL 1.1 API, see the OpenAL Specification for lots of details.

Member Function Documentation

getDistanceModel()

virtual DistanceModel I3DDevice::getDistanceModel ( ) const

pure virtual

Retrieves the distance model.

Returns

The distance model.

Implemented in SoftwareDevice, and OpenALDevice.

getDopplerFactor()

virtual float I3DDevice::getDopplerFactor ( ) const

pure virtual

Retrieves the doppler factor.

This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect.

Returns

The doppler factor.

Implemented in SoftwareDevice, and OpenALDevice.

getListenerLocation()

virtual Vector3 I3DDevice::getListenerLocation ( ) const

pure virtual

Retrieves the listener location.

Returns

The listener location.

Implemented in SoftwareDevice, and OpenALDevice.

getListenerOrientation()

virtual Quaternion I3DDevice::getListenerOrientation ( ) const

pure virtual

Retrieves the listener orientation.

Returns

The listener orientation as quaternion.

Implemented in SoftwareDevice, and OpenALDevice.

getListenerVelocity()

virtual Vector3 I3DDevice::getListenerVelocity ( ) const

pure virtual

Retrieves the listener velocity.

Returns

The listener velocity.

Implemented in SoftwareDevice, and OpenALDevice.

getSpeedOfSound()

virtual float I3DDevice::getSpeedOfSound ( ) const

pure virtual

Retrieves the speed of sound.

This value is needed for doppler effect calculation.

Returns

The speed of sound.

Implemented in SoftwareDevice, and OpenALDevice.

setDistanceModel()

virtual void I3DDevice::setDistanceModel ( DistanceModel model )

pure virtual

Sets the distance model.

Parameters

model

distance model.

Implemented in SoftwareDevice, and OpenALDevice.

setDopplerFactor()

virtual void I3DDevice::setDopplerFactor ( float factor )

pure virtual

Sets the doppler factor.

This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect.

Parameters

factor

The new doppler factor.

Implemented in SoftwareDevice, and OpenALDevice.

setListenerLocation()

virtual void I3DDevice::setListenerLocation ( const Vector3 & location )

pure virtual

Sets the listener location.

Parameters

location

The new location.

Note

The location is not updated with the velocity and remains constant until the next call of this method.

Implemented in SoftwareDevice, and OpenALDevice.

setListenerOrientation()

virtual void I3DDevice::setListenerOrientation ( const Quaternion & orientation )

pure virtual

Sets the listener orientation.

Parameters

orientation

The new orientation as quaternion.

Note

The coordinate system used is right handed and the listener by default is oriented looking in the negative z direction with the positive y axis as up direction.

Implemented in SoftwareDevice, and OpenALDevice.

setListenerVelocity()

virtual void I3DDevice::setListenerVelocity ( const Vector3 & velocity )

pure virtual

Sets the listener velocity.

Parameters

velocity

The new velocity.

Note

This velocity does not change the position of the listener over time, it is simply used for the calculation of the doppler effect.

Implemented in SoftwareDevice, and OpenALDevice.

setSpeedOfSound()

virtual void I3DDevice::setSpeedOfSound ( float speed )

pure virtual

Sets the speed of sound.

This value is needed for doppler effect calculation.

Parameters

speed

The new speed of sound.

Implemented in SoftwareDevice, and OpenALDevice.

---

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

• devices/I3DDevice.h