Documentation / @imvu/cal3d / Material

Class: Material

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

A Cal3D material (.crf binary / .xrf XML): base colors and texture maps. A mesh's submeshes refer to materials by index (their materialId).

IMVU's renderer only uses the texture maps — it reads and discards the colors and shininess — but they are kept here as written.

Constructors

Constructor

new Material(init?): Material;

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

Parameters

Parameter	Type
init?	MaterialInit

Returns

Material

Properties

ambient

ambient: Color;

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

Ambient color, bytes 0–255.

---

diffuse

diffuse: Color;

Defined in: packages/cal3d/src/Material.ts:46

Diffuse color, bytes 0–255.

---

maps

readonly maps: TextureMap[];

Defined in: packages/cal3d/src/Material.ts:50

---

shininess

shininess: number;

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

---

specular

specular: Color;

Defined in: packages/cal3d/src/Material.ts:48

Specular color, bytes 0–255.

---

version

version: number | undefined;

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

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

Accessors

diffuseMap

Get Signature

get diffuseMap(): TextureMap | undefined;

Defined in: packages/cal3d/src/Material.ts:77

The diffuse texture, if any.

Returns

TextureMap | undefined

---

opacityMap

Get Signature

get opacityMap(): TextureMap | undefined;

Defined in: packages/cal3d/src/Material.ts:82

The opacity (alpha mask) texture, if any.

Returns

TextureMap | undefined

Methods

getMap()

getMap(type): TextureMap | undefined;

Defined in: packages/cal3d/src/Material.ts:71

The first map of a type (case-insensitive), e.g. getMap('Opacity').

Parameters

Parameter	Type
type	string

Returns

TextureMap | undefined

---

toBinary()

toBinary(): Uint8Array;

Defined in: packages/cal3d/src/Material.ts:86

Returns

Uint8Array

---

toXml()

toXml(): string;

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

Returns

string

---

parse()

static parse(input, options?): Material;

Defined in: packages/cal3d/src/Material.ts:63

Parse a binary or XML material file.

Parameters

Parameter	Type
input	Cal3DInput
options?	ParseOptions

Returns

Material