Documentation

planner-core/src/roomle-planner..default

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

• new default(planObject)

# Parameters

Name Type
planObject PlanObject

# Overrides

default.constructor

# Properties

# currentPoint

• currentPoint: string

# Methods

# addMesh

▸ addMesh(mesh): void

# Parameters

Name Type
mesh Object3D<Object3DEventMap>

# Returns

void

# Inherited from

default.addMesh

# clear

▸ clear(): void

# Returns

void

# Inherited from

default.clear

# clearReference

▸ clearReference(): void

# Returns

void

# Inherited from

default.clearReference

# deselect

▸ deselect(): void

# Returns

void

# Inherited from

default.deselect

# deselectAllDraggablePoints

▸ deselectAllDraggablePoints(): void

# Returns

void

# deselectPoint1Draggable

▸ deselectPoint1Draggable(): void

# Returns

void

# deselectPoint2Draggable

▸ deselectPoint2Draggable(): void

# Returns

void

# getBoundingBox

▸ getBoundingBox(): RoomleEventedMesh

# Returns

RoomleEventedMesh

# Inherited from

default.getBoundingBox

# getBounds

▸ getBounds(): Box3

# Returns

Box3

# Inherited from

default.getBounds

# getContainer

▸ getContainer(): Object3D<Object3DEventMap>

# Returns

Object3D<Object3DEventMap>

# Inherited from

default.getContainer

# getId

▸ getId(): number

# Returns

number

# Inherited from

default.getId

# getKernelObject

▸ getKernelObject(): KernelObject

# Returns

KernelObject

# Inherited from

default.getKernelObject

# getMeasurementLineDimension

▸ getMeasurementLineDimension(): MeasurementLineDimension

# Returns

MeasurementLineDimension

# getMesh

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

# Parameters

Name Type
material any

# Returns

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

# Inherited from

default.getMesh

# getObject

▸ getObject(): RoomleEventedObject3D

# Returns

RoomleEventedObject3D

# Inherited from

default.getObject

# getObjectAsync

▸ getObjectAsync(): Promise<Object3D<Object3DEventMap>>

# Returns

Promise<Object3D<Object3DEventMap>>

# Inherited from

default.getObjectAsync

# getPlanElement

▸ getPlanElement(): PlanObject

# Returns

PlanObject

# Inherited from

default.getPlanElement

# getPoint1Draggable

▸ getPoint1Draggable(): default

# Returns

default

# getPoint1DraggableBoundingBox

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

# Returns

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

# getPoint2Draggable

▸ getPoint2Draggable(): default

# Returns

default

# getPoint2DraggableBoundingBox

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

# Returns

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

# getPosition

▸ getPosition(): Vector3

# Returns

Vector3

# Inherited from

default.getPosition

# getRotation

▸ getRotation(): number

# Returns

number

# Inherited from

default.getRotation

# getSize

▸ getSize(): Vector3

# Returns

Vector3

# Inherited from

default.getSize

# handleDraggablePointsSelection

▸ handleDraggablePointsSelection(planElementViewModel): void

# Parameters

Name Type
planElementViewModel default

# Returns

void

# hide

▸ hide(): void

# Returns

void

# hideAllSubLines

▸ hideAllSubLines(): void

# Returns

void

# hideDraggableNodes

▸ hideDraggableNodes(): void

# Returns

void

# hideDraggablePointsOnDragStart

▸ hideDraggablePointsOnDragStart(planElementViewModel, point): void

# Parameters

Name Type
planElementViewModel default
point MeasurementLineDraggablePoints

# Returns

void

# hidePoint1DraggableNode

▸ hidePoint1DraggableNode(): void

# Returns

void

# hidePoint2DraggableNode

▸ hidePoint2DraggableNode(): void

# Returns

void

# hidePreviewBox

▸ hidePreviewBox(): void

# Returns

void

# Overrides

default.hidePreviewBox

# hoverOff

▸ hoverOff(): void

# Returns

void

# Inherited from

default.hoverOff

# hoverOffDragPoint1

▸ hoverOffDragPoint1(): void

# Returns

void

# hoverOffDragPoint2

▸ hoverOffDragPoint2(): void

# Returns

void

# hoverOn

▸ hoverOn(): void

# Returns

void

# Inherited from

default.hoverOn

# hoverOnDragPoint1

▸ hoverOnDragPoint1(): void

# Returns

void

# hoverOnDragPoint2

▸ hoverOnDragPoint2(): void

# Returns

void

# remove

▸ remove(): void

# Returns

void

# Inherited from

default.remove

# select

▸ select(): void

# Returns

void

# Inherited from

default.select

# selectAllDraggablePoints

▸ selectAllDraggablePoints(): void

# Returns

void

# selectPoint1Draggable

▸ selectPoint1Draggable(): void

# Returns

void

# selectPoint2Draggable

▸ selectPoint2Draggable(): void

# Returns

void

# selectPointOnDragStart

▸ selectPointOnDragStart(planElementViewModel): void

# Parameters

Name Type
planElementViewModel default

# Returns

void

# setObject

▸ setObject(object): void

# Parameters

Name Type
object RoomleEventedObject3D

# Returns

void

# Inherited from

default.setObject

# setTopView

▸ setTopView(enabled): void

# Parameters

Name Type
enabled boolean

# Returns

void

# Overrides

default.setTopView

# show

▸ show(): void

# Returns

void

# showAllSubLines

▸ showAllSubLines(): void

# Returns

void

# showDraggableNodes

▸ showDraggableNodes(): void

# Returns

void

# showDraggablePointsOnDragEnd

▸ showDraggablePointsOnDragEnd(planElementViewModel, point): void

# Parameters

Name Type
planElementViewModel default
point MeasurementLineDraggablePoints

# Returns

void

# showDraggablePointsOnHoverOff

▸ showDraggablePointsOnHoverOff(planElementViewModel): void

# Parameters

Name Type
planElementViewModel default

# Returns

void

# showDraggablePointsOnHoverOn

▸ showDraggablePointsOnHoverOn(planElementViewModel): void

# Parameters

Name Type
planElementViewModel default

# Returns

void

# showPoint1DraggableNode

▸ showPoint1DraggableNode(): void

# Returns

void

# showPoint2DraggableNode

▸ showPoint2DraggableNode(): void

# Returns

void

# toJSON

▸ toJSON(): Object

# Returns

Object

Name Type
rootElementId number

# Inherited from

default.toJSON

# update

▸ update(): void

# Returns

void

# Overrides

default.update