measure_surface
Trace an open wall run to calculate surface area in square feet, using wall height from the condition. Ideal for wall tile, wainscot, and wall system takeoffs.
Instructions
Surface Area — wall SF (#146): trace an OPEN run along the wall in plan view (min 2 points, image px) and the quantity is traced LF × height. This is how wall tile, wainscot, and wall systems are taken off — the quantity family one_click and measure_polygon cannot produce. Height lives on the CONDITION (the canvas's H knob): pass height_ft to set it on this call (journals as its own undo step, like typing H before tracing), or set it once with edit_condition; with neither, this refuses and mints nothing. The shape snapshots the height it was quantified at. Requires the sheet's scale. Coordinates are image px at render scale 2.0: PDF pt × 2, origin top-left, y down (the browser canvas's native space). Sheet payloads carry dims in both px and pt.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pts | Yes | The wall run, an open polyline (image px) | |
| sheet | Yes | ||
| condition | Yes | Finish tag to commit under (minted on first use), e.g. 'CT-W1' | |
| height_ft | No | Wall height in feet — written to the condition's H knob first, then used |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| npts | Yes | ||
| area_sf | Yes | length_lf × height_ft — the wall SF committed | |
| shape_id | Yes | ||
| condition | Yes | ||
| height_ft | Yes | The height this shape was quantified at (snapshotted on the shape) | |
| length_lf | Yes | The traced run's open length |