Packagespark.effects
Classpublic class Rotate3D
InheritanceRotate3D Inheritance AnimateTransform3D Inheritance AnimateTransform Inheritance Animate Inheritance Effect Inheritance flash.events.EventDispatcher

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The Rotate3D class rotate a target object in three dimensions around the x, y, or z axes. The rotation occurs around the transform center of the target.

Like all AnimateTransform-based effects, this effect only works on subclasses of UIComponent and GraphicElement, as these effects depend on specific transform functions in those classes. Also, transform effects running in parallel on the same target run as a single effect instance Therefore, the transform effects share the transform center set by any of the contributing effects.

MXML SyntaxexpandedHide MXML Syntax

The <s:Rotate3D> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <s:Rotate3D
    Properties
    id="ID"
    angleXFrom="no default"
    angleXTo="no default"
    angleYFrom="no default"
    angleYTo="no default"
    angleZFrom="no default"
    angleZTo="no default"
  />
  

Default MXML PropertymotionPaths

View the examples



Public Properties
 PropertyDefined By
  angleXFrom : Number
The starting angle of rotation of the target object around the x axis, expressed in degrees.
Rotate3D
  angleXTo : Number
The ending angle of rotation of the target object around the x axis, expressed in degrees.
Rotate3D
  angleYFrom : Number
The starting angle of rotation of the target object around the y axis, expressed in degrees.
Rotate3D
  angleYTo : Number
The ending angle of rotation of the target object around the y axis, expressed in degrees.
Rotate3D
  angleZFrom : Number
The starting angle of rotation of the target object around the z axis, expressed in degrees.
Rotate3D
  angleZTo : Number
The ending angle of rotation of the target object around the z axis, expressed in degrees.
Rotate3D
 InheritedapplyChangesPostLayout : Boolean
[override] Used by the subclasses of AnimateTransform to specify whether the effect changes transform values used by the layout manager, or whether it changes values used after layout is run.
AnimateTransform3D
 InheritedapplyLocalProjection : Boolean
If true, the effect creates a perspective projection using the other projection-related properties in the effect and applies it to the target component's parent when it starts playing.
AnimateTransform3D
 InheritedautoCenterProjection : Boolean = true
Set to false to disable a 3D effect from automatically setting the projection point to the center of the target.
AnimateTransform3D
 InheritedautoCenterTransform : Boolean = false
Specifies whether the transform effect occurs around the center of the target, (width/2, height/2) when the effect begins playing.
AnimateTransform
 InheritedclassName : String
[read-only] The name of the effect class, such as "Fade".
Effect
 InheritedcustomFilter : EffectTargetFilter
Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.
Effect
 InheriteddisableLayout : 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
 Inheritedduration : Number
Duration of the effect in milliseconds.
Effect
 Inheritedeaser : IEaser
The easing behavior for this effect.
Animate
 InheritedeffectTargetHost : IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
Effect
 InheritedfieldOfView : Number
Specifies an angle, in degrees between 0 and 180, for the field of view in three dimensions.
AnimateTransform3D
 Inheritedfilter : String
Specifies an algorithm for filtering targets for an effect.
Effect
 InheritedfocalLength : Number
The distance between the eye or the viewpoint's origin (0,0,0) and the display object located in the z axis.
AnimateTransform3D
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
Effect
 InheritedinstanceClass : Class
An object of type Class that specifies the effect instance class class for this effect class.
Effect
 Inheritedinterpolator : IInterpolator
The interpolator used by this effect to calculate values between the start and end values of a property.
Animate
 InheritedisPlaying : 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
 InheritedperElementOffset : Number
Additional delay, in milliseconds, for effect targets after the first target of the effect.
Effect
 InheritedplayheadTime : Number
Current time position of the effect.
Effect
 InheritedprojectionX : Number = 0
Sets the projection point as the offset of the projection point in the x direction from the (0, 0) coordinate of the target.
AnimateTransform3D
 InheritedprojectionY : Number = 0
Sets the projection point as the offset of the projection point in the y direction from the (0, 0) coordinate of the target.
AnimateTransform3D
 InheritedrelevantProperties : Array
An Array of property names to use when performing filtering.
Effect
 InheritedrelevantStyles : Array
An Array of style names to use when performing filtering.
Effect
 InheritedremoveLocalProjectionWhenComplete : Boolean = false
If true, the effect removes the perspective projection from the target component's parent when it completes playing.
AnimateTransform3D
 InheritedstartDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect.
Effect
 Inheritedtarget : Object
The object to which this effect is applied.
Effect
 Inheritedtargets : Array
An Array of objects that are targets for the effect.
Effect
 InheritedtransformX : Number
Sets the x coordinate for the transform center, unless overridden by the autoCenterTransform property.
AnimateTransform
 InheritedtransformY : Number
