API ReferenceGlobalsPlanModelViewHelper

# Class: PlanModelViewHelper

# Hierarchy

  • PlanModelViewHelper

# Index

# Methods

# Methods

# getPlanOverview

getPlanOverview(planObject: KernelObject): PlanOverview

Defined in packages/typings/planner.ts:188

Parameters:

Name Type
planObject KernelObject

Returns: PlanOverview


# Static getCeilingHeight

getCeilingHeight(aFloor: Floor): number

Defined in packages/typings/planner-kernel-container.ts:276

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:282

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:280

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:278

Parameters:

Name Type
aPlanObject PlanObjectPtr

Returns: number


# Static requestFloorMesh2d

requestFloorMesh2d(aFloor: Floor): void

Defined in packages/typings/planner-kernel-container.ts:274

Parameters:

Name Type
aFloor Floor

Returns: void


# Static requestMesh3d

requestMesh3d(aPlanElement: PlanElement): void

Defined in packages/typings/planner-kernel-container.ts:268

Parameters:

Name Type
aPlanElement PlanElement

Returns: void


# Static requestPlanMesh3d

requestPlanMesh3d(aPlanElement: PlanElement, includeCeiling: boolean): void

Defined in packages/typings/planner-kernel-container.ts:270

Parameters:

Name Type
aPlanElement PlanElement
includeCeiling boolean

Returns: void


# Static requestWallMesh2d

requestWallMesh2d(aWall: Wall): void

Defined in packages/typings/planner-kernel-container.ts:272

Parameters:

Name Type
aWall Wall

Returns: void