AUD_I3DDevice Class Reference

#include <AUD_I3DDevice.h>

Inheritance diagram for AUD_I3DDevice:

List of all members.

Public Member Functions
virtual AUD_Vector3	getListenerLocation () const =0
virtual void	setListenerLocation (const AUD_Vector3 &location)=0
virtual AUD_Vector3	getListenerVelocity () const =0
virtual void	setListenerVelocity (const AUD_Vector3 &velocity)=0
virtual AUD_Quaternion	getListenerOrientation () const =0
virtual void	setListenerOrientation (const AUD_Quaternion &orientation)=0
virtual float	getSpeedOfSound () const =0
virtual void	setSpeedOfSound (float speed)=0
virtual float	getDopplerFactor () const =0
virtual void	setDopplerFactor (float factor)=0
virtual AUD_DistanceModel	getDistanceModel () const =0
virtual void	setDistanceModel (AUD_DistanceModel model)=0
virtual AUD_Vector3	getSourceLocation (AUD_Handle *handle)=0
virtual bool	setSourceLocation (AUD_Handle *handle, const AUD_Vector3 &location)=0
virtual AUD_Vector3	getSourceVelocity (AUD_Handle *handle)=0
virtual bool	setSourceVelocity (AUD_Handle *handle, const AUD_Vector3 &velocity)=0
virtual AUD_Quaternion	getSourceOrientation (AUD_Handle *handle)=0
virtual bool	setSourceOrientation (AUD_Handle *handle, const AUD_Quaternion &orientation)=0
virtual bool	isRelative (AUD_Handle *handle)=0
virtual bool	setRelative (AUD_Handle *handle, bool relative)=0
virtual float	getVolumeMaximum (AUD_Handle *handle)=0
virtual bool	setVolumeMaximum (AUD_Handle *handle, float volume)=0
virtual float	getVolumeMinimum (AUD_Handle *handle)=0
virtual bool	setVolumeMinimum (AUD_Handle *handle, float volume)=0
virtual float	getDistanceMaximum (AUD_Handle *handle)=0
virtual bool	setDistanceMaximum (AUD_Handle *handle, float distance)=0
virtual float	getDistanceReference (AUD_Handle *handle)=0
virtual bool	setDistanceReference (AUD_Handle *handle, float distance)=0
virtual float	getAttenuation (AUD_Handle *handle)=0
virtual bool	setAttenuation (AUD_Handle *handle, float factor)=0
virtual float	getConeAngleOuter (AUD_Handle *handle)=0
virtual bool	setConeAngleOuter (AUD_Handle *handle, float angle)=0
virtual float	getConeAngleInner (AUD_Handle *handle)=0
virtual bool	setConeAngleInner (AUD_Handle *handle, float angle)=0
virtual float	getConeVolumeOuter (AUD_Handle *handle)=0
virtual bool	setConeVolumeOuter (AUD_Handle *handle, float volume)=0

---

Detailed Description

This class represents an output device for 3D sound.

Definition at line 43 of file AUD_I3DDevice.h.

---

Member Function Documentation

virtual float AUD_I3DDevice::getAttenuation

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the attenuation of a source.

Parameters:

handle

The handle of the source.

Returns:

The attenuation.

Implemented in AUD_OpenALDevice.

virtual float AUD_I3DDevice::getConeAngleInner

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the inner angle of the cone of a source.

Parameters:

handle

The handle of the source.

Returns:

The inner angle of the cone.

Implemented in AUD_OpenALDevice.

virtual float AUD_I3DDevice::getConeAngleOuter

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the outer angle of the cone of a source.

Parameters:

handle

The handle of the source.

Returns:

The outer angle of the cone.

Implemented in AUD_OpenALDevice.

virtual float AUD_I3DDevice::getConeVolumeOuter

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the outer volume of the cone of a source. The volume between inner and outer angle is interpolated between inner volume and this value.

Parameters:

handle

The handle of the source.

Returns:

The outer volume of the cone.

Implemented in AUD_OpenALDevice.

