Options
Menu

Class Skeleton

A Skeleton object is a hierarchical grouping of joint objects that can be used for skeletal animation.

see

away.animators.SkeletonJoint

Hierarchy

  • AssetBase

Implements

  • IAsset
  • IAssetAdapter
  • IAsset

Index

Constructors

constructor

  • Creates a new Skeleton object

    Returns Skeleton

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

assetFullPath

assetFullPath: Array<string>

assetNamespace

assetNamespace: string

id

id: number

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

joints

joints: Array<SkeletonJoint>

A flat list of joint objects that comprise the skeleton. Every joint except for the root has a parentIndex property that is an index into this list. A child joint should always have a higher index than its parent.

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.

Static DEFAULT_NAMESPACE

DEFAULT_NAMESPACE: string

Static ID_COUNT

ID_COUNT: number

Static assetType

assetType: string

Accessors

assetType

  • get (): string
  • inheritdoc

    Returns string

numJoints

  • get (): number
  • The total number of joints in the skeleton.

    Returns number

Methods

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

clear

  • clear(): void
  • Returns void

dispatchEvent

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

    method

    dispatchEvent

    Parameters

    • event: EventBase

    Returns void

dispose

  • dispose(): void
  • inheritdoc

    Returns void

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

jointFromName

  • Returns the joint object in the skeleton with the given name, otherwise returns a null object.

    see

    #joints

    Parameters

    • jointName: string

      The name of the joint object to be found.

    Returns SkeletonJoint

    The joint object with the given name.

jointIndexFromName

  • jointIndexFromName(jointName: string): number
  • Returns the joint index, given the joint name. -1 is returned if the joint name is not found.

    see

    #joints

    Parameters

    • jointName: string

      The name of the joint object to be found.

    Returns number

    The index of the joint object in the joints Array

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

updateFullPath

  • updateFullPath(): void
  • Returns void

Generated using TypeDoc