| Package | away3d.animators |
| Class | public class AnimatorBase |
| Inheritance | AnimatorBase  flash.events.EventDispatcher |
| Subclasses | ParticleAnimator, SkeletonAnimator, SpriteSheetAnimator, UVAnimator, VertexAnimator |
AnimationSetBase.
See also
| Property | Defined By | ||
|---|---|---|---|
| absoluteTime : Number [read-only]
Returns the internal absolute time of the animator, calculated by the current time and the playback speed. | AnimatorBase | ||
| activeAnimation : AnimationNodeBase [read-only]
Returns the current active animation node. | AnimatorBase | ||
| activeAnimationName : String [read-only]
Returns the current active animation node. | AnimatorBase | ||
| activeState : IAnimationState [read-only]
Returns the current active animation state. | AnimatorBase | ||
| animationSet : IAnimationSet [read-only]
Returns the animation data set in use by the animator. | AnimatorBase | ||
| autoUpdate : Boolean
Determines whether the animators internal update mechanisms are active. | AnimatorBase | ||
| playbackSpeed : Number
The amount by which passed time should be scaled. | AnimatorBase | ||
| time : int
Gets and sets the internal time clock of the animator. | AnimatorBase | ||
| updatePosition : Boolean = true
Enables translation of the animated mesh from data returned per frame via the positionDelta property of the active animation node. | AnimatorBase | ||
| Property | Defined By | ||
|---|---|---|---|
| _absoluteTime : Number = 0 | AnimatorBase | ||
| _activeNode : AnimationNodeBase | AnimatorBase | ||
| _activeState : IAnimationState | AnimatorBase | ||
| _animationSet : IAnimationSet | AnimatorBase | ||
| _name : String | AnimatorBase | ||
| _owners : Vector.<Mesh> | AnimatorBase | ||
| Method | Defined By | ||
|---|---|---|---|
AnimatorBase(animationSet:IAnimationSet)
Creates a new AnimatorBase object. | AnimatorBase | ||
| AnimatorBase | |||
getAnimationStateByName(name:String):AnimationStateBase | AnimatorBase | ||
phase(value:Number):void
Sets the animation phase of the current active state's animation clip(s). | AnimatorBase | ||
reset(name:String, offset:Number = 0):void | AnimatorBase | ||
start():void
Resumes the automatic playback clock controling the active state of the animator. | AnimatorBase | ||
stop():void
Pauses the automatic playback clock of the animator, in case manual updates are required via the
time property or update() method. | AnimatorBase | ||
update(time:int):void
Provides a way to manually update the active state of the animator when automatic
updates are disabled. | AnimatorBase | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when playback of an animation reaches the end of an animation. | AnimatorBase | |||
| Dispatched when playback of an animation inside the animator object starts. | AnimatorBase | |||
| Dispatched when playback of an animation inside the animator object stops. | AnimatorBase | |||
| _absoluteTime | property |
protected var _absoluteTime:Number = 0| _activeNode | property |
protected var _activeNode:AnimationNodeBase| _activeState | property |
protected var _activeState:IAnimationState| _animationSet | property |
protected var _animationSet:IAnimationSet| _name | property |
protected var _name:String| _owners | property |
protected var _owners:Vector.<Mesh>| absoluteTime | property |
absoluteTime:Number [read-only] Returns the internal absolute time of the animator, calculated by the current time and the playback speed.
public function get absoluteTime():NumberSee also
| activeAnimation | property |
activeAnimation:AnimationNodeBase [read-only] Returns the current active animation node.
public function get activeAnimation():AnimationNodeBase| activeAnimationName | property |
activeAnimationName:String [read-only] Returns the current active animation node.
public function get activeAnimationName():String| activeState | property |
activeState:IAnimationState [read-only] Returns the current active animation state.
public function get activeState():IAnimationState| animationSet | property |
animationSet:IAnimationSet [read-only] Returns the animation data set in use by the animator.
public function get animationSet():IAnimationSet| autoUpdate | property |
autoUpdate:Boolean
Determines whether the animators internal update mechanisms are active. Used in cases
where manual updates are required either via the time property or update() method.
Defaults to true.
public function get autoUpdate():Boolean public function set autoUpdate(value:Boolean):voidSee also
| playbackSpeed | property |
playbackSpeed:NumberThe amount by which passed time should be scaled. Used to slow down or speed up animations. Defaults to 1.
public function get playbackSpeed():Number public function set playbackSpeed(value:Number):void| time | property |
time:intGets and sets the internal time clock of the animator.
public function get time():int public function set time(value:int):void| updatePosition | property |
public var updatePosition:Boolean = trueEnables translation of the animated mesh from data returned per frame via the positionDelta property of the active animation node. Defaults to true.
See also
| AnimatorBase | () | Constructor |
public function AnimatorBase(animationSet:IAnimationSet)
Creates a new AnimatorBase object.
animationSet:IAnimationSet — The animation data set to be used by the animator object.
|
| getAnimationState | () | method |
public function getAnimationState(node:AnimationNodeBase):AnimationStateBaseParameters
node:AnimationNodeBase |
AnimationStateBase |
| getAnimationStateByName | () | method |
public function getAnimationStateByName(name:String):AnimationStateBaseParameters
name:String |
AnimationStateBase |
| phase | () | method |
public function phase(value:Number):voidSets the animation phase of the current active state's animation clip(s).
Parameters
value:Number — The phase value to use. 0 represents the beginning of an animation clip, 1 represents the end.
|
| reset | () | method |
public function reset(name:String, offset:Number = 0):voidParameters
name:String | |
offset:Number (default = 0) |
| start | () | method |
public function start():voidResumes the automatic playback clock controling the active state of the animator.
| stop | () | method |
public function stop():void
Pauses the automatic playback clock of the animator, in case manual updates are required via the
time property or update() method.
See also
| update | () | method |
public function update(time:int):voidProvides a way to manually update the active state of the animator when automatic updates are disabled.
Parameters
time:int |
See also
| cycle_complete | Event |
away3d.events.AnimatorEventaway3d.events.AnimatorEventDispatched when playback of an animation reaches the end of an animation.
| start | Event |
away3d.events.AnimatorEventaway3d.events.AnimatorEventDispatched when playback of an animation inside the animator object starts.
| stop | Event |
away3d.events.AnimatorEventaway3d.events.AnimatorEventDispatched when playback of an animation inside the animator object stops.