Skip to content

Documentation / @imvu/cal3d / Bone

Class: Bone ​

Defined in: packages/cal3d/src/Skeleton.ts:39

One bone (node) of a Skeleton.

translation/rotation place the bone relative to its parent (the bind pose); localTranslation/localRotation are the inverse bind pose — the transform from model space into this bone's space, which skinning applies before the bone's animated world transform.

Constructors ​

Constructor ​

ts
new Bone(init): Bone;

Defined in: packages/cal3d/src/Skeleton.ts:54

Parameters ​

ParameterType
initBoneInit

Returns ​

Bone

Properties ​

lightColor ​

ts
lightColor: Color;

Defined in: packages/cal3d/src/Skeleton.ts:49

Light color as RGB floats (a is unused).


lightType ​

ts
lightType: number;

Defined in: packages/cal3d/src/Skeleton.ts:47

A LightType; anything but None makes this bone a light.


localRotation ​

ts
localRotation: Quaternion;

Defined in: packages/cal3d/src/Skeleton.ts:45


localTranslation ​

ts
localTranslation: Vector3;

Defined in: packages/cal3d/src/Skeleton.ts:44


name ​

ts
name: string;

Defined in: packages/cal3d/src/Skeleton.ts:40


parentId ​

ts
parentId: number;

Defined in: packages/cal3d/src/Skeleton.ts:41


rotation ​

ts
rotation: Quaternion;

Defined in: packages/cal3d/src/Skeleton.ts:43


skeleton ​

ts
skeleton: Skeleton | null = null;

Defined in: packages/cal3d/src/Skeleton.ts:52

Internal

Set by the owning skeleton.


translation ​

ts
translation: Vector3;

Defined in: packages/cal3d/src/Skeleton.ts:42

Accessors ​

children ​

Get Signature ​

ts
get children(): Bone[];

Defined in: packages/cal3d/src/Skeleton.ts:74

Returns ​

Bone[]


id ​

Get Signature ​

ts
get id(): number;

Defined in: packages/cal3d/src/Skeleton.ts:66

This bone's index in its skeleton (what meshes and animations refer to), or -1 if detached.

Returns ​

number


isLight ​

Get Signature ​

ts
get isLight(): boolean;

Defined in: packages/cal3d/src/Skeleton.ts:83

Returns ​

boolean


isRoot ​

Get Signature ​

ts
get isRoot(): boolean;

Defined in: packages/cal3d/src/Skeleton.ts:79

Returns ​

boolean


parent ​

Get Signature ​

ts
get parent(): Bone | null;

Defined in: packages/cal3d/src/Skeleton.ts:70

Returns ​

Bone | null

Released under the MIT License.