Skeletal animation resource. More...
#include </home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Graphics/Animation.h>
Inheritance diagram for Urho3D::Animation:
Public Member Functions | |
| Animation (Context *context) | |
| Construct. | |
| ~Animation () override | |
| Destruct. | |
| bool | BeginLoad (Deserializer &source) override |
| Load resource from stream. May be called from a worker thread. Return true if successful. More... | |
| bool | Save (Serializer &dest) const override |
| Save resource. Return true if successful. More... | |
| void | SetAnimationName (const String &name) |
| Set animation name. | |
| void | SetLength (float length) |
| Set animation length. | |
| AnimationTrack * | CreateTrack (const String &name) |
| Create and return a track by name. If track by same name already exists, returns the existing. More... | |
| bool | RemoveTrack (const 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 (i32 index, const AnimationTriggerPoint &trigger) |
| Set a trigger point at index. | |
| void | AddTrigger (const AnimationTriggerPoint &trigger) |
| Add a trigger point. | |
| void | AddTrigger (float time, bool timeIsNormalized, const Variant &data) |
| Add a trigger point. | |
| void | RemoveTrigger (i32 index) |
| Remove a trigger point by index. | |
| void | RemoveAllTriggers () |
| Remove all trigger points. | |
| void | SetNumTriggers (i32 num) |
| Resize trigger point vector. | |
| SharedPtr< Animation > | Clone (const String &cloneName=String::EMPTY) const |
| Clone the animation. | |
| const String & | GetAnimationName () const |
| Return animation name. | |
| StringHash | GetAnimationNameHash () const |
| Return animation name hash. | |
| float | GetLength () const |
| Return animation length. | |
| const HashMap< StringHash, AnimationTrack > & | GetTracks () const |
| Return all animation tracks. | |
| i32 | GetNumTracks () const |
| Return number of animation tracks. | |
| AnimationTrack * | GetTrack (i32 index) |
| Return animation track by index. | |
| AnimationTrack * | GetTrack (const String &name) |
| Return animation track by name. | |
| AnimationTrack * | GetTrack (StringHash nameHash) |
| Return animation track by name hash. | |
| const Vector< AnimationTriggerPoint > & | GetTriggers () const |
| Return animation trigger points. | |
| i32 | GetNumTriggers () const |
| Return number of animation trigger points. | |
| AnimationTriggerPoint * | GetTrigger (i32 index) |
| Return a trigger point by index. | |
 Public Member Functions inherited from Urho3D::ResourceWithMetadata | |
| ResourceWithMetadata (Context *context) | |
| Construct. | |
| void | AddMetadata (const String &name, const Variant &value) |
| Add new metadata variable or overwrite old value. | |
| void | RemoveMetadata (const String &name) |
| Remove metadata variable. | |
| void | RemoveAllMetadata () |
| Remove all metadata variables. | |
| const Variant & | GetMetadata (const String &name) const |
| Return metadata variable. | |
| bool | HasMetadata () const |
| Return whether the resource has metadata. | |
| 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 | BeginLoad (Deserializer &source) |
| Load resource from stream. May be called from a worker thread. Return true if successful. More... | |
| virtual bool | EndLoad () |
| Finish resource loading. Always called from the main thread. Return true if successful. More... | |
| virtual bool | Save (Serializer &dest) const |
| Save resource. Return true if successful. More... | |
| bool | LoadFile (const String &fileName) |
| Load resource from file. | |
| virtual bool | SaveFile (const String &fileName) const |
| Save resource to file. More... | |
| void | SetName (const String &name) |
| Set name. | |
| void | SetMemoryUse (i32 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. | |
| const String & | GetName () const |
| Return name. | |
| StringHash | GetNameHash () const |
| Return name hash. | |
| i32 | GetMemoryUse () const |
| Return memory use in bytes, possibly approximate. | |
| unsigned | GetUseTimer () |
| Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero. | |
| AsyncLoadState | GetAsyncLoadState () const |
| Return the asynchronous loading state. | |
| 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 |
| Return type hash. More... | |
| virtual const String & | GetTypeName () const =0 |
| Return type name. More... | |
| virtual const TypeInfo * | GetTypeInfo () 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 | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event. | |
| void | SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr) |
| 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 Vector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events). | |
| void | SendEvent (StringHash eventType) |
| Send event to all subscribers. | |
| void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers. | |
| VariantMap & | GetEventDataMap () 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, Args... args) |
| Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another. | |
| Context * | GetContext () const |
| Return execution context. | |
| const Variant & | GetGlobalVar (StringHash key) const |
| Return global variable based on key. | |
| const VariantMap & | GetGlobalVars () const |
| Return all global variables. | |
| void | SetGlobalVar (StringHash key, const Variant &value) |
| Set global variable with the respective key and value. | |
| Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type. | |
| Object * | GetEventSender () const |
| Return active event sender. Null outside event handling. | |
| EventHandler * | GetEventHandler () 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 String & | GetCategory () const |
| Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. | |
| 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. | |
| RefCounted & | operator= (const RefCounted &rhs)=delete |
| Prevent assignment. | |
| void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. | |
| void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. | |
| int | Refs () const |
| Return reference count. | |
| int | WeakRefs () const |
| Return weak reference count. | |
| RefCount * | RefCountPtr () |
| Return pointer to the reference count structure. | |
Static Public Member Functions | |
| static void | RegisterObject (Context *context) |
| Register object factory. | |
| Static Public Member Functions inherited from Urho3D::Object | |
| static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static. | |
Private Member Functions | |
| URHO3D_OBJECT (Animation, ResourceWithMetadata) | |
Private Attributes | |
| String | animationName_ |
| Animation name. | |
| StringHash | animationNameHash_ |
| Animation name hash. | |
| float | length_ |
| Animation length. | |
| HashMap< StringHash, AnimationTrack > | tracks_ |
| Animation tracks. | |
| Vector< AnimationTriggerPoint > | triggers_ |
| Animation trigger points. | |
Additional Inherited Members | |
| Protected Member Functions inherited from Urho3D::ResourceWithMetadata | |
| void | LoadMetadataFromXML (const XMLElement &source) |
| Load metadata from <metadata> children of XML element. | |
| void | LoadMetadataFromJSON (const JSONArray &array) |
| Load metadata from JSON array. | |
| void | SaveMetadataToXML (XMLElement &destination) const |
| Save as <metadata> children of XML element. | |
| void | CopyMetadata (const ResourceWithMetadata &source) |
| Copy metadata from another resource. | |
| Protected Attributes inherited from Urho3D::Object | |
| Context * | context_ |
| Execution context. | |
Detailed Description
Skeletal animation resource.
Member Function Documentation
◆ BeginLoad()
|
overridevirtual |
Load resource from stream. May be called from a worker thread. Return true if successful.
Reimplemented from Urho3D::Resource.
◆ CreateTrack()
| AnimationTrack * Urho3D::Animation::CreateTrack | ( | const String & | name | ) |
Create and return a track by name. If track by same name already exists, returns the existing.
- Todo:
- When tracks / keyframes are created dynamically, memory use is not updated
◆ Save()
|
overridevirtual |
Save resource. Return true if successful.
Reimplemented from Urho3D::Resource.
The documentation for this class was generated from the following files:
- /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Graphics/Animation.h
- /home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Graphics/Animation.cpp
