Skip to main content
It has an axis, a thickness, a height and a base elevation. To join walls at corners, add them to a WallNetwork.

Import

Example

Notes

  • Values are in metres and the Y axis points up. The angles of a circular axis are in radians.
  • The constructor needs all WallOptions. setOPConfig accepts some of them.
  • locationLine sets which line of the wall follows the axis: the centre or one face.
  • To add a door or a window, call attachDoor or attachWindow, then commitOpeningCuts().
  • dispose() detaches the openings. Dispose the door and window objects separately.
  • Start the geometry kernel before you create this object. See Floorkit.
  • This object is live geometry. To save a building, write it in a building model.
Inheritance: extends OPElement implements PlanVectorExportable, IPlaceable

Constructor

string
string
required
WallAxis
required
number
required
number
required
number
required
LocationLine
required
number
required
string
required
number
required
number
required
{ start: WallEndJoin; end: WallEndJoin; }
required
PropertySets

Properties

string
ElementType
string
Record<string, unknown>
boolean
WallFootprint
Read-only.
"open" | "closed"
Read-only.
Profile
AnalyticSolid | undefined
Read-only.
readonly AnalyticSolid[]
Read-only.

Methods

editableSchema

refreshOutline

anchorSpace

getEditAnchors

applyEditAnchor

beginOpeningGesture

beginWallDragPreview

Show moving opening outlines while an edited wall has an uncut preview body.

endWallDragPreview

commitOpeningCuts

prepareOpeningCuts

abortOpeningGesture

getHostedOpenings

attachDoor

attachWindow

attachWallOpening

openingFit

The one fit rule of a hosted opening: its whole cut in a net run of this resolved wall.

attachOpening

detachOpening

moveOpening

getOPConfig

getNetworkConfig

restoreConfig

beginEdit

endEdit

deleteFromNetwork

setOPConfig

bind

assignAxis

setResolvedFootprint

toDrawing

Produce standardized drawing primitives for a view directly from the element’s parametric data (the 0.3.0 contract).

getExportRoots

getOpeningDiagnostics

Opening diagnostics of this wall; junctions are the junctions of this wall when given.

move

Translate this element by delta (world-space, meters).

rotate

Rotate this element by angleDeg around axis (default Y-up), pivoted at anchor (default the element’s own centroid).

dispose

Types

WallOptions

WallFootprint

HostedOpening

The package does not export this type by name.

WallHostPlacement

Where to place an opening on its host wall. The package does not export this type by name.
number
Arc length from the host wall’s start point.
number
Bottom of the rough opening above the wall’s base. Never a world Y.

WallOpeningFitInput

A full-width cut asked at one centre station of a wall, in metres from the wall base.
number
required
number
required
number
required
number
required
string
required
boolean
Count the seam of a T stem against the fit, as an added opening does: an opening over a seam does not fit, and the nearest station and fit range keep clear of the seams.

WallOpeningFit

Where a hosted opening fits on one wall: stations are centre distances along its axis.
boolean
required
The whole cut lies in a net run of the wall, inside its height: the wall cuts it here.
WallOpeningFitReason[]
required
Why it does not fit; t-junction when the cut lies over the seam of a T stem.
number | null
required
The fitting centre station nearest to the asked one, or null when it fits nowhere.
{ start: number; end: number; } | null
required
The range of fitting centre stations that holds nearestStation, or null.

Junction

JunctionDiagnostic

Vec3

Strict 3-tuple of numbers.

LocationLine

WallMaterial

WallEndJoin

FootprintRing

WallOpeningFitReason

Why a hosted opening does not fit at a station; t-junction alone still fits (it is cut).

JunctionKind

FootprintEdge

EdgeRole

Last modified on October 16, 2026