Packageaway3d.animators
Classpublic class SkeletonAnimationSet
InheritanceSkeletonAnimationSet Inheritance AnimationSetBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher
Implements IAnimationSet

The animation data set used by skeleton-based animators, containing skeleton animation state data.

See also

away3d.animators.SkeletonAnimator
away3d.animators.SkeletonAnimationState


Public Properties
 PropertyDefined By
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[read-only]
AnimationSetBase
  jointsPerVertex : uint
[read-only] Returns the amount of skeleton joints that can be linked to a single vertex via skinned weight values.
SkeletonAnimationSet
 Inheritedname : String
NamedAssetBase
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
 Inheritedstates : Vector.<IAnimationState>
[read-only] Returns a vector of animation state objects that make up the contents of the animation data set.
AnimationSetBase
 InheritedusesCPU : Boolean
[read-only] Indicates whether the properties of the animation data contained within the set combined with the vertex registers aslready in use on shading materials allows the animation data to utilise GPU calls.
AnimationSetBase
Public Methods
 MethodDefined By
  
SkeletonAnimationSet(jointsPerVertex:uint = 4)
Creates a new SkeletonAnimationSet object.
SkeletonAnimationSet
  
activate(stage3DProxy:Stage3DProxy, pass:MaterialPassBase):void
SkeletonAnimationSet
  
addState(stateName:String, animationState:IAnimationState):void
[override] Adds an animation state object to the aniamtion data set under the given name.
SkeletonAnimationSet
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
  
deactivate(stage3DProxy:Stage3DProxy, pass:MaterialPassBase):void
SkeletonAnimationSet
 Inherited
dispose():void
Cleans up any resources used by the current object.
AnimationSetBase
  
getAGALVertexCode(pass:MaterialPassBase, sourceRegisters:Array, targetRegisters:Array):String
SkeletonAnimationSet
 Inherited
getState(stateName:String):IAnimationState
Retrieves the animation state object registered in the animation data set under the given name.
AnimationSetBase
 Inherited
hasState(stateName:String):Boolean
Check to determine whether a state is registered in the animation set under the given name.
AnimationSetBase
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
Protected Methods
 MethodDefined By
 Inherited
findTempReg(exclude:Array, excludeAnother:String = null):String
Retrieves a temporary GPU register that's still free.
AnimationSetBase
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Property Detail
jointsPerVertexproperty
jointsPerVertex:uint  [read-only]

Returns the amount of skeleton joints that can be linked to a single vertex via skinned weight values. For GPU-base animation, the maximum allowed value is 4.


Implementation
    public function get jointsPerVertex():uint
Constructor Detail
SkeletonAnimationSet()Constructor
public function SkeletonAnimationSet(jointsPerVertex:uint = 4)

Creates a new SkeletonAnimationSet object.

Parameters
jointsPerVertex:uint (default = 4) — Sets the amount of skeleton joints that can be linked to a single vertex via skinned weight values. For GPU-base animation, the maximum allowed value is 4. Defaults to 4.
Method Detail
activate()method
public function activate(stage3DProxy:Stage3DProxy, pass:MaterialPassBase):void

Parameters

stage3DProxy:Stage3DProxy
 
pass:MaterialPassBase

addState()method 
override public function addState(stateName:String, animationState:IAnimationState):void

Adds an animation state object to the aniamtion data set under the given name.

Parameters

stateName:String — The name under which the animation state object will be stored.
 
animationState:IAnimationState — The animation state object to be staored in the set.

deactivate()method 
public function deactivate(stage3DProxy:Stage3DProxy, pass:MaterialPassBase):void

Parameters

stage3DProxy:Stage3DProxy
 
pass:MaterialPassBase

getAGALVertexCode()method 
public function getAGALVertexCode(pass:MaterialPassBase, sourceRegisters:Array, targetRegisters:Array):String

Parameters

pass:MaterialPassBase
 
sourceRegisters:Array
 
targetRegisters:Array

Returns
String