@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.
- package/AGENTS.md +231 -231
- package/CHANGELOG.md +408 -408
- package/CLAUDE.md +11 -11
- package/dist/api/analysis/daylight.d.ts +5 -5
- package/dist/api/analysis/solar.d.ts +2 -2
- package/dist/api/core/camera/index.d.ts +29 -0
- package/dist/api/core/camera/index.d.ts.map +1 -1
- package/dist/api/core/geom/create/index.d.ts +7 -1
- package/dist/api/core/geom/create/index.d.ts.map +1 -1
- package/dist/api/core/geom/update/contour.d.ts +8 -2
- package/dist/api/core/geom/update/contour.d.ts.map +1 -1
- package/dist/api/core/zoom/index.d.ts +13 -0
- package/dist/api/core/zoom/index.d.ts.map +1 -1
- package/dist/api/design/bim.d.ts +209 -0
- package/dist/api/design/bim.d.ts.map +1 -0
- package/dist/api/design/boolean/index.d.ts +2 -0
- package/dist/api/design/boolean/index.d.ts.map +1 -1
- package/dist/api/design/catalog.d.ts +320 -0
- package/dist/api/design/catalog.d.ts.map +1 -0
- package/dist/api/design/create/bulk-items.d.ts +65 -25
- package/dist/api/design/create/bulk-items.d.ts.map +1 -1
- package/dist/api/design/create/index.d.ts +272 -99
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/create/opening-fields.d.ts +13 -12
- package/dist/api/design/create/opening-fields.d.ts.map +1 -1
- package/dist/api/design/delete/index.d.ts +1 -0
- package/dist/api/design/delete/index.d.ts.map +1 -1
- package/dist/api/design/doors/index.d.ts +18 -24
- package/dist/api/design/doors/index.d.ts.map +1 -1
- package/dist/api/design/family.d.ts +797 -27
- package/dist/api/design/family.d.ts.map +1 -1
- package/dist/api/design/index.d.ts +16 -0
- package/dist/api/design/index.d.ts.map +1 -1
- package/dist/api/design/networks.d.ts +1763 -0
- package/dist/api/design/networks.d.ts.map +1 -0
- package/dist/api/design/query/index.d.ts +42 -32
- package/dist/api/design/query/index.d.ts.map +1 -1
- package/dist/api/design/selection/index.d.ts +10 -10
- package/dist/api/design/types/index.d.ts +40 -24
- package/dist/api/design/types/index.d.ts.map +1 -1
- package/dist/api/design/update/index.d.ts +43 -3
- package/dist/api/design/update/index.d.ts.map +1 -1
- package/dist/api/design/windows/index.d.ts +8 -8
- package/dist/api/design/windows/index.d.ts.map +1 -1
- package/dist/api/presentation/aiInspiration.d.ts +10 -10
- package/dist/api/presentation/annotate.d.ts +38 -22
- package/dist/api/presentation/annotate.d.ts.map +1 -1
- package/dist/api/presentation/drawingContract.d.ts +32 -0
- package/dist/api/presentation/drawingContract.d.ts.map +1 -0
- package/dist/api/presentation/drawings.d.ts +3523 -0
- package/dist/api/presentation/drawings.d.ts.map +1 -0
- package/dist/api/presentation/export.d.ts +23 -5
- package/dist/api/presentation/export.d.ts.map +1 -1
- package/dist/api/presentation/index.d.ts +32 -12
- package/dist/api/presentation/index.d.ts.map +1 -1
- package/dist/api/presentation/placedViews.d.ts +106 -6
- package/dist/api/presentation/placedViews.d.ts.map +1 -1
- package/dist/api/presentation/shapes.d.ts +2 -2
- package/dist/api/presentation/sheets.d.ts +175 -19
- package/dist/api/presentation/sheets.d.ts.map +1 -1
- package/dist/api/presentation/viewPresets.d.ts +222 -0
- package/dist/api/presentation/viewPresets.d.ts.map +1 -0
- package/dist/api/presentation/views.d.ts +103 -5
- package/dist/api/presentation/views.d.ts.map +1 -1
- package/dist/api/presentation/walkthroughs.d.ts +6 -6
- package/dist/errors/codes.d.ts +3 -1
- package/dist/errors/codes.d.ts.map +1 -1
- package/dist/index.cjs +3732 -2383
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +3607 -2383
- package/dist/index.js.map +1 -1
- package/package.json +42 -42
- package/scripts/check-dist-fresh.mjs +22 -22
- package/scripts/generate-manifest.mjs +243 -238
- package/scripts/generate-manifest.test.mjs +303 -303
- package/src/api/analysis/daylight.ts +470 -470
- package/src/api/analysis/heatmaps.ts +683 -683
- package/src/api/analysis/illuminance.ts +155 -155
- package/src/api/analysis/index.ts +61 -61
- package/src/api/analysis/shadows.ts +183 -183
- package/src/api/analysis/solar.ts +237 -237
- package/src/api/analysis/sunlightHours.ts +211 -211
- package/src/api/analysis/sunpath.ts +83 -83
- package/src/api/analysis/weather.ts +179 -179
- package/src/api/core/buildings.ts +485 -485
- package/src/api/core/camera/index.ts +696 -667
- package/src/api/core/comment/index.ts +376 -376
- package/src/api/core/geom/create/index.ts +2139 -2133
- package/src/api/core/geom/delete/index.ts +84 -84
- package/src/api/core/geom/index.ts +35 -35
- package/src/api/core/geom/query/arc.ts +169 -169
- package/src/api/core/geom/query/brep.ts +621 -621
- package/src/api/core/geom/query/circle.ts +404 -404
- package/src/api/core/geom/query/contour.ts +540 -540
- package/src/api/core/geom/query/curve.ts +1102 -1102
- package/src/api/core/geom/query/edge.ts +130 -130
- package/src/api/core/geom/query/face.ts +508 -508
- package/src/api/core/geom/query/halfedge.ts +210 -210
- package/src/api/core/geom/query/index.ts +63 -63
- package/src/api/core/geom/query/profile.ts +473 -473
- package/src/api/core/geom/query/vertex.ts +205 -205
- package/src/api/core/geom/update/contour.ts +323 -317
- package/src/api/core/geom/update/curve.ts +209 -209
- package/src/api/core/geom/update/index.ts +29 -29
- package/src/api/core/geom/update/profile.ts +379 -379
- package/src/api/core/groups.ts +521 -521
- package/src/api/core/handles/index.ts +234 -234
- package/src/api/core/history/index.ts +84 -84
- package/src/api/core/index.ts +99 -99
- package/src/api/core/io/export/index.ts +126 -126
- package/src/api/core/io/import/index.ts +504 -504
- package/src/api/core/io/index.ts +42 -42
- package/src/api/core/io/job/index.ts +140 -140
- package/src/api/core/io/query/index.ts +71 -71
- package/src/api/core/io/terrain/index.ts +360 -360
- package/src/api/core/io/underlay/index.ts +705 -705
- package/src/api/core/layers.ts +540 -540
- package/src/api/core/math/index.ts +20 -20
- package/src/api/core/math/quat.ts +172 -172
- package/src/api/core/math/vec3.ts +179 -179
- package/src/api/core/mode/index.ts +108 -108
- package/src/api/core/project/index.ts +479 -479
- package/src/api/core/proposals/index.ts +570 -570
- package/src/api/core/storeys/index.ts +308 -308
- package/src/api/core/storeys/layers.ts +339 -339
- package/src/api/core/tags.ts +911 -911
- package/src/api/core/units/index.ts +164 -164
- package/src/api/core/user.ts +46 -46
- package/src/api/core/zoom/index.ts +64 -51
- package/src/api/design/bim.ts +121 -0
- package/src/api/design/boolean/index.ts +181 -179
- package/src/api/design/catalog.ts +203 -0
- package/src/api/design/create/bulk-items.ts +294 -254
- package/src/api/design/create/grids.ts +137 -137
- package/src/api/design/create/index.ts +2148 -1980
- package/src/api/design/create/opening-fields.ts +40 -37
- package/src/api/design/delete/index.ts +75 -74
- package/src/api/design/dimensions.ts +453 -453
- package/src/api/design/doors/index.ts +516 -500
- package/src/api/design/edit/index.ts +54 -54
- package/src/api/design/erase/index.ts +151 -151
- package/src/api/design/family.ts +1334 -704
- package/src/api/design/furniture/index.ts +319 -319
- package/src/api/design/grids.ts +237 -237
- package/src/api/design/index.ts +304 -274
- package/src/api/design/lock.ts +69 -69
- package/src/api/design/materials/index.ts +608 -608
- package/src/api/design/networks.ts +667 -0
- package/src/api/design/query/geometry/index.ts +319 -319
- package/src/api/design/query/grids.ts +197 -197
- package/src/api/design/query/index.ts +1236 -1226
- package/src/api/design/query/referenceLines.ts +52 -52
- package/src/api/design/query/spaces.ts +275 -275
- package/src/api/design/selection/index.ts +273 -273
- package/src/api/design/shared.ts +40 -40
- package/src/api/design/transform/index.ts +254 -254
- package/src/api/design/types/index.ts +163 -156
- package/src/api/design/update/index.ts +1024 -983
- package/src/api/design/visibility.ts +143 -143
- package/src/api/design/windows/index.ts +351 -333
- package/src/api/entity/buildableEnvelope.ts +322 -322
- package/src/api/entity/index.ts +30 -30
- package/src/api/entity/referenceLine.ts +235 -235
- package/src/api/entity/space.ts +612 -612
- package/src/api/entity/story.ts +517 -517
- package/src/api/index.ts +47 -47
- package/src/api/presentation/aiInspiration.ts +1116 -1116
- package/src/api/presentation/annotate.ts +417 -385
- package/src/api/presentation/camera.ts +289 -289
- package/src/api/presentation/diagrams.ts +194 -194
- package/src/api/presentation/drawingContract.ts +70 -0
- package/src/api/presentation/drawings.ts +1179 -0
- package/src/api/presentation/export.ts +134 -108
- package/src/api/presentation/import.ts +159 -159
- package/src/api/presentation/index.ts +160 -135
- package/src/api/presentation/placedViews.ts +1211 -1120
- package/src/api/presentation/sections.ts +420 -420
- package/src/api/presentation/shapes.ts +274 -274
- package/src/api/presentation/sheets.ts +746 -585
- package/src/api/presentation/slideshow.ts +134 -134
- package/src/api/presentation/tables.ts +84 -84
- package/src/api/presentation/viewPresets.ts +241 -0
- package/src/api/presentation/views.ts +713 -673
- package/src/api/presentation/walkthroughs.ts +1201 -1201
- package/src/api/program/adjacency.ts +164 -164
- package/src/api/program/areas.ts +408 -408
- package/src/api/program/classification.ts +138 -138
- package/src/api/program/cores.ts +83 -83
- package/src/api/program/departments.ts +517 -517
- package/src/api/program/index.ts +73 -73
- package/src/api/program/labels.ts +332 -332
- package/src/api/program/layout.ts +422 -422
- package/src/api/program/metadata.ts +364 -364
- package/src/api/program/metrics.ts +120 -120
- package/src/api/program/site.ts +748 -748
- package/src/api/program/spreadsheet.ts +2698 -2698
- package/src/api/workspace/index.ts +612 -612
- package/src/errors/codes.ts +143 -136
- package/src/errors/envelope.ts +75 -75
- package/src/errors/index.ts +21 -21
- package/src/errors/plugin-error.ts +134 -134
- package/src/handles.ts +297 -297
- package/src/host-utils.ts +67 -67
- package/src/index.ts +7 -7
- package/src/massParameters.ops.ts +246 -246
- package/src/massParameters.ts +427 -427
- package/src/types.ts +16 -16
- package/test/drawingContract.test.mjs +288 -0
- package/test/errors.test.mjs +185 -184
- package/test/massParameters.test.mjs +952 -952
- package/tsconfig.json +22 -22
- package/tsup.config.ts +12 -12
- package/api-manifest.json +0 -9711
|
@@ -1,319 +1,319 @@
|
|
|
1
|
-
import * as z from "zod"
|
|
2
|
-
import { PluginApiReturn } from "../../../../types"
|
|
3
|
-
import {
|
|
4
|
-
ComponentHandle,
|
|
5
|
-
BrepHandle,
|
|
6
|
-
ContourHandle,
|
|
7
|
-
CurveHandle,
|
|
8
|
-
} from "../../../../handles"
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
* `snaptrude.design.query.geometry` — read the geometry of scene BIM entities.
|
|
12
|
-
*
|
|
13
|
-
* This is the bridge from the BIM/scene layer (`design.*`, keyed by
|
|
14
|
-
* {@linkcode ComponentHandle}) into the geometry kernel (`core.geom.query.*`,
|
|
15
|
-
* keyed by value/topology handles). {@linkcode PluginDesignQueryGeometryApi.getBrep}
|
|
16
|
-
* mints a {@linkcode BrepHandle} for a component's boundary-representation mesh;
|
|
17
|
-
* {@linkcode PluginDesignQueryGeometryApi.getBottomContour} mints a
|
|
18
|
-
* {@linkcode ContourHandle} for its footprint outline;
|
|
19
|
-
* {@linkcode PluginDesignQueryGeometryApi.getCenterline} mints a
|
|
20
|
-
* {@linkcode CurveHandle} for a wall's core curve.
|
|
21
|
-
* {@linkcode PluginDesignQueryGeometryApi.getTriangulatedMeshes} is the
|
|
22
|
-
* handle-free exception: it returns `{ meshes }` — the triangulated render
|
|
23
|
-
* meshes as plain world-space arrays, wrapped in an object, never bare.
|
|
24
|
-
*
|
|
25
|
-
* Returned handles are session-ephemeral and go stale on undo/redo/re-topologize
|
|
26
|
-
* — re-fetch a fresh one after edits.
|
|
27
|
-
*/
|
|
28
|
-
export abstract class PluginDesignQueryGeometryApi {
|
|
29
|
-
constructor() {}
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Get the boundary representation (B-rep) of a scene component — the solid
|
|
33
|
-
* geometry (faces, edges, vertices) behind a wall, slab, room or any other
|
|
34
|
-
* scene entity, as a reusable {@linkcode BrepHandle} for the
|
|
35
|
-
* `core.geom.query.brep.*` reads.
|
|
36
|
-
*
|
|
37
|
-
* **Frame.** By default the brep comes back in the component's own LOCAL frame
|
|
38
|
-
* (its vertices are relative to the mesh origin, exactly as stored). This is
|
|
39
|
-
* the long-standing default, and existing callers rely on it. Pass
|
|
40
|
-
* `{ frame: "world" }` to get the same solid placed where it sits in the
|
|
41
|
-
* scene (world coordinates, like
|
|
42
|
-
* `getBottomContour` / `getTriangulatedMeshes` and every `design.query.measure`
|
|
43
|
-
* read). Use `"world"` whenever the handle will be COMBINED with other scene
|
|
44
|
-
* geometry or committed back beside its source: booleans between two scene
|
|
45
|
-
* masses, `brepFromFillet` / `brepFromShell` / `brepFromOffset` /
|
|
46
|
-
* `brepFromChamfer` on a scene mass followed by `massFromBrep`, or comparing
|
|
47
|
-
* its vertices with a bounding box. A world-frame handle from a parametrically
|
|
48
|
-
* live mass also carries that mass's recipe, so an operation result keeps an
|
|
49
|
-
* editable record.
|
|
50
|
-
*
|
|
51
|
-
* @param component - The scene component to read
|
|
52
|
-
* @param options - `frame`: `"local"` (default, mesh-local coordinates) or `"world"` (scene coordinates)
|
|
53
|
-
* @returns The brep as a {@linkcode BrepHandle}, or `null` if the component has no brep geometry — also `null` for a parametric family: read `design.family.getParameters({ component }).parts[].brep`
|
|
54
|
-
*
|
|
55
|
-
* @examplePrompt Get the 3D solid geometry of the selected wall
|
|
56
|
-
* @examplePrompt Round the top rim of this column and put it back where it is
|
|
57
|
-
* @examplePrompt How many faces does this mass have?
|
|
58
|
-
* @examplePrompt Inspect the mesh of this slab so I can look at its faces and edges
|
|
59
|
-
* @examplePrompt Read the vertices of the selected column's geometry
|
|
60
|
-
*
|
|
61
|
-
* @example
|
|
62
|
-
* ```ts
|
|
63
|
-
* const brep = await snaptrude.design.query.geometry.getBrep(component)
|
|
64
|
-
* if (brep) {
|
|
65
|
-
* const faces = await snaptrude.core.geom.query.brep.listFaces(brep)
|
|
66
|
-
* }
|
|
67
|
-
*
|
|
68
|
-
* // Operate on a scene mass and commit the result where the mass sits:
|
|
69
|
-
* const placed = await snaptrude.design.query.geometry.getBrep(mass, { frame: "world" })
|
|
70
|
-
* const rounded = await snaptrude.core.geom.create.brepFromFillet(placed, edges, 0.2)
|
|
71
|
-
* await snaptrude.design.create.massFromBrep(rounded, "Rounded")
|
|
72
|
-
* ```
|
|
73
|
-
*/
|
|
74
|
-
public abstract getBrep(
|
|
75
|
-
component: ComponentHandle,
|
|
76
|
-
options?: PluginDesignQueryGeometryGetBrepOptions,
|
|
77
|
-
): PluginApiReturn<BrepHandle | null>
|
|
78
|
-
|
|
79
|
-
/**
|
|
80
|
-
* Get the **bottom-face contour** of a component — the footprint outline (outer
|
|
81
|
-
* profile + holes) of its lowest horizontal face, as a reusable
|
|
82
|
-
* {@linkcode ContourHandle}.
|
|
83
|
-
*
|
|
84
|
-
* Extracted from the component's B-rep; robust to inverted face normals. Read
|
|
85
|
-
* its geometry via `snaptrude.core.geom.query.contour.*`, or feed it back into
|
|
86
|
-
* `design.create.*` / `core.geom.*`.
|
|
87
|
-
*
|
|
88
|
-
* @param component - The scene component to read
|
|
89
|
-
* @returns the footprint {@linkcode ContourHandle}, or `null` if the component
|
|
90
|
-
* has no extractable bottom face (e.g. it carries no B-rep)
|
|
91
|
-
*
|
|
92
|
-
* @examplePrompt Get the footprint of the selected mass
|
|
93
|
-
* @examplePrompt What is the plan outline of this building volume?
|
|
94
|
-
* @examplePrompt Trace the base profile of this wall
|
|
95
|
-
* @examplePrompt Find the ground-level outline of the slab, including any openings
|
|
96
|
-
* @examplePrompt Work out the footprint area of the selected component
|
|
97
|
-
*
|
|
98
|
-
* @example
|
|
99
|
-
* ```ts
|
|
100
|
-
* const [wall] = await snaptrude.design.query.listWalls()
|
|
101
|
-
* const contour = await snaptrude.design.query.geometry.getBottomContour(wall)
|
|
102
|
-
* if (contour) {
|
|
103
|
-
* const area = await snaptrude.core.geom.query.contour.getArea(contour)
|
|
104
|
-
* }
|
|
105
|
-
* ```
|
|
106
|
-
*/
|
|
107
|
-
public abstract getBottomContour(
|
|
108
|
-
component: ComponentHandle,
|
|
109
|
-
): PluginApiReturn<ContourHandle | null>
|
|
110
|
-
|
|
111
|
-
/**
|
|
112
|
-
* Get the **centerline** (core curve) of a wall — the single curve running
|
|
113
|
-
* down the middle of the wall, as a reusable {@linkcode CurveHandle}
|
|
114
|
-
* (a `Line` for a straight wall, an `Arc` for a curved wall).
|
|
115
|
-
*
|
|
116
|
-
* For a parametric wall this is its stored core curve; otherwise it is
|
|
117
|
-
* derived from the wall's B-rep bottom face. Read its geometry via
|
|
118
|
-
* `snaptrude.core.geom.query.curve.*`, or feed it into `design.create.*`.
|
|
119
|
-
*
|
|
120
|
-
* Only walls have a centerline. As with all `get*` reads it never throws:
|
|
121
|
-
* a non-wall component, or a wall with no derivable centerline, yields `null`.
|
|
122
|
-
*
|
|
123
|
-
* @param component - The scene component to read (only walls yield a centerline)
|
|
124
|
-
* @returns the centerline {@linkcode CurveHandle}, or `null` if the component
|
|
125
|
-
* is not a wall or the wall has no derivable centerline (e.g. it carries no
|
|
126
|
-
* B-rep or has an unsupported profile)
|
|
127
|
-
*
|
|
128
|
-
* @examplePrompt Get the centerline of the selected wall
|
|
129
|
-
* @examplePrompt How long is this wall along its centre line?
|
|
130
|
-
* @examplePrompt Find the axis running down the middle of this wall
|
|
131
|
-
* @examplePrompt Give me the core curve of that curved wall
|
|
132
|
-
* @examplePrompt Where does the wall's centreline start and end?
|
|
133
|
-
*
|
|
134
|
-
* @example
|
|
135
|
-
* ```ts
|
|
136
|
-
* const [wall] = await snaptrude.design.query.listWalls()
|
|
137
|
-
* const centerline = await snaptrude.design.query.geometry.getCenterline(wall)
|
|
138
|
-
* if (centerline) {
|
|
139
|
-
* const length = await snaptrude.core.geom.query.curve.getLength(centerline)
|
|
140
|
-
* }
|
|
141
|
-
* ```
|
|
142
|
-
*/
|
|
143
|
-
public abstract getCenterline(
|
|
144
|
-
component: ComponentHandle,
|
|
145
|
-
): PluginApiReturn<CurveHandle | null>
|
|
146
|
-
|
|
147
|
-
/**
|
|
148
|
-
* Get the **triangulated render meshes** of scene components as plain,
|
|
149
|
-
* serializable arrays — flat world-space vertex `positions` (`[x0, y0, z0,
|
|
150
|
-
* x1, …]`) and triangle `indices` (three per triangle), one record per
|
|
151
|
-
* requested component. The result is `{ meshes }`, not a bare array —
|
|
152
|
-
* destructure it before iterating.
|
|
153
|
-
*
|
|
154
|
-
* Unlike the other `geometry.*` reads this does NOT mint kernel handles — the
|
|
155
|
-
* raw arrays cross the boundary directly, ready for export, custom analysis,
|
|
156
|
-
* or feeding an external renderer. Positions are **always world-space**
|
|
157
|
-
* (instance/transform baked in; there is no local-coordinates mode) in plan
|
|
158
|
-
* units — no conversion needed. Raw doubles, unrounded.
|
|
159
|
-
*
|
|
160
|
-
* With `includeMaterialIds: true` each record also carries `materialIds`: one
|
|
161
|
-
* entry **per triangle** (`indices.length / 3` entries), the material *name*
|
|
162
|
-
* painted on that triangle, or `null` for unpainted/default faces.
|
|
163
|
-
*
|
|
164
|
-
* With `includeFaceIndices: true` each record also carries `faceIds`: one
|
|
165
|
-
* entry **per triangle** (input order), the B-rep face index owning that
|
|
166
|
-
* triangle (same ids as {@linkcode getBrep} faces), or `null` where there is
|
|
167
|
-
* no provenance. Non-B-rep meshes (Revit imports, generic models, furniture)
|
|
168
|
-
* yield all-`null` rather than an error.
|
|
169
|
-
*
|
|
170
|
-
* A resolvable component with no readable mesh geometry yields
|
|
171
|
-
* `{ id, positions: [], indices: [] }` — nothing is silently omitted.
|
|
172
|
-
*
|
|
173
|
-
* The call is capped at **500 000 triangles total**; over the cap it throws a
|
|
174
|
-
* `VALIDATION` error whose message includes the actual total — split the
|
|
175
|
-
* component list into smaller batches and call again.
|
|
176
|
-
*
|
|
177
|
-
* @param components - The scene components to triangulate
|
|
178
|
-
* @param options - `includeMaterialIds` adds the per-triangle material names;
|
|
179
|
-
* `includeFaceIndices` adds the per-triangle B-rep face indices
|
|
180
|
-
* @returns `{ meshes }` — one {@linkcode PluginTriangulatedMesh} per requested
|
|
181
|
-
* component, in input order
|
|
182
|
-
* @throws `HANDLE_INVALID` if any component handle is gone/forged;
|
|
183
|
-
* `VALIDATION` if the combined mesh exceeds 500 000 triangles
|
|
184
|
-
*
|
|
185
|
-
* @examplePrompt Export the selected masses as a triangle mesh
|
|
186
|
-
* @examplePrompt Get the raw vertices and triangles of this wall in world coordinates
|
|
187
|
-
* @examplePrompt Give me the triangulated geometry of every space with its materials
|
|
188
|
-
* @examplePrompt Compute the surface area of this roof from its triangles
|
|
189
|
-
*
|
|
190
|
-
* @example
|
|
191
|
-
* ```ts
|
|
192
|
-
* const spaces = await snaptrude.design.query.listSpaces()
|
|
193
|
-
* const { meshes } = await snaptrude.design.query.geometry.getTriangulatedMeshes(spaces, {
|
|
194
|
-
* includeMaterialIds: true,
|
|
195
|
-
* })
|
|
196
|
-
* for (const mesh of meshes) {
|
|
197
|
-
* const triangleCount = mesh.indices.length / 3
|
|
198
|
-
* console.log(mesh.id, triangleCount, mesh.materialIds?.[0])
|
|
199
|
-
* }
|
|
200
|
-
* ```
|
|
201
|
-
*/
|
|
202
|
-
public abstract getTriangulatedMeshes(
|
|
203
|
-
components: ComponentHandle[],
|
|
204
|
-
options?: PluginDesignQueryGeometryGetTriangulatedMeshesArgs["options"],
|
|
205
|
-
): PluginApiReturn<PluginDesignQueryGeometryGetTriangulatedMeshesResult>
|
|
206
|
-
}
|
|
207
|
-
|
|
208
|
-
/**
|
|
209
|
-
* Arguments for {@linkcode PluginDesignQueryGeometryApi.getBrep}.
|
|
210
|
-
*
|
|
211
|
-
* | Property | Type | Description |
|
|
212
|
-
* |---|---|---|
|
|
213
|
-
* | `component` | {@linkcode ComponentHandle} | The scene component to read |
|
|
214
|
-
*/
|
|
215
|
-
/** Options for {@linkcode PluginDesignQueryGeometryApi.getBrep}: `frame` defaults to `"local"`. */
|
|
216
|
-
export type PluginDesignQueryGeometryGetBrepOptions = { frame?: "local" | "world" }
|
|
217
|
-
export const PluginDesignQueryGeometryGetBrepOptions: z.ZodType<
|
|
218
|
-
PluginDesignQueryGeometryGetBrepOptions,
|
|
219
|
-
PluginDesignQueryGeometryGetBrepOptions
|
|
220
|
-
> = z.object({ frame: z.enum(["local", "world"]).optional() })
|
|
221
|
-
|
|
222
|
-
export const PluginDesignQueryGeometryGetBrepArgs = z.object({
|
|
223
|
-
component: ComponentHandle,
|
|
224
|
-
options: PluginDesignQueryGeometryGetBrepOptions.optional(),
|
|
225
|
-
})
|
|
226
|
-
|
|
227
|
-
export type PluginDesignQueryGeometryGetBrepArgs = z.infer<
|
|
228
|
-
typeof PluginDesignQueryGeometryGetBrepArgs
|
|
229
|
-
>
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* Arguments for {@linkcode PluginDesignQueryGeometryApi.getBottomContour}.
|
|
233
|
-
*
|
|
234
|
-
* | Property | Type | Description |
|
|
235
|
-
* |---|---|---|
|
|
236
|
-
* | `component` | {@linkcode ComponentHandle} | The scene component to read |
|
|
237
|
-
*/
|
|
238
|
-
export const PluginDesignQueryGeometryGetBottomContourArgs = z.object({
|
|
239
|
-
component: ComponentHandle,
|
|
240
|
-
})
|
|
241
|
-
|
|
242
|
-
export type PluginDesignQueryGeometryGetBottomContourArgs = z.infer<
|
|
243
|
-
typeof PluginDesignQueryGeometryGetBottomContourArgs
|
|
244
|
-
>
|
|
245
|
-
|
|
246
|
-
/**
|
|
247
|
-
* Arguments for {@linkcode PluginDesignQueryGeometryApi.getCenterline}.
|
|
248
|
-
*
|
|
249
|
-
* | Property | Type | Description |
|
|
250
|
-
* |---|---|---|
|
|
251
|
-
* | `component` | {@linkcode ComponentHandle} | The scene component to read |
|
|
252
|
-
*/
|
|
253
|
-
export const PluginDesignQueryGeometryGetCenterlineArgs = z.object({
|
|
254
|
-
component: ComponentHandle,
|
|
255
|
-
})
|
|
256
|
-
|
|
257
|
-
export type PluginDesignQueryGeometryGetCenterlineArgs = z.infer<
|
|
258
|
-
typeof PluginDesignQueryGeometryGetCenterlineArgs
|
|
259
|
-
>
|
|
260
|
-
|
|
261
|
-
/**
|
|
262
|
-
* One component's triangulated world-space mesh, as plain serializable arrays
|
|
263
|
-
* (no handles).
|
|
264
|
-
*
|
|
265
|
-
* | Property | Type | Description |
|
|
266
|
-
* |---|---|---|
|
|
267
|
-
* | `id` | `string` | The component's id (its {@linkcode ComponentHandle} token) |
|
|
268
|
-
* | `positions` | `number[]` | Flat world-space vertex coordinates `[x0, y0, z0, x1, …]`, plan units, raw doubles |
|
|
269
|
-
* | `indices` | `number[]` | Triangle vertex indices, three per triangle, into `positions / 3` |
|
|
270
|
-
* | `materialIds` | `(string \| null)[]` _(optional)_ | One entry per triangle: the painted material's name, `null` for unpainted/default faces. Present only when requested via `includeMaterialIds` |
|
|
271
|
-
* | `faceIds` | `(number \| null)[]` _(optional)_ | One entry per triangle: the B-rep face index owning it (same ids as {@linkcode PluginDesignQueryGeometryApi.getBrep} faces), `null` where there is no provenance (non-B-rep mesh). Present only when requested via `includeFaceIndices` |
|
|
272
|
-
*/
|
|
273
|
-
export const PluginTriangulatedMesh = z.object({
|
|
274
|
-
id: z.string(),
|
|
275
|
-
positions: z.array(z.number()),
|
|
276
|
-
indices: z.array(z.number()),
|
|
277
|
-
materialIds: z.array(z.string().nullable()).optional(),
|
|
278
|
-
faceIds: z.array(z.number().nullable()).optional(),
|
|
279
|
-
})
|
|
280
|
-
|
|
281
|
-
export type PluginTriangulatedMesh = z.infer<typeof PluginTriangulatedMesh>
|
|
282
|
-
|
|
283
|
-
/**
|
|
284
|
-
* Arguments for {@linkcode PluginDesignQueryGeometryApi.getTriangulatedMeshes}.
|
|
285
|
-
*
|
|
286
|
-
* | Property | Type | Description |
|
|
287
|
-
* |---|---|---|
|
|
288
|
-
* | `components` | {@linkcode ComponentHandle}`[]` | The scene components to triangulate |
|
|
289
|
-
* | `options.includeMaterialIds` | `boolean` _(optional)_ | Also return the per-triangle material names |
|
|
290
|
-
* | `options.includeFaceIndices` | `boolean` _(optional)_ | Also return the per-triangle B-rep face indices |
|
|
291
|
-
*/
|
|
292
|
-
export const PluginDesignQueryGeometryGetTriangulatedMeshesArgs = z.object({
|
|
293
|
-
components: z.array(ComponentHandle),
|
|
294
|
-
options: z
|
|
295
|
-
.object({
|
|
296
|
-
includeMaterialIds: z.boolean().optional(),
|
|
297
|
-
includeFaceIndices: z.boolean().optional(),
|
|
298
|
-
})
|
|
299
|
-
.optional(),
|
|
300
|
-
})
|
|
301
|
-
|
|
302
|
-
export type PluginDesignQueryGeometryGetTriangulatedMeshesArgs = z.infer<
|
|
303
|
-
typeof PluginDesignQueryGeometryGetTriangulatedMeshesArgs
|
|
304
|
-
>
|
|
305
|
-
|
|
306
|
-
/**
|
|
307
|
-
* Result of {@linkcode PluginDesignQueryGeometryApi.getTriangulatedMeshes}.
|
|
308
|
-
*
|
|
309
|
-
* | Property | Type | Description |
|
|
310
|
-
* |---|---|---|
|
|
311
|
-
* | `meshes` | {@linkcode PluginTriangulatedMesh}`[]` | One record per requested component, in input order |
|
|
312
|
-
*/
|
|
313
|
-
export const PluginDesignQueryGeometryGetTriangulatedMeshesResult = z.object({
|
|
314
|
-
meshes: z.array(PluginTriangulatedMesh),
|
|
315
|
-
})
|
|
316
|
-
|
|
317
|
-
export type PluginDesignQueryGeometryGetTriangulatedMeshesResult = z.infer<
|
|
318
|
-
typeof PluginDesignQueryGeometryGetTriangulatedMeshesResult
|
|
319
|
-
>
|
|
1
|
+
import * as z from "zod"
|
|
2
|
+
import { PluginApiReturn } from "../../../../types"
|
|
3
|
+
import {
|
|
4
|
+
ComponentHandle,
|
|
5
|
+
BrepHandle,
|
|
6
|
+
ContourHandle,
|
|
7
|
+
CurveHandle,
|
|
8
|
+
} from "../../../../handles"
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* `snaptrude.design.query.geometry` — read the geometry of scene BIM entities.
|
|
12
|
+
*
|
|
13
|
+
* This is the bridge from the BIM/scene layer (`design.*`, keyed by
|
|
14
|
+
* {@linkcode ComponentHandle}) into the geometry kernel (`core.geom.query.*`,
|
|
15
|
+
* keyed by value/topology handles). {@linkcode PluginDesignQueryGeometryApi.getBrep}
|
|
16
|
+
* mints a {@linkcode BrepHandle} for a component's boundary-representation mesh;
|
|
17
|
+
* {@linkcode PluginDesignQueryGeometryApi.getBottomContour} mints a
|
|
18
|
+
* {@linkcode ContourHandle} for its footprint outline;
|
|
19
|
+
* {@linkcode PluginDesignQueryGeometryApi.getCenterline} mints a
|
|
20
|
+
* {@linkcode CurveHandle} for a wall's core curve.
|
|
21
|
+
* {@linkcode PluginDesignQueryGeometryApi.getTriangulatedMeshes} is the
|
|
22
|
+
* handle-free exception: it returns `{ meshes }` — the triangulated render
|
|
23
|
+
* meshes as plain world-space arrays, wrapped in an object, never bare.
|
|
24
|
+
*
|
|
25
|
+
* Returned handles are session-ephemeral and go stale on undo/redo/re-topologize
|
|
26
|
+
* — re-fetch a fresh one after edits.
|
|
27
|
+
*/
|
|
28
|
+
export abstract class PluginDesignQueryGeometryApi {
|
|
29
|
+
constructor() {}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Get the boundary representation (B-rep) of a scene component — the solid
|
|
33
|
+
* geometry (faces, edges, vertices) behind a wall, slab, room or any other
|
|
34
|
+
* scene entity, as a reusable {@linkcode BrepHandle} for the
|
|
35
|
+
* `core.geom.query.brep.*` reads.
|
|
36
|
+
*
|
|
37
|
+
* **Frame.** By default the brep comes back in the component's own LOCAL frame
|
|
38
|
+
* (its vertices are relative to the mesh origin, exactly as stored). This is
|
|
39
|
+
* the long-standing default, and existing callers rely on it. Pass
|
|
40
|
+
* `{ frame: "world" }` to get the same solid placed where it sits in the
|
|
41
|
+
* scene (world coordinates, like
|
|
42
|
+
* `getBottomContour` / `getTriangulatedMeshes` and every `design.query.measure`
|
|
43
|
+
* read). Use `"world"` whenever the handle will be COMBINED with other scene
|
|
44
|
+
* geometry or committed back beside its source: booleans between two scene
|
|
45
|
+
* masses, `brepFromFillet` / `brepFromShell` / `brepFromOffset` /
|
|
46
|
+
* `brepFromChamfer` on a scene mass followed by `massFromBrep`, or comparing
|
|
47
|
+
* its vertices with a bounding box. A world-frame handle from a parametrically
|
|
48
|
+
* live mass also carries that mass's recipe, so an operation result keeps an
|
|
49
|
+
* editable record.
|
|
50
|
+
*
|
|
51
|
+
* @param component - The scene component to read
|
|
52
|
+
* @param options - `frame`: `"local"` (default, mesh-local coordinates) or `"world"` (scene coordinates)
|
|
53
|
+
* @returns The brep as a {@linkcode BrepHandle}, or `null` if the component has no brep geometry — also `null` for a parametric family: read `design.family.getParameters({ component }).parts[].brep`
|
|
54
|
+
*
|
|
55
|
+
* @examplePrompt Get the 3D solid geometry of the selected wall
|
|
56
|
+
* @examplePrompt Round the top rim of this column and put it back where it is
|
|
57
|
+
* @examplePrompt How many faces does this mass have?
|
|
58
|
+
* @examplePrompt Inspect the mesh of this slab so I can look at its faces and edges
|
|
59
|
+
* @examplePrompt Read the vertices of the selected column's geometry
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const brep = await snaptrude.design.query.geometry.getBrep(component)
|
|
64
|
+
* if (brep) {
|
|
65
|
+
* const faces = await snaptrude.core.geom.query.brep.listFaces(brep)
|
|
66
|
+
* }
|
|
67
|
+
*
|
|
68
|
+
* // Operate on a scene mass and commit the result where the mass sits:
|
|
69
|
+
* const placed = await snaptrude.design.query.geometry.getBrep(mass, { frame: "world" })
|
|
70
|
+
* const rounded = await snaptrude.core.geom.create.brepFromFillet(placed, edges, 0.2)
|
|
71
|
+
* await snaptrude.design.create.massFromBrep(rounded, "Rounded")
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
public abstract getBrep(
|
|
75
|
+
component: ComponentHandle,
|
|
76
|
+
options?: PluginDesignQueryGeometryGetBrepOptions,
|
|
77
|
+
): PluginApiReturn<BrepHandle | null>
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* Get the **bottom-face contour** of a component — the footprint outline (outer
|
|
81
|
+
* profile + holes) of its lowest horizontal face, as a reusable
|
|
82
|
+
* {@linkcode ContourHandle}.
|
|
83
|
+
*
|
|
84
|
+
* Extracted from the component's B-rep; robust to inverted face normals. Read
|
|
85
|
+
* its geometry via `snaptrude.core.geom.query.contour.*`, or feed it back into
|
|
86
|
+
* `design.create.*` / `core.geom.*`.
|
|
87
|
+
*
|
|
88
|
+
* @param component - The scene component to read
|
|
89
|
+
* @returns the footprint {@linkcode ContourHandle}, or `null` if the component
|
|
90
|
+
* has no extractable bottom face (e.g. it carries no B-rep)
|
|
91
|
+
*
|
|
92
|
+
* @examplePrompt Get the footprint of the selected mass
|
|
93
|
+
* @examplePrompt What is the plan outline of this building volume?
|
|
94
|
+
* @examplePrompt Trace the base profile of this wall
|
|
95
|
+
* @examplePrompt Find the ground-level outline of the slab, including any openings
|
|
96
|
+
* @examplePrompt Work out the footprint area of the selected component
|
|
97
|
+
*
|
|
98
|
+
* @example
|
|
99
|
+
* ```ts
|
|
100
|
+
* const [wall] = await snaptrude.design.query.listWalls()
|
|
101
|
+
* const contour = await snaptrude.design.query.geometry.getBottomContour(wall)
|
|
102
|
+
* if (contour) {
|
|
103
|
+
* const area = await snaptrude.core.geom.query.contour.getArea(contour)
|
|
104
|
+
* }
|
|
105
|
+
* ```
|
|
106
|
+
*/
|
|
107
|
+
public abstract getBottomContour(
|
|
108
|
+
component: ComponentHandle,
|
|
109
|
+
): PluginApiReturn<ContourHandle | null>
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Get the **centerline** (core curve) of a wall — the single curve running
|
|
113
|
+
* down the middle of the wall, as a reusable {@linkcode CurveHandle}
|
|
114
|
+
* (a `Line` for a straight wall, an `Arc` for a curved wall).
|
|
115
|
+
*
|
|
116
|
+
* For a parametric wall this is its stored core curve; otherwise it is
|
|
117
|
+
* derived from the wall's B-rep bottom face. Read its geometry via
|
|
118
|
+
* `snaptrude.core.geom.query.curve.*`, or feed it into `design.create.*`.
|
|
119
|
+
*
|
|
120
|
+
* Only walls have a centerline. As with all `get*` reads it never throws:
|
|
121
|
+
* a non-wall component, or a wall with no derivable centerline, yields `null`.
|
|
122
|
+
*
|
|
123
|
+
* @param component - The scene component to read (only walls yield a centerline)
|
|
124
|
+
* @returns the centerline {@linkcode CurveHandle}, or `null` if the component
|
|
125
|
+
* is not a wall or the wall has no derivable centerline (e.g. it carries no
|
|
126
|
+
* B-rep or has an unsupported profile)
|
|
127
|
+
*
|
|
128
|
+
* @examplePrompt Get the centerline of the selected wall
|
|
129
|
+
* @examplePrompt How long is this wall along its centre line?
|
|
130
|
+
* @examplePrompt Find the axis running down the middle of this wall
|
|
131
|
+
* @examplePrompt Give me the core curve of that curved wall
|
|
132
|
+
* @examplePrompt Where does the wall's centreline start and end?
|
|
133
|
+
*
|
|
134
|
+
* @example
|
|
135
|
+
* ```ts
|
|
136
|
+
* const [wall] = await snaptrude.design.query.listWalls()
|
|
137
|
+
* const centerline = await snaptrude.design.query.geometry.getCenterline(wall)
|
|
138
|
+
* if (centerline) {
|
|
139
|
+
* const length = await snaptrude.core.geom.query.curve.getLength(centerline)
|
|
140
|
+
* }
|
|
141
|
+
* ```
|
|
142
|
+
*/
|
|
143
|
+
public abstract getCenterline(
|
|
144
|
+
component: ComponentHandle,
|
|
145
|
+
): PluginApiReturn<CurveHandle | null>
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Get the **triangulated render meshes** of scene components as plain,
|
|
149
|
+
* serializable arrays — flat world-space vertex `positions` (`[x0, y0, z0,
|
|
150
|
+
* x1, …]`) and triangle `indices` (three per triangle), one record per
|
|
151
|
+
* requested component. The result is `{ meshes }`, not a bare array —
|
|
152
|
+
* destructure it before iterating.
|
|
153
|
+
*
|
|
154
|
+
* Unlike the other `geometry.*` reads this does NOT mint kernel handles — the
|
|
155
|
+
* raw arrays cross the boundary directly, ready for export, custom analysis,
|
|
156
|
+
* or feeding an external renderer. Positions are **always world-space**
|
|
157
|
+
* (instance/transform baked in; there is no local-coordinates mode) in plan
|
|
158
|
+
* units — no conversion needed. Raw doubles, unrounded.
|
|
159
|
+
*
|
|
160
|
+
* With `includeMaterialIds: true` each record also carries `materialIds`: one
|
|
161
|
+
* entry **per triangle** (`indices.length / 3` entries), the material *name*
|
|
162
|
+
* painted on that triangle, or `null` for unpainted/default faces.
|
|
163
|
+
*
|
|
164
|
+
* With `includeFaceIndices: true` each record also carries `faceIds`: one
|
|
165
|
+
* entry **per triangle** (input order), the B-rep face index owning that
|
|
166
|
+
* triangle (same ids as {@linkcode getBrep} faces), or `null` where there is
|
|
167
|
+
* no provenance. Non-B-rep meshes (Revit imports, generic models, furniture)
|
|
168
|
+
* yield all-`null` rather than an error.
|
|
169
|
+
*
|
|
170
|
+
* A resolvable component with no readable mesh geometry yields
|
|
171
|
+
* `{ id, positions: [], indices: [] }` — nothing is silently omitted.
|
|
172
|
+
*
|
|
173
|
+
* The call is capped at **500 000 triangles total**; over the cap it throws a
|
|
174
|
+
* `VALIDATION` error whose message includes the actual total — split the
|
|
175
|
+
* component list into smaller batches and call again.
|
|
176
|
+
*
|
|
177
|
+
* @param components - The scene components to triangulate
|
|
178
|
+
* @param options - `includeMaterialIds` adds the per-triangle material names;
|
|
179
|
+
* `includeFaceIndices` adds the per-triangle B-rep face indices
|
|
180
|
+
* @returns `{ meshes }` — one {@linkcode PluginTriangulatedMesh} per requested
|
|
181
|
+
* component, in input order
|
|
182
|
+
* @throws `HANDLE_INVALID` if any component handle is gone/forged;
|
|
183
|
+
* `VALIDATION` if the combined mesh exceeds 500 000 triangles
|
|
184
|
+
*
|
|
185
|
+
* @examplePrompt Export the selected masses as a triangle mesh
|
|
186
|
+
* @examplePrompt Get the raw vertices and triangles of this wall in world coordinates
|
|
187
|
+
* @examplePrompt Give me the triangulated geometry of every space with its materials
|
|
188
|
+
* @examplePrompt Compute the surface area of this roof from its triangles
|
|
189
|
+
*
|
|
190
|
+
* @example
|
|
191
|
+
* ```ts
|
|
192
|
+
* const spaces = await snaptrude.design.query.listSpaces()
|
|
193
|
+
* const { meshes } = await snaptrude.design.query.geometry.getTriangulatedMeshes(spaces, {
|
|
194
|
+
* includeMaterialIds: true,
|
|
195
|
+
* })
|
|
196
|
+
* for (const mesh of meshes) {
|
|
197
|
+
* const triangleCount = mesh.indices.length / 3
|
|
198
|
+
* console.log(mesh.id, triangleCount, mesh.materialIds?.[0])
|
|
199
|
+
* }
|
|
200
|
+
* ```
|
|
201
|
+
*/
|
|
202
|
+
public abstract getTriangulatedMeshes(
|
|
203
|
+
components: ComponentHandle[],
|
|
204
|
+
options?: PluginDesignQueryGeometryGetTriangulatedMeshesArgs["options"],
|
|
205
|
+
): PluginApiReturn<PluginDesignQueryGeometryGetTriangulatedMeshesResult>
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Arguments for {@linkcode PluginDesignQueryGeometryApi.getBrep}.
|
|
210
|
+
*
|
|
211
|
+
* | Property | Type | Description |
|
|
212
|
+
* |---|---|---|
|
|
213
|
+
* | `component` | {@linkcode ComponentHandle} | The scene component to read |
|
|
214
|
+
*/
|
|
215
|
+
/** Options for {@linkcode PluginDesignQueryGeometryApi.getBrep}: `frame` defaults to `"local"`. */
|
|
216
|
+
export type PluginDesignQueryGeometryGetBrepOptions = { frame?: "local" | "world" }
|
|
217
|
+
export const PluginDesignQueryGeometryGetBrepOptions: z.ZodType<
|
|
218
|
+
PluginDesignQueryGeometryGetBrepOptions,
|
|
219
|
+
PluginDesignQueryGeometryGetBrepOptions
|
|
220
|
+
> = z.object({ frame: z.enum(["local", "world"]).optional() })
|
|
221
|
+
|
|
222
|
+
export const PluginDesignQueryGeometryGetBrepArgs = z.object({
|
|
223
|
+
component: ComponentHandle,
|
|
224
|
+
options: PluginDesignQueryGeometryGetBrepOptions.optional(),
|
|
225
|
+
})
|
|
226
|
+
|
|
227
|
+
export type PluginDesignQueryGeometryGetBrepArgs = z.infer<
|
|
228
|
+
typeof PluginDesignQueryGeometryGetBrepArgs
|
|
229
|
+
>
|
|
230
|
+
|
|
231
|
+
/**
|
|
232
|
+
* Arguments for {@linkcode PluginDesignQueryGeometryApi.getBottomContour}.
|
|
233
|
+
*
|
|
234
|
+
* | Property | Type | Description |
|
|
235
|
+
* |---|---|---|
|
|
236
|
+
* | `component` | {@linkcode ComponentHandle} | The scene component to read |
|
|
237
|
+
*/
|
|
238
|
+
export const PluginDesignQueryGeometryGetBottomContourArgs = z.object({
|
|
239
|
+
component: ComponentHandle,
|
|
240
|
+
})
|
|
241
|
+
|
|
242
|
+
export type PluginDesignQueryGeometryGetBottomContourArgs = z.infer<
|
|
243
|
+
typeof PluginDesignQueryGeometryGetBottomContourArgs
|
|
244
|
+
>
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Arguments for {@linkcode PluginDesignQueryGeometryApi.getCenterline}.
|
|
248
|
+
*
|
|
249
|
+
* | Property | Type | Description |
|
|
250
|
+
* |---|---|---|
|
|
251
|
+
* | `component` | {@linkcode ComponentHandle} | The scene component to read |
|
|
252
|
+
*/
|
|
253
|
+
export const PluginDesignQueryGeometryGetCenterlineArgs = z.object({
|
|
254
|
+
component: ComponentHandle,
|
|
255
|
+
})
|
|
256
|
+
|
|
257
|
+
export type PluginDesignQueryGeometryGetCenterlineArgs = z.infer<
|
|
258
|
+
typeof PluginDesignQueryGeometryGetCenterlineArgs
|
|
259
|
+
>
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* One component's triangulated world-space mesh, as plain serializable arrays
|
|
263
|
+
* (no handles).
|
|
264
|
+
*
|
|
265
|
+
* | Property | Type | Description |
|
|
266
|
+
* |---|---|---|
|
|
267
|
+
* | `id` | `string` | The component's id (its {@linkcode ComponentHandle} token) |
|
|
268
|
+
* | `positions` | `number[]` | Flat world-space vertex coordinates `[x0, y0, z0, x1, …]`, plan units, raw doubles |
|
|
269
|
+
* | `indices` | `number[]` | Triangle vertex indices, three per triangle, into `positions / 3` |
|
|
270
|
+
* | `materialIds` | `(string \| null)[]` _(optional)_ | One entry per triangle: the painted material's name, `null` for unpainted/default faces. Present only when requested via `includeMaterialIds` |
|
|
271
|
+
* | `faceIds` | `(number \| null)[]` _(optional)_ | One entry per triangle: the B-rep face index owning it (same ids as {@linkcode PluginDesignQueryGeometryApi.getBrep} faces), `null` where there is no provenance (non-B-rep mesh). Present only when requested via `includeFaceIndices` |
|
|
272
|
+
*/
|
|
273
|
+
export const PluginTriangulatedMesh = z.object({
|
|
274
|
+
id: z.string(),
|
|
275
|
+
positions: z.array(z.number()),
|
|
276
|
+
indices: z.array(z.number()),
|
|
277
|
+
materialIds: z.array(z.string().nullable()).optional(),
|
|
278
|
+
faceIds: z.array(z.number().nullable()).optional(),
|
|
279
|
+
})
|
|
280
|
+
|
|
281
|
+
export type PluginTriangulatedMesh = z.infer<typeof PluginTriangulatedMesh>
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Arguments for {@linkcode PluginDesignQueryGeometryApi.getTriangulatedMeshes}.
|
|
285
|
+
*
|
|
286
|
+
* | Property | Type | Description |
|
|
287
|
+
* |---|---|---|
|
|
288
|
+
* | `components` | {@linkcode ComponentHandle}`[]` | The scene components to triangulate |
|
|
289
|
+
* | `options.includeMaterialIds` | `boolean` _(optional)_ | Also return the per-triangle material names |
|
|
290
|
+
* | `options.includeFaceIndices` | `boolean` _(optional)_ | Also return the per-triangle B-rep face indices |
|
|
291
|
+
*/
|
|
292
|
+
export const PluginDesignQueryGeometryGetTriangulatedMeshesArgs = z.object({
|
|
293
|
+
components: z.array(ComponentHandle),
|
|
294
|
+
options: z
|
|
295
|
+
.object({
|
|
296
|
+
includeMaterialIds: z.boolean().optional(),
|
|
297
|
+
includeFaceIndices: z.boolean().optional(),
|
|
298
|
+
})
|
|
299
|
+
.optional(),
|
|
300
|
+
})
|
|
301
|
+
|
|
302
|
+
export type PluginDesignQueryGeometryGetTriangulatedMeshesArgs = z.infer<
|
|
303
|
+
typeof PluginDesignQueryGeometryGetTriangulatedMeshesArgs
|
|
304
|
+
>
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
* Result of {@linkcode PluginDesignQueryGeometryApi.getTriangulatedMeshes}.
|
|
308
|
+
*
|
|
309
|
+
* | Property | Type | Description |
|
|
310
|
+
* |---|---|---|
|
|
311
|
+
* | `meshes` | {@linkcode PluginTriangulatedMesh}`[]` | One record per requested component, in input order |
|
|
312
|
+
*/
|
|
313
|
+
export const PluginDesignQueryGeometryGetTriangulatedMeshesResult = z.object({
|
|
314
|
+
meshes: z.array(PluginTriangulatedMesh),
|
|
315
|
+
})
|
|
316
|
+
|
|
317
|
+
export type PluginDesignQueryGeometryGetTriangulatedMeshesResult = z.infer<
|
|
318
|
+
typeof PluginDesignQueryGeometryGetTriangulatedMeshesResult
|
|
319
|
+
>
|