@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,210 +1,210 @@
1
- import * as z from "zod"
2
- import { PluginApiReturn } from "../../../../types"
3
- import { HalfEdgeHandle, VertexHandle, EdgeHandle, FaceHandle } from "../../../../handles"
4
-
5
- /**
6
- * Half-edge queries — walk and read a single BREP half-edge (all-handle model, §11).
7
- * A {@linkcode HalfEdgeHandle} is minted by walking from a brep/face/edge/vertex
8
- * handle; it is session-ephemeral and goes stale on undo/redo/re-topologize.
9
- *
10
- * The kind token is all-lowercase `"halfedge"` (§6.1 — no camelCase namespaces).
11
- * Traversals (`getNext`/`getPrev`/`getFlip`) return `null` on a boundary or a
12
- * malformed chain rather than throwing (§6, reads never throw).
13
- *
14
- * Accessed via `snaptrude.core.geom.query.halfedge`.
15
- */
16
- export abstract class PluginGeomQueryHalfEdgeApi {
17
- constructor() {}
18
-
19
- /**
20
- * Get the next half-edge around the face loop.
21
- * @param halfEdge The half-edge to walk from
22
- * @returns The next half-edge as a {@linkcode HalfEdgeHandle}, or `null` on a malformed chain
23
- *
24
- * # Example
25
- * ```ts
26
- * const [wall] = await snaptrude.design.query.listWalls()
27
- * const brep = await snaptrude.design.query.geometry.getBrep(wall)
28
- * if (brep) {
29
- * const [face] = await snaptrude.core.geom.query.brep.listFaces(brep)
30
- * const [he] = await snaptrude.core.geom.query.face.listHalfEdges(face)
31
- * const next = await snaptrude.core.geom.query.halfedge.getNext(he)
32
- * if (next) {
33
- * const vertex = await snaptrude.core.geom.query.halfedge.getVertex(next)
34
- * }
35
- * }
36
- * ```
37
- */
38
- public abstract getNext(halfEdge: HalfEdgeHandle): PluginApiReturn<HalfEdgeHandle | null>
39
-
40
- /**
41
- * Get the previous half-edge around the face loop.
42
- * @param halfEdge The half-edge to walk from
43
- * @returns The previous half-edge as a {@linkcode HalfEdgeHandle}, or `null` on a malformed chain
44
- *
45
- * # Example
46
- * ```ts
47
- * const [wall] = await snaptrude.design.query.listWalls()
48
- * const brep = await snaptrude.design.query.geometry.getBrep(wall)
49
- * if (brep) {
50
- * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
51
- * const prev = await snaptrude.core.geom.query.halfedge.getPrev(he)
52
- * if (prev) {
53
- * const edge = await snaptrude.core.geom.query.halfedge.getEdge(prev)
54
- * }
55
- * }
56
- * ```
57
- */
58
- public abstract getPrev(halfEdge: HalfEdgeHandle): PluginApiReturn<HalfEdgeHandle | null>
59
-
60
- /**
61
- * Get the flip (opposite) half-edge of the shared edge.
62
- * @param halfEdge The half-edge to flip
63
- * @returns The flip half-edge as a {@linkcode HalfEdgeHandle}, or `null` on a boundary
64
- *
65
- * # Example
66
- * ```ts
67
- * const [wall] = await snaptrude.design.query.listWalls()
68
- * const brep = await snaptrude.design.query.geometry.getBrep(wall)
69
- * if (brep) {
70
- * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
71
- * const flip = await snaptrude.core.geom.query.halfedge.getFlip(he)
72
- * if (flip) {
73
- * // cross the shared edge into the neighbouring face
74
- * const neighbourFace = await snaptrude.core.geom.query.halfedge.getFace(flip)
75
- * }
76
- * }
77
- * ```
78
- */
79
- public abstract getFlip(halfEdge: HalfEdgeHandle): PluginApiReturn<HalfEdgeHandle | null>
80
-
81
- /**
82
- * Get the tail vertex of a half-edge.
83
- * @param halfEdge The half-edge to read
84
- * @returns The vertex as a {@linkcode VertexHandle}
85
- *
86
- * # Example
87
- * ```ts
88
- * const [wall] = await snaptrude.design.query.listWalls()
89
- * const brep = await snaptrude.design.query.geometry.getBrep(wall)
90
- * if (brep) {
91
- * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
92
- * const vertex = await snaptrude.core.geom.query.halfedge.getVertex(he)
93
- * const pos = await snaptrude.core.geom.query.vertex.getPosition(brep, vertex)
94
- * }
95
- * ```
96
- */
97
- public abstract getVertex(halfEdge: HalfEdgeHandle): PluginApiReturn<VertexHandle>
98
-
99
- /**
100
- * Get the edge of a half-edge.
101
- * @param halfEdge The half-edge to read
102
- * @returns The edge as an {@linkcode EdgeHandle}
103
- *
104
- * # Example
105
- * ```ts
106
- * const [wall] = await snaptrude.design.query.listWalls()
107
- * const brep = await snaptrude.design.query.geometry.getBrep(wall)
108
- * if (brep) {
109
- * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
110
- * const edge = await snaptrude.core.geom.query.halfedge.getEdge(he)
111
- * const faces = await snaptrude.core.geom.query.edge.listFaces(edge)
112
- * }
113
- * ```
114
- */
115
- public abstract getEdge(halfEdge: HalfEdgeHandle): PluginApiReturn<EdgeHandle>
116
-
117
- /**
118
- * Get the face of a half-edge.
119
- * @param halfEdge The half-edge to read
120
- * @returns The face as a {@linkcode FaceHandle}
121
- *
122
- * # Example
123
- * ```ts
124
- * const [wall] = await snaptrude.design.query.listWalls()
125
- * const brep = await snaptrude.design.query.geometry.getBrep(wall)
126
- * if (brep) {
127
- * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
128
- * const face = await snaptrude.core.geom.query.halfedge.getFace(he)
129
- * const index = await snaptrude.core.geom.query.face.getIndex(face)
130
- * }
131
- * ```
132
- */
133
- public abstract getFace(halfEdge: HalfEdgeHandle): PluginApiReturn<FaceHandle>
134
-
135
- /**
136
- * Test whether a half-edge lies on the brep boundary (has no flip).
137
- * @param halfEdge The half-edge to test
138
- * @returns `true` if on the boundary, otherwise `false`
139
- *
140
- * # Example
141
- * ```ts
142
- * const [wall] = await snaptrude.design.query.listWalls()
143
- * const brep = await snaptrude.design.query.geometry.getBrep(wall)
144
- * if (brep) {
145
- * const halfEdges = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
146
- * let boundary = 0
147
- * for (const he of halfEdges) {
148
- * if (await snaptrude.core.geom.query.halfedge.isOnBoundary(he)) boundary++
149
- * }
150
- * console.log("boundary half-edges:", boundary)
151
- * }
152
- * ```
153
- */
154
- public abstract isOnBoundary(halfEdge: HalfEdgeHandle): PluginApiReturn<boolean>
155
-
156
- /**
157
- * Test whether a half-edge is the forward (primary) half-edge of its edge —
158
- * i.e. `edge.getHalfEdge() === thisHalfEdge`.
159
- * @param halfEdge The half-edge to test
160
- * @returns `true` if forward, otherwise `false`
161
- *
162
- * # Example
163
- * ```ts
164
- * const [wall] = await snaptrude.design.query.listWalls()
165
- * const brep = await snaptrude.design.query.geometry.getBrep(wall)
166
- * if (brep) {
167
- * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
168
- * const forward = await snaptrude.core.geom.query.halfedge.isForward(he)
169
- * console.log(forward ? "primary half-edge" : "flip half-edge")
170
- * }
171
- * ```
172
- */
173
- public abstract isForward(halfEdge: HalfEdgeHandle): PluginApiReturn<boolean>
174
- }
175
-
176
- const heArg = z.object({ halfEdge: HalfEdgeHandle })
177
-
178
- /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getNext}. `{ halfEdge: HalfEdgeHandle }` */
179
- export const PluginGeomQueryHalfEdgeGetNextArgs = heArg
180
- export type PluginGeomQueryHalfEdgeGetNextArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetNextArgs>
181
-
182
- /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getPrev}. `{ halfEdge: HalfEdgeHandle }` */
183
- export const PluginGeomQueryHalfEdgeGetPrevArgs = heArg
184
- export type PluginGeomQueryHalfEdgeGetPrevArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetPrevArgs>
185
-
186
- /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getFlip}. `{ halfEdge: HalfEdgeHandle }` */
187
- export const PluginGeomQueryHalfEdgeGetFlipArgs = heArg
188
- export type PluginGeomQueryHalfEdgeGetFlipArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetFlipArgs>
189
-
190
- /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getVertex}. `{ halfEdge: HalfEdgeHandle }` */
191
- export const PluginGeomQueryHalfEdgeGetVertexArgs = heArg
192
- export type PluginGeomQueryHalfEdgeGetVertexArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetVertexArgs>
193
-
194
- /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getEdge}. `{ halfEdge: HalfEdgeHandle }` */
195
- export const PluginGeomQueryHalfEdgeGetEdgeArgs = heArg
196
- export type PluginGeomQueryHalfEdgeGetEdgeArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetEdgeArgs>
197
-
198
- /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getFace}. `{ halfEdge: HalfEdgeHandle }` */
199
- export const PluginGeomQueryHalfEdgeGetFaceArgs = heArg
200
- export type PluginGeomQueryHalfEdgeGetFaceArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetFaceArgs>
201
-
202
- /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.isOnBoundary}. `{ halfEdge: HalfEdgeHandle }` */
203
- export const PluginGeomQueryHalfEdgeIsOnBoundaryArgs = heArg
204
- export type PluginGeomQueryHalfEdgeIsOnBoundaryArgs = z.infer<
205
- typeof PluginGeomQueryHalfEdgeIsOnBoundaryArgs
206
- >
207
-
208
- /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.isForward}. `{ halfEdge: HalfEdgeHandle }` */
209
- export const PluginGeomQueryHalfEdgeIsForwardArgs = heArg
210
- export type PluginGeomQueryHalfEdgeIsForwardArgs = z.infer<typeof PluginGeomQueryHalfEdgeIsForwardArgs>
1
+ import * as z from "zod"
2
+ import { PluginApiReturn } from "../../../../types"
3
+ import { HalfEdgeHandle, VertexHandle, EdgeHandle, FaceHandle } from "../../../../handles"
4
+
5
+ /**
6
+ * Half-edge queries — walk and read a single BREP half-edge (all-handle model, §11).
7
+ * A {@linkcode HalfEdgeHandle} is minted by walking from a brep/face/edge/vertex
8
+ * handle; it is session-ephemeral and goes stale on undo/redo/re-topologize.
9
+ *
10
+ * The kind token is all-lowercase `"halfedge"` (§6.1 — no camelCase namespaces).
11
+ * Traversals (`getNext`/`getPrev`/`getFlip`) return `null` on a boundary or a
12
+ * malformed chain rather than throwing (§6, reads never throw).
13
+ *
14
+ * Accessed via `snaptrude.core.geom.query.halfedge`.
15
+ */
16
+ export abstract class PluginGeomQueryHalfEdgeApi {
17
+ constructor() {}
18
+
19
+ /**
20
+ * Get the next half-edge around the face loop.
21
+ * @param halfEdge The half-edge to walk from
22
+ * @returns The next half-edge as a {@linkcode HalfEdgeHandle}, or `null` on a malformed chain
23
+ *
24
+ * # Example
25
+ * ```ts
26
+ * const [wall] = await snaptrude.design.query.listWalls()
27
+ * const brep = await snaptrude.design.query.geometry.getBrep(wall)
28
+ * if (brep) {
29
+ * const [face] = await snaptrude.core.geom.query.brep.listFaces(brep)
30
+ * const [he] = await snaptrude.core.geom.query.face.listHalfEdges(face)
31
+ * const next = await snaptrude.core.geom.query.halfedge.getNext(he)
32
+ * if (next) {
33
+ * const vertex = await snaptrude.core.geom.query.halfedge.getVertex(next)
34
+ * }
35
+ * }
36
+ * ```
37
+ */
38
+ public abstract getNext(halfEdge: HalfEdgeHandle): PluginApiReturn<HalfEdgeHandle | null>
39
+
40
+ /**
41
+ * Get the previous half-edge around the face loop.
42
+ * @param halfEdge The half-edge to walk from
43
+ * @returns The previous half-edge as a {@linkcode HalfEdgeHandle}, or `null` on a malformed chain
44
+ *
45
+ * # Example
46
+ * ```ts
47
+ * const [wall] = await snaptrude.design.query.listWalls()
48
+ * const brep = await snaptrude.design.query.geometry.getBrep(wall)
49
+ * if (brep) {
50
+ * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
51
+ * const prev = await snaptrude.core.geom.query.halfedge.getPrev(he)
52
+ * if (prev) {
53
+ * const edge = await snaptrude.core.geom.query.halfedge.getEdge(prev)
54
+ * }
55
+ * }
56
+ * ```
57
+ */
58
+ public abstract getPrev(halfEdge: HalfEdgeHandle): PluginApiReturn<HalfEdgeHandle | null>
59
+
60
+ /**
61
+ * Get the flip (opposite) half-edge of the shared edge.
62
+ * @param halfEdge The half-edge to flip
63
+ * @returns The flip half-edge as a {@linkcode HalfEdgeHandle}, or `null` on a boundary
64
+ *
65
+ * # Example
66
+ * ```ts
67
+ * const [wall] = await snaptrude.design.query.listWalls()
68
+ * const brep = await snaptrude.design.query.geometry.getBrep(wall)
69
+ * if (brep) {
70
+ * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
71
+ * const flip = await snaptrude.core.geom.query.halfedge.getFlip(he)
72
+ * if (flip) {
73
+ * // cross the shared edge into the neighbouring face
74
+ * const neighbourFace = await snaptrude.core.geom.query.halfedge.getFace(flip)
75
+ * }
76
+ * }
77
+ * ```
78
+ */
79
+ public abstract getFlip(halfEdge: HalfEdgeHandle): PluginApiReturn<HalfEdgeHandle | null>
80
+
81
+ /**
82
+ * Get the tail vertex of a half-edge.
83
+ * @param halfEdge The half-edge to read
84
+ * @returns The vertex as a {@linkcode VertexHandle}
85
+ *
86
+ * # Example
87
+ * ```ts
88
+ * const [wall] = await snaptrude.design.query.listWalls()
89
+ * const brep = await snaptrude.design.query.geometry.getBrep(wall)
90
+ * if (brep) {
91
+ * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
92
+ * const vertex = await snaptrude.core.geom.query.halfedge.getVertex(he)
93
+ * const pos = await snaptrude.core.geom.query.vertex.getPosition(brep, vertex)
94
+ * }
95
+ * ```
96
+ */
97
+ public abstract getVertex(halfEdge: HalfEdgeHandle): PluginApiReturn<VertexHandle>
98
+
99
+ /**
100
+ * Get the edge of a half-edge.
101
+ * @param halfEdge The half-edge to read
102
+ * @returns The edge as an {@linkcode EdgeHandle}
103
+ *
104
+ * # Example
105
+ * ```ts
106
+ * const [wall] = await snaptrude.design.query.listWalls()
107
+ * const brep = await snaptrude.design.query.geometry.getBrep(wall)
108
+ * if (brep) {
109
+ * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
110
+ * const edge = await snaptrude.core.geom.query.halfedge.getEdge(he)
111
+ * const faces = await snaptrude.core.geom.query.edge.listFaces(edge)
112
+ * }
113
+ * ```
114
+ */
115
+ public abstract getEdge(halfEdge: HalfEdgeHandle): PluginApiReturn<EdgeHandle>
116
+
117
+ /**
118
+ * Get the face of a half-edge.
119
+ * @param halfEdge The half-edge to read
120
+ * @returns The face as a {@linkcode FaceHandle}
121
+ *
122
+ * # Example
123
+ * ```ts
124
+ * const [wall] = await snaptrude.design.query.listWalls()
125
+ * const brep = await snaptrude.design.query.geometry.getBrep(wall)
126
+ * if (brep) {
127
+ * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
128
+ * const face = await snaptrude.core.geom.query.halfedge.getFace(he)
129
+ * const index = await snaptrude.core.geom.query.face.getIndex(face)
130
+ * }
131
+ * ```
132
+ */
133
+ public abstract getFace(halfEdge: HalfEdgeHandle): PluginApiReturn<FaceHandle>
134
+
135
+ /**
136
+ * Test whether a half-edge lies on the brep boundary (has no flip).
137
+ * @param halfEdge The half-edge to test
138
+ * @returns `true` if on the boundary, otherwise `false`
139
+ *
140
+ * # Example
141
+ * ```ts
142
+ * const [wall] = await snaptrude.design.query.listWalls()
143
+ * const brep = await snaptrude.design.query.geometry.getBrep(wall)
144
+ * if (brep) {
145
+ * const halfEdges = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
146
+ * let boundary = 0
147
+ * for (const he of halfEdges) {
148
+ * if (await snaptrude.core.geom.query.halfedge.isOnBoundary(he)) boundary++
149
+ * }
150
+ * console.log("boundary half-edges:", boundary)
151
+ * }
152
+ * ```
153
+ */
154
+ public abstract isOnBoundary(halfEdge: HalfEdgeHandle): PluginApiReturn<boolean>
155
+
156
+ /**
157
+ * Test whether a half-edge is the forward (primary) half-edge of its edge —
158
+ * i.e. `edge.getHalfEdge() === thisHalfEdge`.
159
+ * @param halfEdge The half-edge to test
160
+ * @returns `true` if forward, otherwise `false`
161
+ *
162
+ * # Example
163
+ * ```ts
164
+ * const [wall] = await snaptrude.design.query.listWalls()
165
+ * const brep = await snaptrude.design.query.geometry.getBrep(wall)
166
+ * if (brep) {
167
+ * const [he] = await snaptrude.core.geom.query.brep.listHalfEdges(brep)
168
+ * const forward = await snaptrude.core.geom.query.halfedge.isForward(he)
169
+ * console.log(forward ? "primary half-edge" : "flip half-edge")
170
+ * }
171
+ * ```
172
+ */
173
+ public abstract isForward(halfEdge: HalfEdgeHandle): PluginApiReturn<boolean>
174
+ }
175
+
176
+ const heArg = z.object({ halfEdge: HalfEdgeHandle })
177
+
178
+ /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getNext}. `{ halfEdge: HalfEdgeHandle }` */
179
+ export const PluginGeomQueryHalfEdgeGetNextArgs = heArg
180
+ export type PluginGeomQueryHalfEdgeGetNextArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetNextArgs>
181
+
182
+ /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getPrev}. `{ halfEdge: HalfEdgeHandle }` */
183
+ export const PluginGeomQueryHalfEdgeGetPrevArgs = heArg
184
+ export type PluginGeomQueryHalfEdgeGetPrevArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetPrevArgs>
185
+
186
+ /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getFlip}. `{ halfEdge: HalfEdgeHandle }` */
187
+ export const PluginGeomQueryHalfEdgeGetFlipArgs = heArg
188
+ export type PluginGeomQueryHalfEdgeGetFlipArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetFlipArgs>
189
+
190
+ /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getVertex}. `{ halfEdge: HalfEdgeHandle }` */
191
+ export const PluginGeomQueryHalfEdgeGetVertexArgs = heArg
192
+ export type PluginGeomQueryHalfEdgeGetVertexArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetVertexArgs>
193
+
194
+ /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getEdge}. `{ halfEdge: HalfEdgeHandle }` */
195
+ export const PluginGeomQueryHalfEdgeGetEdgeArgs = heArg
196
+ export type PluginGeomQueryHalfEdgeGetEdgeArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetEdgeArgs>
197
+
198
+ /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.getFace}. `{ halfEdge: HalfEdgeHandle }` */
199
+ export const PluginGeomQueryHalfEdgeGetFaceArgs = heArg
200
+ export type PluginGeomQueryHalfEdgeGetFaceArgs = z.infer<typeof PluginGeomQueryHalfEdgeGetFaceArgs>
201
+
202
+ /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.isOnBoundary}. `{ halfEdge: HalfEdgeHandle }` */
203
+ export const PluginGeomQueryHalfEdgeIsOnBoundaryArgs = heArg
204
+ export type PluginGeomQueryHalfEdgeIsOnBoundaryArgs = z.infer<
205
+ typeof PluginGeomQueryHalfEdgeIsOnBoundaryArgs
206
+ >
207
+
208
+ /** Arguments for {@linkcode PluginGeomQueryHalfEdgeApi.isForward}. `{ halfEdge: HalfEdgeHandle }` */
209
+ export const PluginGeomQueryHalfEdgeIsForwardArgs = heArg
210
+ export type PluginGeomQueryHalfEdgeIsForwardArgs = z.infer<typeof PluginGeomQueryHalfEdgeIsForwardArgs>
@@ -1,63 +1,63 @@
1
- import { PluginGeomQueryCurveApi } from "./curve"
2
- import { PluginGeomQueryArcApi } from "./arc"
3
- import { PluginGeomQueryCircleApi } from "./circle"
4
- import { PluginGeomQueryProfileApi } from "./profile"
5
- import { PluginGeomQueryContourApi } from "./contour"
6
- import { PluginGeomQueryBrepApi } from "./brep"
7
- import { PluginGeomQueryFaceApi } from "./face"
8
- import { PluginGeomQueryEdgeApi } from "./edge"
9
- import { PluginGeomQueryHalfEdgeApi } from "./halfedge"
10
- import { PluginGeomQueryVertexApi } from "./vertex"
11
-
12
- /**
13
- * Geometry-kernel query namespace — read geometry, topology, and relationships as
14
- * plain values / child handles (all-handle model, §11). No query mutates its inputs.
15
- *
16
- * - {@linkcode PluginGeomQueryApi.curve} — shared line/arc queries + two-curve relationships
17
- * - {@linkcode PluginGeomQueryApi.arc} — arc-specific reads
18
- * - {@linkcode PluginGeomQueryApi.circle} — circle-specific reads
19
- * - {@linkcode PluginGeomQueryApi.profile} — profile reads
20
- * - {@linkcode PluginGeomQueryApi.contour} — contour reads (outer profile + holes)
21
- * - {@linkcode PluginGeomQueryApi.brep} — BREP mesh topology + geometry
22
- * - {@linkcode PluginGeomQueryApi.face} — BREP face reads
23
- * - {@linkcode PluginGeomQueryApi.edge} — BREP edge reads
24
- * - {@linkcode PluginGeomQueryApi.halfedge} — BREP half-edge walks
25
- * - {@linkcode PluginGeomQueryApi.vertex} — BREP vertex reads
26
- *
27
- * Accessed via `snaptrude.core.geom.query`.
28
- */
29
- export abstract class PluginGeomQueryApi {
30
- /** Shared curve queries (line or arc) and relationships. See {@linkcode PluginGeomQueryCurveApi}. */
31
- public abstract curve: PluginGeomQueryCurveApi
32
- /** Arc-specific queries. See {@linkcode PluginGeomQueryArcApi}. */
33
- public abstract arc: PluginGeomQueryArcApi
34
- /** Circle-specific queries. See {@linkcode PluginGeomQueryCircleApi}. */
35
- public abstract circle: PluginGeomQueryCircleApi
36
- /** Profile queries. See {@linkcode PluginGeomQueryProfileApi}. */
37
- public abstract profile: PluginGeomQueryProfileApi
38
- /** Contour queries. See {@linkcode PluginGeomQueryContourApi}. */
39
- public abstract contour: PluginGeomQueryContourApi
40
- /** BREP mesh topology + geometry queries. See {@linkcode PluginGeomQueryBrepApi}. */
41
- public abstract brep: PluginGeomQueryBrepApi
42
- /** BREP face queries. See {@linkcode PluginGeomQueryFaceApi}. */
43
- public abstract face: PluginGeomQueryFaceApi
44
- /** BREP edge queries. See {@linkcode PluginGeomQueryEdgeApi}. */
45
- public abstract edge: PluginGeomQueryEdgeApi
46
- /** BREP half-edge walks. See {@linkcode PluginGeomQueryHalfEdgeApi}. */
47
- public abstract halfedge: PluginGeomQueryHalfEdgeApi
48
- /** BREP vertex queries. See {@linkcode PluginGeomQueryVertexApi}. */
49
- public abstract vertex: PluginGeomQueryVertexApi
50
-
51
- constructor() {}
52
- }
53
-
54
- export * from "./curve"
55
- export * from "./arc"
56
- export * from "./circle"
57
- export * from "./profile"
58
- export * from "./contour"
59
- export * from "./brep"
60
- export * from "./face"
61
- export * from "./edge"
62
- export * from "./halfedge"
63
- export * from "./vertex"
1
+ import { PluginGeomQueryCurveApi } from "./curve"
2
+ import { PluginGeomQueryArcApi } from "./arc"
3
+ import { PluginGeomQueryCircleApi } from "./circle"
4
+ import { PluginGeomQueryProfileApi } from "./profile"
5
+ import { PluginGeomQueryContourApi } from "./contour"
6
+ import { PluginGeomQueryBrepApi } from "./brep"
7
+ import { PluginGeomQueryFaceApi } from "./face"
8
+ import { PluginGeomQueryEdgeApi } from "./edge"
9
+ import { PluginGeomQueryHalfEdgeApi } from "./halfedge"
10
+ import { PluginGeomQueryVertexApi } from "./vertex"
11
+
12
+ /**
13
+ * Geometry-kernel query namespace — read geometry, topology, and relationships as
14
+ * plain values / child handles (all-handle model, §11). No query mutates its inputs.
15
+ *
16
+ * - {@linkcode PluginGeomQueryApi.curve} — shared line/arc queries + two-curve relationships
17
+ * - {@linkcode PluginGeomQueryApi.arc} — arc-specific reads
18
+ * - {@linkcode PluginGeomQueryApi.circle} — circle-specific reads
19
+ * - {@linkcode PluginGeomQueryApi.profile} — profile reads
20
+ * - {@linkcode PluginGeomQueryApi.contour} — contour reads (outer profile + holes)
21
+ * - {@linkcode PluginGeomQueryApi.brep} — BREP mesh topology + geometry
22
+ * - {@linkcode PluginGeomQueryApi.face} — BREP face reads
23
+ * - {@linkcode PluginGeomQueryApi.edge} — BREP edge reads
24
+ * - {@linkcode PluginGeomQueryApi.halfedge} — BREP half-edge walks
25
+ * - {@linkcode PluginGeomQueryApi.vertex} — BREP vertex reads
26
+ *
27
+ * Accessed via `snaptrude.core.geom.query`.
28
+ */
29
+ export abstract class PluginGeomQueryApi {
30
+ /** Shared curve queries (line or arc) and relationships. See {@linkcode PluginGeomQueryCurveApi}. */
31
+ public abstract curve: PluginGeomQueryCurveApi
32
+ /** Arc-specific queries. See {@linkcode PluginGeomQueryArcApi}. */
33
+ public abstract arc: PluginGeomQueryArcApi
34
+ /** Circle-specific queries. See {@linkcode PluginGeomQueryCircleApi}. */
35
+ public abstract circle: PluginGeomQueryCircleApi
36
+ /** Profile queries. See {@linkcode PluginGeomQueryProfileApi}. */
37
+ public abstract profile: PluginGeomQueryProfileApi
38
+ /** Contour queries. See {@linkcode PluginGeomQueryContourApi}. */
39
+ public abstract contour: PluginGeomQueryContourApi
40
+ /** BREP mesh topology + geometry queries. See {@linkcode PluginGeomQueryBrepApi}. */
41
+ public abstract brep: PluginGeomQueryBrepApi
42
+ /** BREP face queries. See {@linkcode PluginGeomQueryFaceApi}. */
43
+ public abstract face: PluginGeomQueryFaceApi
44
+ /** BREP edge queries. See {@linkcode PluginGeomQueryEdgeApi}. */
45
+ public abstract edge: PluginGeomQueryEdgeApi
46
+ /** BREP half-edge walks. See {@linkcode PluginGeomQueryHalfEdgeApi}. */
47
+ public abstract halfedge: PluginGeomQueryHalfEdgeApi
48
+ /** BREP vertex queries. See {@linkcode PluginGeomQueryVertexApi}. */
49
+ public abstract vertex: PluginGeomQueryVertexApi
50
+
51
+ constructor() {}
52
+ }
53
+
54
+ export * from "./curve"
55
+ export * from "./arc"
56
+ export * from "./circle"
57
+ export * from "./profile"
58
+ export * from "./contour"
59
+ export * from "./brep"
60
+ export * from "./face"
61
+ export * from "./edge"
62
+ export * from "./halfedge"
63
+ export * from "./vertex"