The IListener audio object interface.
More...
#include <murl_audio_i_listener.h>
The IListener audio object interface.
This interface represents an audio listener or audio sink, which can be positioned and oriented in 3D world space.
Used internally by Graph::Listener.
Inherited by Murl::Audio::Al11::Listener, and Murl::Audio::Dummy::Listener.
◆ GetObjectInterface() [1/2]
virtual IObject* Murl::Audio::IListener::GetObjectInterface |
( |
| ) |
|
|
pure virtual |
◆ GetObjectInterface() [2/2]
virtual const IObject* Murl::Audio::IListener::GetObjectInterface |
( |
| ) |
const |
|
pure virtual |
◆ Enable()
virtual Bool Murl::Audio::IListener::Enable |
( |
| ) |
|
|
pure virtual |
Enable the listener.
- Returns
- true if successful.
◆ Disable()
virtual Bool Murl::Audio::IListener::Disable |
( |
| ) |
|
|
pure virtual |
Disable the listener.
- Returns
- true if successful.
◆ SetVolume()
virtual Bool Murl::Audio::IListener::SetVolume |
( |
Real |
volume | ) |
|
|
pure virtual |
Set the listener's overall volume (gain).
- Parameters
-
volume | The overall volume, usually in the range 0.0-1.0. |
- Returns
- true if successful.
◆ GetVolume()
virtual Real Murl::Audio::IListener::GetVolume |
( |
| ) |
const |
|
pure virtual |
Get the listener's overall volume (gain).
- Returns
- The overall volume.
◆ SetMaxDistance()
virtual Bool Murl::Audio::IListener::SetMaxDistance |
( |
Real |
maxDistance | ) |
|
|
pure virtual |
Set the maximum hearing distance.
- Parameters
-
maxDistance | The maximum distance. |
- Returns
- true if successful.
◆ GetMaxDistance()
virtual Real Murl::Audio::IListener::GetMaxDistance |
( |
| ) |
const |
|
pure virtual |
Get the maximum hearing distance.
- Returns
- The maximum distance.
◆ SetDistanceModel()
Set the listener's distance model used for attenuation calculation.
See Graph::Listener.
- Parameters
-
distanceModel | The distance model to use. |
- Returns
- true if successful.
◆ GetDistanceModel()
Get the listener's distance model used for attenuation calculation.
- Returns
- The distance model used.
◆ SetWorldTransform()
virtual Bool Murl::Audio::IListener::SetWorldTransform |
( |
const Matrix & |
transform | ) |
|
|
pure virtual |
Set the listener's current world transform.
- Parameters
-
transform | The world transform matrix. |
- Returns
- true if successful.
◆ GetWorldTransform()
virtual const Matrix& Murl::Audio::IListener::GetWorldTransform |
( |
| ) |
const |
|
pure virtual |
Get the listener's current world transform.
- Returns
- The world transform matrix.
◆ GetViewTransform()
virtual const Matrix& Murl::Audio::IListener::GetViewTransform |
( |
| ) |
const |
|
pure virtual |
Get the listener's current view matrix.
The view matrix equals the inverse of the transform matrix.
- Returns
- The view matrix.
◆ IsIntersecting()
virtual Bool Murl::Audio::IListener::IsIntersecting |
( |
const Sphere & |
boundingSphere | ) |
const |
|
pure virtual |
Check if the listener's hearing area intersects a given sphere.
- Parameters
-
boundingSphere | The world-coordinate bounding sphere to check. |
- Returns
- true if the bounding sphere is in hearing range.
◆ SetView()
virtual Bool Murl::Audio::IListener::SetView |
( |
IView * |
view | ) |
|
|
pure virtual |
Set the listener view.
- Parameters
-
- Returns
- true if successful.
◆ GetView()
virtual IView* Murl::Audio::IListener::GetView |
( |
| ) |
const |
|
pure virtual |
Get the listener view.
- Returns
- The view used.
The documentation for this interface was generated from the following file: