Documentation / @imvu/cal3d / Skeleton

Class: Skeleton

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

A Cal3D skeleton (.csf binary / .xsf XML): a flat list of bones linked by parent index.

Constructors

Constructor

new Skeleton(init?): Skeleton;

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

Parameters

Parameter	Type
init?	SkeletonInit

Returns

Skeleton

Properties

bones

readonly bones: Bone[] = [];

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

---

sceneAmbientColor

sceneAmbientColor: Color;

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

Scene ambient light as RGB floats (a is unused). IMVU rooms set it; avatars leave it black.

---

version

version: number | undefined;

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

The version of the file this was parsed from (undefined for skeletons built in code).

Accessors

lights

Get Signature

get lights(): Bone[];

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

Bones that act as scene lights.

Returns

Bone[]

---

roots

Get Signature

get roots(): Bone[];

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

Bones without a parent.

Returns

Bone[]

Methods

addBone()

addBone(bone): Bone;

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

Append a bone (its id becomes the next index) and return it.

Parameters

Parameter	Type
bone	Bone

Returns

Bone

---

getBone()

getBone(idOrName): Bone | undefined;

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

Parameters

Parameter	Type
idOrName	string | number

Returns

Bone | undefined

---

toBinary()

toBinary(): Uint8Array;

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

Returns

Uint8Array

---

toXml()

toXml(): string;

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

Returns

string

---

walk()

walk(): Generator<{
  bone: Bone;
  depth: number;
}>;

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

Depth-first walk from the roots, parents before children.

Returns

Generator<{ bone: Bone; depth: number; }>

---

parse()

static parse(input, options?): Skeleton;

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

Parse a binary or XML skeleton file.

Parameters

Parameter	Type
input	Cal3DInput
options?	ParseOptions

Returns

Skeleton