Documentation

configurator-core/src/roomle-configurator..StaticComponent

# Hierarchy

# Table of contents

# Properties

# Methods

# Properties

# animationValues

• Optional animationValues: Map<string, string>

# Inherited from

RoomleComponent.animationValues

# boundingBox

• boundingBox: Box3

# Inherited from

RoomleComponent.boundingBox

# boundingBoxMesh

• boundingBoxMesh: RoomleEventedMesh

# Inherited from

RoomleComponent.boundingBoxMesh

# geometryChanged

• geometryChanged: boolean

# Inherited from

RoomleComponent.geometryChanged

# glbUrl

• glbUrl: string

# hash

• hash: string

# Inherited from

RoomleComponent.hash

# isChildPlanObject

• isChildPlanObject: boolean

# Inherited from

RoomleComponent.isChildPlanObject

# isRootComponent

• isRootComponent: boolean

# Inherited from

RoomleComponent.isRootComponent

# loadingMesh

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

# Inherited from

RoomleComponent.loadingMesh

# meshes

• meshes: RoomleEventedMesh[]

# Inherited from

RoomleComponent.meshes

# parentObjectId

• parentObjectId: number

# Inherited from

RoomleComponent.parentObjectId

# roomlePosition

• roomlePosition: KernelVector3

# Inherited from

RoomleComponent.roomlePosition

# roomleRotation

• roomleRotation: KernelVector3

# Inherited from

RoomleComponent.roomleRotation

# runtimeId

• runtimeId: number

# Inherited from

RoomleComponent.runtimeId

# Methods

# addMesh

▸ addMesh(mesh, transform?): void

# Parameters

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

# Returns

void

# Inherited from

RoomleComponent.addMesh

# animateMeshes

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

# Parameters

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

# Returns

void

# Inherited from

RoomleComponent.animateMeshes

# computeBoundingBox

▸ computeBoundingBox(boxForMeasurements?, useMeshes?): void

# Parameters

Name Type
boxForMeasurements? KernelCube
useMeshes? boolean

# Returns

void

# Inherited from

RoomleComponent.computeBoundingBox

# deselect

▸ deselect(): void

# Returns

void

# Inherited from

RoomleComponent.deselect

# getKernelPosition

▸ getKernelPosition(newParent): KernelVector3

# Parameters

Name Type
newParent RoomleComponent

# Returns

KernelVector3

# Inherited from

RoomleComponent.getKernelPosition

# getMeshById

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

# Parameters

Name Type
meshId number

# Returns

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

# Inherited from

RoomleComponent.getMeshById

# hoverOff

▸ hoverOff(): void

# Returns

void

# Inherited from

RoomleComponent.hoverOff

# hoverOn

▸ hoverOn(): void

# Returns

void

# Inherited from

RoomleComponent.hoverOn

# isChild

▸ isChild(componentId): boolean

# Parameters

Name Type
componentId number

# Returns

boolean

# Inherited from

RoomleComponent.isChild

# loading

▸ loading(): void

# Returns

void

# Inherited from

RoomleComponent.loading

# loadingFinished

▸ loadingFinished(): void

# Returns

void

# Inherited from

RoomleComponent.loadingFinished

# recursiveMeshes

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

# Returns

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

# Inherited from

RoomleComponent.recursiveMeshes

# removeAllMeshes

▸ removeAllMeshes(): void

# Returns

void

# Inherited from

RoomleComponent.removeAllMeshes

# removeMesh

▸ removeMesh(mesh): void

# Parameters

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

# Returns

void

# Inherited from

RoomleComponent.removeMesh

# removeMeshById

▸ removeMeshById(meshId): void

# Parameters

Name Type
meshId number

# Returns

void

# Inherited from

RoomleComponent.removeMeshById

# replaceMeshes

▸ replaceMeshes(meshes): void

# Parameters

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

# Returns

void

# Inherited from

RoomleComponent.replaceMeshes

# select

▸ select(): void

# Returns

void

# Inherited from

RoomleComponent.select