Documentation

configurator-core/src/roomle-configurator..default

# Hierarchy

default

↳ default

# Table of contents

# Constructors

constructor

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new default(creator)

# Parameters

Name	Type
`creator`	`string`

# Overrides

default.constructor

# Properties

# _creator_

• _creator_: string

# Inherited from

default.creator

# materialQueue

• materialQueue: PromiseQueue<void>

# Inherited from

default.materialQueue

# Accessors

# maxAnisotropy

• get maxAnisotropy(): number

# Returns

number

# Inherited from

MeshGenerator.maxAnisotropy

• set maxAnisotropy(maxAnisotropy): void

# Parameters

Name	Type
`maxAnisotropy`	`number`

# Returns

void

# Inherited from

MeshGenerator.maxAnisotropy

# maxTextures

• get maxTextures(): number

# Returns

number

# Inherited from

MeshGenerator.maxTextures

• set maxTextures(maxTextures): void

# Parameters

Name	Type
`maxTextures`	`number`

# Returns

void

# Inherited from

MeshGenerator.maxTextures

# Methods

# changeMaterialOfMesh

▸ changeMaterialOfMesh(mesh, material, materialAttributes?): void

# Parameters

Name	Type
`mesh`	`Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` \| `Material`[], `Object3DEventMap`>
`material`	`Material`
`materialAttributes?`	`Record`<`string`, `string`>

# Returns

void

# Inherited from

default.changeMaterialOfMesh

# clear

▸ clear(): void

# Returns

void

# Inherited from

default.clear

# generateMesh

▸ generateMesh(runtimeComponentId?, geometryId?, materialId, vertices, indices, uvCoords, normals, newGeometryInstance?, materialAttributes?): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

# Parameters

Name	Type	Default value
`runtimeComponentId`	`number`	`0`
`geometryId`	`string`	`null`
`materialId`	`string`	`undefined`
`vertices`	`Float32Array`	`undefined`
`indices`	`Int32Array`	`undefined`
`uvCoords`	`Float32Array`	`undefined`
`normals`	`Float32Array`	`undefined`
`newGeometryInstance`	`boolean`	`false`
`materialAttributes?`	`Record`<`string`, `string`>	`undefined`

# Returns

Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

# getGeometry

▸ getGeometry(meshId): BufferGeometry<NormalBufferAttributes>

# Parameters

Name	Type
`meshId`	`string`

# Returns

BufferGeometry<NormalBufferAttributes>

# Inherited from

default.getGeometry

# loadMaterial

▸ loadMaterial(materialId, width?, height?): Promise<Material>

# Parameters

Name	Type
`materialId`	`string`
`width?`	`number`
`height?`	`number`

# Returns

Promise<Material>

# loadTextures

▸ loadTextures(rapiMaterial, material, width?, height?): Promise<void>

# Parameters

Name	Type
`rapiMaterial`	`RapiMaterial`
`material`	`MeshPhysicalMaterial`
`width?`	`number`
`height?`	`number`

# Returns

Promise<void>

# removeMaterialLoadedListener

▸ removeMaterialLoadedListener(): void

# Returns

void

# Inherited from

default.removeMaterialLoadedListener

# setMaterial

▸ setMaterial(mesh, materialId, _type?, materialAttributes?): Promise<void>

# Parameters

Name	Type
`mesh`	`Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` \| `Material`[], `Object3DEventMap`>
`materialId`	`string`
`_type?`	`KernelEnum`
`materialAttributes?`	`Record`<`string`, `string`>

# Returns

Promise<void>

# setMaterialLoadedListener

▸ setMaterialLoadedListener(fun): void

# Parameters

Name	Type
`fun`	() => `void`

# Returns

void

# Inherited from

default.setMaterialLoadedListener