@snaptrude/plugin-core 0.9.17 → 0.9.18-edgesetbacks-20261021.1

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

@@ -1,209 +1,209 @@
-import * as z from "zod"
-import { PluginApiReturn } from "../../../../types"
-import { Vec3Handle, CurveHandle } from "../../../../handles"
-
-/**
- * Curve editing — produce NEW curves from an existing one (all-handle model, §11).
- *
- * Every method takes an opaque {@linkcode CurveHandle} and returns a fresh handle
- * (or handles) for the resulting geometry; the input curve is never mutated. Read
- * the resulting geometry back as plain values with the query namespace.
- *
- * Accessed via `snaptrude.core.geom.update.curve`.
- */
-export abstract class PluginGeomUpdateCurveApi {
-  constructor() {}
-
-  /**
-   * Extend a curve by a distance from one of its ends. Host API call — returns a handle.
-   *
-   * @param curve - The curve to extend
-   * @param distance - Distance to extend the curve by
-   * @param fromStart - Extend from the start end when `true`, otherwise from the end
-   * @returns The extended curve as a {@linkcode CurveHandle}
-   *
-   * @examplePrompt Extend this line by 1 metre
-   * @examplePrompt Lengthen this edge from its start point
-   *
-   * # Example
-   * ```ts
-   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
-   * const b = await snaptrude.core.math.vec3.new(5, 0, 0)
-   * const line = await snaptrude.core.geom.create.line(a, b)
-   * const longer = await snaptrude.core.geom.update.curve.extend(line, 1, false)
-   * const length = await snaptrude.core.geom.query.curve.getLength(longer) // 6
-   * ```
-   */
-  public abstract extend(
-    curve: CurveHandle,
-    distance: number,
-    fromStart: boolean,
-  ): PluginApiReturn<CurveHandle>
-
-  /**
-   * Split a curve at a point into separate segments. Host API call — returns handles.
-   *
-   * @param curve - The curve to split
-   * @param point - Point on the curve to split at
-   * @returns The resulting segments as {@linkcode CurveHandle}`[]`
-   *
-   * @examplePrompt Split this line at its midpoint
-   * @examplePrompt Break this edge into two pieces where it meets the gridline
-   *
-   * # Example
-   * ```ts
-   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
-   * const b = await snaptrude.core.math.vec3.new(6, 0, 0)
-   * const line = await snaptrude.core.geom.create.line(a, b)
-   * const mid = await snaptrude.core.math.vec3.new(3, 0, 0)
-   * const [left, right] = await snaptrude.core.geom.update.curve.split(line, mid)
-   * ```
-   */
-  public abstract split(
-    curve: CurveHandle,
-    point: Vec3Handle,
-  ): PluginApiReturn<CurveHandle[]>
-
-  /**
-   * Trim a curve to the portion between two parameter values. Host API call — returns a handle.
-   *
-   * @param curve - The curve to trim
-   * @param startParam - Start parameter of the portion to keep
-   * @param endParam - End parameter of the portion to keep
-   * @returns The trimmed curve as a {@linkcode CurveHandle}
-   *
-   * @examplePrompt Trim this line back to a shorter segment
-   * @examplePrompt Keep only the middle portion of this curve
-   *
-   * # Example
-   * ```ts
-   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
-   * const b = await snaptrude.core.math.vec3.new(10, 0, 0)
-   * const line = await snaptrude.core.geom.create.line(a, b)
-   * const middle = await snaptrude.core.geom.update.curve.trim(line, 0.25, 0.75)
-   * ```
-   */
-  public abstract trim(
-    curve: CurveHandle,
-    startParam: number,
-    endParam: number,
-  ): PluginApiReturn<CurveHandle>
-
-  /**
-   * Offset a curve by a translation vector. Host API call — returns a handle.
-   *
-   * @param curve - The curve to offset
-   * @param vector - Translation vector to offset the curve by
-   * @returns The offset curve as a {@linkcode CurveHandle}
-   *
-   * @examplePrompt Offset this line 500mm to the side
-   * @examplePrompt Shift this edge over to make a parallel copy
-   *
-   * # Example
-   * ```ts
-   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
-   * const b = await snaptrude.core.math.vec3.new(8, 0, 0)
-   * const line = await snaptrude.core.geom.create.line(a, b)
-   * const sideways = await snaptrude.core.math.vec3.new(0, 0, 0.5)
-   * const parallel = await snaptrude.core.geom.update.curve.offset(line, sideways)
-   * ```
-   */
-  public abstract offset(
-    curve: CurveHandle,
-    vector: Vec3Handle,
-  ): PluginApiReturn<CurveHandle>
-
-  /**
-   * Reverse the direction of a curve. Host API call — returns a handle.
-   *
-   * @param curve - The curve to reverse
-   * @returns The reversed curve as a {@linkcode CurveHandle}
-   *
-   * # Example
-   * ```ts
-   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
-   * const b = await snaptrude.core.math.vec3.new(4, 0, 0)
-   * const line = await snaptrude.core.geom.create.line(a, b)
-   * const reversed = await snaptrude.core.geom.update.curve.reverse(line)
-   * const start = await snaptrude.core.geom.query.curve.getStartPoint(reversed) // { x: 4, y: 0, z: 0 }
-   * ```
-   */
-  public abstract reverse(curve: CurveHandle): PluginApiReturn<CurveHandle>
-}
-
-/**
- * Arguments for {@linkcode PluginGeomUpdateCurveApi.extend}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `curve` | {@linkcode CurveHandle} | The curve to extend |
- * | `distance` | `number` | Distance to extend the curve by |
- * | `fromStart` | `boolean` | Extend from the start end when `true`, otherwise from the end |
- */
-export const PluginGeomUpdateCurveExtendArgs = z.object({
-  curve: CurveHandle,
-  distance: z.number(),
-  fromStart: z.boolean(),
-})
-
-export type PluginGeomUpdateCurveExtendArgs = z.infer<typeof PluginGeomUpdateCurveExtendArgs>
-
-/**
- * Arguments for {@linkcode PluginGeomUpdateCurveApi.split}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `curve` | {@linkcode CurveHandle} | The curve to split |
- * | `point` | {@linkcode Vec3Handle} | Point on the curve to split at |
- */
-export const PluginGeomUpdateCurveSplitArgs = z.object({
-  curve: CurveHandle,
-  point: Vec3Handle,
-})
-
-export type PluginGeomUpdateCurveSplitArgs = z.infer<typeof PluginGeomUpdateCurveSplitArgs>
-
-/**
- * Arguments for {@linkcode PluginGeomUpdateCurveApi.trim}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `curve` | {@linkcode CurveHandle} | The curve to trim |
- * | `startParam` | `number` | Start parameter of the portion to keep |
- * | `endParam` | `number` | End parameter of the portion to keep |
- */
-export const PluginGeomUpdateCurveTrimArgs = z.object({
-  curve: CurveHandle,
-  startParam: z.number(),
-  endParam: z.number(),
-})
-
-export type PluginGeomUpdateCurveTrimArgs = z.infer<typeof PluginGeomUpdateCurveTrimArgs>
-
-/**
- * Arguments for {@linkcode PluginGeomUpdateCurveApi.offset}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `curve` | {@linkcode CurveHandle} | The curve to offset |
- * | `vector` | {@linkcode Vec3Handle} | Translation vector to offset the curve by |
- */
-export const PluginGeomUpdateCurveOffsetArgs = z.object({
-  curve: CurveHandle,
-  vector: Vec3Handle,
-})
-
-export type PluginGeomUpdateCurveOffsetArgs = z.infer<typeof PluginGeomUpdateCurveOffsetArgs>
-
-/**
- * Arguments for {@linkcode PluginGeomUpdateCurveApi.reverse}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `curve` | {@linkcode CurveHandle} | The curve to reverse |
- */
-export const PluginGeomUpdateCurveReverseArgs = z.object({
-  curve: CurveHandle,
-})
-
-export type PluginGeomUpdateCurveReverseArgs = z.infer<typeof PluginGeomUpdateCurveReverseArgs>
+import * as z from "zod"
+import { PluginApiReturn } from "../../../../types"
+import { Vec3Handle, CurveHandle } from "../../../../handles"
+
+/**
+ * Curve editing — produce NEW curves from an existing one (all-handle model, §11).
+ *
+ * Every method takes an opaque {@linkcode CurveHandle} and returns a fresh handle
+ * (or handles) for the resulting geometry; the input curve is never mutated. Read
+ * the resulting geometry back as plain values with the query namespace.
+ *
+ * Accessed via `snaptrude.core.geom.update.curve`.
+ */
+export abstract class PluginGeomUpdateCurveApi {
+  constructor() {}
+
+  /**
+   * Extend a curve by a distance from one of its ends. Host API call — returns a handle.
+   *
+   * @param curve - The curve to extend
+   * @param distance - Distance to extend the curve by
+   * @param fromStart - Extend from the start end when `true`, otherwise from the end
+   * @returns The extended curve as a {@linkcode CurveHandle}
+   *
+   * @examplePrompt Extend this line by 1 metre
+   * @examplePrompt Lengthen this edge from its start point
+   *
+   * # Example
+   * ```ts
+   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
+   * const b = await snaptrude.core.math.vec3.new(5, 0, 0)
+   * const line = await snaptrude.core.geom.create.line(a, b)
+   * const longer = await snaptrude.core.geom.update.curve.extend(line, 1, false)
+   * const length = await snaptrude.core.geom.query.curve.getLength(longer) // 6
+   * ```
+   */
+  public abstract extend(
+    curve: CurveHandle,
+    distance: number,
+    fromStart: boolean,
+  ): PluginApiReturn<CurveHandle>
+
+  /**
+   * Split a curve at a point into separate segments. Host API call — returns handles.
+   *
+   * @param curve - The curve to split
+   * @param point - Point on the curve to split at
+   * @returns The resulting segments as {@linkcode CurveHandle}`[]`
+   *
+   * @examplePrompt Split this line at its midpoint
+   * @examplePrompt Break this edge into two pieces where it meets the gridline
+   *
+   * # Example
+   * ```ts
+   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
+   * const b = await snaptrude.core.math.vec3.new(6, 0, 0)
+   * const line = await snaptrude.core.geom.create.line(a, b)
+   * const mid = await snaptrude.core.math.vec3.new(3, 0, 0)
+   * const [left, right] = await snaptrude.core.geom.update.curve.split(line, mid)
+   * ```
+   */
+  public abstract split(
+    curve: CurveHandle,
+    point: Vec3Handle,
+  ): PluginApiReturn<CurveHandle[]>
+
+  /**
+   * Trim a curve to the portion between two parameter values. Host API call — returns a handle.
+   *
+   * @param curve - The curve to trim
+   * @param startParam - Start parameter of the portion to keep
+   * @param endParam - End parameter of the portion to keep
+   * @returns The trimmed curve as a {@linkcode CurveHandle}
+   *
+   * @examplePrompt Trim this line back to a shorter segment
+   * @examplePrompt Keep only the middle portion of this curve
+   *
+   * # Example
+   * ```ts
+   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
+   * const b = await snaptrude.core.math.vec3.new(10, 0, 0)
+   * const line = await snaptrude.core.geom.create.line(a, b)
+   * const middle = await snaptrude.core.geom.update.curve.trim(line, 0.25, 0.75)
+   * ```
+   */
+  public abstract trim(
+    curve: CurveHandle,
+    startParam: number,
+    endParam: number,
+  ): PluginApiReturn<CurveHandle>
+
+  /**
+   * Offset a curve by a translation vector. Host API call — returns a handle.
+   *
+   * @param curve - The curve to offset
+   * @param vector - Translation vector to offset the curve by
+   * @returns The offset curve as a {@linkcode CurveHandle}
+   *
+   * @examplePrompt Offset this line 500mm to the side
+   * @examplePrompt Shift this edge over to make a parallel copy
+   *
+   * # Example
+   * ```ts
+   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
+   * const b = await snaptrude.core.math.vec3.new(8, 0, 0)
+   * const line = await snaptrude.core.geom.create.line(a, b)
+   * const sideways = await snaptrude.core.math.vec3.new(0, 0, 0.5)
+   * const parallel = await snaptrude.core.geom.update.curve.offset(line, sideways)
+   * ```
+   */
+  public abstract offset(
+    curve: CurveHandle,
+    vector: Vec3Handle,
+  ): PluginApiReturn<CurveHandle>
+
+  /**
+   * Reverse the direction of a curve. Host API call — returns a handle.
+   *
+   * @param curve - The curve to reverse
+   * @returns The reversed curve as a {@linkcode CurveHandle}
+   *
+   * # Example
+   * ```ts
+   * const a = await snaptrude.core.math.vec3.new(0, 0, 0)
+   * const b = await snaptrude.core.math.vec3.new(4, 0, 0)
+   * const line = await snaptrude.core.geom.create.line(a, b)
+   * const reversed = await snaptrude.core.geom.update.curve.reverse(line)
+   * const start = await snaptrude.core.geom.query.curve.getStartPoint(reversed) // { x: 4, y: 0, z: 0 }
+   * ```
+   */
+  public abstract reverse(curve: CurveHandle): PluginApiReturn<CurveHandle>
+}
+
+/**
+ * Arguments for {@linkcode PluginGeomUpdateCurveApi.extend}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `curve` | {@linkcode CurveHandle} | The curve to extend |
+ * | `distance` | `number` | Distance to extend the curve by |
+ * | `fromStart` | `boolean` | Extend from the start end when `true`, otherwise from the end |
+ */
+export const PluginGeomUpdateCurveExtendArgs = z.object({
+  curve: CurveHandle,
+  distance: z.number(),
+  fromStart: z.boolean(),
+})
+
+export type PluginGeomUpdateCurveExtendArgs = z.infer<typeof PluginGeomUpdateCurveExtendArgs>
+
+/**
+ * Arguments for {@linkcode PluginGeomUpdateCurveApi.split}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `curve` | {@linkcode CurveHandle} | The curve to split |
+ * | `point` | {@linkcode Vec3Handle} | Point on the curve to split at |
+ */
+export const PluginGeomUpdateCurveSplitArgs = z.object({
+  curve: CurveHandle,
+  point: Vec3Handle,
+})
+
+export type PluginGeomUpdateCurveSplitArgs = z.infer<typeof PluginGeomUpdateCurveSplitArgs>
+
+/**
+ * Arguments for {@linkcode PluginGeomUpdateCurveApi.trim}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `curve` | {@linkcode CurveHandle} | The curve to trim |
+ * | `startParam` | `number` | Start parameter of the portion to keep |
+ * | `endParam` | `number` | End parameter of the portion to keep |
+ */
+export const PluginGeomUpdateCurveTrimArgs = z.object({
+  curve: CurveHandle,
+  startParam: z.number(),
+  endParam: z.number(),
+})
+
+export type PluginGeomUpdateCurveTrimArgs = z.infer<typeof PluginGeomUpdateCurveTrimArgs>
+
+/**
+ * Arguments for {@linkcode PluginGeomUpdateCurveApi.offset}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `curve` | {@linkcode CurveHandle} | The curve to offset |
+ * | `vector` | {@linkcode Vec3Handle} | Translation vector to offset the curve by |
+ */
+export const PluginGeomUpdateCurveOffsetArgs = z.object({
+  curve: CurveHandle,
+  vector: Vec3Handle,
+})
+
+export type PluginGeomUpdateCurveOffsetArgs = z.infer<typeof PluginGeomUpdateCurveOffsetArgs>
+
+/**
+ * Arguments for {@linkcode PluginGeomUpdateCurveApi.reverse}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `curve` | {@linkcode CurveHandle} | The curve to reverse |
+ */
+export const PluginGeomUpdateCurveReverseArgs = z.object({
+  curve: CurveHandle,
+})
+
+export type PluginGeomUpdateCurveReverseArgs = z.infer<typeof PluginGeomUpdateCurveReverseArgs>

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

