Documentation

configurator-core/src/roomle-configurator..RoomleComponent

# Hierarchy

RoomleEventedObject3D

↳ RoomleComponent

↳↳ PreviewComponent

↳↳ StaticComponent

# Table of contents

# Properties

# Methods

# Properties

# animationValues

• Optional animationValues: Map<string, string>

# boundingBox

• boundingBox: Box3

# boundingBoxMesh

• boundingBoxMesh: RoomleEventedMesh

# geometryChanged

• geometryChanged: boolean

# hash

• hash: string

# isChildPlanObject

• isChildPlanObject: boolean

# isRootComponent

• isRootComponent: boolean

# loadingMesh

• loadingMesh: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

# meshes

• meshes: RoomleEventedMesh[]

# parentObjectId

• parentObjectId: number

# roomlePosition

• roomlePosition: KernelVector3

# roomleRotation

• roomleRotation: KernelVector3

# runtimeId

• runtimeId: number

# Methods

# addMesh

▸ addMesh(mesh, transform?): void

# Parameters

Name	Type
`mesh`	`Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` \| `Material`[], `Object3DEventMap`>
`transform?`	`Float32Array`

# Returns

void

# animateMeshes

▸ animateMeshes(aniamtion, from, to, animate, onProgressUpdate?): void

# Parameters

Name	Type
`aniamtion`	`string`
`from`	`string`
`to`	`string`
`animate`	`boolean`
`onProgressUpdate?`	() => `void`

# Returns

void

# computeBoundingBox

▸ computeBoundingBox(boxForMeasurements?, useMeshes?): void

# Parameters

Name	Type
`boxForMeasurements?`	`KernelCube`
`useMeshes?`	`boolean`

# Returns

void

# deselect

▸ deselect(): void

# Returns

void

# getKernelPosition

▸ getKernelPosition(newParent): KernelVector3

# Parameters

Name	Type
`newParent`	`RoomleComponent`

# Returns

KernelVector3

# getMeshById

▸ getMeshById(meshId): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

# Parameters

Name	Type
`meshId`	`number`

# Returns

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

# hoverOff

▸ hoverOff(): void

# Returns

void

# hoverOn

▸ hoverOn(): void

# Returns

void

# isChild

▸ isChild(componentId): boolean

# Parameters

Name	Type
`componentId`	`number`

# Returns

boolean

# loading

▸ loading(): void

# Returns

void

# loadingFinished

▸ loadingFinished(): void

# Returns

void

# recursiveMeshes

▸ recursiveMeshes(): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]

# Returns

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

# removeAllMeshes

▸ removeAllMeshes(): void

# Returns

void

# removeMesh

▸ removeMesh(mesh): void

# Parameters

Name	Type
`mesh`	`Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` \| `Material`[], `Object3DEventMap`>

# Returns

void

# removeMeshById

▸ removeMeshById(meshId): void

# Parameters

Name	Type
`meshId`	`number`

# Returns

void

# replaceMeshes

▸ replaceMeshes(meshes): void

# Parameters

Name	Type
`meshes`	`Mesh`<`BufferGeometry`<`NormalBufferAttributes`>, `Material` \| `Material`[], `Object3DEventMap`>[]

# Returns

void

# select

▸ select(): void

# Returns

void