@snaptrude/plugin-core 0.3.0 → 0.5.0

package/dist/api/core/geom/query/halfedge.d.ts

@@ -0,0 +1,206 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../../../types";
+import { HalfEdgeHandle, VertexHandle, EdgeHandle, FaceHandle } from "../../../../handles";
+/**
+ * Half-edge queries — walk and read a single BREP half-edge (all-handle model, §11).
+ * A {@linkcode HalfEdgeHandle} is minted by walking from a brep/face/edge/vertex
+ * handle; it is session-ephemeral and goes stale on undo/redo/re-topologize.
+ *
+ * The kind token is all-lowercase `"halfedge"` (§6.1 — no camelCase namespaces).
+ * Traversals (`getNext`/`getPrev`/`getFlip`) return `null` on a boundary or a
+ * malformed chain rather than throwing (§6, reads never throw).
+ *
+ * Accessed via `snaptrude.core.geom.query.halfedge`.
+ */
+export declare abstract class PluginGeomQueryHalfEdgeApi {
+    constructor();
+    /**
+     * Get the next half-edge around the face loop.
+     * @param halfEdge The half-edge to walk from
+     * @returns The next half-edge as a {@linkcode HalfEdgeHandle}, or `null` on a malformed chain
+     *
+     * # Example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const brep = await snaptrude.design.query.geometry.getBrep(wall)
+     * if (brep) {
+     *   const [face] = await snaptrude.core.geom.query.brep.listFaces(brep)
+     *   const [he] = await snaptrude.core.geom.query.face.listHalfEdges(face)
+     *   const next = await snaptrude.core.geom.query.halfedge.getNext(he)
+     *   if (next) {
+     *     const vertex = await snaptrude.core.geom.query.halfedge.getVertex(next)
+     *   }
+     * }
+     * ```
+     */
+    abstract getNext(halfEdge: HalfEdgeHandle): PluginApiReturn<HalfEdgeHandle | null>;
+    /**
+     * Get the previous half-edge around the face loop.
+     * @param halfEdge The half-edge to walk from
+     * @returns The previous half-edge as a {@linkcode HalfEdgeHandle}, or `null` on a malformed chain
+     *
+     * # Example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const brep = await snaptrude.design.query.geometry.getBrep(wall)
+     * if (brep) {
+     *   const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
+     *   const prev = await snaptrude.core.geom.query.halfedge.getPrev(he)
+     *   if (prev) {
+     *     const edge = await snaptrude.core.geom.query.halfedge.getEdge(prev)
+     *   }
+     * }
+     * ```
+     */
+    abstract getPrev(halfEdge: HalfEdgeHandle): PluginApiReturn<HalfEdgeHandle | null>;
+    /**
+     * Get the flip (opposite) half-edge of the shared edge.
+     * @param halfEdge The half-edge to flip
+     * @returns The flip half-edge as a {@linkcode HalfEdgeHandle}, or `null` on a boundary
+     *
+     * # Example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const brep = await snaptrude.design.query.geometry.getBrep(wall)
+     * if (brep) {
+     *   const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
+     *   const flip = await snaptrude.core.geom.query.halfedge.getFlip(he)
+     *   if (flip) {
+     *     // cross the shared edge into the neighbouring face
+     *     const neighbourFace = await snaptrude.core.geom.query.halfedge.getFace(flip)
+     *   }
+     * }
+     * ```
+     */
+    abstract getFlip(halfEdge: HalfEdgeHandle): PluginApiReturn<HalfEdgeHandle | null>;
+    /**
+     * Get the tail vertex of a half-edge.
+     * @param halfEdge The half-edge to read
+     * @returns The vertex as a {@linkcode VertexHandle}
+     *
+     * # Example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const brep = await snaptrude.design.query.geometry.getBrep(wall)
+     * if (brep) {
+     *   const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
+     *   const vertex = await snaptrude.core.geom.query.halfedge.getVertex(he)
+     *   const pos = await snaptrude.core.geom.query.vertex.getPosition(brep, vertex)
+     * }
+     * ```
+     */
+    abstract getVertex(halfEdge: HalfEdgeHandle): PluginApiReturn<VertexHandle>;
+    /**
+     * Get the edge of a half-edge.
+     * @param halfEdge The half-edge to read
+     * @returns The edge as an {@linkcode EdgeHandle}
+     *
+     * # Example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const brep = await snaptrude.design.query.geometry.getBrep(wall)
+     * if (brep) {
+     *   const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
+     *   const edge = await snaptrude.core.geom.query.halfedge.getEdge(he)
+     *   const faces = await snaptrude.core.geom.query.edge.listFaces(edge)
+     * }
+     * ```
+     */
+    abstract getEdge(halfEdge: HalfEdgeHandle): PluginApiReturn<EdgeHandle>;
+    /**
+     * Get the face of a half-edge.
+     * @param halfEdge The half-edge to read
+     * @returns The face as a {@linkcode FaceHandle}
+     *
+     * # Example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const brep = await snaptrude.design.query.geometry.getBrep(wall)
+     * if (brep) {
+     *   const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
+     *   const face = await snaptrude.core.geom.query.halfedge.getFace(he)
+     *   const index = await snaptrude.core.geom.query.face.getIndex(face)
+     * }
+     * ```
+     */
+    abstract getFace(halfEdge: HalfEdgeHandle): PluginApiReturn<FaceHandle>;
+    /**
+     * Test whether a half-edge lies on the brep boundary (has no flip).
+     * @param halfEdge The half-edge to test
+     * @returns `true` if on the boundary, otherwise `false`
+     *
+     * # Example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const brep = await snaptrude.design.query.geometry.getBrep(wall)
+     * if (brep) {
+     *   const halfEdges = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
+     *   let boundary = 0
+     *   for (const he of halfEdges) {
+     *     if (await snaptrude.core.geom.query.halfedge.isOnBoundary(he)) boundary++
+     *   }
+     *   console.log("boundary half-edges:", boundary)
+     * }
+     * ```
+     */
+    abstract isOnBoundary(halfEdge: HalfEdgeHandle): PluginApiReturn<boolean>;
+    /**
+     * Test whether a half-edge is the forward (primary) half-edge of its edge —
+     * i.e. `edge.getHalfEdge() === thisHalfEdge`.
+     * @param halfEdge The half-edge to test
+     * @returns `true` if forward, otherwise `false`
+     *
+     * # Example
+     * ```ts
+     * const [wall] = await snaptrude.design.query.listWalls()
+     * const brep = await snaptrude.design.query.geometry.getBrep(wall)
+     * if (brep) {
+     *   const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
+     *   const forward = await snaptrude.core.geom.query.halfedge.isForward(he)
+     *   console.log(forward ? "primary half-edge" : "flip half-edge")
+     * }
+     * ```
+     */
+    abstract isForward(halfEdge: HalfEdgeHandle): PluginApiReturn<boolean>;
+}
+/** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getNext}. `{ halfEdge: HalfEdgeHandle }` */
+export declare const PluginGeomQueryHalfEdgeGetNextArgs: z.ZodObject<{
+    halfEdge: z.ZodPipe<z.ZodString, z.ZodTransform<import("../../../..").Handle<"halfedge">, string>>;
+}, z.core.$strip>;
+export type PluginGeomQueryHalfEdgeGetNextArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetNextArgs>;
+/** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getPrev}. `{ halfEdge: HalfEdgeHandle }` */
+export declare const PluginGeomQueryHalfEdgeGetPrevArgs: z.ZodObject<{
+    halfEdge: z.ZodPipe<z.ZodString, z.ZodTransform<import("../../../..").Handle<"halfedge">, string>>;
+}, z.core.$strip>;
+export type PluginGeomQueryHalfEdgeGetPrevArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetPrevArgs>;
+/** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getFlip}. `{ halfEdge: HalfEdgeHandle }` */
+export declare const PluginGeomQueryHalfEdgeGetFlipArgs: z.ZodObject<{
+    halfEdge: z.ZodPipe<z.ZodString, z.ZodTransform<import("../../../..").Handle<"halfedge">, string>>;
+}, z.core.$strip>;
+export type PluginGeomQueryHalfEdgeGetFlipArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetFlipArgs>;
+/** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getVertex}. `{ halfEdge: HalfEdgeHandle }` */
+export declare const PluginGeomQueryHalfEdgeGetVertexArgs: z.ZodObject<{
+    halfEdge: z.ZodPipe<z.ZodString, z.ZodTransform<import("../../../..").Handle<"halfedge">, string>>;
+}, z.core.$strip>;
+export type PluginGeomQueryHalfEdgeGetVertexArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetVertexArgs>;
+/** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getEdge}. `{ halfEdge: HalfEdgeHandle }` */
+export declare const PluginGeomQueryHalfEdgeGetEdgeArgs: z.ZodObject<{
+    halfEdge: z.ZodPipe<z.ZodString, z.ZodTransform<import("../../../..").Handle<"halfedge">, string>>;
+}, z.core.$strip>;
+export type PluginGeomQueryHalfEdgeGetEdgeArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetEdgeArgs>;
+/** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getFace}. `{ halfEdge: HalfEdgeHandle }` */
+export declare const PluginGeomQueryHalfEdgeGetFaceArgs: z.ZodObject<{
+    halfEdge: z.ZodPipe<z.ZodString, z.ZodTransform<import("../../../..").Handle<"halfedge">, string>>;
+}, z.core.$strip>;
+export type PluginGeomQueryHalfEdgeGetFaceArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetFaceArgs>;
+/** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.isOnBoundary}. `{ halfEdge: HalfEdgeHandle }` */
+export declare const PluginGeomQueryHalfEdgeIsOnBoundaryArgs: z.ZodObject<{
+    halfEdge: z.ZodPipe<z.ZodString, z.ZodTransform<import("../../../..").Handle<"halfedge">, string>>;
+}, z.core.$strip>;
+export type PluginGeomQueryHalfEdgeIsOnBoundaryArgs = z.infer<typeof PluginGeomQueryHalfEdgeIsOnBoundaryArgs>;
+/** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.isForward}. `{ halfEdge: HalfEdgeHandle }` */
+export declare const PluginGeomQueryHalfEdgeIsForwardArgs: z.ZodObject<{
+    halfEdge: z.ZodPipe<z.ZodString, z.ZodTransform<import("../../../..").Handle<"halfedge">, string>>;
+}, z.core.$strip>;
+export type PluginGeomQueryHalfEdgeIsForwardArgs = z.infer<typeof PluginGeomQueryHalfEdgeIsForwardArgs>;
+//# sourceMappingURL=halfedge.d.ts.map