virtual float AUD_I3DDevice::getDistanceMaximum

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the maximum distance of a source. If a source is further away from the reader than this distance, the volume will automatically be set to 0.

Parameters:

handle

The handle of the source.

Returns:

The maximum distance.

Implemented in AUD_OpenALDevice.

virtual AUD_DistanceModel AUD_I3DDevice::getDistanceModel

(

)

const [pure virtual]

Retrieves the distance model.

Returns:

The distance model.

Implemented in AUD_OpenALDevice.

Referenced by Device_get_distance_model().

virtual float AUD_I3DDevice::getDistanceReference

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the reference distance of a source.

Parameters:

handle

The handle of the source.

Returns:

The reference distance.

Implemented in AUD_OpenALDevice.

virtual float AUD_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 AUD_OpenALDevice.

Referenced by Device_get_doppler_factor().

virtual AUD_Vector3 AUD_I3DDevice::getListenerLocation

(

)

const [pure virtual]

Retrieves the listener location.

Returns:

The listener location.

Implemented in AUD_OpenALDevice.

Referenced by Device_get_listener_location().

virtual AUD_Quaternion AUD_I3DDevice::getListenerOrientation

(

)

const [pure virtual]

Retrieves the listener orientation.

Returns:

The listener orientation as quaternion.

Implemented in AUD_OpenALDevice.

Referenced by Device_get_listener_orientation().

virtual AUD_Vector3 AUD_I3DDevice::getListenerVelocity

(

)

const [pure virtual]

Retrieves the listener velocity.

Returns:

The listener velocity.

Implemented in AUD_OpenALDevice.

Referenced by Device_get_listener_velocity().

virtual AUD_Vector3 AUD_I3DDevice::getSourceLocation

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the location of a source.

Parameters:

handle

The handle of the source.

Returns:

The location.

Implemented in AUD_OpenALDevice.

virtual AUD_Quaternion AUD_I3DDevice::getSourceOrientation

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the orientation of a source.

Parameters:

handle

The handle of the source.

Returns:

The orientation as quaternion.

Implemented in AUD_OpenALDevice.

virtual AUD_Vector3 AUD_I3DDevice::getSourceVelocity

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the velocity of a source.

Parameters:

handle

The handle of the source.

Returns:

The velocity.

Implemented in AUD_OpenALDevice.

virtual float AUD_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 AUD_OpenALDevice.

Referenced by Device_get_speed_of_sound().

virtual float AUD_I3DDevice::getVolumeMaximum

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the maximum volume of a source.

Parameters:

handle

The handle of the source.

Returns:

The maximum volume.

Implemented in AUD_OpenALDevice.

virtual float AUD_I3DDevice::getVolumeMinimum

(

AUD_Handle *

handle

)

[pure virtual]

Retrieves the minimum volume of a source.

Parameters:

handle

The handle of the source.

Returns:

The minimum volume.

Implemented in AUD_OpenALDevice.

virtual bool AUD_I3DDevice::isRelative

(

AUD_Handle *

handle

)

[pure virtual]

Checks whether the source location, velocity and orientation are relative to the listener.

Parameters:

handle

The handle of the source.

Returns:

Whether the source is relative.

Implemented in AUD_OpenALDevice.

virtual bool AUD_I3DDevice::setAttenuation	(	AUD_Handle *	handle,
		float	factor
	)		[pure virtual]

Sets the attenuation of a source. This value is used for distance calculation.

Parameters:

handle	The handle of the source.
factor	The new attenuation.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setAttenuation().

virtual bool AUD_I3DDevice::setConeAngleInner	(	AUD_Handle *	handle,
		float	angle
	)		[pure virtual]

Sets the inner angle of the cone of a source.

Parameters:

handle	The handle of the source.
angle	The new inner angle of the cone.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setConeAngleInner().

virtual bool AUD_I3DDevice::setConeAngleOuter	(	AUD_Handle *	handle,
		float	angle
	)		[pure virtual]

Sets the outer angle of the cone of a source.

Parameters:

handle	The handle of the source.
angle	The new outer angle of the cone.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setConeAngleOuter().

