| Package | away3d.animators |
| Class | public class Animator |
| Inheritance | Animator  flash.events.EventDispatcher |
| Subclasses | BonesAnimator, PathAnimator, VertexAnimator |
| Property | Defined By | ||
|---|---|---|---|
| currentFrame : int [read-only]
Returns the current keyframe number
| Animator | ||
| cycleNumber : int [read-only]
Returns the number of the current loop cycle
| Animator | ||
| delay : Number
Defines the delay to the start of the animation in seconds
| Animator | ||
| fps : Number
Defines the keyframes per second of the animation
| Animator | ||
| interpolate : Boolean
Defines whether the animation interpolates between channel points. | Animator | ||
| isPlaying : Boolean [read-only]
Returns true when the animation is playing
| Animator | ||
| length : Number
Defines the total length of the animation in seconds
| Animator | ||
| loop : Boolean
Defines whether the animation will loop. | Animator | ||
| name : String
The name of the animation used as a unique reference. | Animator | ||
| progress : Number
Represents the progress of the animation playhead from the start (0) to the end (1) of the animation. | Animator | ||
| target : Object3D
Defines the 3d object to which the animation is applied. | Animator | ||
| totalFrames : Number [read-only]
Returns the total length of the animation in frames
| Animator | ||
| Property | Defined By | ||
|---|---|---|---|
| _currentFrame : uint | Animator | ||
| _fraction : Number | Animator | ||
| ini : Init
Instance of the Init object used to hold and parse default property values
specified by the initialiser object in the 3d object constructor. | Animator | ||
| _invFraction : Number | Animator | ||
| _progress : Number = 0 | Animator | ||
| _target : Object3D | Animator | ||
| _time : Number | Animator | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new Animator object. | Animator | ||
addOnCycle(listener:Function):void
Default method for adding a cycle event listener. | Animator | ||
addOnEnterKeyFrame(listener:Function):void
Default method for adding an enterKeyFrame event listener
| Animator | ||
Duplicates the animators properties to another Animator object
| Animator | ||
gotoAndPlay(frame:uint):void | Animator | ||
gotoAndStop(frame:uint):void | Animator | ||
play():void | Animator | ||
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
| Animator | ||
removeOnEnterKeyFrame(listener:Function):void
Default method for removing a enterKeyFrame event listener
| Animator | ||
stop():void | Animator | ||
update(time:Number):void
Updates the position of the playhead to the given time in seconds. | Animator | ||
| Method | Defined By | ||
|---|---|---|---|
getDefaultFps():Number | Animator | ||
updateProgress(val:Number):void | Animator | ||
updateTarget():void | Animator | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when a looping animation starts a new cycle. | Animator | |||
| Dispatched when entering a new keyframe. | Animator | |||
| Dispatched when the animation starts. | Animator | |||
| Dispatched when the animation stops. | Animator | |||
| _currentFrame | property |
protected var _currentFrame:uint| _fraction | property |
protected var _fraction:Number| _invFraction | property |
protected var _invFraction:Number| _progress | property |
protected var _progress:Number = 0| _target | property |
protected var _target:Object3D| _time | property |
protected var _time:Number| _totalFrames | property |
arcane var _totalFrames:Number = 0| currentFrame | property |
currentFrame:int [read-only] Returns the current keyframe number
public function get currentFrame():int| cycleNumber | property |
cycleNumber:int [read-only] Returns the number of the current loop cycle
public function get cycleNumber():int| delay | property |
public var delay:NumberDefines the delay to the start of the animation in seconds
| fps | property |
public var fps:NumberDefines the keyframes per second of the animation
| ini | property |
protected var ini:InitInstance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
| interpolate | property |
public var interpolate:BooleanDefines whether the animation interpolates between channel points. Defaults to true.
| isPlaying | property |
isPlaying:Boolean [read-only] Returns true when the animation is playing
public function get isPlaying():Boolean| length | property |
length:NumberDefines the total length of the animation in seconds
public function get length():Number public function set length(value:Number):void| loop | property |
public var loop:BooleanDefines whether the animation will loop. Defaults to true.
| name | property |
public var name:StringThe name of the animation used as a unique reference.
| progress | property |
progress:NumberRepresents the progress of the animation playhead from the start (0) to the end (1) of the animation.
public function get progress():Number public function set progress(value:Number):void| target | property |
target:Object3DDefines the 3d object to which the animation is applied.
public function get target():Object3D public function set target(value:Object3D):void| totalFrames | property |
totalFrames:Number [read-only] Returns the total length of the animation in frames
public function get totalFrames():Number| Animator | () | Constructor |
public function Animator(target:Object3D = null, init:Object = null)
Creates a new Animator object.
target:Object3D (default = null) | |
init:Object (default = null) |
| addOnCycle | () | method |
public function addOnCycle(listener:Function):voidDefault method for adding a cycle event listener.
Parameters
listener:Function — The listener function
|
| addOnEnterKeyFrame | () | method |
public function addOnEnterKeyFrame(listener:Function):voidDefault method for adding an enterKeyFrame event listener
Parameters
listener:Function — The listener function
|
| clone | () | method |
public function clone(animator:Animator = null):Animator
Duplicates the animators properties to another Animator object
Parameters
animator:Animator (default = null) |
Animator — The new animator instance with duplicated properties applied
|
| getDefaultFps | () | method |
protected function getDefaultFps():NumberReturnsNumber |
| gotoAndPlay | () | method |
public function gotoAndPlay(frame:uint):voidParameters
frame:uint |
| gotoAndStop | () | method |
public function gotoAndStop(frame:uint):voidParameters
frame:uint |
| play | () | method |
public function play():void| removeOnCycle | () | method |
public function removeOnCycle(listener:Function):voidDefault method for removing a cycle event listener
Parameters
listener:Function — The listener function
|
| removeOnEnterKeyFrame | () | method |
public function removeOnEnterKeyFrame(listener:Function):voidDefault method for removing a enterKeyFrame event listener
Parameters
listener:Function — The listener function
|
| stop | () | method |
public function stop():void| update | () | method |
public function update(time:Number):voidUpdates the position of the playhead to the given time in seconds.
Parameters
time:Number — Defines the time in seconds of the playhead of the animation.
|
| updateProgress | () | method |
protected function updateProgress(val:Number):voidParameters
val:Number |
| updateTarget | () | method |
protected function updateTarget():void| cycle | Event |
away3d.events.AnimatorEventaway3d.events.AnimatorEventDispatched when a looping animation starts a new cycle.
See also
| enterKeyFrame | Event |
away3d.events.AnimatorEventaway3d.events.AnimatorEventDispatched when entering a new keyframe.
| start | Event |
away3d.events.AnimatorEventaway3d.events.AnimatorEventDispatched when the animation starts.
| stop | Event |
away3d.events.AnimatorEventaway3d.events.AnimatorEventDispatched when the animation stops.