Options
Menu

Class SkeletonPose

A collection of pose objects, determining the pose for an entire skeleton. The jointPoses vector object corresponds to a skeleton's joints vector object, however, there is no reference to a skeleton's instance, since several skeletons can be influenced by the same pose (eg: animation clips are added to any animator with a valid skeleton)

see

away.animators.Skeleton

see

away.animators.JointPose

Hierarchy

  • AssetBase

Implements

  • IAsset
  • IAssetAdapter
  • IAsset

Index

Constructors

constructor

  • Creates a new SkeletonPose object.

    Returns SkeletonPose

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

jointPoses

jointPoses: Array<JointPose>

A flat list of pose objects that comprise the skeleton pose. The pose indices correspond to the target skeleton's joint indices.

see

away.animators.Skeleton#joints

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

numJointPoses

  • get (): number
  • The total number of joint poses in the skeleton pose.

    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

clone

  • Creates a copy of the SkeletonPose object, with a dulpicate of its component joint poses.

    Returns SkeletonPose

    SkeletonPose

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

jointPoseFromName

  • jointPoseFromName(jointName: string): JointPose
  • Returns the joint pose object with the given joint name, otherwise returns a null object.

    Parameters

    • jointName: string

      The name of the joint object whose pose is to be found.

    Returns JointPose

    The pose object with the given joint name.

jointPoseIndexFromName

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

    see

    #jointPoses

    Parameters

    • jointName: string

    Returns number

    The index of the pose object in the jointPoses 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