| Package | away3d.animators.states |
| Class | public class AnimationClipState |
| Inheritance | AnimationClipState  AnimationStateBase Object |
| Subclasses | SkeletonClipState, SpriteSheetAnimationState, UVClipState, VertexClipState |
| Property | Defined By | ||
|---|---|---|---|
| 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 | ||
| 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 | |
| Property | Defined By | ||
|---|---|---|---|
| _animationNode : AnimationNodeBase | AnimationStateBase | |
| _animator : IAnimator | AnimationStateBase | |
| _blendWeight : Number | AnimationClipState | ||
| _currentFrame : uint | AnimationClipState | ||
| _framesDirty : Boolean = true | AnimationClipState | ||
| _nextFrame : uint | AnimationClipState | ||
| _oldFrame : uint | AnimationClipState | ||
| _positionDeltaDirty : Boolean = true | AnimationStateBase | |
| _rootDelta : Vector3D | AnimationStateBase | |
| _startTime : int | AnimationStateBase | |
| _time : int | AnimationStateBase | |
| _timeDir : int | AnimationClipState | ||
| Method | Defined By | ||
|---|---|---|---|
| AnimationClipState | |||
| 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
Updates the nodes internal playhead to determine the current and next animation frame, and the blendWeight between the two. | AnimationClipState | ||
| updatePositionDelta():void
Updates the node's root delta position
| AnimationStateBase | |
updateTime(time:int):void [override]
Updates the node's internal playhead position. | AnimationClipState | ||
| _blendWeight | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _blendWeight:Number| _currentFrame | property |
protected var _currentFrame:uint| _framesDirty | property |
protected var _framesDirty:Boolean = true| _nextFrame | property |
protected var _nextFrame:uint| _oldFrame | property |
protected var _oldFrame:uint| _timeDir | property |
protected var _timeDir:int| blendWeight | property |
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.
public function get blendWeight():NumberSee also
| currentFrame | property |
currentFrame:uint [read-only] Returns the current frame of animation in the clip based on the internal playhead position.
public function get currentFrame():uint| nextFrame | property |
nextFrame:uint [read-only] Returns the next frame of animation in the clip based on the internal playhead position.
public function get nextFrame():uint| AnimationClipState | () | Constructor |
public function AnimationClipState(animator:IAnimator, animationClipNode:AnimationClipNodeBase)animator:IAnimator | |
animationClipNode:AnimationClipNodeBase |
| phase | () | method |
override public function phase(value:Number):voidSets the animation phase of the node.
Parameters
value:Number — The phase value to use. 0 represents the beginning of an animation clip, 1 represents the end.
|
| update | () | method |
override public function update(time:int):voidUpdates the configuration of the node to its current state.
Parameters
time:int — The absolute time (in milliseconds) of the animator's play head position.
|
| updateFrames | () | method |
protected function updateFrames():voidUpdates the nodes internal playhead to determine the current and next animation frame, and the blendWeight between the two.
See also
| updateTime | () | method |
override protected function updateTime(time:int):voidUpdates the node's internal playhead position.
Parameters
time:int — The local time (in milliseconds) of the node's playhead position.
|