| Package | mx.effects.effectClasses |
| Class | public class RotateInstance |
| Inheritance | RotateInstance  TweenEffectInstance EffectInstance flash.events.EventDispatcher |
Every effect class that is a subclass of the TweenEffect class supports the following events:
tweenEnd: Dispatched when the tween effect ends. tweenUpdate: Dispatched every time a TweenEffect
class calculates a new value.The event object passed to the event listener for these events is of type TweenEvent.
The TweenEvent class defines the property value, which contains
the tween value calculated by the effect.
For the Rotate effect,
the TweenEvent.value property contains a Number between the values of
the Rotate.angleFrom and
Rotate.angleTo properties.
See also
| Property | Defined by | ||
|---|---|---|---|
| angleFrom : Number = 0
The starting angle of rotation of the target object,
expressed in degrees.
| RotateInstance | ||
| angleTo : Number = 360
The ending angle of rotation of the target object,
expressed in degrees.
| RotateInstance | ||
 | 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 | |
| originX : Number
The x-position of the center point of rotation.
| RotateInstance | ||
| originY : Number
The y-position of the center point of rotation.
| RotateInstance | ||
| playheadTime : Number
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 | ||
|---|---|---|---|
|
RotateInstance(target:Object)
Constructor.
| RotateInstance | ||
|
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 | |
| angleFrom | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var angleFrom:Number = 0The starting angle of rotation of the target object, expressed in degrees. Valid values range from 0 to 360.
The default value is 0.
| angleTo | property |
public var angleTo:Number = 360The ending angle of rotation of the target object, expressed in degrees. Values can be either positive or negative.
If the value of angleTo is less
than the value of angleFrom,
then the target rotates in a counterclockwise direction.
Otherwise, it rotates in clockwise direction.
If you want the target to rotate multiple times,
set this value to a large positive or small negative number.
The default value is 360.
| originX | property |
public var originX:NumberThe x-position of the center point of rotation. The target rotates around this point. The valid values are between 0 and the width of the target.
The default value is 0.
| originY | property |
public var originY:NumberThe y-position of the center point of rotation. The target rotates around this point. The valid values are between 0 and the height of the target.
The default value is 0.
| RotateInstance | () | constructor |
public function RotateInstance(target:Object)Constructor.
Parameterstarget:Object — The Object to animate with this effect.
|