Class fvaswing.effects.FvTweenEffect

Description

Abstract class to manage tween effects on ASwing Components

Take a look at fvaswing.effects package to see concrete effect implementations.

Use the Pixlib Tween engine.
More informations about Pixlib here.

Field Index

duration, easing, isPlaying, onEffectEndEVENT, onEffectProgressEVENT, onEffectStartEVENT, repeat, repeatDelay, startDelay

Method Index

end(), play()

Field Detail

onEffectEndEVENT

static public onEffectEndEVENT:EventType
Broadcasted when effect stop playing.

onEffectProgressEVENT

static public onEffectProgressEVENT:EventType
Broadcasted when effect is playing.

onEffectStartEVENT

static public onEffectStartEVENT:EventType
Broadcasted when effect start playing.

duration

public duration:Number
Returns the duration of the effect in milliseconds.

easing

public easing:Function
Returns current easing function used by effect.

isPlaying

public isPlaying:Boolean [Read Only]
A read-only flag which is true if any instances of the effect are currently playing, and false if none are.

repeat

public repeat:Number
Number of effect repetitions. Possible values are any integer greater than or equal to 0.

A value of 1 means to play the effect once.

A value of 0 means to play the effect indefinitely until stopped by a call to the end() method.

repeatDelay

public repeatDelay:Number
Amount of time, in milliseconds, to wait before repeating the effect.

Possible values are any integer greater than or equal to 0.

startDelay

public startDelay:Number
Amount of time, in milliseconds, to wait before starting the effect.

Possible values are any int greater than or equal to 0.

If the effect is repeated by using the repeat property, the startDelay is only applied to the first time the effect is played.

Method Detail

play

public function play():Void

Starts effect.

onEffectStartEVENT event is dispatched

end

public function end():Void

Ends effects.

Must be override by custom subclass

onEffectEndEVENT event is dispatched

Throws

Errorif subclass not override this method
as2api