Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
AnimateTransformInstance

Package | spark.effects.supportClasses
Class | public class AnimateTransformInstance
Inheritance | AnimateTransformInstance AnimateInstance EffectInstance flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The AnimateTransformInstance class implements the instance class for the AnimateTransform effect. Flex creates an instance of this class when it plays a AnimateTransform effect; you do not create one yourself.

See also

spark.effects.AnimateTransform

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | autoCenterTransform : Boolean If autoCenterTransform is true, the transform center is recalculated as the effect progresses, updating to any changes in the width and height of the object. | AnimateTransformInstance
|  | className : String [read-only] The name of the effect class, such as "FadeInstance". | EffectInstance
|  | 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. | AnimateInstance
|  | duration : Number The duration of the effect, in milliseconds. | EffectInstance
|  | easer : IEaser The easing behavior for this effect. | AnimateInstance
|  | effect : IEffect The IEffect object that created this IEffectInstance object. | EffectInstance
|  | effectTargetHost : IEffectTargetHost A property that lets you access the target list-based control of a data effect. | EffectInstance
|  | hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect. | EffectInstance
|  | initialized : Boolean = false If true, this single instance of the transform-related effects has already been initialized. | AnimateTransformInstance
|  | interpolator : IInterpolator The interpolator used by this effect to calculate values between the start and end values of a property. | AnimateInstance
|  | 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. | AnimateInstance
|  | playheadTime : Number [override] Current time position of the effect. | AnimateInstance
|  | propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets. | EffectInstance
|  | repeatBehavior : String The behavior of a repeating effect, which means an effect with repeatCount equal to either 0 or > 1. | AnimateInstance
|  | repeatCount : int Number of times to repeat the effect. | EffectInstance
|  | repeatDelay : int Amount of time, in milliseconds, to wait before repeating the effect. | EffectInstance
|  | startDelay : int Amount of time, in milliseconds, to wait before starting the effect. | EffectInstance
|  | suspendBackgroundProcessing : Boolean If true, blocks all background processing while the effect is playing. | EffectInstance
|  | target : Object The UIComponent object to which this effect is applied. | EffectInstance
|  | transformCenter : Vector3D The center around which the transformations in this effect occur. | AnimateTransformInstance
|  | triggerEvent : Event The event, if any, which triggered the playing of the effect. | EffectInstance

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | autoRemoveTarget : Boolean = false If true, the effect retains its target during a transition and removes it when finished. | AnimateInstance
|  | playCount : int = 0 Number of times that the instance has been played. | EffectInstance

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | AnimateTransformInstance(target:Object) Constructor. | AnimateTransformInstance
|  | addMotionPath(newMotionPath:MotionPath, newEffectStartTime:Number = 0):void Adds a MotionPath object to the set of MotionPath objects in this instance, with the start time relative to the outermost parent effect. | AnimateTransformInstance
|  | end():void Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect. | EffectInstance
|  | finishEffect():void Called by the end() method when the effect finishes playing. | EffectInstance
|  | finishRepeat():void Called after each iteration of a repeated effect finishes playing. | EffectInstance
|  | initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager. | EffectInstance
|  | pause():void Pauses the effect until you call the resume() method. | EffectInstance
|  | play():void Plays the effect instance on the target. | EffectInstance
|  | resume():void Resumes the effect after it has been paused by a call to the pause() method. | EffectInstance
|  | reverse():void Plays the effect in reverse, starting from the current position of the effect. | EffectInstance
|  | startEffect():void Plays the effect instance on the target after the startDelay period has elapsed. | EffectInstance
|  | stop():void Stops the effect, leaving the target in its current state. | EffectInstance

Property Detail

autoCenterTransform | property

`public var autoCenterTransform:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

If `autoCenterTransform` is `true`, the transform center is recalculated as the effect progresses, updating to any changes in the width and height of the object. If the property is `false`, the `transformCenter` property is used instead.

initialized | property |

`public var initialized:Boolean = false`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

If `true`, this single instance of the transform-related effects has already been initialized. This property is used by AnimateTransform to prevent duplicate initialization of the instance when there are multiple transform effects feeding into this single instance.

The default value is `false`.

transformCenter | property |

`public var transformCenter:Vector3D`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The center around which the transformations in this effect occur. In particular, rotations rotate around this point, translations move this point, and scales scale centered around this point. This property will be ignored if `autoCenterTransform` is true. If `autoCenterTransform` is false and `transformCenter` is not supplied, then the center of the target object is used.

Constructor Detail

AnimateTransformInstance | () | Constructor

`public function AnimateTransformInstance(target:Object)`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

Parameters

| `target:Object` — The Object to animate with this effect.

Method Detail

addMotionPath | () | method

`public function addMotionPath(newMotionPath:MotionPath, newEffectStartTime:Number = 0):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Adds a MotionPath object to the set of MotionPath objects in this instance, with the start time relative to the outermost parent effect. If there is already a MotionPath object for this effect instance that is acting on the same property as the new MotionPath object, then the keyframes of the new MotionPath are simply added to the existing MotionPath.

Parameters

| `newMotionPath:MotionPath` — New MotionPath object.
| `newEffectStartTime:Number` (default = `0`)`` — Start time, in milliseconds, of the new MotionPath object.

Sun Mar 5 2017, 03:42 PM +11:00