Rebel Fork Framework
Urho3D::AnimationController Class Reference

Component that drives an AnimatedModel's animations. More...

#include <Urho3D/Graphics/AnimationController.h>

Inheritance diagram for Urho3D::AnimationController:
Urho3D::AnimationStateSource Urho3D::Component Urho3D::Serializable Urho3D::Object Urho3D::RefCounted


struct  AnimationInstance
 Currently playing animations. More...

Public Member Functions

 AnimationController (Context *context)
 ~AnimationController () override
void ApplyAttributes () override
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
void OnSetEnabled () override
 Handle enabled/disabled state change.
void MarkAnimationStateTracksDirty () override
virtual void Update (float timeStep)
 Update the animations. Is called from HandleScenePostUpdate().
void ReplaceAnimations (ea::span< const AnimationParameters > newAnimations, float elapsedTime, float fadeTime)
 Smoothly replace existing animations with animations from external source.
bool IsSkeletonReset () const
void SetSkeletonReset (bool resetSkeleton)
void SetAnimationsAttr (const VariantVector &value)
 Set animation parameters attribute.
VariantVector GetAnimationsAttr () const
 Return animation parameters attribute.
void AddAnimation (const AnimationParameters &params)
void UpdateAnimation (unsigned index, const AnimationParameters &params)
void RemoveAnimation (unsigned index)
void GetAnimationParameters (ea::vector< AnimationParameters > &result) const
ea::vector< AnimationParametersGetAnimationParameters () const
unsigned GetNumAnimations () const
unsigned GetAnimationLayer (unsigned index) const
const AnimationParametersGetAnimationParameters (unsigned index) const
unsigned GetRevision () const
void UpdatePose ()
unsigned FindLastAnimation (Animation *animation, unsigned layer=M_MAX_UNSIGNED) const
const AnimationParametersGetLastAnimationParameters (Animation *animation, unsigned layer=M_MAX_UNSIGNED) const
bool IsPlaying (Animation *animation) const
unsigned PlayNew (const AnimationParameters &params, float fadeInTime=0.0f)
unsigned PlayNewExclusive (const AnimationParameters &params, float fadeInTime=0.0f)
unsigned PlayExisting (const AnimationParameters &params, float fadeInTime=0.0f)
unsigned PlayExistingExclusive (const AnimationParameters &params, float fadeInTime=0.0f)
void Fade (Animation *animation, float targetWeight, float fadeTime)
void Stop (Animation *animation, float fadeTime=0.0f)
void StopLayer (unsigned layer, float fadeTime=0.0f)
void StopLayerExcept (unsigned layer, unsigned exceptionIndex, float fadeTime=0.0f)
void StopAll (float fadeTime=0.0f)
bool UpdateAnimationTime (Animation *animation, float time)
bool UpdateAnimationWeight (Animation *animation, float weight, float fadeTime=0.0f)
bool UpdateAnimationSpeed (Animation *animation, float speed)
bool Play (const ea::string &name, unsigned char layer, bool looped, float fadeTime=0.0f)
bool PlayExclusive (const ea::string &name, unsigned char layer, bool looped, float fadeTime=0.0f)
bool Fade (const ea::string &name, float targetWeight, float fadeTime=0.0f)
bool Stop (const ea::string &name, float fadeTime=0.0f)
bool SetTime (const ea::string &name, float time)
bool SetWeight (const ea::string &name, float weight)
bool SetSpeed (const ea::string &name, float speed)
bool IsPlaying (const ea::string &name) const
float GetTime (const ea::string &name) const
float GetWeight (const ea::string &name) const
float GetSpeed (const ea::string &name) const
- Public Member Functions inherited from Urho3D::AnimationStateSource
 AnimationStateSource (Context *context)
const AnimationStateVector & GetAnimationStates () const
 Return animations states for AnimatedModel.
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 ~Component () override
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 void DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
 Visualize the component as debug geometry.
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 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 void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
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::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.

Protected Member Functions

void OnNodeSet (Node *previousNode, Node *currentNode) override
 Handle node being assigned.
