Defines an object property which is animable, i.e. More...

#include <OgreAnimable.h>

Inheritance diagram for Ogre::AnimableValue:

Public Types
enum	ValueType { INT , REAL , VECTOR2 , VECTOR3 , VECTOR4 , QUATERNION , COLOUR , RADIAN , DEGREE }
	The type of the value being animated. More...

Public Member Functions
	AnimableValue (ValueType t)

virtual	~AnimableValue ()

virtual void	applyDeltaValue (const Any &val)
	Apply delta value.

virtual void	applyDeltaValue (const ColourValue &)
	Apply delta value.

virtual void	applyDeltaValue (const Degree &)
	Apply delta value.

virtual void	applyDeltaValue (const Quaternion &)
	Apply delta value.

virtual void	applyDeltaValue (const Radian &)
	Apply delta value.

virtual void	applyDeltaValue (const Vector2 &)
	Apply delta value.

virtual void	applyDeltaValue (const Vector3 &)
	Apply delta value.

virtual void	applyDeltaValue (const Vector4 &)
	Apply delta value.

virtual void	applyDeltaValue (int)
	Apply delta value.

virtual void	applyDeltaValue (Real)
	Set value.

ValueType	getType (void) const
	Gets the value type of this animable value.

void	operator delete (void *ptr)

void	operator delete (void ptr, const char , int, const char *)

void	operator delete (void ptr, void )

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info

void *	operator new (size_t sz, void *ptr)
	placement operator new

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info

virtual void	resetToBaseValue (void)

virtual void	setCurrentStateAsBaseValue (void)=0
	Sets the current state as the 'base' value; used for delta animation.

virtual void	setValue (const Any &val)
	Set value.

virtual void	setValue (const ColourValue &)
	Set value.

virtual void	setValue (const Degree &)
	Set value.

virtual void	setValue (const Quaternion &)
	Set value.

virtual void	setValue (const Radian &)
	Set value.

virtual void	setValue (const Vector2 &)
	Set value.

virtual void	setValue (const Vector3 &)
	Set value.

virtual void	setValue (const Vector4 &)
	Set value.

virtual void	setValue (int)
	Set value.

virtual void	setValue (Real)
	Set value.

Protected Member Functions
virtual void	setAsBaseValue (const Any &val)
	Internal method to set a value as base.

virtual void	setAsBaseValue (const ColourValue &val)
	Internal method to set a value as base.

virtual void	setAsBaseValue (const Degree &val)
	Internal method to set a value as base.

virtual void	setAsBaseValue (const Quaternion &val)
	Internal method to set a value as base.

virtual void	setAsBaseValue (const Radian &val)
	Internal method to set a value as base.

virtual void	setAsBaseValue (const Vector2 &val)
	Internal method to set a value as base.

virtual void	setAsBaseValue (const Vector3 &val)
	Internal method to set a value as base.

virtual void	setAsBaseValue (const Vector4 &val)
	Internal method to set a value as base.

virtual void	setAsBaseValue (int val)
	Internal method to set a value as base.

virtual void	setAsBaseValue (Real val)
	Internal method to set a value as base.

Protected Attributes
union {

int mBaseValueInt

Real mBaseValueReal [4]

};
	Base value data.

ValueType	mType
	Value type.

Detailed Description

Defines an object property which is animable, i.e.

may be keyframed.

Remarks: Animable properties are those which can be altered over time by a predefined keyframe sequence. They may be set directly, or they may be modified from their existing state (common if multiple animations are expected to apply at once). Implementors of this interface are expected to override the 'setValue', 'setCurrentStateAsBaseValue' and 'applyDeltaValue' methods appropriate to the type in question, and to initialise the type.

: AnimableValue instances are accessible through any class which extends AnimableObject in order to expose it's animable properties.

Note: This class is an instance of the Adapter pattern, since it generalises access to a particular property. Whilst it could have been templated such that the type which was being referenced was compiled in, this would make it more difficult to aggregated generically, and since animations are often comprised of multiple properties it helps to be able to deal with all values through a single class.

Definition at line 72 of file OgreAnimable.h.

Member Enumeration Documentation

◆ ValueType

enum Ogre::AnimableValue::ValueType

The type of the value being animated.

Enumerator
INT
REAL
VECTOR2
VECTOR3
VECTOR4
QUATERNION
COLOUR
RADIAN
DEGREE

Definition at line 76 of file OgreAnimable.h.

Constructor & Destructor Documentation

◆ AnimableValue()

Ogre::AnimableValue::AnimableValue ( ValueType t )

Definition at line 138 of file OgreAnimable.h.

◆ ~AnimableValue()

virtual Ogre::AnimableValue::~AnimableValue ( )

virtual

Definition at line 139 of file OgreAnimable.h.

Member Function Documentation

◆ applyDeltaValue() [1/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( const Any & val )

virtual

Apply delta value.

◆ applyDeltaValue() [2/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( const ColourValue & )

virtual

Apply delta value.

Definition at line 214 of file OgreAnimable.h.

References OGRE_EXCEPT.

◆ applyDeltaValue() [3/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( const Degree & )

virtual

Apply delta value.

Definition at line 218 of file OgreAnimable.h.

References OGRE_EXCEPT.

◆ applyDeltaValue() [4/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( const Quaternion & )

virtual

Apply delta value.

Definition at line 210 of file OgreAnimable.h.

References OGRE_EXCEPT.

◆ applyDeltaValue() [5/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( const Radian & )

virtual

Apply delta value.

Definition at line 222 of file OgreAnimable.h.

References OGRE_EXCEPT.

◆ applyDeltaValue() [6/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( const Vector2 & )

virtual

Apply delta value.

Definition at line 198 of file OgreAnimable.h.

References OGRE_EXCEPT.

◆ applyDeltaValue() [7/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( const Vector3 & )

virtual

Apply delta value.

Definition at line 202 of file OgreAnimable.h.

References OGRE_EXCEPT.

◆ applyDeltaValue() [8/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( const Vector4 & )

virtual

Apply delta value.

Definition at line 206 of file OgreAnimable.h.

References OGRE_EXCEPT.

◆ applyDeltaValue() [9/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( int )

virtual

Apply delta value.

Definition at line 190 of file OgreAnimable.h.

References OGRE_EXCEPT.

◆ applyDeltaValue() [10/10]

virtual void Ogre::AnimableValue::applyDeltaValue ( Real )

virtual

Set value.

Definition at line 194 of file OgreAnimable.h.

References OGRE_EXCEPT.

◆ getType()

ValueType Ogre::AnimableValue::getType ( void ) const

Gets the value type of this animable value.

Definition at line 142 of file OgreAnimable.h.

◆ operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *	)

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *	)

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *	)

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func )

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr )

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [1/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func )

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ resetToBaseValue()

virtual void Ogre::AnimableValue::resetToBaseValue ( void )

virtual