Properties of a logical audio source. A source also has a pose, which can be stored as a component of a source entity via gz::sim::components::Pose. More...
#include <LogicalAudio.hh>
Public Member Functions | |
| bool | operator!= (const Source &_source) const |
| bool | operator== (const Source &_source) const |
Public Attributes | |
| logical_audio::AttenuationFunction | attFunc |
| The source's attenuation function. More... | |
| logical_audio::AttenuationShape | attShape |
| The source's attenuation shape. More... | |
| double | emissionVolume |
| The source's emission volume, which should be between 0.0 (0% volume) and 1.0 (100% volume) More... | |
| double | falloffDistance |
| The source's falloff distance, which should be greater than Source::innerRadius. More... | |
| unsigned int | id |
| The source's id. More... | |
| double | innerRadius |
| The source's inner radius, which should be >= 0. More... | |
Detailed Description
Properties of a logical audio source. A source also has a pose, which can be stored as a component of a source entity via gz::sim::components::Pose.
Member Function Documentation
◆ operator!=()
|
inline |
◆ operator==()
|
inline |
References Source::id.
Member Data Documentation
◆ attFunc
The source's attenuation function.
Referenced by LogicalAudioSourceSerializer::Deserialize(), and LogicalAudioSourceSerializer::Serialize().
◆ attShape
| logical_audio::AttenuationShape attShape |
The source's attenuation shape.
Referenced by LogicalAudioSourceSerializer::Deserialize(), and LogicalAudioSourceSerializer::Serialize().
◆ emissionVolume
| double emissionVolume |
The source's emission volume, which should be between 0.0 (0% volume) and 1.0 (100% volume)
Referenced by LogicalAudioSourceSerializer::Deserialize(), and LogicalAudioSourceSerializer::Serialize().
◆ falloffDistance
| double falloffDistance |
The source's falloff distance, which should be greater than Source::innerRadius.
Referenced by LogicalAudioSourceSerializer::Deserialize(), and LogicalAudioSourceSerializer::Serialize().
◆ id
| unsigned int id |
The source's id.
Referenced by LogicalAudioSourceSerializer::Deserialize(), Source::operator==(), and LogicalAudioSourceSerializer::Serialize().
◆ innerRadius
| double innerRadius |
The source's inner radius, which should be >= 0.
Referenced by LogicalAudioSourceSerializer::Deserialize(), and LogicalAudioSourceSerializer::Serialize().
The documentation for this struct was generated from the following file: