Packageaway3d.animators
Interfacepublic interface IAnimator
Implementors SkeletonAnimator, UVAnimator, VertexAnimator

Provides an interface for animator classes that control animation output from a data set subtype of AnimationSetBase.

See also

away3d.animators.IAnimationSet


Public Properties
 PropertyDefined By
  activeState : IAnimationState
[read-only] Returns the current active animation state.
IAnimator
  animationSet : IAnimationSet
[read-only] Returns the animation data set in use by the animator.
IAnimator
  autoUpdate : Boolean
Determines whether the animators internal update mechanisms are active.
IAnimator
  playbackSpeed : Number
The amount by which passed time should be scaled.
IAnimator
  time : int
Gets and sets the internal time clock of the animator.
IAnimator
Public Methods
 MethodDefined By
  
play(stateName:String, stateTransition:StateTransitionBase = null):void
IAnimator
  
setRenderState(stage3DProxy:Stage3DProxy, renderable:IRenderable, vertexConstantOffset:int, vertexStreamOffset:int):void
Sets the GPU render state required by the animation that is dependent of the rendered object.
IAnimator
  
start():void
Resumes the automatic playback clock controling the active state of the animator.
IAnimator
  
stop():void
Pauses the automatic playback clock of the animator, in case manual updates are required via the time property or update() method.
IAnimator
  
Verifies if the animation will be used on cpu.
IAnimator
  
update(time:int):void
Provides a way to manually update the active state of the animator when automatic updates are disabled.
IAnimator
Property Detail
activeStateproperty
activeState:IAnimationState  [read-only]

Returns the current active animation state.


Implementation
    public function get activeState():IAnimationState
animationSetproperty 
animationSet:IAnimationSet  [read-only]

Returns the animation data set in use by the animator.


Implementation
    public function get animationSet():IAnimationSet
autoUpdateproperty 
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.


Implementation
    public function get autoUpdate():Boolean
    public function set autoUpdate(value:Boolean):void

See also

playbackSpeedproperty 
playbackSpeed:Number

The amount by which passed time should be scaled. Used to slow down or speed up animations. Defaults to 1.


Implementation
    public function get playbackSpeed():Number
    public function set playbackSpeed(value:Number):void
timeproperty 
time:int

Gets and sets the internal time clock of the animator.


Implementation
    public function get time():int
    public function set time(value:int):void
Method Detail
play()method
public function play(stateName:String, stateTransition:StateTransitionBase = null):void

Parameters

stateName:String
 
stateTransition:StateTransitionBase (default = null)

setRenderState()method 
public function setRenderState(stage3DProxy:Stage3DProxy, renderable:IRenderable, vertexConstantOffset:int, vertexStreamOffset:int):void

Sets the GPU render state required by the animation that is dependent of the rendered object.

Parameters

stage3DProxy:Stage3DProxy — The Stage3DProxy object which is currently being used for rendering.
 
renderable:IRenderable — The object currently being rendered.
 
vertexConstantOffset:int — The first available vertex register to write data to if running on the gpu.
 
vertexStreamOffset:int — The first available vertex stream to write vertex data to if running on the gpu.

start()method 
public function start():void

Resumes 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

testGPUCompatibility()method 
public function testGPUCompatibility(pass:MaterialPassBase):void

Verifies if the animation will be used on cpu. Needs to be true for all passes for a material to be able to use it on gpu. Needs to be called if gpu code is potentially required.

Parameters

pass:MaterialPassBase

update()method 
public function update(time:int):void

Provides a way to manually update the active state of the animator when automatic updates are disabled.

Parameters

time:int

See also