Rebel Fork Framework
Urho3D::SoundSource3D Class Reference

Sound source component with three-dimensional position. More...

#include <Urho3D/Audio/SoundSource3D.h>

Inheritance diagram for Urho3D::SoundSource3D:
Urho3D::SoundSource Urho3D::Component Urho3D::Serializable Urho3D::Object Urho3D::RefCounted

Public Member Functions

 SoundSource3D (Context *context)
void DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
 Visualize the component as debug geometry.
void Update (float timeStep) override
 Update sound source.
void SetDistanceAttenuation (float nearDistance, float farDistance, float rolloffFactor)
 Set attenuation parameters.
void SetAngleAttenuation (float innerAngle, float outerAngle)
 Set angle attenuation parameters.
void SetNearDistance (float distance)
void SetFarDistance (float distance)
void SetInnerAngle (float angle)
void SetOuterAngle (float angle)
void SetRolloffFactor (float factor)
void CalculateAttenuation ()
 Calculate attenuation and panning based on current position and listener position.
float GetNearDistance () const
float GetFarDistance () const
float GetInnerAngle () const
float GetOuterAngle () const
float RollAngleoffFactor () const
- Public Member Functions inherited from Urho3D::SoundSource
 SoundSource (Context *context)
 ~SoundSource () override
 Destruct. Remove self from the audio subsystem.
void Seek (float seekTime)
 Seek to time.
void Play (Sound *sound)
 Play a sound.
void Play (Sound *sound, float frequency)
 Play a sound with specified frequency.
void Play (Sound *sound, float frequency, float gain)
 Play a sound with specified frequency and gain.
void Play (Sound *sound, float frequency, float gain, float panning)
 Play a sound with specified frequency, gain and panning.
void Play (SoundStream *stream)
 Start playing a sound stream.
void Stop ()
 Stop playback.
void SetSoundType (const ea::string &type)
void SetFrequency (float frequency)
void SetGain (float gain)
void SetAttenuation (float attenuation)
 Set attenuation. 1.0 is unaltered. Used for distance attenuated playback.
void SetPanning (float panning)
void SetReach (float reach)
void SetLowFrequency (bool state)
void SetAutoRemoveMode (AutoRemoveMode mode)
void SetPlayPosition (signed char *pos)
 Set new playback position.
void SetIgnoreSceneTimeScale (bool ignoreSceneTimeScale)
 Enable or disable ignore scene time scale mode.
SoundGetSound () const
volatile signed char * GetPlayPosition () const
 Return playback position.
ea::string GetSoundType () const
float GetTimePosition () const
float GetFrequency () const
float GetGain () const
float GetAttenuation () const
float GetPanning () const
float GetReach () const
bool IsLowFrequency () const
AutoRemoveMode GetAutoRemoveMode () const
bool GetIgnoreSceneTimeScale () const
 Return true if sound source ignores scene time scale.
bool IsPlaying () const
void Mix (int dest[], unsigned samples, int mixRate, SpeakerMode mode, bool interpolation)
 Mix sound source output to a 32-bit clipping buffer. Called by Audio.
void UpdateMasterGain ()
 Update the effective master gain. Called internally and by Audio when the master gain changes.
void SetSoundAttr (const ResourceRef &value)
 Set sound attribute.
void SetPositionAttr (int value)
 Set sound position attribute.
ResourceRef GetSoundAttr () const
 Return sound attribute.
void SetPlayingAttr (bool value)
 Set sound playing attribute.
int GetPositionAttr () const
 Return sound position attribute.
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 ~Component () override
virtual void OnSetEnabled ()
 Handle enabled/disabled state change.
AttributeScopeHint GetEffectiveScopeHint () const
bool Save (Serializer &dest) const override
 Save as binary data. Return true if successful.
bool SaveXML (XMLElement &dest) const override
 Save as XML data. Return true if successful.
bool SaveJSON (JSONValue &dest) const override
 Save as JSON data. Return true if successful.
virtual void GetDependencyNodes (ea::vector< Node * > &dest)
 Return the depended on nodes to order network updates.
virtual bool HasAuxiliaryData () const
virtual void SerializeAuxiliaryData (Archive &archive)
 Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
void SetEnabled (bool enable)
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned GetID () const
Node * GetNode () const
SceneGetScene () const
 Return the scene the node belongs to.
bool IsEnabled () const
bool IsEnabledEffective () const
ea::string GetFullNameDebug () const
 Return full component name for debugging. Unique for each component in the scene. Slow!
