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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (221) hide show
  1. package/AGENTS.md +231 -231
  2. package/CHANGELOG.md +408 -402
  3. package/CLAUDE.md +11 -11
  4. package/api-manifest.json +1510 -701
  5. package/dist/api/analysis/daylight.d.ts +5 -5
  6. package/dist/api/analysis/solar.d.ts +2 -2
  7. package/dist/api/core/camera/index.d.ts +29 -0
  8. package/dist/api/core/camera/index.d.ts.map +1 -1
  9. package/dist/api/core/geom/create/index.d.ts +7 -1
  10. package/dist/api/core/geom/create/index.d.ts.map +1 -1
  11. package/dist/api/core/geom/update/contour.d.ts +8 -2
  12. package/dist/api/core/geom/update/contour.d.ts.map +1 -1
  13. package/dist/api/core/storeys/index.d.ts +5 -2
  14. package/dist/api/core/storeys/index.d.ts.map +1 -1
  15. package/dist/api/core/zoom/index.d.ts +13 -0
  16. package/dist/api/core/zoom/index.d.ts.map +1 -1
  17. package/dist/api/design/bim.d.ts +299 -0
  18. package/dist/api/design/bim.d.ts.map +1 -0
  19. package/dist/api/design/boolean/index.d.ts +2 -0
  20. package/dist/api/design/boolean/index.d.ts.map +1 -1
  21. package/dist/api/design/catalog.d.ts +320 -0
  22. package/dist/api/design/catalog.d.ts.map +1 -0
  23. package/dist/api/design/create/bulk-items.d.ts +65 -25
  24. package/dist/api/design/create/bulk-items.d.ts.map +1 -1
  25. package/dist/api/design/create/index.d.ts +299 -100
  26. package/dist/api/design/create/index.d.ts.map +1 -1
  27. package/dist/api/design/create/opening-fields.d.ts +13 -12
  28. package/dist/api/design/create/opening-fields.d.ts.map +1 -1
  29. package/dist/api/design/delete/index.d.ts +1 -0
  30. package/dist/api/design/delete/index.d.ts.map +1 -1
  31. package/dist/api/design/doors/index.d.ts +18 -24
  32. package/dist/api/design/doors/index.d.ts.map +1 -1
  33. package/dist/api/design/family.d.ts +813 -35
  34. package/dist/api/design/family.d.ts.map +1 -1
  35. package/dist/api/design/index.d.ts +16 -0
  36. package/dist/api/design/index.d.ts.map +1 -1
  37. package/dist/api/design/networks.d.ts +1703 -0
  38. package/dist/api/design/networks.d.ts.map +1 -0
  39. package/dist/api/design/query/grids.d.ts +2 -2
  40. package/dist/api/design/query/index.d.ts +42 -32
  41. package/dist/api/design/query/index.d.ts.map +1 -1
  42. package/dist/api/design/selection/index.d.ts +10 -10
  43. package/dist/api/design/types/index.d.ts +40 -24
  44. package/dist/api/design/types/index.d.ts.map +1 -1
  45. package/dist/api/design/update/index.d.ts +111 -6
  46. package/dist/api/design/update/index.d.ts.map +1 -1
  47. package/dist/api/design/windows/index.d.ts +8 -8
  48. package/dist/api/design/windows/index.d.ts.map +1 -1
  49. package/dist/api/entity/buildableEnvelope.d.ts +84 -2
  50. package/dist/api/entity/buildableEnvelope.d.ts.map +1 -1
  51. package/dist/api/presentation/aiInspiration.d.ts +10 -10
  52. package/dist/api/presentation/annotate.d.ts +38 -22
  53. package/dist/api/presentation/annotate.d.ts.map +1 -1
  54. package/dist/api/presentation/drawingContract.d.ts +32 -0
  55. package/dist/api/presentation/drawingContract.d.ts.map +1 -0
  56. package/dist/api/presentation/drawings.d.ts +3523 -0
  57. package/dist/api/presentation/drawings.d.ts.map +1 -0
  58. package/dist/api/presentation/export.d.ts +23 -5
  59. package/dist/api/presentation/export.d.ts.map +1 -1
  60. package/dist/api/presentation/index.d.ts +41 -12
  61. package/dist/api/presentation/index.d.ts.map +1 -1
  62. package/dist/api/presentation/placedViews.d.ts +106 -6
  63. package/dist/api/presentation/placedViews.d.ts.map +1 -1
  64. package/dist/api/presentation/sections.d.ts +461 -0
  65. package/dist/api/presentation/sections.d.ts.map +1 -0
  66. package/dist/api/presentation/shapes.d.ts +2 -2
  67. package/dist/api/presentation/sheets.d.ts +175 -19
  68. package/dist/api/presentation/sheets.d.ts.map +1 -1
  69. package/dist/api/presentation/viewPresets.d.ts +222 -0
  70. package/dist/api/presentation/viewPresets.d.ts.map +1 -0
  71. package/dist/api/presentation/views.d.ts +141 -8
  72. package/dist/api/presentation/views.d.ts.map +1 -1
  73. package/dist/api/presentation/walkthroughs.d.ts +6 -6
  74. package/dist/errors/codes.d.ts +3 -1
  75. package/dist/errors/codes.d.ts.map +1 -1
  76. package/dist/index.cjs +3883 -2385
  77. package/dist/index.cjs.map +1 -1
  78. package/dist/index.js +3744 -2385
  79. package/dist/index.js.map +1 -1
  80. package/package.json +1 -1
  81. package/scripts/check-dist-fresh.mjs +22 -22
  82. package/scripts/generate-manifest.mjs +243 -238
  83. package/scripts/generate-manifest.test.mjs +303 -303
  84. package/src/api/analysis/daylight.ts +470 -470
  85. package/src/api/analysis/heatmaps.ts +683 -683
  86. package/src/api/analysis/illuminance.ts +155 -155
  87. package/src/api/analysis/index.ts +61 -61
  88. package/src/api/analysis/shadows.ts +183 -183
  89. package/src/api/analysis/solar.ts +237 -237
  90. package/src/api/analysis/sunlightHours.ts +211 -211
  91. package/src/api/analysis/sunpath.ts +83 -83
  92. package/src/api/analysis/weather.ts +179 -179
  93. package/src/api/core/buildings.ts +485 -485
  94. package/src/api/core/camera/index.ts +696 -667
  95. package/src/api/core/comment/index.ts +376 -376
  96. package/src/api/core/geom/create/index.ts +2139 -2133
  97. package/src/api/core/geom/delete/index.ts +84 -84
  98. package/src/api/core/geom/index.ts +35 -35
  99. package/src/api/core/geom/query/arc.ts +169 -169
  100. package/src/api/core/geom/query/brep.ts +621 -621
  101. package/src/api/core/geom/query/circle.ts +404 -404
  102. package/src/api/core/geom/query/contour.ts +540 -540
  103. package/src/api/core/geom/query/curve.ts +1102 -1102
  104. package/src/api/core/geom/query/edge.ts +130 -130
  105. package/src/api/core/geom/query/face.ts +508 -508
  106. package/src/api/core/geom/query/halfedge.ts +210 -210
  107. package/src/api/core/geom/query/index.ts +63 -63
  108. package/src/api/core/geom/query/profile.ts +473 -473
  109. package/src/api/core/geom/query/vertex.ts +205 -205
  110. package/src/api/core/geom/update/contour.ts +323 -317
  111. package/src/api/core/geom/update/curve.ts +209 -209
  112. package/src/api/core/geom/update/index.ts +29 -29
  113. package/src/api/core/geom/update/profile.ts +379 -379
  114. package/src/api/core/groups.ts +521 -521
  115. package/src/api/core/handles/index.ts +234 -234
  116. package/src/api/core/history/index.ts +84 -84
  117. package/src/api/core/index.ts +99 -99
  118. package/src/api/core/io/export/index.ts +126 -126
  119. package/src/api/core/io/import/index.ts +504 -504
  120. package/src/api/core/io/index.ts +42 -42
  121. package/src/api/core/io/job/index.ts +140 -140
  122. package/src/api/core/io/query/index.ts +71 -71
  123. package/src/api/core/io/terrain/index.ts +360 -360
  124. package/src/api/core/io/underlay/index.ts +705 -705
  125. package/src/api/core/layers.ts +540 -540
  126. package/src/api/core/math/index.ts +20 -20
  127. package/src/api/core/math/quat.ts +172 -172
  128. package/src/api/core/math/vec3.ts +179 -179
  129. package/src/api/core/mode/index.ts +108 -108
  130. package/src/api/core/project/index.ts +479 -479
  131. package/src/api/core/proposals/index.ts +570 -570
  132. package/src/api/core/storeys/index.ts +311 -308
  133. package/src/api/core/storeys/layers.ts +339 -339
  134. package/src/api/core/tags.ts +911 -911
  135. package/src/api/core/units/index.ts +164 -164
  136. package/src/api/core/user.ts +46 -46
  137. package/src/api/core/zoom/index.ts +64 -51
  138. package/src/api/design/bim.ts +210 -0
  139. package/src/api/design/boolean/index.ts +181 -179
  140. package/src/api/design/catalog.ts +203 -0
  141. package/src/api/design/create/bulk-items.ts +294 -254
  142. package/src/api/design/create/grids.ts +137 -137
  143. package/src/api/design/create/index.ts +2178 -1980
  144. package/src/api/design/create/opening-fields.ts +40 -37
  145. package/src/api/design/delete/index.ts +75 -74
  146. package/src/api/design/dimensions.ts +453 -453
  147. package/src/api/design/doors/index.ts +516 -500
  148. package/src/api/design/edit/index.ts +54 -54
  149. package/src/api/design/erase/index.ts +151 -151
  150. package/src/api/design/family.ts +1342 -704
  151. package/src/api/design/furniture/index.ts +319 -319
  152. package/src/api/design/grids.ts +237 -237
  153. package/src/api/design/index.ts +304 -274
  154. package/src/api/design/lock.ts +69 -69
  155. package/src/api/design/materials/index.ts +608 -608
  156. package/src/api/design/networks.ts +607 -0
  157. package/src/api/design/query/geometry/index.ts +319 -319
  158. package/src/api/design/query/grids.ts +197 -197
  159. package/src/api/design/query/index.ts +1236 -1226
  160. package/src/api/design/query/referenceLines.ts +52 -52
  161. package/src/api/design/query/spaces.ts +275 -275
  162. package/src/api/design/selection/index.ts +273 -273
  163. package/src/api/design/shared.ts +40 -40
  164. package/src/api/design/transform/index.ts +254 -254
  165. package/src/api/design/types/index.ts +163 -156
  166. package/src/api/design/update/index.ts +1096 -983
  167. package/src/api/design/visibility.ts +143 -143
  168. package/src/api/design/windows/index.ts +351 -333
  169. package/src/api/entity/buildableEnvelope.ts +397 -322
  170. package/src/api/entity/index.ts +30 -30
  171. package/src/api/entity/referenceLine.ts +235 -235
  172. package/src/api/entity/space.ts +612 -612
  173. package/src/api/entity/story.ts +517 -517
  174. package/src/api/index.ts +47 -47
  175. package/src/api/presentation/aiInspiration.ts +1116 -1116
  176. package/src/api/presentation/annotate.ts +417 -385
  177. package/src/api/presentation/camera.ts +289 -289
  178. package/src/api/presentation/diagrams.ts +194 -194
  179. package/src/api/presentation/drawingContract.ts +70 -0
  180. package/src/api/presentation/drawings.ts +1179 -0
  181. package/src/api/presentation/export.ts +134 -108
  182. package/src/api/presentation/import.ts +159 -159
  183. package/src/api/presentation/index.ts +160 -126
  184. package/src/api/presentation/placedViews.ts +1211 -1120
  185. package/src/api/presentation/sections.ts +420 -0
  186. package/src/api/presentation/shapes.ts +274 -274
  187. package/src/api/presentation/sheets.ts +746 -585
  188. package/src/api/presentation/slideshow.ts +134 -134
  189. package/src/api/presentation/tables.ts +84 -84
  190. package/src/api/presentation/viewPresets.ts +241 -0
  191. package/src/api/presentation/views.ts +742 -673
  192. package/src/api/presentation/walkthroughs.ts +1201 -1201
  193. package/src/api/program/adjacency.ts +164 -164
  194. package/src/api/program/areas.ts +408 -408
  195. package/src/api/program/classification.ts +138 -138
  196. package/src/api/program/cores.ts +83 -83
  197. package/src/api/program/departments.ts +517 -517
  198. package/src/api/program/index.ts +73 -73
  199. package/src/api/program/labels.ts +332 -332
  200. package/src/api/program/layout.ts +422 -422
  201. package/src/api/program/metadata.ts +364 -364
  202. package/src/api/program/metrics.ts +120 -120
  203. package/src/api/program/site.ts +748 -748
  204. package/src/api/program/spreadsheet.ts +2698 -2698
  205. package/src/api/workspace/index.ts +612 -612
  206. package/src/errors/codes.ts +143 -136
  207. package/src/errors/envelope.ts +75 -75
  208. package/src/errors/index.ts +21 -21
  209. package/src/errors/plugin-error.ts +134 -134
  210. package/src/handles.ts +297 -297
  211. package/src/host-utils.ts +67 -67
  212. package/src/index.ts +7 -7
  213. package/src/massParameters.ops.ts +246 -246
  214. package/src/massParameters.ts +427 -427
  215. package/src/types.ts +16 -16
  216. package/test/drawingContract.test.mjs +288 -0
  217. package/test/errors.test.mjs +185 -184
  218. package/test/massParameters.test.mjs +952 -952
  219. package/test/presentationViewSettings.test.mjs +85 -0
  220. package/tsconfig.json +22 -22
  221. package/tsup.config.ts +12 -12
