Class SkeletonBoneData

Contains information about a single bone in a Skeleton.

Index

Constructors

Properties

_index _inverseBindPose _localTransform _name _parent _worldTransform

Accessors

index inverseBindPose localTransform name parent worldTransform

Methods

assign clone isEqual isEqual

Constructors

constructor

new SkeletonBoneData(index?, name?, parent?, localTransform?, worldTransform?, inverseBindPose?): SkeletonBoneData
Parameters
- Optionalindex: number
- Optionalname: string
- Optionalparent: number
- OptionallocalTransform: Immutable<Transform>
- OptionalworldTransform: Immutable<Transform>
- OptionalinverseBindPose: Immutable<Matrix4>
Returns SkeletonBoneData

Properties

`Protected`_index

_index: number

`Protected`_inverseBindPose

_inverseBindPose: Matrix4

`Protected`_localTransform

_localTransform: Transform

`Protected`_name

_name: string

`Protected`_parent

_parent: number

`Protected`_worldTransform

_worldTransform: Transform

Accessors

index

get index(): number
The index of the bone.

Returns number
set index(value): void
Parameters
- value: number
Returns void

inverseBindPose

get inverseBindPose(): Matrix4
Inverse transform of the pose the skeleton was initially created in.

Returns Matrix4
set inverseBindPose(value): void
Parameters
- value: Immutable<Matrix4>
Returns void

localTransform

get localTransform(): Transform
Local transform of the bone.

Returns Transform
set localTransform(value): void
Parameters
- value: Immutable<Transform>
Returns void

name

get name(): string
Unique name of the bone.

Returns string
set name(value): void
Parameters
- value: string
Returns void

parent

get parent(): number
Index of the parent bone (within the relevant Skeleton object). -1 if root bone.

Returns number
set parent(value): void
Parameters
- value: number
Returns void

worldTransform

get worldTransform(): Transform
World transform of the bone.

Returns Transform
set worldTransform(value): void
Parameters
- value: Immutable<Transform>
Returns void

Methods

assign

assign(other): SkeletonBoneData
Copies all properties defined by the prototype of SkeletonBoneData from other to this instance.
Parameters
- other: Immutable<SkeletonBoneData>
Returns SkeletonBoneData

clone

clone(): SkeletonBoneData
Clones this instance and returns a new SkeletonBoneData with identical values.

Returns SkeletonBoneData

isEqual

isEqual(this, other): boolean
Determines if this SkeletonBoneData instance is equal to the other instance.
Parameters
- this: Immutable<SkeletonBoneData>
- other: Immutable<SkeletonBoneData>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both SkeletonBoneData instances are equal.
Parameters
- lhs: Immutable<SkeletonBoneData>
- rhs: Immutable<SkeletonBoneData>
Returns boolean