package/dist/api/core/geom/query/halfedge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"halfedge.d.ts","sourceRoot":"","sources":["../../../../../src/api/core/geom/query/halfedge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAE1F;;;;;;;;;;GAUG;AACH,8BAAsB,0BAA0B;;IAG9C;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,cAAc,GAAG,IAAI,CAAC;IAEzF;;;;;;;;;;;;;;;;;OAiBG;aACa,OAAO,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,cAAc,GAAG,IAAI,CAAC;IAEzF;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,cAAc,GAAG,IAAI,CAAC;IAEzF;;;;;;;;;;;;;;;OAeG;aACa,SAAS,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,YAAY,CAAC;IAElF;;;;;;;;;;;;;;;OAeG;aACa,OAAO,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,UAAU,CAAC;IAE9E;;;;;;;;;;;;;;;OAeG;aACa,OAAO,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,UAAU,CAAC;IAE9E;;;;;;;;;;;;;;;;;;OAkBG;aACa,YAAY,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,OAAO,CAAC;IAEhF;;;;;;;;;;;;;;;;OAgBG;aACa,SAAS,CAAC,QAAQ,EAAE,cAAc,GAAG,eAAe,CAAC,OAAO,CAAC;CAC9E;AAID,mGAAmG;AACnG,eAAO,MAAM,kCAAkC;;iBAAQ,CAAA;AACvD,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG,mGAAmG;AACnG,eAAO,MAAM,kCAAkC;;iBAAQ,CAAA;AACvD,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG,mGAAmG;AACnG,eAAO,MAAM,kCAAkC;;iBAAQ,CAAA;AACvD,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG,qGAAqG;AACrG,eAAO,MAAM,oCAAoC;;iBAAQ,CAAA;AACzD,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAA;AAEvG,mGAAmG;AACnG,eAAO,MAAM,kCAAkC;;iBAAQ,CAAA;AACvD,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG,mGAAmG;AACnG,eAAO,MAAM,kCAAkC;;iBAAQ,CAAA;AACvD,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG,wGAAwG;AACxG,eAAO,MAAM,uCAAuC;;iBAAQ,CAAA;AAC5D,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED,qGAAqG;AACrG,eAAO,MAAM,oCAAoC;;iBAAQ,CAAA;AACzD,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAA"}

