Sleeping Wombat Common Library  0.50.0
swCommonLibrary
Public Types | Public Member Functions | List of all members
AnimationTyped< KeyType > Class Template Referenceabstract

Interface class for manipulating animation keys. More...

#include <Animation.h>

Inheritance diagram for AnimationTyped< KeyType >:
IAnimation AnimationImpl< KeyType, AddressType >

Public Types

typedef IInterpolator< KeyType > Interpolator
 

Public Member Functions

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 InterpolatorGetInterpolator (Size idx)=0
 Gets interpolator under index. You're not owner of this interpolator.
 
virtual const Key< KeyType > * GetKey (TimeType time)=0
 Return key in given time.
 
virtual KeySet< KeyType > & GetKeySet ()=0
 Returns KeySet object.
 
- Public Member Functions inherited from IAnimation
virtual void Animate (Object *object, TimelineBase *timeline)=0
 
virtual void Animate (Object *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 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 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: