@snaptrude/plugin-core 0.9.17 → 0.9.18-networks-20261016.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 (213) hide show
  1. package/AGENTS.md +231 -231
  2. package/CHANGELOG.md +408 -408
  3. package/CLAUDE.md +11 -11
  4. package/dist/api/analysis/daylight.d.ts +5 -5
  5. package/dist/api/analysis/solar.d.ts +2 -2
  6. package/dist/api/core/camera/index.d.ts +29 -0
  7. package/dist/api/core/camera/index.d.ts.map +1 -1
  8. package/dist/api/core/geom/create/index.d.ts +7 -1
  9. package/dist/api/core/geom/create/index.d.ts.map +1 -1
  10. package/dist/api/core/geom/update/contour.d.ts +8 -2
  11. package/dist/api/core/geom/update/contour.d.ts.map +1 -1
  12. package/dist/api/core/zoom/index.d.ts +13 -0
  13. package/dist/api/core/zoom/index.d.ts.map +1 -1
  14. package/dist/api/design/bim.d.ts +209 -0
  15. package/dist/api/design/bim.d.ts.map +1 -0
  16. package/dist/api/design/boolean/index.d.ts +2 -0
  17. package/dist/api/design/boolean/index.d.ts.map +1 -1
  18. package/dist/api/design/catalog.d.ts +320 -0
  19. package/dist/api/design/catalog.d.ts.map +1 -0
  20. package/dist/api/design/create/bulk-items.d.ts +65 -25
  21. package/dist/api/design/create/bulk-items.d.ts.map +1 -1
  22. package/dist/api/design/create/index.d.ts +272 -99
  23. package/dist/api/design/create/index.d.ts.map +1 -1
  24. package/dist/api/design/create/opening-fields.d.ts +13 -12
  25. package/dist/api/design/create/opening-fields.d.ts.map +1 -1
  26. package/dist/api/design/delete/index.d.ts +1 -0
  27. package/dist/api/design/delete/index.d.ts.map +1 -1
  28. package/dist/api/design/doors/index.d.ts +18 -24
  29. package/dist/api/design/doors/index.d.ts.map +1 -1
  30. package/dist/api/design/family.d.ts +797 -27
  31. package/dist/api/design/family.d.ts.map +1 -1
  32. package/dist/api/design/index.d.ts +16 -0
  33. package/dist/api/design/index.d.ts.map +1 -1
  34. package/dist/api/design/networks.d.ts +1763 -0
  35. package/dist/api/design/networks.d.ts.map +1 -0
  36. package/dist/api/design/query/index.d.ts +42 -32
  37. package/dist/api/design/query/index.d.ts.map +1 -1
  38. package/dist/api/design/selection/index.d.ts +10 -10
  39. package/dist/api/design/types/index.d.ts +40 -24
  40. package/dist/api/design/types/index.d.ts.map +1 -1
  41. package/dist/api/design/update/index.d.ts +43 -3
  42. package/dist/api/design/update/index.d.ts.map +1 -1
  43. package/dist/api/design/windows/index.d.ts +8 -8
  44. package/dist/api/design/windows/index.d.ts.map +1 -1
  45. package/dist/api/presentation/aiInspiration.d.ts +10 -10
  46. package/dist/api/presentation/annotate.d.ts +38 -22
  47. package/dist/api/presentation/annotate.d.ts.map +1 -1
  48. package/dist/api/presentation/drawingContract.d.ts +32 -0
  49. package/dist/api/presentation/drawingContract.d.ts.map +1 -0
  50. package/dist/api/presentation/drawings.d.ts +3523 -0
  51. package/dist/api/presentation/drawings.d.ts.map +1 -0
  52. package/dist/api/presentation/export.d.ts +23 -5
  53. package/dist/api/presentation/export.d.ts.map +1 -1
  54. package/dist/api/presentation/index.d.ts +32 -12
  55. package/dist/api/presentation/index.d.ts.map +1 -1
  56. package/dist/api/presentation/placedViews.d.ts +106 -6
  57. package/dist/api/presentation/placedViews.d.ts.map +1 -1
  58. package/dist/api/presentation/shapes.d.ts +2 -2
  59. package/dist/api/presentation/sheets.d.ts +175 -19
  60. package/dist/api/presentation/sheets.d.ts.map +1 -1
  61. package/dist/api/presentation/viewPresets.d.ts +222 -0
  62. package/dist/api/presentation/viewPresets.d.ts.map +1 -0
  63. package/dist/api/presentation/views.d.ts +103 -5
  64. package/dist/api/presentation/views.d.ts.map +1 -1
  65. package/dist/api/presentation/walkthroughs.d.ts +6 -6
  66. package/dist/errors/codes.d.ts +3 -1
  67. package/dist/errors/codes.d.ts.map +1 -1
  68. package/dist/index.cjs +3732 -2383
  69. package/dist/index.cjs.map +1 -1
  70. package/dist/index.js +3607 -2383
  71. package/dist/index.js.map +1 -1
  72. package/package.json +42 -42
  73. package/scripts/check-dist-fresh.mjs +22 -22
  74. package/scripts/generate-manifest.mjs +243 -238
  75. package/scripts/generate-manifest.test.mjs +303 -303
  76. package/src/api/analysis/daylight.ts +470 -470
  77. package/src/api/analysis/heatmaps.ts +683 -683
  78. package/src/api/analysis/illuminance.ts +155 -155
  79. package/src/api/analysis/index.ts +61 -61
  80. package/src/api/analysis/shadows.ts +183 -183
  81. package/src/api/analysis/solar.ts +237 -237
  82. package/src/api/analysis/sunlightHours.ts +211 -211
  83. package/src/api/analysis/sunpath.ts +83 -83
  84. package/src/api/analysis/weather.ts +179 -179
  85. package/src/api/core/buildings.ts +485 -485
  86. package/src/api/core/camera/index.ts +696 -667
  87. package/src/api/core/comment/index.ts +376 -376
  88. package/src/api/core/geom/create/index.ts +2139 -2133
  89. package/src/api/core/geom/delete/index.ts +84 -84
  90. package/src/api/core/geom/index.ts +35 -35
  91. package/src/api/core/geom/query/arc.ts +169 -169
  92. package/src/api/core/geom/query/brep.ts +621 -621
  93. package/src/api/core/geom/query/circle.ts +404 -404
  94. package/src/api/core/geom/query/contour.ts +540 -540
  95. package/src/api/core/geom/query/curve.ts +1102 -1102
  96. package/src/api/core/geom/query/edge.ts +130 -130
  97. package/src/api/core/geom/query/face.ts +508 -508
  98. package/src/api/core/geom/query/halfedge.ts +210 -210
  99. package/src/api/core/geom/query/index.ts +63 -63
  100. package/src/api/core/geom/query/profile.ts +473 -473
  101. package/src/api/core/geom/query/vertex.ts +205 -205
  102. package/src/api/core/geom/update/contour.ts +323 -317
  103. package/src/api/core/geom/update/curve.ts +209 -209
  104. package/src/api/core/geom/update/index.ts +29 -29
  105. package/src/api/core/geom/update/profile.ts +379 -379
  106. package/src/api/core/groups.ts +521 -521
  107. package/src/api/core/handles/index.ts +234 -234
  108. package/src/api/core/history/index.ts +84 -84
  109. package/src/api/core/index.ts +99 -99
  110. package/src/api/core/io/export/index.ts +126 -126
  111. package/src/api/core/io/import/index.ts +504 -504
  112. package/src/api/core/io/index.ts +42 -42
  113. package/src/api/core/io/job/index.ts +140 -140
  114. package/src/api/core/io/query/index.ts +71 -71
  115. package/src/api/core/io/terrain/index.ts +360 -360
  116. package/src/api/core/io/underlay/index.ts +705 -705
  117. package/src/api/core/layers.ts +540 -540
  118. package/src/api/core/math/index.ts +20 -20
  119. package/src/api/core/math/quat.ts +172 -172
  120. package/src/api/core/math/vec3.ts +179 -179
  121. package/src/api/core/mode/index.ts +108 -108
  122. package/src/api/core/project/index.ts +479 -479
  123. package/src/api/core/proposals/index.ts +570 -570
  124. package/src/api/core/storeys/index.ts +308 -308
  125. package/src/api/core/storeys/layers.ts +339 -339
  126. package/src/api/core/tags.ts +911 -911
  127. package/src/api/core/units/index.ts +164 -164
  128. package/src/api/core/user.ts +46 -46
  129. package/src/api/core/zoom/index.ts +64 -51
  130. package/src/api/design/bim.ts +121 -0
  131. package/src/api/design/boolean/index.ts +181 -179
  132. package/src/api/design/catalog.ts +203 -0
  133. package/src/api/design/create/bulk-items.ts +294 -254
  134. package/src/api/design/create/grids.ts +137 -137
  135. package/src/api/design/create/index.ts +2148 -1980
  136. package/src/api/design/create/opening-fields.ts +40 -37
  137. package/src/api/design/delete/index.ts +75 -74
  138. package/src/api/design/dimensions.ts +453 -453
  139. package/src/api/design/doors/index.ts +516 -500
  140. package/src/api/design/edit/index.ts +54 -54
  141. package/src/api/design/erase/index.ts +151 -151
  142. package/src/api/design/family.ts +1334 -704
  143. package/src/api/design/furniture/index.ts +319 -319
  144. package/src/api/design/grids.ts +237 -237
  145. package/src/api/design/index.ts +304 -274
  146. package/src/api/design/lock.ts +69 -69
  147. package/src/api/design/materials/index.ts +608 -608
  148. package/src/api/design/networks.ts +667 -0
  149. package/src/api/design/query/geometry/index.ts +319 -319
  150. package/src/api/design/query/grids.ts +197 -197
  151. package/src/api/design/query/index.ts +1236 -1226
  152. package/src/api/design/query/referenceLines.ts +52 -52
  153. package/src/api/design/query/spaces.ts +275 -275
  154. package/src/api/design/selection/index.ts +273 -273
  155. package/src/api/design/shared.ts +40 -40
  156. package/src/api/design/transform/index.ts +254 -254
  157. package/src/api/design/types/index.ts +163 -156
  158. package/src/api/design/update/index.ts +1024 -983
  159. package/src/api/design/visibility.ts +143 -143
  160. package/src/api/design/windows/index.ts +351 -333
  161. package/src/api/entity/buildableEnvelope.ts +322 -322
  162. package/src/api/entity/index.ts +30 -30
  163. package/src/api/entity/referenceLine.ts +235 -235
  164. package/src/api/entity/space.ts +612 -612
  165. package/src/api/entity/story.ts +517 -517
  166. package/src/api/index.ts +47 -47
  167. package/src/api/presentation/aiInspiration.ts +1116 -1116
  168. package/src/api/presentation/annotate.ts +417 -385
  169. package/src/api/presentation/camera.ts +289 -289
  170. package/src/api/presentation/diagrams.ts +194 -194
  171. package/src/api/presentation/drawingContract.ts +70 -0
  172. package/src/api/presentation/drawings.ts +1179 -0
  173. package/src/api/presentation/export.ts +134 -108
  174. package/src/api/presentation/import.ts +159 -159
  175. package/src/api/presentation/index.ts +160 -135
  176. package/src/api/presentation/placedViews.ts +1211 -1120
  177. package/src/api/presentation/sections.ts +420 -420
  178. package/src/api/presentation/shapes.ts +274 -274
  179. package/src/api/presentation/sheets.ts +746 -585
  180. package/src/api/presentation/slideshow.ts +134 -134
  181. package/src/api/presentation/tables.ts +84 -84
  182. package/src/api/presentation/viewPresets.ts +241 -0
  183. package/src/api/presentation/views.ts +713 -673
  184. package/src/api/presentation/walkthroughs.ts +1201 -1201
  185. package/src/api/program/adjacency.ts +164 -164
  186. package/src/api/program/areas.ts +408 -408
  187. package/src/api/program/classification.ts +138 -138
  188. package/src/api/program/cores.ts +83 -83
  189. package/src/api/program/departments.ts +517 -517
  190. package/src/api/program/index.ts +73 -73
  191. package/src/api/program/labels.ts +332 -332
  192. package/src/api/program/layout.ts +422 -422
  193. package/src/api/program/metadata.ts +364 -364
  194. package/src/api/program/metrics.ts +120 -120
  195. package/src/api/program/site.ts +748 -748
  196. package/src/api/program/spreadsheet.ts +2698 -2698
  197. package/src/api/workspace/index.ts +612 -612
  198. package/src/errors/codes.ts +143 -136
  199. package/src/errors/envelope.ts +75 -75
  200. package/src/errors/index.ts +21 -21
  201. package/src/errors/plugin-error.ts +134 -134
  202. package/src/handles.ts +297 -297
  203. package/src/host-utils.ts +67 -67
  204. package/src/index.ts +7 -7
  205. package/src/massParameters.ops.ts +246 -246
  206. package/src/massParameters.ts +427 -427
  207. package/src/types.ts +16 -16
  208. package/test/drawingContract.test.mjs +288 -0
  209. package/test/errors.test.mjs +185 -184
  210. package/test/massParameters.test.mjs +952 -952
  211. package/tsconfig.json +22 -22
  212. package/tsup.config.ts +12 -12
  213. package/api-manifest.json +0 -9711