package/dist/api/core/geom/query/index.d.ts

@@ -0,0 +1,61 @@
+import { PluginGeomQueryCurveApi } from "./curve";
+import { PluginGeomQueryArcApi } from "./arc";
+import { PluginGeomQueryCircleApi } from "./circle";
+import { PluginGeomQueryProfileApi } from "./profile";
+import { PluginGeomQueryContourApi } from "./contour";
+import { PluginGeomQueryBrepApi } from "./brep";
+import { PluginGeomQueryFaceApi } from "./face";
+import { PluginGeomQueryEdgeApi } from "./edge";
+import { PluginGeomQueryHalfEdgeApi } from "./halfedge";
+import { PluginGeomQueryVertexApi } from "./vertex";
+/**
+ * Geometry-kernel query namespace — read geometry, topology, and relationships as
+ * plain values / child handles (all-handle model, §11). No query mutates its inputs.
+ *
+ * - {@linkcode PluginGeomQueryApi.curve} — shared line/arc queries + two-curve relationships
+ * - {@linkcode PluginGeomQueryApi.arc} — arc-specific reads
+ * - {@linkcode PluginGeomQueryApi.circle} — circle-specific reads
+ * - {@linkcode PluginGeomQueryApi.profile} — profile reads
+ * - {@linkcode PluginGeomQueryApi.contour} — contour reads (outer profile + holes)
+ * - {@linkcode PluginGeomQueryApi.brep} — BREP mesh topology + geometry
+ * - {@linkcode PluginGeomQueryApi.face} — BREP face reads
+ * - {@linkcode PluginGeomQueryApi.edge} — BREP edge reads
+ * - {@linkcode PluginGeomQueryApi.halfedge} — BREP half-edge walks
+ * - {@linkcode PluginGeomQueryApi.vertex} — BREP vertex reads
+ *
+ * Accessed via `snaptrude.core.geom.query`.
+ */
+export declare abstract class PluginGeomQueryApi {
+    /** Shared curve queries (line or arc) and relationships. See {@linkcode PluginGeomQueryCurveApi}. */
+    abstract curve: PluginGeomQueryCurveApi;
+    /** Arc-specific queries. See {@linkcode PluginGeomQueryArcApi}. */
+    abstract arc: PluginGeomQueryArcApi;
+    /** Circle-specific queries. See {@linkcode PluginGeomQueryCircleApi}. */
+    abstract circle: PluginGeomQueryCircleApi;
+    /** Profile queries. See {@linkcode PluginGeomQueryProfileApi}. */
+    abstract profile: PluginGeomQueryProfileApi;
+    /** Contour queries. See {@linkcode PluginGeomQueryContourApi}. */
+    abstract contour: PluginGeomQueryContourApi;
+    /** BREP mesh topology + geometry queries. See {@linkcode PluginGeomQueryBrepApi}. */
+    abstract brep: PluginGeomQueryBrepApi;
+    /** BREP face queries. See {@linkcode PluginGeomQueryFaceApi}. */
+    abstract face: PluginGeomQueryFaceApi;
+    /** BREP edge queries. See {@linkcode PluginGeomQueryEdgeApi}. */
+    abstract edge: PluginGeomQueryEdgeApi;
+    /** BREP half-edge walks. See {@linkcode PluginGeomQueryHalfEdgeApi}. */
+    abstract halfedge: PluginGeomQueryHalfEdgeApi;
+    /** BREP vertex queries. See {@linkcode PluginGeomQueryVertexApi}. */
+    abstract vertex: PluginGeomQueryVertexApi;
+    constructor();
+}
+export * from "./curve";
+export * from "./arc";
+export * from "./circle";
+export * from "./profile";
+export * from "./contour";
+export * from "./brep";
+export * from "./face";
+export * from "./edge";
+export * from "./halfedge";
+export * from "./vertex";
+//# sourceMappingURL=index.d.ts.map

