Documentation

# Interface: PlanInteractionHandler

configurator-core/src/roomle-configurator..PlanInteractionHandler

# Table of contents

# Properties

# Methods

# Properties

# createChildrenEntities

• createChildrenEntities: ChildEntityMode

# Defined in

packages/typings/planner.ts:403 (opens new window)

# customRaster

• customRaster: number

# Defined in

packages/typings/planner.ts:395 (opens new window)

# dockWhenSnap

• dockWhenSnap: boolean

# Defined in

packages/typings/planner.ts:401 (opens new window)

# enableDrawingSnap

• enableDrawingSnap: boolean

# Defined in

packages/typings/planner.ts:398 (opens new window)

# enableRaster

• enableRaster: boolean

# Defined in

packages/typings/planner.ts:394 (opens new window)

# enableSnap

• enableSnap: boolean

# Defined in

packages/typings/planner.ts:397 (opens new window)

# objectToObjectSnapMode

• objectToObjectSnapMode: SnapMode

# Defined in

packages/typings/planner.ts:400 (opens new window)

# objectToWallSnapMode

• objectToWallSnapMode: SnapMode

# Defined in

packages/typings/planner.ts:399 (opens new window)

# unDockOnMove

• unDockOnMove: boolean

# Defined in

packages/typings/planner.ts:402 (opens new window)

# unit

• unit: string

# Defined in

packages/typings/planner.ts:393 (opens new window)

# Methods

# addMeasure

▸ addMeasure(startPosition, endPosition): PlanMeasure

# Parameters

Name Type
startPosition KernelVector3f
endPosition KernelVector3f

# Returns

PlanMeasure

# Defined in

packages/typings/planner.ts:388 (opens new window)

# addNode

▸ addNode(point): PlanNode

# Parameters

Name Type
point Object
point.x number
point.y number
point.z number

# Returns

PlanNode

# Defined in

packages/typings/planner.ts:320 (opens new window)

# addOrUpdateExternalPlanObjects

▸ addOrUpdateExternalPlanObjects(serialzedConfiguration, position, rotationInRad, findFreeSpaceInPlan): PlanObject[]

# Parameters

Name Type
serialzedConfiguration string
position KernelVector3
rotationInRad number
findFreeSpaceInPlan boolean

# Returns

PlanObject[]

# Defined in

packages/typings/planner.ts:272 (opens new window)

# addPlanObjectFromItem

▸ addPlanObjectFromItem(object, position, type, findFreeSpaceInPlan): PlanObject

# Parameters

Name Type
object KernelObject
position KernelVector3
type number
findFreeSpaceInPlan boolean

# Returns

PlanObject

# Defined in

packages/typings/planner.ts:265 (opens new window)

# addPlanObjects

▸ addPlanObjects(list, findFreeSpaceInPlan): PlanObject[]

# Parameters

Name Type
list KernelObjectPtrList
findFreeSpaceInPlan boolean

# Returns

PlanObject[]

# Defined in

packages/typings/planner.ts:260 (opens new window)

# addWall

▸ addWall(from, to): KernelWall

# Parameters

Name Type
from PlanNode
to PlanNode

# Returns

KernelWall

# Defined in

packages/typings/planner.ts:322 (opens new window)

# beginDrawing

▸ beginDrawing(point, vectorDrawMode): void

# Parameters

Name Type
point Object
point.x number
point.y number
point.z number
vectorDrawMode boolean

# Returns

void

# Defined in

packages/typings/planner.ts:311 (opens new window)

# cancelDrawing

▸ cancelDrawing(): void

# Returns

void

# Defined in

packages/typings/planner.ts:318 (opens new window)

# currentDrawingPosition

▸ currentDrawingPosition(point): void

# Parameters

Name Type
point Object
point.x number
point.y number
point.z number

# Returns

void

# Defined in

packages/typings/planner.ts:336 (opens new window)

# deactivateAllSnappingActivity

▸ deactivateAllSnappingActivity(): void

# Returns

void

# Defined in

packages/typings/planner.ts:295 (opens new window)

# duplicatePlanObject

▸ duplicatePlanObject(object, count, findFreeSpaceInPlan): PlanObject[]

# Parameters

Name Type
object PlanObject
count number
findFreeSpaceInPlan boolean

# Returns

PlanObject[]

# Defined in

packages/typings/planner.ts:239 (opens new window)

# duplicatePlanObjects

▸ duplicatePlanObjects(objects, count, findFreeSpaceInPlan): PlanObject[]

# Parameters

Name Type
objects PlanObjectList
count number
findFreeSpaceInPlan boolean

# Returns

PlanObject[]

# Defined in

packages/typings/planner.ts:245 (opens new window)

# endDrawing

▸ endDrawing(point): void

# Parameters

Name Type
point Object
point.x number
point.y number
point.z number

# Returns

void

# Defined in

packages/typings/planner.ts:316 (opens new window)

