Rebel Fork Framework
Urho3D::Animatable Class Referenceabstract

Base class for animatable object, an animatable object can be set animation on it's attributes, or can be set an object animation to it. More...

#include <Urho3D/Scene/Animatable.h>

Inheritance diagram for Urho3D::Animatable:
Urho3D::Serializable Urho3D::Object Urho3D::RefCounted Urho3D::UIElement Urho3D::BorderImage Urho3D::ScrollView Urho3D::Sprite Urho3D::ToolTip Urho3D::UISelectable Urho3D::Button Urho3D::CheckBox Urho3D::Cursor Urho3D::LineEdit Urho3D::ProgressBar Urho3D::ScrollBar Urho3D::Slider Urho3D::Window Urho3D::ListView Urho3D::Text

Public Member Functions

 Animatable (Context *context)
 ~Animatable () override
bool LoadXML (const XMLElement &source) override
 Load from XML data. Return true if successful.
bool SaveXML (XMLElement &dest) const override
 Save as XML data. Return true if successful.
bool LoadJSON (const JSONValue &source) override
 Load from JSON data. Return true if successful.
bool SaveJSON (JSONValue &dest) const override
 Save as JSON data. Return true if successful.
void SetAnimationEnabled (bool enable)
void SetAnimationTime (float time)
 Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.
void SetObjectAnimation (ObjectAnimation *objectAnimation)
void SetAttributeAnimation (const ea::string &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
 Set attribute animation.
void SetAttributeAnimationWrapMode (const ea::string &name, WrapMode wrapMode)
 Set attribute animation wrap mode.
void SetAttributeAnimationSpeed (const ea::string &name, float speed)
 Set attribute animation speed.
void SetAttributeAnimationTime (const ea::string &name, float time)
 Set attribute animation time position manually. Automatic update should be disabled in this case.
void RemoveObjectAnimation ()
 Remove object animation. Same as calling SetObjectAnimation with a null pointer.
void RemoveAttributeAnimation (const ea::string &name)
 Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.
bool GetAnimationEnabled () const
ObjectAnimationGetObjectAnimation () const
ValueAnimationGetAttributeAnimation (const ea::string &name) const
 Return attribute animation.
WrapMode GetAttributeAnimationWrapMode (const ea::string &name) const
 Return attribute animation wrap mode.
float GetAttributeAnimationSpeed (const ea::string &name) const
 Return attribute animation speed.
float GetAttributeAnimationTime (const ea::string &name) const
 Return attribute animation time position.
void SetObjectAnimationAttr (const ResourceRef &value)
 Set object animation attribute.
ResourceRef GetObjectAnimationAttr () const
 Return object animation attribute.
- 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 Save (Serializer &dest) const
 Save as binary 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 void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
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

virtual void OnAttributeAnimationAdded ()=0
 Handle attribute animation added.
virtual void OnAttributeAnimationRemoved ()=0
 Handle attribute animation removed.
virtual AnimatableFindAttributeAnimationTarget (const ea::string &name, ea::string &outName)
 Find target of an attribute animation from object hierarchy by name.
void SetObjectAttributeAnimation (const ea::string &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed)
 Set object attribute animation internal.
void OnObjectAnimationAdded (ObjectAnimation *objectAnimation)
 Handle object animation added.
void OnObjectAnimationRemoved (ObjectAnimation *objectAnimation)
 Handle object animation removed.
void UpdateAttributeAnimations (float timeStep)
 Update attribute animations.
AttributeAnimationInfoGetAttributeAnimationInfo (const ea::string &name) const
 Return attribute animation info.
void HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData)
 Handle attribute animation added.
void HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData)
 Handle attribute animation removed.

Protected Attributes

bool animationEnabled_
 Animation enabled.
SharedPtr< ObjectAnimationobjectAnimation_
ea::unordered_map< ea::string, SharedPtr< AttributeAnimationInfo > > attributeAnimationInfos_
 Attribute animation infos.
- 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.

Private Member Functions

 URHO3D_OBJECT (Animatable, Serializable)

Detailed Description

Base class for animatable object, an animatable object can be set animation on it's attributes, or can be set an object animation to it.

Member Function Documentation

◆ GetAnimationEnabled()

bool Urho3D::Animatable::GetAnimationEnabled ( ) const

Return animation enabled.

◆ GetObjectAnimation()

ObjectAnimation * Urho3D::Animatable::GetObjectAnimation ( ) const

Return object animation.

◆ RegisterObject()

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

Register object factory.

◆ SetAnimationEnabled()

void Urho3D::Animatable::SetAnimationEnabled ( bool  enable)

Set automatic update of animation, default true.

◆ SetObjectAnimation()

void Urho3D::Animatable::SetObjectAnimation ( ObjectAnimation objectAnimation)

Set object animation.

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