Rebel Fork Framework
Urho3D::Animation Class Reference

#include <Urho3D/Graphics/Animation.h>

Inheritance diagram for Urho3D::Animation:
Urho3D::ResourceWithMetadata Urho3D::ObjectRevisionTracker Urho3D::Resource Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Animation (Context *context)
 Construct.
 
 ~Animation () override
 Destruct.
 
void ResetToDefault ()
 Reset resource state to default.
 
bool LoadXML (const XMLElement &source)
 Load resource from XML file.
 
bool BeginLoad (Deserializer &source) override
 Load resource from stream. May be called from a worker thread. Return true if successful.
 
bool Save (Serializer &dest) const override
 Save resource. Return true if successful.
 
void SetAnimationName (const ea::string &name)
 
void SetLength (float length)
 
AnimationTrackCreateTrack (const ea::string &name)
 Create and return a track by name. If track by same name already exists, returns the existing. More...
 
VariantAnimationTrackCreateVariantTrack (const ea::string &name)
 Create and return generic variant track by name. If variant track by same name already exists, returns the existing. More...
 
bool RemoveTrack (const ea::string &name)
 Remove a track by name. Return true if was found and removed successfully. This is unsafe if the animation is currently used in playback.
 
void RemoveAllTracks ()
 Remove all tracks. This is unsafe if the animation is currently used in playback.
 
void SetTrigger (unsigned index, const AnimationTriggerPoint &trigger)
 
void AddTrigger (const AnimationTriggerPoint &trigger)
 Add a trigger point.
 
void AddTrigger (float time, bool timeIsNormalized, const Variant &data)
 Add a trigger point.
 
void RemoveTrigger (unsigned index)
 Remove a trigger point by index.
 
void RemoveAllTriggers ()
 Remove all trigger points.
 
void SetNumTriggers (unsigned num)
 
SharedPtr< AnimationClone (const ea::string &cloneName=EMPTY_STRING) const
 Clone the animation.
 
const ea::string & GetAnimationName () const
 
StringHash GetAnimationNameHash () const
 Return animation name hash.
 
float GetLength () const
 
const ea::unordered_map< StringHash, AnimationTrack > & GetTracks () const
 Return all animation tracks.
 
unsigned GetNumTracks () const
 
AnimationTrackGetTrack (unsigned index)
 Return animation track by index.
 
AnimationTrackGetTrack (const ea::string &name)
 
AnimationTrackGetTrack (StringHash nameHash)
 Return animation track by name hash.
 
const ea::vector< AnimationTriggerPoint > & GetTriggers () const
 Return animation trigger points.
 
unsigned GetNumTriggers () const
 
AnimationTriggerPointGetTrigger (unsigned index)
 Return a trigger point by index.
 
void SetTracks (const ea::vector< AnimationTrack > &tracks)
 Set all animation tracks.
 
const ea::unordered_map< StringHash, VariantAnimationTrack > & GetVariantTracks () const
 
unsigned GetNumVariantTracks () const
 
VariantAnimationTrackGetVariantTrack (unsigned index)
 
VariantAnimationTrackGetVariantTrack (const ea::string &name)
 
VariantAnimationTrackGetVariantTrack (StringHash nameHash)
 
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
 Construct.
 
bool Load (Deserializer &source)
 Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.
 
virtual bool EndLoad ()
 Finish resource loading. Always called from the main thread. Return true if successful.
 
bool LoadFile (const FileIdentifier &fileName)
 Load resource from file.
 
virtual bool SaveFile (const FileIdentifier &fileName) const
 Save resource to file.
 
void SetName (const ea::string &name)
 
void SetMemoryUse (unsigned size)
 Set memory use in bytes, possibly approximate.
 
void ResetUseTimer ()
 Reset last used timer.
 
void SetAsyncLoadState (AsyncLoadState newState)
 Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
 
void SetAbsoluteFileName (const ea::string &fileName)
 Set absolute file name.
 
const ea::string & GetName () const
 
StringHash GetNameHash () const
 Return name hash.
 
unsigned GetMemoryUse () const
 