@@ -1,404 +1,404 @@
1
- import * as z from "zod"
2
- import { PluginApiReturn } from "../../../../types"
3
- import { CircleHandle, Vec3Handle, Vec3Components } from "../../../../handles"
4
-
5
- /**
6
- * Circle-specific geometry queries — read closed-circle properties as plain values
7
- * (all-handle model, §11). A circle is a closed curve with its own namespace
8
- * (mirroring {@linkcode PluginGeomQueryArcApi}); it is NOT part of the shared
9
- * {@linkcode CurveHandle} line/arc surface.
10
- *
11
- * Every method takes an opaque {@linkcode CircleHandle} (plus a point handle where
12
- * relevant) and returns plain values — numbers, {@linkcode Vec3Components},
13
- * predicates as `boolean`. No query mutates its inputs.
14
- *
15
- * Accessed via `snaptrude.core.geom.query.circle`.
16
- */
17
- export abstract class PluginGeomQueryCircleApi {
18
- constructor() {}
19
-
20
- /**
21
- * Read the radius of a circle.
22
- * @param circle The circle to query
23
- * @returns The radius as a `number`
24
- *
25
- * @examplePrompt What is the radius of this circle?
26
- * @examplePrompt Measure the radius of the circular column grid
27
- *
28
- * # Example
29
- * ```ts
30
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
31
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
32
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
33
- * const radius = await snaptrude.core.geom.query.circle.getRadius(circle)
34
- * ```
35
- */
36
- public abstract getRadius(circle: CircleHandle): PluginApiReturn<number>
37
-
38
- /**
39
- * Read the centre point of a circle.
40
- * @param circle The circle to query
41
- * @returns The centre as {@linkcode Vec3Components}
42
- *
43
- * @examplePrompt Where is the centre of this circle?
44
- * @examplePrompt Find the center point of the circular courtyard outline
45
- *
46
- * # Example
47
- * ```ts
48
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
49
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
50
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
51
- * const centre = await snaptrude.core.geom.query.circle.getCentre(circle)
52
- * console.log(centre.x, centre.y, centre.z)
53
- * ```
54
- */
55
- public abstract getCentre(circle: CircleHandle): PluginApiReturn<Vec3Components>
56
-
57
- /**
58
- * Read the axis (plane normal) of a circle.
59
- * @param circle The circle to query
60
- * @returns The axis as {@linkcode Vec3Components}
61
- *
62
- * # Example
63
- * ```ts
64
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
65
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
66
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
67
- * const axis = await snaptrude.core.geom.query.circle.getAxis(circle)
68
- * console.log(axis.x, axis.y, axis.z)
69
- * ```
70
- */
71
- public abstract getAxis(circle: CircleHandle): PluginApiReturn<Vec3Components>
72
-
73
- /**
74
- * Read the length (circumference, `2πr`) of a circle.
75
- * @param circle The circle to query
76
- * @returns The circumference as a `number`
77
- *
78
- * @examplePrompt What is the circumference of this circle?
79
- * @examplePrompt How long is the circular path around the courtyard?
80
- *
81
- * # Example
82
- * ```ts
83
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
84
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
85
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
86
- * const circumference = await snaptrude.core.geom.query.circle.getLength(circle)
87
- * ```
88
- */
89
- public abstract getLength(circle: CircleHandle): PluginApiReturn<number>
90
-
91
- /**
92
- * Check whether a circle is geometrically valid (non-degenerate axis + positive radius).
93
- * @param circle The circle to query
94
- * @returns `true` if the circle is valid, otherwise `false`
95
- *
96
- * # Example
97
- * ```ts
98
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
99
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
100
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
101
- * const ok = await snaptrude.core.geom.query.circle.isValid(circle)
102
- * ```
103
- */
104
- public abstract isValid(circle: CircleHandle): PluginApiReturn<boolean>
105
-
106
- /**
107
- * Get the point on a circle nearest to an arbitrary point.
108
- * @param circle The circle to query
109
- * @param point The reference point
110
- * @returns The nearest point as {@linkcode Vec3Components}
111
- *
112
- * @examplePrompt Find the point on the circle closest to this column
113
- *
114
- * # Example
115
- * ```ts
116
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
117
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
118
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
119
- * const target = await snaptrude.core.math.vec3.new(8, 0, 2)
120
- * const nearest = await snaptrude.core.geom.query.circle.getNearestPoint(circle, target)
121
- * console.log(nearest.x, nearest.y, nearest.z)
122
- * ```
123
- */
124
- public abstract getNearestPoint(
125
- circle: CircleHandle,
126
- point: Vec3Handle
127
- ): PluginApiReturn<Vec3Components>
128
-
129
- /**
130
- * Test whether a point lies on a circle.
131
- * @param circle The circle to query
132
- * @param point The point to test
133
- * @returns `true` if the point is on the circle, otherwise `false`
134
- *
135
- * @examplePrompt Check whether this point sits on the circle
136
- *
137
- * # Example
138
- * ```ts
139
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
140
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
141
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
142
- * const pt = await snaptrude.core.math.vec3.new(5, 0, 0)
143
- * const onCircle = await snaptrude.core.geom.query.circle.hasPoint(circle, pt)
144
- * ```
145
- */
146
- public abstract hasPoint(circle: CircleHandle, point: Vec3Handle): PluginApiReturn<boolean>
147
-
148
- /**
149
- * Get the tangent direction of a circle at a point on it.
150
- * @param circle The circle to query
151
- * @param point A point on the circle
152
- * @returns The tangent as {@linkcode Vec3Components}
153
- *
154
- * # Example
155
- * ```ts
156
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
157
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
158
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
159
- * const pt = await snaptrude.core.math.vec3.new(5, 0, 0)
160
- * const tangent = await snaptrude.core.geom.query.circle.getTangent(circle, pt)
161
- * console.log(tangent.x, tangent.y, tangent.z)
162
- * ```
163
- */
164
- public abstract getTangent(circle: CircleHandle, point: Vec3Handle): PluginApiReturn<Vec3Components>
165
-
166
- /**
167
- * Get the (in-plane, radial) normal direction of a circle at a point on it.
168
- * @param circle The circle to query
169
- * @param point A point on the circle
170
- * @returns The radial normal as {@linkcode Vec3Components}
171
- *
172
- * # Example
173
- * ```ts
174
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
175
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
176
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
177
- * const pt = await snaptrude.core.math.vec3.new(5, 0, 0)
178
- * const normal = await snaptrude.core.geom.query.circle.getNormal(circle, pt)
179
- * console.log(normal.x, normal.y, normal.z)
180
- * ```
181
- */
182
- public abstract getNormal(circle: CircleHandle, point: Vec3Handle): PluginApiReturn<Vec3Components>
183
-
184
- /**
185
- * Get the point reached by travelling a signed arc-distance along the circle from
186
- * a reference point that lies on it.
187
- * @param circle The circle to query
188
- * @param referencePoint A point on the circle to travel from
189
- * @param distance Arc distance to travel
190
- * @param forward Travel direction (optional; default forward)
191
- * @returns The resulting point as {@linkcode Vec3Components}
192
- *
193
- * @examplePrompt Mark a point 2 metres along the circle from this point
194
- *
195
- * # Example
196
- * ```ts
197
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
198
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
199
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
200
- * const ref = await snaptrude.core.math.vec3.new(5, 0, 0)
201
- * const ahead = await snaptrude.core.geom.query.circle.getPointAtDistance(circle, ref, 2)
202
- * const behind = await snaptrude.core.geom.query.circle.getPointAtDistance(circle, ref, 2, false)
203
- * ```
204
- */
205
- public abstract getPointAtDistance(
206
- circle: CircleHandle,
207
- referencePoint: Vec3Handle,
208
- distance: number,
209
- forward?: boolean
210
- ): PluginApiReturn<Vec3Components>
211
-
212
- /**
213
- * Test whether two circles are geometrically equal.
214
- * @param circleA First circle
215
- * @param circleB Second circle
216
- * @returns `true` if the circles are equal, otherwise `false`
217
- *
218
- * # Example
219
- * ```ts
220
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
221
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
222
- * const a = await snaptrude.core.geom.create.circle(origin, up, 5)
223
- * const b = await snaptrude.core.geom.create.circle(origin, up, 3)
224
- * const same = await snaptrude.core.geom.query.circle.isEqual(a, b)
225
- * ```
226
- */
227
- public abstract isEqual(circleA: CircleHandle, circleB: CircleHandle): PluginApiReturn<boolean>
228
-
229
- /**
230
- * Sample a circle into an ordered list of points.
231
- * @param circle The circle to query
232
- * @param resolution Number of segments to sample (optional)
233
- * @returns The sampled points as {@linkcode Vec3Components}`[]`
234
- *
235
- * @examplePrompt Divide this circle into 12 equal points
236
- * @examplePrompt Get evenly spaced points around the circle to place columns
237
- *
238
- * # Example
239
- * ```ts
240
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
241
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
242
- * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
243
- * const points = await snaptrude.core.geom.query.circle.listPoints(circle, 12)
244
- * for (const p of points) console.log(p.x, p.y, p.z)
245
- * ```
246
- */
247
- public abstract listPoints(circle: CircleHandle, resolution?: number): PluginApiReturn<Vec3Components[]>
248
- }
249
-
250
- /**
251
- * Arguments for {@linkcode PluginGeomQueryCircleApi.getRadius}.
252
- *
253
- * | Property | Type | Description |
254
- * |---|---|---|
255
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
256
- */
257
- export const PluginGeomQueryCircleGetRadiusArgs = z.object({ circle: CircleHandle })
258
- export type PluginGeomQueryCircleGetRadiusArgs = z.infer<typeof PluginGeomQueryCircleGetRadiusArgs>
259
-
260
- /**
261
- * Arguments for {@linkcode PluginGeomQueryCircleApi.getCentre}.
262
- *
263
- * | Property | Type | Description |
264
- * |---|---|---|
265
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
266
- */
267
- export const PluginGeomQueryCircleGetCentreArgs = z.object({ circle: CircleHandle })
268
- export type PluginGeomQueryCircleGetCentreArgs = z.infer<typeof PluginGeomQueryCircleGetCentreArgs>
269
-
270
- /**
271
- * Arguments for {@linkcode PluginGeomQueryCircleApi.getAxis}.
272
- *
273
- * | Property | Type | Description |
274
- * |---|---|---|
275
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
276
- */
277
- export const PluginGeomQueryCircleGetAxisArgs = z.object({ circle: CircleHandle })
278
- export type PluginGeomQueryCircleGetAxisArgs = z.infer<typeof PluginGeomQueryCircleGetAxisArgs>
279
-
280
- /**
281
- * Arguments for {@linkcode PluginGeomQueryCircleApi.getLength}.
282
- *
283
- * | Property | Type | Description |
284
- * |---|---|---|
285
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
286
- */
287
- export const PluginGeomQueryCircleGetLengthArgs = z.object({ circle: CircleHandle })
288
- export type PluginGeomQueryCircleGetLengthArgs = z.infer<typeof PluginGeomQueryCircleGetLengthArgs>
289
-
290
- /**
291
- * Arguments for {@linkcode PluginGeomQueryCircleApi.isValid}.
292
- *
293
- * | Property | Type | Description |
294
- * |---|---|---|
295
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
296
- */
297
- export const PluginGeomQueryCircleIsValidArgs = z.object({ circle: CircleHandle })
298
- export type PluginGeomQueryCircleIsValidArgs = z.infer<typeof PluginGeomQueryCircleIsValidArgs>
299
-
300
- /**
301
- * Arguments for {@linkcode PluginGeomQueryCircleApi.getNearestPoint}.
302
- *
303
- * | Property | Type | Description |
304
- * |---|---|---|
305
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
306
- * | `point` | {@linkcode Vec3Handle} | The reference point |
307
- */
308
- export const PluginGeomQueryCircleGetNearestPointArgs = z.object({
309
- circle: CircleHandle,
310
- point: Vec3Handle,
311
- })
312
- export type PluginGeomQueryCircleGetNearestPointArgs = z.infer<
313
- typeof PluginGeomQueryCircleGetNearestPointArgs
314
- >
315
-
316
- /**
317
- * Arguments for {@linkcode PluginGeomQueryCircleApi.hasPoint}.
318
- *
319
- * | Property | Type | Description |
320
- * |---|---|---|
321
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
322
- * | `point` | {@linkcode Vec3Handle} | The point to test |
323
- */
324
- export const PluginGeomQueryCircleHasPointArgs = z.object({
325
- circle: CircleHandle,
326
- point: Vec3Handle,
327
- })
328
- export type PluginGeomQueryCircleHasPointArgs = z.infer<typeof PluginGeomQueryCircleHasPointArgs>
329
-
330
- /**
331
- * Arguments for {@linkcode PluginGeomQueryCircleApi.getTangent}.
332
- *
333
- * | Property | Type | Description |
334
- * |---|---|---|
335
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
336
- * | `point` | {@linkcode Vec3Handle} | A point on the circle |
337
- */
338
- export const PluginGeomQueryCircleGetTangentArgs = z.object({
339
- circle: CircleHandle,
340
- point: Vec3Handle,
341
- })
342
- export type PluginGeomQueryCircleGetTangentArgs = z.infer<typeof PluginGeomQueryCircleGetTangentArgs>
343
-
344
- /**
345
- * Arguments for {@linkcode PluginGeomQueryCircleApi.getNormal}.
346
- *
347
- * | Property | Type | Description |
348
- * |---|---|---|
349
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
350
- * | `point` | {@linkcode Vec3Handle} | A point on the circle |
351
- */
352
- export const PluginGeomQueryCircleGetNormalArgs = z.object({
353
- circle: CircleHandle,
354
- point: Vec3Handle,
355
- })
356
- export type PluginGeomQueryCircleGetNormalArgs = z.infer<typeof PluginGeomQueryCircleGetNormalArgs>
357
-
358
- /**
359
- * Arguments for {@linkcode PluginGeomQueryCircleApi.getPointAtDistance}.
360
- *
361
- * | Property | Type | Description |
362
- * |---|---|---|
363
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
364
- * | `referencePoint` | {@linkcode Vec3Handle} | A point on the circle to travel from |
365
- * | `distance` | `number` | Arc distance to travel |
366
- * | `forward` | `boolean` | Travel direction (optional; default forward) |
367
- */
368
- export const PluginGeomQueryCircleGetPointAtDistanceArgs = z.object({
369
- circle: CircleHandle,
370
- referencePoint: Vec3Handle,
371
- distance: z.number(),
372
- forward: z.boolean().optional(),
373
- })
374
- export type PluginGeomQueryCircleGetPointAtDistanceArgs = z.infer<
375
- typeof PluginGeomQueryCircleGetPointAtDistanceArgs
376
- >
377
-
378
- /**
379
- * Arguments for {@linkcode PluginGeomQueryCircleApi.isEqual}.
380
- *
381
- * | Property | Type | Description |
382
- * |---|---|---|
383
- * | `circleA` | {@linkcode CircleHandle} | First circle |
384
- * | `circleB` | {@linkcode CircleHandle} | Second circle |
385
- */
386
- export const PluginGeomQueryCircleIsEqualArgs = z.object({
387
- circleA: CircleHandle,
388
- circleB: CircleHandle,
389
- })
390
- export type PluginGeomQueryCircleIsEqualArgs = z.infer<typeof PluginGeomQueryCircleIsEqualArgs>
391
-
392
- /**
393
- * Arguments for {@linkcode PluginGeomQueryCircleApi.listPoints}.
394
- *
395
- * | Property | Type | Description |
396
- * |---|---|---|
397
- * | `circle` | {@linkcode CircleHandle} | The circle to query |
398
- * | `resolution` | `number` | Number of segments to sample (optional) |
399
- */
400
- export const PluginGeomQueryCircleListPointsArgs = z.object({
401
- circle: CircleHandle,
402
- resolution: z.number().optional(),
403
- })
404
- export type PluginGeomQueryCircleListPointsArgs = z.infer<typeof PluginGeomQueryCircleListPointsArgs>
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../../types"
3
+ import { CircleHandle, Vec3Handle, Vec3Components } from "../../../../handles"
4
+
5
+ /**
6
+ * Circle-specific geometry queries — read closed-circle properties as plain values
7
+ * (all-handle model, §11). A circle is a closed curve with its own namespace
8
+ * (mirroring {@linkcode PluginGeomQueryArcApi}); it is NOT part of the shared
9
+ * {@linkcode CurveHandle} line/arc surface.
10
+ *
11
+ * Every method takes an opaque {@linkcode CircleHandle} (plus a point handle where
12
+ * relevant) and returns plain values — numbers, {@linkcode Vec3Components},
13
+ * predicates as `boolean`. No query mutates its inputs.
14
+ *
15
+ * Accessed via `snaptrude.core.geom.query.circle`.
16
+ */
17
+ export abstract class PluginGeomQueryCircleApi {
18
+ constructor() {}
19
+
20
+ /**
21
+ * Read the radius of a circle.
22
+ * @param circle The circle to query
23
+ * @returns The radius as a `number`
24
+ *
25
+ * @examplePrompt What is the radius of this circle?
26
+ * @examplePrompt Measure the radius of the circular column grid
27
+ *
28
+ * # Example
29
+ * ```ts
30
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
31
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
32
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
33
+ * const radius = await snaptrude.core.geom.query.circle.getRadius(circle)
34
+ * ```
35
+ */
36
+ public abstract getRadius(circle: CircleHandle): PluginApiReturn<number>
37
+
38
+ /**
39
+ * Read the centre point of a circle.
40
+ * @param circle The circle to query
41
+ * @returns The centre as {@linkcode Vec3Components}
42
+ *
43
+ * @examplePrompt Where is the centre of this circle?
44
+ * @examplePrompt Find the center point of the circular courtyard outline
45
+ *
46
+ * # Example
47
+ * ```ts
48
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
49
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
50
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
51
+ * const centre = await snaptrude.core.geom.query.circle.getCentre(circle)
52
+ * console.log(centre.x, centre.y, centre.z)
53
+ * ```
54
+ */
55
+ public abstract getCentre(circle: CircleHandle): PluginApiReturn<Vec3Components>
56
+
57
+ /**
58
+ * Read the axis (plane normal) of a circle.
59
+ * @param circle The circle to query
60
+ * @returns The axis as {@linkcode Vec3Components}
61
+ *
62
+ * # Example
63
+ * ```ts
64
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
65
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
66
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
67
+ * const axis = await snaptrude.core.geom.query.circle.getAxis(circle)
68
+ * console.log(axis.x, axis.y, axis.z)
69
+ * ```
70
+ */
71
+ public abstract getAxis(circle: CircleHandle): PluginApiReturn<Vec3Components>
72
+
73
+ /**
74
+ * Read the length (circumference, `2πr`) of a circle.
75
+ * @param circle The circle to query
76
+ * @returns The circumference as a `number`
77
+ *
78
+ * @examplePrompt What is the circumference of this circle?
79
+ * @examplePrompt How long is the circular path around the courtyard?
80
+ *
81
+ * # Example
82
+ * ```ts
83
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
84
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
85
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
86
+ * const circumference = await snaptrude.core.geom.query.circle.getLength(circle)
87
+ * ```
88
+ */
89
+ public abstract getLength(circle: CircleHandle): PluginApiReturn<number>
90
+
91
+ /**
92
+ * Check whether a circle is geometrically valid (non-degenerate axis + positive radius).
93
+ * @param circle The circle to query
94
+ * @returns `true` if the circle is valid, otherwise `false`
95
+ *
96
+ * # Example
97
+ * ```ts
98
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
99
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
100
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
101
+ * const ok = await snaptrude.core.geom.query.circle.isValid(circle)
102
+ * ```
103
+ */
104
+ public abstract isValid(circle: CircleHandle): PluginApiReturn<boolean>
105
+
106
+ /**
107
+ * Get the point on a circle nearest to an arbitrary point.
108
+ * @param circle The circle to query
109
+ * @param point The reference point
110
+ * @returns The nearest point as {@linkcode Vec3Components}
111
+ *
112
+ * @examplePrompt Find the point on the circle closest to this column
113
+ *
114
+ * # Example
115
+ * ```ts
116
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
117
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
118
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
119
+ * const target = await snaptrude.core.math.vec3.new(8, 0, 2)
120
+ * const nearest = await snaptrude.core.geom.query.circle.getNearestPoint(circle, target)
121
+ * console.log(nearest.x, nearest.y, nearest.z)
122
+ * ```
123
+ */
124
+ public abstract getNearestPoint(
125
+ circle: CircleHandle,
126
+ point: Vec3Handle
127
+ ): PluginApiReturn<Vec3Components>
128
+
129
+ /**
130
+ * Test whether a point lies on a circle.
131
+ * @param circle The circle to query
132
+ * @param point The point to test
133
+ * @returns `true` if the point is on the circle, otherwise `false`
134
+ *
135
+ * @examplePrompt Check whether this point sits on the circle
136
+ *
137
+ * # Example
138
+ * ```ts
139
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
140
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
141
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
142
+ * const pt = await snaptrude.core.math.vec3.new(5, 0, 0)
143
+ * const onCircle = await snaptrude.core.geom.query.circle.hasPoint(circle, pt)
144
+ * ```
145
+ */
146
+ public abstract hasPoint(circle: CircleHandle, point: Vec3Handle): PluginApiReturn<boolean>
147
+
148
+ /**
149
+ * Get the tangent direction of a circle at a point on it.
150
+ * @param circle The circle to query
151
+ * @param point A point on the circle
152
+ * @returns The tangent as {@linkcode Vec3Components}
153
+ *
154
+ * # Example
155
+ * ```ts
156
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
157
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
158
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
159
+ * const pt = await snaptrude.core.math.vec3.new(5, 0, 0)
160
+ * const tangent = await snaptrude.core.geom.query.circle.getTangent(circle, pt)
161
+ * console.log(tangent.x, tangent.y, tangent.z)
162
+ * ```
163
+ */
164
+ public abstract getTangent(circle: CircleHandle, point: Vec3Handle): PluginApiReturn<Vec3Components>
165
+
166
+ /**
167
+ * Get the (in-plane, radial) normal direction of a circle at a point on it.
168
+ * @param circle The circle to query
169
+ * @param point A point on the circle
170
+ * @returns The radial normal as {@linkcode Vec3Components}
171
+ *
172
+ * # Example
173
+ * ```ts
174
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
175
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
176
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
177
+ * const pt = await snaptrude.core.math.vec3.new(5, 0, 0)
178
+ * const normal = await snaptrude.core.geom.query.circle.getNormal(circle, pt)
179
+ * console.log(normal.x, normal.y, normal.z)
180
+ * ```
181
+ */
182
+ public abstract getNormal(circle: CircleHandle, point: Vec3Handle): PluginApiReturn<Vec3Components>
183
+
184
+ /**
185
+ * Get the point reached by travelling a signed arc-distance along the circle from
186
+ * a reference point that lies on it.
187
+ * @param circle The circle to query
188
+ * @param referencePoint A point on the circle to travel from
189
+ * @param distance Arc distance to travel
190
+ * @param forward Travel direction (optional; default forward)
191
+ * @returns The resulting point as {@linkcode Vec3Components}
192
+ *
193
+ * @examplePrompt Mark a point 2 metres along the circle from this point
194
+ *
195
+ * # Example
196
+ * ```ts
197
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
198
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
199
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
200
+ * const ref = await snaptrude.core.math.vec3.new(5, 0, 0)
201
+ * const ahead = await snaptrude.core.geom.query.circle.getPointAtDistance(circle, ref, 2)
202
+ * const behind = await snaptrude.core.geom.query.circle.getPointAtDistance(circle, ref, 2, false)
203
+ * ```
204
+ */
205
+ public abstract getPointAtDistance(
206
+ circle: CircleHandle,
207
+ referencePoint: Vec3Handle,
208
+ distance: number,
209
+ forward?: boolean
210
+ ): PluginApiReturn<Vec3Components>
211
+
212
+ /**
213
+ * Test whether two circles are geometrically equal.
214
+ * @param circleA First circle
215
+ * @param circleB Second circle
216
+ * @returns `true` if the circles are equal, otherwise `false`
217
+ *
218
+ * # Example
219
+ * ```ts
220
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
221
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
222
+ * const a = await snaptrude.core.geom.create.circle(origin, up, 5)
223
+ * const b = await snaptrude.core.geom.create.circle(origin, up, 3)
224
+ * const same = await snaptrude.core.geom.query.circle.isEqual(a, b)
225
+ * ```
226
+ */
227
+ public abstract isEqual(circleA: CircleHandle, circleB: CircleHandle): PluginApiReturn<boolean>
228
+
229
+ /**
230
+ * Sample a circle into an ordered list of points.
231
+ * @param circle The circle to query
232
+ * @param resolution Number of segments to sample (optional)
233
+ * @returns The sampled points as {@linkcode Vec3Components}`[]`
234
+ *
235
+ * @examplePrompt Divide this circle into 12 equal points
236
+ * @examplePrompt Get evenly spaced points around the circle to place columns
237
+ *
238
+ * # Example
239
+ * ```ts
240
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
241
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
242
+ * const circle = await snaptrude.core.geom.create.circle(origin, up, 5)
243
+ * const points = await snaptrude.core.geom.query.circle.listPoints(circle, 12)
244
+ * for (const p of points) console.log(p.x, p.y, p.z)
245
+ * ```
246
+ */
247
+ public abstract listPoints(circle: CircleHandle, resolution?: number): PluginApiReturn<Vec3Components[]>
248
+ }
249
+
250
+ /**
251
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.getRadius}.
252
+ *
253
+ * | Property | Type | Description |
254
+ * |---|---|---|
255
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
256
+ */
257
+ export const PluginGeomQueryCircleGetRadiusArgs = z.object({ circle: CircleHandle })
258
+ export type PluginGeomQueryCircleGetRadiusArgs = z.infer<typeof PluginGeomQueryCircleGetRadiusArgs>
259
+
260
+ /**
261
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.getCentre}.
262
+ *
263
+ * | Property | Type | Description |
264
+ * |---|---|---|
265
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
266
+ */
267
+ export const PluginGeomQueryCircleGetCentreArgs = z.object({ circle: CircleHandle })
268
+ export type PluginGeomQueryCircleGetCentreArgs = z.infer<typeof PluginGeomQueryCircleGetCentreArgs>
269
+
270
+ /**
271
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.getAxis}.
272
+ *
273
+ * | Property | Type | Description |
274
+ * |---|---|---|
275
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
276
+ */
277
+ export const PluginGeomQueryCircleGetAxisArgs = z.object({ circle: CircleHandle })
278
+ export type PluginGeomQueryCircleGetAxisArgs = z.infer<typeof PluginGeomQueryCircleGetAxisArgs>
279
+
280
+ /**
281
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.getLength}.
282
+ *
283
+ * | Property | Type | Description |
284
+ * |---|---|---|
285
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
286
+ */
287
+ export const PluginGeomQueryCircleGetLengthArgs = z.object({ circle: CircleHandle })
288
+ export type PluginGeomQueryCircleGetLengthArgs = z.infer<typeof PluginGeomQueryCircleGetLengthArgs>
289
+
290
+ /**
291
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.isValid}.
292
+ *
293
+ * | Property | Type | Description |
294
+ * |---|---|---|
295
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
296
+ */
297
+ export const PluginGeomQueryCircleIsValidArgs = z.object({ circle: CircleHandle })
298
+ export type PluginGeomQueryCircleIsValidArgs = z.infer<typeof PluginGeomQueryCircleIsValidArgs>
299
+
300
+ /**
301
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.getNearestPoint}.
302
+ *
303
+ * | Property | Type | Description |
304
+ * |---|---|---|
305
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
306
+ * | `point` | {@linkcode Vec3Handle} | The reference point |
307
+ */
308
+ export const PluginGeomQueryCircleGetNearestPointArgs = z.object({
309
+ circle: CircleHandle,
310
+ point: Vec3Handle,
311
+ })
312
+ export type PluginGeomQueryCircleGetNearestPointArgs = z.infer<
313
+ typeof PluginGeomQueryCircleGetNearestPointArgs
314
+ >
315
+
316
+ /**
317
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.hasPoint}.
318
+ *
319
+ * | Property | Type | Description |
320
+ * |---|---|---|
321
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
322
+ * | `point` | {@linkcode Vec3Handle} | The point to test |
323
+ */
324
+ export const PluginGeomQueryCircleHasPointArgs = z.object({
325
+ circle: CircleHandle,
326
+ point: Vec3Handle,
327
+ })
328
+ export type PluginGeomQueryCircleHasPointArgs = z.infer<typeof PluginGeomQueryCircleHasPointArgs>
329
+
330
+ /**
331
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.getTangent}.
332
+ *
333
+ * | Property | Type | Description |
334
+ * |---|---|---|
335
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
336
+ * | `point` | {@linkcode Vec3Handle} | A point on the circle |
337
+ */
338
+ export const PluginGeomQueryCircleGetTangentArgs = z.object({
339
+ circle: CircleHandle,
340
+ point: Vec3Handle,
341
+ })
342
+ export type PluginGeomQueryCircleGetTangentArgs = z.infer<typeof PluginGeomQueryCircleGetTangentArgs>
343
+
344
+ /**
345
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.getNormal}.
346
+ *
347
+ * | Property | Type | Description |
348
+ * |---|---|---|
349
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
350
+ * | `point` | {@linkcode Vec3Handle} | A point on the circle |
351
+ */
352
+ export const PluginGeomQueryCircleGetNormalArgs = z.object({
353
+ circle: CircleHandle,
354
+ point: Vec3Handle,
355
+ })
356
+ export type PluginGeomQueryCircleGetNormalArgs = z.infer<typeof PluginGeomQueryCircleGetNormalArgs>
357
+
358
+ /**
359
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.getPointAtDistance}.
360
+ *
361
+ * | Property | Type | Description |
362
+ * |---|---|---|
363
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
364
+ * | `referencePoint` | {@linkcode Vec3Handle} | A point on the circle to travel from |
365
+ * | `distance` | `number` | Arc distance to travel |
366
+ * | `forward` | `boolean` | Travel direction (optional; default forward) |
367
+ */
368
+ export const PluginGeomQueryCircleGetPointAtDistanceArgs = z.object({
369
+ circle: CircleHandle,
370
+ referencePoint: Vec3Handle,
371
+ distance: z.number(),
372
+ forward: z.boolean().optional(),
373
+ })
374
+ export type PluginGeomQueryCircleGetPointAtDistanceArgs = z.infer<
375
+ typeof PluginGeomQueryCircleGetPointAtDistanceArgs
376
+ >
377
+
378
+ /**
379
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.isEqual}.
380
+ *
381
+ * | Property | Type | Description |
382
+ * |---|---|---|
383
+ * | `circleA` | {@linkcode CircleHandle} | First circle |
384
+ * | `circleB` | {@linkcode CircleHandle} | Second circle |
385
+ */
386
+ export const PluginGeomQueryCircleIsEqualArgs = z.object({
387
+ circleA: CircleHandle,
388
+ circleB: CircleHandle,
389
+ })
390
+ export type PluginGeomQueryCircleIsEqualArgs = z.infer<typeof PluginGeomQueryCircleIsEqualArgs>
391
+
392
+ /**
393
+ * Arguments for {@linkcode PluginGeomQueryCircleApi.listPoints}.
394
+ *
395
+ * | Property | Type | Description |
396
+ * |---|---|---|
397
+ * | `circle` | {@linkcode CircleHandle} | The circle to query |
398
+ * | `resolution` | `number` | Number of segments to sample (optional) |
399
+ */
400
+ export const PluginGeomQueryCircleListPointsArgs = z.object({
401
+ circle: CircleHandle,
402
+ resolution: z.number().optional(),
403
+ })
404
+ export type PluginGeomQueryCircleListPointsArgs = z.infer<typeof PluginGeomQueryCircleListPointsArgs>