API Reference › Globals › PlanModelViewHelper
# Class: PlanModelViewHelper
# Hierarchy
- PlanModelViewHelper
# Index
# Methods
- getPlanOverview
- getCeilingHeight
- getDistAlongWallOnSide
- getDistToNextWallOnSide
- getMaxDistToBorderForPlanObject
- requestFloorMesh2d
- requestMesh3d
- requestPlanMesh3d
- requestWallMesh2d
# Methods
# getPlanOverview
▸ getPlanOverview(planObject: KernelObject): PlanOverview
Defined in packages/typings/planner.ts:120
Parameters:
| Name | Type |
|---|---|
planObject | KernelObject |
Returns: PlanOverview
# Static getCeilingHeight
▸ getCeilingHeight(aFloor: Floor): number
Defined in packages/typings/planner-kernel-container.ts:217
Parameters:
| Name | Type |
|---|---|
aFloor | Floor |
Returns: number
# Static getDistAlongWallOnSide
▸ getDistAlongWallOnSide(anObject: ConstructionObject, aSide: PlanObjectSide, aWallSide: WallSide): number
Defined in packages/typings/planner-kernel-container.ts:220
Parameters:
| Name | Type |
|---|---|
anObject | ConstructionObject |
aSide | PlanObjectSide |
aWallSide | WallSide |
Returns: number
# Static getDistToNextWallOnSide
▸ getDistToNextWallOnSide(anObject: PlanObjectPtr, aSide: PlanObjectSide, maxDist: number): number
Defined in packages/typings/planner-kernel-container.ts:219
Parameters:
| Name | Type |
|---|---|
anObject | PlanObjectPtr |
aSide | PlanObjectSide |
maxDist | number |
Returns: number
# Static getMaxDistToBorderForPlanObject
▸ getMaxDistToBorderForPlanObject(aPlanObject: PlanObjectPtr): number
Defined in packages/typings/planner-kernel-container.ts:218
Parameters:
| Name | Type |
|---|---|
aPlanObject | PlanObjectPtr |
Returns: number
# Static requestFloorMesh2d
▸ requestFloorMesh2d(aFloor: Floor): void
Defined in packages/typings/planner-kernel-container.ts:216
Parameters:
| Name | Type |
|---|---|
aFloor | Floor |
Returns: void
# Static requestMesh3d
▸ requestMesh3d(aPlanElement: PlanElement): void
Defined in packages/typings/planner-kernel-container.ts:213
Parameters:
| Name | Type |
|---|---|
aPlanElement | PlanElement |
Returns: void
# Static requestPlanMesh3d
▸ requestPlanMesh3d(aPlanElement: PlanElement, includeCeiling: boolean): void
Defined in packages/typings/planner-kernel-container.ts:214
Parameters:
| Name | Type |
|---|---|
aPlanElement | PlanElement |
includeCeiling | boolean |
Returns: void
# Static requestWallMesh2d
▸ requestWallMesh2d(aWall: Wall): void
Defined in packages/typings/planner-kernel-container.ts:215
Parameters:
| Name | Type |
|---|---|
aWall | Wall |
Returns: void