@snaptrude/plugin-core 0.0.0-dev-20260908074328 → 0.0.0-dev-20260921132444

package/dist/api/design/create/grids.d.ts

@@ -0,0 +1,132 @@
+import * as z from "zod";
+import { ComponentHandle } from "../../../handles";
+/**
+ * Grid line style (mirrors the engine `LineMode` values verbatim — the same
+ * vocabulary as {@linkcode PluginReferenceLineStyle}).
+ */
+export declare const PluginGridLineStyle: z.ZodEnum<{
+    SOLID: "SOLID";
+    DASHED: "DASHED";
+    DOT_DASH: "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 declare const PluginGridStyleOptions: z.ZodObject<{
+    style: z.ZodOptional<z.ZodEnum<{
+        SOLID: "SOLID";
+        DASHED: "DASHED";
+        DOT_DASH: "DOT_DASH";
+    }>>;
+    weight: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodString>;
+    showStart: z.ZodOptional<z.ZodBoolean>;
+    showEnd: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginGridStyleOptions = z.infer<typeof PluginGridStyleOptions>;
+/**
+ * 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 declare const PluginDesignCreateGridArgs: z.ZodObject<{
+    linesX: z.ZodNumber;
+    linesY: z.ZodNumber;
+    spacingX: z.ZodNumber;
+    spacingY: z.ZodNumber;
+    angle: z.ZodOptional<z.ZodNumber>;
+    center: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    style: z.ZodOptional<z.ZodEnum<{
+        SOLID: "SOLID";
+        DASHED: "DASHED";
+        DOT_DASH: "DOT_DASH";
+    }>>;
+    weight: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodString>;
+    showStart: z.ZodOptional<z.ZodBoolean>;
+    showEnd: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginDesignCreateGridArgs = z.infer<typeof PluginDesignCreateGridArgs>;
+/**
+ * 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 declare const PluginDesignCreateGridFromCurveArgs: z.ZodObject<{
+    curve: z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"line">, string>>, z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"arc">, string>>]>;
+    tag: z.ZodOptional<z.ZodString>;
+    style: z.ZodOptional<z.ZodEnum<{
+        SOLID: "SOLID";
+        DASHED: "DASHED";
+        DOT_DASH: "DOT_DASH";
+    }>>;
+    weight: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodString>;
+    showStart: z.ZodOptional<z.ZodBoolean>;
+    showEnd: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginDesignCreateGridFromCurveArgs = z.infer<typeof PluginDesignCreateGridFromCurveArgs>;
+/**
+ * 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 declare const PluginDesignCreateGridsFromMassesArgs: z.ZodObject<{
+    masses: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    spacingX: z.ZodNumber;
+    spacingY: z.ZodNumber;
+    style: z.ZodOptional<z.ZodEnum<{
+        SOLID: "SOLID";
+        DASHED: "DASHED";
+        DOT_DASH: "DOT_DASH";
+    }>>;
+    weight: z.ZodOptional<z.ZodNumber>;
+    color: z.ZodOptional<z.ZodString>;
+    showStart: z.ZodOptional<z.ZodBoolean>;
+    showEnd: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginDesignCreateGridsFromMassesArgs = z.infer<typeof PluginDesignCreateGridsFromMassesArgs>;
+/**
+ * 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 declare const PluginDesignCreateColumnsFromGridsArgs: z.ZodObject<{
+    grids: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    width: z.ZodNumber;
+    depth: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginDesignCreateColumnsFromGridsArgs = z.infer<typeof PluginDesignCreateColumnsFromGridsArgs>;
+//# sourceMappingURL=grids.d.ts.map

package/dist/api/design/create/grids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grids.d.ts","sourceRoot":"","sources":["../../../../src/api/design/create/grids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAA2B,MAAM,kBAAkB,CAAA;AAM3E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;EAA0C,CAAA;AAC1E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;iBASjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAM3E;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;iBASP,CAAA;AAChC,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAMnF;;;;;;;;GAQG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;iBAKhB,CAAA;AAChC,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAMD;;;;;;;;;GASG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;iBAMlB,CAAA;AAChC,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAMD;;;;;;;;GAQG;AACH,eAAO,MAAM,sCAAsC;;;;iBAIjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA"}