RoomlePlanner.Internal.default-4

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

Hierarchy

• default<SceneEventInfo>

  ↳ default

Table of contents

Constructors

• constructor

Properties

• _creator_

Accessors

• hoveredObjectId

• isCurrentlyDrawing

• planInteractionHandler

Methods

• addComponentDragInHandler

• addConstructionPlanObjectHandlers

• addEventListener

• addFloorHandlers

• addMeasurementLineHandlers

• addNodeHandlers

• addPlanObjectHandlers

• addWallHandlers

• cancelSelection

• cancelWallDrawing

• disable

• disableAdvancedDocking

• disableEvents

• disableMeasurementLineDrawing

• disableShowChildrenOfPlanObject

• disableSnapping

• dispatchEvent

• enable

• enableAdvancedDocking

• enableConstructionEvents

• enableEvents

• enableMeasurementLineDrawing

• enableObjectEvents

• enableShowChildrenOfPlanObject

• enableSnapping

• enableWallDrawing

• endWallDrawing

• getSelectedIds

• getSelectionMode

• isDragIn

• removeEventListener

• removeSelection

• resetState

• selectPlanElement

• setCamera

• setDragIn

• setKernelZoomFactor

• setMeasurementLineLength

• setObject

• setPlanViewModel

• setSelectionMode

• setState

• showsChildrenOfPlanObject

• startDrawing

• stopDrawing

Constructors

constructor

• new default(creator, scene, camera, inputManager)

Parameters

Name	Type
creator	string
scene	Scene
camera	Camera
inputManager	default

Overrides

default.constructor

Properties

_creator_

• _creator_: string

Inherited from

default.creator

Accessors

hoveredObjectId

• get hoveredObjectId(): number

Returns

number

---

isCurrentlyDrawing

• get isCurrentlyDrawing(): boolean

Returns

boolean

---

planInteractionHandler

• get planInteractionHandler(): PlanInteractionHandler

Returns

PlanInteractionHandler

Methods

addComponentDragInHandler

▸ addComponentDragInHandler(planViewModel): void

Parameters

Name	Type
planViewModel	default

Returns

void

---

addConstructionPlanObjectHandlers

▸ addConstructionPlanObjectHandlers(planObjectViewModel, object?): void

Parameters

Name	Type
planObjectViewModel	default
object?	RoomleEventedObject3D

Returns

void

---

addEventListener

▸ addEventListener(eventName, callback, scope): void

Parameters

Name	Type
eventName	number
callback	ListenerFunction<SceneEventInfo>
scope	any

Returns

void

Inherited from

default.addEventListener

---

addFloorHandlers

▸ addFloorHandlers(planElementViewModel): void

Parameters

Name	Type
planElementViewModel	default

Returns

void

---

addMeasurementLineHandlers

▸ addMeasurementLineHandlers(planElementViewModel): void

Parameters

Name	Type
planElementViewModel	default

Returns

void

---

addNodeHandlers

▸ addNodeHandlers(planElementViewModel): void

Parameters

Name	Type
planElementViewModel	default

Returns

void

---

addPlanObjectHandlers

▸ addPlanObjectHandlers(planObjectViewModel, object?): void

Parameters

Name	Type
planObjectViewModel	default
object?	RoomleEventedObject3D

Returns

void

---

addWallHandlers

▸ addWallHandlers(planElementViewModel): void

Parameters

Name	Type
planElementViewModel	default

Returns

void

---

cancelSelection

▸ cancelSelection(reason): void

Parameters

Name	Type
reason	CancelSelectionReasons

Returns

void

---

cancelWallDrawing

▸ cancelWallDrawing(): Group<Object3DEventMap>

Returns

Group<Object3DEventMap>

---

disable

▸ disable(): void

Returns

void

---

disableAdvancedDocking

▸ disableAdvancedDocking(): void

Returns

void

---

disableEvents

▸ disableEvents(): void

Returns

void

Inherited from

default.disableEvents

---

disableMeasurementLineDrawing

▸ disableMeasurementLineDrawing(): void

Returns

void

---

