ZoomEffect Class Reference

Effect that enlarges or reduces the current scale to the specified scale. More...

Inheritance diagram for ZoomEffect:

List of all members.

Public Member Functions
	ZoomEffect ()
	Constructor.
	ZoomEffect (Widget widget, float time, float scale, ZoomEffectInterpolator interpolator)
	Constructor.
Static Public Member Functions
static ZoomEffect	CreateAndStart (Widget widget, float time, float scale, ZoomEffectInterpolator interpolator)
	Creates an instance and starts the effect.
Protected Member Functions
override void	OnStart ()
	Start processing.
override EffectUpdateResponse	OnUpdate (float elapsedTime)
	Update processing.
override void	OnStop ()
	Stop processing.
Properties
float	TargetScaleX [get, set]
	Obtains and sets the scale in the target X direction.
float	TargetScaleY [get, set]
	Obtains and sets the scale in the target Y direction.
float	TargetScaleZ [get, set]
	Obtains and sets the scale in the target Z direction.
float	Time [get, set]
	Obtains and sets the animation time.
ZoomEffectInterpolator	Interpolator [get, set]
	Obtains and sets the type of interpolation function.
AnimationInterpolator	CustomInterpolator [get, set]
	Obtains and sets a custom interpolation function.

---

Detailed Description

Effect that enlarges or reduces the current scale to the specified scale.

---

Constructor & Destructor Documentation

ZoomEffect	(	Widget	widget,
		float	time,
		float	scale,
		ZoomEffectInterpolator	interpolator
	)

Constructor.

Parameters:

widget	Effect-target widget
time	Duration (ms)
scale	Target scale
interpolator	Interpolation function

---

Member Function Documentation

static ZoomEffect CreateAndStart	(	Widget	widget,
		float	time,
		float	scale,
		ZoomEffectInterpolator	interpolator
	)		[static]

Creates an instance and starts the effect.

Parameters:

widget	Effect-target widget
time	Duration (ms)
scale	Target scale
interpolator	Interpolation function

Returns:

Effect instance

override EffectUpdateResponse OnUpdate

(

float

elapsedTime

)

[protected, virtual]

Update processing.

Parameters:

elapsedTime

Elapsed time from previous update (ms)

Returns:

Response of effect update

Implements Effect.

---

Property Documentation

float TargetScaleX [get, set]

Obtains and sets the scale in the target X direction.

(Magnification = 1)

float TargetScaleY [get, set]

Obtains and sets the scale in the target Y direction.

(Magnification = 1)

float TargetScaleZ [get, set]

Obtains and sets the scale in the target Z direction.

(Magnification = 1)

float Time [get, set]

Obtains and sets the animation time.

(ms)