@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,84 +1,84 @@
1
- import * as z from "zod"
2
- import { PluginApiReturn } from "../../../../types"
3
- import { ProfileHandle, ContourHandle } from "../../../../handles"
4
-
5
- /**
6
- * Geometry deletion — release transient geometry resource handles (all-handle model, §11).
7
- *
8
- * Methods here free a handle's backing registry entry and reclaim its share of the
9
- * plugin's resource quota. This is purely a handle-lifecycle operation: it does NOT
10
- * tear down or delete any engine-side geometry. Once released, the handle is no
11
- * longer resolvable and must not be reused.
12
- *
13
- * Accessed via `snaptrude.core.geom.delete`.
14
- */
15
- export abstract class PluginGeomDeleteApi {
16
- constructor() {}
17
-
18
- /**
19
- * Free a transient profile resource handle — releases its registry entry and
20
- * reclaims its share of the plugin's resource quota. This is a handle-lifecycle
21
- * operation only and does NOT tear down any engine-side geometry.
22
- *
23
- * @deprecated Use `core.handles.release([profile])` — the universal, batched
24
- * release API for every arena handle kind.
25
- *
26
- * @param profile The transient profile handle to release
27
- * @returns Nothing
28
- *
29
- * # Example
30
- * ```ts
31
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
32
- * const area = await snaptrude.core.geom.query.profile.getArea(rect)
33
- * await snaptrude.core.geom.delete.profile(rect) // rect is no longer resolvable
34
- * ```
35
- */
36
- public abstract profile(profile: ProfileHandle): PluginApiReturn<void>
37
-
38
- /**
39
- * Free a transient contour resource handle — releases its registry entry and
40
- * reclaims its share of the plugin's resource quota. Handle-lifecycle only; does
41
- * NOT tear down engine-side geometry, nor the contour's child profile handles.
42
- *
43
- * @deprecated Use `core.handles.release([contour])` — the universal, batched
44
- * release API for every arena handle kind.
45
- *
46
- * @param contour The transient contour handle to release
47
- * @returns Nothing
48
- *
49
- * # Example
50
- * ```ts
51
- * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
52
- * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
53
- * const area = await snaptrude.core.geom.query.contour.getArea(contour)
54
- * await snaptrude.core.geom.delete.contour(contour) // contour freed; rect still valid
55
- * ```
56
- */
57
- public abstract contour(contour: ContourHandle): PluginApiReturn<void>
58
- }
59
-
60
- /**
61
- * Arguments for {@linkcode PluginGeomDeleteApi.profile}.
62
- *
63
- * | Property | Type | Description |
64
- * |---|---|---|
65
- * | `profile` | {@linkcode ProfileHandle} | The transient profile handle to release |
66
- */
67
- export const PluginGeomDeleteProfileArgs = z.object({
68
- profile: ProfileHandle,
69
- })
70
-
71
- export type PluginGeomDeleteProfileArgs = z.infer<typeof PluginGeomDeleteProfileArgs>
72
-
73
- /**
74
- * Arguments for {@linkcode PluginGeomDeleteApi.contour}.
75
- *
76
- * | Property | Type | Description |
77
- * |---|---|---|
78
- * | `contour` | {@linkcode ContourHandle} | The transient contour handle to release |
79
- */
80
- export const PluginGeomDeleteContourArgs = z.object({
81
- contour: ContourHandle,
82
- })
83
-
84
- export type PluginGeomDeleteContourArgs = z.infer<typeof PluginGeomDeleteContourArgs>
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../../types"
3
+ import { ProfileHandle, ContourHandle } from "../../../../handles"
4
+
5
+ /**
6
+ * Geometry deletion — release transient geometry resource handles (all-handle model, §11).
7
+ *
8
+ * Methods here free a handle's backing registry entry and reclaim its share of the
9
+ * plugin's resource quota. This is purely a handle-lifecycle operation: it does NOT
10
+ * tear down or delete any engine-side geometry. Once released, the handle is no
11
+ * longer resolvable and must not be reused.
12
+ *
13
+ * Accessed via `snaptrude.core.geom.delete`.
14
+ */
15
+ export abstract class PluginGeomDeleteApi {
16
+ constructor() {}
17
+
18
+ /**
19
+ * Free a transient profile resource handle — releases its registry entry and
20
+ * reclaims its share of the plugin's resource quota. This is a handle-lifecycle
21
+ * operation only and does NOT tear down any engine-side geometry.
22
+ *
23
+ * @deprecated Use `core.handles.release([profile])` — the universal, batched
24
+ * release API for every arena handle kind.
25
+ *
26
+ * @param profile The transient profile handle to release
27
+ * @returns Nothing
28
+ *
29
+ * # Example
30
+ * ```ts
31
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
32
+ * const area = await snaptrude.core.geom.query.profile.getArea(rect)
33
+ * await snaptrude.core.geom.delete.profile(rect) // rect is no longer resolvable
34
+ * ```
35
+ */
36
+ public abstract profile(profile: ProfileHandle): PluginApiReturn<void>
37
+
38
+ /**
39
+ * Free a transient contour resource handle — releases its registry entry and
40
+ * reclaims its share of the plugin's resource quota. Handle-lifecycle only; does
41
+ * NOT tear down engine-side geometry, nor the contour's child profile handles.
42
+ *
43
+ * @deprecated Use `core.handles.release([contour])` — the universal, batched
44
+ * release API for every arena handle kind.
45
+ *
46
+ * @param contour The transient contour handle to release
47
+ * @returns Nothing
48
+ *
49
+ * # Example
50
+ * ```ts
51
+ * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
52
+ * const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
53
+ * const area = await snaptrude.core.geom.query.contour.getArea(contour)
54
+ * await snaptrude.core.geom.delete.contour(contour) // contour freed; rect still valid
55
+ * ```
56
+ */
57
+ public abstract contour(contour: ContourHandle): PluginApiReturn<void>
58
+ }
59
+
60
+ /**
61
+ * Arguments for {@linkcode PluginGeomDeleteApi.profile}.
62
+ *
63
+ * | Property | Type | Description |
64
+ * |---|---|---|
65
+ * | `profile` | {@linkcode ProfileHandle} | The transient profile handle to release |
66
+ */
67
+ export const PluginGeomDeleteProfileArgs = z.object({
68
+ profile: ProfileHandle,
69
+ })
70
+
71
+ export type PluginGeomDeleteProfileArgs = z.infer<typeof PluginGeomDeleteProfileArgs>
72
+
73
+ /**
74
+ * Arguments for {@linkcode PluginGeomDeleteApi.contour}.
75
+ *
76
+ * | Property | Type | Description |
77
+ * |---|---|---|
78
+ * | `contour` | {@linkcode ContourHandle} | The transient contour handle to release |
79
+ */
80
+ export const PluginGeomDeleteContourArgs = z.object({
81
+ contour: ContourHandle,
82
+ })
83
+
84
+ export type PluginGeomDeleteContourArgs = z.infer<typeof PluginGeomDeleteContourArgs>
@@ -1,35 +1,35 @@
1
- import { PluginGeomCreateApi } from "./create"
2
- import { PluginGeomQueryApi } from "./query"
3
- import { PluginGeomUpdateApi } from "./update"
4
- import { PluginGeomDeleteApi } from "./delete"
5
-
6
- /**
7
- * Geometry kernel — domain-free construction, query, editing, and disposal of
8
- * curves (lines / arcs) and profiles. No BIM/AEC knowledge lives here; build
9
- * geometry bottom-up: points ({@linkcode Vec3Handle}) → curves → profiles → entities.
10
- *
11
- * - {@linkcode PluginGeomApi.create} — construct lines, arcs, and profiles
12
- * - {@linkcode PluginGeomApi.query} — read curve / arc / profile geometry and relationships
13
- * - {@linkcode PluginGeomApi.update} — derive new curves / profiles (immutable edits)
14
- * - {@linkcode PluginGeomApi.delete} — free a transient profile resource handle
15
- *
16
- * Profiles can then be used with entity creation methods like
17
- * {@linkcode PluginSpaceApi.createFromProfile}.
18
- */
19
- export abstract class PluginGeomApi {
20
- /** Curve and profile construction. See {@linkcode PluginGeomCreateApi}. */
21
- public abstract create: PluginGeomCreateApi
22
- /** Curve, arc, and profile queries. See {@linkcode PluginGeomQueryApi}. */
23
- public abstract query: PluginGeomQueryApi
24
- /** Curve and profile editing (derive-new). See {@linkcode PluginGeomUpdateApi}. */
25
- public abstract update: PluginGeomUpdateApi
26
- /** Resource-handle disposal (profile). See {@linkcode PluginGeomDeleteApi}. */
27
- public abstract delete: PluginGeomDeleteApi
28
-
29
- constructor() {}
30
- }
31
-
32
- export * from "./create"
33
- export * from "./query"
34
- export * from "./update"
35
- export * from "./delete"
1
+ import { PluginGeomCreateApi } from "./create"
2
+ import { PluginGeomQueryApi } from "./query"
3
+ import { PluginGeomUpdateApi } from "./update"
4
+ import { PluginGeomDeleteApi } from "./delete"
5
+
6
+ /**
7
+ * Geometry kernel — domain-free construction, query, editing, and disposal of
8
+ * curves (lines / arcs) and profiles. No BIM/AEC knowledge lives here; build
9
+ * geometry bottom-up: points ({@linkcode Vec3Handle}) → curves → profiles → entities.
10
+ *
11
+ * - {@linkcode PluginGeomApi.create} — construct lines, arcs, and profiles
12
+ * - {@linkcode PluginGeomApi.query} — read curve / arc / profile geometry and relationships
13
+ * - {@linkcode PluginGeomApi.update} — derive new curves / profiles (immutable edits)
14
+ * - {@linkcode PluginGeomApi.delete} — free a transient profile resource handle
15
+ *
16
+ * Profiles can then be used with entity creation methods like
17
+ * {@linkcode PluginSpaceApi.createFromProfile}.
18
+ */
19
+ export abstract class PluginGeomApi {
20
+ /** Curve and profile construction. See {@linkcode PluginGeomCreateApi}. */
21
+ public abstract create: PluginGeomCreateApi
22
+ /** Curve, arc, and profile queries. See {@linkcode PluginGeomQueryApi}. */
23
+ public abstract query: PluginGeomQueryApi
24
+ /** Curve and profile editing (derive-new). See {@linkcode PluginGeomUpdateApi}. */
25
+ public abstract update: PluginGeomUpdateApi
26
+ /** Resource-handle disposal (profile). See {@linkcode PluginGeomDeleteApi}. */
27
+ public abstract delete: PluginGeomDeleteApi
28
+
29
+ constructor() {}
30
+ }
31
+
32
+ export * from "./create"
33
+ export * from "./query"
34
+ export * from "./update"
35
+ export * from "./delete"
@@ -1,169 +1,169 @@
1
- import * as z from "zod"
2
- import { PluginApiReturn } from "../../../../types"
3
- import { ArcHandle, Vec3Components } from "../../../../handles"
4
-
5
- /**
6
- * Arc-specific geometry queries — read circular-arc properties as plain values.
7
- *
8
- * Every method takes an opaque {@linkcode ArcHandle} and returns plain values
9
- * (numbers or {@linkcode Vec3Components}), never a handle. Use these to inspect
10
- * the radius, centre, axis, sweep angle, and validity of an arc handle obtained
11
- * from {@linkcode PluginGeomCreateApi.arc} or another query.
12
- *
13
- * Accessed via `snaptrude.core.geom.query.arc`.
14
- */
15
- export abstract class PluginGeomQueryArcApi {
16
- constructor() {}
17
-
18
- /**
19
- * Read the radius of an arc.
20
- *
21
- * @param arc The arc to query
22
- * @returns The arc radius as a `number`
23
- *
24
- * @examplePrompt What is the radius of this curved wall segment?
25
- * @examplePrompt Measure the radius of the selected arc
26
- *
27
- * # Example
28
- * ```ts
29
- * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
30
- * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
31
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
32
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
33
- * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
34
- * const radius = await snaptrude.core.geom.query.arc.getRadius(arc)
35
- * ```
36
- */
37
- public abstract getRadius(arc: ArcHandle): PluginApiReturn<number>
38
-
39
- /**
40
- * Read the centre point of an arc.
41
- *
42
- * @param arc The arc to query
43
- * @returns The arc centre as {@linkcode Vec3Components}
44
- *
45
- * @examplePrompt Where is the centre of this arc?
46
- * @examplePrompt Find the center point of the curved wall
47
- *
48
- * # Example
49
- * ```ts
50
- * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
51
- * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
52
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
53
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
54
- * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
55
- * const centre = await snaptrude.core.geom.query.arc.getCentre(arc)
56
- * console.log(centre.x, centre.y, centre.z)
57
- * ```
58
- */
59
- public abstract getCentre(arc: ArcHandle): PluginApiReturn<Vec3Components>
60
-
61
- /**
62
- * Read the rotation axis of an arc.
63
- *
64
- * @param arc The arc to query
65
- * @returns The arc axis as {@linkcode Vec3Components}
66
- *
67
- * # Example
68
- * ```ts
69
- * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
70
- * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
71
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
72
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
73
- * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
74
- * const axis = await snaptrude.core.geom.query.arc.getAxis(arc)
75
- * console.log(axis.x, axis.y, axis.z)
76
- * ```
77
- */
78
- public abstract getAxis(arc: ArcHandle): PluginApiReturn<Vec3Components>
79
-
80
- /**
81
- * Read the sweep angle of an arc (the angle subtended at its centre).
82
- *
83
- * @param arc The arc to query
84
- * @returns The sweep angle in radians as a `number`
85
- *
86
- * @examplePrompt What angle does this arc sweep through?
87
- * @examplePrompt How many degrees does this curved wall turn?
88
- *
89
- * # Example
90
- * ```ts
91
- * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
92
- * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
93
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
94
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
95
- * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
96
- * const sweep = await snaptrude.core.geom.query.arc.getSweepAngle(arc)
97
- * console.log("degrees:", (sweep * 180) / Math.PI)
98
- * ```
99
- */
100
- public abstract getSweepAngle(arc: ArcHandle): PluginApiReturn<number>
101
-
102
- /**
103
- * Check whether an arc is geometrically valid.
104
- *
105
- * @param arc The arc to query
106
- * @returns `true` if the arc is valid as a `boolean`
107
- *
108
- * # Example
109
- * ```ts
110
- * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
111
- * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
112
- * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
113
- * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
114
- * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
115
- * const ok = await snaptrude.core.geom.query.arc.isValid(arc)
116
- * ```
117
- */
118
- public abstract isValid(arc: ArcHandle): PluginApiReturn<boolean>
119
- }
120
-
121
- /**
122
- * Arguments for {@linkcode PluginGeomQueryArcApi.getRadius}.
123
- *
124
- * | Property | Type | Description |
125
- * |---|---|---|
126
- * | `arc` | {@linkcode ArcHandle} | The arc to query |
127
- */
128
- export const PluginGeomQueryArcGetRadiusArgs = z.object({ arc: ArcHandle })
129
- export type PluginGeomQueryArcGetRadiusArgs = z.infer<typeof PluginGeomQueryArcGetRadiusArgs>
130
-
131
- /**
132
- * Arguments for {@linkcode PluginGeomQueryArcApi.getCentre}.
133
- *
134
- * | Property | Type | Description |
135
- * |---|---|---|
136
- * | `arc` | {@linkcode ArcHandle} | The arc to query |
137
- */
138
- export const PluginGeomQueryArcGetCentreArgs = z.object({ arc: ArcHandle })
139
- export type PluginGeomQueryArcGetCentreArgs = z.infer<typeof PluginGeomQueryArcGetCentreArgs>
140
-
141
- /**
142
- * Arguments for {@linkcode PluginGeomQueryArcApi.getAxis}.
143
- *
144
- * | Property | Type | Description |
145
- * |---|---|---|
146
- * | `arc` | {@linkcode ArcHandle} | The arc to query |
147
- */
148
- export const PluginGeomQueryArcGetAxisArgs = z.object({ arc: ArcHandle })
149
- export type PluginGeomQueryArcGetAxisArgs = z.infer<typeof PluginGeomQueryArcGetAxisArgs>
150
-
151
- /**
152
- * Arguments for {@linkcode PluginGeomQueryArcApi.getSweepAngle}.
153
- *
154
- * | Property | Type | Description |
155
- * |---|---|---|
156
- * | `arc` | {@linkcode ArcHandle} | The arc to query |
157
- */
158
- export const PluginGeomQueryArcGetSweepAngleArgs = z.object({ arc: ArcHandle })
159
- export type PluginGeomQueryArcGetSweepAngleArgs = z.infer<typeof PluginGeomQueryArcGetSweepAngleArgs>
160
-
161
- /**
162
- * Arguments for {@linkcode PluginGeomQueryArcApi.isValid}.
163
- *
164
- * | Property | Type | Description |
165
- * |---|---|---|
166
- * | `arc` | {@linkcode ArcHandle} | The arc to query |
167
- */
168
- export const PluginGeomQueryArcIsValidArgs = z.object({ arc: ArcHandle })
169
- export type PluginGeomQueryArcIsValidArgs = z.infer<typeof PluginGeomQueryArcIsValidArgs>
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../../types"
3
+ import { ArcHandle, Vec3Components } from "../../../../handles"
4
+
5
+ /**
6
+ * Arc-specific geometry queries — read circular-arc properties as plain values.
7
+ *
8
+ * Every method takes an opaque {@linkcode ArcHandle} and returns plain values
9
+ * (numbers or {@linkcode Vec3Components}), never a handle. Use these to inspect
10
+ * the radius, centre, axis, sweep angle, and validity of an arc handle obtained
11
+ * from {@linkcode PluginGeomCreateApi.arc} or another query.
12
+ *
13
+ * Accessed via `snaptrude.core.geom.query.arc`.
14
+ */
15
+ export abstract class PluginGeomQueryArcApi {
16
+ constructor() {}
17
+
18
+ /**
19
+ * Read the radius of an arc.
20
+ *
21
+ * @param arc The arc to query
22
+ * @returns The arc radius as a `number`
23
+ *
24
+ * @examplePrompt What is the radius of this curved wall segment?
25
+ * @examplePrompt Measure the radius of the selected arc
26
+ *
27
+ * # Example
28
+ * ```ts
29
+ * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
30
+ * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
31
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
32
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
33
+ * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
34
+ * const radius = await snaptrude.core.geom.query.arc.getRadius(arc)
35
+ * ```
36
+ */
37
+ public abstract getRadius(arc: ArcHandle): PluginApiReturn<number>
38
+
39
+ /**
40
+ * Read the centre point of an arc.
41
+ *
42
+ * @param arc The arc to query
43
+ * @returns The arc centre as {@linkcode Vec3Components}
44
+ *
45
+ * @examplePrompt Where is the centre of this arc?
46
+ * @examplePrompt Find the center point of the curved wall
47
+ *
48
+ * # Example
49
+ * ```ts
50
+ * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
51
+ * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
52
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
53
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
54
+ * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
55
+ * const centre = await snaptrude.core.geom.query.arc.getCentre(arc)
56
+ * console.log(centre.x, centre.y, centre.z)
57
+ * ```
58
+ */
59
+ public abstract getCentre(arc: ArcHandle): PluginApiReturn<Vec3Components>
60
+
61
+ /**
62
+ * Read the rotation axis of an arc.
63
+ *
64
+ * @param arc The arc to query
65
+ * @returns The arc axis as {@linkcode Vec3Components}
66
+ *
67
+ * # Example
68
+ * ```ts
69
+ * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
70
+ * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
71
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
72
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
73
+ * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
74
+ * const axis = await snaptrude.core.geom.query.arc.getAxis(arc)
75
+ * console.log(axis.x, axis.y, axis.z)
76
+ * ```
77
+ */
78
+ public abstract getAxis(arc: ArcHandle): PluginApiReturn<Vec3Components>
79
+
80
+ /**
81
+ * Read the sweep angle of an arc (the angle subtended at its centre).
82
+ *
83
+ * @param arc The arc to query
84
+ * @returns The sweep angle in radians as a `number`
85
+ *
86
+ * @examplePrompt What angle does this arc sweep through?
87
+ * @examplePrompt How many degrees does this curved wall turn?
88
+ *
89
+ * # Example
90
+ * ```ts
91
+ * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
92
+ * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
93
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
94
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
95
+ * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
96
+ * const sweep = await snaptrude.core.geom.query.arc.getSweepAngle(arc)
97
+ * console.log("degrees:", (sweep * 180) / Math.PI)
98
+ * ```
99
+ */
100
+ public abstract getSweepAngle(arc: ArcHandle): PluginApiReturn<number>
101
+
102
+ /**
103
+ * Check whether an arc is geometrically valid.
104
+ *
105
+ * @param arc The arc to query
106
+ * @returns `true` if the arc is valid as a `boolean`
107
+ *
108
+ * # Example
109
+ * ```ts
110
+ * const start = await snaptrude.core.math.vec3.new(5, 0, 0)
111
+ * const end = await snaptrude.core.math.vec3.new(0, 0, 5)
112
+ * const origin = await snaptrude.core.math.vec3.new(0, 0, 0)
113
+ * const up = await snaptrude.core.math.vec3.new(0, 1, 0)
114
+ * const arc = await snaptrude.core.geom.create.arc(start, end, origin, up)
115
+ * const ok = await snaptrude.core.geom.query.arc.isValid(arc)
116
+ * ```
117
+ */
118
+ public abstract isValid(arc: ArcHandle): PluginApiReturn<boolean>
119
+ }
120
+
121
+ /**
122
+ * Arguments for {@linkcode PluginGeomQueryArcApi.getRadius}.
123
+ *
124
+ * | Property | Type | Description |
125
+ * |---|---|---|
126
+ * | `arc` | {@linkcode ArcHandle} | The arc to query |
127
+ */
128
+ export const PluginGeomQueryArcGetRadiusArgs = z.object({ arc: ArcHandle })
129
+ export type PluginGeomQueryArcGetRadiusArgs = z.infer<typeof PluginGeomQueryArcGetRadiusArgs>
130
+
131
+ /**
132
+ * Arguments for {@linkcode PluginGeomQueryArcApi.getCentre}.
133
+ *
134
+ * | Property | Type | Description |
135
+ * |---|---|---|
136
+ * | `arc` | {@linkcode ArcHandle} | The arc to query |
137
+ */
138
+ export const PluginGeomQueryArcGetCentreArgs = z.object({ arc: ArcHandle })
139
+ export type PluginGeomQueryArcGetCentreArgs = z.infer<typeof PluginGeomQueryArcGetCentreArgs>
140
+
141
+ /**
142
+ * Arguments for {@linkcode PluginGeomQueryArcApi.getAxis}.
143
+ *
144
+ * | Property | Type | Description |
145
+ * |---|---|---|
146
+ * | `arc` | {@linkcode ArcHandle} | The arc to query |
147
+ */
148
+ export const PluginGeomQueryArcGetAxisArgs = z.object({ arc: ArcHandle })
149
+ export type PluginGeomQueryArcGetAxisArgs = z.infer<typeof PluginGeomQueryArcGetAxisArgs>
150
+
151
+ /**
152
+ * Arguments for {@linkcode PluginGeomQueryArcApi.getSweepAngle}.
153
+ *
154
+ * | Property | Type | Description |
155
+ * |---|---|---|
156
+ * | `arc` | {@linkcode ArcHandle} | The arc to query |
157
+ */
158
+ export const PluginGeomQueryArcGetSweepAngleArgs = z.object({ arc: ArcHandle })
159
+ export type PluginGeomQueryArcGetSweepAngleArgs = z.infer<typeof PluginGeomQueryArcGetSweepAngleArgs>
160
+
161
+ /**
162
+ * Arguments for {@linkcode PluginGeomQueryArcApi.isValid}.
163
+ *
164
+ * | Property | Type | Description |
165
+ * |---|---|---|
166
+ * | `arc` | {@linkcode ArcHandle} | The arc to query |
167
+ */
168
+ export const PluginGeomQueryArcIsValidArgs = z.object({ arc: ArcHandle })
169
+ export type PluginGeomQueryArcIsValidArgs = z.infer<typeof PluginGeomQueryArcIsValidArgs>