API ReferenceGlobalsPlanInteractionHandler

# Interface: PlanInteractionHandler

# Hierarchy

  • PlanInteractionHandler

# Index

# Properties

# Methods

# Properties

# unit

unit: string

Defined in packages/typings/planner.ts:175

# Methods

# addNode

addNode(point: object): PlanNode

Defined in packages/typings/planner.ts:145

Parameters:

point: object

Name Type
x number
y number
z number

Returns: PlanNode


# addPlanObjectFromItem

addPlanObjectFromItem(object: KernelObject, position: KernelVector3, type: number): KernelObject

Defined in packages/typings/planner.ts:113

Parameters:

Name Type
object KernelObject
position KernelVector3
type number

Returns: KernelObject


# addPlanObjects

addPlanObjects(list: KernelObjectPtrList): void

Defined in packages/typings/planner.ts:111

Parameters:

Name Type
list KernelObjectPtrList

Returns: void


# addWall

addWall(from: PlanNode, to: PlanNode): KernelWall

Defined in packages/typings/planner.ts:147

Parameters:

Name Type
from PlanNode
to PlanNode

Returns: KernelWall


# beginDrawing

beginDrawing(point: object): void

Defined in packages/typings/planner.ts:139

Parameters:

point: object

Name Type
x number
y number
z number

Returns: void


# cancelDrawing

cancelDrawing(): void

Defined in packages/typings/planner.ts:143

Returns: void


# currentDrawingPosition

currentDrawingPosition(point: object): void

Defined in packages/typings/planner.ts:155

Parameters:

point: object

Name Type
x number
y number
z number

Returns: void


# deactivateAllSnappingActivity

deactivateAllSnappingActivity(): void

Defined in packages/typings/planner.ts:123

Returns: void


# endDrawing

endDrawing(point: object): void

Defined in packages/typings/planner.ts:141

Parameters:

point: object

Name Type
x number
y number
z number

Returns: void


# endInteraction

endInteraction(): void

Defined in packages/typings/planner.ts:133

Returns: void


# forceNode

forceNode(point: object): void

Defined in packages/typings/planner.ts:157

Parameters:

point: object

Name Type
x number
y number
z number

Returns: void


# getConfiguratorKernel

getConfiguratorKernel(): ConfiguratorKernelClass

Defined in packages/typings/planner.ts:95

Returns: ConfiguratorKernelClass


# getPlan

getPlan(): Plan

Defined in packages/typings/planner.ts:99

Returns: Plan


# groupObjects

groupObjects(planObjectPtrList: PlanObjectList): ObjectGroupPtr

Defined in packages/typings/planner.ts:117

Parameters:

Name Type
planObjectPtrList PlanObjectList

Returns: ObjectGroupPtr


# init

init(reference: PlanInteractionHandler, zoomFactor: number, viewSnapDist: number, snapObjectsToWalls: boolean, shouldSnap: boolean, drawingType: any): PlanInteractionHandler

Defined in packages/typings/planner.ts:93

Parameters:

Name Type
reference PlanInteractionHandler
zoomFactor number
viewSnapDist number
snapObjectsToWalls boolean
shouldSnap boolean
drawingType any

Returns: PlanInteractionHandler


# isRedoPossible

isRedoPossible(): boolean

Defined in packages/typings/planner.ts:129

Returns: boolean


# isUndoPossible

isUndoPossible(): boolean

Defined in packages/typings/planner.ts:127

Returns: boolean


# loadPlanXML

loadPlanXML(xml: string): Plan

Defined in packages/typings/planner.ts:97

Parameters:

Name Type
xml string

Returns: Plan


# moveElementBy

moveElementBy(planObject: KernelObject, distance: KernelVector3): void

Defined in packages/typings/planner.ts:103

Parameters:

Name Type
planObject KernelObject
distance KernelVector3

Returns: void


# moveElementTo

moveElementTo(planObject: KernelObject, point: KernelVector3): void

Defined in packages/typings/planner.ts:101

Parameters:

Name Type
planObject KernelObject
point KernelVector3

Returns: void


# moveObjectsBy

moveObjectsBy(planObjects: KernelObjectPtrList, distance: KernelVector3): void

Defined in packages/typings/planner.ts:105

