Effect Class Reference

Base class of animation applying to widget or element. More...

Inheritance diagram for Effect:

List of all members.

Public Member Functions
	Effect ()
	Constructor.
void	Start ()
	Starts the effect.
void	Stop ()
	Stops the effect.
void	Pause ()
	Pauses the effect.
void	Resume ()
	Resumes the effect.
Protected Member Functions
abstract void	OnStart ()
	Start processing.
abstract EffectUpdateResponse	OnUpdate (float elapsedTime)
	Update processing.
abstract void	OnStop ()
	Stop processing.
virtual void	OnPause ()
	Pause processing.
virtual void	OnResume ()
	Resume processing.
virtual void	OnRepeat ()
	Repeat processing.
Properties
float	TotalElapsedTime [get, set]
	Obtains the time elapsed from the start of the effect.
bool	Playing [get, set]
	Obtains whether the effect is operating.
bool	Paused [get, set]
	Obtains whether the effect is paused.
bool	Repeating [get, set]
	Obtains and sets whether the effect will be repeatedly played back.
Widget	Widget [get, set]
	Obtains and sets the effect-target widget.
Events
EventHandler< EventArgs >	EffectStopped
	Handler called when the effect is stopped.

---

Detailed Description

Base class of animation applying to widget or element.

---

Member Function Documentation

virtual void OnPause

(

)

[protected, virtual]

Pause processing.

Implements the pause processing with the derived class.

virtual void OnRepeat

(

)

[protected, virtual]

Repeat processing.

Implements the repeat processing with the derived class.

Reimplemented in UIMotion.

virtual void OnResume

(

)

[protected, virtual]

Resume processing.

Implements the resume processing with the derived class.

abstract void OnStart

(

)

[protected, pure virtual]

Start processing.

Implements the start processing with the derived class.

Implemented in BunjeeJumpEffect, DelayedExecutor, FadeInEffect, FadeOutEffect, FlipBoardEffect, JumpFlipEffect, MoveEffect, SlideInEffect, SlideOutEffect, TiltDropEffect, UIMotion, and ZoomEffect.

abstract void OnStop

(

)

[protected, pure virtual]

Stop processing.

Implements the stop processing with the derived class.

Implemented in BunjeeJumpEffect, DelayedExecutor, FadeInEffect, FadeOutEffect, FlipBoardEffect, JumpFlipEffect, MoveEffect, SlideInEffect, SlideOutEffect, TiltDropEffect, UIMotion, and ZoomEffect.

abstract EffectUpdateResponse OnUpdate

(

float

elapsedTime

)

[protected, pure virtual]

Update processing.

Parameters:

elapsedTime

Elapsed time from previous update (ms)

Returns:

Response of effect update

Implements the update processing with the derived class.

Implemented in BunjeeJumpEffect, DelayedExecutor, FadeInEffect, FadeOutEffect, FlipBoardEffect, JumpFlipEffect, MoveEffect, SlideInEffect, SlideOutEffect, TiltDropEffect, UIMotion, and ZoomEffect.

void Pause

(

)

Pauses the effect.

Nothing is performed when the effect is being played (Playing==true).

void Resume

(

)

Resumes the effect.

Nothing is performed when the effect is paused (Paused==true).

void Start

(

)

Starts the effect.

Nothing is performed when being started (Playing==true) and when paused (Paused==true).

void Stop

(

)

Stops the effect.

Nothing is performed when the effect is stopped. If it is paused, it will be stopped.

Reimplemented in UIMotion.

---

Property Documentation

float TotalElapsedTime [get, set]

Obtains the time elapsed from the start of the effect.

(ms)