@snaptrude/plugin-core 0.7.1 → 0.9.0

package/src/api/design/query/geometry/index.ts

@@ -18,6 +18,9 @@ import {
  * {@linkcode ContourHandle} for its footprint outline;
  * {@linkcode PluginDesignQueryGeometryApi.getCenterline} mints a
  * {@linkcode CurveHandle} for a wall's core curve.
+ * {@linkcode PluginDesignQueryGeometryApi.getTriangulatedMeshes} is the
+ * handle-free exception: it returns the triangulated render meshes as plain
+ * world-space arrays.
  *
  * Returned handles are session-ephemeral and go stale on undo/redo/re-topologize
  * — re-fetch a fresh one after edits.
@@ -48,7 +51,7 @@ export abstract class PluginDesignQueryGeometryApi {
    * ```
    */
   public abstract getBrep(
-    component: ComponentHandle
+    component: ComponentHandle,
   ): PluginApiReturn<BrepHandle | null>
 
   /**
@@ -80,7 +83,7 @@ export abstract class PluginDesignQueryGeometryApi {
    * ```
    */
   public abstract getBottomContour(
-    component: ComponentHandle
+    component: ComponentHandle,
   ): PluginApiReturn<ContourHandle | null>
 
   /**
@@ -116,8 +119,67 @@ export abstract class PluginDesignQueryGeometryApi {
    * ```
    */
   public abstract getCenterline(
-    component: ComponentHandle
+    component: ComponentHandle,
   ): PluginApiReturn<CurveHandle | null>
+
+  /**
+   * Get the **triangulated render meshes** of scene components as plain,
+   * serializable arrays — flat world-space vertex `positions` (`[x0, y0, z0,
+   * x1, …]`) and triangle `indices` (three per triangle), one record per
+   * requested component.
+   *
+   * Unlike the other `geometry.*` reads this does NOT mint kernel handles — the
+   * raw arrays cross the boundary directly, ready for export, custom analysis,
+   * or feeding an external renderer. Positions are **always world-space**
+   * (instance/transform baked in; there is no local-coordinates mode) in plan
+   * units — no conversion needed. Raw doubles, unrounded.
+   *
+   * With `includeMaterialIds: true` each record also carries `materialIds`: one
+   * entry **per triangle** (`indices.length / 3` entries), the material *name*
+   * painted on that triangle, or `null` for unpainted/default faces.
+   *
+   * With `includeFaceIndices: true` each record also carries `faceIds`: one
+   * entry **per triangle** (input order), the B-rep face index owning that
+   * triangle (same ids as {@linkcode getBrep} faces), or `null` where there is
+   * no provenance. Non-B-rep meshes (Revit imports, generic models, furniture)
+   * yield all-`null` rather than an error.
+   *
+   * A resolvable component with no readable mesh geometry yields
+   * `{ id, positions: [], indices: [] }` — nothing is silently omitted.
+   *
+   * The call is capped at **500 000 triangles total**; over the cap it throws a
+   * `VALIDATION` error whose message includes the actual total — split the
+   * component list into smaller batches and call again.
+   *
+   * @param components - The scene components to triangulate
+   * @param options - `includeMaterialIds` adds the per-triangle material names;
+   *   `includeFaceIndices` adds the per-triangle B-rep face indices
+   * @returns `{ meshes }` — one {@linkcode PluginTriangulatedMesh} per requested
+   *   component, in input order
+   * @throws `HANDLE_INVALID` if any component handle is gone/forged;
+   *   `VALIDATION` if the combined mesh exceeds 500 000 triangles
+   *
+   * @examplePrompt Export the selected masses as a triangle mesh
+   * @examplePrompt Get the raw vertices and triangles of this wall in world coordinates
+   * @examplePrompt Give me the triangulated geometry of every space with its materials
+   * @examplePrompt Compute the surface area of this roof from its triangles
+   *
+   * @example
+   * ```ts
+   * const spaces = await snaptrude.design.query.listSpaces()
+   * const { meshes } = await snaptrude.design.query.geometry.getTriangulatedMeshes(spaces, {
+   *   includeMaterialIds: true,
+   * })
+   * for (const mesh of meshes) {
+   *   const triangleCount = mesh.indices.length / 3
+   *   console.log(mesh.id, triangleCount, mesh.materialIds?.[0])
+   * }
+   * ```
+   */
+  public abstract getTriangulatedMeshes(
+    components: ComponentHandle[],
+    options?: PluginDesignQueryGeometryGetTriangulatedMeshesArgs["options"],
+  ): PluginApiReturn<PluginDesignQueryGeometryGetTriangulatedMeshesResult>
 }
 
 /**
@@ -164,3 +226,63 @@ export const PluginDesignQueryGeometryGetCenterlineArgs = z.object({
 export type PluginDesignQueryGeometryGetCenterlineArgs = z.infer<
   typeof PluginDesignQueryGeometryGetCenterlineArgs
 >
+
+/**
+ * One component's triangulated world-space mesh, as plain serializable arrays
+ * (no handles).
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | The component's id (its {@linkcode ComponentHandle} token) |
+ * | `positions` | `number[]` | Flat world-space vertex coordinates `[x0, y0, z0, x1, …]`, plan units, raw doubles |
+ * | `indices` | `number[]` | Triangle vertex indices, three per triangle, into `positions / 3` |
+ * | `materialIds` | `(string \| null)[]` _(optional)_ | One entry per triangle: the painted material's name, `null` for unpainted/default faces. Present only when requested via `includeMaterialIds` |
+ * | `faceIds` | `(number \| null)[]` _(optional)_ | One entry per triangle: the B-rep face index owning it (same ids as {@linkcode PluginDesignQueryGeometryApi.getBrep} faces), `null` where there is no provenance (non-B-rep mesh). Present only when requested via `includeFaceIndices` |
+ */
+export const PluginTriangulatedMesh = z.object({
+  id: z.string(),
+  positions: z.array(z.number()),
+  indices: z.array(z.number()),
+  materialIds: z.array(z.string().nullable()).optional(),
+  faceIds: z.array(z.number().nullable()).optional(),
+})
+
+export type PluginTriangulatedMesh = z.infer<typeof PluginTriangulatedMesh>
+
+/**
+ * Arguments for {@linkcode PluginDesignQueryGeometryApi.getTriangulatedMeshes}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | The scene components to triangulate |
+ * | `options.includeMaterialIds` | `boolean` _(optional)_ | Also return the per-triangle material names |
+ * | `options.includeFaceIndices` | `boolean` _(optional)_ | Also return the per-triangle B-rep face indices |
+ */
+export const PluginDesignQueryGeometryGetTriangulatedMeshesArgs = z.object({
+  components: z.array(ComponentHandle),
+  options: z
+    .object({
+      includeMaterialIds: z.boolean().optional(),
+      includeFaceIndices: z.boolean().optional(),
+    })
+    .optional(),
+})
+
+export type PluginDesignQueryGeometryGetTriangulatedMeshesArgs = z.infer<
+  typeof PluginDesignQueryGeometryGetTriangulatedMeshesArgs
+>
+
+/**
+ * Result of {@linkcode PluginDesignQueryGeometryApi.getTriangulatedMeshes}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `meshes` | {@linkcode PluginTriangulatedMesh}`[]` | One record per requested component, in input order |
+ */
+export const PluginDesignQueryGeometryGetTriangulatedMeshesResult = z.object({
+  meshes: z.array(PluginTriangulatedMesh),
+})
+
+export type PluginDesignQueryGeometryGetTriangulatedMeshesResult = z.infer<
+  typeof PluginDesignQueryGeometryGetTriangulatedMeshesResult
+>

package/src/api/design/query/index.ts

@@ -10,6 +10,7 @@ import {
 import { PluginStaircasePreset } from "../create"
 import { PluginDesignQueryGeometryApi } from "./geometry"
 import { PluginDesignQuerySpacesApi } from "./spaces"
+import { PluginDesignQueryReferenceLinesApi } from "./referenceLines"
 
 // ---------------------------------------------------------------------------
 // Entity type vocabulary
@@ -168,6 +169,7 @@ export type PluginDesignQueryComponentsArgs = z.infer<
  * | `spaceType` | {@linkcode PluginSpaceType} | Space-type (spaces only) |
  * | `areaClass` | {@linkcode PluginAreaClass} | Area classification (spaces only) |
  * | `departmentId` | `string` | Department (masses only) |
+ * | `buildingType` | `string` | Assigned building type NAME (walls / slabs / floors / roofs / ceilings only) — the Object Properties panel's Wall/Slab/Floor/Roof/Ceiling Type dropdown value, matching the names from `design.types.list(kind)` |
  * | `isLocked` | `boolean` | Lock flag |
  * | `isHidden` | `boolean` | User-hidden flag |
  * | `isSelected` | `boolean` | Current selection state |
@@ -186,6 +188,7 @@ export const PluginEntityProperties = z
     spaceType: PluginSpaceType,
     areaClass: PluginAreaClass,
     departmentId: z.string(),
+    buildingType: z.string(),
     isLocked: z.boolean(),
     isHidden: z.boolean(),
     isSelected: z.boolean(),
@@ -201,17 +204,28 @@ export type PluginEntityProperties = z.infer<typeof PluginEntityProperties>
  * entity's type computes them (area: floors/masses/slabs/roofs/beams/columns;
  * volume: all; length: walls/beams).
  *
+ * `thickness` and `height` are the Object Properties panel's dimension reads
+ * (the same engine source `design.update.wall` / `design.update.slab` etc.
+ * write through), in engine units. `thickness`: walls (the plan thickness —
+ * present only for straight orthogonal walls, exactly when the panel shows it)
+ * and slabs/floors/roofs/ceilings (the vertical extent the panel calls
+ * Thickness). `height`: walls only.
+ *
  * | Property | Type | Description |
  * |---|---|---|
  * | `area` | `number`? | Bottom-face area |
  * | `volume` | `number`? | Solid volume |
  * | `length` | `number`? | Running length (linear elements) |
+ * | `thickness` | `number`? | Panel Thickness — walls (straight orthogonal only) and the slab family |
+ * | `height` | `number`? | Panel Height — walls only |
  * | `boundingBox` | {@linkcode BBoxComponents} | World-space AABB (always present) |
  */
 export const PluginEntityMeasurements = z.object({
   area: z.number().optional(),
   volume: z.number().optional(),
   length: z.number().optional(),
+  thickness: z.number().optional(),
+  height: z.number().optional(),
   boundingBox: BBoxComponents,
 })
 export type PluginEntityMeasurements = z.infer<typeof PluginEntityMeasurements>
@@ -288,6 +302,8 @@ export abstract class PluginDesignQueryApi {
   public abstract geometry: PluginDesignQueryGeometryApi
   /** Space-specific reads (footprint, …). See {@linkcode PluginDesignQuerySpacesApi}. */
   public abstract spaces: PluginDesignQuerySpacesApi
+  /** Reference-line-specific reads. See {@linkcode PluginDesignQueryReferenceLinesApi}. */
+  public abstract referenceLines: PluginDesignQueryReferenceLinesApi
 
   constructor() {}
 
@@ -755,9 +771,7 @@ export abstract class PluginDesignQueryApi {
    * }
    * ```
    */
-  public abstract exists(
-    id: ComponentHandle,
-  ): PluginApiReturn<boolean>
+  public abstract exists(id: ComponentHandle): PluginApiReturn<boolean>
 
   /**
    * Get the kind of BIM entity a handle refers to — wall, door, space, slab,
@@ -811,9 +825,7 @@ export abstract class PluginDesignQueryApi {
    * }
    * ```
    */
-  public abstract getLabel(
-    component: ComponentHandle,
-  ): PluginApiReturn<string>
+  public abstract getLabel(component: ComponentHandle): PluginApiReturn<string>
 
   /**
    * Get a serializable, persistable reference to an entity. Under the all-handle
@@ -897,13 +909,16 @@ export abstract class PluginDesignQueryApi {
    * Read an entity's common properties as a {@linkcode PluginEntityProperties}
    * record (only applicable fields are present). For spaces/masses this includes
    * `adjacency` — the per-entity adjacency read (bulk form:
-   * `program.adjacency.getMatrix`).
+   * `program.adjacency.getMatrix`). For walls and the slab family (slab / floor
+   * / roof / ceiling) this includes `buildingType` — the assigned building type
+   * NAME the panel's type dropdown shows, matching `design.types.list(kind)`.
    *
    * @param component - the entity's {@linkcode ComponentHandle}
    * @returns the property record
    *
    * @examplePrompt Show me all the details of the selected object
    * @examplePrompt What storey is this wall on?
+   * @examplePrompt Which wall type is assigned to this wall?
    * @examplePrompt Which department does this room belong to?
    * @examplePrompt Is this element locked or hidden?
    * @examplePrompt Get the adjacencies of this space
@@ -933,11 +948,20 @@ export abstract class PluginDesignQueryApi {
    * Measure an entity — read its area, volume, and/or running length (whichever
    * its type supports) together with its world-space bounding box in one call.
    *
+   * For walls and the slab family this also carries the Object Properties
+   * panel's dimension reads in engine units: `thickness` (walls — straight
+   * orthogonal only, exactly when the panel shows it; slabs / floors / roofs /
+   * ceilings — the vertical extent the panel calls Thickness) and `height`
+   * (walls). These are the read side of `design.update.wall` /
+   * `design.update.slab` / `.floor` / `.roof` / `.ceiling`.
+   *
    * @param component - the entity's {@linkcode ComponentHandle}
    * @returns a {@linkcode PluginEntityMeasurements}, or `null` if the entity is gone
    *
    * @examplePrompt What's the area of this room?
    * @examplePrompt How long is the selected wall?
+   * @examplePrompt How thick is this wall?
+   * @examplePrompt Get the thickness of the slab on level 2
    * @examplePrompt Get the volume of this mass
    * @examplePrompt Give me the dimensions of the selected element
    * @examplePrompt What's the floor area of the kitchen?
@@ -947,6 +971,11 @@ export abstract class PluginDesignQueryApi {
    * const [space] = await snaptrude.design.query.listSpaces()
    * const m = await snaptrude.design.query.measure(space)
    * console.log(m?.area, m?.volume)
+   *
+   * // wall dimensions — the panel's Thickness / Height, in engine units
+   * const [wall] = await snaptrude.design.query.listWalls()
+   * const wm = await snaptrude.design.query.measure(wall)
+   * console.log(wm?.thickness, wm?.height)
    * ```
    */
   public abstract measure(
@@ -1016,3 +1045,4 @@ export abstract class PluginDesignQueryApi {
 
 export * from "./geometry"
 export * from "./spaces"
+export * from "./referenceLines"

package/src/api/design/query/referenceLines.ts

@@ -0,0 +1,52 @@
+import * as z from "zod"
+import { PluginApiReturn } from "../../../types"
+import {
+  PluginReferenceLineGetProperty,
+  PluginReferenceLineGetResult,
+} from "../../entity/referenceLine"
+
+/**
+ * `design.query.referenceLines.*` — reference-line-specific reads.
+ *
+ * A **reference line** is a 2D guide line (or arc) in the scene, typically used
+ * for grid lines and alignment guides. Enumerate reference lines with
+ * `design.query.listReferenceLines`; read an individual line's properties here.
+ * This is the canonical home of the read formerly at `entity.referenceLine.get`
+ * (now deprecated).
+ *
+ * Accessed via `snaptrude.design.query.referenceLines`.
+ */
+export abstract class PluginDesignQueryReferenceLinesApi {
+  constructor() {}
+
+  /**
+   * Get properties of a reference line by its ID.
+   *
+   * Only the properties listed in `properties` are returned — unlisted
+   * properties will be `undefined` in the result.
+   *
+   * @param referenceLineId - The unique reference line ID
+   * @param properties - Array of property names to retrieve. See
+   *   {@linkcode PluginReferenceLineGetProperty}.
+   * @returns A partial {@linkcode PluginReferenceLineGetResult} containing only the
+   *   requested properties
+   * @throws If the reference line does not exist
+   *
+   * @examplePrompt Get the curve geometry of this reference line
+   * @examplePrompt Where does this grid line run?
+   * @examplePrompt Read the geometry of a guide line by its id
+   * @examplePrompt Look up the curve of the selected reference line
+   *
+   * # Example
+   * ```ts
+   * const [refLine] = await snaptrude.design.query.listReferenceLines()
+   * const result = await snaptrude.design.query.referenceLines.get(refLine, ["curve"])
+   * // result.curve is an opaque CurveHandle; read its coordinates via
+   * // `snaptrude.core.geom.curve`.
+   * ```
+   */
+  public abstract get(
+    referenceLineId: string,
+    properties: z.infer<typeof PluginReferenceLineGetProperty>[],
+  ): PluginApiReturn<PluginReferenceLineGetResult>
+}

package/src/api/design/query/spaces.ts

@@ -75,6 +75,55 @@ export abstract class PluginDesignQuerySpacesApi {
   public abstract getFootprint(
     space: ComponentHandle,
   ): PluginApiReturn<ContourHandle | null>
+
+  /**
+   * Get the **enclosure** of a space — the floor and ceiling that cap it, the
+   * bounding walls around it (with each wall's door/window openings), and the
+   * neighbouring spaces it shares a boundary with.
+   *
+   * **Geometric v1 — best effort.** The engine has no persisted space→surface
+   * topology, so this read is derived purely from *plan geometry*: the space
+   * footprint is matched against the plan footprints/baselines of the slabs and
+   * walls on the same storey. Consequences a caller must account for:
+   *
+   * - `faceIndices` is **always `[]`**. The triangle→B-rep-face provenance that
+   *   would populate it is a separate engine capability that does not exist yet;
+   *   read a surface's full geometry via
+   *   {@linkcode PluginDesignQueryGeometryApi.getBrep} on its `component` instead.
+   * - After heavy edits (move / stretch / boolean) or on imported models the plan
+   *   match can miss or mis-attribute a surface — treat the result as advisory,
+   *   not authoritative.
+   * - `adjacentSpaces` comes from the same adjacency data as
+   *   {@linkcode PluginProgramAdjacencyApi.getMatrix} (so the two agree on which
+   *   spaces neighbour). `sharedEdgeLength` is `0` because that data exposes no
+   *   edge length, and `sharedSurface` is the common boundary wall only when one
+   *   is found geometrically (else `null`).
+   *
+   * Read-only; never mutates the model.
+   *
+   * @param space - The space (room mass) to read
+   * @returns the {@linkcode PluginSpaceEnclosure}, or `null` when `space` is not a
+   *   space (room mass) or has no extractable plan footprint
+   *
+   * @examplePrompt What walls, floor and ceiling enclose this room?
+   * @examplePrompt Which of this room's walls are external?
+   * @examplePrompt List the doors and windows around the selected space
+   * @examplePrompt Which spaces are adjacent to this room, and through which wall?
+   *
+   * # Example
+   * ```ts
+   * const [space] = await snaptrude.design.query.listSpaces()
+   * const enclosure = await snaptrude.design.query.spaces.getEnclosure(space)
+   * if (enclosure) {
+   *   const walls = enclosure.surfaces.filter((s) => s.role === "wall")
+   *   const external = walls.filter((s) => s.isExternal)
+   *   console.log(`${walls.length} walls, ${external.length} external`)
+   * }
+   * ```
+   */
+  public abstract getEnclosure(
+    space: ComponentHandle,
+  ): PluginApiReturn<PluginSpaceEnclosure | null>
 }
 
 /**
@@ -130,3 +179,97 @@ export const PluginDesignQuerySpacesGetResult = PluginSpaceGetResult.omit({
 export type PluginDesignQuerySpacesGetResult = z.infer<
   typeof PluginDesignQuerySpacesGetResult
 >
+
+/**
+ * Arguments for {@linkcode PluginDesignQuerySpacesApi.getEnclosure}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `space` | {@linkcode ComponentHandle} | The space (room mass) to read |
+ */
+export const PluginDesignQuerySpacesGetEnclosureArgs = z.object({
+  space: ComponentHandle,
+})
+export type PluginDesignQuerySpacesGetEnclosureArgs = z.infer<
+  typeof PluginDesignQuerySpacesGetEnclosureArgs
+>
+
+/**
+ * The role a bounding surface plays in a {@linkcode PluginSpaceEnclosure}:
+ * `"floor"` (slab below), `"ceiling"` (slab/roof above), or `"wall"`.
+ */
+export const PluginEnclosureRole = z.enum(["floor", "ceiling", "wall"])
+export type PluginEnclosureRole = z.infer<typeof PluginEnclosureRole>
+
+/** The kind of opening hosted in a bounding wall. */
+export const PluginEnclosureOpeningKind = z.enum(["door", "window", "void"])
+export type PluginEnclosureOpeningKind = z.infer<
+  typeof PluginEnclosureOpeningKind
+>
+
+/**
+ * One opening (door / window / void) in a bounding wall.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `kind` | {@linkcode PluginEnclosureOpeningKind} | `"door"`, `"window"`, or `"void"` |
+ * | `component` | {@linkcode ComponentHandle} | The opening entity |
+ */
+export const PluginEnclosureOpening = z.object({
+  kind: PluginEnclosureOpeningKind,
+  component: ComponentHandle,
+})
+export type PluginEnclosureOpening = z.infer<typeof PluginEnclosureOpening>
+
+/**
+ * One bounding surface of a space's enclosure.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `role` | {@linkcode PluginEnclosureRole} | `"floor"`, `"ceiling"`, or `"wall"` |
+ * | `component` | {@linkcode ComponentHandle} | The wall / slab / roof entity |
+ * | `faceIndices` | `number[]` | B-rep face indices facing the space. **Always `[]` in geometric v1** (no triangle→face provenance yet) |
+ * | `isExternal` | `boolean` | No space on the other side — for a wall, no other room bounds it; for a floor/ceiling, no room caps the storey below/above |
+ * | `openings` | {@linkcode PluginEnclosureOpening}`[]` | Doors/windows/voids in the surface (walls only; `[]` for floor/ceiling in v1) |
+ */
+export const PluginEnclosureSurface = z.object({
+  role: PluginEnclosureRole,
+  component: ComponentHandle,
+  faceIndices: z.array(z.number()),
+  isExternal: z.boolean(),
+  openings: z.array(PluginEnclosureOpening),
+})
+export type PluginEnclosureSurface = z.infer<typeof PluginEnclosureSurface>
+
+/**
+ * A space that neighbours the queried space.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `space` | {@linkcode ComponentHandle} | The neighbouring space |
+ * | `sharedSurface` | {@linkcode ComponentHandle}` \| null` | The common boundary wall when one is found geometrically, else `null` (e.g. an open-plan or non-physical adjacency) |
+ * | `sharedEdgeLength` | `number` | Plan-unit length of the shared boundary — **always `0` in geometric v1** (the adjacency data exposes no edge length) |
+ */
+export const PluginAdjacentSpace = z.object({
+  space: ComponentHandle,
+  sharedSurface: ComponentHandle.nullable(),
+  sharedEdgeLength: z.number(),
+})
+export type PluginAdjacentSpace = z.infer<typeof PluginAdjacentSpace>
+
+/**
+ * Result of {@linkcode PluginDesignQuerySpacesApi.getEnclosure} — the geometric
+ * v1 enclosure of a space.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `space` | {@linkcode ComponentHandle} | The queried space |
+ * | `surfaces` | {@linkcode PluginEnclosureSurface}`[]` | Floor + ceiling + bounding walls, as a flat list (any of the three may be absent when no plan match is found) |
+ * | `adjacentSpaces` | {@linkcode PluginAdjacentSpace}`[]` | Neighbouring spaces from the adjacency data (`[]` when adjacency was never computed) |
+ */
+export const PluginSpaceEnclosure = z.object({
+  space: ComponentHandle,
+  surfaces: z.array(PluginEnclosureSurface),
+  adjacentSpaces: z.array(PluginAdjacentSpace),
+})
+export type PluginSpaceEnclosure = z.infer<typeof PluginSpaceEnclosure>