@snaptrude/plugin-core 0.9.13 → 0.9.15

package/src/api/core/geom/query/brep.ts

@@ -174,16 +174,26 @@ export abstract class PluginGeomQueryBrepApi {
    * | `"line"` | `startPoint`, `endPoint`, `length` |
    * | `"arc"` | `startPoint`, `endPoint`, `centre`, `axis`, `radius`, `length` |
    * | `"circle"` | `centre`, `axis`, `radius`, `length` — a full-circle edge (e.g. a cylinder cap rim) |
+   * | `"spline"` | `startPoint`, `endPoint`, `degree`, `controlPoints`, `knots`, `length` — a free-form NURBS edge |
+   *
+   * For a `"spline"` edge, `knots` is the **expanded** knot vector — each knot
+   * repeated by its multiplicity, the textbook NURBS form — so
+   * `knots.length === controlPoints.length + degree + 1`.
    *
    * @param brep The brep the edge belongs to
    * @param edge The edge whose curve to read
    * @returns The curve data as a discriminated union on `type` (see table above)
    * @throws VALIDATION if the edge is not on `brep`
+   * @throws PRECONDITION_FAILED if the edge is a RATIONAL (weighted) spline —
+   *   e.g. a NURBS-converted elliptical intersection edge. The wire form
+   *   carries no weights, so such an edge is refused rather than reported as a
+   *   different curve; sample it instead.
    *
    * @examplePrompt Read the radius of this curved edge
    * @examplePrompt Is this edge straight or an arc?
    * @examplePrompt Get the exact start and end points of this edge
    * @examplePrompt Measure the length of each edge of this mass
+   * @examplePrompt Read the control points of this curved edge
    *
    * # Example
    * ```ts
@@ -219,6 +229,16 @@ export abstract class PluginGeomQueryBrepApi {
         radius: number
         length: number
       }
+    | {
+        type: "spline"
+        startPoint: Vec3Components
+        endPoint: Vec3Components
+        degree: number
+        controlPoints: Vec3Components[]
+        /** Expanded by multiplicity: `controlPoints.length + degree + 1` entries. */
+        knots: number[]
+        length: number
+      }
   >
 
   /**
@@ -263,7 +283,10 @@ export abstract class PluginGeomQueryBrepApi {
   public abstract listVertexPositions(brep: BrepHandle): PluginApiReturn<Vec3Components[]>
 
   /**
-   * Get the centroid (mean of all vertex positions) of a brep.
+   * Get the centroid of a brep: the mean of its vertex positions for planar
+   * and cylinder-sided solids; for a solid with sphere, cone, torus or spline
+   * geometry, its exact centre of mass (integrated over the surfaces; the
+   * vertex mean again if the kernel cannot integrate it, e.g. an open brep).
    * @param brep The brep to query
    * @returns The centroid as {@linkcode Vec3Components}
    *
@@ -366,6 +389,37 @@ export abstract class PluginGeomQueryBrepApi {
    */
   public abstract getBoundingBox(brep: BrepHandle): PluginApiReturn<BBoxComponents>
 
+  /**
+   * Get the enclosed **volume** of a closed solid, integrated from its exact
+   * surfaces. Curved faces are measured analytically, not from their
+   * tessellation — a real sphere of radius 5 reports 523.6, whatever its
+   * triangle count. That makes this the reliable way to confirm a solid is the
+   * shape you intended (a torus should measure 2·π²·R·r²).
+   *
+   * Runs on the OpenCascade kernel (the first kernel call loads a wasm of tens
+   * of MB — expect a pause of seconds).
+   *
+   * @param brep The solid to measure
+   * @returns The enclosed volume in cubic internal length units
+   * @throws OPERATION_FAILED if the kernel cannot compute the volume (the brep
+   *   is not a closed solid)
+   *
+   * @examplePrompt What is the volume of this mass?
+   * @examplePrompt How much concrete is in this shape?
+   * @examplePrompt Check the volume of the dome I just made
+   *
+   * # Example
+   * ```ts
+   * const [mass] = await snaptrude.design.query.listMasses()
+   * const brep = await snaptrude.design.query.geometry.getBrep(mass)
+   * if (brep) {
+   *   const volume = await snaptrude.core.geom.query.brep.getVolume(brep)
+   *   console.log("volume:", volume)
+   * }
+   * ```
+   */
+  public abstract getVolume(brep: BrepHandle): PluginApiReturn<number>
+
   /**
    * Test whether two breps are geometrically equal.
    * @param brepA First brep
@@ -388,7 +442,7 @@ export abstract class PluginGeomQueryBrepApi {
   public abstract isEqual(brepA: BrepHandle, brepB: BrepHandle): PluginApiReturn<boolean>
 
   /**
-   * Measures the minimum distance between two solids, with the closest witness
+   * Measures the minimum distance between two solids, with the closest
    * point on each. Touching or overlapping solids report a distance of 0 with
    * contact points.
    *
@@ -534,6 +588,10 @@ export type PluginGeomQueryBrepGetBoundingBoxArgs = z.infer<
   typeof PluginGeomQueryBrepGetBoundingBoxArgs
 >
 
+/** Arguments for {@linkcode PluginGeomQueryBrepApi.getVolume}. `{ brep: BrepHandle }` */
+export const PluginGeomQueryBrepGetVolumeArgs = brepArg
+export type PluginGeomQueryBrepGetVolumeArgs = z.infer<typeof PluginGeomQueryBrepGetVolumeArgs>
+
 /**
  * Arguments for {@linkcode PluginGeomQueryBrepApi.isEqual}.
  *

package/src/api/core/geom/query/curve.ts

@@ -3,8 +3,8 @@ import { PluginApiReturn } from "../../../../types"
 import { Vec3Handle, CurveHandle, LineHandle, Vec3Components } from "../../../../handles"
 
 /**
- * Curve queries — read-only geometric questions about curves (lines and arcs)
- * and the relationships between two curves (all-handle model, §11).
+ * Curve queries — read-only geometric questions about curves (lines, arcs and
+ * splines) and the relationships between two curves.
  *
  * Every method takes opaque curve handles ({@linkcode CurveHandle}/{@linkcode LineHandle})
  * and point handles ({@linkcode Vec3Handle}) and returns plain values — points as
@@ -13,6 +13,30 @@ import { Vec3Handle, CurveHandle, LineHandle, Vec3Components } from "../../../..
  * {@linkcode CurveHandle} (or `null` when there is no result). No query mutates its
  * inputs.
  *
+ * ## Splines
+ *
+ * A {@linkcode CurveHandle} is a line, an arc, or a NURBS spline (minted by
+ * `core.geom.create.splineFromPoints` / `splineFromControlPoints`, and returned by
+ * `edge.getCurve`, `profile.listCurves` and `update.curve.reverse` for a spline run). Every method here accepts a spline at
+ * compile time, but only the reads backed by the engine's spline math answer
+ * for one today. The rest throw `PRECONDITION_FAILED` ("not supported for
+ * splines yet") — a typed refusal, never a quietly wrong answer.
+ *
+ * | Splines | Members |
+ * |---|---|
+ * | **supported** | {@linkcode PluginGeomQueryCurveApi.getStartPoint}, {@linkcode PluginGeomQueryCurveApi.getEndPoint}, {@linkcode PluginGeomQueryCurveApi.getLength}, {@linkcode PluginGeomQueryCurveApi.getTangent}, {@linkcode PluginGeomQueryCurveApi.listPoints}, {@linkcode PluginGeomQueryCurveApi.getNearestPoint} |
+ * | **not yet** | `getMidPoint`, `getChordLength`, `getNormal`, `getProjection`, `getPointAtDistance`, `getParameterAtPoint`, `getCurvature`, `getDistanceToPoint`, `getDistanceAlong`, `listSubdivisions`, `isLinear`, `isOnCurve`, `hasPoint`, `isEqual`, `isOverlapping`, `getCommonPart`, `listIntersections`, `getMergedCurve`, `isContinuous`, `isParallel`, `getShortestGap`, `getDistanceBetween` |
+ *
+ * {@linkcode PluginGeomQueryCurveApi.isOverlapping} is deliberately in the
+ * second row: its line/arc path falls back to structural equality, which would
+ * answer a spline pair wrongly rather than not at all.
+ *
+ * To work around the second row, sample the curve —
+ * {@linkcode PluginGeomQueryCurveApi.listPoints} then the ordinary
+ * `core.math.vec3` operations — or read a spline brep edge exactly with
+ * `core.geom.query.brep.getEdgeCurve`, which returns its degree, control points
+ * and knots.
+ *
  * Accessed via `snaptrude.core.geom.query.curve`.
  */
 export abstract class PluginGeomQueryCurveApi {

package/src/api/core/geom/query/edge.ts

@@ -69,9 +69,9 @@ export abstract class PluginGeomQueryEdgeApi {
   public abstract listVertices(edge: EdgeHandle): PluginApiReturn<VertexHandle[]>
 
   /**
-   * Get the underlying curve geometry of an edge (a line or arc).
+   * Get the underlying curve geometry of an edge (a line, arc or spline).
    * @param edge The edge to query
-   * @returns The curve as a {@linkcode CurveHandle}, or `null` if it is a circle or unset
+   * @returns The curve as a {@linkcode CurveHandle} (`line_`, `arc_` or `spline_`), or `null` if it is a circle or unset
    *
    * # Example
    * ```ts

package/src/api/core/geom/query/face.ts

@@ -59,6 +59,49 @@ export abstract class PluginGeomQueryFaceApi {
    */
   public abstract getMaterialIndex(face: FaceHandle): PluginApiReturn<number>
 
+  /**
+   * Read what KIND of surface a face lies on. This is the one read that tells a
+   * genuinely curved face from a faceted approximation of one: every face of a
+   * 200-triangle "dome" answers `"plane"`, while a real dome has faces
+   * answering `"sphere"`. Use it to confirm a curved solid actually came out
+   * curved.
+   *
+   * | Value | Surface |
+   * |---|---|
+   * | `"plane"` | Flat face |
+   * | `"cylinder"` | Cylindrical face — constant radius about an axis |
+   * | `"cone"` | Conical face — a tapered ring (a cone or frustum side) |
+   * | `"sphere"` | Spherical face |
+   * | `"torus"` | Toroidal face — the ring surface of a donut |
+   * | `"spline"` | Free-form NURBS face |
+   *
+   * Pure read: no geometry kernel is loaded.
+   *
+   * @param face The face to query
+   * @returns The surface kind (see the table), or `null` when the face carries
+   *   no surface classification
+   *
+   * @examplePrompt Is this face flat or curved?
+   * @examplePrompt Check that this dome is a real sphere, not a faceted approximation
+   * @examplePrompt What kind of surface is this face?
+   * @examplePrompt How many curved faces does this mass have?
+   *
+   * # Example
+   * ```ts
+   * const [mass] = await snaptrude.design.query.listMasses()
+   * const brep = await snaptrude.design.query.geometry.getBrep(mass)
+   * if (brep) {
+   *   const faces = await snaptrude.core.geom.query.brep.listFaces(brep)
+   *   const kinds = []
+   *   for (const face of faces) kinds.push(await snaptrude.core.geom.query.face.getSurfaceKind(face))
+   *   console.log("spherical faces:", kinds.filter((k) => k === "sphere").length)
+   * }
+   * ```
+   */
+  public abstract getSurfaceKind(
+    face: FaceHandle,
+  ): PluginApiReturn<"plane" | "cylinder" | "cone" | "sphere" | "torus" | "spline" | null>
+
   /**
    * Get a seed half-edge of a face's outer loop.
    * @param face The face to query
@@ -257,6 +300,56 @@ export abstract class PluginGeomQueryFaceApi {
     brep: BrepHandle,
   ): PluginApiReturn<Vec3Components[]>
 
+  /**
+   * Exact surface area of one face of `brep`, in internal length units SQUARED —
+   * integrated off the face's own surface, not its facets, so a curved patch
+   * reads exactly rather than as its triangles. Needs the parent brep: a face
+   * handle cannot name its own solid.
+   * @param face The face to measure
+   * @param brep The parent brep (owner last, as in
+   *   {@linkcode PluginGeomQueryFaceApi.listVertexPositions})
+   * @returns The area as a `number`
+   * @throws VALIDATION if `face` is not a face of `brep`
+   * @throws OPERATION_FAILED if the kernel could not measure the face
+   *
+   * @examplePrompt How big is this roof patch?
+   * @examplePrompt Which face of this mass has the largest area?
+   *
+   * # Example
+   * ```ts
+   * const [mass] = await snaptrude.design.query.listMasses()
+   * const brep = await snaptrude.design.query.geometry.getBrep(mass)
+   * if (brep) {
+   *   const faces = await snaptrude.core.geom.query.brep.listFaces(brep)
+   *   const areas = await Promise.all(
+   *     faces.map((f) => snaptrude.core.geom.query.face.getArea(f, brep)),
+   *   )
+   * }
+   * ```
+   */
+  public abstract getArea(face: FaceHandle, brep: BrepHandle): PluginApiReturn<number>
+
+  /**
+   * Centre of area of one face of `brep`, as a point in that brep's frame
+   * (internal length units). On a solid whose every face reads `"spline"` this
+   * is the read that tells two patches apart — the top of a thickened patch from
+   * its bottom, one quarter of a closed surface from the next.
+   * @param face The face to measure
+   * @param brep The parent brep (owner last)
+   * @returns The centroid as {@linkcode Vec3Components}
+   * @throws VALIDATION if `face` is not a face of `brep`
+   * @throws OPERATION_FAILED if the kernel could not measure the face
+   *
+   * @examplePrompt Where is the middle of this face?
+   * @examplePrompt Pick the topmost face of this curved mass
+   *
+   * # Example
+   * ```ts
+   * const centre = await snaptrude.core.geom.query.face.getCentroid(face, brep)
+   * ```
+   */
+  public abstract getCentroid(face: FaceHandle, brep: BrepHandle): PluginApiReturn<Vec3Components>
+
   /**
    * List the tessellated boundary points of a face's outer loop (arcs sampled,
    * sense-corrected). Not cardinality-equal to {@linkcode PluginGeomQueryFaceApi.listVertexPositions}.
@@ -301,6 +394,7 @@ export abstract class PluginGeomQueryFaceApi {
 }
 
 const faceArg = z.object({ face: FaceHandle })
+const faceWithBrepArg = z.object({ face: FaceHandle, brep: BrepHandle })
 
 /** Arguments for {@linkcode PluginGeomQueryFaceApi.getIndex}. `{ face: FaceHandle }` */
 export const PluginGeomQueryFaceGetIndexArgs = faceArg
@@ -312,6 +406,12 @@ export type PluginGeomQueryFaceGetMaterialIndexArgs = z.infer<
   typeof PluginGeomQueryFaceGetMaterialIndexArgs
 >
 
+/** Arguments for {@linkcode PluginGeomQueryFaceApi.getSurfaceKind}. `{ face: FaceHandle }` */
+export const PluginGeomQueryFaceGetSurfaceKindArgs = faceArg
+export type PluginGeomQueryFaceGetSurfaceKindArgs = z.infer<
+  typeof PluginGeomQueryFaceGetSurfaceKindArgs
+>
+
 /** Arguments for {@linkcode PluginGeomQueryFaceApi.getHalfEdge}. `{ face: FaceHandle }` */
 export const PluginGeomQueryFaceGetHalfEdgeArgs = faceArg
 export type PluginGeomQueryFaceGetHalfEdgeArgs = z.infer<typeof PluginGeomQueryFaceGetHalfEdgeArgs>
@@ -382,14 +482,19 @@ export type PluginGeomQueryFaceGetHoleContainingHalfEdgeArgs = z.infer<
  * | `face` | {@linkcode FaceHandle} | The face to query |
  * | `brep` | {@linkcode BrepHandle} | The parent brep (source of vertex coordinates) |
  */
-export const PluginGeomQueryFaceListVertexPositionsArgs = z.object({
-  face: FaceHandle,
-  brep: BrepHandle,
-})
+export const PluginGeomQueryFaceListVertexPositionsArgs = faceWithBrepArg
 export type PluginGeomQueryFaceListVertexPositionsArgs = z.infer<
   typeof PluginGeomQueryFaceListVertexPositionsArgs
 >
 
+/** Arguments for {@linkcode PluginGeomQueryFaceApi.getArea}. `{ face: FaceHandle, brep: BrepHandle }` */
+export const PluginGeomQueryFaceGetAreaArgs = faceWithBrepArg
+export type PluginGeomQueryFaceGetAreaArgs = z.infer<typeof PluginGeomQueryFaceGetAreaArgs>
+
+/** Arguments for {@linkcode PluginGeomQueryFaceApi.getCentroid}. `{ face: FaceHandle, brep: BrepHandle }` */
+export const PluginGeomQueryFaceGetCentroidArgs = faceWithBrepArg
+export type PluginGeomQueryFaceGetCentroidArgs = z.infer<typeof PluginGeomQueryFaceGetCentroidArgs>
+
 /** Arguments for {@linkcode PluginGeomQueryFaceApi.listVertexPositionsWithCurves}. `{ face: FaceHandle }` */
 export const PluginGeomQueryFaceListVertexPositionsWithCurvesArgs = faceArg
 export type PluginGeomQueryFaceListVertexPositionsWithCurvesArgs = z.infer<

package/src/api/core/geom/update/contour.ts

@@ -29,6 +29,8 @@ export abstract class PluginGeomUpdateContourApi {
    * @param contour The contour to offset
    * @param distance Signed offset distance (outward when positive, inward when negative)
    * @returns The offset contour as a NEW {@linkcode ContourHandle}
+   * @throws PRECONDITION_FAILED if the outline or a hole has a spline run
+   *   (splines cannot be offset yet)
    *
    * @examplePrompt Offset this boundary 500mm inward
    * @examplePrompt Shrink this floor outline by half a metre all around

package/src/api/core/geom/update/profile.ts

@@ -28,6 +28,8 @@ export abstract class PluginGeomUpdateProfileApi {
    * @param profile The closed profile to offset
    * @param distance Signed offset distance (outward when positive, inward when negative)
    * @returns The offset profile as a NEW {@linkcode ProfileHandle}
+   * @throws PRECONDITION_FAILED if the profile has a spline run (splines cannot
+   *   be offset yet)
    *
    * @examplePrompt Offset this outline 300mm inward
    * @examplePrompt Inset this boundary by a foot all around

package/src/api/core/handles/index.ts

@@ -6,7 +6,7 @@ import type { AnyArenaHandle } from "../../../handles"
 import { Handle } from "../../../handles"
 
 /**
- * The 12 registry-arena handle kinds — the releasable families. Entity-style
+ * The 13 registry-arena handle kinds — the releasable families. Entity-style
  * handles (component / material / underlay / terrain / importJob / comment) are
  * raw engine ids with no arena entry and therefore no lifecycle: passing one to
  * `release` is a silent no-op like any other unknown id.
@@ -16,6 +16,7 @@ export const ArenaKind = z.enum([
   "quat",
   "line",
   "arc",
+  "spline",
   "circle",
   "profile",
   "contour",
@@ -216,7 +217,7 @@ export type PluginHandlesEndScopeArgs = z.infer<typeof PluginHandlesEndScopeArgs
  * | Property | Type | Description |
  * |---|---|---|
  * | `resources` | `number` | Live resource-arena entries (profile/contour) |
- * | `values` | `number` | Live value-arena entries (vec3/quat/line/arc/circle) |
+ * | `values` | `number` | Live value-arena entries (vec3/quat/line/arc/spline/circle) |
  * | `topology` | `number` | Live topology-arena entries (brep/face/edge/halfedge/vertex) |
  * | `scopes` | `number` | Currently open handle scopes |
  * | `hostHeapUsedBytes` | `number \| null` | Host page `usedJSHeapSize` (null where unsupported) |

package/src/api/core/index.ts

@@ -31,8 +31,8 @@ import { PluginUserApi } from "./user"
  * - {@linkcode PluginCoreApi.comment} — Comments: create, edit, resolve, tag, list
  * - {@linkcode PluginCoreApi.groups} — Read & edit the group hierarchy
  * - {@linkcode PluginCoreApi.buildings} — Read & edit buildings and their storeys
- * - {@linkcode PluginCoreApi.storeys} — Create, read & edit storeys (floors)
- * - {@linkcode PluginCoreApi.layers} — Read & toggle storey drawing/reference layers
+ * - {@linkcode PluginCoreApi.storeys} — Create, read & edit storeys (floors); `storeys.layers` reads & toggles each storey's sketch surfaces and underlays
+ * - {@linkcode PluginCoreApi.layers} — The Layers panel in the left sidebar: list, create, rename, lock, hide, activate, delete, move objects between layers
  * - {@linkcode PluginCoreApi.tags} — Tag catalog + assignment
  * - {@linkcode PluginCoreApi.io} — Import files (image/pdf/cad/model/terrain), poll jobs, manage underlays
  * - {@linkcode PluginCoreApi.handles} — Handle lifecycle: release, releaseAll, scopes
@@ -61,11 +61,11 @@ export abstract class PluginCoreApi {
   public abstract groups: PluginCoreGroupsApi
   /** Buildings — read & edit buildings and their storeys. See {@linkcode PluginCoreBuildingsApi}. */
   public abstract buildings: PluginCoreBuildingsApi
-  /** Storeys — create, read & edit storeys (floors). See {@linkcode PluginCoreStoreysApi}. */
+  /** Storeys — create, read & edit storeys (floors), plus each storey's sketch surfaces and underlays (`storeys.layers`). See {@linkcode PluginCoreStoreysApi}. */
   public abstract storeys: PluginCoreStoreysApi
   /** Application mode — read & switch the editor's top-bar mode. See {@linkcode PluginCoreModeApi}. */
   public abstract mode: PluginCoreModeApi
-  /** Layers — read & toggle storey drawing/reference layers. See {@linkcode PluginCoreLayersApi}. */
+  /** Layers — the Layers panel's layers: list, create, rename, lock, hide, activate, delete, assign objects. See {@linkcode PluginCoreLayersApi}. */
   public abstract layers: PluginCoreLayersApi
   /** Tags — tag catalog + assignment. See {@linkcode PluginCoreTagsApi}. */
   public abstract tags: PluginCoreTagsApi