Skip to content

Documentation / @imvu/cal3d / Mesh

Class: Mesh ​

Defined in: packages/cal3d/src/Mesh.ts:191

A Cal3D mesh (.cmf binary / .xmf XML): one or more submeshes, each with its own material slot, vertices skinned to a skeleton's bones, and optional morph targets.

Constructors ​

Constructor ​

ts
new Mesh(submeshes?): Mesh;

Defined in: packages/cal3d/src/Mesh.ts:196

Parameters ​

ParameterTypeDefault value
submeshes?Submesh[][]

Returns ​

Mesh

Properties ​

submeshes ​

ts
readonly submeshes: Submesh[];

Defined in: packages/cal3d/src/Mesh.ts:192


version ​

ts
version: number | undefined;

Defined in: packages/cal3d/src/Mesh.ts:194

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

Accessors ​

faceCount ​

Get Signature ​

ts
get faceCount(): number;

Defined in: packages/cal3d/src/Mesh.ts:215

Returns ​

number


morphNames ​

Get Signature ​

ts
get morphNames(): string[];

Defined in: packages/cal3d/src/Mesh.ts:220

Names of all morph targets across submeshes.

Returns ​

string[]


vertexCount ​

Get Signature ​

ts
get vertexCount(): number;

Defined in: packages/cal3d/src/Mesh.ts:211

Returns ​

number

Methods ​

toBinary() ​

ts
toBinary(): Uint8Array;

Defined in: packages/cal3d/src/Mesh.ts:224

Returns ​

Uint8Array


toXml() ​

ts
toXml(): string;

Defined in: packages/cal3d/src/Mesh.ts:230

Returns ​

string


parse() ​

ts
static parse(input, options?): Mesh;

Defined in: packages/cal3d/src/Mesh.ts:204

Parse a binary or XML mesh file. An XML file holding only a <HEADER/> is an empty mesh — IMVU creators use that to remove a mesh inherited from a parent product.

Parameters ​

ParameterType
inputCal3DInput
options?ParseOptions

Returns ​

Mesh

Released under the MIT License.