spark.effects.AnimateTransform3D - Adobe® Flex® 4 Language Reference (Flex 4)

Package	spark.effects
Class	public class AnimateTransform3D
Inheritance	AnimateTransform3D AnimateTransform Animate Effect EventDispatcher Object
Subclasses	Move3D, Rotate3D, Scale3D

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The AnimateTransform3D effect extends the abilities of the AnimateTransform effect to 3D transform properties. Like AnimateTransform, this effect is not intended to be used directly, but instead provides common functionality that is used by its subclasses. To get 3D effects, use the subclasses Move3D, Rotate3D, and Scale3D.

As with AnimateTransform, there are some properties of this affect that are shared with all other transform effects that it is combined with at runtime. In particular, the projection-related properties applyLocalProjection, removeProjectionWhenComplete, autoCenterProjection, fieldOfView, focalLength, projectionX, and projectionY are all shared properties. Set these properties similarly on all 3D effects that are combined in a composite effect to get predictable results.

MXML Syntax expanded

Hide MXML Syntax

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

  <s:AnimateTransform
    Properties
    id="ID"
    applyChangesPostLayout="true"
    applyLocalProjection="false"
    autoCenterProjection="true"
    fieldOfView="no default"
    focalLength="no default"
    projectionX="0"
    projectionY="0"
    removeLocalProjectionWhenComplete="false"
  />

Default MXML PropertymotionPaths

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		applyChangesPostLayout : 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
		applyLocalProjection : 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
		autoCenterProjection : Boolean = true Set to false to disable a 3D effect from automatically setting the projection point to the center of the target.	AnimateTransform3D
		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
		fieldOfView : Number Specifies an angle, in degrees between 0 and 180, for the field of view in three dimensions.	AnimateTransform3D
		filter : String Specifies an algorithm for filtering targets for an effect.	Effect
		focalLength : Number The distance between the eye or the viewpoint's origin (0,0,0) and the display object located in the z axis.	AnimateTransform3D
		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
		motionPaths : Vector.<MotionPath> A Vector of MotionPath objects, each of which holds the name of a property being animated and the values that the property takes during the animation.	Animate
		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
		projectionX : 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
		projectionY : 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
		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
		removeLocalProjectionWhenComplete : Boolean = false If true, the effect removes the perspective projection from the target component's parent when it completes playing.	AnimateTransform3D
		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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		applyTransitionEndProperties : 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
		endValuesCaptured : 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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		AnimateTransform3D(target:Object = null) Constructor.	AnimateTransform3D
		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
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		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
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
effectEnd	Dispatched 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
effectRepeat	Dispatched when the effect begins a new repetition, for any effect that is repeated more than once.	Animate
effectStart	Dispatched when the effect starts playing.	Effect
effectStop	Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.	Effect
effectUpdate	Dispatched every time the effect updates the target.	Animate

Property Detail

applyChangesPostLayout

property

applyChangesPostLayout:Boolean[override]

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

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. Because the Flex layout system ignores 3D transformation properties, this class overrides the AnimateTransform.applyChangesPostLayout property to set the default value to true for 3D effects.

The default value is true.

Implementation
override public function get applyChangesPostLayout():Boolean
override public function set applyChangesPostLayout(value:Boolean):void

applyLocalProjection

property

applyLocalProjection:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

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. By default, the projection is left on the parent when the effect finishes; to remove the projection when the effect ends, set removeLocalProjectionWhenComplete to true.

The default value is true.

Implementation
public function get applyLocalProjection():Boolean
public function set applyLocalProjection(value:Boolean):void

See also

removeLocalProjectionWhenComplete

autoCenterProjection

property

public var autoCenterProjection:Boolean = true

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Set to false to disable a 3D effect from automatically setting the projection point to the center of the target. You then use the projectionX and projectionY properties to explicitly set the projection point as the offset of the projection point from the (0, 0) coordinate of the target.

The 3D effects work by mapping a three-dimensional image onto a two-dimensional representation for display on a computer screen. The projection point defines the center of the field of view, and controls how the target is projected from three dimensions onto the screen.

This property is only used when applyLocalProjection is set to true.

The default value is true.

See also

applyLocalProjection

fieldOfView

property

public var fieldOfView:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Specifies an angle, in degrees between 0 and 180, for the field of view in three dimensions. This value determines how strong the perspective transformation and distortion apply to a three-dimensional display object with a non-zero z-coordinate.

A degree close to 0 means that the screen's two-dimensional x- and y-coordinates are roughly the same as the three-dimensional x-, y-, and z-coordinates with little or no distortion. In other words, for a small angle, a display object moving down the z axis appears to stay near the same size and moves little.

A value close to 180 degrees results in a fisheye lens effect: positions with a z value smaller than 0 are magnified, while positions with a z value larger than 0 are minimized. With a large angle, a display object moving down the z axis appears to change size quickly and moves a great distance. If the field of view is set to 0 or 180, nothing is seen on the screen.

This property is only used when applyLocalProjection is set to true.

focalLength

property

public var focalLength:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The distance between the eye or the viewpoint's origin (0,0,0) and the display object located in the z axis. During the perspective transformation, the focalLength is calculated dynamically using the angle of the field of view and the stage's aspect ratio (stage width divided by stage height).

This property is only used when applyLocalProjection is set to true.

projectionX

property

public var projectionX:Number = 0

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Sets the projection point as the offset of the projection point in the x direction from the (0, 0) coordinate of the target. By default, when you apply a 3D effect, the effect automatically sets the projection point to the center of the target. You can set the autoCenterProjection property of the effect to false to disable this default, and use the projectionX and projectionY properties instead.

This property is only used when applyLocalProjection is set to true.

See also

applyLocalProjection

projectionY

property

public var projectionY:Number = 0

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Sets the projection point as the offset of the projection point in the y direction from the (0, 0) coordinate of the target. By default, when you apply a 3D effect, the effect automatically sets the projection point to the center of the target. You can set the autoCenterProjection property of the effect to false to disable this default, and use the projectionX and projectionY properties instead.

This property is only used when applyLocalProjection is set to true.

See also

applyLocalProjection

removeLocalProjectionWhenComplete

property

public var removeLocalProjectionWhenComplete:Boolean = false

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

If true, the effect removes the perspective projection from the target component's parent when it completes playing. By default, the perspective projection is retained.

This property is only used when applyLocalProjection is set to true.

The default value is false.

See also

applyLocalProjection

Constructor Detail

AnimateTransform3D

()

Constructor

public function AnimateTransform3D(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.