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(), Hold(), Pause(), Resume(), SetPosition(), Start(), Stop(), Unfreeze(), Unhold()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• CAnimationDataProvider
• CAnimator
• MAnimationObserver

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:

• TAnimationConfig

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:

• Unfreeze()

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:

• Freeze()