ComponentGetComponent (StringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
unsigned GetIndexInParent () const
 Return index of this component in the node.
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 ~Serializable () override
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
 Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual ObjectReflectionGetReflection () const
 Return reflection used for serialization.
virtual const ea::vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
void SerializeInBlock (Archive &archive) override
 Serialize content from/to archive. May throw ArchiveException.
void SerializeInBlock (Archive &archive, bool serializeTemporary)
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful.
virtual bool Load (const ea::string &resourceName)
 Load from binary resource.
virtual bool LoadXML (const ea::string &resourceName)
 Load from XML resource.
virtual bool LoadJSON (const ea::string &resourceName)
 Load from JSON resource.
virtual bool LoadFile (const ea::string &resourceName)
 Load from resource of automatically detected type.
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual bool SaveDefaultAttributes (const AttributeInfo &attr) const
 Return whether should save default-valued attributes into XML. Default false.
bool SetAttribute (unsigned index, const Variant &value)
bool SetAttribute (const ea::string &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
void SetInstanceDefault (bool enable)
 (Internal use) Set instance-level default flag.
void SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
 (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
virtual Variant GetInstanceDefault (const ea::string &name) const
 (Internal use) Get instance-level default value.
void ResetToDefault ()
 Reset all editable attributes to their default values.
void RemoveInstanceDefault ()
 Remove instance's default values if they are set previously.
void SetTemporary (bool enable)
Variant GetAttribute (unsigned index) const
Variant GetAttribute (const ea::string &name) const
 Return attribute value by name. Return empty if not found.
Variant GetAttributeDefault (unsigned index) const
Variant GetAttributeDefault (const ea::string &name) const
 Return attribute default value by name. Return empty if not found.
unsigned GetNumAttributes () const
void CopyAttributes (const Serializable *source, bool resetToDefault=true)
 Copy all attributes from another serializable.
bool IsTemporary () const
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
virtual const ea::string & GetTypeName () const =0
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
virtual bool IsInstanceOf (StringHash type) const =0
 Check whether current instance implements specified type.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 Subscribe to a specific sender's event.
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
void UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
ContextGetContext () const
 Return execution context.
const VariantGetGlobalVar (StringHash key) const
const VariantMapGetGlobalVars () const
void SetGlobalVar (StringHash key, const Variant &value)
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
bool HasEventHandlers () const
 Return whether has subscribed to any event.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
const ea::string & GetCategory () const
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
int AddRef ()
int ReleaseRef ()
int Refs () const
int WeakRefs () const
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
bool IsScriptStrongRef () const
 Return true if script reference is strong.

Static Public Member Functions

static void RegisterObject (Context *context)
- Static Public Member Functions inherited from Urho3D::SoundSource
static void RegisterObject (Context *context)
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.

Protected Attributes

float nearDistance_
 Near distance.
float farDistance_
 Far distance.
float innerAngle_
 Inner angle for directional attenuation.
float outerAngle_
 Outer angle for directional attenuation.
float rolloffFactor_
 Rolloff power factor.
- Protected Attributes inherited from Urho3D::SoundSource
WeakPtr< Audioaudio_
 Audio subsystem.
ea::string soundType_
 SoundSource type, determines the master gain group.
StringHash soundTypeHash_
 SoundSource type hash.
float frequency_
float gain_
float attenuation_
float panning_
 Stereo panning.
float reach_ {0.0f}
 Surround sound forward/back reach.
float masterGain_ {}
 Effective master gain.
bool sendFinishedEvent_
 Whether finished event should be sent on playback stop.
bool lowFrequency_ { false }
 Whether this source should output to the LFE.
AutoRemoveMode autoRemove_
 Automatic removal mode.
- Protected Attributes inherited from Urho3D::Component
Node * node_
 Scene node.
unsigned id_
 Unique ID within the scene.
bool networkUpdate_
 Network update queued flag.
bool enabled_
 Enabled flag.
- Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMapinstanceDefaultValues_
 Attribute default value at each instance level.
bool setInstanceDefault_
 When true, store the attribute value as instance's default value (internal use only).
bool temporary_
 Temporary flag.
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.

Private Member Functions

 URHO3D_OBJECT (SoundSource3D, SoundSource)

Additional Inherited Members

- Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
- Protected Member Functions inherited from Urho3D::Component
virtual void OnNodeSet (Node *previousNode, Node *currentNode)
 Handle scene node being assigned at creation.
virtual void OnSceneSet (Scene *scene)
 Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here.
virtual void OnMarkedDirty (Node *node)
 Handle scene node transform dirtied.
virtual void OnNodeSetEnabled (Node *node)
 Handle scene node enabled status changing.
void SetID (unsigned id)
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
ComponentGetFixedUpdateSource ()
 Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
void DoAutoRemove (AutoRemoveMode mode)
 Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.

Detailed Description

Sound source component with three-dimensional position.

Member Function Documentation

◆ GetFarDistance()

float Urho3D::SoundSource3D::GetFarDistance ( ) const

Return far distance.

◆ GetInnerAngle()

float Urho3D::SoundSource3D::GetInnerAngle ( ) const

Return inner angle in degrees.

◆ GetNearDistance()

float Urho3D::SoundSource3D::GetNearDistance ( ) const

Return near distance.

◆ GetOuterAngle()

float Urho3D::SoundSource3D::GetOuterAngle ( ) const

Return outer angle in degrees.

◆ RegisterObject()

void Urho3D::SoundSource3D::RegisterObject ( Context context)

Register object factory.

◆ RollAngleoffFactor()

float Urho3D::SoundSource3D::RollAngleoffFactor ( ) const

Return rolloff power factor.

◆ SetFarDistance()

void Urho3D::SoundSource3D::SetFarDistance ( float  distance)

Set far distance. Outside this range sound will be completely attenuated.

◆ SetInnerAngle()

void Urho3D::SoundSource3D::SetInnerAngle ( float  angle)

Set inner angle in degrees. Inside this angle sound will not be attenuated.By default 360, meaning direction never has an effect.

◆ SetNearDistance()

void Urho3D::SoundSource3D::SetNearDistance ( float  distance)

Set near distance. Inside this range sound will not be attenuated.

◆ SetOuterAngle()

void Urho3D::SoundSource3D::SetOuterAngle ( float  angle)

Set outer angle in degrees. Outside this angle sound will be completely attenuated. By default 360, meaning direction never has an effect.

◆ SetRolloffFactor()

void Urho3D::SoundSource3D::SetRolloffFactor ( float  factor)

Set rolloff power factor, defines attenuation function shape.

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