Packageaway3d.animators
Interfacepublic interface IAnimator
Implementors ParticleAnimator, SkeletonAnimator, SpriteSheetAnimator, 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
  animationSet : IAnimationSet
[read-only] Returns the animation data set in use by the animator.
IAnimator
Public Methods
 MethodDefined By
  
Returns a shallow clone (re-using the same IAnimationSet) of this IAnimator.
IAnimator
  
IAnimator
  
IAnimator
  
setRenderState(stage3DProxy:Stage3DProxy, renderable:IRenderable, vertexConstantOffset:int, vertexStreamOffset:int, camera:Camera3D):void
Sets the GPU render state required by the animation that is dependent of the rendered object.
IAnimator
  
Verifies if the animation will be used on cpu.
IAnimator
Property Detail
animationSetproperty
animationSet:IAnimationSet  [read-only]

Returns the animation data set in use by the animator.


Implementation
    public function get animationSet():IAnimationSet
Method Detail
clone()method
public function clone():IAnimator

Returns a shallow clone (re-using the same IAnimationSet) of this IAnimator.

Returns
IAnimator
getAnimationState()method 
public function getAnimationState(node:AnimationNodeBase):AnimationStateBase

Parameters

node:AnimationNodeBase

Returns
AnimationStateBase
getAnimationStateByName()method 
public function getAnimationStateByName(name:String):AnimationStateBase

Parameters

name:String

Returns
AnimationStateBase
setRenderState()method 
public function setRenderState(stage3DProxy:Stage3DProxy, renderable:IRenderable, vertexConstantOffset:int, vertexStreamOffset:int, camera:Camera3D):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.
 
camera:Camera3D

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