Packageaway3d.animators
Classpublic class VertexAnimationSet
InheritanceVertexAnimationSet Inheritance AnimationSetBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher
Implements IAnimationSet

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

See also

away3d.animators.VertexAnimator
away3d.animators.VertexAnimationState


Public Properties
 PropertyDefined By
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[read-only]
AnimationSetBase
  blendMode : String
[read-only] Returns the active blend mode of the vertex animator object.
VertexAnimationSet
 Inheritedname : String
NamedAssetBase
  numPoses : uint
[read-only] Returns the number of poses made available at once to the GPU animation code.
VertexAnimationSet
 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
  useNormals : Boolean
[read-only] Returns whether or not normal data is used in last set GPU pass of the vertex shader.
VertexAnimationSet
 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
  
VertexAnimationSet(numPoses:uint = 2, blendMode:String = absolute)
Creates a new VertexAnimationSet object.
VertexAnimationSet
  
activate(stage3DProxy:Stage3DProxy, pass:MaterialPassBase):void
VertexAnimationSet
  
addState(stateName:String, animationState:IAnimationState):void
[override] Adds an animation state object to the aniamtion data set under the given name.
VertexAnimationSet
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
  
deactivate(stage3DProxy:Stage3DProxy, pass:MaterialPassBase):void
VertexAnimationSet
 Inherited
dispose():void
Cleans up any resources used by the current object.
AnimationSetBase
  
getAGALVertexCode(pass:MaterialPassBase, sourceRegisters:Array, targetRegisters:Array):String
VertexAnimationSet
 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
blendModeproperty
blendMode:String  [read-only]

Returns the active blend mode of the vertex animator object.


Implementation
    public function get blendMode():String
numPosesproperty 
numPoses:uint  [read-only]

Returns the number of poses made available at once to the GPU animation code.


Implementation
    public function get numPoses():uint
useNormalsproperty 
useNormals:Boolean  [read-only]

Returns whether or not normal data is used in last set GPU pass of the vertex shader.


Implementation
    public function get useNormals():Boolean
Constructor Detail
VertexAnimationSet()Constructor
public function VertexAnimationSet(numPoses:uint = 2, blendMode:String = absolute)

Creates a new VertexAnimationSet object.

Parameters
numPoses:uint (default = 2) — The number of poses made available at once to the GPU animation code.
 
blendMode:String (default = absolute) — Optional value for setting the animation mode of the vertex animator object.

See also

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