Packagefl.motion
Classpublic class Animator
InheritanceAnimator Inheritance AnimatorBase Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The Animator class applies an XML description of a motion tween to a display object. The properties and methods of the Animator class control the playback of the motion, and Flash Player broadcasts events in response to changes in the motion's status. If there isn't any three-dimensional content, the Copy Motion as ActionScript command in Flash CS4 uses the Animator class. For three-dimensional content, the Animator3D class is used, instead, which shares the same base class as the Animator class but is specifically for three-dimensional content. You can then edit the ActionScript using the application programming interface (API) or construct your own custom animation.

If you plan to call methods of the Animator class within a function, declare the Animator instance outside of the function so the scope of the object is not restricted to the function itself. If you declare the instance within a function, Flash Player deletes the Animator instance at the end of the function as part of Flash Player's routine "garbage collection" and the target object will not animate.

Note: In Flash CS3, some properties and methods supported by this class were members of this class, exclusively. Flash CS4 introduced a base class, AnimatorBase, for those properties and methods of this class, and they are now shared by other classes through the inheritance chain. If you have been working in Flash CS3, notice that these properties and methods are still supported by the Animator class, but are members of the AnimatorBase class in releases of Flash Professional after Flash CS3. As with any other class in this reference, select Show Inherited Public Properties and Show Inherited Public Methods to see all of the properties and methods supported by this class.

Default MXML Propertymotion

See also

Motion XML Elements

Public Properties
 PropertyDefined By
 InheritedautoRewind : Boolean = false
Sets the animation to restart after it finishes.
AnimatorBase
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedframeEvent : String
AnimatorBase
 InheritedinitialPosition : Array
[write-only]
AnimatorBase
 InheritedisPlaying : Boolean
[read-only] Indicates whether the animation is currently playing.
AnimatorBase
 Inheritedmotion : MotionBase
The object that contains the motion tween properties for the animation.
AnimatorBase
 InheritedorientToPath : Boolean = false
Sets the position of the display object along the motion path.
AnimatorBase
 InheritedpositionMatrix : Matrix
The Matrix object that applies an overall transformation to the motion path.
AnimatorBase
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrepeatCount : int = 1
Number of times to repeat the animation.
AnimatorBase
 InheritedsceneName : String
AnimatorBase
 InheritedspanEnd : int
[read-only] Returns the frame of the target's parent on which the animation of the target ends.
AnimatorBase
 InheritedspanStart : int
[read-only] Returns the frame of the target's parent on which the animation of the target begins.
AnimatorBase
 Inheritedtarget : DisplayObject
The display object being animated.
AnimatorBase
 InheritedtargetName : String
The name of the target object as seen by the parent DisplayObjectContainer.
AnimatorBase
 InheritedtargetParent : DisplayObjectContainer
The target parent DisplayObjectContainer being animated, which can be used in conjunction with targetName to retrieve the target object after it is removed and then replaced on the timeline.
AnimatorBase
 InheritedtargetState3D : Array
The initial orientation for the target object.
AnimatorBase
 Inheritedtime : int
A zero-based integer that indicates and controls the time in the current animation.
AnimatorBase
 InheritedtransformationPoint : Point
The point of reference for rotating or scaling a display object.
AnimatorBase
 InheritedtransformationPointZ : int
AnimatorBase
 InheritedusingCurrentFrame : Boolean
[read-only] Indicates whether the currentFrame property is checked whenever a new frame is entered and whether the target's animation is synchronized to the frames in its parent's timeline, or always advancing no matter what the parent's current frame is.
AnimatorBase
Public Methods
 MethodDefined By
  
Animator(xml:XML = null, target:DisplayObject = null)
Creates an Animator object to apply the XML-based motion tween description to a display object.
Animator
 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
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
end(reset:Boolean = false, stopEnterFrame:Boolean = true):void
Stops the animation and Flash Player goes immediately to the last frame in the animation sequence.
AnimatorBase
  
fromXMLString(xmlString:String, target:DisplayObject = null):Animator
[static] Creates an Animator object from a string of XML.
Animator
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
nextFrame():void
Advances Flash Player to the next frame in the animation sequence.
AnimatorBase
 Inherited
pause():void
Pauses the animation until you call the resume() method.
AnimatorBase
 Inherited
play(startTime:int = -1, startEnterFrame:Boolean = true):void
Begins the animation.
AnimatorBase
 Inherited
processCurrentFrame(parent:MovieClip, anim:AnimatorBase, startEnterFrame:Boolean, playOnly:Boolean = false):void
[static]
AnimatorBase
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
registerButtonState(targetParentBtn:SimpleButton, anim:AnimatorBase, stateFrame:int):void
[static]
AnimatorBase
 Inherited
registerParentFrameHandler(parent:MovieClip, anim:AnimatorBase, spanStart:int, repeatCount:int = 0, useCurrentFrame:Boolean = false):void
[static] Registers the given MovieClip and an AnimatorBase instance for a child of that MovieClip.
AnimatorBase
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
resume():void
Resumes the animation after it has been paused by the pause() method.
AnimatorBase
 Inherited
rewind():void
Sets Flash Player to the first frame of the animation.
AnimatorBase
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
startFrameEvents():void
AnimatorBase
 Inherited
stop():void
Stops the animation and Flash Player goes back to the first frame in the animation sequence.
AnimatorBase
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
useCurrentFrame(enable:Boolean, spanStart:int):void
Sets the currentFrame property whenever a new frame is entered, and sets whether the target's animation is synchronized to the frames in its parent MovieClips's timeline.
AnimatorBase
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
Events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 Inherited
motionEnd
Dispatched when the motion finishes playing, either when it reaches the end, or when the motion is interrupted by a call to the stop() or end() methods.AnimatorBase
 Inherited
motionStart
Dispatched when the motion starts playing.AnimatorBase
 Inherited
motionUpdate
Dispatched when the motion has changed and the screen has been updated.AnimatorBase
 Inherited
timeChange
Dispatched when the Animator's time value has changed, but the screen has not yet been updated (i.e., the motionUpdate event).AnimatorBase
Constructor Detail
Animator()Constructor
public function Animator(xml:XML = null, target:DisplayObject = null)

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Creates an Animator object to apply the XML-based motion tween description to a display object.

Parameters
xml:XML (default = null) — An E4X object containing an XML-based motion tween description.
 
target:DisplayObject (default = null) — The display object using the motion tween.

See also

Motion XML Elements
Method Detail
fromXMLString()method
public static function fromXMLString(xmlString:String, target:DisplayObject = null):Animator

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Creates an Animator object from a string of XML. This method is an alternative to using the Animator constructor, which accepts an E4X object instead.

Parameters

xmlString:String — A string of XML describing the motion tween.
 
target:DisplayObject (default = null) — The display object using the motion tween.

Returns
Animator — An Animator instance that applies the specified xmlString to the specified target.

See also

Motion XML Elements



© 2009 Adobe Systems Incorporated. All rights reserved.
Wed Jul 29 2009, 04:58 PM -07:00
Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator Animator
fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator fl.motion.Animator