| Package | mx.effects.effectClasses |
| Class | public class TweenEffectInstance |
| Inheritance | TweenEffectInstance  EffectInstance flash.events.EventDispatcher |
| Subclasses | AnimatePropertyInstance, BlurInstance, DissolveInstance, FadeInstance, GlowInstance, MoveInstance, PauseInstance, ResizeInstance, RotateInstance, ZoomInstance |
See also
| Property | Defined by | ||
|---|---|---|---|
 | className : String
The name of the effect class, such as
"FadeInstance". | EffectInstance | |
| duration : Number
The duration of the effect, in milliseconds.
| EffectInstance | |
| easingFunction : Function
The easing function for the animation.
| TweenEffectInstance | ||
| effect : IEffect
The IEffect object that created this IEffectInstance object.
| EffectInstance | |
| effectTargetHost : IEffectTargetHost
A property that lets you access the target
list-based control of a data effect.
| EffectInstance | |
| hideFocusRing : Boolean
Determines whether the effect should hide
the focus ring when starting the effect.
| EffectInstance | |
| playheadTime : Number [read-only]
The current position of the effect, in milliseconds.
| TweenEffectInstance | ||
| propertyChanges : PropertyChanges
Specifies the PropertyChanges object containing
the start and end values for the set of properties
relevant to the effect's targets.
| EffectInstance | |
| repeatCount : int
Number of times to repeat the effect.
| EffectInstance | |
| repeatDelay : int
Amount of time, in milliseconds,
to wait before repeating the effect.
| EffectInstance | |
| startDelay : int
Amount of time, in milliseconds,
to wait before starting the effect.
| EffectInstance | |
| suspendBackgroundProcessing : Boolean
If
true, blocks all background processing
while the effect is playing. | EffectInstance | |
| target : Object
The UIComponent object to which this effect is applied.
| EffectInstance | |
| triggerEvent : Event
The event, if any, which triggered the playing of the effect.
| EffectInstance | |
| tween : Tween
The Tween object, which determines the animation.
| TweenEffectInstance | ||
| Method | Defined by | ||
|---|---|---|---|
|
TweenEffectInstance(target:Object)
Constructor.
| TweenEffectInstance | ||
|
end():void
Interrupts an effect that is currently playing,
and immediately jumps to the end of the effect.
| TweenEffectInstance | ||
|
finishEffect():void
Called by the
end() method when the effect
finishes playing. | EffectInstance | |
|
finishRepeat():void
Called after each iteration of a repeated effect finishes playing.
| EffectInstance | |
|
initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager.
| EffectInstance | |
|
onTweenEnd(value:Object):void
Callback method that is called when the target should be updated
by the effect for the last time.
| TweenEffectInstance | ||
|
onTweenUpdate(value:Object):void
Callback method that is called when the target should be updated
by the effect.
| TweenEffectInstance | ||
|
pause():void
Pauses the effect until you call the
resume() method. | EffectInstance | |
|
play():void
Plays the effect instance on the target.
| EffectInstance | |
|
resume():void
Resumes the effect after it has been paused
by a call to the
pause() method. | EffectInstance | |
|
reverse():void
Plays the effect in reverse, starting from
the current position of the effect.
| EffectInstance | |
|
seek(playheadTime:Number):void
Advances the effect to the specified position.
| TweenEffectInstance | ||
|
startEffect():void
Plays the effect instance on the target after the
startDelay period has elapsed. | EffectInstance | |
|
stop():void
Stops the effect, leaving the target in its current state.
| EffectInstance | |
| Method | Defined by | ||
|---|---|---|---|
|
createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):Tween
Creates a Tween instance,
assigns it the start, end, and duration values.
| TweenEffectInstance | ||
| easingFunction | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var easingFunction:FunctionThe easing function for the animation. By default, effects use the same easing function as the TweenEffect class.
See also
| playheadTime | property |
playheadTime:Number [read-only]
The current position of the effect, in milliseconds.
This value is between 0 and the value of the
duration property.
Use the seek() method to change the position of the effect.
public function get playheadTime():Number
| tween | property |
public var tween:Tween
The Tween object, which determines the animation.
To create an effect, you must create a Tween instance
in the override of the EffectInstance.play() method
and assign it to the tween property.
Use the createTween() method to create your Tween object.
| TweenEffectInstance | () | constructor |
public function TweenEffectInstance(target:Object)Constructor.
Parameterstarget:Object — The Object to animate with this effect.
|
| createTween | () | method |
protected function createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):Tween
Creates a Tween instance,
assigns it the start, end, and duration values. If an easing function has
been specified, then it is assigned to the Tween instance. The Tween instance is assigned
event listeners for the TweenEvents: tweenStart, tweenUpdate,
and tweenEnd.
Typically, you call this method from your override of
the EffectInstance.play() method
which effectively starts the animation timer.
listener:Object — Object that is notified at each interval
of the animation. You typically pass the this
keyword as the value.
The listener must define the
onTweenUpdate() method and optionally the
onTweenEnd() method.
The onTweenUpdate() method is invoked for each interval of the animation,
and the onTweenEnd() method is invoked just after the animation finishes.
|
|
startValue:Object — Initial value(s) of the animation.
Either a number or an Array of numbers.
If a number is passed, the Tween interpolates
between this number and the number passed
in the endValue parameter.
If an Array of numbers is passed,
each number in the Array is interpolated.
|
|
endValue:Object — Final value(s) of the animation.
The type of this argument must match the startValue
parameter.
|
|
duration:Number (default = -1) |
|
minFps:Number (default = -1)onTweenUpdate() method should be called every second.
The tween code tries to call the onTweenUpdate()
method as frequently as possible (up to 100 times per second).
However, if the frequency falls below minFps,
the duration of the animation automatically increases.
As a result, an animation that temporarily freezes
(because it is not getting any CPU cycles) begins again
where it left off, instead of suddenly jumping ahead.
|
Tween —
The newly created Tween instance.
|
| end | () | method |
public override function end():void
Interrupts an effect that is currently playing,
and immediately jumps to the end of the effect.
Calls the Tween.endTween() method
on the tween property.
This method implements the method of the superclass.
If you create a subclass of TweenEffectInstance, you can optionally override this method.
The effect dispatches the effectEnd event.
See also
| onTweenEnd | () | method |
public function onTweenEnd(value:Object):void
Callback method that is called when the target should be updated
by the effect for the last time.
The Tween class passes Tween.endValue as the value
of the value argument.
The value argument can be either a Number
or an Array of Numbers.
Overriding this function is optional.
You must also call the super version of this method
from the end of your override, super.onTweenEnd(val),
after your logic.
value:Object — The value of the value argument
is an interpolated value determined by the
Tween.startValue property,
Tween.endValue property, and interpolation function
specified by the implementation of the effect in its
play() method.
The play() method uses these values to create
a Tween object that plays the effect over a time period.
The value argument can be either a Number
or an Array of Numbers.
|
| onTweenUpdate | () | method |
public function onTweenUpdate(value:Object):void
Callback method that is called when the target should be updated
by the effect.
The Tween class uses the easing function and the
Tween.startValue, Tween.endValue
and Tween.duration properties to calculate
the value of the value argument.
The value argument can be either a Number
or an Array of Numbers.
All subclasses must override this method. It is not necessary to call the super version of this function when overriding this method.
Parametersvalue:Object — The value of the value argument
is an interpolated value determined by the
Tween.startValue property,
Tween.endValue property, and interpolation function
specified by the implementation of the effect in its
play() method.
The play() method uses these values to create
a Tween object that plays the effect over a time period.
The value argument can be either a Number
or an Array of Numbers.
|
| seek | () | method |
public function seek(playheadTime:Number):voidAdvances the effect to the specified position.
ParametersplayheadTime:Number — The position, in milliseconds, between 0
and the value of the duration property.
|