Package | away3d.animators |
Class | public class SpriteSheetAnimator |
Inheritance | SpriteSheetAnimator ![]() ![]() |
Implements | IAnimator |
Property | Defined By | ||
---|---|---|---|
![]() | absoluteTime : Number [read-only]
Returns the internal absolute time of the animator, calculated by the current time and the playback speed. | AnimatorBase | |
![]() | activeAnimation : AnimationNodeBase [read-only]
Returns the current active animation node. | AnimatorBase | |
![]() | activeAnimationName : String [read-only]
Returns the current active animation node. | AnimatorBase | |
![]() | activeState : IAnimationState [read-only]
Returns the current active animation state. | AnimatorBase | |
![]() | animationSet : IAnimationSet [read-only]
Returns the animation data set in use by the animator. | AnimatorBase | |
![]() | autoUpdate : Boolean
Determines whether the animators internal update mechanisms are active. | AnimatorBase | |
backAndForth : Boolean | SpriteSheetAnimator | ||
currentFrameNumber : uint [read-only] | SpriteSheetAnimator | ||
fps : uint | SpriteSheetAnimator | ||
![]() | playbackSpeed : Number
The amount by which passed time should be scaled. | AnimatorBase | |
reverse : Boolean | SpriteSheetAnimator | ||
![]() | time : int
Gets and sets the internal time clock of the animator. | AnimatorBase | |
totalFrames : uint [read-only] | SpriteSheetAnimator | ||
![]() | updatePosition : Boolean = true
Enables translation of the animated mesh from data returned per frame via the positionDelta property of the active animation node. | AnimatorBase |
Method | Defined By | ||
---|---|---|---|
SpriteSheetAnimator(spriteSheetAnimationSet:SpriteSheetAnimationSet)
Creates a new SpriteSheetAnimator object. | SpriteSheetAnimator | ||
SpriteSheetAnimator | |||
![]() | AnimatorBase | ||
![]() | getAnimationStateByName(name:String):AnimationStateBase | AnimatorBase | |
gotoAndPlay(frameNumber:uint):void | SpriteSheetAnimator | ||
gotoAndStop(frameNumber:uint):void | SpriteSheetAnimator | ||
![]() | 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 | SpriteSheetAnimator | ||
![]() | 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. | SpriteSheetAnimator | ||
![]() | 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 | SpriteSheetAnimator | ||
![]() | 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]
Applies the calculated time delta to the active animation state node. | SpriteSheetAnimator |
backAndForth | property |
backAndForth:Boolean
public function get backAndForth():Boolean
public function set backAndForth(value:Boolean):void
currentFrameNumber | property |
currentFrameNumber:uint
[read-only] public function get currentFrameNumber():uint
fps | property |
fps:uint
public function get fps():uint
public function set fps(value:uint):void
reverse | property |
reverse:Boolean
public function get reverse():Boolean
public function set reverse(value:Boolean):void
totalFrames | property |
totalFrames:uint
[read-only] public function get totalFrames():uint
SpriteSheetAnimator | () | Constructor |
public function SpriteSheetAnimator(spriteSheetAnimationSet:SpriteSheetAnimationSet)
Creates a new SpriteSheetAnimator
object.
spriteSheetAnimationSet:SpriteSheetAnimationSet — The animation data set containing the sprite sheet animation states used by the animator.
|
clone | () | method |
gotoAndPlay | () | method |
public function gotoAndPlay(frameNumber:uint):void
Parameters
frameNumber:uint |
gotoAndStop | () | method |
public function gotoAndStop(frameNumber:uint):void
Parameters
frameNumber:uint |
play | () | method |
public function play(name:String, transition:IAnimationTransition = null, offset:Number):void
Parameters
name:String | |
transition:IAnimationTransition (default = null )
| |
offset:Number (default = NaN )
|
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 |
updateDeltaTime | () | method |
override protected function updateDeltaTime(dt:Number):void
Applies the calculated time delta to the active animation state node.
Parameters
dt:Number |