AnimationTyped< KeyType > Class Template Reference

Interface class for manipulating animation keys. More...

#include <Animation.h>

Inheritance diagram for AnimationTyped< KeyType >:

Public Types
typedef IInterpolator< KeyType >	Interpolator

Public Member Functions
virtual	~AnimationTyped ()=default
virtual bool	AddKey (TimeType time, const KeyType &value)=0
	Adds key and sets default interpolator. More...
virtual bool	AddKey (TimeType time, const KeyType &value, InterpolatorType interpolatorType)=0
	Adds key and sets given interpolator. More...
virtual bool	UpdateKey (TimeType time, const KeyType &newValue, UPtr< Interpolator > &&interpolator)=0
	Udates key given by time. Sets new interpolator. More...
virtual bool	UpdateKey (TimeType time, const KeyType &newValue)=0
	Updates key. Leaves interpolator unchanged. More...
virtual bool	RemoveKey (TimeType time)=0
	Removes key in given time. More...
virtual bool	ChangeInterpolator (Size idx, UPtr< Interpolator > &&interpolator)=0
	Updates interpolator. Key remains unchanged. More...
virtual bool	ChangeInterpolator (Size idx, InterpolatorType interpolatorType)=0
	Updates interpolator. You can set only built in interpolators. If you want to set your own interpolators use second overload instead. More...
virtual Interpolator *	GetInterpolator (Size idx)=0
	Gets interpolator under index. You're not owner of this interpolator. More...
virtual const Key< KeyType > *	GetKey (TimeType time)=0
	Return key in given time. More...
virtual KeySet< KeyType > &	GetKeySet ()=0
	Returns KeySet object. More...
Public Member Functions inherited from IAnimation
	IAnimation ()=default
virtual	~IAnimation ()=default
virtual void	Animate (EngineObject *object, TimelineBase *timeline)=0
virtual void	Animate (EngineObject *object, TimeType time)=0

Detailed Description

template<typename KeyType>
class AnimationTyped< KeyType >

Interface class for manipulating animation keys.

Inherit from this class to specialize parameter addressing method.

Member Typedef Documentation

template<typename KeyType >

typedef IInterpolator< KeyType > AnimationTyped< KeyType >::Interpolator

Constructor & Destructor Documentation

template<typename KeyType >

virtual AnimationTyped< KeyType >::~AnimationTyped ( )

virtualdefault

Member Function Documentation

template<typename KeyType >

virtual bool AnimationTyped< KeyType >::AddKey ( TimeType  time, const KeyType &  value  )

pure virtual

Adds key and sets default interpolator.

Returns

False if key already exists.

Implemented in AnimationImpl< KeyType, AddressType >.

template<typename KeyType >

virtual bool AnimationTyped< KeyType >::AddKey ( TimeType  time, const KeyType &  value, InterpolatorType  interpolatorType  )

pure virtual

Adds key and sets given interpolator.

Returns

False if key already exists.

Implemented in AnimationImpl< KeyType, AddressType >.

template<typename KeyType >

virtual bool AnimationTyped< KeyType >::ChangeInterpolator ( Size  idx, UPtr< Interpolator > &&  interpolator  )

pure virtual

Updates interpolator. Key remains unchanged.

Returns

False if there's no interpolator under given index.

Implemented in AnimationImpl< KeyType, AddressType >.

template<typename KeyType >

virtual bool AnimationTyped< KeyType >::ChangeInterpolator ( Size  idx, InterpolatorType  interpolatorType  )

pure virtual

Updates interpolator. You can set only built in interpolators. If you want to set your own interpolators use second overload instead.

Returns

False if there's no interpolator under given index.

Implemented in AnimationImpl< KeyType, AddressType >.

template<typename KeyType >

virtual Interpolator* AnimationTyped< KeyType >::GetInterpolator ( Size  idx )

pure virtual

Gets interpolator under index. You're not owner of this interpolator.

Implemented in AnimationImpl< KeyType, AddressType >.

template<typename KeyType >

virtual const Key< KeyType >* AnimationTyped< KeyType >::GetKey ( TimeType  time )

pure virtual

Return key in given time.

Implemented in AnimationImpl< KeyType, AddressType >.

template<typename KeyType >

virtual KeySet< KeyType >& AnimationTyped< KeyType >::GetKeySet ( )

pure virtual

Returns KeySet object.

Implemented in AnimationImpl< KeyType, AddressType >.

template<typename KeyType >

virtual bool AnimationTyped< KeyType >::RemoveKey ( TimeType  time )

pure virtual

Removes key in given time.

Returns

False if There's no key in given time.

Implemented in AnimationImpl< KeyType, AddressType >.

template<typename KeyType >

virtual bool AnimationTyped< KeyType >::UpdateKey ( TimeType  time, const KeyType &  newValue, UPtr< Interpolator > &&  interpolator  )

pure virtual

Udates key given by time. Sets new interpolator.

Returns

False if There's no key in given time.

Implemented in AnimationImpl< KeyType, AddressType >.

template<typename KeyType >

virtual bool AnimationTyped< KeyType >::UpdateKey ( TimeType  time, const KeyType &  newValue  )

pure virtual

Updates key. Leaves interpolator unchanged.

Returns

False if There's no key in given time.

Implemented in AnimationImpl< KeyType, AddressType >.

---

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

• D:/ProgramyVS/SWLibraries/swCommonLib/ParameterAnimation/Animation/Animation.h