Class Skeleton

Contains information about bones required for skeletal animation.

Note

Must be immutable in order to be usable on multiple threads

Hierarchy

FrameworkObject
- Skeleton

Index

Constructors

Accessors

boneCount rootBoneIndex skeletonPhysicsData skeletonPhysicsDataHandle

Methods

getAncestorBoneIndices getBoneData getDescendantBoneIndices

Constructors

`Protected`constructor

new Skeleton(isInternalConstructor?): Skeleton
Parameters
- OptionalisInternalConstructor: boolean
Returns Skeleton
Overrides FrameworkObject.constructor

Accessors

boneCount

get boneCount(): number
Returns the total number of bones in the skeleton.

Returns number

rootBoneIndex

get rootBoneIndex(): number
Searches all bones to find a root bone. Returns -1 if no root can be found.

Returns number

skeletonPhysicsData

get skeletonPhysicsData(): SkeletonPhysicsData
Sets the skeleton physics data to use with this skeleton

Returns SkeletonPhysicsData
set skeletonPhysicsData(value): void
Sets the skeleton physics data to use with this skeleton
Parameters
- value: SkeletonPhysicsData
Returns void

skeletonPhysicsDataHandle

get skeletonPhysicsDataHandle(): ResourceHandle<SkeletonPhysicsData>
Sets the skeleton physics data to use with this skeleton

Returns ResourceHandle<SkeletonPhysicsData>
set skeletonPhysicsDataHandle(value): void
Parameters
- value: SkeletonPhysicsData | ResourceHandle<SkeletonPhysicsData>
Returns void

Methods

getAncestorBoneIndices

getAncestorBoneIndices(boneIndex): number[]
Gets all bone indices that are ancestors of the specified boneIndex.
Parameters
- boneIndex: number
Returns number[]

getBoneData

getBoneData(boneIndex): SkeletonBoneData
Returns information about a bone at the provided boneIndex.
Parameters
- boneIndex: number
Returns SkeletonBoneData
Note
All transform data is calculated when accesing the bone data. It's best to hold on the data for as long as possible instead if needed for a prolonged period of time with frequent access to the bone information.

getDescendantBoneIndices

getDescendantBoneIndices(boneIndex): number[]
Gets all bone indices that are descendants of the specified boneIndex.
Parameters
- boneIndex: number
Returns number[]