SFXFMODEventSource
Engine/source/sfx/fmod/sfxFMODEventSource.h
An SFXSource that controls the playback of an SFXFMODEvent.
Public Types
Parent
Protected Attributes
FMOD_EVENT *
The event instance handle for this source.
Protected Functions
SFXFMODEventSource(SFXFMODEvent * event)
_onParameterEvent(SFXParameter * parameter, SFXParameterEvent event)
_setFadeTimes(F32 fadeInTime, F32 fadeOutTime)
_setMinMaxDistance(F32 min, F32 max)
Set 3D min/max distance without affecting CustomRadiusFlag.
Update 3D position, velocity, and orientation from current source transform.
Update the effective pitch of the source.
Update the effective priority of the source.
Update the playback status of the source.
_updateVolume(const MatrixF & listener)
Update the effective volume of the source.
Public Functions
DECLARE_CATEGORY("SFX FMOD" )
DECLARE_DESCRIPTION("An <a href="/coding/file/sfxsystem_8h/#sfxsystem_8h_1a52e87f85ae30be82ffefd31b5c03e03d">SFX</a> <a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> controlling the playback of an FMOD Designer event." )
getEvent()
Return the FMOD event object that is being played back by this source.
setTransform(const MatrixF & transform)
Sets the position and orientation for a 3d buffer.
setVelocity(const VectorF & velocity)
Sets the velocity for a 3d buffer.
Public Static Functions
create(SFXFMODEvent * event)
Create a new source for the given event.
Detailed Description
An SFXSource that controls the playback of an SFXFMODEvent.
SFXFMODEvents can be played back directly through their console methods. However, this class integrates them with the remaining SFX system and makes events usable wherever SFX tracks are usable though with the important distinction that there can only ever be a single source for a given event.
Note that calling playback methods directly on an event will cause a source for the event to be created if there is not already one.
Be aware that using fade-outs in events in combination with play-once sources does not work well at the moment.
Public Types
typedef SFXSource Parent
Protected Attributes
FMOD_EVENT * mHandle
The event instance handle for this source.
Protected Functions
SFXFMODEventSource(SFXFMODEvent * event)
_onParameterEvent(SFXParameter * parameter, SFXParameterEvent event)
Reimplemented from: SFXSource
_setCone(F32 innerAngle, F32 outerAngle, F32 outerVolume)
Reimplemented from: SFXSource
_setFadeTimes(F32 fadeInTime, F32 fadeOutTime)
Reimplemented from: SFXSource
_setMinMaxDistance(F32 min, F32 max)
Reimplemented from: SFXSource
_update3DAttributes()
Update 3D position, velocity, and orientation from current source transform.
_updatePitch()
Reimplemented from: SFXSource
_updatePriority()
Reimplemented from: SFXSource
_updateStatus()
Reimplemented from: SFXSource
_updateVolume(const MatrixF & listener)
Reimplemented from: SFXSource
Public Functions
SFXFMODEventSource()
~SFXFMODEventSource()
DECLARE_CATEGORY("SFX FMOD" )
DECLARE_CONOBJECT(SFXFMODEventSource )
DECLARE_DESCRIPTION("An <a href="/coding/file/sfxsystem_8h/#sfxsystem_8h_1a52e87f85ae30be82ffefd31b5c03e03d">SFX</a> <a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> controlling the playback of an FMOD Designer event." )
getEvent()
Return the FMOD event object that is being played back by this source.
pause(F32 fadeOutTime)
Reimplemented from: SFXSource
play(F32 fadeInTime)
Reimplemented from: SFXSource
setTransform(const MatrixF & transform)
Reimplemented from: SFXSource
setVelocity(const VectorF & velocity)
Reimplemented from: SFXSource
stop(F32 fadeOutTime)
Reimplemented from: SFXSource