@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.
- package/AGENTS.md +231 -231
- package/CHANGELOG.md +408 -402
- package/CLAUDE.md +11 -11
- package/api-manifest.json +1510 -701
- 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/storeys/index.d.ts +5 -2
- package/dist/api/core/storeys/index.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 +299 -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 +299 -100
- 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 +813 -35
- 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 +1703 -0
- package/dist/api/design/networks.d.ts.map +1 -0
- package/dist/api/design/query/grids.d.ts +2 -2
- 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 +111 -6
- 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/entity/buildableEnvelope.d.ts +84 -2
- package/dist/api/entity/buildableEnvelope.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 +41 -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/sections.d.ts +461 -0
- package/dist/api/presentation/sections.d.ts.map +1 -0
- 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 +141 -8
- 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 +3883 -2385
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +3744 -2385
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- 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 +311 -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 +210 -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 +2178 -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 +1342 -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 +607 -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 +1096 -983
- package/src/api/design/visibility.ts +143 -143
- package/src/api/design/windows/index.ts +351 -333
- package/src/api/entity/buildableEnvelope.ts +397 -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 -126
- package/src/api/presentation/placedViews.ts +1211 -1120
- package/src/api/presentation/sections.ts +420 -0
- 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 +742 -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/test/presentationViewSettings.test.mjs +85 -0
- package/tsconfig.json +22 -22
- package/tsup.config.ts +12 -12
|
@@ -1,317 +1,323 @@
|
|
|
1
|
-
import * as z from "zod"
|
|
2
|
-
import { PluginApiReturn } from "../../../../types"
|
|
3
|
-
import {
|
|
4
|
-
ContourHandle,
|
|
5
|
-
ProfileHandle,
|
|
6
|
-
Vec3Handle,
|
|
7
|
-
Vec3Components,
|
|
8
|
-
} from "../../../../handles"
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
* Contour editing — produce NEW contours from an existing one (all-handle model, §11).
|
|
12
|
-
*
|
|
13
|
-
* A contour is an outer {@linkcode ProfileHandle} plus zero or more inner profiles
|
|
14
|
-
* that punch holes in it. Every method here is an immutable derive-new operation:
|
|
15
|
-
* it takes an opaque {@linkcode ContourHandle} (plus any extra inputs) and returns a
|
|
16
|
-
* fresh {@linkcode ContourHandle} for the resulting contour. The input contour is
|
|
17
|
-
* never mutated — the original handle keeps referring to the unchanged contour. Read
|
|
18
|
-
* the resulting geometry back as plain values with the query namespace.
|
|
19
|
-
*
|
|
20
|
-
* Accessed via `snaptrude.core.geom.update.contour`.
|
|
21
|
-
*/
|
|
22
|
-
export abstract class PluginGeomUpdateContourApi {
|
|
23
|
-
constructor() {}
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* Offset a contour inward/outward by a signed distance. Immutable — returns a NEW
|
|
27
|
-
* contour and leaves the input unchanged.
|
|
28
|
-
*
|
|
29
|
-
* @param contour The contour to offset
|
|
30
|
-
* @param distance Signed offset distance (outward when positive, inward when negative)
|
|
31
|
-
* @returns The offset contour as a NEW {@linkcode ContourHandle}
|
|
32
|
-
* @throws PRECONDITION_FAILED if the outline or a hole has a spline run
|
|
33
|
-
* (splines cannot be offset yet)
|
|
34
|
-
*
|
|
35
|
-
* @examplePrompt Offset this boundary 500mm inward
|
|
36
|
-
* @examplePrompt Shrink this floor outline by half a metre all around
|
|
37
|
-
*
|
|
38
|
-
* # Example
|
|
39
|
-
* ```ts
|
|
40
|
-
* const rect = await snaptrude.core.geom.create.profileRect(10, 8)
|
|
41
|
-
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
42
|
-
* const inset = await snaptrude.core.geom.update.contour.offset(contour, -0.5)
|
|
43
|
-
* const area = await snaptrude.core.geom.query.contour.getArea(inset)
|
|
44
|
-
* ```
|
|
45
|
-
*/
|
|
46
|
-
public abstract offset(
|
|
47
|
-
contour: ContourHandle,
|
|
48
|
-
distance: number,
|
|
49
|
-
): PluginApiReturn<ContourHandle>
|
|
50
|
-
|
|
51
|
-
/**
|
|
52
|
-
* Translate a contour by a vector. Immutable — returns a NEW contour and leaves
|
|
53
|
-
* the input unchanged.
|
|
54
|
-
*
|
|
55
|
-
* @param contour The contour to move
|
|
56
|
-
* @param translation Translation vector to move the contour by
|
|
57
|
-
* @returns The moved contour as a NEW {@linkcode ContourHandle}
|
|
58
|
-
*
|
|
59
|
-
* @examplePrompt Move this shape 2 metres to the right
|
|
60
|
-
* @examplePrompt Shift this outline over by 5 feet
|
|
61
|
-
*
|
|
62
|
-
* # Example
|
|
63
|
-
* ```ts
|
|
64
|
-
* const rect = await snaptrude.core.geom.create.profileRect(6, 4)
|
|
65
|
-
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
66
|
-
* const shift = await snaptrude.core.math.vec3.new(2, 0, 0)
|
|
67
|
-
* const moved = await snaptrude.core.geom.update.contour.move(contour, shift)
|
|
68
|
-
* ```
|
|
69
|
-
*/
|
|
70
|
-
public abstract move(
|
|
71
|
-
contour: ContourHandle,
|
|
72
|
-
translation: Vec3Handle,
|
|
73
|
-
): PluginApiReturn<ContourHandle>
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
* Rotate a contour about an axis through an optional pivot. Immutable — returns a
|
|
77
|
-
* NEW contour and leaves the input unchanged.
|
|
78
|
-
*
|
|
79
|
-
* @param contour The contour to rotate
|
|
80
|
-
* @param axis Rotation axis direction
|
|
81
|
-
* @param angle Rotation angle in radians
|
|
82
|
-
* @param pivot Optional pivot point to rotate about (defaults to the origin)
|
|
83
|
-
* @returns The rotated contour as a NEW {@linkcode ContourHandle}
|
|
84
|
-
*
|
|
85
|
-
* @examplePrompt Rotate this shape 45 degrees
|
|
86
|
-
* @examplePrompt Turn this outline 90 degrees about its corner
|
|
87
|
-
*
|
|
88
|
-
* # Example
|
|
89
|
-
* ```ts
|
|
90
|
-
* const rect = await snaptrude.core.geom.create.profileRect(6, 4)
|
|
91
|
-
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
92
|
-
* const axis = await snaptrude.core.math.vec3.new(0, 1, 0)
|
|
93
|
-
* const pivot = await snaptrude.core.math.vec3.new(3, 0, 2)
|
|
94
|
-
* const rotated = await snaptrude.core.geom.update.contour.rotate(contour, axis, Math.PI / 4, pivot)
|
|
95
|
-
* ```
|
|
96
|
-
*/
|
|
97
|
-
public abstract rotate(
|
|
98
|
-
contour: ContourHandle,
|
|
99
|
-
axis: Vec3Handle,
|
|
100
|
-
angle: number,
|
|
101
|
-
pivot?: Vec3Handle,
|
|
102
|
-
): PluginApiReturn<ContourHandle>
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
* Scale a contour uniformly or per-axis about an optional pivot. Immutable —
|
|
106
|
-
* returns a NEW contour and leaves the input unchanged.
|
|
107
|
-
*
|
|
108
|
-
* @param contour The contour to scale
|
|
109
|
-
* @param factor Uniform scale factor, or per-axis factors
|
|
110
|
-
* @param pivot Optional pivot point to scale about (defaults to the origin)
|
|
111
|
-
* @returns The scaled contour as a NEW {@linkcode ContourHandle}
|
|
112
|
-
*
|
|
113
|
-
* @examplePrompt Scale this shape up by a factor of 2
|
|
114
|
-
* @examplePrompt Make this outline half its current size
|
|
115
|
-
*
|
|
116
|
-
* # Example
|
|
117
|
-
* ```ts
|
|
118
|
-
* const rect = await snaptrude.core.geom.create.profileRect(6, 4)
|
|
119
|
-
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
120
|
-
* const doubled = await snaptrude.core.geom.update.contour.scale(contour, 2)
|
|
121
|
-
* const stretched = await snaptrude.core.geom.update.contour.scale(contour, { x: 2, y: 1, z: 1 })
|
|
122
|
-
* ```
|
|
123
|
-
*/
|
|
124
|
-
public abstract scale(
|
|
125
|
-
contour: ContourHandle,
|
|
126
|
-
factor: number | Vec3Components,
|
|
127
|
-
pivot?: Vec3Handle,
|
|
128
|
-
): PluginApiReturn<ContourHandle>
|
|
129
|
-
|
|
130
|
-
/**
|
|
131
|
-
* Mirror a contour across a plane. Immutable — returns a NEW contour and leaves
|
|
132
|
-
* the input unchanged.
|
|
133
|
-
*
|
|
134
|
-
* @param contour The contour to mirror
|
|
135
|
-
* @param plane Mirror plane defined by a point on it and its normal
|
|
136
|
-
* @returns The mirrored contour as a NEW {@linkcode ContourHandle}
|
|
137
|
-
*
|
|
138
|
-
* @examplePrompt Mirror this shape across the gridline
|
|
139
|
-
* @examplePrompt Flip this outline to its mirror image
|
|
140
|
-
*
|
|
141
|
-
* # Example
|
|
142
|
-
* ```ts
|
|
143
|
-
* const rect = await snaptrude.core.geom.create.profileRect(6, 4)
|
|
144
|
-
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
145
|
-
* const point = await snaptrude.core.math.vec3.new(0, 0, 0)
|
|
146
|
-
* const normal = await snaptrude.core.math.vec3.new(1, 0, 0)
|
|
147
|
-
* const mirrored = await snaptrude.core.geom.update.contour.mirror(contour, { point, normal })
|
|
148
|
-
* ```
|
|
149
|
-
*/
|
|
150
|
-
public abstract mirror(
|
|
151
|
-
contour: ContourHandle,
|
|
152
|
-
plane: { point: Vec3Handle; normal: Vec3Handle },
|
|
153
|
-
): PluginApiReturn<ContourHandle>
|
|
154
|
-
|
|
155
|
-
/**
|
|
156
|
-
* Add a hole to a contour by appending an inner profile. Immutable — returns a NEW
|
|
157
|
-
* contour and leaves the input unchanged.
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
* @
|
|
164
|
-
* @
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
* const
|
|
172
|
-
* const
|
|
173
|
-
*
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
*
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
})
|
|
268
|
-
|
|
269
|
-
export
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
}
|
|
316
|
-
|
|
317
|
-
|
|
1
|
+
import * as z from "zod"
|
|
2
|
+
import { PluginApiReturn } from "../../../../types"
|
|
3
|
+
import {
|
|
4
|
+
ContourHandle,
|
|
5
|
+
ProfileHandle,
|
|
6
|
+
Vec3Handle,
|
|
7
|
+
Vec3Components,
|
|
8
|
+
} from "../../../../handles"
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Contour editing — produce NEW contours from an existing one (all-handle model, §11).
|
|
12
|
+
*
|
|
13
|
+
* A contour is an outer {@linkcode ProfileHandle} plus zero or more inner profiles
|
|
14
|
+
* that punch holes in it. Every method here is an immutable derive-new operation:
|
|
15
|
+
* it takes an opaque {@linkcode ContourHandle} (plus any extra inputs) and returns a
|
|
16
|
+
* fresh {@linkcode ContourHandle} for the resulting contour. The input contour is
|
|
17
|
+
* never mutated — the original handle keeps referring to the unchanged contour. Read
|
|
18
|
+
* the resulting geometry back as plain values with the query namespace.
|
|
19
|
+
*
|
|
20
|
+
* Accessed via `snaptrude.core.geom.update.contour`.
|
|
21
|
+
*/
|
|
22
|
+
export abstract class PluginGeomUpdateContourApi {
|
|
23
|
+
constructor() {}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Offset a contour inward/outward by a signed distance. Immutable — returns a NEW
|
|
27
|
+
* contour and leaves the input unchanged.
|
|
28
|
+
*
|
|
29
|
+
* @param contour The contour to offset
|
|
30
|
+
* @param distance Signed offset distance (outward when positive, inward when negative)
|
|
31
|
+
* @returns The offset contour as a NEW {@linkcode ContourHandle}
|
|
32
|
+
* @throws PRECONDITION_FAILED if the outline or a hole has a spline run
|
|
33
|
+
* (splines cannot be offset yet)
|
|
34
|
+
*
|
|
35
|
+
* @examplePrompt Offset this boundary 500mm inward
|
|
36
|
+
* @examplePrompt Shrink this floor outline by half a metre all around
|
|
37
|
+
*
|
|
38
|
+
* # Example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const rect = await snaptrude.core.geom.create.profileRect(10, 8)
|
|
41
|
+
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
42
|
+
* const inset = await snaptrude.core.geom.update.contour.offset(contour, -0.5)
|
|
43
|
+
* const area = await snaptrude.core.geom.query.contour.getArea(inset)
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
public abstract offset(
|
|
47
|
+
contour: ContourHandle,
|
|
48
|
+
distance: number,
|
|
49
|
+
): PluginApiReturn<ContourHandle>
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Translate a contour by a vector. Immutable — returns a NEW contour and leaves
|
|
53
|
+
* the input unchanged.
|
|
54
|
+
*
|
|
55
|
+
* @param contour The contour to move
|
|
56
|
+
* @param translation Translation vector to move the contour by
|
|
57
|
+
* @returns The moved contour as a NEW {@linkcode ContourHandle}
|
|
58
|
+
*
|
|
59
|
+
* @examplePrompt Move this shape 2 metres to the right
|
|
60
|
+
* @examplePrompt Shift this outline over by 5 feet
|
|
61
|
+
*
|
|
62
|
+
* # Example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const rect = await snaptrude.core.geom.create.profileRect(6, 4)
|
|
65
|
+
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
66
|
+
* const shift = await snaptrude.core.math.vec3.new(2, 0, 0)
|
|
67
|
+
* const moved = await snaptrude.core.geom.update.contour.move(contour, shift)
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
public abstract move(
|
|
71
|
+
contour: ContourHandle,
|
|
72
|
+
translation: Vec3Handle,
|
|
73
|
+
): PluginApiReturn<ContourHandle>
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Rotate a contour about an axis through an optional pivot. Immutable — returns a
|
|
77
|
+
* NEW contour and leaves the input unchanged.
|
|
78
|
+
*
|
|
79
|
+
* @param contour The contour to rotate
|
|
80
|
+
* @param axis Rotation axis direction
|
|
81
|
+
* @param angle Rotation angle in radians
|
|
82
|
+
* @param pivot Optional pivot point to rotate about (defaults to the origin)
|
|
83
|
+
* @returns The rotated contour as a NEW {@linkcode ContourHandle}
|
|
84
|
+
*
|
|
85
|
+
* @examplePrompt Rotate this shape 45 degrees
|
|
86
|
+
* @examplePrompt Turn this outline 90 degrees about its corner
|
|
87
|
+
*
|
|
88
|
+
* # Example
|
|
89
|
+
* ```ts
|
|
90
|
+
* const rect = await snaptrude.core.geom.create.profileRect(6, 4)
|
|
91
|
+
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
92
|
+
* const axis = await snaptrude.core.math.vec3.new(0, 1, 0)
|
|
93
|
+
* const pivot = await snaptrude.core.math.vec3.new(3, 0, 2)
|
|
94
|
+
* const rotated = await snaptrude.core.geom.update.contour.rotate(contour, axis, Math.PI / 4, pivot)
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
public abstract rotate(
|
|
98
|
+
contour: ContourHandle,
|
|
99
|
+
axis: Vec3Handle,
|
|
100
|
+
angle: number,
|
|
101
|
+
pivot?: Vec3Handle,
|
|
102
|
+
): PluginApiReturn<ContourHandle>
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Scale a contour uniformly or per-axis about an optional pivot. Immutable —
|
|
106
|
+
* returns a NEW contour and leaves the input unchanged.
|
|
107
|
+
*
|
|
108
|
+
* @param contour The contour to scale
|
|
109
|
+
* @param factor Uniform scale factor, or per-axis factors
|
|
110
|
+
* @param pivot Optional pivot point to scale about (defaults to the origin)
|
|
111
|
+
* @returns The scaled contour as a NEW {@linkcode ContourHandle}
|
|
112
|
+
*
|
|
113
|
+
* @examplePrompt Scale this shape up by a factor of 2
|
|
114
|
+
* @examplePrompt Make this outline half its current size
|
|
115
|
+
*
|
|
116
|
+
* # Example
|
|
117
|
+
* ```ts
|
|
118
|
+
* const rect = await snaptrude.core.geom.create.profileRect(6, 4)
|
|
119
|
+
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
120
|
+
* const doubled = await snaptrude.core.geom.update.contour.scale(contour, 2)
|
|
121
|
+
* const stretched = await snaptrude.core.geom.update.contour.scale(contour, { x: 2, y: 1, z: 1 })
|
|
122
|
+
* ```
|
|
123
|
+
*/
|
|
124
|
+
public abstract scale(
|
|
125
|
+
contour: ContourHandle,
|
|
126
|
+
factor: number | Vec3Components,
|
|
127
|
+
pivot?: Vec3Handle,
|
|
128
|
+
): PluginApiReturn<ContourHandle>
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* Mirror a contour across a plane. Immutable — returns a NEW contour and leaves
|
|
132
|
+
* the input unchanged.
|
|
133
|
+
*
|
|
134
|
+
* @param contour The contour to mirror
|
|
135
|
+
* @param plane Mirror plane defined by a point on it and its normal
|
|
136
|
+
* @returns The mirrored contour as a NEW {@linkcode ContourHandle}
|
|
137
|
+
*
|
|
138
|
+
* @examplePrompt Mirror this shape across the gridline
|
|
139
|
+
* @examplePrompt Flip this outline to its mirror image
|
|
140
|
+
*
|
|
141
|
+
* # Example
|
|
142
|
+
* ```ts
|
|
143
|
+
* const rect = await snaptrude.core.geom.create.profileRect(6, 4)
|
|
144
|
+
* const contour = await snaptrude.core.geom.create.contourFromProfile(rect)
|
|
145
|
+
* const point = await snaptrude.core.math.vec3.new(0, 0, 0)
|
|
146
|
+
* const normal = await snaptrude.core.math.vec3.new(1, 0, 0)
|
|
147
|
+
* const mirrored = await snaptrude.core.geom.update.contour.mirror(contour, { point, normal })
|
|
148
|
+
* ```
|
|
149
|
+
*/
|
|
150
|
+
public abstract mirror(
|
|
151
|
+
contour: ContourHandle,
|
|
152
|
+
plane: { point: Vec3Handle; normal: Vec3Handle },
|
|
153
|
+
): PluginApiReturn<ContourHandle>
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* Add a hole to a contour by appending an inner profile. Immutable — returns a NEW
|
|
157
|
+
* contour and leaves the input unchanged.
|
|
158
|
+
*
|
|
159
|
+
* Edits a contour value only; for an editable hole in an existing slab, floor
|
|
160
|
+
* or roof use `design.create.void`.
|
|
161
|
+
*
|
|
162
|
+
* @param contour The contour to add a hole to
|
|
163
|
+
* @param hole The inner profile to add as a hole
|
|
164
|
+
* @returns The contour with the added hole as a NEW {@linkcode ContourHandle}
|
|
165
|
+
*
|
|
166
|
+
* @examplePrompt Cut a hole in this shape
|
|
167
|
+
* @examplePrompt Punch an opening through this outline
|
|
168
|
+
*
|
|
169
|
+
* # Example
|
|
170
|
+
* ```ts
|
|
171
|
+
* const outer = await snaptrude.core.geom.create.profileRect(10, 8)
|
|
172
|
+
* const contour = await snaptrude.core.geom.create.contourFromProfile(outer)
|
|
173
|
+
* const hole = await snaptrude.core.geom.create.profileRect(2, 2)
|
|
174
|
+
* const withHole = await snaptrude.core.geom.update.contour.addHole(contour, hole)
|
|
175
|
+
* const count = await snaptrude.core.geom.query.contour.getHoleCount(withHole) // 1
|
|
176
|
+
* ```
|
|
177
|
+
*/
|
|
178
|
+
public abstract addHole(
|
|
179
|
+
contour: ContourHandle,
|
|
180
|
+
hole: ProfileHandle,
|
|
181
|
+
): PluginApiReturn<ContourHandle>
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Remove a hole from a contour by inner-profile index. Immutable — returns a NEW
|
|
185
|
+
* contour and leaves the input unchanged.
|
|
186
|
+
*
|
|
187
|
+
* Edits a contour value only; for an editable hole in an existing slab, floor
|
|
188
|
+
* or roof use `design.create.void`.
|
|
189
|
+
*
|
|
190
|
+
* @param contour The contour to remove a hole from
|
|
191
|
+
* @param index Zero-based index of the inner profile (hole) to remove
|
|
192
|
+
* @returns The contour with the hole removed as a NEW {@linkcode ContourHandle}
|
|
193
|
+
*
|
|
194
|
+
* @examplePrompt Remove the hole from this shape
|
|
195
|
+
* @examplePrompt Fill in the opening in this outline
|
|
196
|
+
*
|
|
197
|
+
* # Example
|
|
198
|
+
* ```ts
|
|
199
|
+
* const outer = await snaptrude.core.geom.create.profileRect(10, 8)
|
|
200
|
+
* const hole = await snaptrude.core.geom.create.profileRect(2, 2)
|
|
201
|
+
* const contour = await snaptrude.core.geom.create.contourFromProfiles(outer, [hole])
|
|
202
|
+
* const solid = await snaptrude.core.geom.update.contour.removeHole(contour, 0)
|
|
203
|
+
* ```
|
|
204
|
+
*/
|
|
205
|
+
public abstract removeHole(
|
|
206
|
+
contour: ContourHandle,
|
|
207
|
+
index: number,
|
|
208
|
+
): PluginApiReturn<ContourHandle>
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Arguments for {@linkcode PluginGeomUpdateContourApi.offset}.
|
|
213
|
+
*
|
|
214
|
+
* | Property | Type | Description |
|
|
215
|
+
* |---|---|---|
|
|
216
|
+
* | `contour` | {@linkcode ContourHandle} | The contour to offset |
|
|
217
|
+
* | `distance` | `number` | Signed offset distance (outward when positive, inward when negative) |
|
|
218
|
+
*/
|
|
219
|
+
export const PluginGeomUpdateContourOffsetArgs = z.object({
|
|
220
|
+
contour: ContourHandle,
|
|
221
|
+
distance: z.number(),
|
|
222
|
+
})
|
|
223
|
+
|
|
224
|
+
export type PluginGeomUpdateContourOffsetArgs = z.infer<typeof PluginGeomUpdateContourOffsetArgs>
|
|
225
|
+
|
|
226
|
+
/**
|
|
227
|
+
* Arguments for {@linkcode PluginGeomUpdateContourApi.move}.
|
|
228
|
+
*
|
|
229
|
+
* | Property | Type | Description |
|
|
230
|
+
* |---|---|---|
|
|
231
|
+
* | `contour` | {@linkcode ContourHandle} | The contour to move |
|
|
232
|
+
* | `translation` | {@linkcode Vec3Handle} | Translation vector to move the contour by |
|
|
233
|
+
*/
|
|
234
|
+
export const PluginGeomUpdateContourMoveArgs = z.object({
|
|
235
|
+
contour: ContourHandle,
|
|
236
|
+
translation: Vec3Handle,
|
|
237
|
+
})
|
|
238
|
+
|
|
239
|
+
export type PluginGeomUpdateContourMoveArgs = z.infer<typeof PluginGeomUpdateContourMoveArgs>
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* Arguments for {@linkcode PluginGeomUpdateContourApi.rotate}.
|
|
243
|
+
*
|
|
244
|
+
* | Property | Type | Description |
|
|
245
|
+
* |---|---|---|
|
|
246
|
+
* | `contour` | {@linkcode ContourHandle} | The contour to rotate |
|
|
247
|
+
* | `axis` | {@linkcode Vec3Handle} | Rotation axis direction |
|
|
248
|
+
* | `angle` | `number` | Rotation angle in radians |
|
|
249
|
+
* | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to rotate about (defaults to the origin) |
|
|
250
|
+
*/
|
|
251
|
+
export const PluginGeomUpdateContourRotateArgs = z.object({
|
|
252
|
+
contour: ContourHandle,
|
|
253
|
+
axis: Vec3Handle,
|
|
254
|
+
angle: z.number(),
|
|
255
|
+
pivot: Vec3Handle.optional(),
|
|
256
|
+
})
|
|
257
|
+
|
|
258
|
+
export type PluginGeomUpdateContourRotateArgs = z.infer<typeof PluginGeomUpdateContourRotateArgs>
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* Arguments for {@linkcode PluginGeomUpdateContourApi.scale}.
|
|
262
|
+
*
|
|
263
|
+
* | Property | Type | Description |
|
|
264
|
+
* |---|---|---|
|
|
265
|
+
* | `contour` | {@linkcode ContourHandle} | The contour to scale |
|
|
266
|
+
* | `factor` | `number` \| {@linkcode Vec3Components} | Uniform scale factor, or per-axis factors |
|
|
267
|
+
* | `pivot` | {@linkcode Vec3Handle} | Optional pivot point to scale about (defaults to the origin) |
|
|
268
|
+
*/
|
|
269
|
+
export const PluginGeomUpdateContourScaleArgs = z.object({
|
|
270
|
+
contour: ContourHandle,
|
|
271
|
+
factor: z.union([z.number(), Vec3Components]),
|
|
272
|
+
pivot: Vec3Handle.optional(),
|
|
273
|
+
})
|
|
274
|
+
|
|
275
|
+
export type PluginGeomUpdateContourScaleArgs = z.infer<typeof PluginGeomUpdateContourScaleArgs>
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* Arguments for {@linkcode PluginGeomUpdateContourApi.mirror}.
|
|
279
|
+
*
|
|
280
|
+
* | Property | Type | Description |
|
|
281
|
+
* |---|---|---|
|
|
282
|
+
* | `contour` | {@linkcode ContourHandle} | The contour to mirror |
|
|
283
|
+
* | `plane` | `{ point: `{@linkcode Vec3Handle}`, normal: `{@linkcode Vec3Handle}` }` | Mirror plane defined by a point on it and its normal |
|
|
284
|
+
*/
|
|
285
|
+
export const PluginGeomUpdateContourMirrorArgs = z.object({
|
|
286
|
+
contour: ContourHandle,
|
|
287
|
+
plane: z.object({
|
|
288
|
+
point: Vec3Handle,
|
|
289
|
+
normal: Vec3Handle,
|
|
290
|
+
}),
|
|
291
|
+
})
|
|
292
|
+
|
|
293
|
+
export type PluginGeomUpdateContourMirrorArgs = z.infer<typeof PluginGeomUpdateContourMirrorArgs>
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* Arguments for {@linkcode PluginGeomUpdateContourApi.addHole}.
|
|
297
|
+
*
|
|
298
|
+
* | Property | Type | Description |
|
|
299
|
+
* |---|---|---|
|
|
300
|
+
* | `contour` | {@linkcode ContourHandle} | The contour to add a hole to |
|
|
301
|
+
* | `hole` | {@linkcode ProfileHandle} | The inner profile to add as a hole |
|
|
302
|
+
*/
|
|
303
|
+
export const PluginGeomUpdateContourAddHoleArgs = z.object({
|
|
304
|
+
contour: ContourHandle,
|
|
305
|
+
hole: ProfileHandle,
|
|
306
|
+
})
|
|
307
|
+
|
|
308
|
+
export type PluginGeomUpdateContourAddHoleArgs = z.infer<typeof PluginGeomUpdateContourAddHoleArgs>
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Arguments for {@linkcode PluginGeomUpdateContourApi.removeHole}.
|
|
312
|
+
*
|
|
313
|
+
* | Property | Type | Description |
|
|
314
|
+
* |---|---|---|
|
|
315
|
+
* | `contour` | {@linkcode ContourHandle} | The contour to remove a hole from |
|
|
316
|
+
* | `index` | `number` | Zero-based index of the inner profile (hole) to remove |
|
|
317
|
+
*/
|
|
318
|
+
export const PluginGeomUpdateContourRemoveHoleArgs = z.object({
|
|
319
|
+
contour: ContourHandle,
|
|
320
|
+
index: z.number(),
|
|
321
|
+
})
|
|
322
|
+
|
|
323
|
+
export type PluginGeomUpdateContourRemoveHoleArgs = z.infer<typeof PluginGeomUpdateContourRemoveHoleArgs>
|