| Package | away3d.animators |
| Class | public class ParticleAnimator |
| Inheritance | ParticleAnimator  AnimatorBase flash.events.EventDispatcher |
| Implements | IAnimator |
See also
| Method | Defined By | ||
|---|---|---|---|
ParticleAnimator(particleAnimationSet:ParticleAnimationSet)
Creates a new ParticleAnimator object. | ParticleAnimator | ||
 | 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 | |
resetTime(offset:int = 0):void | ParticleAnimator | ||
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. | ParticleAnimator | ||
start():void [override]
Resumes the automatic playback clock controling the active state of the animator. | ParticleAnimator | ||
| 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. | ParticleAnimator | ||
| 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]
| ParticleAnimator | ||
| ParticleAnimator | () | Constructor |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic function ParticleAnimator(particleAnimationSet:ParticleAnimationSet)
Creates a new ParticleAnimator object.
particleAnimationSet:ParticleAnimationSet — The animation data set containing the particle animations used by the animator.
|
| resetTime | () | method |
public function resetTime(offset:int = 0):void
Parameters
offset:int (default = 0) |
| 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 |
| start | () | method |
override public function start():voidResumes the automatic playback clock controling the active state of the animator.
| 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 |