disableShowChildrenOfPlanObject

▸ disableShowChildrenOfPlanObject(object): void

Parameters

Name	Type
object	KernelObject

Returns

void

---

disableSnapping

▸ disableSnapping(): void

Returns

void

---

dispatchEvent

▸ dispatchEvent(eventName, arg?): void

Parameters

Name	Type
eventName	number
arg?	SceneEventInfo

Returns

void

Inherited from

default.dispatchEvent

---

enable

▸ enable(): void

Returns

void

---

enableAdvancedDocking

▸ enableAdvancedDocking(): void

Returns

void

---

enableConstructionEvents

▸ enableConstructionEvents(enable): void

Parameters

Name	Type
enable	boolean

Returns

void

---

enableEvents

▸ enableEvents(): void

Returns

void

Inherited from

default.enableEvents

---

enableMeasurementLineDrawing

▸ enableMeasurementLineDrawing(): void

Returns

void

---

enableObjectEvents

▸ enableObjectEvents(enable): void

Parameters

Name	Type
enable	boolean

Returns

void

---

enableShowChildrenOfPlanObject

▸ enableShowChildrenOfPlanObject(object): void

Parameters

Name	Type
object	KernelObject

Returns

void

---

enableSnapping

▸ enableSnapping(): void

Returns

void

---

enableWallDrawing

▸ enableWallDrawing(): Group<Object3DEventMap>

Returns

Group<Object3DEventMap>

---

endWallDrawing

▸ endWallDrawing(event, point?): void

Parameters

Name	Type
event	InputEvent
point?	KernelVector3

Returns

void

---

getSelectedIds

▸ getSelectedIds(): number[]

Returns

number[]

---

getSelectionMode

▸ getSelectionMode(): SELECTION_MODE

Returns

SELECTION_MODE

---

isDragIn

▸ isDragIn(): boolean

Returns

boolean

Inherited from

default.isDragIn

---

removeEventListener

▸ removeEventListener(eventName, fun): void

Parameters

Name	Type
eventName	number
fun	ListenerFunction<SceneEventInfo>

Returns

void

Inherited from

default.removeEventListener

---

removeSelection

▸ removeSelection(): void

Returns

void

---

resetState

▸ resetState(): void

Returns

void

---

selectPlanElement

▸ selectPlanElement(planElement): Promise<void>

Parameters

Name	Type
planElement	default

Returns

Promise<void>

---

setCamera

▸ setCamera(camera): void

Parameters

Name	Type
camera	Camera

Returns

void

---

setDragIn

▸ setDragIn(dragIn, dragEvent?): void

Parameters

Name	Type
dragIn	boolean
dragEvent?	DragEvent

Returns

void

Inherited from

default.setDragIn

---

setKernelZoomFactor

▸ setKernelZoomFactor(kernelZoomFactor): void

Parameters

Name	Type
kernelZoomFactor	number

Returns

void

---

setMeasurementLineLength

▸ setMeasurementLineLength(measurementLine, targetLengthMM, direction): void

Parameters

Name	Type
measurementLine	default
targetLengthMM	number
direction	string

Returns

void

---

setObject

▸ setObject(object): void

Parameters

Name	Type
object	Object3D<Object3DEventMap>

Returns

void

---

setPlanViewModel

▸ setPlanViewModel(planViewModel): void

Parameters

Name	Type
planViewModel	default

Returns

void

---

setSelectionMode

▸ setSelectionMode(selectionMode): void

Parameters

Name	Type
selectionMode	SELECTION_MODE

Returns

void

---

setState

▸ setState(state): void

Parameters

Name	Type
state	PLANNER_SCENE_EVENT_STATE

Returns

void

---

showsChildrenOfPlanObject

▸ showsChildrenOfPlanObject(object): boolean

Parameters

Name	Type
object	KernelObject

Returns

boolean

---

startDrawing

▸ startDrawing(): void

Returns

void

---

stopDrawing

▸ stopDrawing(cancelDrawing?): void

Parameters

Name	Type	Default value
cancelDrawing	boolean	true

Returns

void