Open 3D Engine EMotionFX Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
EMStudio::AnimGraphEventHandler Class Reference

Inherits EMotionFX::EventHandler.

Public Member Functions

AZ_CLASS_ALLOCATOR_DECL AnimGraphEventHandler (AnimGraphPlugin *plugin)
 
const AZStd::vector< EMotionFX::EventTypes > GetHandledEventTypes () const override
 
void OnSetVisualManipulatorOffset (EMotionFX::AnimGraphInstance *animGraphInstance, size_t paramIndex, const AZ::Vector3 &offset) override
 
void OnInputPortsChanged (EMotionFX::AnimGraphNode *node, const AZStd::vector< AZStd::string > &newInputPorts, const AZStd::string &memberName, const AZStd::vector< AZStd::string > &memberValue) override
 
void OnOutputPortsChanged (EMotionFX::AnimGraphNode *node, const AZStd::vector< AZStd::string > &newOutputPorts, const AZStd::string &memberName, const AZStd::vector< AZStd::string > &memberValue) override
 
bool OnRayIntersectionTest (const AZ::Vector3 &start, const AZ::Vector3 &end, EMotionFX::IntersectionInfo *outIntersectInfo) override
 
void OnDeleteAnimGraph (EMotionFX::AnimGraph *animGraph) override
 
void OnDeleteAnimGraphInstance (EMotionFX::AnimGraphInstance *animGraphInstance) override
 
- Public Member Functions inherited from EMotionFX::EventHandler
virtual void OnEvent (const EventInfo &eventInfo)
 
virtual const AZStd::vector< EventTypes > GetHandledEventTypes () const =0
 
virtual void OnPlayMotion (Motion *motion, PlayBackInfo *info)
 
virtual void OnStartMotionInstance (MotionInstance *motionInstance, PlayBackInfo *info)
 
virtual void OnDeleteMotionInstance (MotionInstance *motionInstance)
 
virtual void OnDeleteMotion (Motion *motion)
 
virtual void OnStop (MotionInstance *motionInstance)
 
virtual void OnHasLooped (MotionInstance *motionInstance)
 
virtual void OnHasReachedMaxNumLoops (MotionInstance *motionInstance)
 
virtual void OnHasReachedMaxPlayTime (MotionInstance *motionInstance)
 
virtual void OnIsFrozenAtLastFrame (MotionInstance *motionInstance)
 
virtual void OnChangedPauseState (MotionInstance *motionInstance)
 
virtual void OnChangedActiveState (MotionInstance *motionInstance)
 
virtual void OnStartBlending (MotionInstance *motionInstance)
 
virtual void OnStopBlending (MotionInstance *motionInstance)
 
virtual void OnQueueMotionInstance (MotionInstance *motionInstance, PlayBackInfo *info)
 
virtual void OnDeleteActor (Actor *actor)
 
virtual void OnSimulatePhysics (float timeDelta)
 
virtual void OnCustomEvent (uint32 eventType, void *data)
 
virtual void OnDrawTriangle (const AZ::Vector3 &posA, const AZ::Vector3 &posB, const AZ::Vector3 &posC, const AZ::Vector3 &normalA, const AZ::Vector3 &normalB, const AZ::Vector3 &normalC, uint32 color)
 
virtual void OnDrawTriangles ()
 
virtual void OnCreateAnimGraph (AnimGraph *animGraph)
 
virtual void OnCreateAnimGraphInstance (AnimGraphInstance *animGraphInstance)
 
virtual void OnCreateMotion (Motion *motion)
 
virtual void OnCreateMotionSet (MotionSet *motionSet)
 
virtual void OnCreateMotionInstance (MotionInstance *motionInstance)
 
virtual void OnCreateMotionSystem (MotionSystem *motionSystem)
 
virtual void OnCreateActor (Actor *actor)
 
virtual void OnPostCreateActor (Actor *actor)
 
virtual void OnDeleteAnimGraph (AnimGraph *animGraph)
 
virtual void OnDeleteAnimGraphInstance (AnimGraphInstance *animGraphInstance)
 
virtual void OnDeleteMotionSet (MotionSet *motionSet)
 
virtual void OnDeleteMotionSystem (MotionSystem *motionSystem)
 
virtual bool OnRayIntersectionTest (const AZ::Vector3 &start, const AZ::Vector3 &end, IntersectionInfo *outIntersectInfo)
 
virtual void OnStateEnter (AnimGraphInstance *animGraphInstance, AnimGraphNode *state)
 
virtual void OnStateEntering (AnimGraphInstance *animGraphInstance, AnimGraphNode *state)
 
