| Package | spark.effects |
| Class | public class AnimateTransform |
| Inheritance | AnimateTransform  Animate Effect EventDispatcher Object |
| Subclasses | AnimateTransform3D, Move, Rotate, Scale |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
While this combination of multiple transform effects happens internally, it does force certain constraints that should be considered:
- The
transformCenterfor 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 SyntaxThe <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 PropertymotionPaths
Related API Elements
| 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 | |
| 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 | |
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
AnimateTransform(target:Object = null)
Constructor. | AnimateTransform | ||
| 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 | |
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):voidautoCenterTransform | 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.
Related API Elements
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.
Related API Elements
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.
Related API Elements
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.
Related API Elements
AnimateTransform | () | Constructor |
Wed Nov 21 2018, 06:34 AM -08:00