FadeOutEffect Class Reference

Fade-out effect. More...

Inheritance diagram for FadeOutEffect:

List of all members.

Public Member Functions
	FadeOutEffect ()
	Constructor.
	FadeOutEffect (Widget widget, float time, FadeOutEffectInterpolator interpolator)
	Constructor.
Static Public Member Functions
static FadeOutEffect	CreateAndStart (Widget widget, float time, FadeOutEffectInterpolator 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	Time [get, set]
	Obtains and sets the duration.
FadeOutEffectInterpolator	Interpolator [get, set]
	Obtains and sets the type of interpolation function.
AnimationInterpolator	CustomInterpolator [get, set]
	Sets a custom interpolation function.

---

Detailed Description

Fade-out effect.

Changes from opaque (set alpha value) to transparent.

---

Constructor & Destructor Documentation

FadeOutEffect	(	Widget	widget,
		float	time,
		FadeOutEffectInterpolator	interpolator
	)

Constructor.

Parameters:

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

---

Member Function Documentation

static FadeOutEffect CreateAndStart	(	Widget	widget,
		float	time,
		FadeOutEffectInterpolator	interpolator
	)		[static]

Creates an instance and starts the effect.

Parameters:

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

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 Time [get, set]

Obtains and sets the duration.

(ms)