Packageaway3d.animators
Classpublic class AnimationSetBase
InheritanceAnimationSetBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher
Implements IAsset
Subclasses SkeletonAnimationSet, UVAnimationSet, VertexAnimationSet

Provides an abstract base class for data set classes that hold animation data for use in animator classes.

See also

away3d.animators.AnimatorBase


Public Properties
 PropertyDefined By
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
  assetType : String
[read-only]
AnimationSetBase
 Inheritedname : String
NamedAssetBase
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
  states : Vector.<IAnimationState>
[read-only] Returns a vector of animation state objects that make up the contents of the animation data set.
AnimationSetBase
  usesCPU : 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
  
addState(stateName:String, animationState:IAnimationState):void
Adds an animation state object to the aniamtion data set under the given name.
AnimationSetBase
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
  
dispose():void
Cleans up any resources used by the current object.
AnimationSetBase
  
getState(stateName:String):IAnimationState
Retrieves the animation state object registered in the animation data set under the given name.
AnimationSetBase
  
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
  
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
_usesCPUproperty
arcane var _usesCPU:Boolean

assetTypeproperty 
assetType:String  [read-only]


Implementation
    public function get assetType():String
statesproperty 
states:Vector.<IAnimationState>  [read-only]

Returns a vector of animation state objects that make up the contents of the animation data set.


Implementation
    public function get states():Vector.<IAnimationState>
usesCPUproperty 
usesCPU: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.


Implementation
    public function get usesCPU():Boolean
Method Detail
addState()method
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.

dispose()method 
public function dispose():void

Cleans up any resources used by the current object.

findTempReg()method 
protected function findTempReg(exclude:Array, excludeAnother:String = null):String

Retrieves a temporary GPU register that's still free.

Parameters

exclude:Array — An array of non-free temporary registers.
 
excludeAnother:String (default = null) — An additional register that's not free.

Returns
String — A temporary register that can be used.
getState()method 
public function getState(stateName:String):IAnimationState

Retrieves the animation state object registered in the animation data set under the given name.

Parameters

stateName:String — The name of the animation state object to be retrieved.

Returns
IAnimationState
hasState()method 
public function hasState(stateName:String):Boolean

Check to determine whether a state is registered in the animation set under the given name.

Parameters

stateName:String — The name of the animation state object to be checked.

Returns
Boolean