@snaptrude/plugin-core 0.3.0 → 0.6.0

package/dist/api/design/query/geometry/index.d.ts

@@ -0,0 +1,140 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../../../types";
+import { ComponentHandle, BrepHandle, ContourHandle, CurveHandle } from "../../../../handles";
+/**
+ * `snaptrude.design.query.geometry` — read the geometry of scene BIM entities.
+ *
+ * This is the bridge from the BIM/scene layer (`design.*`, keyed by
+ * {@linkcode ComponentHandle}) into the geometry kernel (`core.geom.query.*`,
+ * keyed by value/topology handles). {@linkcode PluginDesignQueryGeometryApi.getBrep}
+ * mints a {@linkcode BrepHandle} for a component's boundary-representation mesh;
+ * {@linkcode PluginDesignQueryGeometryApi.getBottomContour} mints a
+ * {@linkcode ContourHandle} for its footprint outline;
+ * {@linkcode PluginDesignQueryGeometryApi.getCenterline} mints a
+ * {@linkcode CurveHandle} for a wall's core curve.
+ *
+ * Returned handles are session-ephemeral and go stale on undo/redo/re-topologize
+ * — re-fetch a fresh one after edits.
+ */
+export declare abstract class PluginDesignQueryGeometryApi {
+    constructor();
+    /**
+     * Get the boundary representation (B-rep) of a scene component — the solid
+     * geometry (faces, edges, vertices) behind a wall, slab, room or any other
+     * scene entity, as a reusable {@linkcode BrepHandle} for the
+     * `core.geom.query.brep.*` reads.
+     *
+     * @param component - The scene component to read
+     * @returns The brep as a {@linkcode BrepHandle}, or `null` if the component has no brep geometry
+     *
+     * @examplePrompt Get the 3D solid geometry of the selected wall
+     * @examplePrompt How many faces does this mass have?
+     * @examplePrompt Inspect the mesh of this slab so I can look at its faces and edges
+     * @examplePrompt Read the vertices of the selected column's geometry
+     *
+     * @example
+     * ```ts
+     * const brep = await snaptrude.design.query.geometry.getBrep(component)
+     * if (brep) {
+     *   const faces = await snaptrude.core.geom.query.brep.listFaces(brep)
+     * }
+     * ```
+     */
+    abstract getBrep(component: ComponentHandle): PluginApiReturn<BrepHandle | null>;
+    /**
+     * Get the **bottom-face contour** of a component — the footprint outline (outer
+     * profile + holes) of its lowest horizontal face, as a reusable
+     * {@linkcode ContourHandle}.
+     *
+     * Extracted from the component's B-rep; robust to inverted face normals. Read
+     * its geometry via `snaptrude.core.geom.query.contour.*`, or feed it back into
+     * `design.create.*` / `core.geom.*`.
+     *
+     * @param component - The scene component to read
+     * @returns the footprint {@linkcode ContourHandle}, or `null` if the component
+     *   has no extractable bottom face (e.g. it carries no B-rep)
+     *
+     * @examplePrompt Get the footprint of the selected mass
+     * @examplePrompt What is the plan outline of this building volume?
+     * @examplePrompt Trace the base profile of this wall
+     * @examplePrompt Find the ground-level outline of the slab, including any openings
+     * @examplePrompt Work out the footprint area of the selected component
+     *
+     * @example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const contour = await snaptrude.design.query.geometry.getBottomContour(wall)
+     * if (contour) {
+     *   const area = await snaptrude.core.geom.query.contour.getArea(contour)
+     * }
+     * ```
+     */
+    abstract getBottomContour(component: ComponentHandle): PluginApiReturn<ContourHandle | null>;
+    /**
+     * Get the **centerline** (core curve) of a wall — the single curve running
+     * down the middle of the wall, as a reusable {@linkcode CurveHandle}
+     * (a `Line` for a straight wall, an `Arc` for a curved wall).
+     *
+     * For a parametric wall this is its stored core curve; otherwise it is
+     * derived from the wall's B-rep bottom face. Read its geometry via
+     * `snaptrude.core.geom.query.curve.*`, or feed it into `design.create.*`.
+     *
+     * Only walls have a centerline. As with all `get*` reads it never throws:
+     * a non-wall component, or a wall with no derivable centerline, yields `null`.
+     *
+     * @param component - The scene component to read (only walls yield a centerline)
+     * @returns the centerline {@linkcode CurveHandle}, or `null` if the component
+     *   is not a wall or the wall has no derivable centerline (e.g. it carries no
+     *   B-rep or has an unsupported profile)
+     *
+     * @examplePrompt Get the centerline of the selected wall
+     * @examplePrompt How long is this wall along its centre line?
+     * @examplePrompt Find the axis running down the middle of this wall
+     * @examplePrompt Give me the core curve of that curved wall
+     * @examplePrompt Where does the wall's centreline start and end?
+     *
+     * @example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const centerline = await snaptrude.design.query.geometry.getCenterline(wall)
+     * if (centerline) {
+     *   const length = await snaptrude.core.geom.query.curve.getLength(centerline)
+     * }
+     * ```
+     */
+    abstract getCenterline(component: ComponentHandle): PluginApiReturn<CurveHandle | null>;
+}
+/**
+ * Arguments for {@linkcode PluginDesignQueryGeometryApi.getBrep}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `component` | {@linkcode ComponentHandle} | The scene component to read |
+ */
+export declare const PluginDesignQueryGeometryGetBrepArgs: z.ZodObject<{
+    component: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+}, z.core.$strip>;
+export type PluginDesignQueryGeometryGetBrepArgs = z.infer<typeof PluginDesignQueryGeometryGetBrepArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignQueryGeometryApi.getBottomContour}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `component` | {@linkcode ComponentHandle} | The scene component to read |
+ */
+export declare const PluginDesignQueryGeometryGetBottomContourArgs: z.ZodObject<{
+    component: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+}, z.core.$strip>;
+export type PluginDesignQueryGeometryGetBottomContourArgs = z.infer<typeof PluginDesignQueryGeometryGetBottomContourArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignQueryGeometryApi.getCenterline}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `component` | {@linkcode ComponentHandle} | The scene component to read |
+ */
+export declare const PluginDesignQueryGeometryGetCenterlineArgs: z.ZodObject<{
+    component: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+}, z.core.$strip>;
+export type PluginDesignQueryGeometryGetCenterlineArgs = z.infer<typeof PluginDesignQueryGeometryGetCenterlineArgs>;
+//# sourceMappingURL=index.d.ts.map

package/dist/api/design/query/geometry/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/api/design/query/geometry/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EACL,eAAe,EACf,UAAU,EACV,aAAa,EACb,WAAW,EACZ,MAAM,qBAAqB,CAAA;AAE5B;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,4BAA4B;;IAGhD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,OAAO,CACrB,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,UAAU,GAAG,IAAI,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,gBAAgB,CAC9B,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,aAAa,GAAG,IAAI,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;aACa,aAAa,CAC3B,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,WAAW,GAAG,IAAI,CAAC;CACvC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AAEF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6CAA6C;;iBAExD,CAAA;AAEF,MAAM,MAAM,6CAA6C,GAAG,CAAC,CAAC,KAAK,CACjE,OAAO,6CAA6C,CACrD,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0CAA0C;;iBAErD,CAAA;AAEF,MAAM,MAAM,0CAA0C,GAAG,CAAC,CAAC,KAAK,CAC9D,OAAO,0CAA0C,CAClD,CAAA"}