API Reference › Globals › PlanInteractionHandler
# Interface: PlanInteractionHandler
# Hierarchy
- PlanInteractionHandler
# Index
# Methods
- addNode
- addPlanObjectFromItem
- addPlanObjects
- addWall
- deactivateAllSnappingActivity
- endInteraction
- getConfiguratorKernel
- getPlan
- groupObjects
- init
- isRedoPossible
- isUndoPossible
- loadPlanXML
- moveElementBy
- moveElementTo
- moveObjectsBy
- reactivateAllSnappingActivity
- redo
- removeElement
- rotateGroupBy
- rotateObjectTo
- rotateObjectsBy
- setObjectRotation
- setWallHeight
- setWallThickness
- startInteraction
- undo
# Methods
# addNode
▸ addNode(point: object): PlanNode
Defined in packages/typings/planner.ts:102
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:76
Parameters:
| Name | Type |
|---|---|
object | KernelObject |
position | KernelVector3 |
type | number |
Returns: KernelObject
# addPlanObjects
▸ addPlanObjects(list: KernelObjectPtrList): void
Defined in packages/typings/planner.ts:74
Parameters:
| Name | Type |
|---|---|
list | KernelObjectPtrList |
Returns: void
# addWall
▸ addWall(from: PlanNode, to: PlanNode): KernelWall
Defined in packages/typings/planner.ts:104
Parameters:
| Name | Type |
|---|---|
from | PlanNode |
to | PlanNode |
Returns: KernelWall
# deactivateAllSnappingActivity
▸ deactivateAllSnappingActivity(): void
Defined in packages/typings/planner.ts:86
Returns: void
# endInteraction
▸ endInteraction(): void
Defined in packages/typings/planner.ts:96
Returns: void
# getConfiguratorKernel
▸ getConfiguratorKernel(): ConfiguratorKernelClass
Defined in packages/typings/planner.ts:58
Returns: ConfiguratorKernelClass
# getPlan
▸ getPlan(): Plan
Defined in packages/typings/planner.ts:62
Returns: Plan
# groupObjects
▸ groupObjects(planObjectPtrList: PlanObjectList): ObjectGroupPtr
Defined in packages/typings/planner.ts:80
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:56
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:92
Returns: boolean
# isUndoPossible
▸ isUndoPossible(): boolean
Defined in packages/typings/planner.ts:90
Returns: boolean
# loadPlanXML
▸ loadPlanXML(xml: string): Plan
Defined in packages/typings/planner.ts:60
Parameters:
| Name | Type |
|---|---|
xml | string |
Returns: Plan
# moveElementBy
▸ moveElementBy(planObject: KernelObject, distance: KernelVector3): void
Defined in packages/typings/planner.ts:66
Parameters:
| Name | Type |
|---|---|
planObject | KernelObject |
distance | KernelVector3 |
Returns: void
# moveElementTo
▸ moveElementTo(planObject: KernelObject, point: KernelVector3): void
Defined in packages/typings/planner.ts:64
Parameters:
| Name | Type |
|---|---|
planObject | KernelObject |
point | KernelVector3 |
Returns: void
# moveObjectsBy
▸ moveObjectsBy(planObjects: KernelObjectPtrList, distance: KernelVector3): void
Defined in packages/typings/planner.ts:68
Parameters:
| Name | Type |
|---|---|
planObjects | KernelObjectPtrList |
distance | KernelVector3 |
Returns: void
# reactivateAllSnappingActivity
▸ reactivateAllSnappingActivity(): void
Defined in packages/typings/planner.ts:88
Returns: void
# redo
▸ redo(): void
Defined in packages/typings/planner.ts:100
Returns: void
# removeElement
▸ removeElement(planObject: KernelObject): void
Defined in packages/typings/planner.ts:78
Parameters:
| Name | Type |
|---|---|
planObject | KernelObject |
Returns: void
# rotateGroupBy
▸ rotateGroupBy(group: ObjectGroupPtr, anAngleInRad: number, aroundPoint: KernelVector3): void
Defined in packages/typings/planner.ts:84
Parameters:
| Name | Type |
|---|---|
group | ObjectGroupPtr |
anAngleInRad | number |
aroundPoint | KernelVector3 |
Returns: void
# rotateObjectTo
▸ rotateObjectTo(planObject: KernelObject, angleInRad: number): void
Defined in packages/typings/planner.ts:70
Parameters:
| Name | Type |
|---|---|
planObject | KernelObject |
angleInRad | number |
Returns: void
# rotateObjectsBy
▸ rotateObjectsBy(planObjectPtrList: PlanObjectList, anAngleInRad: number, aroundPoint: KernelVector3): void
Defined in packages/typings/planner.ts:82
Parameters:
| Name | Type |
|---|---|
planObjectPtrList | PlanObjectList |
anAngleInRad | number |
aroundPoint | KernelVector3 |
Returns: void
# setObjectRotation
▸ setObjectRotation(planObject: KernelObject, angleInRad: number): void
Defined in packages/typings/planner.ts:72
Parameters:
| Name | Type |
|---|---|
planObject | KernelObject |
angleInRad | number |
Returns: void
# setWallHeight
▸ setWallHeight(wall: KernelWall, height: number): void
Defined in packages/typings/planner.ts:106
Parameters:
| Name | Type |
|---|---|
wall | KernelWall |
height | number |
Returns: void
# setWallThickness
▸ setWallThickness(wall: KernelWall, thickness: number): void
Defined in packages/typings/planner.ts:108
Parameters:
| Name | Type |
|---|---|
wall | KernelWall |
thickness | number |
Returns: void
# startInteraction
▸ startInteraction(): void
Defined in packages/typings/planner.ts:94
Returns: void
# undo
▸ undo(): void
Defined in packages/typings/planner.ts:98
Returns: void