EMotionFX::Integration::ActorNotifications Class Reference

#include <AnimationBus.h>

Inherits AZ::ComponentBus.

Public Types
typedef AZStd::recursive_mutex	MutexType

Public Member Functions
virtual void	OnMotionEvent (MotionEvent)
virtual void	OnMotionLoop (const char *)
virtual void	OnStateEntering (const char *)
virtual void	OnStateEntered (const char *)
virtual void	OnStateExiting (const char *)
virtual void	OnStateExited (const char *)
virtual void	OnStateTransitionStart (const char *, const char *)
virtual void	OnStateTransitionEnd (const char *, const char *)

Static Public Attributes
static const bool	EnableEventQueue = true

Detailed Description

EMotion FX Actor Notification Bus Used for monitoring EMotion FX per-actor events.

Member Function Documentation

OnMotionEvent()

virtual void EMotionFX::Integration::ActorNotifications::OnMotionEvent ( MotionEvent  )

inlinevirtual

A motion event has fired during playback.

Parameters

motionEvent

information about the event.

OnMotionLoop()

virtual void EMotionFX::Integration::ActorNotifications::OnMotionLoop ( const char *  )

inlinevirtual

A motion has looped.

Parameters

motionName

name of the motion.

OnStateEntered()

virtual void EMotionFX::Integration::ActorNotifications::OnStateEntered ( const char *  )

inlinevirtual

A anim graph state has been entered.

Parameters

stateName

name of the state.

OnStateEntering()

virtual void EMotionFX::Integration::ActorNotifications::OnStateEntering ( const char *  )

inlinevirtual

A anim graph state is about to be entered.

Parameters

stateName

name of the state.

OnStateExited()

virtual void EMotionFX::Integration::ActorNotifications::OnStateExited ( const char *  )

inlinevirtual

A anim graph state has been exited.

Parameters

stateName

name of the state.

OnStateExiting()

virtual void EMotionFX::Integration::ActorNotifications::OnStateExiting ( const char *  )

inlinevirtual

A anim graph state is about to be exited.

Parameters

stateName

name of the state.

OnStateTransitionEnd()

virtual void EMotionFX::Integration::ActorNotifications::OnStateTransitionEnd ( const char *  , const char *    )

inlinevirtual

A transition between states has completed.

Parameters

fromState	name of source state.
toState	name of target state.

OnStateTransitionStart()

virtual void EMotionFX::Integration::ActorNotifications::OnStateTransitionStart ( const char *  , const char *    )

inlinevirtual

A transition between states is beginning.

Parameters

fromState	name of source state.
toState	name of target state.

Member Data Documentation

EnableEventQueue

const bool EMotionFX::Integration::ActorNotifications::EnableEventQueue = true

static

Bus is accessed from job threads as well as simulation threads. This allows events to be safely queued from anywhere, and flushed from the main simulation thread.

---

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

• Gems/EMotionFX/Code/Include/Integration/AnimationBus.h