@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,540 +1,540 @@
1
- import * as z from "zod"
2
- import { PluginApiReturn } from "../../../../types"
3
- import {
4
- ContourHandle,
5
- ProfileHandle,
6
- Vec3Handle,
7
- Vec3Components,
8
- BBoxComponents,
9
- } from "../../../../handles"
10
-
11
- /**
12
- * Contour queries — read-only geometric questions about a contour (an outer
13
- * {@linkcode ProfileHandle} plus zero or more inner profiles that act as holes)
14
- * and the relationships between two contours (all-handle model, §11).
15
- *
16
- * Every method takes an opaque {@linkcode ContourHandle} (plus point handles
17
- * {@linkcode Vec3Handle} where relevant) and returns plain values — points as
18
- * {@linkcode Vec3Components}, areas/perimeters/counts as `number`, predicates as
19
- * `boolean`, the bounding box as {@linkcode BBoxComponents}. Methods that
20
- * enumerate the contour's child profiles return fresh {@linkcode ProfileHandle}s.
21
- * No query mutates its inputs.
22
- *
23
- * Accessed via `snaptrude.core.geom.query.contour`.
24
- */
25
- export abstract class PluginGeomQueryContourApi {
26
- constructor() {}
27
-
28
- /**
29
- * Get the outer (boundary) profile of a contour. Host API call — mints a fresh handle.
30
- * @param contour The contour to query
31
- * @returns The outer profile as a {@linkcode ProfileHandle}, or `null` if the contour has no outer profile
32
- *
33
- * # Example
34
- * ```ts
35
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
36
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
37
- * const outer = await snaptrude.core.geom.query.contour.getOuterProfile(contour)
38
- * if (outer) console.log(await snaptrude.core.geom.query.profile.getPerimeter(outer))
39
- * ```
40
- */
41
- public abstract getOuterProfile(
42
- contour: ContourHandle
43
- ): PluginApiReturn<ProfileHandle | null>
44
-
45
- /**
46
- * List the inner profiles (holes) of a contour. Host API call — mints fresh handles.
47
- * @param contour The contour to query
48
- * @returns The contour's holes as {@linkcode ProfileHandle}`[]`
49
- *
50
- * # Example
51
- * ```ts
52
- * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
53
- * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
54
- * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
55
- * const holes = await snaptrude.core.geom.query.contour.listHoles(contour)
56
- * for (const h of holes) console.log(await snaptrude.core.geom.query.profile.getArea(h))
57
- * ```
58
- */
59
- public abstract listHoles(
60
- contour: ContourHandle
61
- ): PluginApiReturn<ProfileHandle[]>
62
-
63
- /**
64
- * Get the number of inner profiles (holes) in a contour.
65
- * @param contour The contour to query
66
- * @returns The hole count as a `number`
67
- *
68
- * @examplePrompt How many holes does this shape have?
69
- * @examplePrompt Count the openings in this slab outline
70
- *
71
- * # Example
72
- * ```ts
73
- * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
74
- * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
75
- * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
76
- * const count = await snaptrude.core.geom.query.contour.getHoleCount(contour) // 1
77
- * ```
78
- */
79
- public abstract getHoleCount(
80
- contour: ContourHandle
81
- ): PluginApiReturn<number>
82
-
83
- /**
84
- * Get the (approximate) net enclosed area of a contour — the outer profile area
85
- * minus the area of every hole.
86
- * @param contour The contour to query
87
- * @returns The area as a `number`
88
- *
89
- * @examplePrompt What is the area of this shape?
90
- * @examplePrompt Calculate the usable area of this outline after subtracting its holes
91
- *
92
- * # Example
93
- * ```ts
94
- * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
95
- * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
96
- * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
97
- * const area = await snaptrude.core.geom.query.contour.getArea(contour) // 24 - 2 = 22
98
- * ```
99
- */
100
- public abstract getArea(
101
- contour: ContourHandle
102
- ): PluginApiReturn<number>
103
-
104
- /**
105
- * Get the perimeter (total length of every curve) of a contour, including holes.
106
- * @param contour The contour to query
107
- * @returns The perimeter as a `number`
108
- *
109
- * @examplePrompt What is the perimeter of this shape?
110
- * @examplePrompt How long is the boundary of this outline, including its holes?
111
- *
112
- * # Example
113
- * ```ts
114
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
115
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
116
- * const perimeter = await snaptrude.core.geom.query.contour.getPerimeter(contour) // 14
117
- * ```
118
- */
119
- public abstract getPerimeter(
120
- contour: ContourHandle
121
- ): PluginApiReturn<number>
122
-
123
- /**
124
- * Get the axis-aligned bounding box of a contour.
125
- * @param contour The contour to query
126
- * @returns The bounding box as {@linkcode BBoxComponents}
127
- *
128
- * @examplePrompt What are the overall extents of this shape?
129
- *
130
- * # Example
131
- * ```ts
132
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
133
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
134
- * const { min, max } = await snaptrude.core.geom.query.contour.getBoundingBox(contour)
135
- * console.log(max.x - min.x, max.z - min.z) // 4 3
136
- * ```
137
- */
138
- public abstract getBoundingBox(
139
- contour: ContourHandle
140
- ): PluginApiReturn<BBoxComponents>
141
-
142
- /**
143
- * Get the unit normal vector of a contour's plane.
144
- * @param contour The contour to query
145
- * @returns The normal as {@linkcode Vec3Components}, or `null` if the contour has no well-defined normal
146
- *
147
- * # Example
148
- * ```ts
149
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
150
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
151
- * const normal = await snaptrude.core.geom.query.contour.getNormal(contour)
152
- * if (normal) console.log(normal.x, normal.y, normal.z)
153
- * ```
154
- */
155
- public abstract getNormal(
156
- contour: ContourHandle
157
- ): PluginApiReturn<Vec3Components | null>
158
-
159
- /**
160
- * Get the point on a contour nearest to an arbitrary point.
161
- * @param contour The contour to query
162
- * @param point The reference point
163
- * @returns The nearest point on the contour as {@linkcode Vec3Components}
164
- *
165
- * @examplePrompt Find the point on this boundary closest to a given location
166
- *
167
- * # Example
168
- * ```ts
169
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
170
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
171
- * const point = await snaptrude.core.math.vec3.new(5, 0, 0)
172
- * const nearest = await snaptrude.core.geom.query.contour.getNearestPoint(contour, point)
173
- * console.log(nearest.x, nearest.y, nearest.z) // 2 0 0
174
- * ```
175
- */
176
- public abstract getNearestPoint(
177
- contour: ContourHandle,
178
- point: Vec3Handle
179
- ): PluginApiReturn<Vec3Components>
180
-
181
- /**
182
- * Test whether a point lies inside a contour (inside the outer profile and
183
- * outside every hole).
184
- * @param contour The contour to query
185
- * @param point The point to test
186
- * @returns `true` if the point is inside the contour, otherwise `false`
187
- *
188
- * @examplePrompt Is this point inside the shape?
189
- * @examplePrompt Check whether a location falls within this boundary but not in a hole
190
- *
191
- * # Example
192
- * ```ts
193
- * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
194
- * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
195
- * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
196
- * const point = await snaptrude.core.math.vec3.new(2.5, 0, 1.5)
197
- * const inside = await snaptrude.core.geom.query.contour.hasPoint(contour, point) // true — outside the hole
198
- * ```
199
- */
200
- public abstract hasPoint(
201
- contour: ContourHandle,
202
- point: Vec3Handle
203
- ): PluginApiReturn<boolean>
204
-
205
- /**
206
- * Test whether a point lies on a contour's boundary (any of its curves).
207
- * @param contour The contour to query
208
- * @param point The point to test
209
- * @returns `true` if the point is on the boundary, otherwise `false`
210
- *
211
- * # Example
212
- * ```ts
213
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
214
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
215
- * const point = await snaptrude.core.math.vec3.new(2, 0, 0)
216
- * const onEdge = await snaptrude.core.geom.query.contour.isOnBoundary(contour, point) // true
217
- * ```
218
- */
219
- public abstract isOnBoundary(
220
- contour: ContourHandle,
221
- point: Vec3Handle
222
- ): PluginApiReturn<boolean>
223
-
224
- /**
225
- * Test whether a contour's outer profile is wound clockwise on the XZ plane.
226
- * @param contour The contour to query
227
- * @returns `true` if the contour is clockwise, otherwise `false`
228
- *
229
- * # Example
230
- * ```ts
231
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
232
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
233
- * const clockwise = await snaptrude.core.geom.query.contour.isClockwise(contour)
234
- * ```
235
- */
236
- public abstract isClockwise(
237
- contour: ContourHandle
238
- ): PluginApiReturn<boolean>
239
-
240
- /**
241
- * Test whether a contour is planar.
242
- * @param contour The contour to query
243
- * @returns `true` if the contour is planar, otherwise `false`
244
- *
245
- * # Example
246
- * ```ts
247
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
248
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
249
- * const planar = await snaptrude.core.geom.query.contour.isPlanar(contour) // true
250
- * ```
251
- */
252
- public abstract isPlanar(
253
- contour: ContourHandle
254
- ): PluginApiReturn<boolean>
255
-
256
- /**
257
- * Test whether a contour is empty (its outer profile contains no curves).
258
- * @param contour The contour to query
259
- * @returns `true` if the contour is empty, otherwise `false`
260
- *
261
- * # Example
262
- * ```ts
263
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
264
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
265
- * const empty = await snaptrude.core.geom.query.contour.isEmpty(contour) // false
266
- * ```
267
- */
268
- public abstract isEmpty(
269
- contour: ContourHandle
270
- ): PluginApiReturn<boolean>
271
-
272
- /**
273
- * Test whether a contour intersects itself.
274
- * @param contour The contour to query
275
- * @returns `true` if the contour is self-intersecting, otherwise `false`
276
- *
277
- * # Example
278
- * ```ts
279
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
280
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
281
- * const crossed = await snaptrude.core.geom.query.contour.isSelfIntersecting(contour) // false
282
- * ```
283
- */
284
- public abstract isSelfIntersecting(
285
- contour: ContourHandle
286
- ): PluginApiReturn<boolean>
287
-
288
- /**
289
- * Test whether a contour's orientation is valid (outer profile and holes are
290
- * wound consistently).
291
- * @param contour The contour to query
292
- * @returns `true` if the orientation is valid, otherwise `false`
293
- *
294
- * # Example
295
- * ```ts
296
- * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
297
- * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
298
- * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
299
- * const valid = await snaptrude.core.geom.query.contour.isOrientationValid(contour)
300
- * ```
301
- */
302
- public abstract isOrientationValid(
303
- contour: ContourHandle
304
- ): PluginApiReturn<boolean>
305
-
306
- /**
307
- * Test whether two contours are geometrically equal.
308
- * @param contourA First contour
309
- * @param contourB Second contour
310
- * @returns `true` if the contours are equal, otherwise `false`
311
- *
312
- * # Example
313
- * ```ts
314
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
315
- * const a = await snaptrude.core.geom.create.contourFromProfile(rect)
316
- * const b = await snaptrude.core.geom.create.contourFromProfile(rect)
317
- * const same = await snaptrude.core.geom.query.contour.isEqual(a, b) // true
318
- * ```
319
- */
320
- public abstract isEqual(
321
- contourA: ContourHandle,
322
- contourB: ContourHandle
323
- ): PluginApiReturn<boolean>
324
- }
325
-
326
- /**
327
- * Arguments for {@linkcode PluginGeomQueryContourApi.getOuterProfile}.
328
- *
329
- * | Property | Type | Description |
330
- * |---|---|---|
331
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
332
- */
333
- export const PluginGeomQueryContourGetOuterProfileArgs = z.object({
334
- contour: ContourHandle,
335
- })
336
-
337
- export type PluginGeomQueryContourGetOuterProfileArgs = z.infer<typeof PluginGeomQueryContourGetOuterProfileArgs>
338
-
339
- /**
340
- * Arguments for {@linkcode PluginGeomQueryContourApi.listHoles}.
341
- *
342
- * | Property | Type | Description |
343
- * |---|---|---|
344
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
345
- */
346
- export const PluginGeomQueryContourListHolesArgs = z.object({
347
- contour: ContourHandle,
348
- })
349
-
350
- export type PluginGeomQueryContourListHolesArgs = z.infer<typeof PluginGeomQueryContourListHolesArgs>
351
-
352
- /**
353
- * Arguments for {@linkcode PluginGeomQueryContourApi.getHoleCount}.
354
- *
355
- * | Property | Type | Description |
356
- * |---|---|---|
357
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
358
- */
359
- export const PluginGeomQueryContourGetHoleCountArgs = z.object({
360
- contour: ContourHandle,
361
- })
362
-
363
- export type PluginGeomQueryContourGetHoleCountArgs = z.infer<typeof PluginGeomQueryContourGetHoleCountArgs>
364
-
365
- /**
366
- * Arguments for {@linkcode PluginGeomQueryContourApi.getArea}.
367
- *
368
- * | Property | Type | Description |
369
- * |---|---|---|
370
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
371
- */
372
- export const PluginGeomQueryContourGetAreaArgs = z.object({
373
- contour: ContourHandle,
374
- })
375
-
376
- export type PluginGeomQueryContourGetAreaArgs = z.infer<typeof PluginGeomQueryContourGetAreaArgs>
377
-
378
- /**
379
- * Arguments for {@linkcode PluginGeomQueryContourApi.getPerimeter}.
380
- *
381
- * | Property | Type | Description |
382
- * |---|---|---|
383
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
384
- */
385
- export const PluginGeomQueryContourGetPerimeterArgs = z.object({
386
- contour: ContourHandle,
387
- })
388
-
389
- export type PluginGeomQueryContourGetPerimeterArgs = z.infer<typeof PluginGeomQueryContourGetPerimeterArgs>
390
-
391
- /**
392
- * Arguments for {@linkcode PluginGeomQueryContourApi.getBoundingBox}.
393
- *
394
- * | Property | Type | Description |
395
- * |---|---|---|
396
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
397
- */
398
- export const PluginGeomQueryContourGetBoundingBoxArgs = z.object({
399
- contour: ContourHandle,
400
- })
401
-
402
- export type PluginGeomQueryContourGetBoundingBoxArgs = z.infer<typeof PluginGeomQueryContourGetBoundingBoxArgs>
403
-
404
- /**
405
- * Arguments for {@linkcode PluginGeomQueryContourApi.getNormal}.
406
- *
407
- * | Property | Type | Description |
408
- * |---|---|---|
409
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
410
- */
411
- export const PluginGeomQueryContourGetNormalArgs = z.object({
412
- contour: ContourHandle,
413
- })
414
-
415
- export type PluginGeomQueryContourGetNormalArgs = z.infer<typeof PluginGeomQueryContourGetNormalArgs>
416
-
417
- /**
418
- * Arguments for {@linkcode PluginGeomQueryContourApi.getNearestPoint}.
419
- *
420
- * | Property | Type | Description |
421
- * |---|---|---|
422
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
423
- * | `point` | {@linkcode Vec3Handle} | The reference point |
424
- */
425
- export const PluginGeomQueryContourGetNearestPointArgs = z.object({
426
- contour: ContourHandle,
427
- point: Vec3Handle,
428
- })
429
-
430
- export type PluginGeomQueryContourGetNearestPointArgs = z.infer<typeof PluginGeomQueryContourGetNearestPointArgs>
431
-
432
- /**
433
- * Arguments for {@linkcode PluginGeomQueryContourApi.hasPoint}.
434
- *
435
- * | Property | Type | Description |
436
- * |---|---|---|
437
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
438
- * | `point` | {@linkcode Vec3Handle} | The point to test |
439
- */
440
- export const PluginGeomQueryContourHasPointArgs = z.object({
441
- contour: ContourHandle,
442
- point: Vec3Handle,
443
- })
444
-
445
- export type PluginGeomQueryContourHasPointArgs = z.infer<typeof PluginGeomQueryContourHasPointArgs>
446
-
447
- /**
448
- * Arguments for {@linkcode PluginGeomQueryContourApi.isOnBoundary}.
449
- *
450
- * | Property | Type | Description |
451
- * |---|---|---|
452
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
453
- * | `point` | {@linkcode Vec3Handle} | The point to test |
454
- */
455
- export const PluginGeomQueryContourIsOnBoundaryArgs = z.object({
456
- contour: ContourHandle,
457
- point: Vec3Handle,
458
- })
459
-
460
- export type PluginGeomQueryContourIsOnBoundaryArgs = z.infer<typeof PluginGeomQueryContourIsOnBoundaryArgs>
461
-
462
- /**
463
- * Arguments for {@linkcode PluginGeomQueryContourApi.isClockwise}.
464
- *
465
- * | Property | Type | Description |
466
- * |---|---|---|
467
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
468
- */
469
- export const PluginGeomQueryContourIsClockwiseArgs = z.object({
470
- contour: ContourHandle,
471
- })
472
-
473
- export type PluginGeomQueryContourIsClockwiseArgs = z.infer<typeof PluginGeomQueryContourIsClockwiseArgs>
474
-
475
- /**
476
- * Arguments for {@linkcode PluginGeomQueryContourApi.isPlanar}.
477
- *
478
- * | Property | Type | Description |
479
- * |---|---|---|
480
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
481
- */
482
- export const PluginGeomQueryContourIsPlanarArgs = z.object({
483
- contour: ContourHandle,
484
- })
485
-
486
- export type PluginGeomQueryContourIsPlanarArgs = z.infer<typeof PluginGeomQueryContourIsPlanarArgs>
487
-
488
- /**
489
- * Arguments for {@linkcode PluginGeomQueryContourApi.isEmpty}.
490
- *
491
- * | Property | Type | Description |
492
- * |---|---|---|
493
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
494
- */
495
- export const PluginGeomQueryContourIsEmptyArgs = z.object({
496
- contour: ContourHandle,
497
- })
498
-
499
- export type PluginGeomQueryContourIsEmptyArgs = z.infer<typeof PluginGeomQueryContourIsEmptyArgs>
500
-
501
- /**
502
- * Arguments for {@linkcode PluginGeomQueryContourApi.isSelfIntersecting}.
503
- *
504
- * | Property | Type | Description |
505
- * |---|---|---|
506
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
507
- */
508
- export const PluginGeomQueryContourIsSelfIntersectingArgs = z.object({
509
- contour: ContourHandle,
510
- })
511
-
512
- export type PluginGeomQueryContourIsSelfIntersectingArgs = z.infer<typeof PluginGeomQueryContourIsSelfIntersectingArgs>
513
-
514
- /**
515
- * Arguments for {@linkcode PluginGeomQueryContourApi.isOrientationValid}.
516
- *
517
- * | Property | Type | Description |
518
- * |---|---|---|
519
- * | `contour` | {@linkcode ContourHandle} | The contour to query |
520
- */
521
- export const PluginGeomQueryContourIsOrientationValidArgs = z.object({
522
- contour: ContourHandle,
523
- })
524
-
525
- export type PluginGeomQueryContourIsOrientationValidArgs = z.infer<typeof PluginGeomQueryContourIsOrientationValidArgs>
526
-
527
- /**
528
- * Arguments for {@linkcode PluginGeomQueryContourApi.isEqual}.
529
- *
530
- * | Property | Type | Description |
531
- * |---|---|---|
532
- * | `contourA` | {@linkcode ContourHandle} | First contour |
533
- * | `contourB` | {@linkcode ContourHandle} | Second contour |
534
- */
535
- export const PluginGeomQueryContourIsEqualArgs = z.object({
536
- contourA: ContourHandle,
537
- contourB: ContourHandle,
538
- })
539
-
540
- export type PluginGeomQueryContourIsEqualArgs = z.infer<typeof PluginGeomQueryContourIsEqualArgs>
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../../types"
3
+ import {
4
+ ContourHandle,
5
+ ProfileHandle,
6
+ Vec3Handle,
7
+ Vec3Components,
8
+ BBoxComponents,
9
+ } from "../../../../handles"
10
+
11
+ /**
12
+ * Contour queries — read-only geometric questions about a contour (an outer
13
+ * {@linkcode ProfileHandle} plus zero or more inner profiles that act as holes)
14
+ * and the relationships between two contours (all-handle model, §11).
15
+ *
16
+ * Every method takes an opaque {@linkcode ContourHandle} (plus point handles
17
+ * {@linkcode Vec3Handle} where relevant) and returns plain values — points as
18
+ * {@linkcode Vec3Components}, areas/perimeters/counts as `number`, predicates as
19
+ * `boolean`, the bounding box as {@linkcode BBoxComponents}. Methods that
20
+ * enumerate the contour's child profiles return fresh {@linkcode ProfileHandle}s.
21
+ * No query mutates its inputs.
22
+ *
23
+ * Accessed via `snaptrude.core.geom.query.contour`.
24
+ */
25
+ export abstract class PluginGeomQueryContourApi {
26
+ constructor() {}
27
+
28
+ /**
29
+ * Get the outer (boundary) profile of a contour. Host API call — mints a fresh handle.
30
+ * @param contour The contour to query
31
+ * @returns The outer profile as a {@linkcode ProfileHandle}, or `null` if the contour has no outer profile
32
+ *
33
+ * # Example
34
+ * ```ts
35
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
36
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
37
+ * const outer = await snaptrude.core.geom.query.contour.getOuterProfile(contour)
38
+ * if (outer) console.log(await snaptrude.core.geom.query.profile.getPerimeter(outer))
39
+ * ```
40
+ */
41
+ public abstract getOuterProfile(
42
+ contour: ContourHandle
43
+ ): PluginApiReturn<ProfileHandle | null>
44
+
45
+ /**
46
+ * List the inner profiles (holes) of a contour. Host API call — mints fresh handles.
47
+ * @param contour The contour to query
48
+ * @returns The contour's holes as {@linkcode ProfileHandle}`[]`
49
+ *
50
+ * # Example
51
+ * ```ts
52
+ * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
53
+ * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
54
+ * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
55
+ * const holes = await snaptrude.core.geom.query.contour.listHoles(contour)
56
+ * for (const h of holes) console.log(await snaptrude.core.geom.query.profile.getArea(h))
57
+ * ```
58
+ */
59
+ public abstract listHoles(
60
+ contour: ContourHandle
61
+ ): PluginApiReturn<ProfileHandle[]>
62
+
63
+ /**
64
+ * Get the number of inner profiles (holes) in a contour.
65
+ * @param contour The contour to query
66
+ * @returns The hole count as a `number`
67
+ *
68
+ * @examplePrompt How many holes does this shape have?
69
+ * @examplePrompt Count the openings in this slab outline
70
+ *
71
+ * # Example
72
+ * ```ts
73
+ * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
74
+ * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
75
+ * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
76
+ * const count = await snaptrude.core.geom.query.contour.getHoleCount(contour) // 1
77
+ * ```
78
+ */
79
+ public abstract getHoleCount(
80
+ contour: ContourHandle
81
+ ): PluginApiReturn<number>
82
+
83
+ /**
84
+ * Get the (approximate) net enclosed area of a contour — the outer profile area
85
+ * minus the area of every hole.
86
+ * @param contour The contour to query
87
+ * @returns The area as a `number`
88
+ *
89
+ * @examplePrompt What is the area of this shape?
90
+ * @examplePrompt Calculate the usable area of this outline after subtracting its holes
91
+ *
92
+ * # Example
93
+ * ```ts
94
+ * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
95
+ * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
96
+ * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
97
+ * const area = await snaptrude.core.geom.query.contour.getArea(contour) // 24 - 2 = 22
98
+ * ```
99
+ */
100
+ public abstract getArea(
101
+ contour: ContourHandle
102
+ ): PluginApiReturn<number>
103
+
104
+ /**
105
+ * Get the perimeter (total length of every curve) of a contour, including holes.
106
+ * @param contour The contour to query
107
+ * @returns The perimeter as a `number`
108
+ *
109
+ * @examplePrompt What is the perimeter of this shape?
110
+ * @examplePrompt How long is the boundary of this outline, including its holes?
111
+ *
112
+ * # Example
113
+ * ```ts
114
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
115
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
116
+ * const perimeter = await snaptrude.core.geom.query.contour.getPerimeter(contour) // 14
117
+ * ```
118
+ */
119
+ public abstract getPerimeter(
120
+ contour: ContourHandle
121
+ ): PluginApiReturn<number>
122
+
123
+ /**
124
+ * Get the axis-aligned bounding box of a contour.
125
+ * @param contour The contour to query
126
+ * @returns The bounding box as {@linkcode BBoxComponents}
127
+ *
128
+ * @examplePrompt What are the overall extents of this shape?
129
+ *
130
+ * # Example
131
+ * ```ts
132
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
133
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
134
+ * const { min, max } = await snaptrude.core.geom.query.contour.getBoundingBox(contour)
135
+ * console.log(max.x - min.x, max.z - min.z) // 4 3
136
+ * ```
137
+ */
138
+ public abstract getBoundingBox(
139
+ contour: ContourHandle
140
+ ): PluginApiReturn<BBoxComponents>
141
+
142
+ /**
143
+ * Get the unit normal vector of a contour's plane.
144
+ * @param contour The contour to query
145
+ * @returns The normal as {@linkcode Vec3Components}, or `null` if the contour has no well-defined normal
146
+ *
147
+ * # Example
148
+ * ```ts
149
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
150
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
151
+ * const normal = await snaptrude.core.geom.query.contour.getNormal(contour)
152
+ * if (normal) console.log(normal.x, normal.y, normal.z)
153
+ * ```
154
+ */
155
+ public abstract getNormal(
156
+ contour: ContourHandle
157
+ ): PluginApiReturn<Vec3Components | null>
158
+
159
+ /**
160
+ * Get the point on a contour nearest to an arbitrary point.
161
+ * @param contour The contour to query
162
+ * @param point The reference point
163
+ * @returns The nearest point on the contour as {@linkcode Vec3Components}
164
+ *
165
+ * @examplePrompt Find the point on this boundary closest to a given location
166
+ *
167
+ * # Example
168
+ * ```ts
169
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
170
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
171
+ * const point = await snaptrude.core.math.vec3.new(5, 0, 0)
172
+ * const nearest = await snaptrude.core.geom.query.contour.getNearestPoint(contour, point)
173
+ * console.log(nearest.x, nearest.y, nearest.z) // 2 0 0
174
+ * ```
175
+ */
176
+ public abstract getNearestPoint(
177
+ contour: ContourHandle,
178
+ point: Vec3Handle
179
+ ): PluginApiReturn<Vec3Components>
180
+
181
+ /**
182
+ * Test whether a point lies inside a contour (inside the outer profile and
183
+ * outside every hole).
184
+ * @param contour The contour to query
185
+ * @param point The point to test
186
+ * @returns `true` if the point is inside the contour, otherwise `false`
187
+ *
188
+ * @examplePrompt Is this point inside the shape?
189
+ * @examplePrompt Check whether a location falls within this boundary but not in a hole
190
+ *
191
+ * # Example
192
+ * ```ts
193
+ * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
194
+ * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
195
+ * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
196
+ * const point = await snaptrude.core.math.vec3.new(2.5, 0, 1.5)
197
+ * const inside = await snaptrude.core.geom.query.contour.hasPoint(contour, point) // true — outside the hole
198
+ * ```
199
+ */
200
+ public abstract hasPoint(
201
+ contour: ContourHandle,
202
+ point: Vec3Handle
203
+ ): PluginApiReturn<boolean>
204
+
205
+ /**
206
+ * Test whether a point lies on a contour's boundary (any of its curves).
207
+ * @param contour The contour to query
208
+ * @param point The point to test
209
+ * @returns `true` if the point is on the boundary, otherwise `false`
210
+ *
211
+ * # Example
212
+ * ```ts
213
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
214
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
215
+ * const point = await snaptrude.core.math.vec3.new(2, 0, 0)
216
+ * const onEdge = await snaptrude.core.geom.query.contour.isOnBoundary(contour, point) // true
217
+ * ```
218
+ */
219
+ public abstract isOnBoundary(
220
+ contour: ContourHandle,
221
+ point: Vec3Handle
222
+ ): PluginApiReturn<boolean>
223
+
224
+ /**
225
+ * Test whether a contour's outer profile is wound clockwise on the XZ plane.
226
+ * @param contour The contour to query
227
+ * @returns `true` if the contour is clockwise, otherwise `false`
228
+ *
229
+ * # Example
230
+ * ```ts
231
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
232
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
233
+ * const clockwise = await snaptrude.core.geom.query.contour.isClockwise(contour)
234
+ * ```
235
+ */
236
+ public abstract isClockwise(
237
+ contour: ContourHandle
238
+ ): PluginApiReturn<boolean>
239
+
240
+ /**
241
+ * Test whether a contour is planar.
242
+ * @param contour The contour to query
243
+ * @returns `true` if the contour is planar, otherwise `false`
244
+ *
245
+ * # Example
246
+ * ```ts
247
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
248
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
249
+ * const planar = await snaptrude.core.geom.query.contour.isPlanar(contour) // true
250
+ * ```
251
+ */
252
+ public abstract isPlanar(
253
+ contour: ContourHandle
254
+ ): PluginApiReturn<boolean>
255
+
256
+ /**
257
+ * Test whether a contour is empty (its outer profile contains no curves).
258
+ * @param contour The contour to query
259
+ * @returns `true` if the contour is empty, otherwise `false`
260
+ *
261
+ * # Example
262
+ * ```ts
263
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
264
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
265
+ * const empty = await snaptrude.core.geom.query.contour.isEmpty(contour) // false
266
+ * ```
267
+ */
268
+ public abstract isEmpty(
269
+ contour: ContourHandle
270
+ ): PluginApiReturn<boolean>
271
+
272
+ /**
273
+ * Test whether a contour intersects itself.
274
+ * @param contour The contour to query
275
+ * @returns `true` if the contour is self-intersecting, otherwise `false`
276
+ *
277
+ * # Example
278
+ * ```ts
279
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
280
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
281
+ * const crossed = await snaptrude.core.geom.query.contour.isSelfIntersecting(contour) // false
282
+ * ```
283
+ */
284
+ public abstract isSelfIntersecting(
285
+ contour: ContourHandle
286
+ ): PluginApiReturn<boolean>
287
+
288
+ /**
289
+ * Test whether a contour's orientation is valid (outer profile and holes are
290
+ * wound consistently).
291
+ * @param contour The contour to query
292
+ * @returns `true` if the orientation is valid, otherwise `false`
293
+ *
294
+ * # Example
295
+ * ```ts
296
+ * const outer = await snaptrude.core.geom.create.profileRect(6, 4)
297
+ * const hole = await snaptrude.core.geom.create.profileRect(2, 1)
298
+ * const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
299
+ * const valid = await snaptrude.core.geom.query.contour.isOrientationValid(contour)
300
+ * ```
301
+ */
302
+ public abstract isOrientationValid(
303
+ contour: ContourHandle
304
+ ): PluginApiReturn<boolean>
305
+
306
+ /**
307
+ * Test whether two contours are geometrically equal.
308
+ * @param contourA First contour
309
+ * @param contourB Second contour
310
+ * @returns `true` if the contours are equal, otherwise `false`
311
+ *
312
+ * # Example
313
+ * ```ts
314
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
315
+ * const a = await snaptrude.core.geom.create.contourFromProfile(rect)
316
+ * const b = await snaptrude.core.geom.create.contourFromProfile(rect)
317
+ * const same = await snaptrude.core.geom.query.contour.isEqual(a, b) // true
318
+ * ```
319
+ */
320
+ public abstract isEqual(
321
+ contourA: ContourHandle,
322
+ contourB: ContourHandle
323
+ ): PluginApiReturn<boolean>
324
+ }
325
+
326
+ /**
327
+ * Arguments for {@linkcode PluginGeomQueryContourApi.getOuterProfile}.
328
+ *
329
+ * | Property | Type | Description |
330
+ * |---|---|---|
331
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
332
+ */
333
+ export const PluginGeomQueryContourGetOuterProfileArgs = z.object({
334
+ contour: ContourHandle,
335
+ })
336
+
337
+ export type PluginGeomQueryContourGetOuterProfileArgs = z.infer<typeof PluginGeomQueryContourGetOuterProfileArgs>
338
+
339
+ /**
340
+ * Arguments for {@linkcode PluginGeomQueryContourApi.listHoles}.
341
+ *
342
+ * | Property | Type | Description |
343
+ * |---|---|---|
344
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
345
+ */
346
+ export const PluginGeomQueryContourListHolesArgs = z.object({
347
+ contour: ContourHandle,
348
+ })
349
+
350
+ export type PluginGeomQueryContourListHolesArgs = z.infer<typeof PluginGeomQueryContourListHolesArgs>
351
+
352
+ /**
353
+ * Arguments for {@linkcode PluginGeomQueryContourApi.getHoleCount}.
354
+ *
355
+ * | Property | Type | Description |
356
+ * |---|---|---|
357
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
358
+ */
359
+ export const PluginGeomQueryContourGetHoleCountArgs = z.object({
360
+ contour: ContourHandle,
361
+ })
362
+
363
+ export type PluginGeomQueryContourGetHoleCountArgs = z.infer<typeof PluginGeomQueryContourGetHoleCountArgs>
364
+
365
+ /**
366
+ * Arguments for {@linkcode PluginGeomQueryContourApi.getArea}.
367
+ *
368
+ * | Property | Type | Description |
369
+ * |---|---|---|
370
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
371
+ */
372
+ export const PluginGeomQueryContourGetAreaArgs = z.object({
373
+ contour: ContourHandle,
374
+ })
375
+
376
+ export type PluginGeomQueryContourGetAreaArgs = z.infer<typeof PluginGeomQueryContourGetAreaArgs>
377
+
378
+ /**
379
+ * Arguments for {@linkcode PluginGeomQueryContourApi.getPerimeter}.
380
+ *
381
+ * | Property | Type | Description |
382
+ * |---|---|---|
383
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
384
+ */
385
+ export const PluginGeomQueryContourGetPerimeterArgs = z.object({
386
+ contour: ContourHandle,
387
+ })
388
+
389
+ export type PluginGeomQueryContourGetPerimeterArgs = z.infer<typeof PluginGeomQueryContourGetPerimeterArgs>
390
+
391
+ /**
392
+ * Arguments for {@linkcode PluginGeomQueryContourApi.getBoundingBox}.
393
+ *
394
+ * | Property | Type | Description |
395
+ * |---|---|---|
396
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
397
+ */
398
+ export const PluginGeomQueryContourGetBoundingBoxArgs = z.object({
399
+ contour: ContourHandle,
400
+ })
401
+
402
+ export type PluginGeomQueryContourGetBoundingBoxArgs = z.infer<typeof PluginGeomQueryContourGetBoundingBoxArgs>
403
+
404
+ /**
405
+ * Arguments for {@linkcode PluginGeomQueryContourApi.getNormal}.
406
+ *
407
+ * | Property | Type | Description |
408
+ * |---|---|---|
409
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
410
+ */
411
+ export const PluginGeomQueryContourGetNormalArgs = z.object({
412
+ contour: ContourHandle,
413
+ })
414
+
415
+ export type PluginGeomQueryContourGetNormalArgs = z.infer<typeof PluginGeomQueryContourGetNormalArgs>
416
+
417
+ /**
418
+ * Arguments for {@linkcode PluginGeomQueryContourApi.getNearestPoint}.
419
+ *
420
+ * | Property | Type | Description |
421
+ * |---|---|---|
422
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
423
+ * | `point` | {@linkcode Vec3Handle} | The reference point |
424
+ */
425
+ export const PluginGeomQueryContourGetNearestPointArgs = z.object({
426
+ contour: ContourHandle,
427
+ point: Vec3Handle,
428
+ })
429
+
430
+ export type PluginGeomQueryContourGetNearestPointArgs = z.infer<typeof PluginGeomQueryContourGetNearestPointArgs>
431
+
432
+ /**
433
+ * Arguments for {@linkcode PluginGeomQueryContourApi.hasPoint}.
434
+ *
435
+ * | Property | Type | Description |
436
+ * |---|---|---|
437
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
438
+ * | `point` | {@linkcode Vec3Handle} | The point to test |
439
+ */
440
+ export const PluginGeomQueryContourHasPointArgs = z.object({
441
+ contour: ContourHandle,
442
+ point: Vec3Handle,
443
+ })
444
+
445
+ export type PluginGeomQueryContourHasPointArgs = z.infer<typeof PluginGeomQueryContourHasPointArgs>
446
+
447
+ /**
448
+ * Arguments for {@linkcode PluginGeomQueryContourApi.isOnBoundary}.
449
+ *
450
+ * | Property | Type | Description |
451
+ * |---|---|---|
452
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
453
+ * | `point` | {@linkcode Vec3Handle} | The point to test |
454
+ */
455
+ export const PluginGeomQueryContourIsOnBoundaryArgs = z.object({
456
+ contour: ContourHandle,
457
+ point: Vec3Handle,
458
+ })
459
+
460
+ export type PluginGeomQueryContourIsOnBoundaryArgs = z.infer<typeof PluginGeomQueryContourIsOnBoundaryArgs>
461
+
462
+ /**
463
+ * Arguments for {@linkcode PluginGeomQueryContourApi.isClockwise}.
464
+ *
465
+ * | Property | Type | Description |
466
+ * |---|---|---|
467
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
468
+ */
469
+ export const PluginGeomQueryContourIsClockwiseArgs = z.object({
470
+ contour: ContourHandle,
471
+ })
472
+
473
+ export type PluginGeomQueryContourIsClockwiseArgs = z.infer<typeof PluginGeomQueryContourIsClockwiseArgs>
474
+
475
+ /**
476
+ * Arguments for {@linkcode PluginGeomQueryContourApi.isPlanar}.
477
+ *
478
+ * | Property | Type | Description |
479
+ * |---|---|---|
480
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
481
+ */
482
+ export const PluginGeomQueryContourIsPlanarArgs = z.object({
483
+ contour: ContourHandle,
484
+ })
485
+
486
+ export type PluginGeomQueryContourIsPlanarArgs = z.infer<typeof PluginGeomQueryContourIsPlanarArgs>
487
+
488
+ /**
489
+ * Arguments for {@linkcode PluginGeomQueryContourApi.isEmpty}.
490
+ *
491
+ * | Property | Type | Description |
492
+ * |---|---|---|
493
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
494
+ */
495
+ export const PluginGeomQueryContourIsEmptyArgs = z.object({
496
+ contour: ContourHandle,
497
+ })
498
+
499
+ export type PluginGeomQueryContourIsEmptyArgs = z.infer<typeof PluginGeomQueryContourIsEmptyArgs>
500
+
501
+ /**
502
+ * Arguments for {@linkcode PluginGeomQueryContourApi.isSelfIntersecting}.
503
+ *
504
+ * | Property | Type | Description |
505
+ * |---|---|---|
506
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
507
+ */
508
+ export const PluginGeomQueryContourIsSelfIntersectingArgs = z.object({
509
+ contour: ContourHandle,
510
+ })
511
+
512
+ export type PluginGeomQueryContourIsSelfIntersectingArgs = z.infer<typeof PluginGeomQueryContourIsSelfIntersectingArgs>
513
+
514
+ /**
515
+ * Arguments for {@linkcode PluginGeomQueryContourApi.isOrientationValid}.
516
+ *
517
+ * | Property | Type | Description |
518
+ * |---|---|---|
519
+ * | `contour` | {@linkcode ContourHandle} | The contour to query |
520
+ */
521
+ export const PluginGeomQueryContourIsOrientationValidArgs = z.object({
522
+ contour: ContourHandle,
523
+ })
524
+
525
+ export type PluginGeomQueryContourIsOrientationValidArgs = z.infer<typeof PluginGeomQueryContourIsOrientationValidArgs>
526
+
527
+ /**
528
+ * Arguments for {@linkcode PluginGeomQueryContourApi.isEqual}.
529
+ *
530
+ * | Property | Type | Description |
531
+ * |---|---|---|
532
+ * | `contourA` | {@linkcode ContourHandle} | First contour |
533
+ * | `contourB` | {@linkcode ContourHandle} | Second contour |
534
+ */
535
+ export const PluginGeomQueryContourIsEqualArgs = z.object({
536
+ contourA: ContourHandle,
537
+ contourB: ContourHandle,
538
+ })
539
+
540
+ export type PluginGeomQueryContourIsEqualArgs = z.infer<typeof PluginGeomQueryContourIsEqualArgs>