MoveEffect Class Reference

Effect that moves from the current position to a specified location. More...

Inheritance diagram for MoveEffect:
Effect

List of all members.

Public Member Functions

 MoveEffect ()
 Constructor.
 MoveEffect (Widget widget, float time, float x, float y, MoveEffectInterpolator interpolator)
 Constructor.

Static Public Member Functions

static MoveEffect CreateAndStart (Widget widget, float time, float x, float y, MoveEffectInterpolator 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.
float X [get, set]
 Obtains and sets the X coordinate of the destination in the parent coordinate system.
float Y [get, set]
 Obtains and sets the Y coordinate of the destination in the parent coordinate system.
MoveEffectInterpolator 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 moves from the current position to a specified location.


Constructor & Destructor Documentation

MoveEffect ( Widget  widget,
float  time,
float  x,
float  y,
MoveEffectInterpolator  interpolator 
)

Constructor.

Parameters:
widgetEffect-target widget
timeDuration (ms)
xX coordinate of destination in the parent coordinate system
yY coordinate of destination in the parent coordinate system
interpolatorInterpolation function

Member Function Documentation

static MoveEffect CreateAndStart ( Widget  widget,
float  time,
float  x,
float  y,
MoveEffectInterpolator  interpolator 
) [static]

Creates an instance and starts the effect.

Parameters:
widgetEffect-target widget
timeDuration (ms)
xX coordinate of destination in the parent coordinate system
yY coordinate of destination in the parent coordinate system
interpolatorInterpolation function
Returns:
Effect instance
override EffectUpdateResponse OnUpdate ( float  elapsedTime) [protected, virtual]

Update processing.

Parameters:
elapsedTimeElapsed time from previous update (ms)

Implements Effect.


Property Documentation

float Time [get, set]

Obtains and sets the duration.

(ms)