@snaptrude/plugin-core 0.1.3 → 0.3.0

package/src/api/tools/offset.ts

@@ -0,0 +1,43 @@
+import * as z from "zod"
+import type { ComponentId } from "../../types"
+import { PVec3 } from "../core/math/vec3"
+
+/**
+ * Arguments for `snaptrude.tools.offset`.
+ *
+ * Runs Snaptrude's offset/split operation on the top profile of a scene
+ * component. A positive distance offsets outward from the selected profile;
+ * a negative distance offsets inward. If `profilePickPoint` is omitted, the
+ * outer top profile is used. If `profilePickPoint` is provided, the nearest top
+ * contour profile to that point is used, matching the interactive offset tool's
+ * pick behavior.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `componentId` | `string` | Component ID to offset |
+ * | `distance` | `number` | Signed offset distance in Snaptrude units |
+ * | `profilePickPoint` | {@linkcode PVec3} | Optional point used to choose a top contour profile |
+ */
+export const PluginOffsetArgs = z.object({
+  componentId: z.string().min(1),
+  distance: z.number(),
+  profilePickPoint: PVec3.optional(),
+})
+
+export type PluginOffsetArgs = z.infer<typeof PluginOffsetArgs>
+
+/**
+ * Result of `snaptrude.tools.offset`.
+ *
+ * `createdIds` are the components created by the offset operation. `deletedIds`
+ * are components removed by split-style offsets.
+ */
+export const PluginOffsetResult = z.object({
+  createdIds: z.array(z.string()),
+  deletedIds: z.array(z.string()),
+})
+
+export type PluginOffsetResult = {
+  createdIds: ComponentId[]
+  deletedIds: ComponentId[]
+}