void OnSceneSet (Scene *scene) override
 Handle scene being assigned.
- Protected Member Functions inherited from Urho3D::Component
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.

Private Member Functions

 URHO3D_OBJECT (AnimationController, AnimationStateSource)
void HandleScenePostUpdate (StringHash eventType, VariantMap &eventData)
 Handle scene post-update event.
void SortAnimationStates ()
 Sort animations states according to the layers.
void UpdateAnimationStateTracks (AnimationState *state)
 Update animation state tracks so they are connected to correct animatable objects.
void ConnectToAnimatedModel ()
 Connect to AnimatedModel if possible.
AnimatedAttributeReference ParseAnimatablePath (ea::string_view path, Node *startNode)
 Parse animatable path from starting node.
Node * GetTrackNodeByNameHash (StringHash trackNameHash, Node *startBone) const
 Get animated node (bone or owner node) by track name hash.
AnimationGetAnimationByName (const ea::string &name) const
 Deprecated. Get animation by resource name.
void CommitNodeAndAttributeAnimations ()
void SendTriggerEvents ()
void UpdateInstance (AnimationParameters &params, float timeStep, bool fireTriggers)
ea::optional< float > UpdateInstanceTime (AnimationParameters &params, float timeStep, bool fireTriggers)
void ApplyInstanceAutoFadeOut (AnimationParameters &params, float overtime) const
void UpdateInstanceWeight (AnimationParameters &params, float timeStep) const
void ApplyInstanceRemoval (AnimationParameters &params, bool isCompleted) const
void EnsureStateInitialized (AnimationState *state, const AnimationParameters &params)
void UpdateState (AnimationState *state, const AnimationParameters &params) const

Private Attributes

bool resetSkeleton_ {}
 Whether to reset AnimatedModel skeleton to bind pose every frame.
ea::vector< AnimationInstanceanimations_
ea::vector< AnimationInstancetempAnimations_
ea::vector< ea::pair< Animation *, const AnimationTriggerPoint * > > pendingTriggers_
 Triggers to be fired. Processed all at once due to possible side effects.
unsigned revision_ {}
 Revision that tracks substantial updates of animation state.
ea::unordered_map< Node *, NodeAnimationOutputanimatedNodes_
ea::unordered_map< AnimatedAttributeReference, VariantanimatedAttributes_
bool animationStatesDirty_ {}
bool revisionDirty_ {}

Additional Inherited Members

- Protected Attributes inherited from Urho3D::AnimationStateSource
AnimationStateVector animationStates_
 Animation states. Shared with AnimatedModel when possible.
- 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.

Detailed Description

Component that drives an AnimatedModel's animations.

Member Function Documentation

◆ AddAnimation()

void Urho3D::AnimationController::AddAnimation ( const AnimationParameters params)

Manage played animations on low level.

◆ FindLastAnimation()

unsigned Urho3D::AnimationController::FindLastAnimation ( Animation animation,
unsigned  layer = M_MAX_UNSIGNED 
) const

Manage played animations on high level.

◆ MarkAnimationStateTracksDirty()

void Urho3D::AnimationController::MarkAnimationStateTracksDirty ( )

Mark that animation state tracks are dirty and should be reconnected. Should be called on every substantial change in animated structure.

Implements Urho3D::AnimationStateSource.

◆ Play()

bool Urho3D::AnimationController::Play ( const ea::string &  name,
unsigned char  layer,
bool  looped,
float  fadeTime = 0.0f 


◆ RegisterObject()

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

Register object factory.

◆ UpdateInstance()

void Urho3D::AnimationController::UpdateInstance ( AnimationParameters params,
float  timeStep,
bool  fireTriggers 

Update single animation.

Member Data Documentation

◆ animatedNodes_

ea::unordered_map<Node*, NodeAnimationOutput> Urho3D::AnimationController::animatedNodes_

Temporary buffers for animated values. TODO: Nodes may be expired for unused elements! TODO: Revisit allocations?

◆ animationStatesDirty_

bool Urho3D::AnimationController::animationStatesDirty_ {}

Internal dirty flags cleaned on Update.

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