brepjs-bim 0.23.1 → 0.24.0

package/README.md

@@ -25,14 +25,33 @@ the low-level path (and covers elements the declarative route doesn't yet). See
 
 Parametric authoring of the common IFC4 building elements plus the data layers that make a model
 useful downstream (psets, classification, materials, quantities), with import, export, and
-validation. Geometry is produced by brepjs (OCCT); each element carries a `ValidSolid` (or, for
-curtain walls, a panel/mullion grid). Element geometry is **unplaced template geometry** in local
-coordinates — placement (`origin` / `axisX` / `axisZ`) is applied by the IFC layer via
-`IfcLocalPlacement`, not baked into the brepjs solid. Use `placedSolids(element)` to read fresh,
-caller-owned solids transformed by the element's own placement (stairs and ramps return one solid
-per flight, curtain walls their panels and mullions). When an element is beneath a placed spatial
-structure, pass its cumulative frame as `placedSolids(element, { parentFrame })` to obtain world
-coordinates. This is especially important for parent-local Proxy and Earthworks Fill bodies.
+validation. Geometry is produced by brepjs (OCCT). Walls and railings carry a `ProductBody`, either
+a parametric solid or a non-empty collection of authoritative exact solids. Use `bodySolids()` to
+borrow their Product-local model handles and narrow `geometry.kind` when a caller specifically
+needs the parametric branch. Other solid-bearing categories continue to expose their existing
+geometry types.
+
+`takeExactProductBody(localId, { kind: 'EXACT', solids })` installs an authoritative wall or
+railing Body atomically. Success transfers every supplied handle to the model and disposes the
+superseded parametric Body; failure transfers nothing. Add wall openings before takeover, because
+an exact wall rejects later `addDoor()` and `addWindow()` mutations.
+
+Element geometry is **unplaced template geometry** in local coordinates. Placement (`origin` /
+`axisX` / `axisZ`) is applied by the IFC layer via `IfcLocalPlacement`, not baked into the brepjs
+solid. Use `placedSolids(element)` to read fresh, caller-owned solids transformed by the element's
+own placement. Stairs and ramps return one solid per flight, curtain walls return their panels and
+mullions, and an exact Product Body returns one placed copy per Body item. When an element is
+beneath a placed spatial structure, pass its cumulative frame as
+`placedSolids(element, { parentFrame })` to obtain world coordinates. This is especially important
+for parent-local Proxy and Earthworks Fill bodies.
+
+IFC import reconstructs every supported Body item independently. `ImportedGeometry.solids` owns
+the resulting World-placed handles and `completeness` reports `COMPLETE`, `PARTIAL`, or `NONE`.
+`fidelity` reports the least faithful retained item. Raw mesh siblings are combined in
+`meshVertices` and `meshIndices`. The legacy `.solid` property is a borrowed alias only for a
+complete one-solid Body. Dispose import geometry through `disposeImportedModel()` rather than
+through either property. Complete Bodies also expose aggregate `bounds` and `volumeMm3`; both are
+`null` when aggregate measurement fails or when the Body is partial or missing.
 
 - Units default to mm; IFC export emits SI metres.
 - Stable identity: deterministic IFC GUIDs (`deriveIfcGuid`) and local id counters.