configurator-core/src/roomle-configurator.
# Hierarchy
-
↳
PreviewComponent
# Table of contents
# Properties
- animationValues
- boundingBox
- boundingBoxMesh
- childDockId
- childId
- geometryChanged
- hash
- isChildPlanObject
- isRootComponent
- loadingMesh
- meshes
- parentDockId
- parentId
- parentObjectId
- receivedPointAssociation
- roomlePosition
- roomleRotation
- runtimeId
- stringId
# Methods
- addMesh
- animateMeshes
- clonePreview
- computeBoundingBox
- deselect
- getKernelPosition
- getMeshById
- hoverOff
- hoverOn
- isChild
- loading
- loadingFinished
- preparePreview
- recursiveMeshes
- removeAllMeshes
- removeMesh
- removeMeshById
- replaceMeshes
- select
- startPulsating
# Properties
# animationValues
• Optional
animationValues: Map
<string
, string
>
# Inherited from
RoomleComponent.animationValues
# boundingBox
• boundingBox: Box3
# Inherited from
# boundingBoxMesh
• boundingBoxMesh: RoomleEventedMesh
# Inherited from
RoomleComponent.boundingBoxMesh
# childDockId
• childDockId: number
# childId
• childId: number
# geometryChanged
• geometryChanged: boolean
# Inherited from
RoomleComponent.geometryChanged
# hash
• hash: string
# Inherited from
# isChildPlanObject
• isChildPlanObject: boolean
# Inherited from
RoomleComponent.isChildPlanObject
# isRootComponent
• isRootComponent: boolean
# Inherited from
RoomleComponent.isRootComponent
# loadingMesh
• loadingMesh: Mesh
<BufferGeometry
<NormalBufferAttributes
>, Material
| Material
[], Object3DEventMap
>
# Inherited from
# meshes
• meshes: RoomleEventedMesh
[]
# Inherited from
# parentDockId
• parentDockId: number
# parentId
• parentId: number
# parentObjectId
• parentObjectId: number
# Inherited from
RoomleComponent.parentObjectId
# receivedPointAssociation
• receivedPointAssociation: boolean
# roomlePosition
• roomlePosition: KernelVector3
# Inherited from
RoomleComponent.roomlePosition
# roomleRotation
• roomleRotation: KernelVector3
# Inherited from
RoomleComponent.roomleRotation
# runtimeId
• runtimeId: number
# Inherited from
# stringId
• stringId: string
# Methods
# addMesh
▸ addMesh(mesh
, transform?
): void
# Parameters
Name | Type |
---|---|
mesh | Mesh <BufferGeometry <NormalBufferAttributes >, Material | Material [], Object3DEventMap > |
transform? | Float32Array |
# Returns
void
# Inherited from
# 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
# clonePreview
▸ clonePreview(numberOfDuplication
): PreviewComponent
# Parameters
Name | Type |
---|---|
numberOfDuplication | number |
# Returns
# 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
# getKernelPosition
▸ getKernelPosition(newParent
): KernelVector3
# Parameters
Name | Type |
---|---|
newParent | RoomleComponent |
# Returns
# 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
# hoverOff
▸ hoverOff(): void
# Returns
void
# Inherited from
# hoverOn
▸ hoverOn(): void
# Returns
void
# Inherited from
# isChild
▸ isChild(componentId
): boolean
# Parameters
Name | Type |
---|---|
componentId | number |
# Returns
boolean
# Inherited from
# loading
▸ loading(): void
# Returns
void
# Inherited from
# loadingFinished
▸ loadingFinished(): void
# Returns
void
# Inherited from
RoomleComponent.loadingFinished
# preparePreview
▸ preparePreview(): void
# Returns
void
# 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
# 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
# select
▸ select(): void
# Returns
void
# Inherited from
# startPulsating
▸ startPulsating(): void
# Returns
void