Options
Menu

Class SkeletonAnimationSet

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

see

away.animators.SkeletonAnimator

Hierarchy

  • AnimationSetBase

Implements

  • IAsset
  • IAssetAdapter
  • IAsset
  • IAnimationSet

Index

Constructors

constructor

  • Creates a new SkeletonAnimationSet object.

    Parameters

    • Default value jointsPerVertex: number = 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.

    Returns SkeletonAnimationSet

Properties

_adapter

_adapter: IAssetAdapter

adaptee

adaptee: AssetBase

adapter

adapter: IAssetAdapter

adapter is used to provide MovieClip to scripts taken from different platforms setter typically managed by factory. getter defaults to AwayJS class

animationNames

animationNames: Array<string>

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

animations

animations: Array<AnimationNodeBase>

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

assetFullPath

assetFullPath: Array<string>

assetNamespace

assetNamespace: string

assetType

assetType: string
inheritdoc

id

id: number

A unique id for the asset, used to identify assets in an associative array

name

name: string

originalName

originalName: string

The original name used for this asset in the resource (e.g. file) in which it was found. This may not be the same as name, which may have changed due to of a name conflict.

usesCPU

usesCPU: boolean

Indicates whether the properties of the animation data contained within the set combined with the vertex registers already in use on shading materials allows the animation data to utilise GPU calls.

Static DEFAULT_NAMESPACE

DEFAULT_NAMESPACE: string

Static ID_COUNT

ID_COUNT: number

Static assetType

assetType: string

Accessors

jointsPerVertex

  • get (): number
  • 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.

    Returns number

matricesIndex

  • get (): number
  • Returns number

Methods

_pFindTempReg

  • _pFindTempReg(exclude: Array<string>, excludeAnother?: string): string
  • Retrieves a temporary GPU register that's still free.

    Parameters

    • exclude: Array<string>

      An array of non-free temporary registers.

    • Optional excludeAnother: string

      An additional register that's not free.

    Returns string

    A temporary register that can be used.

addAnimation

  • addAnimation(node: AnimationNodeBase): void
  • Adds an animation state object to the aniamtion data set under the given name.

    Parameters

    • node: AnimationNodeBase

    Returns void

addEventListener

  • addEventListener(type: string, listener: function): void
  • Add an event listener

    method

    addEventListener

    Parameters

    • type: string
    • listener: function
        • (event: EventBase): void
        • Parameters

          • event: EventBase

          Returns void

    Returns void

assetPathEquals

  • assetPathEquals(name: string, ns: string): boolean
  • Parameters

    • name: string
    • ns: string

    Returns boolean

cancelGPUCompatibility

  • cancelGPUCompatibility(): void
  • Returns void

clear

  • clear(): void
  • Returns void

dispatchEvent

  • dispatchEvent(event: EventBase): void
  • Dispatch an event

    method

    dispatchEvent

    Parameters

    • event: EventBase

    Returns void

dispose

  • dispose(): void
  • Cleans up any resources used by the current object.

    Returns void

doneAGALCode

  • doneAGALCode(shader: ShaderBase): void
  • inheritdoc

    Parameters

    • shader: ShaderBase

    Returns void

getAGALFragmentCode

  • getAGALFragmentCode(shader: ShaderBase, registerCache: ShaderRegisterCache, shadedTarget: ShaderRegisterElement): string
  • inheritdoc

    Parameters

    • shader: ShaderBase
    • registerCache: ShaderRegisterCache
    • shadedTarget: ShaderRegisterElement

    Returns string

getAGALUVCode

  • getAGALUVCode(shader: ShaderBase, registerCache: ShaderRegisterCache, sharedRegisters: ShaderRegisterData): string
  • inheritdoc

    Parameters

    • shader: ShaderBase
    • registerCache: ShaderRegisterCache
    • sharedRegisters: ShaderRegisterData

    Returns string

getAGALVertexCode

  • getAGALVertexCode(shader: ShaderBase, registerCache: ShaderRegisterCache, sharedRegisters: ShaderRegisterData): string
  • inheritdoc

    Parameters

    • shader: ShaderBase
    • registerCache: ShaderRegisterCache
    • sharedRegisters: ShaderRegisterData

    Returns string

getAnimation

  • getAnimation(name: string): AnimationNodeBase
  • Retrieves the animation state object registered in the animation data set under the given name.

    Parameters

    • name: string

    Returns AnimationNodeBase

hasAnimation

  • hasAnimation(name: string): boolean
  • Check to determine whether a state is registered in the animation set under the given name.

    Parameters

    • name: string

    Returns boolean

hasEventListener

  • hasEventListener(type: string, listener?: function): boolean
  • check if an object has an event listener assigned to it

    method

    hasListener

    Parameters

    • type: string
    • Optional listener: function
        • (event: EventBase): void
        • Parameters

          • event: EventBase

          Returns void

    Returns boolean

invalidate

  • invalidate(): void
  • Returns void

isAsset

  • isAsset(assetClass: IAssetClass): boolean
  • Parameters

    • assetClass: IAssetClass

    Returns boolean

removeEventListener

  • removeEventListener(type: string, listener: function): void
  • Remove an event listener

    method

    removeEventListener

    Parameters

    • type: string
    • listener: function
        • (event: EventBase): void
        • Parameters

          • event: EventBase

          Returns void

    Returns void

resetAssetPath

  • resetAssetPath(name: string, ns?: string, overrideOriginal?: boolean): void
  • Parameters

    • name: string
    • Optional ns: string
    • Optional overrideOriginal: boolean

    Returns void

Private resetGPUCompatibility

  • resetGPUCompatibility(): void
  • Called by the material to reset the GPU indicator before testing whether register space in the shader is available for running GPU-based animation code.

    Returns void

updateFullPath

  • updateFullPath(): void
  • Returns void

Generated using TypeDoc