| Package | away3d.animators |
| Class | public class VertexAnimator |
| Inheritance | VertexAnimator  AnimatorBase flash.events.EventDispatcher |
| Implements | IAnimator |
| Method | Defined By | ||
|---|---|---|---|
VertexAnimator(vertexAnimationSet:VertexAnimationSet)
Creates a new VertexAnimator object. | VertexAnimator | ||
 | AnimatorBase | ||
| getAnimationStateByName(name:String):AnimationStateBase | AnimatorBase | |
| phase(value:Number):void
Sets the animation phase of the current active state's animation clip(s). | AnimatorBase | |
play(name:String, transition:IAnimationTransition = null, offset:Number):void
Plays a sequence with a given name. | VertexAnimator | ||
| reset(name:String, offset:Number = 0):void | AnimatorBase | |
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. | VertexAnimator | ||
| 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 | |
testGPUCompatibility(pass:MaterialPassBase):void
Verifies if the animation will be used on cpu. | VertexAnimator | ||
| update(time:int):void
Provides a way to manually update the active state of the animator when automatic
updates are disabled. | AnimatorBase | |
| Method | Defined By | ||
|---|---|---|---|
updateDeltaTime(dt:Number):void [override]
| VertexAnimator | ||
| VertexAnimator | () | Constructor |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic function VertexAnimator(vertexAnimationSet:VertexAnimationSet)
Creates a new VertexAnimator object.
vertexAnimationSet:VertexAnimationSet — The animation data set containing the vertex animations used by the animator.
|
| play | () | method |
public function play(name:String, transition:IAnimationTransition = null, offset:Number):voidPlays a sequence with a given name. If the sequence is not found, it may not be loaded yet, and it will retry every frame.
Parameters
name:String — The name of the clip to be played.
| |
transition:IAnimationTransition (default = null) | |
offset:Number (default = NaN) |
| setRenderState | () | method |
public function setRenderState(stage3DProxy:Stage3DProxy, renderable:IRenderable, vertexConstantOffset:int, vertexStreamOffset:int, camera:Camera3D):voidSets 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):voidVerifies 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 |
| updateDeltaTime | () | method |
override protected function updateDeltaTime(dt:Number):void
Parameters
dt:Number |