Skip to main content
Use it for a click-to-draw tool on live walls.

Import

Example

Notes

  • Points are in metres and must be on the base plane of the tool.
  • add sets a point. move updates the preview. finish makes the walls. cancel drops the draft.
  • finish() returns undefined when there are too few points.
  • For walls that must go into a building session, use beginManagedWallCreate.

Constructor

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

Properties

WallNetwork
Read-only.
Omit<WallOptions, 'axis' | 'ogid'>
Read-only.
((result: WallToolCommit) => void) | undefined
Read-only.
'line' | 'arc'
Read-only.
number
Read-only.
readonly Vec3[]
Read-only.
readonly XZ[][]
Read-only.
WallFootprint
Read-only.
readonly Vec3[]
Read-only.

Methods

move

add

finish

removeLast

cancel

Types

WallToolCommit

Last modified on October 6, 2026