Take a look at fvaswing.effects package to see concrete * effect implementations. * *
Use the Pixlib Tween engine.
* More informations about Pixlib here.
*
* @author Romain Ecarnot
*/
class fvaswing.effects.FvTweenEffect extends EventBroadcaster
{
//-------------------------------------------------------------------------
// Events definition
//-------------------------------------------------------------------------
/** Broadcasted when effect stop playing. */
public static var onEffectEndEVENT : EventType = FvEffectEvent.onEffectEndEVENT;
/** Broadcasted when effect is playing. */
public static var onEffectProgressEVENT : EventType = FvEffectEvent.onEffectProgressEVENT;
/** Broadcasted when effect start playing. */
public static var onEffectStartEVENT : EventType = FvEffectEvent.onEffectStartEVENT;
//-------------------------------------------------------------------------
// Private properties
//-------------------------------------------------------------------------
private var _instance : FvEffectInstance;
private var _tween : ITween;
private var _duration : Number;
private var _easing : Function;
private var _event : FvEffectEvent;
private var _isPlaying : Boolean;
private var _firstPlay : Boolean;
private var _isRepeated : Boolean;
private var _counter : Number;
private var _repeatRef : Number;
private var _waitInterval : Number;
//-------------------------------------------------------------------------
// Public Properties
//-------------------------------------------------------------------------
/**
* Defines the duration of the effect in milliseconds.
*
*
The default value is 500 milliseconds. */ public function set duration( value : Number ) : Void { _duration = value; } /** * Returns the duration of the effect in milliseconds. */ public function get duration() : Number { return _duration; } /** * Defines the easing function for the animation. */ public function set easing( value : Function ) : Void { _easing = value; } /** * Returns current easing function used by effect. */ public function get easing() : Function { return _easing; } /** * A read-only flag which is true if any instances of the effect are currently * playing, and false if none are. */ public function get isPlaying() : Boolean { return _isPlaying; } /** * 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. */ public var repeat : Number = 1; /** * Amount of time, in milliseconds, to wait before repeating the effect. * *
Possible values are any integer greater than or equal to 0. */ public var repeatDelay : Number = 0; /** * 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. */ public var startDelay : Number = 0; //------------------------------------------------------------------------- // Public API //------------------------------------------------------------------------- /** * Starts effect. * *
{@link #onEffectStartEVENT} event is dispatched */ public function play() : Void { if( ! _isPlaying ) { _isRepeated = false; _counter = 0; if( startDelay > 0 && _firstPlay ) { _firstPlay = false; _waitInterval = setInterval( this, '_prepareEffect', startDelay ); } else _prepareEffect(); } } /** * Ends effects. * *
Must be override by custom subclass * *
{@link #onEffectEndEVENT} event is dispatched
*
* @throws Error if subclass not override this method
*/
public function end() : Void
{
throw new IllegalAccessException( 'must be override by Effect subclass' );
}
//-------------------------------------------------------------------------
// Private implementation
//-------------------------------------------------------------------------
/**
* Constructor.
*
* @param t AsVing component target
*/
private function FvTweenEffect( t : Component )
{
super( this );
_instance = new FvEffectInstance( t );
_duration = 500;
_easing = TweenMS.noEasing;
_event = new FvEffectEvent( null, this );
_isPlaying = false;
_isRepeated = false;
repeat = 1;
repeatDelay = 0;
startDelay = 0;
_firstPlay = true;
}
/**
* Retreives correct starting and ending values.
* Reset the repetitions counter
*/
private function _prepareEffect() : Void
{
clearInterval( _waitInterval );
_buildTween();
_repeatRef = repeat;
_counter++;
_play();
}
private function _play() : Void
{
_isPlaying = true;
_tween.start();
_event.setType( FvTweenEffect.onEffectStartEVENT );
broadcastEvent( _event );
}
/**
* Builds tweens instance
*
*
Must be override by effect subclass. * * @throws Error if subclass not override this method */ private function _buildTween() : Void { throw new IllegalAccessException( 'must be override by Effect subclass' ); } /** * Tween is finished. * *
Looks if repetition is enabled and defined. * If {@code true}, start loop process, either call * _endEffet() method. */ private function onMotionFinished( event : TweenEvent ) : Void { if( !_checkForRepeatEffect() ) _endEffect(); else _repeatEffect(); } /** * Tweened properties has changed. * *
Broadcasts {@link #onEffectProgressEVENT} event */ private function onMotionChanged( event : TweenEvent ) : Void { _event.setType( FvTweenEffect.onEffectProgressEVENT ); _instance.target.revalidateIfNecessary(); broadcastEvent( _event ); } /** * Indicates if repetition mode is enabled. */ private function _checkForRepeatEffect() : Boolean { return ( _repeatRef == 0 || ( _counter < _repeatRef ) ); } /** * Repeats tweening */ private function _repeatEffect() : Void { _isRepeated = true; if( repeatDelay > 0 ) _waitInterval = setInterval( this, "_prepareEffect", repeatDelay ); else _prepareEffect(); } /** * Ends tweening process. * *
Broadcasts {@link #onEffectEndEVENT} event */ private function _endEffect() : Void { _isPlaying = false; _isRepeated = false; _instance.target.revalidateIfNecessary(); _event.setType( FvTweenEffect.onEffectEndEVENT ); broadcastEvent( _event ); } }