virtual bool AUD_I3DDevice::setConeVolumeOuter	(	AUD_Handle *	handle,
		float	volume
	)		[pure virtual]

Sets the outer volume of the cone of a source. The volume between inner and outer angle is interpolated between inner volume and this value.

Parameters:

handle	The handle of the source.
volume	The new outer volume of the cone.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setConeVolumeOuter().

virtual bool AUD_I3DDevice::setDistanceMaximum	(	AUD_Handle *	handle,
		float	distance
	)		[pure virtual]

Sets the maximum distance of a source. If a source is further away from the reader than this distance, the volume will automatically be set to 0.

Parameters:

handle	The handle of the source.
distance	The new maximum distance.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setDistanceMaximum().

virtual void AUD_I3DDevice::setDistanceModel

(

AUD_DistanceModel

model

)

[pure virtual]

Sets the distance model.

Parameters:

model

distance model.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setDistanceModel(), and Device_set_distance_model().

virtual bool AUD_I3DDevice::setDistanceReference	(	AUD_Handle *	handle,
		float	distance
	)		[pure virtual]

Sets the reference distance of a source.

Parameters:

handle	The handle of the source.
distance	The new reference distance.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setDistanceReference().

virtual void AUD_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 AUD_OpenALDevice.

Referenced by AUD_setDopplerFactor(), and Device_set_doppler_factor().

virtual void AUD_I3DDevice::setListenerLocation

(

const AUD_Vector3 &

location

)

[pure virtual]

Sets the listener location.

Parameters:

location

The new location.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setListenerLocation(), and Device_set_listener_location().

virtual void AUD_I3DDevice::setListenerOrientation

(

const AUD_Quaternion &

orientation

)

[pure virtual]

Sets the listener orientation.

Parameters:

orientation

The new orientation as quaternion.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setListenerOrientation(), and Device_set_listener_orientation().

virtual void AUD_I3DDevice::setListenerVelocity

(

const AUD_Vector3 &

velocity

)

[pure virtual]

Sets the listener velocity.

Parameters:

velocity

The new velocity.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setListenerVelocity(), and Device_set_listener_velocity().

virtual bool AUD_I3DDevice::setRelative	(	AUD_Handle *	handle,
		bool	relative
	)		[pure virtual]

Sets whether the source location, velocity and orientation are relative to the listener.

Parameters:

handle	The handle of the source.
relative	Whether the source is relative.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setRelative().

virtual bool AUD_I3DDevice::setSourceLocation	(	AUD_Handle *	handle,
		const AUD_Vector3 &	location
	)		[pure virtual]

Sets the location of a source.

Parameters:

handle	The handle of the source.
location	The new location.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setSourceLocation().

virtual bool AUD_I3DDevice::setSourceOrientation	(	AUD_Handle *	handle,
		const AUD_Quaternion &	orientation
	)		[pure virtual]

Sets the orientation of a source.

Parameters:

handle	The handle of the source.
orientation	The new orientation as quaternion.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setSourceOrientation().

virtual bool AUD_I3DDevice::setSourceVelocity	(	AUD_Handle *	handle,
		const AUD_Vector3 &	velocity
	)		[pure virtual]

Sets the velocity of a source.

Parameters:

handle	The handle of the source.
velocity	The new velocity.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setSourceVelocity().

virtual void AUD_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 AUD_OpenALDevice.

Referenced by AUD_setSpeedOfSound(), and Device_set_speed_of_sound().

virtual bool AUD_I3DDevice::setVolumeMaximum	(	AUD_Handle *	handle,
		float	volume
	)		[pure virtual]

Sets the maximum volume of a source.

Parameters:

handle	The handle of the source.
volume	The new maximum volume.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setVolumeMaximum().

virtual bool AUD_I3DDevice::setVolumeMinimum	(	AUD_Handle *	handle,
		float	volume
	)		[pure virtual]

Sets the minimum volume of a source.

Parameters:

handle	The handle of the source.
volume	The new minimum volume.

Returns:

Whether the action succeeded.

Implemented in AUD_OpenALDevice.

Referenced by AUD_setVolumeMinimum().

---

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

• AUD_I3DDevice.h