Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
spark.effects.supportClasses 
AnimateTransformInstance 
Packagespark.effects.supportClasses
Classpublic class AnimateTransformInstance
InheritanceAnimateTransformInstance Inheritance AnimateInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object

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



Public Properties
 PropertyDefined By
  autoCenterTransform : Boolean
If autoCenterTransform is true, the transform center will be recalculated as the effect progresses, updating to any changes in the width and height of the object.
AnimateTransformInstance
 InheritedclassName : String
[read-only] The name of the effect class, such as "FadeInstance".
EffectInstance
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 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.
AnimateInstance
 Inheritedduration : Number
The duration of the effect, in milliseconds.
EffectInstance
 Inheritedeaser : IEaser
The easing behavior for this effect.
AnimateInstance
 Inheritedeffect : IEffect
The IEffect object that created this IEffectInstance object.
EffectInstance
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
EffectInstance
 InheritedhideFocusRing : 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
 Inheritedinterpolator : IInterpolator
The interpolator used by this effect to calculate values between the start and end values of a property.
AnimateInstance
 InheritedmotionPaths : 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
 InheritedplayheadTime : Number
[override] Current time position of the effect.
AnimateInstance
 InheritedpropertyChanges : PropertyChanges
Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.
EffectInstance
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrepeatBehavior : String
The behavior of a repeating effect, which means an effect with repeatCount equal to either 0 or > 1.
AnimateInstance
 InheritedrepeatCount : int
Number of times to repeat the effect.
EffectInstance
 InheritedrepeatDelay : int
Amount of time, in milliseconds, to wait before repeating the effect.
EffectInstance
 InheritedstartDelay : int
Amount of time, in milliseconds, to wait before starting the effect.
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
If true, blocks all background processing while the effect is playing.
EffectInstance
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
EffectInstance
  transformCenter : Vector3D
The center around which the transformations in this effect occur.
AnimateTransformInstance
 InheritedtriggerEvent : Event
The event, if any, which triggered the playing of the effect.
EffectInstance
Protected Properties
 PropertyDefined By
 InheritedautoRemoveTarget : Boolean = false
If true, the effect retains its target during a transition and removes it when finished.
AnimateInstance
 InheritedplayCount : int = 0
Number of times that the instance has been played.
EffectInstance
Public Methods
 MethodDefined By
  
Constructor.
AnimateTransformInstance
 Inherited
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
  
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
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect.
EffectInstance
 Inherited
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
This method is called if the effect was triggered by the EffectManager.
EffectInstance
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Pauses the effect until you call the resume() method.
EffectInstance
 Inherited
Plays the effect instance on the target.
EffectInstance
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Resumes the effect after it has been paused by a call to the pause() method.
EffectInstance
 Inherited
Plays the effect in reverse, starting from the current position of the effect.
EffectInstance
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
Stops the effect, leaving the target in its current state.
EffectInstance
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail

autoCenterTransform

property
public var autoCenterTransform:Boolean

If autoCenterTransform is true, the transform center will be 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 will be 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.