Packageaway3d.animators
Classpublic class SpriteSheetAnimator
InheritanceSpriteSheetAnimator Inheritance AnimatorBase Inheritance flash.events.EventDispatcher
Implements IAnimator

Provides an interface for assigning uv-based sprite sheet 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.



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
  backAndForth : Boolean
SpriteSheetAnimator
  currentFrameNumber : uint
[read-only]
SpriteSheetAnimator
  fps : uint
SpriteSheetAnimator
 InheritedplaybackSpeed : Number
The amount by which passed time should be scaled.
AnimatorBase
  reverse : Boolean
SpriteSheetAnimator
 Inheritedtime : int
Gets and sets the internal time clock of the animator.
AnimatorBase
  totalFrames : uint
[read-only]
SpriteSheetAnimator
 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 SpriteSheetAnimator object.
SpriteSheetAnimator
  
SpriteSheetAnimator
 Inherited
AnimatorBase
 Inherited
AnimatorBase
  
gotoAndPlay(frameNumber:uint):void
SpriteSheetAnimator
  
gotoAndStop(frameNumber:uint):void
SpriteSheetAnimator
 Inherited
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
 Inherited
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
 Inherited
start():void
Resumes the automatic playback clock controling the active state of the animator.
AnimatorBase
 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
  
SpriteSheetAnimator
 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] Applies the calculated time delta to the active animation state node.
SpriteSheetAnimator
Events
 Event Summary Defined By
 InheritedDispatched when playback of an animation reaches the end of an animation.AnimatorBase
 InheritedDispatched when playback of an animation inside the animator object starts.AnimatorBase
 InheritedDispatched when playback of an animation inside the animator object stops.AnimatorBase
Property Detail
backAndForthproperty
backAndForth:Boolean


Implementation
    public function get backAndForth():Boolean
    public function set backAndForth(value:Boolean):void
currentFrameNumberproperty 
currentFrameNumber:uint  [read-only]


Implementation
    public function get currentFrameNumber():uint
fpsproperty 
fps:uint


Implementation
    public function get fps():uint
    public function set fps(value:uint):void
reverseproperty 
reverse:Boolean


Implementation
    public function get reverse():Boolean
    public function set reverse(value:Boolean):void
totalFramesproperty 
totalFrames:uint  [read-only]


Implementation
    public function get totalFrames():uint
Constructor Detail
SpriteSheetAnimator()Constructor
public function SpriteSheetAnimator(spriteSheetAnimationSet:SpriteSheetAnimationSet)

Creates a new SpriteSheetAnimator object.

Parameters
spriteSheetAnimationSet:SpriteSheetAnimationSet — The animation data set containing the sprite sheet animation states used by the animator.
Method Detail
clone()method
public function clone():IAnimator

Returns
IAnimator
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 
public function testGPUCompatibility(pass:MaterialPassBase):void

Parameters

pass:MaterialPassBase

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

Applies the calculated time delta to the active animation state node.

Parameters

dt:Number