View source

interface IAnimator

package away3d.animators

extended by ParticleAnimator, SkeletonAnimator, SpriteSheetAnimator, UVAnimator, VertexAnimator

@:directlyUsed

Available on all platforms

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

See also:

  • away3d.animators.IAnimationSet

Variables

read onlyanimationSet:IAnimationSet

Returns the animation data set in use by the animator.

Methods

clone():IAnimator

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

dispose():Void

getAnimationState(node:AnimationNodeBase):IAnimationState

getAnimationStateByName(name:String):IAnimationState

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

The Stage3DProxy object which is currently being used for rendering.

renderable

The object currently being rendered.

vertexConstantOffset

The first available vertex register to write data to if running on the gpu.

vertexStreamOffset

The first available vertex stream to write vertex data to if running on the gpu.

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.