Urho3D::ObjectAnimation Class Reference

Object animation class, an object animation include one or more attribute animations and theirs wrap mode and speed for an Animatable object. More...

#include <Urho3D/Scene/ObjectAnimation.h>

Inheritance diagram for Urho3D::ObjectAnimation:

Public Member Functions
	ObjectAnimation (Context *context)
	Construct.
	~ObjectAnimation () override
	Destruct.
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.
bool	LoadXML (const XMLElement &source)
	Load from XML data. Return true if successful.
bool	SaveXML (XMLElement &dest) const
	Save as XML data. Return true if successful.
bool	LoadJSON (const JSONValue &source)
	Load from JSON data. Return true if successful.
bool	SaveJSON (JSONValue &dest) const
	Save as JSON data. Return true if successful.
void	AddAttributeAnimation (const ea::string &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
	Add attribute animation, attribute name can in following format: "attribute" or "#0/#1/attribute" or ""#0/#1/@component#1/attribute.
void	RemoveAttributeAnimation (const ea::string &name)
	Remove attribute animation, attribute name can in following format: "attribute" or "#0/#1/attribute" or ""#0/#1/@component#1/attribute.
void	RemoveAttributeAnimation (ValueAnimation *attributeAnimation)
	Remove attribute animation.
ValueAnimation *	GetAttributeAnimation (const ea::string &name) const
WrapMode	GetAttributeAnimationWrapMode (const ea::string &name) const
float	GetAttributeAnimationSpeed (const ea::string &name) const
const ea::unordered_map< ea::string, SharedPtr< ValueAnimationInfo > > &	GetAttributeAnimationInfos () const
	Return all attribute animations infos.
ValueAnimationInfo *	GetAttributeAnimationInfo (const ea::string &name) const
	Return attribute animation info by name.
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 TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
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.
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, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &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 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.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () 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::Resource
static Resource *	LoadFromCache (Context *context, StringHash type, const ea::string &name)
	Load resource by reference.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (ObjectAnimation, Resource)
void	SendAttributeAnimationAddedEvent (const ea::string &name)
	Send attribute animation added event.
void	SendAttributeAnimationRemovedEvent (const ea::string &name)
	Send attribute animation remove event.

Private Attributes
ea::unordered_map< ea::string, SharedPtr< ValueAnimationInfo > >	attributeAnimationInfos_
	Name to attribute animation info mapping.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Object animation class, an object animation include one or more attribute animations and theirs wrap mode and speed for an Animatable object.

Member Function Documentation

GetAttributeAnimation()

ValueAnimation * Urho3D::ObjectAnimation::GetAttributeAnimation

(

const ea::string &

name

)

const

Return attribute animation by name.

GetAttributeAnimationSpeed()

float Urho3D::ObjectAnimation::GetAttributeAnimationSpeed

(

const ea::string &

name

)

const

Return attribute animation speed by name.

GetAttributeAnimationWrapMode()

WrapMode Urho3D::ObjectAnimation::GetAttributeAnimationWrapMode

(

const ea::string &

name

)

const

Return attribute animation wrap mode by name.

RegisterObject()

void Urho3D::ObjectAnimation::RegisterObject ( Context *  context )

static

Register object factory.

---

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

• Urho3D/Scene/ObjectAnimation.h
• Urho3D/Scene/ObjectAnimation.cpp