Browse Source

Audio: Remove getter/setter cross references

Should be obvious and are positioned above each other, so getting to the
getter from the setter vice versa should be easy.

Signed-off-by: Squareys <Squareys@googlemail.com>
pull/110/head
Squareys 11 years ago
parent
commit
03106cf5cb
  1. 12
      src/Magnum/Audio/Listener.h
  2. 6
      src/Magnum/Audio/Playable.h
  3. 12
      src/Magnum/Audio/PlayableGroup.h
  4. 28
      src/Magnum/Audio/Source.h

12
src/Magnum/Audio/Listener.h

@ -132,10 +132,7 @@ template <UnsignedInt dimensions> class Listener: public SceneGraph::AbstractFea
SceneGraph::AbstractFeature<dimensions, Float>::setCachedTransformations(SceneGraph::CachedTransformation::Absolute);
}
/**
* @brief Sound transformation
* @see @ref Listener::setSoundTransformation()
*/
/** @brief Sound transformation */
const Matrix4& soundTransformation() const {
return _soundTransformation;
}
@ -145,7 +142,6 @@ template <UnsignedInt dimensions> class Listener: public SceneGraph::AbstractFea
* @param soundTransformation Transformation for transforming from
* world to listener space
* @return Reference to self (for method chaining)
* @see @ref Listener::soundTransformation()
*/
Listener<dimensions>& setSoundTransformation(const Matrix4& soundTransformation) {
_soundTransformation = soundTransformation;
@ -164,10 +160,7 @@ template <UnsignedInt dimensions> class Listener: public SceneGraph::AbstractFea
*/
void update(std::initializer_list<std::reference_wrapper<PlayableGroup<dimensions>>> groups);
/**
* @brief Listener gain
* @see @ref Listener::setGain()
*/
/** @brief Listener gain */
Float gain() const {
return _gain;
}
@ -176,7 +169,6 @@ template <UnsignedInt dimensions> class Listener: public SceneGraph::AbstractFea
* @brief Set listener gain
* @param gain Gain
* @return Reference to self (for method chaining)
* @see @ref Listener::gain()
*/
Listener<dimensions>& setGain(Float gain) {
_gain = gain;

6
src/Magnum/Audio/Playable.h

@ -107,10 +107,7 @@ template<UnsignedInt dimensions> class Playable: public SceneGraph::AbstractGrou
return _source;
}
/**
* @brief Gain
* @see @ref Playable::setGain()
*/
/** @brief Gain */
Float gain() const {
return _gain;
}
@ -122,7 +119,6 @@ template<UnsignedInt dimensions> class Playable: public SceneGraph::AbstractGrou
* The sources gain is computed as `sourceGain = playableGain*groupGain`.
* Default for the playables gain is `1.0f`.
* @see @ref PlayableGroup::setGain(), @ref Source::setGain()
* @see @ref Playable::gain()
*/
Playable& setGain(const Float gain) {
_gain = gain;

12
src/Magnum/Audio/PlayableGroup.h

@ -117,10 +117,7 @@ template<UnsignedInt dimensions> class PlayableGroup: public SceneGraph::Feature
return *this;
}
/**
* @brief Gain
* @see @ref PlayableGroup::setGain()
*/
/** @brief Gain */
Float gain() const {
return _gain;
}
@ -134,7 +131,6 @@ template<UnsignedInt dimensions> class PlayableGroup: public SceneGraph::Feature
* `sourceGain = playableGain*groupGain`. Default of the groups gain
* is `1.0f`.
* @return Reference to self (for method chaining)
* @see @ref PlayableGroup::gain()
*/
PlayableGroup& setGain(const Float gain) {
_gain = gain;
@ -144,10 +140,7 @@ template<UnsignedInt dimensions> class PlayableGroup: public SceneGraph::Feature
return *this;
}
/**
* @brief Sound transformation
* @see @ref PlayableGroup::setSoundTransformation()
*/
/** @brief Sound transformation */
const Matrix4& soundTransformation() const {
return _soundTransform;
}
@ -155,7 +148,6 @@ template<UnsignedInt dimensions> class PlayableGroup: public SceneGraph::Feature
/**
* @brief Set transformation of the sounds in this group
* @return Reference to self (for method chaining)
* @see @ref PlayableGroup::soundTransformation()
*/
PlayableGroup& setSoundTransformation(const Matrix4& matrix);

28
src/Magnum/Audio/Source.h

@ -85,7 +85,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Position
* @see @ref setPosition(), @fn_al{GetSourcefv} with @def_al{POSITION}
* @see @fn_al{GetSourcefv} with @def_al{POSITION}
*/
Vector3 position() const {
Vector3 v;
@ -115,7 +115,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Velocity
* @see @ref setVelocity(), @fn_al{GetSourcefv} with @def_al{VELOCITY}
* @see @fn_al{GetSourcefv} with @def_al{VELOCITY}
*/
Vector3 velocity() const {
Vector3 v;
@ -145,7 +145,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Whether the source is interpreted relative to the listener
* @see @ref setRelative(), @ref position(), @ref direction(), @ref velocity(),
* @see @ref position(), @ref direction(), @ref velocity(),
* @fn_al{GetSourcei} with @def_al{SOURCE_RELATIVE}
*/
bool isRelative() const {
@ -173,7 +173,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Gain
* @see @ref setGain(), @fn_al{GetSourcef} with @def_al{GAIN}
* @see @fn_al{GetSourcef} with @def_al{GAIN}
*/
Float gain() const {
Float gain;
@ -197,7 +197,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Minimal gain to clamp to
* @see @ref setMinGain(), @ref setMaxGain(), @ref setGain(), @ref maxGain(),
* @see @ref setMaxGain(), @ref setGain(), @ref maxGain(),
* @ref gain(), @fn_al{GetSourcef} with @def_al{MIN_GAIN}
*/
Float minGain() const {
@ -213,7 +213,7 @@ class MAGNUM_AUDIO_EXPORT Source {
* If effective gain is lower than min gain, min gain is used. Note
* that this is done before listener gain is applied. Default is
* `0.0f`.
* @see @ref setMinGain(), @ref setGain(), @fn_al{Sourcef} with
* @see @ref setMaxGain(), @ref setGain(), @fn_al{Sourcef} with
* @def_al{MIN_GAIN}
*/
Source& setMinGain(Float gain) {
@ -223,7 +223,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Maximal gain to clamp to
* @see @ref setMaxGain(), @ref setMinGain(), @ref setGain(), @ref maxGain(),
* @see @ref setMinGain(), @ref setGain(), @ref maxGain(),
* @ref gain(), @fn_al{GetSourcef} with @def_al{MAX_GAIN}
*/
Float maxGain() const {
@ -249,7 +249,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Reference distance
* @see @ref setReferenceDistance(), @fn_al{GetSourcef} with @def_al{REFERENCE_DISTANCE}
* @see @fn_al{GetSourcef} with @def_al{REFERENCE_DISTANCE}
*/
Float referenceDistance() const {
Float distance;
@ -282,7 +282,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Rolloff factor
* @see @ref setRolloffFactor(), @fn_al{GetSourcef} with @def_al{ROLLOFF_FACTOR}
* @see @fn_al{GetSourcef} with @def_al{ROLLOFF_FACTOR}
*/
Float rolloffFactor() const {
Float factor;
@ -343,7 +343,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Direction
* @see @ref setDirection(), @fn_al{GetSourcefv} with @def_al{DIRECTION}
* @see @fn_al{GetSourcefv} with @def_al{DIRECTION}
*/
Vector3 direction() const {
Vector3 direction;
@ -375,7 +375,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Inner cone angle
* @see @ref setInnerConeAngle(), @fn_al{GetSourcef} with @def_al{CONE_INNER_ANGLE}
* @see @fn_al{GetSourcef} with @def_al{CONE_INNER_ANGLE}
*/
Deg innerConeAngle() const {
Float angle;
@ -399,7 +399,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Outer cone angle
* @see @ref setOuterConeAngle(), @fn_al{GetSourcef} with @def_al{CONE_OUTER_ANGLE}
* @see @fn_al{GetSourcef} with @def_al{CONE_OUTER_ANGLE}
*/
Deg outerConeAngle() const {
Float angle;
@ -424,7 +424,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Outer cone gain
* @see @ref setOuterConeGain(), @fn_al{GetSourcef} with @def_al{CONE_OUTER_GAIN}
* @see @fn_al{GetSourcef} with @def_al{CONE_OUTER_GAIN}
*/
Float outerConeGain() const {
Float gain;
@ -448,7 +448,7 @@ class MAGNUM_AUDIO_EXPORT Source {
/**
* @brief Pitch
* @see @ref setPitch(), @fn_al{GetSourcef} with @def_al{PITCH}
* @see @fn_al{GetSourcef} with @def_al{PITCH}
*/
Float pitch() const {
Float pitch;

Loading…
Cancel
Save