@snaptrude/plugin-core 0.9.16 → 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 -402
- 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 +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 +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 +3788 -2328
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +3650 -2328
- 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 -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 +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 -9618
|
@@ -1,473 +1,473 @@
|
|
|
1
|
-
import * as z from "zod"
|
|
2
|
-
import { PluginApiReturn } from "../../../../types"
|
|
3
|
-
import {
|
|
4
|
-
ProfileHandle,
|
|
5
|
-
Vec3Handle,
|
|
6
|
-
CurveHandle,
|
|
7
|
-
Vec3Components,
|
|
8
|
-
BBoxComponents,
|
|
9
|
-
} from "../../../../handles"
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Profile queries — read-only geometric questions about a profile (an ordered
|
|
13
|
-
* loop or chain of curves) and the relationships between two profiles
|
|
14
|
-
* (all-handle model, §11).
|
|
15
|
-
*
|
|
16
|
-
* Every method takes an opaque {@linkcode ProfileHandle} (plus point handles
|
|
17
|
-
* {@linkcode Vec3Handle} where relevant) and returns plain values — points as
|
|
18
|
-
* {@linkcode Vec3Components}, areas/perimeters/distances as `number`, predicates
|
|
19
|
-
* as `boolean`, the bounding box as {@linkcode BBoxComponents}. Methods that
|
|
20
|
-
* enumerate the profile's child curves return fresh {@linkcode CurveHandle}`[]`.
|
|
21
|
-
* No query mutates its inputs.
|
|
22
|
-
*
|
|
23
|
-
* Accessed via `snaptrude.core.geom.query.profile`.
|
|
24
|
-
*/
|
|
25
|
-
export abstract class PluginGeomQueryProfileApi {
|
|
26
|
-
constructor() {}
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* List the tessellated points along a profile.
|
|
30
|
-
* @param profile The profile to query
|
|
31
|
-
* @returns The profile points as {@linkcode Vec3Components}`[]`
|
|
32
|
-
*
|
|
33
|
-
* @examplePrompt Give me the corner coordinates of this shape
|
|
34
|
-
* @examplePrompt List the vertex points along this outline
|
|
35
|
-
*
|
|
36
|
-
* # Example
|
|
37
|
-
* ```ts
|
|
38
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
39
|
-
* const points = await snaptrude.core.geom.query.profile.listPoints(rect)
|
|
40
|
-
* for (const p of points) console.log(p.x, p.y, p.z)
|
|
41
|
-
* ```
|
|
42
|
-
*/
|
|
43
|
-
public abstract listPoints(profile: ProfileHandle): PluginApiReturn<Vec3Components[]>
|
|
44
|
-
|
|
45
|
-
/**
|
|
46
|
-
* List the curves that make up a profile. Host API call — mints fresh handles.
|
|
47
|
-
* @param profile The profile to query
|
|
48
|
-
* @returns The profile's curves as {@linkcode CurveHandle}`[]`
|
|
49
|
-
*
|
|
50
|
-
* # Example
|
|
51
|
-
* ```ts
|
|
52
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
53
|
-
* const curves = await snaptrude.core.geom.query.profile.listCurves(rect)
|
|
54
|
-
* for (const c of curves) console.log(await snaptrude.core.geom.query.curve.getLength(c))
|
|
55
|
-
* ```
|
|
56
|
-
*/
|
|
57
|
-
public abstract listCurves(profile: ProfileHandle): PluginApiReturn<CurveHandle[]>
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* Get the (approximate) enclosed area of a profile.
|
|
61
|
-
* @param profile The profile to query
|
|
62
|
-
* @returns The area as a `number`
|
|
63
|
-
*
|
|
64
|
-
* @examplePrompt What is the area enclosed by this outline?
|
|
65
|
-
* @examplePrompt Measure the area of this shape
|
|
66
|
-
*
|
|
67
|
-
* # Example
|
|
68
|
-
* ```ts
|
|
69
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
70
|
-
* const area = await snaptrude.core.geom.query.profile.getArea(rect) // 12
|
|
71
|
-
* ```
|
|
72
|
-
*/
|
|
73
|
-
public abstract getArea(profile: ProfileHandle): PluginApiReturn<number>
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
* Get the perimeter (total curve length) of a profile.
|
|
77
|
-
* @param profile The profile to query
|
|
78
|
-
* @returns The perimeter as a `number`
|
|
79
|
-
*
|
|
80
|
-
* @examplePrompt How long is the boundary of this shape in total?
|
|
81
|
-
* @examplePrompt Measure the perimeter of this outline
|
|
82
|
-
*
|
|
83
|
-
* # Example
|
|
84
|
-
* ```ts
|
|
85
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
86
|
-
* const perimeter = await snaptrude.core.geom.query.profile.getPerimeter(rect) // 14
|
|
87
|
-
* ```
|
|
88
|
-
*/
|
|
89
|
-
public abstract getPerimeter(profile: ProfileHandle): PluginApiReturn<number>
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
* Get the axis-aligned bounding box of a profile.
|
|
93
|
-
* @param profile The profile to query
|
|
94
|
-
* @returns The bounding box as {@linkcode BBoxComponents}
|
|
95
|
-
*
|
|
96
|
-
* @examplePrompt How wide and long is this outline overall?
|
|
97
|
-
*
|
|
98
|
-
* # Example
|
|
99
|
-
* ```ts
|
|
100
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
101
|
-
* const { min, max } = await snaptrude.core.geom.query.profile.getBoundingBox(rect)
|
|
102
|
-
* console.log(max.x - min.x, max.z - min.z) // 4 3
|
|
103
|
-
* ```
|
|
104
|
-
*/
|
|
105
|
-
public abstract getBoundingBox(profile: ProfileHandle): PluginApiReturn<BBoxComponents>
|
|
106
|
-
|
|
107
|
-
/**
|
|
108
|
-
* Get the unit normal vector of a profile's plane.
|
|
109
|
-
* @param profile The profile to query
|
|
110
|
-
* @returns The normal as {@linkcode Vec3Components}, or `null` if the profile has no well-defined normal
|
|
111
|
-
*
|
|
112
|
-
* # Example
|
|
113
|
-
* ```ts
|
|
114
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
115
|
-
* const normal = await snaptrude.core.geom.query.profile.getNormal(rect)
|
|
116
|
-
* if (normal) console.log(normal.x, normal.y, normal.z)
|
|
117
|
-
* ```
|
|
118
|
-
*/
|
|
119
|
-
public abstract getNormal(profile: ProfileHandle): PluginApiReturn<Vec3Components | null>
|
|
120
|
-
|
|
121
|
-
/**
|
|
122
|
-
* Get the point on a profile nearest to an arbitrary point.
|
|
123
|
-
* @param profile The profile to query
|
|
124
|
-
* @param point The reference point
|
|
125
|
-
* @returns The nearest point on the profile as {@linkcode Vec3Components}
|
|
126
|
-
*
|
|
127
|
-
* @examplePrompt Find the closest point on this outline to a given point
|
|
128
|
-
*
|
|
129
|
-
* # Example
|
|
130
|
-
* ```ts
|
|
131
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
132
|
-
* const point = await snaptrude.core.math.vec3.new(5, 0, 0)
|
|
133
|
-
* const nearest = await snaptrude.core.geom.query.profile.getNearestPoint(rect, point)
|
|
134
|
-
* console.log(nearest.x, nearest.y, nearest.z) // 2 0 0
|
|
135
|
-
* ```
|
|
136
|
-
*/
|
|
137
|
-
public abstract getNearestPoint(
|
|
138
|
-
profile: ProfileHandle,
|
|
139
|
-
point: Vec3Handle,
|
|
140
|
-
): PluginApiReturn<Vec3Components>
|
|
141
|
-
|
|
142
|
-
/**
|
|
143
|
-
* Test whether a point lies inside a profile.
|
|
144
|
-
* @param profile The profile to query
|
|
145
|
-
* @param point The point to test
|
|
146
|
-
* @returns `true` if the point is inside the profile, otherwise `false`
|
|
147
|
-
*
|
|
148
|
-
* @examplePrompt Does this point fall inside the outline?
|
|
149
|
-
* @examplePrompt Check if the column location lies within this room boundary
|
|
150
|
-
*
|
|
151
|
-
* # Example
|
|
152
|
-
* ```ts
|
|
153
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
154
|
-
* const point = await snaptrude.core.math.vec3.new(1, 0, 1)
|
|
155
|
-
* const inside = await snaptrude.core.geom.query.profile.hasPoint(rect, point) // true
|
|
156
|
-
* ```
|
|
157
|
-
*/
|
|
158
|
-
public abstract hasPoint(
|
|
159
|
-
profile: ProfileHandle,
|
|
160
|
-
point: Vec3Handle,
|
|
161
|
-
): PluginApiReturn<boolean>
|
|
162
|
-
|
|
163
|
-
/**
|
|
164
|
-
* Test whether a point lies on a profile's boundary.
|
|
165
|
-
* @param profile The profile to query
|
|
166
|
-
* @param point The point to test
|
|
167
|
-
* @returns `true` if the point is on the boundary, otherwise `false`
|
|
168
|
-
*
|
|
169
|
-
* # Example
|
|
170
|
-
* ```ts
|
|
171
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
172
|
-
* const point = await snaptrude.core.math.vec3.new(2, 0, 0)
|
|
173
|
-
* const onEdge = await snaptrude.core.geom.query.profile.isOnBoundary(rect, point) // true
|
|
174
|
-
* ```
|
|
175
|
-
*/
|
|
176
|
-
public abstract isOnBoundary(
|
|
177
|
-
profile: ProfileHandle,
|
|
178
|
-
point: Vec3Handle,
|
|
179
|
-
): PluginApiReturn<boolean>
|
|
180
|
-
|
|
181
|
-
/**
|
|
182
|
-
* Test whether a profile forms a closed loop.
|
|
183
|
-
* @param profile The profile to query
|
|
184
|
-
* @returns `true` if the profile is closed, otherwise `false`
|
|
185
|
-
*
|
|
186
|
-
* @examplePrompt Is my sketch outline closed or still open?
|
|
187
|
-
* @examplePrompt Check whether this boundary forms a complete loop
|
|
188
|
-
*
|
|
189
|
-
* # Example
|
|
190
|
-
* ```ts
|
|
191
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
192
|
-
* const closed = await snaptrude.core.geom.query.profile.isClosed(rect) // true
|
|
193
|
-
* ```
|
|
194
|
-
*/
|
|
195
|
-
public abstract isClosed(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
196
|
-
|
|
197
|
-
/**
|
|
198
|
-
* Test whether a profile is planar.
|
|
199
|
-
* @param profile The profile to query
|
|
200
|
-
* @returns `true` if the profile is planar, otherwise `false`
|
|
201
|
-
*
|
|
202
|
-
* # Example
|
|
203
|
-
* ```ts
|
|
204
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
205
|
-
* const planar = await snaptrude.core.geom.query.profile.isPlanar(rect) // true
|
|
206
|
-
* ```
|
|
207
|
-
*/
|
|
208
|
-
public abstract isPlanar(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
209
|
-
|
|
210
|
-
/**
|
|
211
|
-
* Test whether a profile is wound clockwise on the XZ plane.
|
|
212
|
-
* @param profile The profile to query
|
|
213
|
-
* @returns `true` if the profile is clockwise, otherwise `false`
|
|
214
|
-
*
|
|
215
|
-
* # Example
|
|
216
|
-
* ```ts
|
|
217
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
218
|
-
* const clockwise = await snaptrude.core.geom.query.profile.isClockwise(rect)
|
|
219
|
-
* ```
|
|
220
|
-
*/
|
|
221
|
-
public abstract isClockwise(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
222
|
-
|
|
223
|
-
/**
|
|
224
|
-
* Test whether a profile intersects itself.
|
|
225
|
-
* @param profile The profile to query
|
|
226
|
-
* @returns `true` if the profile is self-intersecting, otherwise `false`
|
|
227
|
-
*
|
|
228
|
-
* # Example
|
|
229
|
-
* ```ts
|
|
230
|
-
* const a = await snaptrude.core.math.vec3.new(0, 0, 0)
|
|
231
|
-
* const b = await snaptrude.core.math.vec3.new(2, 0, 2)
|
|
232
|
-
* const c = await snaptrude.core.math.vec3.new(2, 0, 0)
|
|
233
|
-
* const d = await snaptrude.core.math.vec3.new(0, 0, 2)
|
|
234
|
-
* const bowtie = await snaptrude.core.geom.create.profileFromLinePoints([a, b, c, d])
|
|
235
|
-
* const crossed = await snaptrude.core.geom.query.profile.isSelfIntersecting(bowtie) // true
|
|
236
|
-
* ```
|
|
237
|
-
*/
|
|
238
|
-
public abstract isSelfIntersecting(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
239
|
-
|
|
240
|
-
/**
|
|
241
|
-
* Test whether a profile contains no curves.
|
|
242
|
-
* @param profile The profile to query
|
|
243
|
-
* @returns `true` if the profile is empty, otherwise `false`
|
|
244
|
-
*
|
|
245
|
-
* # Example
|
|
246
|
-
* ```ts
|
|
247
|
-
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
248
|
-
* const empty = await snaptrude.core.geom.query.profile.isEmpty(rect) // false
|
|
249
|
-
* ```
|
|
250
|
-
*/
|
|
251
|
-
public abstract isEmpty(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
252
|
-
|
|
253
|
-
/**
|
|
254
|
-
* Test whether two profiles are geometrically equal.
|
|
255
|
-
* @param profileA First profile
|
|
256
|
-
* @param profileB Second profile
|
|
257
|
-
* @returns `true` if the profiles are equal, otherwise `false`
|
|
258
|
-
*
|
|
259
|
-
* # Example
|
|
260
|
-
* ```ts
|
|
261
|
-
* const a = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
262
|
-
* const b = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
263
|
-
* const same = await snaptrude.core.geom.query.profile.isEqual(a, b) // true
|
|
264
|
-
* ```
|
|
265
|
-
*/
|
|
266
|
-
public abstract isEqual(
|
|
267
|
-
profileA: ProfileHandle,
|
|
268
|
-
profileB: ProfileHandle,
|
|
269
|
-
): PluginApiReturn<boolean>
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
/**
|
|
273
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.listPoints}.
|
|
274
|
-
*
|
|
275
|
-
* | Property | Type | Description |
|
|
276
|
-
* |---|---|---|
|
|
277
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
278
|
-
*/
|
|
279
|
-
export const PluginGeomQueryProfileListPointsArgs = z.object({
|
|
280
|
-
profile: ProfileHandle,
|
|
281
|
-
})
|
|
282
|
-
|
|
283
|
-
export type PluginGeomQueryProfileListPointsArgs = z.infer<typeof PluginGeomQueryProfileListPointsArgs>
|
|
284
|
-
|
|
285
|
-
/**
|
|
286
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.listCurves}.
|
|
287
|
-
*
|
|
288
|
-
* | Property | Type | Description |
|
|
289
|
-
* |---|---|---|
|
|
290
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
291
|
-
*/
|
|
292
|
-
export const PluginGeomQueryProfileListCurvesArgs = z.object({
|
|
293
|
-
profile: ProfileHandle,
|
|
294
|
-
})
|
|
295
|
-
|
|
296
|
-
export type PluginGeomQueryProfileListCurvesArgs = z.infer<typeof PluginGeomQueryProfileListCurvesArgs>
|
|
297
|
-
|
|
298
|
-
/**
|
|
299
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.getArea}.
|
|
300
|
-
*
|
|
301
|
-
* | Property | Type | Description |
|
|
302
|
-
* |---|---|---|
|
|
303
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
304
|
-
*/
|
|
305
|
-
export const PluginGeomQueryProfileGetAreaArgs = z.object({
|
|
306
|
-
profile: ProfileHandle,
|
|
307
|
-
})
|
|
308
|
-
|
|
309
|
-
export type PluginGeomQueryProfileGetAreaArgs = z.infer<typeof PluginGeomQueryProfileGetAreaArgs>
|
|
310
|
-
|
|
311
|
-
/**
|
|
312
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.getPerimeter}.
|
|
313
|
-
*
|
|
314
|
-
* | Property | Type | Description |
|
|
315
|
-
* |---|---|---|
|
|
316
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
317
|
-
*/
|
|
318
|
-
export const PluginGeomQueryProfileGetPerimeterArgs = z.object({
|
|
319
|
-
profile: ProfileHandle,
|
|
320
|
-
})
|
|
321
|
-
|
|
322
|
-
export type PluginGeomQueryProfileGetPerimeterArgs = z.infer<typeof PluginGeomQueryProfileGetPerimeterArgs>
|
|
323
|
-
|
|
324
|
-
/**
|
|
325
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.getBoundingBox}.
|
|
326
|
-
*
|
|
327
|
-
* | Property | Type | Description |
|
|
328
|
-
* |---|---|---|
|
|
329
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
330
|
-
*/
|
|
331
|
-
export const PluginGeomQueryProfileGetBoundingBoxArgs = z.object({
|
|
332
|
-
profile: ProfileHandle,
|
|
333
|
-
})
|
|
334
|
-
|
|
335
|
-
export type PluginGeomQueryProfileGetBoundingBoxArgs = z.infer<typeof PluginGeomQueryProfileGetBoundingBoxArgs>
|
|
336
|
-
|
|
337
|
-
/**
|
|
338
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.getNormal}.
|
|
339
|
-
*
|
|
340
|
-
* | Property | Type | Description |
|
|
341
|
-
* |---|---|---|
|
|
342
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
343
|
-
*/
|
|
344
|
-
export const PluginGeomQueryProfileGetNormalArgs = z.object({
|
|
345
|
-
profile: ProfileHandle,
|
|
346
|
-
})
|
|
347
|
-
|
|
348
|
-
export type PluginGeomQueryProfileGetNormalArgs = z.infer<typeof PluginGeomQueryProfileGetNormalArgs>
|
|
349
|
-
|
|
350
|
-
/**
|
|
351
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.getNearestPoint}.
|
|
352
|
-
*
|
|
353
|
-
* | Property | Type | Description |
|
|
354
|
-
* |---|---|---|
|
|
355
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
356
|
-
* | `point` | {@linkcode Vec3Handle} | The reference point |
|
|
357
|
-
*/
|
|
358
|
-
export const PluginGeomQueryProfileGetNearestPointArgs = z.object({
|
|
359
|
-
profile: ProfileHandle,
|
|
360
|
-
point: Vec3Handle,
|
|
361
|
-
})
|
|
362
|
-
|
|
363
|
-
export type PluginGeomQueryProfileGetNearestPointArgs = z.infer<typeof PluginGeomQueryProfileGetNearestPointArgs>
|
|
364
|
-
|
|
365
|
-
/**
|
|
366
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.hasPoint}.
|
|
367
|
-
*
|
|
368
|
-
* | Property | Type | Description |
|
|
369
|
-
* |---|---|---|
|
|
370
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
371
|
-
* | `point` | {@linkcode Vec3Handle} | The point to test |
|
|
372
|
-
*/
|
|
373
|
-
export const PluginGeomQueryProfileHasPointArgs = z.object({
|
|
374
|
-
profile: ProfileHandle,
|
|
375
|
-
point: Vec3Handle,
|
|
376
|
-
})
|
|
377
|
-
|
|
378
|
-
export type PluginGeomQueryProfileHasPointArgs = z.infer<typeof PluginGeomQueryProfileHasPointArgs>
|
|
379
|
-
|
|
380
|
-
/**
|
|
381
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.isOnBoundary}.
|
|
382
|
-
*
|
|
383
|
-
* | Property | Type | Description |
|
|
384
|
-
* |---|---|---|
|
|
385
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
386
|
-
* | `point` | {@linkcode Vec3Handle} | The point to test |
|
|
387
|
-
*/
|
|
388
|
-
export const PluginGeomQueryProfileIsOnBoundaryArgs = z.object({
|
|
389
|
-
profile: ProfileHandle,
|
|
390
|
-
point: Vec3Handle,
|
|
391
|
-
})
|
|
392
|
-
|
|
393
|
-
export type PluginGeomQueryProfileIsOnBoundaryArgs = z.infer<typeof PluginGeomQueryProfileIsOnBoundaryArgs>
|
|
394
|
-
|
|
395
|
-
/**
|
|
396
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.isClosed}.
|
|
397
|
-
*
|
|
398
|
-
* | Property | Type | Description |
|
|
399
|
-
* |---|---|---|
|
|
400
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
401
|
-
*/
|
|
402
|
-
export const PluginGeomQueryProfileIsClosedArgs = z.object({
|
|
403
|
-
profile: ProfileHandle,
|
|
404
|
-
})
|
|
405
|
-
|
|
406
|
-
export type PluginGeomQueryProfileIsClosedArgs = z.infer<typeof PluginGeomQueryProfileIsClosedArgs>
|
|
407
|
-
|
|
408
|
-
/**
|
|
409
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.isPlanar}.
|
|
410
|
-
*
|
|
411
|
-
* | Property | Type | Description |
|
|
412
|
-
* |---|---|---|
|
|
413
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
414
|
-
*/
|
|
415
|
-
export const PluginGeomQueryProfileIsPlanarArgs = z.object({
|
|
416
|
-
profile: ProfileHandle,
|
|
417
|
-
})
|
|
418
|
-
|
|
419
|
-
export type PluginGeomQueryProfileIsPlanarArgs = z.infer<typeof PluginGeomQueryProfileIsPlanarArgs>
|
|
420
|
-
|
|
421
|
-
/**
|
|
422
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.isClockwise}.
|
|
423
|
-
*
|
|
424
|
-
* | Property | Type | Description |
|
|
425
|
-
* |---|---|---|
|
|
426
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
427
|
-
*/
|
|
428
|
-
export const PluginGeomQueryProfileIsClockwiseArgs = z.object({
|
|
429
|
-
profile: ProfileHandle,
|
|
430
|
-
})
|
|
431
|
-
|
|
432
|
-
export type PluginGeomQueryProfileIsClockwiseArgs = z.infer<typeof PluginGeomQueryProfileIsClockwiseArgs>
|
|
433
|
-
|
|
434
|
-
/**
|
|
435
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.isSelfIntersecting}.
|
|
436
|
-
*
|
|
437
|
-
* | Property | Type | Description |
|
|
438
|
-
* |---|---|---|
|
|
439
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
440
|
-
*/
|
|
441
|
-
export const PluginGeomQueryProfileIsSelfIntersectingArgs = z.object({
|
|
442
|
-
profile: ProfileHandle,
|
|
443
|
-
})
|
|
444
|
-
|
|
445
|
-
export type PluginGeomQueryProfileIsSelfIntersectingArgs = z.infer<typeof PluginGeomQueryProfileIsSelfIntersectingArgs>
|
|
446
|
-
|
|
447
|
-
/**
|
|
448
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.isEmpty}.
|
|
449
|
-
*
|
|
450
|
-
* | Property | Type | Description |
|
|
451
|
-
* |---|---|---|
|
|
452
|
-
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
453
|
-
*/
|
|
454
|
-
export const PluginGeomQueryProfileIsEmptyArgs = z.object({
|
|
455
|
-
profile: ProfileHandle,
|
|
456
|
-
})
|
|
457
|
-
|
|
458
|
-
export type PluginGeomQueryProfileIsEmptyArgs = z.infer<typeof PluginGeomQueryProfileIsEmptyArgs>
|
|
459
|
-
|
|
460
|
-
/**
|
|
461
|
-
* Arguments for {@linkcode PluginGeomQueryProfileApi.isEqual}.
|
|
462
|
-
*
|
|
463
|
-
* | Property | Type | Description |
|
|
464
|
-
* |---|---|---|
|
|
465
|
-
* | `profileA` | {@linkcode ProfileHandle} | First profile |
|
|
466
|
-
* | `profileB` | {@linkcode ProfileHandle} | Second profile |
|
|
467
|
-
*/
|
|
468
|
-
export const PluginGeomQueryProfileIsEqualArgs = z.object({
|
|
469
|
-
profileA: ProfileHandle,
|
|
470
|
-
profileB: ProfileHandle,
|
|
471
|
-
})
|
|
472
|
-
|
|
473
|
-
export type PluginGeomQueryProfileIsEqualArgs = z.infer<typeof PluginGeomQueryProfileIsEqualArgs>
|
|
1
|
+
import * as z from "zod"
|
|
2
|
+
import { PluginApiReturn } from "../../../../types"
|
|
3
|
+
import {
|
|
4
|
+
ProfileHandle,
|
|
5
|
+
Vec3Handle,
|
|
6
|
+
CurveHandle,
|
|
7
|
+
Vec3Components,
|
|
8
|
+
BBoxComponents,
|
|
9
|
+
} from "../../../../handles"
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Profile queries — read-only geometric questions about a profile (an ordered
|
|
13
|
+
* loop or chain of curves) and the relationships between two profiles
|
|
14
|
+
* (all-handle model, §11).
|
|
15
|
+
*
|
|
16
|
+
* Every method takes an opaque {@linkcode ProfileHandle} (plus point handles
|
|
17
|
+
* {@linkcode Vec3Handle} where relevant) and returns plain values — points as
|
|
18
|
+
* {@linkcode Vec3Components}, areas/perimeters/distances as `number`, predicates
|
|
19
|
+
* as `boolean`, the bounding box as {@linkcode BBoxComponents}. Methods that
|
|
20
|
+
* enumerate the profile's child curves return fresh {@linkcode CurveHandle}`[]`.
|
|
21
|
+
* No query mutates its inputs.
|
|
22
|
+
*
|
|
23
|
+
* Accessed via `snaptrude.core.geom.query.profile`.
|
|
24
|
+
*/
|
|
25
|
+
export abstract class PluginGeomQueryProfileApi {
|
|
26
|
+
constructor() {}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* List the tessellated points along a profile.
|
|
30
|
+
* @param profile The profile to query
|
|
31
|
+
* @returns The profile points as {@linkcode Vec3Components}`[]`
|
|
32
|
+
*
|
|
33
|
+
* @examplePrompt Give me the corner coordinates of this shape
|
|
34
|
+
* @examplePrompt List the vertex points along this outline
|
|
35
|
+
*
|
|
36
|
+
* # Example
|
|
37
|
+
* ```ts
|
|
38
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
39
|
+
* const points = await snaptrude.core.geom.query.profile.listPoints(rect)
|
|
40
|
+
* for (const p of points) console.log(p.x, p.y, p.z)
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
public abstract listPoints(profile: ProfileHandle): PluginApiReturn<Vec3Components[]>
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* List the curves that make up a profile. Host API call — mints fresh handles.
|
|
47
|
+
* @param profile The profile to query
|
|
48
|
+
* @returns The profile's curves as {@linkcode CurveHandle}`[]`
|
|
49
|
+
*
|
|
50
|
+
* # Example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
53
|
+
* const curves = await snaptrude.core.geom.query.profile.listCurves(rect)
|
|
54
|
+
* for (const c of curves) console.log(await snaptrude.core.geom.query.curve.getLength(c))
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
public abstract listCurves(profile: ProfileHandle): PluginApiReturn<CurveHandle[]>
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* Get the (approximate) enclosed area of a profile.
|
|
61
|
+
* @param profile The profile to query
|
|
62
|
+
* @returns The area as a `number`
|
|
63
|
+
*
|
|
64
|
+
* @examplePrompt What is the area enclosed by this outline?
|
|
65
|
+
* @examplePrompt Measure the area of this shape
|
|
66
|
+
*
|
|
67
|
+
* # Example
|
|
68
|
+
* ```ts
|
|
69
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
70
|
+
* const area = await snaptrude.core.geom.query.profile.getArea(rect) // 12
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
public abstract getArea(profile: ProfileHandle): PluginApiReturn<number>
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Get the perimeter (total curve length) of a profile.
|
|
77
|
+
* @param profile The profile to query
|
|
78
|
+
* @returns The perimeter as a `number`
|
|
79
|
+
*
|
|
80
|
+
* @examplePrompt How long is the boundary of this shape in total?
|
|
81
|
+
* @examplePrompt Measure the perimeter of this outline
|
|
82
|
+
*
|
|
83
|
+
* # Example
|
|
84
|
+
* ```ts
|
|
85
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
86
|
+
* const perimeter = await snaptrude.core.geom.query.profile.getPerimeter(rect) // 14
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
public abstract getPerimeter(profile: ProfileHandle): PluginApiReturn<number>
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Get the axis-aligned bounding box of a profile.
|
|
93
|
+
* @param profile The profile to query
|
|
94
|
+
* @returns The bounding box as {@linkcode BBoxComponents}
|
|
95
|
+
*
|
|
96
|
+
* @examplePrompt How wide and long is this outline overall?
|
|
97
|
+
*
|
|
98
|
+
* # Example
|
|
99
|
+
* ```ts
|
|
100
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
101
|
+
* const { min, max } = await snaptrude.core.geom.query.profile.getBoundingBox(rect)
|
|
102
|
+
* console.log(max.x - min.x, max.z - min.z) // 4 3
|
|
103
|
+
* ```
|
|
104
|
+
*/
|
|
105
|
+
public abstract getBoundingBox(profile: ProfileHandle): PluginApiReturn<BBoxComponents>
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* Get the unit normal vector of a profile's plane.
|
|
109
|
+
* @param profile The profile to query
|
|
110
|
+
* @returns The normal as {@linkcode Vec3Components}, or `null` if the profile has no well-defined normal
|
|
111
|
+
*
|
|
112
|
+
* # Example
|
|
113
|
+
* ```ts
|
|
114
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
115
|
+
* const normal = await snaptrude.core.geom.query.profile.getNormal(rect)
|
|
116
|
+
* if (normal) console.log(normal.x, normal.y, normal.z)
|
|
117
|
+
* ```
|
|
118
|
+
*/
|
|
119
|
+
public abstract getNormal(profile: ProfileHandle): PluginApiReturn<Vec3Components | null>
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Get the point on a profile nearest to an arbitrary point.
|
|
123
|
+
* @param profile The profile to query
|
|
124
|
+
* @param point The reference point
|
|
125
|
+
* @returns The nearest point on the profile as {@linkcode Vec3Components}
|
|
126
|
+
*
|
|
127
|
+
* @examplePrompt Find the closest point on this outline to a given point
|
|
128
|
+
*
|
|
129
|
+
* # Example
|
|
130
|
+
* ```ts
|
|
131
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
132
|
+
* const point = await snaptrude.core.math.vec3.new(5, 0, 0)
|
|
133
|
+
* const nearest = await snaptrude.core.geom.query.profile.getNearestPoint(rect, point)
|
|
134
|
+
* console.log(nearest.x, nearest.y, nearest.z) // 2 0 0
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
public abstract getNearestPoint(
|
|
138
|
+
profile: ProfileHandle,
|
|
139
|
+
point: Vec3Handle,
|
|
140
|
+
): PluginApiReturn<Vec3Components>
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* Test whether a point lies inside a profile.
|
|
144
|
+
* @param profile The profile to query
|
|
145
|
+
* @param point The point to test
|
|
146
|
+
* @returns `true` if the point is inside the profile, otherwise `false`
|
|
147
|
+
*
|
|
148
|
+
* @examplePrompt Does this point fall inside the outline?
|
|
149
|
+
* @examplePrompt Check if the column location lies within this room boundary
|
|
150
|
+
*
|
|
151
|
+
* # Example
|
|
152
|
+
* ```ts
|
|
153
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
154
|
+
* const point = await snaptrude.core.math.vec3.new(1, 0, 1)
|
|
155
|
+
* const inside = await snaptrude.core.geom.query.profile.hasPoint(rect, point) // true
|
|
156
|
+
* ```
|
|
157
|
+
*/
|
|
158
|
+
public abstract hasPoint(
|
|
159
|
+
profile: ProfileHandle,
|
|
160
|
+
point: Vec3Handle,
|
|
161
|
+
): PluginApiReturn<boolean>
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* Test whether a point lies on a profile's boundary.
|
|
165
|
+
* @param profile The profile to query
|
|
166
|
+
* @param point The point to test
|
|
167
|
+
* @returns `true` if the point is on the boundary, otherwise `false`
|
|
168
|
+
*
|
|
169
|
+
* # Example
|
|
170
|
+
* ```ts
|
|
171
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
172
|
+
* const point = await snaptrude.core.math.vec3.new(2, 0, 0)
|
|
173
|
+
* const onEdge = await snaptrude.core.geom.query.profile.isOnBoundary(rect, point) // true
|
|
174
|
+
* ```
|
|
175
|
+
*/
|
|
176
|
+
public abstract isOnBoundary(
|
|
177
|
+
profile: ProfileHandle,
|
|
178
|
+
point: Vec3Handle,
|
|
179
|
+
): PluginApiReturn<boolean>
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* Test whether a profile forms a closed loop.
|
|
183
|
+
* @param profile The profile to query
|
|
184
|
+
* @returns `true` if the profile is closed, otherwise `false`
|
|
185
|
+
*
|
|
186
|
+
* @examplePrompt Is my sketch outline closed or still open?
|
|
187
|
+
* @examplePrompt Check whether this boundary forms a complete loop
|
|
188
|
+
*
|
|
189
|
+
* # Example
|
|
190
|
+
* ```ts
|
|
191
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
192
|
+
* const closed = await snaptrude.core.geom.query.profile.isClosed(rect) // true
|
|
193
|
+
* ```
|
|
194
|
+
*/
|
|
195
|
+
public abstract isClosed(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Test whether a profile is planar.
|
|
199
|
+
* @param profile The profile to query
|
|
200
|
+
* @returns `true` if the profile is planar, otherwise `false`
|
|
201
|
+
*
|
|
202
|
+
* # Example
|
|
203
|
+
* ```ts
|
|
204
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
205
|
+
* const planar = await snaptrude.core.geom.query.profile.isPlanar(rect) // true
|
|
206
|
+
* ```
|
|
207
|
+
*/
|
|
208
|
+
public abstract isPlanar(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Test whether a profile is wound clockwise on the XZ plane.
|
|
212
|
+
* @param profile The profile to query
|
|
213
|
+
* @returns `true` if the profile is clockwise, otherwise `false`
|
|
214
|
+
*
|
|
215
|
+
* # Example
|
|
216
|
+
* ```ts
|
|
217
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
218
|
+
* const clockwise = await snaptrude.core.geom.query.profile.isClockwise(rect)
|
|
219
|
+
* ```
|
|
220
|
+
*/
|
|
221
|
+
public abstract isClockwise(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
222
|
+
|
|
223
|
+
/**
|
|
224
|
+
* Test whether a profile intersects itself.
|
|
225
|
+
* @param profile The profile to query
|
|
226
|
+
* @returns `true` if the profile is self-intersecting, otherwise `false`
|
|
227
|
+
*
|
|
228
|
+
* # Example
|
|
229
|
+
* ```ts
|
|
230
|
+
* const a = await snaptrude.core.math.vec3.new(0, 0, 0)
|
|
231
|
+
* const b = await snaptrude.core.math.vec3.new(2, 0, 2)
|
|
232
|
+
* const c = await snaptrude.core.math.vec3.new(2, 0, 0)
|
|
233
|
+
* const d = await snaptrude.core.math.vec3.new(0, 0, 2)
|
|
234
|
+
* const bowtie = await snaptrude.core.geom.create.profileFromLinePoints([a, b, c, d])
|
|
235
|
+
* const crossed = await snaptrude.core.geom.query.profile.isSelfIntersecting(bowtie) // true
|
|
236
|
+
* ```
|
|
237
|
+
*/
|
|
238
|
+
public abstract isSelfIntersecting(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
239
|
+
|
|
240
|
+
/**
|
|
241
|
+
* Test whether a profile contains no curves.
|
|
242
|
+
* @param profile The profile to query
|
|
243
|
+
* @returns `true` if the profile is empty, otherwise `false`
|
|
244
|
+
*
|
|
245
|
+
* # Example
|
|
246
|
+
* ```ts
|
|
247
|
+
* const rect = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
248
|
+
* const empty = await snaptrude.core.geom.query.profile.isEmpty(rect) // false
|
|
249
|
+
* ```
|
|
250
|
+
*/
|
|
251
|
+
public abstract isEmpty(profile: ProfileHandle): PluginApiReturn<boolean>
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* Test whether two profiles are geometrically equal.
|
|
255
|
+
* @param profileA First profile
|
|
256
|
+
* @param profileB Second profile
|
|
257
|
+
* @returns `true` if the profiles are equal, otherwise `false`
|
|
258
|
+
*
|
|
259
|
+
* # Example
|
|
260
|
+
* ```ts
|
|
261
|
+
* const a = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
262
|
+
* const b = await snaptrude.core.geom.create.profileRect(4, 3)
|
|
263
|
+
* const same = await snaptrude.core.geom.query.profile.isEqual(a, b) // true
|
|
264
|
+
* ```
|
|
265
|
+
*/
|
|
266
|
+
public abstract isEqual(
|
|
267
|
+
profileA: ProfileHandle,
|
|
268
|
+
profileB: ProfileHandle,
|
|
269
|
+
): PluginApiReturn<boolean>
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.listPoints}.
|
|
274
|
+
*
|
|
275
|
+
* | Property | Type | Description |
|
|
276
|
+
* |---|---|---|
|
|
277
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
278
|
+
*/
|
|
279
|
+
export const PluginGeomQueryProfileListPointsArgs = z.object({
|
|
280
|
+
profile: ProfileHandle,
|
|
281
|
+
})
|
|
282
|
+
|
|
283
|
+
export type PluginGeomQueryProfileListPointsArgs = z.infer<typeof PluginGeomQueryProfileListPointsArgs>
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.listCurves}.
|
|
287
|
+
*
|
|
288
|
+
* | Property | Type | Description |
|
|
289
|
+
* |---|---|---|
|
|
290
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
291
|
+
*/
|
|
292
|
+
export const PluginGeomQueryProfileListCurvesArgs = z.object({
|
|
293
|
+
profile: ProfileHandle,
|
|
294
|
+
})
|
|
295
|
+
|
|
296
|
+
export type PluginGeomQueryProfileListCurvesArgs = z.infer<typeof PluginGeomQueryProfileListCurvesArgs>
|
|
297
|
+
|
|
298
|
+
/**
|
|
299
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.getArea}.
|
|
300
|
+
*
|
|
301
|
+
* | Property | Type | Description |
|
|
302
|
+
* |---|---|---|
|
|
303
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
304
|
+
*/
|
|
305
|
+
export const PluginGeomQueryProfileGetAreaArgs = z.object({
|
|
306
|
+
profile: ProfileHandle,
|
|
307
|
+
})
|
|
308
|
+
|
|
309
|
+
export type PluginGeomQueryProfileGetAreaArgs = z.infer<typeof PluginGeomQueryProfileGetAreaArgs>
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.getPerimeter}.
|
|
313
|
+
*
|
|
314
|
+
* | Property | Type | Description |
|
|
315
|
+
* |---|---|---|
|
|
316
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
317
|
+
*/
|
|
318
|
+
export const PluginGeomQueryProfileGetPerimeterArgs = z.object({
|
|
319
|
+
profile: ProfileHandle,
|
|
320
|
+
})
|
|
321
|
+
|
|
322
|
+
export type PluginGeomQueryProfileGetPerimeterArgs = z.infer<typeof PluginGeomQueryProfileGetPerimeterArgs>
|
|
323
|
+
|
|
324
|
+
/**
|
|
325
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.getBoundingBox}.
|
|
326
|
+
*
|
|
327
|
+
* | Property | Type | Description |
|
|
328
|
+
* |---|---|---|
|
|
329
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
330
|
+
*/
|
|
331
|
+
export const PluginGeomQueryProfileGetBoundingBoxArgs = z.object({
|
|
332
|
+
profile: ProfileHandle,
|
|
333
|
+
})
|
|
334
|
+
|
|
335
|
+
export type PluginGeomQueryProfileGetBoundingBoxArgs = z.infer<typeof PluginGeomQueryProfileGetBoundingBoxArgs>
|
|
336
|
+
|
|
337
|
+
/**
|
|
338
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.getNormal}.
|
|
339
|
+
*
|
|
340
|
+
* | Property | Type | Description |
|
|
341
|
+
* |---|---|---|
|
|
342
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
343
|
+
*/
|
|
344
|
+
export const PluginGeomQueryProfileGetNormalArgs = z.object({
|
|
345
|
+
profile: ProfileHandle,
|
|
346
|
+
})
|
|
347
|
+
|
|
348
|
+
export type PluginGeomQueryProfileGetNormalArgs = z.infer<typeof PluginGeomQueryProfileGetNormalArgs>
|
|
349
|
+
|
|
350
|
+
/**
|
|
351
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.getNearestPoint}.
|
|
352
|
+
*
|
|
353
|
+
* | Property | Type | Description |
|
|
354
|
+
* |---|---|---|
|
|
355
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
356
|
+
* | `point` | {@linkcode Vec3Handle} | The reference point |
|
|
357
|
+
*/
|
|
358
|
+
export const PluginGeomQueryProfileGetNearestPointArgs = z.object({
|
|
359
|
+
profile: ProfileHandle,
|
|
360
|
+
point: Vec3Handle,
|
|
361
|
+
})
|
|
362
|
+
|
|
363
|
+
export type PluginGeomQueryProfileGetNearestPointArgs = z.infer<typeof PluginGeomQueryProfileGetNearestPointArgs>
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.hasPoint}.
|
|
367
|
+
*
|
|
368
|
+
* | Property | Type | Description |
|
|
369
|
+
* |---|---|---|
|
|
370
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
371
|
+
* | `point` | {@linkcode Vec3Handle} | The point to test |
|
|
372
|
+
*/
|
|
373
|
+
export const PluginGeomQueryProfileHasPointArgs = z.object({
|
|
374
|
+
profile: ProfileHandle,
|
|
375
|
+
point: Vec3Handle,
|
|
376
|
+
})
|
|
377
|
+
|
|
378
|
+
export type PluginGeomQueryProfileHasPointArgs = z.infer<typeof PluginGeomQueryProfileHasPointArgs>
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.isOnBoundary}.
|
|
382
|
+
*
|
|
383
|
+
* | Property | Type | Description |
|
|
384
|
+
* |---|---|---|
|
|
385
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
386
|
+
* | `point` | {@linkcode Vec3Handle} | The point to test |
|
|
387
|
+
*/
|
|
388
|
+
export const PluginGeomQueryProfileIsOnBoundaryArgs = z.object({
|
|
389
|
+
profile: ProfileHandle,
|
|
390
|
+
point: Vec3Handle,
|
|
391
|
+
})
|
|
392
|
+
|
|
393
|
+
export type PluginGeomQueryProfileIsOnBoundaryArgs = z.infer<typeof PluginGeomQueryProfileIsOnBoundaryArgs>
|
|
394
|
+
|
|
395
|
+
/**
|
|
396
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.isClosed}.
|
|
397
|
+
*
|
|
398
|
+
* | Property | Type | Description |
|
|
399
|
+
* |---|---|---|
|
|
400
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
401
|
+
*/
|
|
402
|
+
export const PluginGeomQueryProfileIsClosedArgs = z.object({
|
|
403
|
+
profile: ProfileHandle,
|
|
404
|
+
})
|
|
405
|
+
|
|
406
|
+
export type PluginGeomQueryProfileIsClosedArgs = z.infer<typeof PluginGeomQueryProfileIsClosedArgs>
|
|
407
|
+
|
|
408
|
+
/**
|
|
409
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.isPlanar}.
|
|
410
|
+
*
|
|
411
|
+
* | Property | Type | Description |
|
|
412
|
+
* |---|---|---|
|
|
413
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
414
|
+
*/
|
|
415
|
+
export const PluginGeomQueryProfileIsPlanarArgs = z.object({
|
|
416
|
+
profile: ProfileHandle,
|
|
417
|
+
})
|
|
418
|
+
|
|
419
|
+
export type PluginGeomQueryProfileIsPlanarArgs = z.infer<typeof PluginGeomQueryProfileIsPlanarArgs>
|
|
420
|
+
|
|
421
|
+
/**
|
|
422
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.isClockwise}.
|
|
423
|
+
*
|
|
424
|
+
* | Property | Type | Description |
|
|
425
|
+
* |---|---|---|
|
|
426
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
427
|
+
*/
|
|
428
|
+
export const PluginGeomQueryProfileIsClockwiseArgs = z.object({
|
|
429
|
+
profile: ProfileHandle,
|
|
430
|
+
})
|
|
431
|
+
|
|
432
|
+
export type PluginGeomQueryProfileIsClockwiseArgs = z.infer<typeof PluginGeomQueryProfileIsClockwiseArgs>
|
|
433
|
+
|
|
434
|
+
/**
|
|
435
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.isSelfIntersecting}.
|
|
436
|
+
*
|
|
437
|
+
* | Property | Type | Description |
|
|
438
|
+
* |---|---|---|
|
|
439
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
440
|
+
*/
|
|
441
|
+
export const PluginGeomQueryProfileIsSelfIntersectingArgs = z.object({
|
|
442
|
+
profile: ProfileHandle,
|
|
443
|
+
})
|
|
444
|
+
|
|
445
|
+
export type PluginGeomQueryProfileIsSelfIntersectingArgs = z.infer<typeof PluginGeomQueryProfileIsSelfIntersectingArgs>
|
|
446
|
+
|
|
447
|
+
/**
|
|
448
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.isEmpty}.
|
|
449
|
+
*
|
|
450
|
+
* | Property | Type | Description |
|
|
451
|
+
* |---|---|---|
|
|
452
|
+
* | `profile` | {@linkcode ProfileHandle} | The profile to query |
|
|
453
|
+
*/
|
|
454
|
+
export const PluginGeomQueryProfileIsEmptyArgs = z.object({
|
|
455
|
+
profile: ProfileHandle,
|
|
456
|
+
})
|
|
457
|
+
|
|
458
|
+
export type PluginGeomQueryProfileIsEmptyArgs = z.infer<typeof PluginGeomQueryProfileIsEmptyArgs>
|
|
459
|
+
|
|
460
|
+
/**
|
|
461
|
+
* Arguments for {@linkcode PluginGeomQueryProfileApi.isEqual}.
|
|
462
|
+
*
|
|
463
|
+
* | Property | Type | Description |
|
|
464
|
+
* |---|---|---|
|
|
465
|
+
* | `profileA` | {@linkcode ProfileHandle} | First profile |
|
|
466
|
+
* | `profileB` | {@linkcode ProfileHandle} | Second profile |
|
|
467
|
+
*/
|
|
468
|
+
export const PluginGeomQueryProfileIsEqualArgs = z.object({
|
|
469
|
+
profileA: ProfileHandle,
|
|
470
|
+
profileB: ProfileHandle,
|
|
471
|
+
})
|
|
472
|
+
|
|
473
|
+
export type PluginGeomQueryProfileIsEqualArgs = z.infer<typeof PluginGeomQueryProfileIsEqualArgs>
|