Urho3D::ValueAnimation Class Reference

Value animation class. More...

#include <Urho3D/Scene/ValueAnimation.h>

Inheritance diagram for Urho3D::ValueAnimation:

Collaboration diagram for Urho3D::ValueAnimation:

Public Member Functions
	ValueAnimation (Context *context)
	Construct.
virtual	~ValueAnimation ()
	Destruct.
virtual bool	BeginLoad (Deserializer &source)
	Load resource from stream. May be called from a worker thread. Return true if successful.
virtual bool	Save (Serializer &dest) const
	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 XML data. Return true if successful.
void	SetOwner (void *owner)
	Set owner.
void	SetInterpolationMethod (InterpMethod method)
	Set interpolation method.
void	SetSplineTension (float tension)
	Set spline tension, should be between 0.0f and 1.0f, but this is not a must.
void	SetValueType (VariantType valueType)
	Set value type.
bool	SetKeyFrame (float time, const Variant &value)
	Set key frame.
void	SetEventFrame (float time, const StringHash &eventType, const VariantMap &eventData=VariantMap())
	Set event frame.
bool	IsValid () const
	Return animation is valid.
void *	GetOwner () const
	Return owner.
InterpMethod	GetInterpolationMethod () const
	Return interpolation method.
float	GetSplineTension () const
	Return spline tension.
VariantType	GetValueType () const
	Return value type.
float	GetBeginTime () const
	Return begin time.
float	GetEndTime () const
	Return end time.
Variant	GetAnimationValue (float scaledTime)
	Return animation value.
bool	HasEventFrames () const
	Has event frames.
void	GetEventFrames (float beginTime, float endTime, PODVector< const VAnimEventFrame * > &eventFrames) const
	Return all event frames between time.
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.
void	SetName (const String &name)
	Set 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.
const String &	GetName () const
	Return name.
StringHash	GetNameHash () const
	Return name hash.
unsigned	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.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash.
virtual const String &	GetTypeName () const =0
	Return type name.
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.
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	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 PODVector< 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. More...
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
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.
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.
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.

Protected Member Functions
Variant	LinearInterpolation (unsigned index1, unsigned index2, float scaledTime) const
	Linear interpolation.
Variant	SplineInterpolation (unsigned index1, unsigned index2, float scaledTime)
	Spline interpolation.
void	UpdateSplineTangents ()
	Update spline tangents.
Variant	SubstractAndMultiply (const Variant &value1, const Variant &value2, float t) const
	Return (value1 - value2) * t.

Protected Attributes
void *	owner_
	Owner.
InterpMethod	interpolationMethod_
	Interpolation method.
float	splineTension_
	Spline tension.
VariantType	valueType_
	Value type.
bool	interpolatable_
	Interpolatable flag.
float	beginTime_
	Begin time.
float	endTime_
	End time.
Vector< VAnimKeyFrame >	keyFrames_
	Key frames.
VariantVector	splineTangents_
	Spline tangents.
bool	splineTangentsDirty_
	Spline tangents dirty.
Vector< VAnimEventFrame >	eventFrames_
	Event frames.

Private Member Functions
	URHO3D_OBJECT (ValueAnimation, Resource)

Detailed Description

Value animation class.

---

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

• Source/Urho3D/Scene/ValueAnimation.h
• Source/Urho3D/Scene/ValueAnimation.cpp