Packageaway3d.animators.nodes
Classpublic class SkeletonClipNode
InheritanceSkeletonClipNode Inheritance AnimationClipNodeBase Inheritance AnimationNodeBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher
Implements ISkeletonAnimationNode

A skeleton animation node containing time-based animation data as individual skeleton poses.



Public Properties
 PropertyDefined By
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[read-only]
AnimationNodeBase
 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.
AnimationClipNodeBase
 InheritedcurrentFrame : uint
[read-only] Returns the current frame of animation in the clip based on the internal playhead position.
AnimationClipNodeBase
  currentPose : SkeletonPose
[read-only] Returns the current skeleton pose frame of animation in the clip based on the internal playhead position.
SkeletonClipNode
 Inheriteddurations : Vector.<uint>
[read-only] Returns a vector of time values representing the duration (in milliseconds) of each animation frame in the clip.
AnimationClipNodeBase
 InheritedfixedFrameRate : Boolean = true
AnimationClipNodeBase
  frames : Vector.<SkeletonPose>
[read-only] Returns a vector of skeleton poses representing the pose of each animation frame in the clip.
SkeletonClipNode
  highQuality : Boolean = false
Determines whether to use SLERP equations (true) or LERP equations (false) in the calculation of the output skeleton pose.
SkeletonClipNode
 Inheritedlooping : Boolean
Determines whether the contents of the animation node have looping characteristics enabled.
AnimationNodeBase
 Inheritedname : String
NamedAssetBase
 InheritednextFrame : uint
[read-only] Returns the next frame of animation in the clip based on the internal playhead position.
AnimationClipNodeBase
  nextPose : SkeletonPose
[read-only] Returns the next skeleton pose frame of animation in the clip based on the internal playhead position.
SkeletonClipNode
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
 InheritedrootDelta : Vector3D
[read-only] Returns a 3d vector representing the translation delta of the animating entity for the current timestep of animation
AnimationNodeBase
 InheritedstitchFinalFrame : Boolean
Defines if looping content blends the final frame of animation data with the first (true) or works on the assumption that both first and last frames are identical (false).
AnimationClipNodeBase
Protected Properties
 PropertyDefined By
 Inherited_blendWeight : Number
AnimationClipNodeBase
 Inherited_currentFrame : uint
AnimationClipNodeBase
 Inherited_durations : Vector.<uint>
AnimationClipNodeBase
 Inherited_framesDirty : Boolean = true
AnimationClipNodeBase
 Inherited_lastFrame : uint
AnimationClipNodeBase
 Inherited_looping : Boolean = true
AnimationNodeBase
 Inherited_nextFrame : uint
AnimationClipNodeBase
 Inherited_numFrames : uint = 0
AnimationClipNodeBase
 Inherited_rootDelta : Vector3D
AnimationNodeBase
 Inherited_rootDeltaDirty : Boolean = true
AnimationNodeBase
 Inherited_stitchDirty : Boolean = true
AnimationClipNodeBase
 Inherited_stitchFinalFrame : Boolean = false
AnimationClipNodeBase
 Inherited_time : int
AnimationNodeBase
 Inherited_totalDelta : Vector3D
AnimationClipNodeBase
 Inherited_totalDuration : uint = 0
AnimationNodeBase
Public Methods
 MethodDefined By
  
Creates a new SkeletonClipNode object.
SkeletonClipNode
  
addFrame(skeletonPose:SkeletonPose, duration:uint):void
Adds a skeleton pose frame to the internal timeline of the animation node.
SkeletonClipNode
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 Inherited
dispose():void
Cleans up resources used by this asset.
AnimationNodeBase
  
Returns the current skeleton pose of the animation in the clip based on the internal playhead position.
SkeletonClipNode
 Inherited
reset(time:int):void
Resets the configuration of the node to its default state.
AnimationNodeBase
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
 Inherited
update(time:int):void
Updates the configuration of the node to its current state.
AnimationNodeBase
Protected Methods
 MethodDefined By
  
[override] Updates the nodes internal playhead to determine the current and next animation frame, and the blendWeight between the two.
SkeletonClipNode
 Inherited
[override] Updates the node's looping state
AnimationClipNodeBase
  
[override] Updates the node's root delta position
SkeletonClipNode
  
Updates the output skeleton pose of the node based on the internal playhead position.
SkeletonClipNode
  
[override] Updates the node's final frame stitch state.
SkeletonClipNode
  
updateTime(time:int):void
[override] Updates the node's internal playhead position.
SkeletonClipNode
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Property Detail
currentPoseproperty
currentPose:SkeletonPose  [read-only]

Returns the current skeleton pose frame of animation in the clip based on the internal playhead position.


Implementation
    public function get currentPose():SkeletonPose
framesproperty 
frames:Vector.<SkeletonPose>  [read-only]

Returns a vector of skeleton poses representing the pose of each animation frame in the clip.


Implementation
    public function get frames():Vector.<SkeletonPose>
highQualityproperty 
public var highQuality:Boolean = false

Determines whether to use SLERP equations (true) or LERP equations (false) in the calculation of the output skeleton pose. Defaults to false.

nextPoseproperty 
nextPose:SkeletonPose  [read-only]

Returns the next skeleton pose frame of animation in the clip based on the internal playhead position.


Implementation
    public function get nextPose():SkeletonPose
Constructor Detail
SkeletonClipNode()Constructor
public function SkeletonClipNode()

Creates a new SkeletonClipNode object.

Method Detail
addFrame()method
public function addFrame(skeletonPose:SkeletonPose, duration:uint):void

Adds a skeleton pose frame to the internal timeline of the animation node.

Parameters

skeletonPose:SkeletonPose — The skeleton pose object to add to the timeline of the node.
 
duration:uint — The specified duration of the frame in milliseconds.

getSkeletonPose()method 
public function getSkeletonPose(skeleton:Skeleton):SkeletonPose

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

Parameters

skeleton:Skeleton

Returns
SkeletonPose
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.

updateRootDelta()method 
override protected function updateRootDelta():void

Updates the node's root delta position

updateSkeletonPose()method 
protected function updateSkeletonPose(skeleton:Skeleton):void

Updates the output skeleton pose of the node based on the internal playhead position.

Parameters

skeleton:Skeleton — The skeleton used by the animator requesting the ouput pose.

updateStitch()method 
override protected function updateStitch():void

Updates the node's final frame stitch state.

updateTime()method 
override protected function updateTime(time:int):void

Updates the node's internal playhead position.

Parameters

time:int — The local time (in milliseconds) of the node's playhead position.