# endInteraction

▸ endInteraction(): void

# Returns

void

# Defined in

packages/typings/planner.ts:305 (opens new window)

# forceNode

▸ forceNode(point): void

# Parameters

Name Type
point Object
point.x number
point.y number
point.z number

# Returns

void

# Defined in

packages/typings/planner.ts:338 (opens new window)

# getConfiguratorKernel

▸ getConfiguratorKernel(): ConfiguratorKernelClass

# Returns

ConfiguratorKernelClass

# Defined in

packages/typings/planner.ts:229 (opens new window)

# getContinuousDrawingManager

▸ getContinuousDrawingManager(): ContinuousDrawingManager

# Returns

ContinuousDrawingManager

# Defined in

packages/typings/planner.ts:356 (opens new window)

# getPlan

▸ getPlan(): Plan

# Returns

Plan

# Defined in

packages/typings/planner.ts:233 (opens new window)

# groupObjects

▸ groupObjects(planObjectPtrList): ObjectGroupPtr

# Parameters

Name Type
planObjectPtrList PlanObjectList

# Returns

ObjectGroupPtr

# Defined in

packages/typings/planner.ts:281 (opens new window)

# init

▸ init(reference, zoomFactor, viewSnapDist, wallSnapMode, objectSnapMode, shouldSnap, drawingType): PlanInteractionHandler

# Parameters

Name Type
reference PlanInteractionHandler
zoomFactor number
viewSnapDist number
wallSnapMode any
objectSnapMode any
shouldSnap boolean
drawingType any

# Returns

PlanInteractionHandler

# Defined in

packages/typings/planner.ts:219 (opens new window)

# isRedoPossible

▸ isRedoPossible(): boolean

# Returns

boolean

# Defined in

packages/typings/planner.ts:301 (opens new window)

# isUndoPossible

▸ isUndoPossible(): boolean

# Returns

boolean

# Defined in

packages/typings/planner.ts:299 (opens new window)

# loadPlanXML

▸ loadPlanXML(xml): Plan

# Parameters

Name Type
xml string

# Returns

Plan

# Defined in

packages/typings/planner.ts:231 (opens new window)

# moveElementBy

▸ moveElementBy(planObject, distance): void

# Parameters

Name Type
planObject KernelObject
distance KernelVector3

# Returns

void

# Defined in

packages/typings/planner.ts:237 (opens new window)

# moveElementTo

▸ moveElementTo(planObject, point): void

# Parameters

Name Type
planObject KernelObject
point KernelVector3

# Returns

void

# Defined in

packages/typings/planner.ts:235 (opens new window)

# moveObjectsBy

▸ moveObjectsBy(planObjects, distance): void

# Parameters

Name Type
planObjects KernelObjectPtrList
distance KernelVector3

# Returns

void

# Defined in

packages/typings/planner.ts:251 (opens new window)

# reactivateAllSnappingActivity

▸ reactivateAllSnappingActivity(): void

# Returns

void

# Defined in

packages/typings/planner.ts:297 (opens new window)

# redo

▸ redo(): void

# Returns

void

# Defined in

packages/typings/planner.ts:309 (opens new window)

# removeElement

▸ removeElement(planObject): void

# Parameters

Name Type
planObject KernelObject

# Returns

void

# Defined in

packages/typings/planner.ts:279 (opens new window)

# rotateGroupBy

▸ rotateGroupBy(group, anAngleInRad, aroundPoint): void

# Parameters

Name Type
group ObjectGroupPtr
anAngleInRad number
aroundPoint KernelVector3

# Returns

void

# Defined in

packages/typings/planner.ts:289 (opens new window)

# rotateObjectTo

▸ rotateObjectTo(planObject, angleInRad): void

# Parameters

Name Type
planObject KernelObject
angleInRad number

# Returns

void

# Defined in

packages/typings/planner.ts:256 (opens new window)

# rotateObjectsBy

▸ rotateObjectsBy(planObjectPtrList, anAngleInRad, aroundPoint): void

# Parameters

Name Type
planObjectPtrList PlanObjectList
anAngleInRad number
aroundPoint KernelVector3

# Returns

void

# Defined in

packages/typings/planner.ts:283 (opens new window)

# setDefaultParapetHeight

▸ setDefaultParapetHeight(parapetHeight, applyToAll): void

# Parameters

Name Type
parapetHeight number
applyToAll boolean

# Returns

void

# Defined in

packages/typings/planner.ts:350 (opens new window)

# setDefaultWallHeight

▸ setDefaultWallHeight(wallHeight, applyToAll): void

# Parameters

Name Type
wallHeight number
applyToAll boolean

# Returns

void

# Defined in

packages/typings/planner.ts:348 (opens new window)

# setDefaultWallThickness

▸ setDefaultWallThickness(wallThickness, applyToAll): void

# Parameters

Name Type
wallThickness number
applyToAll boolean