virtual void OnStateExit (AnimGraphInstance *animGraphInstance, AnimGraphNode *state)
 
virtual void OnStateEnd (AnimGraphInstance *animGraphInstance, AnimGraphNode *state)
 
virtual void OnStartTransition (AnimGraphInstance *animGraphInstance, AnimGraphStateTransition *transition)
 
virtual void OnEndTransition (AnimGraphInstance *animGraphInstance, AnimGraphStateTransition *transition)
 
virtual void OnSetVisualManipulatorOffset (AnimGraphInstance *animGraphInstance, size_t paramIndex, const AZ::Vector3 &offset)
 
virtual void OnInputPortsChanged (AnimGraphNode *node, const AZStd::vector< AZStd::string > &newInputPorts, const AZStd::string &memberName, const AZStd::vector< AZStd::string > &memberValue)
 
virtual void OnOutputPortsChanged (AnimGraphNode *node, const AZStd::vector< AZStd::string > &newOutputPorts, const AZStd::string &memberName, const AZStd::vector< AZStd::string > &memberValue)
 
virtual void OnRenamedNode (AnimGraph *animGraph, AnimGraphNode *node, const AZStd::string &oldName)
 
virtual void OnCreatedNode (AnimGraph *animGraph, AnimGraphNode *node)
 
virtual void OnRemoveNode (AnimGraph *animGraph, AnimGraphNode *nodeToRemove)
 
virtual void OnRemovedChildNode (AnimGraph *animGraph, AnimGraphNode *parentNode)
 
virtual void OnProgressStart ()
 
virtual void OnProgressEnd ()
 
virtual void OnProgressText (const char *text)
 
virtual void OnProgressValue (float percentage)
 
virtual void OnSubProgressText (const char *text)
 
virtual void OnSubProgressValue (float percentage)
 
virtual void OnScaleActorData (Actor *actor, float scaleFactor)
 
virtual void OnScaleMotionData (Motion *motion, float scaleFactor)
 

Member Function Documentation

◆ GetHandledEventTypes()

const AZStd::vector< EMotionFX::EventTypes > EMStudio::AnimGraphEventHandler::GetHandledEventTypes ( ) const
inlineoverridevirtual

Event handlers need to overload this function and return the list of events they are interested about

Implements EMotionFX::EventHandler.

◆ OnDeleteAnimGraph()

void EMStudio::AnimGraphEventHandler::OnDeleteAnimGraph ( EMotionFX::AnimGraph *  animGraph)
overridevirtual

Reimplemented from EMotionFX::EventHandler.

◆ OnDeleteAnimGraphInstance()

void EMStudio::AnimGraphEventHandler::OnDeleteAnimGraphInstance ( EMotionFX::AnimGraphInstance *  animGraphInstance)
overridevirtual

Reimplemented from EMotionFX::EventHandler.

◆ OnInputPortsChanged()

void EMStudio::AnimGraphEventHandler::OnInputPortsChanged ( EMotionFX::AnimGraphNode *  node,
const AZStd::vector< AZStd::string > &  newInputPorts,
const AZStd::string &  memberName,
const AZStd::vector< AZStd::string > &  memberValue 
)
overridevirtual

Reimplemented from EMotionFX::EventHandler.

◆ OnOutputPortsChanged()

void EMStudio::AnimGraphEventHandler::OnOutputPortsChanged ( EMotionFX::AnimGraphNode *  node,
const AZStd::vector< AZStd::string > &  newOutputPorts,
const AZStd::string &  memberName,
const AZStd::vector< AZStd::string > &  memberValue 
)
overridevirtual

Reimplemented from EMotionFX::EventHandler.

◆ OnRayIntersectionTest()

bool EMStudio::AnimGraphEventHandler::OnRayIntersectionTest ( const AZ::Vector3 &  start,
const AZ::Vector3 &  end,
EMotionFX::IntersectionInfo *  outIntersectInfo 
)
overridevirtual

Perform a ray intersection test and return the intersection info. The first event handler registered that sets the IntersectionInfo::m_isValid to true will be outputting to the outIntersectInfo parameter.

Parameters
startThe start point, in world space.
endThe end point, in world space.
outIntersectInfoThe resulting intersection info.
Returns
Returns true when an intersection occurred and false when no intersection occurred.

Reimplemented from EMotionFX::EventHandler.

◆ OnSetVisualManipulatorOffset()

void EMStudio::AnimGraphEventHandler::OnSetVisualManipulatorOffset ( EMotionFX::AnimGraphInstance *  animGraphInstance,
size_t  paramIndex,
const AZ::Vector3 &  offset 
)
overridevirtual

Reimplemented from EMotionFX::EventHandler.

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