| Package | away3d.animators.states |
| Class | public class SpriteSheetAnimationState |
| Inheritance | SpriteSheetAnimationState  AnimationClipState AnimationStateBase Object |
| Implements | ISpriteSheetAnimationState |
| Property | Defined By | ||
|---|---|---|---|
| backAndForth : Boolean [write-only] | SpriteSheetAnimationState | ||
 | blendWeight : 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 | |
| currentFrame : 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 | ||
| nextFrame : uint [read-only]
Returns the next frame of animation in the clip based on the internal playhead position. | AnimationClipState | |
| positionDelta : 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 | ||
| Method | Defined By | ||
|---|---|---|---|
| SpriteSheetAnimationState | |||
| offset(startTime:int):void
Resets the start time of the node to a new value. | AnimationStateBase | |
| phase(value:Number):void [override]
Sets the animation phase of the node. | AnimationClipState | |
| update(time:int):void [override]
Updates the configuration of the node to its current state. | AnimationClipState | |
| Method | Defined By | ||
|---|---|---|---|
updateFrames():void [override]
Updates the nodes internal playhead to determine the current and next animation frame, and the blendWeight between the two. | SpriteSheetAnimationState | ||
| updatePositionDelta():void
Updates the node's root delta position
| AnimationStateBase | |
| updateTime(time:int):void [override]
Updates the node's internal playhead position. | AnimationClipState | |
| backAndForth | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbackAndForth:Boolean [write-only] public function set backAndForth(value:Boolean):void| currentFrameData | property |
currentFrameData:SpriteSheetAnimationFrame [read-only] Returns the current SpriteSheetAnimationFrame of animation in the clip based on the internal playhead position.
public function get currentFrameData():SpriteSheetAnimationFrame| currentFrameNumber | property |
currentFrameNumber:uintreturns current frame index of the animation. The index is zero based and counts from first frame of the defined animation.
public function get currentFrameNumber():uint public function set currentFrameNumber(value:uint):void| reverse | property |
reverse:Boolean [write-only] public function set reverse(value:Boolean):void| totalFrames | property |
totalFrames:uint [read-only] returns the total frames for the current animation.
arcane function get totalFrames():uint| SpriteSheetAnimationState | () | Constructor |
public function SpriteSheetAnimationState(animator:IAnimator, clipNode:SpriteSheetClipNode)animator:IAnimator | |
clipNode:SpriteSheetClipNode |
| updateFrames | () | method |
override protected function updateFrames():voidUpdates the nodes internal playhead to determine the current and next animation frame, and the blendWeight between the two.