Documentation

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

# Table of contents

# Properties

# Methods

# Properties

# customRaster

• customRaster: number

# dockWhenSnap

• dockWhenSnap: boolean

# enableDrawingSnap

• enableDrawingSnap: boolean

# enableRaster

• enableRaster: boolean

# enableSnap

• enableSnap: boolean

# objectToObjectSnapMode

• objectToObjectSnapMode: SnapMode

# objectToWallSnapMode

• objectToWallSnapMode: SnapMode

# showChildrenOfPlanObjects

• showChildrenOfPlanObjects: ChildEntityMode

# unDockOnMove

• unDockOnMove: boolean

# unit

• unit: string

# Methods

# addMeasure

▸ addMeasure(startPosition, endPosition): PlanMeasure

# Parameters

Name	Type
`startPosition`	`KernelVector3f`
`endPosition`	`KernelVector3f`

# Returns

PlanMeasure

# addNode

▸ addNode(point): PlanNode

# Parameters

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

# Returns

PlanNode

# addOrUpdateExternalPlanObjects

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

# Parameters

Name	Type
`serialzedConfiguration`	`string`
`position`	`KernelVector3`
`rotationInRad`	`number`
`findFreeSpaceInPlan`	`boolean`

# Returns

PlanObject[]

# addPlanObjectFromItem

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

# Parameters

Name	Type
`object`	`KernelObject`
`position`	`KernelVector3`
`type`	`number`
`findFreeSpaceInPlan`	`boolean`

# Returns

PlanObject

# addPlanObjects

▸ addPlanObjects(list, findFreeSpaceInPlan): PlanObject[]

# Parameters

Name	Type
`list`	`KernelObjectPtrList`
`findFreeSpaceInPlan`	`boolean`

# Returns

PlanObject[]

# addWall

▸ addWall(from, to): KernelWall

# Parameters

Name	Type
`from`	`PlanNode`
`to`	`PlanNode`

# Returns

KernelWall

# beginDrawing

▸ beginDrawing(point, vectorPreviewMode): void

# Parameters

Name	Type
`point`	`Object`
`point.x`	`number`
`point.y`	`number`
`point.z`	`number`
`vectorPreviewMode`	`boolean`

# Returns

void

# cancelDrawing

▸ cancelDrawing(): void

# Returns

void

# currentDrawingPosition

▸ currentDrawingPosition(point): void

# Parameters

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

# Returns

void

# deactivateAllSnappingActivity

▸ deactivateAllSnappingActivity(): void

# Returns

void

# duplicatePlanObject

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

# Parameters

Name	Type
`object`	`PlanObject`
`count`	`number`
`findFreeSpaceInPlan`	`boolean`

# Returns

PlanObject[]

# duplicatePlanObjects

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

# Parameters

Name	Type
`objects`	`PlanObjectList`
`count`	`number`
`findFreeSpaceInPlan`	`boolean`

# Returns

PlanObject[]

# endDrawing

▸ endDrawing(point): void

# Parameters

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

# Returns

void

# endInteraction

▸ endInteraction(): void

# Returns

void

# forceNode

▸ forceNode(point): void

# Parameters

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

# Returns

void

# getConfiguratorKernel

▸ getConfiguratorKernel(): ConfiguratorKernelClass

# Returns

ConfiguratorKernelClass

# getContinuousDrawingManager

▸ getContinuousDrawingManager(): ContinuousDrawingManager

# Returns

ContinuousDrawingManager

# getPlan

▸ getPlan(): Plan

# Returns

Plan

# getShowChildrenOfPlanObject

▸ getShowChildrenOfPlanObject(object): ChildEntityMode

# Parameters

Name	Type
`object`	`KernelObject`

# Returns

ChildEntityMode

# groupObjects

▸ groupObjects(planObjectPtrList): ObjectGroupPtr

# Parameters

Name	Type
`planObjectPtrList`	`PlanObjectList`

# Returns

ObjectGroupPtr

# 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

# isRedoPossible

▸ isRedoPossible(): boolean

# Returns

boolean

# isUndoPossible

▸ isUndoPossible(): boolean

# Returns

boolean

# loadPlanXML

▸ loadPlanXML(xml): Plan

# Parameters

Name	Type
`xml`	`string`

# Returns

Plan

# moveElementBy

▸ moveElementBy(planObject, distance): void

# Parameters

Name	Type
`planObject`	`KernelObject`
`distance`	`KernelVector3`

# Returns

void

# moveElementTo

▸ moveElementTo(planObject, point): void

# Parameters

Name	Type
`planObject`	`KernelObject`
`point`	`KernelVector3`

# Returns

void

# moveObjectsBy

▸ moveObjectsBy(planObjects, distance): void

# Parameters

Name	Type
`planObjects`	`KernelObjectPtrList`
`distance`	`KernelVector3`

# Returns

void

# reactivateAllSnappingActivity

▸ reactivateAllSnappingActivity(): void

# Returns

void

# redo

▸ redo(): void

# Returns

void

# removeElement

▸ removeElement(planObject): void

# Parameters

Name	Type
`planObject`	`KernelObject`

# Returns

void

# rotateGroupBy

