Packageaway3d.animators
Classpublic class ParticleAnimator
InheritanceParticleAnimator Inheritance AnimatorBase Inheritance flash.events.EventDispatcher
Implements IAnimator

Provides an interface for assigning paricle-based animation data sets to mesh-based entity objects and controlling the various available states of animation through an interative playhead that can be automatically updated or manually triggered. Requires that the containing geometry of the parent mesh is particle geometry

See also

away3d.core.base.ParticleGeometry


Public Properties
 PropertyDefined By
 InheritedabsoluteTime : Number
[read-only] Returns the internal absolute time of the animator, calculated by the current time and the playback speed.
AnimatorBase
 InheritedactiveAnimation : AnimationNodeBase
[read-only] Returns the current active animation node.
AnimatorBase
 InheritedactiveAnimationName : String
[read-only] Returns the current active animation node.
AnimatorBase
 InheritedactiveState : IAnimationState
[read-only] Returns the current active animation state.
AnimatorBase
 InheritedanimationSet : IAnimationSet
[read-only] Returns the animation data set in use by the animator.
AnimatorBase
 InheritedautoUpdate : Boolean
Determines whether the animators internal update mechanisms are active.
AnimatorBase
 InheritedplaybackSpeed : Number
The amount by which passed time should be scaled.
AnimatorBase
 Inheritedtime : int
Gets and sets the internal time clock of the animator.
AnimatorBase
 InheritedupdatePosition : Boolean = true
Enables translation of the animated mesh from data returned per frame via the positionDelta property of the active animation node.
AnimatorBase
Protected Properties
 PropertyDefined By
 Inherited_absoluteTime : Number = 0
AnimatorBase
 Inherited_activeNode : AnimationNodeBase
AnimatorBase
 Inherited_activeState : IAnimationState
AnimatorBase
 Inherited_animationSet : IAnimationSet
AnimatorBase
 Inherited_name : String
AnimatorBase
 Inherited_owners : Vector.<Mesh>
AnimatorBase
Public Methods
 MethodDefined By
  
Creates a new ParticleAnimator object.
ParticleAnimator
 Inherited
AnimatorBase
 Inherited
AnimatorBase
 Inherited
phase(value:Number):void
Sets the animation phase of the current active state's animation clip(s).
AnimatorBase
 Inherited
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
 Inherited
stop():void
Pauses the automatic playback clock of the animator, in case manual updates are required via the time property or update() method.
AnimatorBase
  
Verifies if the animation will be used on cpu.
ParticleAnimator
 Inherited
update(time:int):void
Provides a way to manually update the active state of the animator when automatic updates are disabled.
AnimatorBase
Protected Methods
 MethodDefined By
  
updateDeltaTime(dt:Number):void
[override]
ParticleAnimator
Events
 Event Summary Defined By
 InheritedDispatched when playback of an animation inside the animator object starts.AnimatorBase
 InheritedDispatched when playback of an animation inside the animator object stops.AnimatorBase
Constructor Detail
ParticleAnimator()Constructor
public function ParticleAnimator(particleAnimationSet:ParticleAnimationSet)

Creates a new ParticleAnimator object.

Parameters
particleAnimationSet:ParticleAnimationSet — The animation data set containing the particle animations used by the animator.
Method Detail
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):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

start()method 
override public function start():void

Resumes the automatic playback clock controling the active state of the animator.

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

updateDeltaTime()method 
override protected function updateDeltaTime(dt:Number):void

Parameters

dt:Number