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 data.

See also

away3d.animators.SkeletonAnimator


Public Properties
 PropertyDefined By
 InheritedanimationNames : Vector.<String>
[read-only] Returns a vector of animation state objects that make up the contents of the animation data set.
AnimationSetBase
 Inheritedanimations : Vector.<AnimationNodeBase>
[read-only] Returns a vector of animation state objects that make up the contents of the animation data set.
AnimationSetBase
 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
 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
 Inherited
Adds an animation state object to the aniamtion data set under the given name.
AnimationSetBase
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 Inherited
AnimationSetBase
  
deactivate(stage3DProxy:Stage3DProxy, pass:MaterialPassBase):void
SkeletonAnimationSet
 Inherited
dispose():void
Cleans up any resources used by the current object.
AnimationSetBase
  
SkeletonAnimationSet
  
getAGALFragmentCode(pass:MaterialPassBase, shadedTarget:String):String
SkeletonAnimationSet
  
getAGALUVCode(pass:MaterialPassBase, UVSource:String, UVTarget:String):String
SkeletonAnimationSet
  
getAGALVertexCode(pass:MaterialPassBase, sourceRegisters:Vector.<String>, targetRegisters:Vector.<String>):String
SkeletonAnimationSet
 Inherited
Retrieves the animation state object registered in the animation data set under the given name.
AnimationSetBase
 Inherited
hasAnimation(name: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:Vector.<String>, 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

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

Parameters

stage3DProxy:Stage3DProxy
 
pass:MaterialPassBase

doneAGALCode()method 
public function doneAGALCode(pass:MaterialPassBase):void

Parameters

pass:MaterialPassBase

getAGALFragmentCode()method 
public function getAGALFragmentCode(pass:MaterialPassBase, shadedTarget:String):String

Parameters

pass:MaterialPassBase
 
shadedTarget:String

Returns
String
getAGALUVCode()method 
public function getAGALUVCode(pass:MaterialPassBase, UVSource:String, UVTarget:String):String

Parameters

pass:MaterialPassBase
 
UVSource:String
 
UVTarget:String

Returns
String
getAGALVertexCode()method 
public function getAGALVertexCode(pass:MaterialPassBase, sourceRegisters:Vector.<String>, targetRegisters:Vector.<String>):String

Parameters

pass:MaterialPassBase
 
sourceRegisters:Vector.<String>
 
targetRegisters:Vector.<String>

Returns
String