Package | spark.effects |
Class | public class Rotate |
Inheritance | Rotate AnimateTransform Animate Effect EventDispatcher Object |
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 SyntaxHide 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
See also
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 | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
customFilter : mx.effects: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 : mx.effects: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 | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
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 | ||
---|---|---|---|
Constructor. | Rotate | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | ||
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 | ||
Captures the current values of the relevant properties
on the effect's targets. | Effect | ||
Creates a single effect instance and initializes it. | Effect | ||
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | ||
Removes event listeners from an instance
and removes it from the list of instances. | Effect | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | ||
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Pauses the effect until you call the resume() method. | Effect | ||
Begins playing the effect. | Effect | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | ||
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Stops the effect, leaving the effect targets in their current state. | Effect | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
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.
|
<?xml version="1.0" encoding="utf-8"?> <!-- Simple example to demonstrate the s:Rotate class. --> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:mx="library://ns.adobe.com/flex/mx" xmlns:s="library://ns.adobe.com/flex/spark"> <!-- Standalone effects must be declared in the "Declarations" tag in Flex 4 --> <fx:Declarations> <s:Rotate id="rotateEffect" target="{myImage}" angleBy="360" duration="1000" autoCenterTransform="true" effectStart="playButton.enabled=false" effectEnd="playButton.enabled=true;"/> </fx:Declarations> <s:Panel title="Rotate Effect Example" width="75%" height="75%"> <s:HGroup width="100%" height="100%"> <!-- Our target to affect --> <s:VGroup id="targetBox" width="50%" horizontalAlign="center"> <s:Label text="Nokia 9930"/> <mx:Image id="myImage" source="@Embed(source='assets/Nokia_6630.png')"/> </s:VGroup> <!-- Directions --> <s:VGroup id="detailsBox" width="50%" left="0"> <s:Label width="99%" color="blue" text="The Rotate effect rotates a target using the following parameters: angleFrom, angleTo, angleBy. Click 'Rotate' to watch the effect."/> </s:VGroup> </s:HGroup> <s:Rect left="0" right="0" bottom="0" height="30"> <s:fill> <s:LinearGradient rotation="90"> <s:GradientEntry color="0xE2E2E2" /> <s:GradientEntry color="0xD9D9D9" /> </s:LinearGradient> </s:fill> </s:Rect> <s:Button id="playButton" left="5" bottom="5" label="Rotate" click="rotateEffect.play();"/> </s:Panel> </s:Application>
Fri Mar 19 2010, 02:45 AM -07:00