Sets the y coordinate for the transform center, unless overridden by the autoCenterTransform property.
AnimateTransform
 InheritedtransformZ : Number
Sets the z coordinate for the transform center, unless overridden by the autoCenterTransform property.
AnimateTransform
 InheritedtriggerEvent : 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
 PropertyDefined By
 InheritedapplyTransitionEndProperties : Boolean
This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.
Effect
 InheritedendValuesCaptured : Boolean = false
A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.
Effect
Public Methods
 MethodDefined By
  
Rotate3D(target:Object = null)
Constructor.
Rotate3D
 Inherited
Captures the current values of the relevant properties on the effect's targets and saves them as end values.
Effect
 Inherited
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
 Inherited
Captures the current values of the relevant properties on the effect's targets.
Effect
 Inherited
createInstance(target:Object = null):IEffectInstance
Creates a single effect instance and initializes it.
Effect
 Inherited
createInstances(targets:Array = null):Array
Takes an Array of target objects and invokes the createInstance() method on each target.
Effect
 Inherited
Removes event listeners from an instance and removes it from the list of instances.
Effect
 Inherited
end(effectInstance:IEffectInstance = null):void
Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.
Effect
 Inherited
Returns an Array of Strings, where each String is the name of a property changed by this effect.
Effect
 Inherited
pause():void
Pauses the effect until you call the resume() method.
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Begins playing the effect.
Effect
 Inherited
resume():void
Resumes the effect after it has been paused by a call to the pause() method.
Effect
 Inherited
reverse():void
Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.
Effect
 Inherited
stop():void
Stops the effect, leaving the effect targets in their current state.
Effect
Protected Methods
 MethodDefined By
 Inherited
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
Used internally by the Effect infrastructure.
Effect
 Inherited
Called when an effect instance has finished playing.
Effect
 Inherited
This method is called when the effect instance starts playing.
Effect
 Inherited
Called when an effect instance has stopped by a call to the stop() method.
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
Determines the logic for filtering out an effect instance.
Effect
 Inherited
getValueFromTarget(target:Object, property:String):*
Called by the captureStartValues() method to get the value of a property from the target.
Effect
 Inherited
Copies properties of the effect to the effect instance.
Effect
Events
 Event Summary Defined By
 InheritedDispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method.Effect
 InheritedDispatched when the effect begins a new repetition, for any effect that is repeated more than once.Animate
 InheritedDispatched when the effect starts playing.Effect
 InheritedDispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.Effect
 InheritedDispatched every time the effect updates the target.Animate
Property Detail
angleXFromproperty
public var angleXFrom: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 around the x axis, expressed in degrees. Valid values range from 0 to 360.

angleXToproperty 
public var angleXTo: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 around the x axis, 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.

angleYFromproperty 
public var angleYFrom: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 around the y axis, expressed in degrees. Valid values range from 0 to 360.

angleYToproperty 
public var angleYTo: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 around the y axis, 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.

angleZFromproperty 
public var angleZFrom: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 around the z axis, expressed in degrees. Valid values range from 0 to 360.

angleZToproperty 
public var angleZTo: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 around the z axis, 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.

Constructor Detail
Rotate3D()Constructor
public function Rotate3D(target:Object = null)

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Parameters
target:Object (default = null) — The Object to animate with this effect.
Examples
Rotate3DEffectExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<!-- Simple example to demonstrate the s:Rotate3D 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:Rotate3D id="rotateEffect" target="{targetBox}" 
            angleXFrom="0" angleXTo="180" angleYFrom="0" angleYTo="180" 
            duration="1000" autoCenterTransform="true"
            effectStart="playButton.enabled=false" effectEnd="playButton.enabled=true;"/>
    </fx:Declarations>

    <s:Panel title="Rotate3D Effect Example"
        width="75%" height="75%">

        <mx:HBox width="100%" height="100%">
            <!-- Our target to affect -->
            <mx:VBox id="targetBox" width="50%" horizontalAlign="center">
                <mx:Label text="Sample Image"/>
                <mx:Image source="@Embed(source='assets/c2.png')"/>
            </mx:VBox>

            <!-- Directions -->
            <mx:VBox id="detailsBox" width="50%" left="0">
                <mx:Text width="99%" color="blue"
                    text="The Rotate3D effect rotates a target using the following parameters: angleXFrom, angleXTo, angleYFrom, angleYTo, angleZFrom, and angleZTo. Click 'Rotate3D' to watch the effect."/>
            </mx:VBox>
        </mx:HBox>

        <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>
        <!-- End then Play the effect to rotate the target.-->
        <s:Button id="playButton"
            left="5" bottom="5"
            label="Rotate3D" click="rotateEffect.play();"/>
    </s:Panel>
</s:Application>