▸ rotateGroupBy(group, anAngleInRad, aroundPoint): void

# Parameters

Name	Type
`group`	`ObjectGroupPtr`
`anAngleInRad`	`number`
`aroundPoint`	`KernelVector3`

# Returns

void

# rotateObjectTo

▸ rotateObjectTo(planObject, angleInRad): void

# Parameters

Name	Type
`planObject`	`KernelObject`
`angleInRad`	`number`

# Returns

void

# rotateObjectsBy

▸ rotateObjectsBy(planObjectPtrList, anAngleInRad, aroundPoint): void

# Parameters

Name	Type
`planObjectPtrList`	`PlanObjectList`
`anAngleInRad`	`number`
`aroundPoint`	`KernelVector3`

# Returns

void

# setDefaultParapetHeight

▸ setDefaultParapetHeight(parapetHeight, applyToAll): void

# Parameters

Name	Type
`parapetHeight`	`number`
`applyToAll`	`boolean`

# Returns

void

# setDefaultWallHeight

▸ setDefaultWallHeight(wallHeight, applyToAll): void

# Parameters

Name	Type
`wallHeight`	`number`
`applyToAll`	`boolean`

# Returns

void

# setDefaultWallThickness

▸ setDefaultWallThickness(wallThickness, applyToAll): void

# Parameters

Name	Type
`wallThickness`	`number`
`applyToAll`	`boolean`

# Returns

void

# setDrawingType

▸ setDrawingType(aNewDrawingType): void

# Parameters

Name	Type
`aNewDrawingType`	`DrawingType`

# Returns

void

# setFloorMaterial

▸ setFloorMaterial(floor, material): void

# Parameters

Name	Type
`floor`	`KernelFloor`
`material`	`KernelFloorMaterial`

# Returns

void

# setLengthOfWall

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

# Parameters

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

# Returns

void

# setMeasurePoint1

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

# Parameters

Name	Type
`measure`	`PlanMeasure`
`point`	`KernelVector3f`
`snapToWalls`	`boolean`
`snapToObjects`	`boolean`

# Returns

void

# setMeasurePoint2

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

# Parameters

Name	Type
`measure`	`PlanMeasure`
`point`	`KernelVector3f`
`snapToWalls`	`boolean`
`snapToObjects`	`boolean`

# Returns

void

# setObjectCustomColor

▸ setObjectCustomColor(anObject, aCustomColor): void

# Parameters

Name	Type
`anObject`	`KernelObject`
`aCustomColor`	`number`

# Returns

void

# setObjectFixedZ

▸ setObjectFixedZ(anObject, shouldFlipZ): void

# Parameters

Name	Type
`anObject`	`KernelObject`
`shouldFlipZ`	`boolean`

# Returns

void

# setObjectFlipX

▸ setObjectFlipX(anObject, shouldFlipX): void

# Parameters

Name	Type
`anObject`	`KernelObject`
`shouldFlipX`	`boolean`

# Returns

void

# setObjectFlipY

▸ setObjectFlipY(anObject, shouldFlipY): void

# Parameters

Name	Type
`anObject`	`KernelObject`
`shouldFlipY`	`boolean`

# Returns

void

# setObjectRotation

▸ setObjectRotation(planObject, angleInRad): void

# Parameters

Name	Type
`planObject`	`KernelObject`
`angleInRad`	`number`

# Returns

void

# setObjectSize

▸ setObjectSize(anObject, aNewSize, anAnchor): void

# Parameters

Name	Type
`anObject`	`KernelObject`
`aNewSize`	`KernelVector3`
`anAnchor`	`Anchor`

# Returns

void

# setShowChildrenOfPlanObject

▸ setShowChildrenOfPlanObject(object, mode): void

# Parameters

Name	Type
`object`	`KernelObject`
`mode`	`ChildEntityMode`

# Returns

void

# setSnapFeedbackWhileDrawing

▸ setSnapFeedbackWhileDrawing(enabled): void

# Parameters

Name	Type
`enabled`	`boolean`

# Returns

void

# setViewSnapDist

▸ setViewSnapDist(aDist): void

# Parameters

Name	Type
`aDist`	`number`

# Returns

void

# setWallHeight

▸ setWallHeight(wall, height): void

# Parameters

Name	Type
`wall`	`KernelWall`
`height`	`number`

# Returns

void

# setWallLeftMaterial

▸ setWallLeftMaterial(wall, material): void

# Parameters

Name	Type
`wall`	`KernelWall`
`material`	`KernelWallMaterial`

# Returns

void

# setWallRightMaterial

▸ setWallRightMaterial(wall, material): void

# Parameters

Name	Type
`wall`	`KernelWall`
`material`	`KernelWallMaterial`

# Returns

void

# setWallThickness

▸ setWallThickness(wall, thickness): void

# Parameters

Name	Type
`wall`	`KernelWall`
`thickness`	`number`

# Returns

void

# setZoomFactor

▸ setZoomFactor(pxPerMM): void

# Parameters

Name	Type
`pxPerMM`	`number`

# Returns

void

# startInteraction

▸ startInteraction(): void

# Returns

void

# undo

▸ undo(): void

# Returns

void