Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
AnimateTransform

Package | spark.effects
Class | public class AnimateTransform
Inheritance | AnimateTransform Animate Effect flash.events.EventDispatcher
Subclasses | AnimateTransform3D, Move, Rotate, Scale

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The AnimateTransform effect controls all transform-related animations on target objects. Transform operations, such as translation, scale, and rotation, are combined into single operations that act in parallel to avoid any conflict when modifying overlapping property values. This effect works by combining all current transform effects on a target into one single effect instance for that target. That is, multiple transform effects within the same Parallel effect are combined (transform effects within a Sequence run separately).

While this combination of multiple transform effects happens internally, it does force certain constraints that should be considered:

- The `transformCenter` for the target object is globally applied to all transform effects on that target, so it should be set to the same value on all targets.
- Transform effects ignore repeat parameters, since the effects of any single Transform effect impact all other Transform effects running on the same target. Effects can still be repeated by encapsulating them in a CompositeEffect.
- The subclasses of the AnimateTransform class provide an easy way for simple manipulations of the transform effect, but for full control and fine-grained manipulation of the underlying keyframe times and values, use the AnimateTransform effect directly.

An additional constraint of this effect and its subclasses is that the target must be of type UIComponent or GraphicElement (or a subclass of those classes), or any other object which has similarly defined and implemented `transformAround()` and `transformPointToParent()` functions.

This effect is not intended to be used directly, but rather exposes common functionality used by its subclasses. To use transform effects, use the subclass effects (Move, Move3D, Scale, Scale3D, Rotate, and Rotate3D).

MXML Syntax Show MXML Syntax
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="false"
        autoCenterTransform="false"
        transformX="0"
        transformY="0"
        transformZ="0"
      />

Default MXML Property `motionPaths`

See also

spark.effects.supportClasses.AnimateTransformInstance

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | 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
|  | 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
|  | 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

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
--- | --- | ---
|  | AnimateTransform(target:Object = null) Constructor. | AnimateTransform
|  | 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

Protected Methods
Show Inherited 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
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | 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`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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.

The default value is `false`.

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

autoCenterTransform | property |

`public var autoCenterTransform:Boolean = false`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies whether the transform effect occurs around the center of the target, `(width/2, height/2)` when the effect begins playing. If the flag is not set, the transform center is determined by the transform center of the object (`transformX, transformY, transformZ`) and the `transformX, transformY, transformZ` properties in this effect. That is, the transform center is the transform center of the target object, where any of the `transformX, transformY, transformZ` properties are overridden by those values in the effect, if set.

The default value is `false`.

See also

mx.core.UIComponent.transformX
mx.core.UIComponent.transformY
mx.core.UIComponent.transformZ
transformX
transformY
transformZ

transformX | property |

`public var transformX:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Sets the x coordinate for the transform center, unless overridden by the `autoCenterTransform` property.

If `autoCenterTransform` is `false`, the transform center is determined by the `transformX`, `transformY`, and `transformZ` properties of the target object, but each of those properties can be overridden by setting the respective properties in this effect.

See also

mx.core.UIComponent.transformX
autoCenterTransform

transformY | property |

`public var transformY:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Sets the y coordinate for the transform center, unless overridden by the `autoCenterTransform` property.

If `autoCenterTransform` is `false`, the transform center is determined by the `transformX`, `transformY`, and `transformZ` properties of the target object, but each of those properties can be overridden by setting the respective properties in this effect.

See also

mx.core.UIComponent.transformY
autoCenterTransform

transformZ | property |

`public var transformZ:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Sets the z coordinate for the transform center, unless overridden by the `autoCenterTransform` property.

If `autoCenterTransform` is `false`, the transform center is determined by the `transformX`, `transformY`, and `transformZ` properties of the target object, but each of those properties can be overridden by setting the respective properties in this effect.

See also

mx.core.UIComponent.transformZ
autoCenterTransform
Constructor Detail

AnimateTransform | () | Constructor

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

Wed Nov 15 2017, 09:50 AM +01:00