Documentation

configurator-core/src/roomle-configurator..PreviewLineComponent

# Hierarchy

# Table of contents

# Properties

# Methods

# Properties

# animationValues

• Optional animationValues: Map<string, string>

# Inherited from

PreviewComponent.animationValues

# boundingBox

• boundingBox: Box3

# Inherited from

PreviewComponent.boundingBox

# boundingBoxMesh

• boundingBoxMesh: RoomleEventedMesh

# Inherited from

PreviewComponent.boundingBoxMesh

# boundingLineMesh

• boundingLineMesh: RoomleEventedMesh

# childDockId

• childDockId: number

# Inherited from

PreviewComponent.childDockId

# childId

• childId: number

# Inherited from

PreviewComponent.childId

# docklineRotation

• docklineRotation: Euler

# geometryChanged

• geometryChanged: boolean

# Inherited from

PreviewComponent.geometryChanged

# hash

• hash: string

# Inherited from

PreviewComponent.hash

# isChildPlanObject

• isChildPlanObject: boolean

# Inherited from

PreviewComponent.isChildPlanObject

# isRootComponent

• isRootComponent: boolean

# Inherited from

PreviewComponent.isRootComponent

# lineFrom

• lineFrom: Vector3

# lineMesh

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

# lineSegments

• lineSegments: PreviewLineSegment[]

# lineTo

• lineTo: Vector3

# loadingMesh

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

# Inherited from

PreviewComponent.loadingMesh

# meshes

• meshes: RoomleEventedMesh[]

# Inherited from

PreviewComponent.meshes

# parentDockId

• parentDockId: number

# Inherited from

PreviewComponent.parentDockId

# parentId

• parentId: number

# Inherited from

PreviewComponent.parentId

# parentObjectId

• parentObjectId: number

# Inherited from

PreviewComponent.parentObjectId

# positionFrom

• positionFrom: Vector3

# positionTo

• positionTo: Vector3

# receivedPointAssociation

• receivedPointAssociation: boolean

# Inherited from

PreviewComponent.receivedPointAssociation

# roomleLineFrom

• roomleLineFrom: KernelVector3

# roomleLineTo

• roomleLineTo: KernelVector3

# roomlePosition

• roomlePosition: KernelVector3

# Inherited from

PreviewComponent.roomlePosition

# roomlePositionFrom

• roomlePositionFrom: KernelVector3

# roomlePositionTo

• roomlePositionTo: KernelVector3

# roomleRotation

• roomleRotation: KernelVector3

# Inherited from

PreviewComponent.roomleRotation

# runtimeId

• runtimeId: number

# Inherited from

PreviewComponent.runtimeId

# stringId

• stringId: string

# Inherited from

PreviewComponent.stringId

# Methods

# addMesh

▸ addMesh(mesh, transform?): void

# Parameters

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

# Returns

void

# Inherited from

PreviewComponent.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

PreviewComponent.animateMeshes

# clonePreview

▸ clonePreview(numberOfDuplication): PreviewComponent

# Parameters

Name Type
numberOfDuplication number

# Returns

PreviewComponent

# Inherited from

PreviewComponent.clonePreview

# clonePreviewLine

▸ clonePreviewLine(numberOfDuplication): PreviewLineComponent

# Parameters

Name Type
numberOfDuplication number

# Returns

PreviewLineComponent

# computeBoundingBox

▸ computeBoundingBox(boxForMeasurements?, useMeshes?): void

# Parameters

Name Type
boxForMeasurements? KernelCube
useMeshes? boolean

# Returns

void

# Inherited from

PreviewComponent.computeBoundingBox

# deselect

▸ deselect(): void

# Returns

void

# Inherited from

PreviewComponent.deselect

# getKernelPosition

▸ getKernelPosition(newParent): KernelVector3

# Parameters

Name Type
newParent RoomleComponent

# Returns

KernelVector3

# Inherited from

PreviewComponent.getKernelPosition

# getMeshById

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

# Parameters

Name Type
meshId number

# Returns

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

# Inherited from

PreviewComponent.getMeshById

# getPositionForIntersectionPoint

▸ getPositionForIntersectionPoint(intersectionPoint): Vector3

# Parameters

Name Type
intersectionPoint Vector3

# Returns

Vector3

# hideSelectionLine

▸ hideSelectionLine(): void

# Returns

void

# hoverOff

▸ hoverOff(): void

# Returns

void

# Inherited from

PreviewComponent.hoverOff

# hoverOn

▸ hoverOn(): void

# Returns

void

# Inherited from

PreviewComponent.hoverOn

# isChild

▸ isChild(componentId): boolean

# Parameters

Name Type
componentId number

# Returns

boolean

# Inherited from

PreviewComponent.isChild

# loading

▸ loading(): void

# Returns

void

# Inherited from

PreviewComponent.loading

# loadingFinished

▸ loadingFinished(): void

# Returns

void

# Inherited from

PreviewComponent.loadingFinished

# preparePreview

▸ preparePreview(): void

# Returns

void

# Inherited from

PreviewComponent.preparePreview

# recursiveMeshes

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

# Returns

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

# Inherited from

PreviewComponent.recursiveMeshes

# removeAllMeshes

▸ removeAllMeshes(): void

# Returns

void

# Inherited from

PreviewComponent.removeAllMeshes

# removeMesh

▸ removeMesh(mesh): void

# Parameters

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

# Returns

void

# Inherited from

PreviewComponent.removeMesh

# removeMeshById

▸ removeMeshById(meshId): void

# Parameters

Name Type
meshId number

# Returns

void

# Inherited from

PreviewComponent.removeMeshById

# replaceMeshes

▸ replaceMeshes(meshes): void

# Parameters

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

# Returns

void

# Inherited from

PreviewComponent.replaceMeshes

# select

▸ select(): void

# Returns

void

# Inherited from

PreviewComponent.select

# startPulsating

▸ startPulsating(): void

# Returns

void

# Inherited from

PreviewComponent.startPulsating

# updatePreviewPosition

▸ updatePreviewPosition(intersectionPoint): void

# Parameters

Name Type
intersectionPoint Vector3

# Returns

void