@@ -1,29 +1,29 @@
-import { PluginGeomUpdateCurveApi } from "./curve"
-import { PluginGeomUpdateProfileApi } from "./profile"
-import { PluginGeomUpdateContourApi } from "./contour"
-
-/**
- * Curve/profile/contour update namespace — derive NEW geometry by editing existing
- * handles (all-handle model, §11). Inputs are never mutated; every method returns a
- * fresh handle.
- *
- * - {@linkcode PluginGeomUpdateApi.curve} — extend, split, trim, offset, reverse
- * - {@linkcode PluginGeomUpdateApi.profile} — offset, affine, add/remove/reverse/simplify
- * - {@linkcode PluginGeomUpdateApi.contour} — offset, affine, addHole/removeHole
- *
- * Accessed via `snaptrude.core.geom.update`.
- */
-export abstract class PluginGeomUpdateApi {
-  /** Curve editing operations. See {@linkcode PluginGeomUpdateCurveApi}. */
-  public abstract curve: PluginGeomUpdateCurveApi
-  /** Profile editing operations. See {@linkcode PluginGeomUpdateProfileApi}. */
-  public abstract profile: PluginGeomUpdateProfileApi
-  /** Contour editing operations. See {@linkcode PluginGeomUpdateContourApi}. */
-  public abstract contour: PluginGeomUpdateContourApi
-
-  constructor() {}
-}
-
-export * from "./curve"
-export * from "./profile"
-export * from "./contour"
+import { PluginGeomUpdateCurveApi } from "./curve"
+import { PluginGeomUpdateProfileApi } from "./profile"
+import { PluginGeomUpdateContourApi } from "./contour"
+
+/**
+ * Curve/profile/contour update namespace — derive NEW geometry by editing existing
+ * handles (all-handle model, §11). Inputs are never mutated; every method returns a
+ * fresh handle.
+ *
+ * - {@linkcode PluginGeomUpdateApi.curve} — extend, split, trim, offset, reverse
+ * - {@linkcode PluginGeomUpdateApi.profile} — offset, affine, add/remove/reverse/simplify
+ * - {@linkcode PluginGeomUpdateApi.contour} — offset, affine, addHole/removeHole
+ *
+ * Accessed via `snaptrude.core.geom.update`.
+ */
+export abstract class PluginGeomUpdateApi {
+  /** Curve editing operations. See {@linkcode PluginGeomUpdateCurveApi}. */
+  public abstract curve: PluginGeomUpdateCurveApi
+  /** Profile editing operations. See {@linkcode PluginGeomUpdateProfileApi}. */
+  public abstract profile: PluginGeomUpdateProfileApi
+  /** Contour editing operations. See {@linkcode PluginGeomUpdateContourApi}. */
+  public abstract contour: PluginGeomUpdateContourApi
+
+  constructor() {}
+}
+
+export * from "./curve"
+export * from "./profile"
+export * from "./contour"