unsigned GetUseTimer ()
 
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
 
const ea::string & GetAbsoluteFileName () const
 Return absolute file name.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
 ~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.
 
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
 
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.
 
- Public Member Functions inherited from Urho3D::ObjectRevisionTracker
unsigned GetRevision () const
 Return object revision.
 

Static Public Member Functions

static void RegisterObject (Context *context)
 
- Static Public Member Functions inherited from Urho3D::Resource
static ResourceLoadFromCache (Context *context, StringHash type, const ea::string &name)
 Load resource by reference.
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Private Member Functions

 URHO3D_OBJECT (Animation, ResourceWithMetadata)
 
void LoadTracksFromXML (const XMLElement &source)
 
void LoadVariantTracksFromXML (const XMLElement &source)
 
void LoadTriggersFromXML (const XMLElement &source)
 

Private Attributes

ea::string animationName_
 Animation name.
 
StringHash animationNameHash_
 Animation name hash.
 
float length_
 Animation length.
 
ea::unordered_map< StringHash, AnimationTracktracks_
 Animation tracks.
 
ea::unordered_map< StringHash, VariantAnimationTrackvariantTracks_
 Generic variant animation tracks.
 
ea::vector< AnimationTriggerPointtriggers_
 Animation trigger points.
 

Static Private Attributes

static const unsigned legacyVersion = 1
 
static const unsigned variantTrackVersion = 2
 
static const unsigned trackWeightVersion = 3
 
static const unsigned channelWeightVersion = 4
 
static const unsigned currentVersion = channelWeightVersion
 

Additional Inherited Members

- Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
 
- Static Public Attributes inherited from Urho3D::ObjectRevisionTracker
static constexpr unsigned InvalidRevision = 0
 
- Protected Member Functions inherited from Urho3D::ObjectRevisionTracker
void MarkRevisionUpdated ()
 Mark object as changed.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Detailed Description

Skeletal animation resource. Don't use bone tracks and generic variant tracks with the same names.

Member Function Documentation

◆ CreateTrack()

AnimationTrack * Urho3D::Animation::CreateTrack ( const ea::string &  name)

Create and return a track by name. If track by same name already exists, returns the existing.

◆ CreateVariantTrack()

VariantAnimationTrack * Urho3D::Animation::CreateVariantTrack ( const ea::string &  name)

Create and return generic variant track by name. If variant track by same name already exists, returns the existing.

◆ GetAnimationName()

const ea::string& Urho3D::Animation::GetAnimationName ( ) const
inline

Return animation name.

◆ GetLength()

float Urho3D::Animation::GetLength ( ) const
inline

Return animation length.

◆ GetNumTracks()

unsigned Urho3D::Animation::GetNumTracks ( ) const
inline

Return number of animation tracks.

◆ GetNumTriggers()

unsigned Urho3D::Animation::GetNumTriggers ( ) const
inline

Return number of animation trigger points.

◆ GetTrack()

AnimationTrack * Urho3D::Animation::GetTrack ( const ea::string &  name)

Return animation track by name.

◆ GetVariantTracks()

const ea::unordered_map<StringHash, VariantAnimationTrack>& Urho3D::Animation::GetVariantTracks ( ) const
inline

Return generic variant animation tracks.

◆ RegisterObject()

void Urho3D::Animation::RegisterObject ( Context context)
static

Register object factory.

◆ SetAnimationName()

void Urho3D::Animation::SetAnimationName ( const ea::string &  name)

Set animation name.

◆ SetLength()

void Urho3D::Animation::SetLength ( float  length)

Set animation length.

◆ SetNumTriggers()

void Urho3D::Animation::SetNumTriggers ( unsigned  num)

Resize trigger point vector.

◆ SetTrigger()

void Urho3D::Animation::SetTrigger ( unsigned  index,
const AnimationTriggerPoint trigger 
)

Set a trigger point at index.

Member Data Documentation

◆ legacyVersion

const unsigned Urho3D::Animation::legacyVersion = 1
staticprivate

Class versions (used for serialization)


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