RoomleConfigurator.Internal.PlanInteractionHandler

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

Table of contents

Properties

• customRaster

• dockWhenSnap

• enableDrawingSnap

• enableRaster

• enableSnap

• objectToObjectSnapMode

• objectToWallSnapMode

• showChildrenOfPlanObjects

• unDockOnMove

• unit

Methods

• addMeasure

• addNode

• addOrUpdateExternalPlanObjects

• addPlanObjectFromItem

• addPlanObjects

• addWall

• beginDrawing

• cancelDrawing

• catalogItemLoaded

• consistsOfMergedComponents

• currentDrawingPosition

• deactivateAllSnappingActivity

• duplicatePlanObject

• duplicatePlanObjects

• endDrawing

• endInteraction

• forceNode

• getConfiguratorKernel

• getContinuousDrawingManager

• getDefaultExteriorWallMaterial

• getDefaultFloorMaterial

• getDefaultInteriorWallMaterial

• getPlan

• getShowChildrenOfPlanObject

• groupObjects

• init

• isRedoPossible

• isUndoPossible

• isVectorPreviewModeEnabled

• loadPlanXML

• moveElementBy

• moveElementTo

• moveObjectsBy

• reactivateAllSnappingActivity

• redo

• removeElement

• removeObjectWithId

• rotateGroupBy

• rotateObjectTo

• rotateObjectsBy

• setDefaultExteriorWallMaterial

• setDefaultFloorMaterial

• setDefaultInteriorWallMaterial

• setDefaultParapetHeight

• setDefaultWallHeight

• setDefaultWallThickness

• setDiscardExternalObjectsOnLoad

• setDrawingType

• setFloorMaterial

• setLengthOfWall

• setMeasurePoint1

• setMeasurePoint2

• setObjectCustomColor

• setObjectFixedZ

• setObjectFlipX

• setObjectFlipY

• setObjectRotation

• setObjectSize

• setRotationSnapAngle

• setShowChildrenOfPlanObject

• setSnapFeedbackWhileDrawing

• setViewSnapDist

• setWallHeight

• setWallLeftMaterial

• setWallRightMaterial

• setWallThickness

• setZoomFactor

• startInteraction

• undo

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
endPosition

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, applyGlobalChildMode): PlanObject[]

Parameters

Name	Type
serialzedConfiguration	string
position
rotationInRad	number
findFreeSpaceInPlan	boolean
applyGlobalChildMode	boolean

Returns

PlanObject[]

---

addPlanObjectFromItem

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

Parameters

Name	Type
object
position
type	number
findFreeSpaceInPlan	boolean

Returns

PlanObject

---

addPlanObjects

▸ addPlanObjects(list, findFreeSpaceInPlan): PlanObject[]

Parameters

Name	Type
list
findFreeSpaceInPlan	boolean

Returns

PlanObject[]

---

addWall

▸ addWall(from, to): KernelWall

Parameters

Name	Type
from
to

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

---

catalogItemLoaded

▸ catalogItemLoaded(catalogItem): void

Parameters

Name	Type
catalogItem

Returns

void

---

consistsOfMergedComponents

▸ consistsOfMergedComponents(object): boolean

Parameters

Name	Type
object

Returns

boolean

---

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
count	number
findFreeSpaceInPlan	boolean

Returns

PlanObject[]

---

duplicatePlanObjects

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

Parameters

Name	Type
objects
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

---

getDefaultExteriorWallMaterial

▸ getDefaultExteriorWallMaterial(): KernelWallMaterial

Returns

KernelWallMaterial

---

getDefaultFloorMaterial

▸ getDefaultFloorMaterial(): KernelFloorMaterial

Returns

KernelFloorMaterial

---

getDefaultInteriorWallMaterial

▸ getDefaultInteriorWallMaterial(): KernelWallMaterial

Returns

KernelWallMaterial

---

getPlan

▸ getPlan(): Plan

Returns

Plan

---

getShowChildrenOfPlanObject

▸ getShowChildrenOfPlanObject(object): ChildEntityMode

Parameters

Name	Type
object

Returns

ChildEntityMode

---

groupObjects

▸ groupObjects(planObjectPtrList): ObjectGroupPtr

Parameters

Name	Type
planObjectPtrList

Returns

ObjectGroupPtr

---

init

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

Parameters

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

Returns

PlanInteractionHandler

---

isRedoPossible

▸ isRedoPossible(): boolean

Returns

boolean

---

isUndoPossible

▸ isUndoPossible(): boolean

Returns

boolean

---

isVectorPreviewModeEnabled

▸ isVectorPreviewModeEnabled(): boolean

Returns

boolean

---

loadPlanXML

▸ loadPlanXML(xml): Plan

Parameters

Name	Type
xml	string

Returns

Plan

---

moveElementBy

▸ moveElementBy(planObject, distance): void

Parameters

Name	Type
planObject
distance

Returns

void

---

moveElementTo

▸ moveElementTo(planObject, point): void

Parameters

Name	Type
planObject
point

Returns

void

---

moveObjectsBy

▸ moveObjectsBy(planObjects, distance): void

Parameters

Name	Type
planObjects
distance

Returns

void

---

reactivateAllSnappingActivity

▸ reactivateAllSnappingActivity(): void

Returns

void

---

redo

▸ redo(): void

Returns

void

---

removeElement

▸ removeElement(planObject): void

Parameters

Name	Type
planObject

Returns

void

---

removeObjectWithId

▸ removeObjectWithId(objectId): void

Parameters

Name	Type
objectId	string

Returns

void

---

rotateGroupBy

▸ rotateGroupBy(group, anAngleInRad, aroundPoint): void

Parameters

Name	Type
group
anAngleInRad	number
aroundPoint

Returns

void

---

rotateObjectTo

▸ rotateObjectTo(planObject, angleInRad): void

Parameters

Name	Type
planObject
angleInRad	number

Returns

void

---

rotateObjectsBy

▸ rotateObjectsBy(planObjectPtrList, anAngleInRad, aroundPoint): void

Parameters

Name	Type
planObjectPtrList
anAngleInRad	number
aroundPoint

Returns

void

---

setDefaultExteriorWallMaterial

▸ setDefaultExteriorWallMaterial(wallMaterial): void

Parameters

Name	Type
wallMaterial

Returns

void

---

setDefaultFloorMaterial

▸ setDefaultFloorMaterial(floorMaterial): void

Parameters

Name	Type
floorMaterial

Returns

void

---

setDefaultInteriorWallMaterial

▸ setDefaultInteriorWallMaterial(wallMaterial): void

Parameters

Name	Type