Package | spark.effects |
Class | public class Rotate |
Inheritance | Rotate ![]() ![]() ![]() ![]() |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
If you specify any two of the angle values (angleFrom, angleTo,
or angleBy), Flex calculates the third.
If you specify all three, Flex ignores the angleBy
value.
Like all AnimateTransform-based effects, this effect will only work on subclasses of UIComponent and GraphicElement, as these effects depend on specific transform functions in those classes.
MXML SyntaxThe <s:Rotate>
tag
inherits all of the tag attributes of its of its superclass,
and adds the following tag attributes:
<s:Rotate id="ID" angleBy="val" angleFrom="val" angleTo="val" />
Default MXML PropertymotionPaths
Property | Defined By | ||
---|---|---|---|
angleBy : Number
Degrees by which to rotate the target object. | Rotate | ||
angleFrom : Number
The starting angle of rotation of the target object,
in degrees. | Rotate | ||
angleTo : Number
The ending angle of rotation of the target object,
in degrees. | Rotate | ||
![]() | applyChangesPostLayout : Boolean
Subclasses of AnimateTransform use this flag to specify
whether the effect changes transform values used by the layout
manager, or whether it changes values used after layout is run. | AnimateTransform | |
![]() | autoCenterTransform : Boolean = false
Specifies whether the transform effect occurs
around the center of the target, (width/2, height/2)
when the effect begins playing. | AnimateTransform | |
![]() | className : String [read-only]
The name of the effect class, such as "Fade". | Effect | |
![]() | customFilter : EffectTargetFilter
Specifies a custom filter object, of type EffectTargetFilter,
used by the effect to determine the targets
on which to play the effect. | Effect | |
![]() | disableLayout : Boolean
If true, the effect disables layout on its
targets' parent containers, setting the containers autoLayout
property to false, and also disables any layout constraints on the
target objects. | Animate | |
![]() | duration : Number
Duration of the effect in milliseconds. | Effect | |
![]() | easer : IEaser
The easing behavior for this effect. | Animate | |
![]() | effectTargetHost : IEffectTargetHost
A property that lets you access the target list-based control
of a data effect. | Effect | |
![]() | filter : String
Specifies an algorithm for filtering targets for an effect. | Effect | |
![]() | hideFocusRing : Boolean
Determines whether the effect should hide the focus ring
when starting the effect. | Effect | |
![]() | instanceClass : Class
An object of type Class that specifies the effect
instance class class for this effect class. | Effect | |
![]() | interpolator : IInterpolator
The interpolator used by this effect to calculate values between
the start and end values of a property. | Animate | |
![]() | 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. | Effect | |
![]() | perElementOffset : Number
Additional delay, in milliseconds, for effect targets
after the first target of the effect. | Effect | |
![]() | playheadTime : Number
Current time position of the effect. | Effect | |
![]() | relevantProperties : Array
An Array of property names to use when performing filtering. | Effect | |
![]() | relevantStyles : Array
An Array of style names to use when performing filtering. | Effect | |
![]() | startDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect. | Effect | |
![]() | target : Object
The object to which this effect is applied. | Effect | |
![]() | targets : Array
An Array of objects that are targets for the effect. | Effect | |
![]() | transformX : Number
Sets the x coordinate for the transform center, unless overridden
by the autoCenterTransform property. | AnimateTransform | |
![]() | transformY : Number
Sets the y coordinate for the transform center, unless overridden
by the autoCenterTransform property. | AnimateTransform | |
![]() | transformZ : Number
Sets the z coordinate for the transform center, unless overridden
by the autoCenterTransform property. | AnimateTransform | |
![]() | triggerEvent : Event
The Event object passed to this Effect
by the EffectManager when an effect is triggered,
or null if the effect is not being
played by the EffectManager. | Effect |
Method | Defined By | ||
---|---|---|---|
Rotate(target:Object = null)
Constructor. | Rotate | ||
![]() | captureEndValues():void
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | |
![]() | captureMoreStartValues(targets:Array):void
Captures the current values of the relevant properties
of an additional set of targets
Flex uses this function when a data change
effect is run.
| Effect | |
![]() | captureStartValues():void
Captures the current values of the relevant properties
on the effect's targets. | Effect | |
![]() | createInstance(target:Object = null):IEffectInstance
Creates a single effect instance and initializes it. | Effect | |
![]() | createInstances(targets:Array = null):Array
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | |
![]() | deleteInstance(instance:IEffectInstance):void
Removes event listeners from an instance
and removes it from the list of instances. | Effect | |
![]() | end(effectInstance:IEffectInstance = null):void
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | |
![]() | getAffectedProperties():Array
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | |
![]() | pause():void
Pauses the effect until you call the resume() method. | Effect | |
![]() | play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Begins playing the effect. | Effect | |
![]() | resume():void
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | |
![]() | reverse():void
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | |
![]() | stop():void
Stops the effect, leaving the effect targets in their current state. | Effect |
angleBy | property |
public var angleBy:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Degrees by which to rotate the target object. Value may be negative.
If the value of angleBy
is negative,
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.
angleFrom | property |
public var angleFrom:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The starting angle of rotation of the target object, in degrees. Valid values range from 0 to 360.
angleTo | property |
public var angleTo:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The ending angle of rotation of the target object, in degrees. Values can be either positive or negative.
If the value of angleTo
is less
than the value of angleFrom
,
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.
Rotate | () | Constructor |
public function Rotate(target:Object = null)
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor.
Parameterstarget:Object (default = null ) — The Object to animate with this effect.
|