Packageaway3d.animators.states
Classpublic class SpriteSheetAnimationState
InheritanceSpriteSheetAnimationState Inheritance AnimationClipState Inheritance AnimationStateBase Inheritance Object
Implements ISpriteSheetAnimationState



Public Properties
 PropertyDefined By
  backAndForth : Boolean
[write-only]
SpriteSheetAnimationState
 InheritedblendWeight : Number
[read-only] Returns a fractional value between 0 and 1 representing the blending ratio of the current playhead position between the current frame (0) and next frame (1) of the animation.
AnimationClipState
 InheritedcurrentFrame : uint
[read-only] Returns the current frame of animation in the clip based on the internal playhead position.
AnimationClipState
  currentFrameData : SpriteSheetAnimationFrame
[read-only] Returns the current SpriteSheetAnimationFrame of animation in the clip based on the internal playhead position.
SpriteSheetAnimationState
  currentFrameNumber : uint
returns current frame index of the animation.
SpriteSheetAnimationState
 InheritednextFrame : uint
[read-only] Returns the next frame of animation in the clip based on the internal playhead position.
AnimationClipState
 InheritedpositionDelta : Vector3D
[read-only] Returns a 3d vector representing the translation delta of the animating entity for the current timestep of animation
AnimationStateBase
  reverse : Boolean
[write-only]
SpriteSheetAnimationState
Protected Properties
 PropertyDefined By
 Inherited_animationNode : AnimationNodeBase
AnimationStateBase
 Inherited_animator : IAnimator
AnimationStateBase
 Inherited_blendWeight : Number
AnimationClipState
 Inherited_currentFrame : uint
AnimationClipState
 Inherited_framesDirty : Boolean = true
AnimationClipState
 Inherited_nextFrame : uint
AnimationClipState
 Inherited_oldFrame : uint
AnimationClipState
 Inherited_positionDeltaDirty : Boolean = true
AnimationStateBase
 Inherited_rootDelta : Vector3D
AnimationStateBase
 Inherited_startTime : int
AnimationStateBase
 Inherited_time : int
AnimationStateBase
 Inherited_timeDir : int
AnimationClipState
Public Methods
 MethodDefined By
  
SpriteSheetAnimationState
 Inherited
offset(startTime:int):void
Resets the start time of the node to a new value.
AnimationStateBase
 Inherited
phase(value:Number):void
[override] Sets the animation phase of the node.
AnimationClipState
 Inherited
update(time:int):void
[override] Updates the configuration of the node to its current state.
AnimationClipState
Protected Methods
 MethodDefined By
  
[override] Updates the nodes internal playhead to determine the current and next animation frame, and the blendWeight between the two.
SpriteSheetAnimationState
 Inherited
Updates the node's root delta position
AnimationStateBase
 Inherited
updateTime(time:int):void
[override] Updates the node's internal playhead position.
AnimationClipState
Property Detail
backAndForthproperty
backAndForth:Boolean  [write-only]


Implementation
    public function set backAndForth(value:Boolean):void
currentFrameDataproperty 
currentFrameData:SpriteSheetAnimationFrame  [read-only]

Returns the current SpriteSheetAnimationFrame of animation in the clip based on the internal playhead position.


Implementation
    public function get currentFrameData():SpriteSheetAnimationFrame
currentFrameNumberproperty 
currentFrameNumber:uint

returns current frame index of the animation. The index is zero based and counts from first frame of the defined animation.


Implementation
    public function get currentFrameNumber():uint
    public function set currentFrameNumber(value:uint):void
reverseproperty 
reverse:Boolean  [write-only]


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

returns the total frames for the current animation.


Implementation
    arcane function get totalFrames():uint
Constructor Detail
SpriteSheetAnimationState()Constructor
public function SpriteSheetAnimationState(animator:IAnimator, clipNode:SpriteSheetClipNode)



Parameters
animator:IAnimator
 
clipNode:SpriteSheetClipNode
Method Detail
updateFrames()method
override protected function updateFrames():void

Updates the nodes internal playhead to determine the current and next animation frame, and the blendWeight between the two.