AttenuationZone¶
class AttenuationZone
The propagation shape for positional sounds.
This allows to increase the attenuation according to the shape of the sound propagation.
Functions¶
| Name | Description |
|---|---|
| ~AttenuationZone | Default destructor. |
| GetAttenuationFactor | Returns the attenuation factor. |
| GetAttenuationFactor | Returns the attenuation factor. |
Function Details¶
GetAttenuationFactor¶
virtual AmReal32 GetAttenuationFactor(const Attenuation* attenuation, const AmVec3& soundLocation, const Listener& listener) = 0
Returns the attenuation factor.
This method is used only for position based sound sources.
- Parameter
attenuation - The Attenuator object to use for distance attenuation.
- Parameter
soundLocation - The location of the sound source.
- Parameter
listener - The listener for which compute the attenuation.
- Return
- The attenuation factor.
virtual AmReal32 GetAttenuationFactor(const Attenuation* attenuation, const Entity& entity, const Listener& listener) = 0
Returns the attenuation factor.
This method is used by position and orientation based sound sources.
- Parameter
attenuation - The Attenuator object to use for distance attenuation.
- Parameter
entity - The entity which emits the sound.
- Parameter
listener - The listener for which compute the attenuation.
- Return
- The attenuation factor.
~AttenuationZone¶
virtual ~AttenuationZone() = default
Default destructor.