package/dist/api/core/geom/query/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/api/core/geom/query/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAA;AAC7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAA;AACnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AACrD,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAA;AAEnD;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,kBAAkB;IACtC,qGAAqG;IACrG,SAAgB,KAAK,EAAE,uBAAuB,CAAA;IAC9C,mEAAmE;IACnE,SAAgB,GAAG,EAAE,qBAAqB,CAAA;IAC1C,yEAAyE;IACzE,SAAgB,MAAM,EAAE,wBAAwB,CAAA;IAChD,kEAAkE;IAClE,SAAgB,OAAO,EAAE,yBAAyB,CAAA;IAClD,kEAAkE;IAClE,SAAgB,OAAO,EAAE,yBAAyB,CAAA;IAClD,qFAAqF;IACrF,SAAgB,IAAI,EAAE,sBAAsB,CAAA;IAC5C,iEAAiE;IACjE,SAAgB,IAAI,EAAE,sBAAsB,CAAA;IAC5C,iEAAiE;IACjE,SAAgB,IAAI,EAAE,sBAAsB,CAAA;IAC5C,wEAAwE;IACxE,SAAgB,QAAQ,EAAE,0BAA0B,CAAA;IACpD,qEAAqE;IACrE,SAAgB,MAAM,EAAE,wBAAwB,CAAA;;CAGjD;AAED,cAAc,SAAS,CAAA;AACvB,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA"}