(Preview)
| Package | mx.effects |
| Class | public class Rotate |
| Inheritance | Rotate  TweenEffect Effect EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
 | Starting with Flex 4.0, Adobe recommends that you use the spark.effects.Rotate class as an alternative to this class. |
The Rotate effect rotates a component around a specified point. You can specify the coordinates of the center of the rotation, and the starting and ending angles of rotation. You can specify positive or negative values for the angles.
Note: To use the Rotate effect with text, you must use an embedded font, not a device font.
MXML Syntax
Show MXML Syntax
Hide MXML SyntaxThe <mx:Rotate> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:Rotate
id="ID"
angleFrom="0"
angleTo="360"
originX="0"
originY="0"
/>
Related API Elements
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| angleFrom : Number = 0
The starting angle of rotation of the target object,
expressed in degrees. | Rotate | ||
| angleTo : Number = 360
The ending angle of rotation of the target object,
expressed in degrees. | Rotate | ||
 | 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 | |
| duration : Number
Duration of the effect in milliseconds. | Effect | |
| easingFunction : Function = null
The easing function for the animation. | TweenEffect | |
| 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 [override]
Determines whether the effect should hide the focus ring when starting the
effect. | Rotate | ||
| instanceClass : Class
An object of type Class that specifies the effect
instance class class for this effect class. | Effect | |
| 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 | |
| originX : Number
The x-position of the center point of rotation. | Rotate | ||
| originY : Number
The y-position of the center point of rotation. | Rotate | ||
| 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 | |
| repeatCount : int = 1
Number of times to repeat the effect. | Effect | |
| repeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect. | Effect | |
| startDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect. | Effect | |
| suspendBackgroundProcessing : Boolean = false
If true, blocks all background processing
while the effect is playing. | 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 | |
| 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 | |
Protected Properties
Public Methods
| 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 | |
Protected Methods
Property Detail
angleFrom | property |
public var angleFrom:Number = 0| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The 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 = 360| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The 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,
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.
hideFocusRing | property |
hideFocusRing:Boolean[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines whether the effect should hide the focus ring when starting the effect. The target itself is responsible for the actual hiding of the focus ring.
The default value is true.
Implementation
override public function get hideFocusRing():Boolean override public function set hideFocusRing(value:Boolean):voidoriginX | property |
public var originX:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The 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:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The 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.
Constructor Detail
Rotate | () | Constructor |
Examples How to use this example
RotateEffectExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Rotate effect. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx"
initialize="Font.registerFont(myriad_font);">
<fx:Script>
<![CDATA[
import flash.text.Font;
[Embed("assets/MyriadWebPro.ttf", fontName="MyMyriad")]
public var myriad_font:Class;
[Bindable]
public var angle:int=0;
private function rotateImage():void {
rotate.end();
angle += 45;
rotate.play();
}
]]>
</fx:Script>
<fx:Declarations>
<mx:Rotate id="rotate" angleFrom="{angle-45}" angleTo="{angle}" target="{myVB}"/>
</fx:Declarations>
<s:Panel title="Halo Rotate Effect Example" width="75%" height="75%" >
<s:VGroup left="20" right="20" top="20" bottom="20">
<s:VGroup id="myVB" width="50%" horizontalAlign="center">
<mx:Label text="Nokia 9930"
fontFamily="MyMyriad" fontSize="14"/>
<mx:Image id="img"
source="@Embed(source='assets/Nokia_6630.png')"/>
</s:VGroup>
<s:Label width="50%" color="blue"
text="Click the button to rotate the image 45 degrees. Use an embedded font when applying the Rotate effect to text."/>
<s:Button label="Rotate 45 Degrees" click="rotateImage();"/>
</s:VGroup>
</s:Panel>
</s:Application>
Wed Nov 21 2018, 06:34 AM -08:00