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

package/src/api/design/create/grids.ts

@@ -1,137 +1,137 @@
-import * as z from "zod"
-import { ComponentHandle, CurveHandle, Vec3Handle } from "../../../handles"
-
-// ---------------------------------------------------------------------------
-// Shared grid style vocabulary
-// ---------------------------------------------------------------------------
-
-/**
- * Grid line style (mirrors the engine `LineMode` values verbatim — the same
- * vocabulary as {@linkcode PluginReferenceLineStyle}).
- */
-export const PluginGridLineStyle = z.enum(["SOLID", "DASHED", "DOT_DASH"])
-export type PluginGridLineStyle = z.infer<typeof PluginGridLineStyle>
-
-/**
- * Optional visual styling shared by every grid creator (and reused as the
- * patch shape by `design.update.grid`). All fields optional; engine defaults
- * apply when omitted.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `style` | {@linkcode PluginGridLineStyle}? | Line style |
- * | `weight` | `number`? | Line weight (> 0) |
- * | `color` | `string`? | Line color as a `#rrggbb` hex string |
- * | `showStart` | `boolean`? | Show the start-end tag bubble |
- * | `showEnd` | `boolean`? | Show the end-end tag bubble |
- */
-export const PluginGridStyleOptions = z.object({
-  style: PluginGridLineStyle.optional(),
-  weight: z.number().positive().optional(),
-  color: z
-    .string()
-    .regex(/^#[0-9a-fA-F]{6}$/, "color must be a #rrggbb hex string")
-    .optional(),
-  showStart: z.boolean().optional(),
-  showEnd: z.boolean().optional(),
-})
-export type PluginGridStyleOptions = z.infer<typeof PluginGridStyleOptions>
-
-// ---------------------------------------------------------------------------
-// create.grid — free rectangular grid
-// ---------------------------------------------------------------------------
-
-/**
- * Arguments for {@linkcode PluginDesignCreateApi.grid}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `linesX` | `number` | Line count of the first family (integer ≥ 1) |
- * | `linesY` | `number` | Line count of the second family (integer ≥ 1) |
- * | `spacingX` | `number` | Spacing of the first family (Snaptrude units, > 0) |
- * | `spacingY` | `number` | Spacing of the second family (Snaptrude units, > 0) |
- * | `angle` | `number`? | Rotation in degrees, CCW about +Y (default 0) |
- * | `center` | {@linkcode Vec3Handle}? | Placement centre; defaults to the native viewport-centre behavior |
- * | …style | {@linkcode PluginGridStyleOptions} | Optional line styling |
- */
-export const PluginDesignCreateGridArgs = z
-  .object({
-    linesX: z.number().int().min(1),
-    linesY: z.number().int().min(1),
-    spacingX: z.number().positive().finite(),
-    spacingY: z.number().positive().finite(),
-    angle: z.number().finite().optional(),
-    center: Vec3Handle.optional(),
-  })
-  .merge(PluginGridStyleOptions)
-export type PluginDesignCreateGridArgs = z.infer<typeof PluginDesignCreateGridArgs>
-
-// ---------------------------------------------------------------------------
-// create.gridFromCurve — single-curve grid
-// ---------------------------------------------------------------------------
-
-/**
- * Arguments for {@linkcode PluginDesignCreateApi.gridFromCurve}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `curve` | {@linkcode CurveHandle} | The grid line's geometry — a line or arc (circles are rejected) |
- * | `tag` | `string`? | The line's grid tag (defaults to the draw tool's next tag) |
- * | …style | {@linkcode PluginGridStyleOptions} | Optional line styling |
- */
-export const PluginDesignCreateGridFromCurveArgs = z
-  .object({
-    curve: CurveHandle,
-    tag: z.string().min(1).optional(),
-  })
-  .merge(PluginGridStyleOptions)
-export type PluginDesignCreateGridFromCurveArgs = z.infer<
-  typeof PluginDesignCreateGridFromCurveArgs
->
-
-// ---------------------------------------------------------------------------
-// create.gridsFromMasses — fitted grids
-// ---------------------------------------------------------------------------
-
-/**
- * Arguments for {@linkcode PluginDesignCreateApi.gridsFromMasses}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `masses` | {@linkcode ComponentHandle}`[]` | Masses whose footprints seat the grids |
- * | `spacingX` | `number` | First-family spacing (Snaptrude units, > 0) |
- * | `spacingY` | `number` | Second-family spacing (Snaptrude units, > 0) |
- * | …style | {@linkcode PluginGridStyleOptions} | Optional line styling |
- */
-export const PluginDesignCreateGridsFromMassesArgs = z
-  .object({
-    masses: z.array(ComponentHandle).min(1),
-    spacingX: z.number().positive().finite(),
-    spacingY: z.number().positive().finite(),
-  })
-  .merge(PluginGridStyleOptions)
-export type PluginDesignCreateGridsFromMassesArgs = z.infer<
-  typeof PluginDesignCreateGridsFromMassesArgs
->
-
-// ---------------------------------------------------------------------------
-// create.columnsFromGrids — columns at line intersections
-// ---------------------------------------------------------------------------
-
-/**
- * Arguments for {@linkcode PluginDesignCreateApi.columnsFromGrids}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `grids` | {@linkcode ComponentHandle}`[]` | Grid groups whose line intersections seat the columns |
- * | `width` | `number` | Column width (Snaptrude units, > 0) |
- * | `depth` | `number` | Column depth (Snaptrude units, > 0) |
- */
-export const PluginDesignCreateColumnsFromGridsArgs = z.object({
-  grids: z.array(ComponentHandle).min(1),
-  width: z.number().positive().finite(),
-  depth: z.number().positive().finite(),
-})
-export type PluginDesignCreateColumnsFromGridsArgs = z.infer<
-  typeof PluginDesignCreateColumnsFromGridsArgs
->
+import * as z from "zod"
+import { ComponentHandle, CurveHandle, Vec3Handle } from "../../../handles"
+
+// ---------------------------------------------------------------------------
+// Shared grid style vocabulary
+// ---------------------------------------------------------------------------
+
+/**
+ * Grid line style (mirrors the engine `LineMode` values verbatim — the same
+ * vocabulary as {@linkcode PluginReferenceLineStyle}).
+ */
+export const PluginGridLineStyle = z.enum(["SOLID", "DASHED", "DOT_DASH"])
+export type PluginGridLineStyle = z.infer<typeof PluginGridLineStyle>
+
+/**
+ * Optional visual styling shared by every grid creator (and reused as the
+ * patch shape by `design.update.grid`). All fields optional; engine defaults
+ * apply when omitted.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `style` | {@linkcode PluginGridLineStyle}? | Line style |
+ * | `weight` | `number`? | Line weight (> 0) |
+ * | `color` | `string`? | Line color as a `#rrggbb` hex string |
+ * | `showStart` | `boolean`? | Show the start-end tag bubble |
+ * | `showEnd` | `boolean`? | Show the end-end tag bubble |
+ */
+export const PluginGridStyleOptions = z.object({
+  style: PluginGridLineStyle.optional(),
+  weight: z.number().positive().optional(),
+  color: z
+    .string()
+    .regex(/^#[0-9a-fA-F]{6}$/, "color must be a #rrggbb hex string")
+    .optional(),
+  showStart: z.boolean().optional(),
+  showEnd: z.boolean().optional(),
+})
+export type PluginGridStyleOptions = z.infer<typeof PluginGridStyleOptions>
+
+// ---------------------------------------------------------------------------
+// create.grid — free rectangular grid
+// ---------------------------------------------------------------------------
+
+/**
+ * Arguments for {@linkcode PluginDesignCreateApi.grid}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `linesX` | `number` | Line count of the first family (integer ≥ 1) |
+ * | `linesY` | `number` | Line count of the second family (integer ≥ 1) |
+ * | `spacingX` | `number` | Spacing of the first family (Snaptrude units, > 0) |
+ * | `spacingY` | `number` | Spacing of the second family (Snaptrude units, > 0) |
+ * | `angle` | `number`? | Rotation in degrees, CCW about +Y (default 0) |
+ * | `center` | {@linkcode Vec3Handle}? | Placement centre; defaults to the native viewport-centre behavior |
+ * | …style | {@linkcode PluginGridStyleOptions} | Optional line styling |
+ */
+export const PluginDesignCreateGridArgs = z
+  .object({
+    linesX: z.number().int().min(1),
+    linesY: z.number().int().min(1),
+    spacingX: z.number().positive().finite(),
+    spacingY: z.number().positive().finite(),
+    angle: z.number().finite().optional(),
+    center: Vec3Handle.optional(),
+  })
+  .merge(PluginGridStyleOptions)
+export type PluginDesignCreateGridArgs = z.infer<typeof PluginDesignCreateGridArgs>
+
+// ---------------------------------------------------------------------------
+// create.gridFromCurve — single-curve grid
+// ---------------------------------------------------------------------------
+
+/**
+ * Arguments for {@linkcode PluginDesignCreateApi.gridFromCurve}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `curve` | {@linkcode CurveHandle} | The grid line's geometry — a line or arc (circles are rejected) |
+ * | `tag` | `string`? | The line's grid tag (defaults to the draw tool's next tag) |
+ * | …style | {@linkcode PluginGridStyleOptions} | Optional line styling |
+ */
+export const PluginDesignCreateGridFromCurveArgs = z
+  .object({
+    curve: CurveHandle,
+    tag: z.string().min(1).optional(),
+  })
+  .merge(PluginGridStyleOptions)
+export type PluginDesignCreateGridFromCurveArgs = z.infer<
+  typeof PluginDesignCreateGridFromCurveArgs
+>
+
+// ---------------------------------------------------------------------------
+// create.gridsFromMasses — fitted grids
+// ---------------------------------------------------------------------------
+
+/**
+ * Arguments for {@linkcode PluginDesignCreateApi.gridsFromMasses}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `masses` | {@linkcode ComponentHandle}`[]` | Masses whose footprints seat the grids |
+ * | `spacingX` | `number` | First-family spacing (Snaptrude units, > 0) |
+ * | `spacingY` | `number` | Second-family spacing (Snaptrude units, > 0) |
+ * | …style | {@linkcode PluginGridStyleOptions} | Optional line styling |
+ */
+export const PluginDesignCreateGridsFromMassesArgs = z
+  .object({
+    masses: z.array(ComponentHandle).min(1),
+    spacingX: z.number().positive().finite(),
+    spacingY: z.number().positive().finite(),
+  })
+  .merge(PluginGridStyleOptions)
+export type PluginDesignCreateGridsFromMassesArgs = z.infer<
+  typeof PluginDesignCreateGridsFromMassesArgs
+>
+
+// ---------------------------------------------------------------------------
+// create.columnsFromGrids — columns at line intersections
+// ---------------------------------------------------------------------------
+
+/**
+ * Arguments for {@linkcode PluginDesignCreateApi.columnsFromGrids}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `grids` | {@linkcode ComponentHandle}`[]` | Grid groups whose line intersections seat the columns |
+ * | `width` | `number` | Column width (Snaptrude units, > 0) |
+ * | `depth` | `number` | Column depth (Snaptrude units, > 0) |
+ */
+export const PluginDesignCreateColumnsFromGridsArgs = z.object({
+  grids: z.array(ComponentHandle).min(1),
+  width: z.number().positive().finite(),
+  depth: z.number().positive().finite(),
+})
+export type PluginDesignCreateColumnsFromGridsArgs = z.infer<
+  typeof PluginDesignCreateColumnsFromGridsArgs
+>