Parameters:

Name Type
planObjects KernelObjectPtrList
distance KernelVector3

Returns: void


# reactivateAllSnappingActivity

reactivateAllSnappingActivity(): void

Defined in packages/typings/planner.ts:125

Returns: void


# redo

redo(): void

Defined in packages/typings/planner.ts:137

Returns: void


# removeElement

removeElement(planObject: KernelObject): void

Defined in packages/typings/planner.ts:115

Parameters:

Name Type
planObject KernelObject

Returns: void


# rotateGroupBy

rotateGroupBy(group: ObjectGroupPtr, anAngleInRad: number, aroundPoint: KernelVector3): void

Defined in packages/typings/planner.ts:121

Parameters:

Name Type
group ObjectGroupPtr
anAngleInRad number
aroundPoint KernelVector3

Returns: void


# rotateObjectTo

rotateObjectTo(planObject: KernelObject, angleInRad: number): void

Defined in packages/typings/planner.ts:107

Parameters:

Name Type
planObject KernelObject
angleInRad number

Returns: void


# rotateObjectsBy

rotateObjectsBy(planObjectPtrList: PlanObjectList, anAngleInRad: number, aroundPoint: KernelVector3): void

Defined in packages/typings/planner.ts:119

Parameters:

Name Type
planObjectPtrList PlanObjectList
anAngleInRad number
aroundPoint KernelVector3

Returns: void


# setDefaultParapetHeight

setDefaultParapetHeight(parapetHeight: number, applyToAll: boolean): void

Defined in packages/typings/planner.ts:169

Parameters:

Name Type
parapetHeight number
applyToAll boolean

Returns: void


# setDefaultWallHeight

setDefaultWallHeight(wallHeight: number, applyToAll: boolean): void

Defined in packages/typings/planner.ts:167

Parameters:

Name Type
wallHeight number
applyToAll boolean

Returns: void


# setDefaultWallThickness

setDefaultWallThickness(wallThickness: number, applyToAll: boolean): void

Defined in packages/typings/planner.ts:165

Parameters:

Name Type
wallThickness number
applyToAll boolean

Returns: void


# setDrawingType

setDrawingType(aNewDrawingType: DrawingType): void

Defined in packages/typings/planner.ts:159

Parameters:

Name Type
aNewDrawingType DrawingType

Returns: void


# setLengthOfWall

setLengthOfWall(wall: KernelWall, length: number, preferredSide: WallSide, direction: WallExtensionType, moveOrthogonalWalls: boolean): void

Defined in packages/typings/planner.ts:151

Parameters:

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

Returns: void


# setObjectRotation

setObjectRotation(planObject: KernelObject, angleInRad: number): void

Defined in packages/typings/planner.ts:109

Parameters:

Name Type
planObject KernelObject
angleInRad number

Returns: void


# setViewSnapDist

setViewSnapDist(aDist: number): void

Defined in packages/typings/planner.ts:163

Parameters:

Name Type
aDist number

Returns: void


# setWallHeight

setWallHeight(wall: KernelWall, height: number): void

Defined in packages/typings/planner.ts:149

Parameters:

Name Type
wall KernelWall
height number

Returns: void


# setWallLeftMaterial

setWallLeftMaterial(wall: KernelWall, material: KernelWallMaterial): void

Defined in packages/typings/planner.ts:171

Parameters:

Name Type
wall KernelWall
material KernelWallMaterial

Returns: void


# setWallRightMaterial

setWallRightMaterial(wall: KernelWall, material: KernelWallMaterial): void

Defined in packages/typings/planner.ts:173

Parameters:

Name Type
wall KernelWall
material KernelWallMaterial

Returns: void


# setWallThickness

setWallThickness(wall: KernelWall, thickness: number): void

Defined in packages/typings/planner.ts:153

Parameters:

Name Type
wall KernelWall
thickness number

Returns: void


# setZoomFactor

setZoomFactor(pxPerMM: number): void

Defined in packages/typings/planner.ts:161

Parameters:

Name Type
pxPerMM number

Returns: void


# startInteraction

startInteraction(): void

Defined in packages/typings/planner.ts:131

Returns: void


# undo

undo(): void

Defined in packages/typings/planner.ts:135

Returns: void