@@ -1,317 +1,323 @@
1
- import * as z from "zod"
2
- import { PluginApiReturn } from "../../../../types"
3
- import {
4
- ContourHandle,
5
- ProfileHandle,
6
- Vec3Handle,
7
- Vec3Components,
8
- } from "../../../../handles"
9
-
10
- /**
11
- * Contour editing — produce NEW contours from an existing one (all-handle model, §11).
12
- *
13
- * A contour is an outer {@linkcode ProfileHandle} plus zero or more inner profiles
14
- * that punch holes in it. Every method here is an immutable derive-new operation:
15
- * it takes an opaque {@linkcode ContourHandle} (plus any extra inputs) and returns a
16
- * fresh {@linkcode ContourHandle} for the resulting contour. The input contour is
17
- * never mutated — the original handle keeps referring to the unchanged contour. Read
18
- * the resulting geometry back as plain values with the query namespace.
19
- *
20
- * Accessed via `snaptrude.core.geom.update.contour`.
21
- */
22
- export abstract class PluginGeomUpdateContourApi {
23
- constructor() {}
24
-
25
- /**
26
- * Offset a contour inward/outward by a signed distance. Immutable — returns a NEW
27
- * contour and leaves the input unchanged.
28
- *
29
- * @param contour The contour to offset
30
- * @param distance Signed offset distance (outward when positive, inward when negative)
31
- * @returns The offset contour as a NEW {@linkcode ContourHandle}
32
- * @throws PRECONDITION_FAILED if the outline or a hole has a spline run
33
- * (splines cannot be offset yet)
34
- *
35
- * @examplePrompt Offset this boundary 500mm inward
36
- * @examplePrompt Shrink this floor outline by half a metre all around
37
- *
38
- * # Example
39
- * ```ts
40
- * const rect = await snaptrude.core.geom.create.profileRect(10, 8)
41
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
42
- * const inset = await snaptrude.core.geom.update.contour.offset(contour, -0.5)
43
- * const area = await snaptrude.core.geom.query.contour.getArea(inset)
44
- * ```
45
- */
46
- public abstract offset(
47
- contour: ContourHandle,
48
- distance: number,
49
- ): PluginApiReturn<ContourHandle>
50
-
51
- /**
52
- * Translate a contour by a vector. Immutable — returns a NEW contour and leaves
53
- * the input unchanged.
54
- *
55
- * @param contour The contour to move
56
- * @param translation Translation vector to move the contour by
57
- * @returns The moved contour as a NEW {@linkcode ContourHandle}
58
- *
59
- * @examplePrompt Move this shape 2 metres to the right
60
- * @examplePrompt Shift this outline over by 5 feet
61
- *
62
- * # Example
63
- * ```ts
64
- * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
65
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
66
- * const shift = await snaptrude.core.math.vec3.new(2, 0, 0)
67
- * const moved = await snaptrude.core.geom.update.contour.move(contour, shift)
68
- * ```
69
- */
70
- public abstract move(
71
- contour: ContourHandle,
72
- translation: Vec3Handle,
73
- ): PluginApiReturn<ContourHandle>
74
-
75
- /**
76
- * Rotate a contour about an axis through an optional pivot. Immutable — returns a
77
- * NEW contour and leaves the input unchanged.
78
- *
79
- * @param contour The contour to rotate
80
- * @param axis Rotation axis direction
81
- * @param angle Rotation angle in radians
82
- * @param pivot Optional pivot point to rotate about (defaults to the origin)
83
- * @returns The rotated contour as a NEW {@linkcode ContourHandle}
84
- *
85
- * @examplePrompt Rotate this shape 45 degrees
86
- * @examplePrompt Turn this outline 90 degrees about its corner
87
- *
88
- * # Example
89
- * ```ts
90
- * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
91
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
92
- * const axis = await snaptrude.core.math.vec3.new(0, 1, 0)
93
- * const pivot = await snaptrude.core.math.vec3.new(3, 0, 2)
94
- * const rotated = await snaptrude.core.geom.update.contour.rotate(contour, axis, Math.PI / 4, pivot)
95
- * ```
96
- */
97
- public abstract rotate(
98
- contour: ContourHandle,
99
- axis: Vec3Handle,
100
- angle: number,
101
- pivot?: Vec3Handle,
102
- ): PluginApiReturn<ContourHandle>
103
-
104
- /**
105
- * Scale a contour uniformly or per-axis about an optional pivot. Immutable —
106
- * returns a NEW contour and leaves the input unchanged.
107
- *
108
- * @param contour The contour to scale
109
- * @param factor Uniform scale factor, or per-axis factors
110
- * @param pivot Optional pivot point to scale about (defaults to the origin)
111
- * @returns The scaled contour as a NEW {@linkcode ContourHandle}
112
- *
113
- * @examplePrompt Scale this shape up by a factor of 2
114
- * @examplePrompt Make this outline half its current size
115
- *
116
- * # Example
117
- * ```ts
118
- * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
119
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
120
- * const doubled = await snaptrude.core.geom.update.contour.scale(contour, 2)
121
- * const stretched = await snaptrude.core.geom.update.contour.scale(contour, { x: 2, y: 1, z: 1 })
122
- * ```
123
- */
124
- public abstract scale(
125
- contour: ContourHandle,
126
- factor: number | Vec3Components,
127
- pivot?: Vec3Handle,
128
- ): PluginApiReturn<ContourHandle>
129
-
130
- /**
131
- * Mirror a contour across a plane. Immutable — returns a NEW contour and leaves
132
- * the input unchanged.
133
- *
134
- * @param contour The contour to mirror
135
- * @param plane Mirror plane defined by a point on it and its normal
136
- * @returns The mirrored contour as a NEW {@linkcode ContourHandle}
137
- *
138
- * @examplePrompt Mirror this shape across the gridline
139
- * @examplePrompt Flip this outline to its mirror image
140
- *
141
- * # Example
142
- * ```ts
143
- * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
144
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
145
- * const point = await snaptrude.core.math.vec3.new(0, 0, 0)
146
- * const normal = await snaptrude.core.math.vec3.new(1, 0, 0)
147
- * const mirrored = await snaptrude.core.geom.update.contour.mirror(contour, { point, normal })
148
- * ```
149
- */
150
- public abstract mirror(
151
- contour: ContourHandle,
152
- plane: { point: Vec3Handle; normal: Vec3Handle },
153
- ): PluginApiReturn<ContourHandle>
154
-
155
- /**
156
- * Add a hole to a contour by appending an inner profile. Immutable — returns a NEW
157
- * contour and leaves the input unchanged.
158
- *
159
- * @param contour The contour to add a hole to
160
- * @param hole The inner profile to add as a hole
161
- * @returns The contour with the added hole as a NEW {@linkcode ContourHandle}
162
- *
163
- * @examplePrompt Cut a hole in this shape
164
- * @examplePrompt Punch an opening through this floor outline
165
- *
166
- * # Example
167
- * ```ts
168
- * const outer = await snaptrude.core.geom.create.profileRect(10, 8)
169
- * const contour = await snaptrude.core.geom.create.contourFromProfile(outer)
170
- * const hole = await snaptrude.core.geom.create.profileRect(2, 2)
171
- * const withHole = await snaptrude.core.geom.update.contour.addHole(contour, hole)
172
- * const count = await snaptrude.core.geom.query.contour.getHoleCount(withHole) // 1
173
- * ```
174
- */
175
- public abstract addHole(
176
- contour: ContourHandle,
177
- hole: ProfileHandle,
178
- ): PluginApiReturn<ContourHandle>
179
-
180
- /**
181
- * Remove a hole from a contour by inner-profile index. Immutable — returns a NEW
182
- * contour and leaves the input unchanged.
183
- *
184
- * @param contour The contour to remove a hole from
185
- * @param index Zero-based index of the inner profile (hole) to remove
186
- * @returns The contour with the hole removed as a NEW {@linkcode ContourHandle}
187
- *
188
- * @examplePrompt Remove the hole from this shape
189
- * @examplePrompt Fill in the opening in this floor outline
190
- *
191
- * # Example
192
- * ```ts
193
- * const outer = await snaptrude.core.geom.create.profileRect(10, 8)
194
- * const hole = await snaptrude.core.geom.create.profileRect(2, 2)
195
- * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
196
- * const solid = await snaptrude.core.geom.update.contour.removeHole(contour, 0)
197
- * ```
198
- */
199
- public abstract removeHole(
200
- contour: ContourHandle,
201
- index: number,
202
- ): PluginApiReturn<ContourHandle>
203
- }
204
-
205
- /**
206
- * Arguments for {@linkcode PluginGeomUpdateContourApi.offset}.
207
- *
208
- * | Property | Type | Description |
209
- * |---|---|---|
210
- * | `contour` | {@linkcode ContourHandle} | The contour to offset |
211
- * | `distance` | `number` | Signed offset distance (outward when positive, inward when negative) |
212
- */
213
- export const PluginGeomUpdateContourOffsetArgs = z.object({
214
- contour: ContourHandle,
215
- distance: z.number(),
216
- })
217
-
218
- export type PluginGeomUpdateContourOffsetArgs = z.infer<typeof PluginGeomUpdateContourOffsetArgs>
219
-
220
- /**
221
- * Arguments for {@linkcode PluginGeomUpdateContourApi.move}.
222
- *
223
- * | Property | Type | Description |
224
- * |---|---|---|
225
- * | `contour` | {@linkcode ContourHandle} | The contour to move |
226
- * | `translation` | {@linkcode Vec3Handle} | Translation vector to move the contour by |
227
- */
228
- export const PluginGeomUpdateContourMoveArgs = z.object({
229
- contour: ContourHandle,
230
- translation: Vec3Handle,
231
- })
232
-
233
- export type PluginGeomUpdateContourMoveArgs = z.infer<typeof PluginGeomUpdateContourMoveArgs>
234
-
235
- /**
236
- * Arguments for {@linkcode PluginGeomUpdateContourApi.rotate}.
237
- *
238
- * | Property | Type | Description |
239
- * |---|---|---|
240
- * | `contour` | {@linkcode ContourHandle} | The contour to rotate |
241
- * | `axis` | {@linkcode Vec3Handle} | Rotation axis direction |
242
- * | `angle` | `number` | Rotation angle in radians |
243
- * | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to rotate about (defaults to the origin) |
244
- */
245
- export const PluginGeomUpdateContourRotateArgs = z.object({
246
- contour: ContourHandle,
247
- axis: Vec3Handle,
248
- angle: z.number(),
249
- pivot: Vec3Handle.optional(),
250
- })
251
-
252
- export type PluginGeomUpdateContourRotateArgs = z.infer<typeof PluginGeomUpdateContourRotateArgs>
253
-
254
- /**
255
- * Arguments for {@linkcode PluginGeomUpdateContourApi.scale}.
256
- *
257
- * | Property | Type | Description |
258
- * |---|---|---|
259
- * | `contour` | {@linkcode ContourHandle} | The contour to scale |
260
- * | `factor` | `number` \| {@linkcode Vec3Components} | Uniform scale factor, or per-axis factors |
261
- * | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to scale about (defaults to the origin) |
262
- */
263
- export const PluginGeomUpdateContourScaleArgs = z.object({
264
- contour: ContourHandle,
265
- factor: z.union([z.number(), Vec3Components]),
266
- pivot: Vec3Handle.optional(),
267
- })
268
-
269
- export type PluginGeomUpdateContourScaleArgs = z.infer<typeof PluginGeomUpdateContourScaleArgs>
270
-
271
- /**
272
- * Arguments for {@linkcode PluginGeomUpdateContourApi.mirror}.
273
- *
274
- * | Property | Type | Description |
275
- * |---|---|---|
276
- * | `contour` | {@linkcode ContourHandle} | The contour to mirror |
277
- * | `plane` | `{ point: `{@linkcode Vec3Handle}`, normal: `{@linkcode Vec3Handle}` }` | Mirror plane defined by a point on it and its normal |
278
- */
279
- export const PluginGeomUpdateContourMirrorArgs = z.object({
280
- contour: ContourHandle,
281
- plane: z.object({
282
- point: Vec3Handle,
283
- normal: Vec3Handle,
284
- }),
285
- })
286
-
287
- export type PluginGeomUpdateContourMirrorArgs = z.infer<typeof PluginGeomUpdateContourMirrorArgs>
288
-
289
- /**
290
- * Arguments for {@linkcode PluginGeomUpdateContourApi.addHole}.
291
- *
292
- * | Property | Type | Description |
293
- * |---|---|---|
294
- * | `contour` | {@linkcode ContourHandle} | The contour to add a hole to |
295
- * | `hole` | {@linkcode ProfileHandle} | The inner profile to add as a hole |
296
- */
297
- export const PluginGeomUpdateContourAddHoleArgs = z.object({
298
- contour: ContourHandle,
299
- hole: ProfileHandle,
300
- })
301
-
302
- export type PluginGeomUpdateContourAddHoleArgs = z.infer<typeof PluginGeomUpdateContourAddHoleArgs>
303
-
304
- /**
305
- * Arguments for {@linkcode PluginGeomUpdateContourApi.removeHole}.
306
- *
307
- * | Property | Type | Description |
308
- * |---|---|---|
309
- * | `contour` | {@linkcode ContourHandle} | The contour to remove a hole from |
310
- * | `index` | `number` | Zero-based index of the inner profile (hole) to remove |
311
- */
312
- export const PluginGeomUpdateContourRemoveHoleArgs = z.object({
313
- contour: ContourHandle,
314
- index: z.number(),
315
- })
316
-
317
- export type PluginGeomUpdateContourRemoveHoleArgs = z.infer<typeof PluginGeomUpdateContourRemoveHoleArgs>
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../../types"
3
+ import {
4
+ ContourHandle,
5
+ ProfileHandle,
6
+ Vec3Handle,
7
+ Vec3Components,
8
+ } from "../../../../handles"
9
+
10
+ /**
11
+ * Contour editing — produce NEW contours from an existing one (all-handle model, §11).
12
+ *
13
+ * A contour is an outer {@linkcode ProfileHandle} plus zero or more inner profiles
14
+ * that punch holes in it. Every method here is an immutable derive-new operation:
15
+ * it takes an opaque {@linkcode ContourHandle} (plus any extra inputs) and returns a
16
+ * fresh {@linkcode ContourHandle} for the resulting contour. The input contour is
17
+ * never mutated — the original handle keeps referring to the unchanged contour. Read
18
+ * the resulting geometry back as plain values with the query namespace.
19
+ *
20
+ * Accessed via `snaptrude.core.geom.update.contour`.
21
+ */
22
+ export abstract class PluginGeomUpdateContourApi {
23
+ constructor() {}
24
+
25
+ /**
26
+ * Offset a contour inward/outward by a signed distance. Immutable — returns a NEW
27
+ * contour and leaves the input unchanged.
28
+ *
29
+ * @param contour The contour to offset
30
+ * @param distance Signed offset distance (outward when positive, inward when negative)
31
+ * @returns The offset contour as a NEW {@linkcode ContourHandle}
32
+ * @throws PRECONDITION_FAILED if the outline or a hole has a spline run
33
+ * (splines cannot be offset yet)
34
+ *
35
+ * @examplePrompt Offset this boundary 500mm inward
36
+ * @examplePrompt Shrink this floor outline by half a metre all around
37
+ *
38
+ * # Example
39
+ * ```ts
40
+ * const rect = await snaptrude.core.geom.create.profileRect(10, 8)
41
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
42
+ * const inset = await snaptrude.core.geom.update.contour.offset(contour, -0.5)
43
+ * const area = await snaptrude.core.geom.query.contour.getArea(inset)
44
+ * ```
45
+ */
46
+ public abstract offset(
47
+ contour: ContourHandle,
48
+ distance: number,
49
+ ): PluginApiReturn<ContourHandle>
50
+
51
+ /**
52
+ * Translate a contour by a vector. Immutable — returns a NEW contour and leaves
53
+ * the input unchanged.
54
+ *
55
+ * @param contour The contour to move
56
+ * @param translation Translation vector to move the contour by
57
+ * @returns The moved contour as a NEW {@linkcode ContourHandle}
58
+ *
59
+ * @examplePrompt Move this shape 2 metres to the right
60
+ * @examplePrompt Shift this outline over by 5 feet
61
+ *
62
+ * # Example
63
+ * ```ts
64
+ * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
65
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
66
+ * const shift = await snaptrude.core.math.vec3.new(2, 0, 0)
67
+ * const moved = await snaptrude.core.geom.update.contour.move(contour, shift)
68
+ * ```
69
+ */
70
+ public abstract move(
71
+ contour: ContourHandle,
72
+ translation: Vec3Handle,
73
+ ): PluginApiReturn<ContourHandle>
74
+
75
+ /**
76
+ * Rotate a contour about an axis through an optional pivot. Immutable — returns a
77
+ * NEW contour and leaves the input unchanged.
78
+ *
79
+ * @param contour The contour to rotate
80
+ * @param axis Rotation axis direction
81
+ * @param angle Rotation angle in radians
82
+ * @param pivot Optional pivot point to rotate about (defaults to the origin)
83
+ * @returns The rotated contour as a NEW {@linkcode ContourHandle}
84
+ *
85
+ * @examplePrompt Rotate this shape 45 degrees
86
+ * @examplePrompt Turn this outline 90 degrees about its corner
87
+ *
88
+ * # Example
89
+ * ```ts
90
+ * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
91
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
92
+ * const axis = await snaptrude.core.math.vec3.new(0, 1, 0)
93
+ * const pivot = await snaptrude.core.math.vec3.new(3, 0, 2)
94
+ * const rotated = await snaptrude.core.geom.update.contour.rotate(contour, axis, Math.PI / 4, pivot)
95
+ * ```
96
+ */
97
+ public abstract rotate(
98
+ contour: ContourHandle,
99
+ axis: Vec3Handle,
100
+ angle: number,
101
+ pivot?: Vec3Handle,
102
+ ): PluginApiReturn<ContourHandle>
103
+
104
+ /**
105
+ * Scale a contour uniformly or per-axis about an optional pivot. Immutable —
106
+ * returns a NEW contour and leaves the input unchanged.
107
+ *
108
+ * @param contour The contour to scale
109
+ * @param factor Uniform scale factor, or per-axis factors
110
+ * @param pivot Optional pivot point to scale about (defaults to the origin)
111
+ * @returns The scaled contour as a NEW {@linkcode ContourHandle}
112
+ *
113
+ * @examplePrompt Scale this shape up by a factor of 2
114
+ * @examplePrompt Make this outline half its current size
115
+ *
116
+ * # Example
117
+ * ```ts
118
+ * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
119
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
120
+ * const doubled = await snaptrude.core.geom.update.contour.scale(contour, 2)
121
+ * const stretched = await snaptrude.core.geom.update.contour.scale(contour, { x: 2, y: 1, z: 1 })
122
+ * ```
123
+ */
124
+ public abstract scale(
125
+ contour: ContourHandle,
126
+ factor: number | Vec3Components,
127
+ pivot?: Vec3Handle,
128
+ ): PluginApiReturn<ContourHandle>
129
+
130
+ /**
131
+ * Mirror a contour across a plane. Immutable — returns a NEW contour and leaves
132
+ * the input unchanged.
133
+ *
134
+ * @param contour The contour to mirror
135
+ * @param plane Mirror plane defined by a point on it and its normal
136
+ * @returns The mirrored contour as a NEW {@linkcode ContourHandle}
137
+ *
138
+ * @examplePrompt Mirror this shape across the gridline
139
+ * @examplePrompt Flip this outline to its mirror image
140
+ *
141
+ * # Example
142
+ * ```ts
143
+ * const rect = await snaptrude.core.geom.create.profileRect(6, 4)
144
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
145
+ * const point = await snaptrude.core.math.vec3.new(0, 0, 0)
146
+ * const normal = await snaptrude.core.math.vec3.new(1, 0, 0)
147
+ * const mirrored = await snaptrude.core.geom.update.contour.mirror(contour, { point, normal })
148
+ * ```
149
+ */
150
+ public abstract mirror(
151
+ contour: ContourHandle,
152
+ plane: { point: Vec3Handle; normal: Vec3Handle },
153
+ ): PluginApiReturn<ContourHandle>
154
+
155
+ /**
156
+ * Add a hole to a contour by appending an inner profile. Immutable — returns a NEW
157
+ * contour and leaves the input unchanged.
158
+ *
159
+ * Edits a contour value only; for an editable hole in an existing slab, floor
160
+ * or roof use `design.create.void`.
161
+ *
162
+ * @param contour The contour to add a hole to
163
+ * @param hole The inner profile to add as a hole
164
+ * @returns The contour with the added hole as a NEW {@linkcode ContourHandle}
165
+ *
166
+ * @examplePrompt Cut a hole in this shape
167
+ * @examplePrompt Punch an opening through this outline
168
+ *
169
+ * # Example
170
+ * ```ts
171
+ * const outer = await snaptrude.core.geom.create.profileRect(10, 8)
172
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(outer)
173
+ * const hole = await snaptrude.core.geom.create.profileRect(2, 2)
174
+ * const withHole = await snaptrude.core.geom.update.contour.addHole(contour, hole)
175
+ * const count = await snaptrude.core.geom.query.contour.getHoleCount(withHole) // 1
176
+ * ```
177
+ */
178
+ public abstract addHole(
179
+ contour: ContourHandle,
180
+ hole: ProfileHandle,
181
+ ): PluginApiReturn<ContourHandle>
182
+
183
+ /**
184
+ * Remove a hole from a contour by inner-profile index. Immutable — returns a NEW
185
+ * contour and leaves the input unchanged.
186
+ *
187
+ * Edits a contour value only; for an editable hole in an existing slab, floor
188
+ * or roof use `design.create.void`.
189
+ *
190
+ * @param contour The contour to remove a hole from
191
+ * @param index Zero-based index of the inner profile (hole) to remove
192
+ * @returns The contour with the hole removed as a NEW {@linkcode ContourHandle}
193
+ *
194
+ * @examplePrompt Remove the hole from this shape
195
+ * @examplePrompt Fill in the opening in this outline
196
+ *
197
+ * # Example
198
+ * ```ts
199
+ * const outer = await snaptrude.core.geom.create.profileRect(10, 8)
200
+ * const hole = await snaptrude.core.geom.create.profileRect(2, 2)
201
+ * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
202
+ * const solid = await snaptrude.core.geom.update.contour.removeHole(contour, 0)
203
+ * ```
204
+ */
205
+ public abstract removeHole(
206
+ contour: ContourHandle,
207
+ index: number,
208
+ ): PluginApiReturn<ContourHandle>
209
+ }
210
+
211
+ /**
212
+ * Arguments for {@linkcode PluginGeomUpdateContourApi.offset}.
213
+ *
214
+ * | Property | Type | Description |
215
+ * |---|---|---|
216
+ * | `contour` | {@linkcode ContourHandle} | The contour to offset |
217
+ * | `distance` | `number` | Signed offset distance (outward when positive, inward when negative) |
218
+ */
219
+ export const PluginGeomUpdateContourOffsetArgs = z.object({
220
+ contour: ContourHandle,
221
+ distance: z.number(),
222
+ })
223
+
224
+ export type PluginGeomUpdateContourOffsetArgs = z.infer<typeof PluginGeomUpdateContourOffsetArgs>
225
+
226
+ /**
227
+ * Arguments for {@linkcode PluginGeomUpdateContourApi.move}.
228
+ *
229
+ * | Property | Type | Description |
230
+ * |---|---|---|
231
+ * | `contour` | {@linkcode ContourHandle} | The contour to move |
232
+ * | `translation` | {@linkcode Vec3Handle} | Translation vector to move the contour by |
233
+ */
234
+ export const PluginGeomUpdateContourMoveArgs = z.object({
235
+ contour: ContourHandle,
236
+ translation: Vec3Handle,
237
+ })
238
+
239
+ export type PluginGeomUpdateContourMoveArgs = z.infer<typeof PluginGeomUpdateContourMoveArgs>
240
+
241
+ /**
242
+ * Arguments for {@linkcode PluginGeomUpdateContourApi.rotate}.
243
+ *
244
+ * | Property | Type | Description |
245
+ * |---|---|---|
246
+ * | `contour` | {@linkcode ContourHandle} | The contour to rotate |
247
+ * | `axis` | {@linkcode Vec3Handle} | Rotation axis direction |
248
+ * | `angle` | `number` | Rotation angle in radians |
249
+ * | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to rotate about (defaults to the origin) |
250
+ */
251
+ export const PluginGeomUpdateContourRotateArgs = z.object({
252
+ contour: ContourHandle,
253
+ axis: Vec3Handle,
254
+ angle: z.number(),
255
+ pivot: Vec3Handle.optional(),
256
+ })
257
+
258
+ export type PluginGeomUpdateContourRotateArgs = z.infer<typeof PluginGeomUpdateContourRotateArgs>
259
+
260
+ /**
261
+ * Arguments for {@linkcode PluginGeomUpdateContourApi.scale}.
262
+ *
263
+ * | Property | Type | Description |
264
+ * |---|---|---|
265
+ * | `contour` | {@linkcode ContourHandle} | The contour to scale |
266
+ * | `factor` | `number` \| {@linkcode Vec3Components} | Uniform scale factor, or per-axis factors |
267
+ * | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to scale about (defaults to the origin) |
268
+ */
269
+ export const PluginGeomUpdateContourScaleArgs = z.object({
270
+ contour: ContourHandle,
271
+ factor: z.union([z.number(), Vec3Components]),
272
+ pivot: Vec3Handle.optional(),
273
+ })
274
+
275
+ export type PluginGeomUpdateContourScaleArgs = z.infer<typeof PluginGeomUpdateContourScaleArgs>
276
+
277
+ /**
278
+ * Arguments for {@linkcode PluginGeomUpdateContourApi.mirror}.
279
+ *
280
+ * | Property | Type | Description |
281
+ * |---|---|---|
282
+ * | `contour` | {@linkcode ContourHandle} | The contour to mirror |
283
+ * | `plane` | `{ point: `{@linkcode Vec3Handle}`, normal: `{@linkcode Vec3Handle}` }` | Mirror plane defined by a point on it and its normal |
284
+ */
285
+ export const PluginGeomUpdateContourMirrorArgs = z.object({
286
+ contour: ContourHandle,
287
+ plane: z.object({
288
+ point: Vec3Handle,
289
+ normal: Vec3Handle,
290
+ }),
291
+ })
292
+
293
+ export type PluginGeomUpdateContourMirrorArgs = z.infer<typeof PluginGeomUpdateContourMirrorArgs>
294
+
295
+ /**
296
+ * Arguments for {@linkcode PluginGeomUpdateContourApi.addHole}.
297
+ *
298
+ * | Property | Type | Description |
299
+ * |---|---|---|
300
+ * | `contour` | {@linkcode ContourHandle} | The contour to add a hole to |
301
+ * | `hole` | {@linkcode ProfileHandle} | The inner profile to add as a hole |
302
+ */
303
+ export const PluginGeomUpdateContourAddHoleArgs = z.object({
304
+ contour: ContourHandle,
305
+ hole: ProfileHandle,
306
+ })
307
+
308
+ export type PluginGeomUpdateContourAddHoleArgs = z.infer<typeof PluginGeomUpdateContourAddHoleArgs>
309
+
310
+ /**
311
+ * Arguments for {@linkcode PluginGeomUpdateContourApi.removeHole}.
312
+ *
313
+ * | Property | Type | Description |
314
+ * |---|---|---|
315
+ * | `contour` | {@linkcode ContourHandle} | The contour to remove a hole from |
316
+ * | `index` | `number` | Zero-based index of the inner profile (hole) to remove |
317
+ */
318
+ export const PluginGeomUpdateContourRemoveHoleArgs = z.object({
319
+ contour: ContourHandle,
320
+ index: z.number(),
321
+ })
322
+
323
+ export type PluginGeomUpdateContourRemoveHoleArgs = z.infer<typeof PluginGeomUpdateContourRemoveHoleArgs>