Class CAnimation

class CAnimation : public CBase;

Description

Pure virtual base class for animations.

This defines an abstracted interface between a client application and an animation. Most of the implementation details are handled by an animator plugin. The source of the animation data and its interpretation are usually handled by a data provider.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CAnimation - Pure virtual base class for animations.

Members

Defined in CAnimation:

• Freeze()Causes whatever ticker this animation provides to its animator to be frozen unti...
• Hold()Puts an animation on hold, which is similar to pause, but keeps track of the tim...
• Pause()Causes the animation to stop, but without rewinding.
• Resume()Causes a paused animation to continue from where it left off.
• SetPosition(const TPoint &)Sets the coordinates of the animation. This generally refers to the top left cor...
• Start(const TAnimationConfig &)Causes the animation to start, at the first time step or logical equivalent. If ...
• Stop()Causes the animation to stop, and rewinds to the first frame.
• Unfreeze()Causes whatever ticker this animation provides to its animator to be unfrozen.
• Unhold()Resumes a held animation.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• CAnimationDataProviderPure virtual base class for data providers.
• CAnimatorPure virtual base class for animators.
• MAnimationObserverInterface used by an animation to report events to the client application.

virtual void Start(const TAnimationConfig &aConfig)=0;

Description

Causes the animation to start, at the first time step or logical equivalent. If the animation is already running, it rewinds.

Parameters

const TAnimationConfig &aConfig Specifies run time attributes of the animation.

See also:

• TAnimationConfigThese are passed to animator objects when an animation is started and provide so...

virtual void Stop()=0;

Description

Causes the animation to stop, and rewinds to the first frame.

virtual void Pause()=0;

Description

Causes the animation to stop, but without rewinding.

virtual void Resume()=0;

Description

Causes a paused animation to continue from where it left off.

virtual void Hold()=0;

Description

Puts an animation on hold, which is similar to pause, but keeps track of the time steps passing and catches up when resumed. This can be used to temporarily cease processing an animation without it getting out of step with others.

virtual void Unhold()=0;

Description

Resumes a held animation.

virtual void SetPosition(const TPoint &aPoint)=0;

Description

Sets the coordinates of the animation. This generally refers to the top left corner of the total area the animation covers.

Parameters

const TPoint &aPoint The new coordinates of the animation (usually the top left corner)

virtual void Freeze()=0;

Description

Causes whatever ticker this animation provides to its animator to be frozen untill a corresponding call to unfreeze.

You should not normally need to call this function.

See also:

• CAnimation::Unfreeze()Causes whatever ticker this animation provides to its animator to be unfrozen.

virtual void Unfreeze()=0;

Description

Causes whatever ticker this animation provides to its animator to be unfrozen.

You should not normally need to call this function.

See also:

• CAnimation::Freeze()Causes whatever ticker this animation provides to its animator to be frozen unti...