SlideOutEffect Class Reference

Effect in which the object slides laterally out of view from the current position. More...

Inheritance diagram for SlideOutEffect:

List of all members.

Public Member Functions
	SlideOutEffect ()
	Constructor.
	SlideOutEffect (Widget widget, float time, FourWayDirection direction, SlideOutEffectInterpolator interpolator)
	Constructor.
Static Public Member Functions
static SlideOutEffect	CreateAndStart (Widget widget, float time, FourWayDirection direction, SlideOutEffectInterpolator 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.
FourWayDirection	MoveDirection [get, set]
	Obtains and sets the effect travel direction.
SlideOutEffectInterpolator	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 in which the object slides laterally out of view from the current position.

---

Constructor & Destructor Documentation

SlideOutEffect	(	Widget	widget,
		float	time,
		FourWayDirection	direction,
		SlideOutEffectInterpolator	interpolator
	)

Constructor.

Parameters:

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

---

Member Function Documentation

static SlideOutEffect CreateAndStart	(	Widget	widget,
		float	time,
		FourWayDirection	direction,
		SlideOutEffectInterpolator	interpolator
	)		[static]

Creates an instance and starts the effect.

Parameters:

widget	Effect-target widget
time	Duration (ms)
direction	Effect travel direction
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 Time [get, set]

Obtains and sets the duration.

(ms)