CAnimation Class Reference

#include <mw/animation.h>

class CAnimation : public CBase

Inherits from

CAnimation
- CBase

Public Member Functions
pure virtual void	Freeze()
pure virtual void	Hold()
pure virtual void	Pause()
pure virtual void	Resume()
pure virtual void	SetPosition(const TPoint &)
pure virtual void	Start(const TAnimationConfig &)
pure virtual void	Stop()
pure virtual void	Unfreeze()
pure virtual void	Unhold()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed 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.

See also: CAnimationDataProvider CAnimator MAnimationObserver

Member Function Documentation

Freeze ( )

void

Freeze

(

)

[pure virtual]

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.

Hold ( )

void

Hold

(

)

[pure virtual]

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.

Pause ( )

void

Pause

(

)

[pure virtual]

Causes the animation to stop, but without rewinding.

Resume ( )

void

Resume

(

)

[pure virtual]

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

SetPosition ( const TPoint & )

void

SetPosition

(

const TPoint &

aPoint

)

[pure virtual]

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

Parameters
aPoint	The new coordinates of the animation (usually the top left corner)

Start ( const TAnimationConfig & )

void

Start

(

const TAnimationConfig &

aConfig

)

[pure virtual]

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

Parameters
aConfig	Specifies run time attributes of the animation.

Stop ( )

void

Stop

(

)

[pure virtual]

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

Unfreeze ( )

void

Unfreeze

(

)

[pure virtual]

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

You should not normally need to call this function.

Unhold ( )

void

Unhold

(

)

[pure virtual]

Resumes a held animation.