# Returns

void

# Defined in

packages/typings/planner.ts:346 (opens new window)

# setDrawingType

▸ setDrawingType(aNewDrawingType): void

# Parameters

Name Type
aNewDrawingType DrawingType

# Returns

void

# Defined in

packages/typings/planner.ts:340 (opens new window)

# setFloorMaterial

▸ setFloorMaterial(floor, material): void

# Parameters

Name Type
floor KernelFloor
material KernelFloorMaterial

# Returns

void

# Defined in

packages/typings/planner.ts:355 (opens new window)

# setLengthOfWall

▸ setLengthOfWall(wall, length, preferredSide, direction, moveOrthogonalWalls): void

# Parameters

Name Type
wall KernelWall
length number
preferredSide WallSide
direction EMSConstant
moveOrthogonalWalls boolean

# Returns

void

# Defined in

packages/typings/planner.ts:326 (opens new window)

# setMeasurePoint1

▸ setMeasurePoint1(measure, point, snapToWalls, snapToObjects): void

# Parameters

Name Type
measure PlanMeasure
point KernelVector3f
snapToWalls boolean
snapToObjects boolean

# Returns

void

# Defined in

packages/typings/planner.ts:374 (opens new window)

# setMeasurePoint2

▸ setMeasurePoint2(measure, point, snapToWalls, snapToObjects): void

# Parameters

Name Type
measure PlanMeasure
point KernelVector3f
snapToWalls boolean
snapToObjects boolean

# Returns

void

# Defined in

packages/typings/planner.ts:381 (opens new window)

# setObjectCustomColor

▸ setObjectCustomColor(anObject, aCustomColor): void

# Parameters

Name Type
anObject KernelObject
aCustomColor number

# Returns

void

# Defined in

packages/typings/planner.ts:370 (opens new window)

# setObjectFixedZ

▸ setObjectFixedZ(anObject, shouldFlipZ): void

# Parameters

Name Type
anObject KernelObject
shouldFlipZ boolean

# Returns

void

# Defined in

packages/typings/planner.ts:372 (opens new window)

# setObjectFlipX

▸ setObjectFlipX(anObject, shouldFlipX): void

# Parameters

Name Type
anObject KernelObject
shouldFlipX boolean

# Returns

void

# Defined in

packages/typings/planner.ts:366 (opens new window)

# setObjectFlipY

▸ setObjectFlipY(anObject, shouldFlipY): void

# Parameters

Name Type
anObject KernelObject
shouldFlipY boolean

# Returns

void

# Defined in

packages/typings/planner.ts:368 (opens new window)

# setObjectRotation

▸ setObjectRotation(planObject, angleInRad): void

# Parameters

Name Type
planObject KernelObject
angleInRad number

# Returns

void

# Defined in

packages/typings/planner.ts:258 (opens new window)

# setObjectSize

▸ setObjectSize(anObject, aNewSize, anAnchor): void

# Parameters

Name Type
anObject KernelObject
aNewSize KernelVector3
anAnchor Anchor

# Returns

void

# Defined in

packages/typings/planner.ts:360 (opens new window)

# setSnapFeedbackWhileDrawing

▸ setSnapFeedbackWhileDrawing(enabled): void

# Parameters

Name Type
enabled boolean

# Returns

void

# Defined in

packages/typings/planner.ts:358 (opens new window)

# setViewSnapDist

▸ setViewSnapDist(aDist): void

# Parameters

Name Type
aDist number

# Returns

void

# Defined in

packages/typings/planner.ts:344 (opens new window)

# setWallHeight

▸ setWallHeight(wall, height): void

# Parameters

Name Type
wall KernelWall
height number

# Returns

void

# Defined in

packages/typings/planner.ts:324 (opens new window)

# setWallLeftMaterial

▸ setWallLeftMaterial(wall, material): void

# Parameters

Name Type
wall KernelWall
material KernelWallMaterial

# Returns

void

# Defined in

packages/typings/planner.ts:352 (opens new window)

# setWallRightMaterial

▸ setWallRightMaterial(wall, material): void

# Parameters

Name Type
wall KernelWall
material KernelWallMaterial

# Returns

void

# Defined in

packages/typings/planner.ts:354 (opens new window)

# setWallThickness

▸ setWallThickness(wall, thickness): void

# Parameters

Name Type
wall KernelWall
thickness number

# Returns

void

# Defined in

packages/typings/planner.ts:334 (opens new window)

# setZoomFactor

▸ setZoomFactor(pxPerMM): void

# Parameters

Name Type
pxPerMM number

# Returns

void

# Defined in

packages/typings/planner.ts:342 (opens new window)

# startInteraction

▸ startInteraction(): void

# Returns

void

# Defined in

packages/typings/planner.ts:303 (opens new window)

# undo

▸ undo(): void

# Returns

void

# Defined in

packages/typings/planner.ts:307 (opens new window)