@snaptrude/plugin-core 0.9.13 → 0.9.15
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/CHANGELOG.md +61 -0
- package/api-manifest.full.json +8930 -0
- package/api-manifest.json +1002 -55
- package/dist/api/core/geom/create/index.d.ts +935 -100
- package/dist/api/core/geom/create/index.d.ts.map +1 -1
- package/dist/api/core/geom/query/brep.d.ts +59 -2
- package/dist/api/core/geom/query/brep.d.ts.map +1 -1
- package/dist/api/core/geom/query/curve.d.ts +59 -35
- package/dist/api/core/geom/query/curve.d.ts.map +1 -1
- package/dist/api/core/geom/query/edge.d.ts +2 -2
- package/dist/api/core/geom/query/face.d.ts +105 -0
- package/dist/api/core/geom/query/face.d.ts.map +1 -1
- package/dist/api/core/geom/update/contour.d.ts +2 -0
- package/dist/api/core/geom/update/contour.d.ts.map +1 -1
- package/dist/api/core/geom/update/curve.d.ts +5 -5
- package/dist/api/core/geom/update/profile.d.ts +3 -1
- package/dist/api/core/geom/update/profile.d.ts.map +1 -1
- package/dist/api/core/handles/index.d.ts +4 -2
- package/dist/api/core/handles/index.d.ts.map +1 -1
- package/dist/api/core/index.d.ts +4 -4
- package/dist/api/core/index.d.ts.map +1 -1
- package/dist/api/core/layers.d.ts +377 -255
- package/dist/api/core/layers.d.ts.map +1 -1
- package/dist/api/core/proposals/index.d.ts +4 -3
- package/dist/api/core/proposals/index.d.ts.map +1 -1
- package/dist/api/core/storeys/index.d.ts +12 -0
- package/dist/api/core/storeys/index.d.ts.map +1 -1
- package/dist/api/core/storeys/layers.d.ts +408 -0
- package/dist/api/core/storeys/layers.d.ts.map +1 -0
- package/dist/api/core/tags.d.ts +3 -3
- package/dist/api/design/create/bulk-items.d.ts +44 -0
- package/dist/api/design/create/bulk-items.d.ts.map +1 -1
- package/dist/api/design/create/grids.d.ts +1 -1
- package/dist/api/design/create/index.d.ts +31 -3
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/family.d.ts +67 -10
- package/dist/api/design/family.d.ts.map +1 -1
- package/dist/api/design/query/geometry/index.d.ts +33 -5
- package/dist/api/design/query/geometry/index.d.ts.map +1 -1
- package/dist/api/design/query/grids.d.ts +3 -3
- package/dist/api/design/query/index.d.ts +47 -0
- package/dist/api/design/query/index.d.ts.map +1 -1
- package/dist/api/design/query/spaces.d.ts +5 -5
- package/dist/api/design/selection/index.d.ts +2 -2
- package/dist/api/design/update/index.d.ts +172 -0
- package/dist/api/design/update/index.d.ts.map +1 -1
- package/dist/api/entity/referenceLine.d.ts +1 -1
- package/dist/api/entity/space.d.ts +4 -4
- package/dist/api/entity/story.d.ts +4 -4
- package/dist/api/presentation/aiInspiration.d.ts +13 -13
- package/dist/api/presentation/camera.d.ts +265 -0
- package/dist/api/presentation/camera.d.ts.map +1 -0
- package/dist/api/presentation/index.d.ts +5 -0
- package/dist/api/presentation/index.d.ts.map +1 -1
- package/dist/api/presentation/placedViews.d.ts +1 -1
- package/dist/api/presentation/views.d.ts +3 -1
- package/dist/api/presentation/views.d.ts.map +1 -1
- package/dist/api/program/site.d.ts +4 -4
- package/dist/api/program/spreadsheet.d.ts +4 -4
- package/dist/handles.d.ts +13 -3
- package/dist/handles.d.ts.map +1 -1
- package/dist/index.cjs +3638 -2958
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3558 -2955
- package/dist/index.js.map +1 -1
- package/dist/massParameters.d.ts +287 -0
- package/dist/massParameters.d.ts.map +1 -0
- package/dist/massParameters.ops.d.ts +138 -0
- package/dist/massParameters.ops.d.ts.map +1 -0
- package/package.json +2 -1
- package/scripts/check-dist-fresh.mjs +22 -0
- package/scripts/generate-manifest.test.mjs +14 -3
- package/src/api/core/geom/create/index.ts +1030 -101
- package/src/api/core/geom/query/brep.ts +60 -2
- package/src/api/core/geom/query/curve.ts +26 -2
- package/src/api/core/geom/query/edge.ts +2 -2
- package/src/api/core/geom/query/face.ts +109 -4
- package/src/api/core/geom/update/contour.ts +2 -0
- package/src/api/core/geom/update/profile.ts +2 -0
- package/src/api/core/handles/index.ts +3 -2
- package/src/api/core/index.ts +4 -4
- package/src/api/core/layers.ts +380 -173
- package/src/api/core/proposals/index.ts +4 -3
- package/src/api/core/storeys/index.ts +14 -0
- package/src/api/core/storeys/layers.ts +339 -0
- package/src/api/design/create/bulk-items.ts +68 -0
- package/src/api/design/create/index.ts +30 -4
- package/src/api/design/family.ts +68 -10
- package/src/api/design/query/geometry/index.ts +35 -4
- package/src/api/design/query/index.ts +50 -0
- package/src/api/design/update/index.ts +186 -1
- package/src/api/presentation/camera.ts +289 -0
- package/src/api/presentation/index.ts +5 -0
- package/src/api/presentation/views.ts +3 -1
- package/src/handles.ts +18 -3
- package/src/index.ts +2 -0
- package/src/massParameters.ops.ts +246 -0
- package/src/massParameters.ts +427 -0
- package/test/massParameters.test.mjs +952 -0
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
import * as z from "zod"
|
|
2
|
+
import { PluginApiReturn } from "../../types"
|
|
3
|
+
import { PluginPresentationImageFormat } from "./views"
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* The Present-mode canvas camera — the Present-mode twin of
|
|
7
|
+
* {@linkcode PluginCameraApi} (`core.camera`).
|
|
8
|
+
*
|
|
9
|
+
* Present mode lays sheets out on an infinite 2D canvas; its camera is a pan
|
|
10
|
+
* (`x`, `y`) and a `zoom`. A plugin can screenshot what that canvas currently
|
|
11
|
+
* shows, read the camera, pan/zoom it, or frame all sheets or one shape.
|
|
12
|
+
*
|
|
13
|
+
* These are transient VIEW-STATE changes: not model edits, so they are not
|
|
14
|
+
* write-gated and not undoable. Every method requires **Present mode to be
|
|
15
|
+
* open** (the documentation editor) and throws `PRECONDITION_FAILED` when it is
|
|
16
|
+
* closed. `capture` is the Present-mode counterpart of
|
|
17
|
+
* {@linkcode PluginPresentationViewsApi.capture}, which shoots the Design
|
|
18
|
+
* (3D) canvas; for whole sheets at their own size use
|
|
19
|
+
* {@linkcode PluginPresentationApi.export}.
|
|
20
|
+
*
|
|
21
|
+
* Coordinates are Present canvas page units (pixels at 100% zoom), the same
|
|
22
|
+
* space `sheets`, `placedViews` and `shapes` report positions in. `zoom` is a
|
|
23
|
+
* factor: `1` = 100%, `0.5` = zoomed out to half size.
|
|
24
|
+
*
|
|
25
|
+
* Accessed via `snaptrude.presentation.camera`.
|
|
26
|
+
*/
|
|
27
|
+
export abstract class PluginPresentationCameraApi {
|
|
28
|
+
constructor() {}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Screenshot what the Present canvas currently shows.
|
|
32
|
+
*
|
|
33
|
+
* Captures exactly the visible area — the canvas as clipped by the window,
|
|
34
|
+
* minus the strip under the floating left sidebar — at the current pan and
|
|
35
|
+
* zoom, rendered
|
|
36
|
+
* through the same pipeline as the Present-mode Export dialog, so sheets,
|
|
37
|
+
* placed views, text, annotations and imported images look as they do on
|
|
38
|
+
* screen. Selection handles, cursors and the UI itself are not part of the
|
|
39
|
+
* image. Nothing on screen still yields an image (the export backdrop).
|
|
40
|
+
* Export-pipeline details, as in the Export dialog: sheet frames themselves
|
|
41
|
+
* are not drawn (no paper, margin guides or name label — editor chrome), the
|
|
42
|
+
* backdrop is tldraw's near-white export backdrop rather than the on-screen
|
|
43
|
+
* canvas grey, and with exactly one sheet in view it is white. Only the left
|
|
44
|
+
* sidebar is subtracted from the view; floating right-hand panels are not.
|
|
45
|
+
*
|
|
46
|
+
* @param options - All optional: `format` (`"png"` default, or `"jpeg"`),
|
|
47
|
+
* `pixelRatio` (output pixels per screen pixel, `1`–`4`, default `1`;
|
|
48
|
+
* `2` for a retina-sharp image).
|
|
49
|
+
* @returns A {@linkcode PluginPresentationCameraCaptureResult}: the base64
|
|
50
|
+
* data URL and its pixel size.
|
|
51
|
+
* @throws If Present mode is not open.
|
|
52
|
+
*
|
|
53
|
+
* @examplePrompt Take a screenshot of the Present canvas
|
|
54
|
+
* @examplePrompt Capture what I am looking at in Present mode
|
|
55
|
+
* @examplePrompt Screenshot the presentation canvas as a JPEG
|
|
56
|
+
* @examplePrompt Grab a high-res image of the current sheet view
|
|
57
|
+
*
|
|
58
|
+
* # Example
|
|
59
|
+
* ```ts
|
|
60
|
+
* const { image, width, height } = await snaptrude.presentation.camera.capture({
|
|
61
|
+
* format: "png",
|
|
62
|
+
* pixelRatio: 2,
|
|
63
|
+
* })
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
public abstract capture(options?: {
|
|
67
|
+
format?: PluginPresentationImageFormat
|
|
68
|
+
pixelRatio?: number
|
|
69
|
+
}): PluginApiReturn<PluginPresentationCameraCaptureResult>
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Read the Present camera: pan, zoom, the visible page-space rectangle and
|
|
73
|
+
* the sheet under the centre of the view.
|
|
74
|
+
*
|
|
75
|
+
* @returns The current {@linkcode PluginPresentationCameraState}.
|
|
76
|
+
* @throws If Present mode is not open.
|
|
77
|
+
*
|
|
78
|
+
* @examplePrompt Where is the Present canvas camera?
|
|
79
|
+
* @examplePrompt What zoom level is Present mode at?
|
|
80
|
+
* @examplePrompt Which sheet is on screen right now?
|
|
81
|
+
* @examplePrompt Read the visible area of the presentation canvas
|
|
82
|
+
*
|
|
83
|
+
* # Example
|
|
84
|
+
* ```ts
|
|
85
|
+
* const { zoom, sheetId } = await snaptrude.presentation.camera.get()
|
|
86
|
+
* ```
|
|
87
|
+
*/
|
|
88
|
+
public abstract get(): PluginApiReturn<PluginPresentationCameraState>
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Pan and/or zoom the Present canvas. Fields left out keep their current
|
|
92
|
+
* value, so `{ zoom: 2 }` changes only the zoom (the page point at the
|
|
93
|
+
* viewport's top-left corner stays put) and `{ x, y }` pans at the current
|
|
94
|
+
* zoom. `zoom` is clamped to the editor's range (1% to 1000%); the requested
|
|
95
|
+
* `x`/`y` are always honoured. Immediate (no animation). View-state only —
|
|
96
|
+
* not undoable.
|
|
97
|
+
*
|
|
98
|
+
* `x`/`y` are the camera offset in page units: the page point that lands at
|
|
99
|
+
* the viewport's top-left corner is `(-x, -y)`. Read them back from
|
|
100
|
+
* {@linkcode PluginPresentationCameraApi.get} to reproduce a framing later.
|
|
101
|
+
*
|
|
102
|
+
* @param camera - Any of `x`, `y`, `zoom` ({@linkcode PluginPresentationCameraSetArgs}); at least one.
|
|
103
|
+
* @returns The resulting {@linkcode PluginPresentationCameraState}.
|
|
104
|
+
* @throws If Present mode is not open, or another Present-mode control has
|
|
105
|
+
* locked the camera (an open style dropdown, AI Inspiration's layout mode).
|
|
106
|
+
*
|
|
107
|
+
* @examplePrompt Zoom the Present canvas to 50%
|
|
108
|
+
* @examplePrompt Pan the presentation canvas to the right
|
|
109
|
+
* @examplePrompt Restore the Present camera I saved earlier
|
|
110
|
+
* @examplePrompt Set the Present zoom to 200% without moving
|
|
111
|
+
*
|
|
112
|
+
* # Example
|
|
113
|
+
* ```ts
|
|
114
|
+
* const saved = await snaptrude.presentation.camera.get()
|
|
115
|
+
* await snaptrude.presentation.camera.set({ zoom: 0.5 })
|
|
116
|
+
* // …later, restore the exact framing
|
|
117
|
+
* await snaptrude.presentation.camera.set({ x: saved.x, y: saved.y, zoom: saved.zoom })
|
|
118
|
+
* ```
|
|
119
|
+
*/
|
|
120
|
+
public abstract set(camera: {
|
|
121
|
+
x?: number
|
|
122
|
+
y?: number
|
|
123
|
+
zoom?: number
|
|
124
|
+
}): PluginApiReturn<PluginPresentationCameraState>
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Frame everything on the Present canvas — every sheet and loose shape — the
|
|
128
|
+
* Present-mode "zoom to fit". View-state only — not undoable.
|
|
129
|
+
*
|
|
130
|
+
* @returns The resulting {@linkcode PluginPresentationCameraState}.
|
|
131
|
+
* @throws If Present mode is not open, or the camera is locked.
|
|
132
|
+
*
|
|
133
|
+
* @examplePrompt Zoom out to see all the sheets
|
|
134
|
+
* @examplePrompt Fit the whole presentation in the Present view
|
|
135
|
+
* @examplePrompt Zoom to fit in Present mode
|
|
136
|
+
*
|
|
137
|
+
* # Example
|
|
138
|
+
* ```ts
|
|
139
|
+
* await snaptrude.presentation.camera.zoomToFit()
|
|
140
|
+
* ```
|
|
141
|
+
*/
|
|
142
|
+
public abstract zoomToFit(): PluginApiReturn<PluginPresentationCameraState>
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* Frame one shape on the Present canvas: a sheet, a placed view, a keyed
|
|
146
|
+
* shape or an annotation — any id the other `presentation` namespaces hand
|
|
147
|
+
* out. Pair with {@linkcode PluginPresentationCameraApi.capture} to
|
|
148
|
+
* screenshot a single sheet or placed view as it appears on screen.
|
|
149
|
+
* Immediate, unlike `sheets.setActive`, which animates its move over half a
|
|
150
|
+
* second. View-state only — not undoable.
|
|
151
|
+
*
|
|
152
|
+
* @param shapeId - The id of the sheet or shape to frame.
|
|
153
|
+
* @returns The resulting {@linkcode PluginPresentationCameraState}.
|
|
154
|
+
* @throws If Present mode is not open, the id is unknown, or the camera is locked.
|
|
155
|
+
*
|
|
156
|
+
* @examplePrompt Zoom in on sheet 2 in Present mode
|
|
157
|
+
* @examplePrompt Frame this placed view on the Present canvas
|
|
158
|
+
* @examplePrompt Go to the cover sheet and screenshot it
|
|
159
|
+
* @examplePrompt Centre the presentation view on that table
|
|
160
|
+
*
|
|
161
|
+
* # Example
|
|
162
|
+
* ```ts
|
|
163
|
+
* const { sheets } = await snaptrude.presentation.sheets.list()
|
|
164
|
+
* await snaptrude.presentation.camera.zoomTo(sheets[1].id)
|
|
165
|
+
* const { image } = await snaptrude.presentation.camera.capture()
|
|
166
|
+
* ```
|
|
167
|
+
*/
|
|
168
|
+
public abstract zoomTo(
|
|
169
|
+
shapeId: string,
|
|
170
|
+
): PluginApiReturn<PluginPresentationCameraState>
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* The visible area of the Present canvas in page units — the canvas as
|
|
175
|
+
* clipped by the window, minus the strip under the floating left sidebar.
|
|
176
|
+
*
|
|
177
|
+
* | Property | Type | Description |
|
|
178
|
+
* |---|---|---|
|
|
179
|
+
* | `x` | `number` | Left edge (page units) |
|
|
180
|
+
* | `y` | `number` | Top edge (page units) |
|
|
181
|
+
* | `width` | `number` | Width (page units) |
|
|
182
|
+
* | `height` | `number` | Height (page units) |
|
|
183
|
+
*/
|
|
184
|
+
export const PluginPresentationCameraViewport = z.object({
|
|
185
|
+
x: z.number().finite(),
|
|
186
|
+
y: z.number().finite(),
|
|
187
|
+
width: z.number().finite().nonnegative(),
|
|
188
|
+
height: z.number().finite().nonnegative(),
|
|
189
|
+
})
|
|
190
|
+
export type PluginPresentationCameraViewport = z.infer<
|
|
191
|
+
typeof PluginPresentationCameraViewport
|
|
192
|
+
>
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* The Present canvas camera as returned by every
|
|
196
|
+
* {@linkcode PluginPresentationCameraApi} method.
|
|
197
|
+
*
|
|
198
|
+
* | Property | Type | Description |
|
|
199
|
+
* |---|---|---|
|
|
200
|
+
* | `x` | `number` | Camera pan offset (page units): the page point at the tldraw viewport's top-left corner (under the sidebar) is `(-x, -y)` |
|
|
201
|
+
* | `y` | `number` | Camera pan offset (page units) |
|
|
202
|
+
* | `zoom` | `number` | Zoom factor, `1` = 100% |
|
|
203
|
+
* | `viewport` | {@linkcode PluginPresentationCameraViewport} | The visible page-space rectangle |
|
|
204
|
+
* | `sheetId` | `string \| null` | The sheet under the centre of the view, or `null` when none |
|
|
205
|
+
*/
|
|
206
|
+
export const PluginPresentationCameraState = z.object({
|
|
207
|
+
x: z.number().finite(),
|
|
208
|
+
y: z.number().finite(),
|
|
209
|
+
zoom: z.number().finite().positive(),
|
|
210
|
+
viewport: PluginPresentationCameraViewport,
|
|
211
|
+
sheetId: z.string().nullable(),
|
|
212
|
+
})
|
|
213
|
+
export type PluginPresentationCameraState = z.infer<
|
|
214
|
+
typeof PluginPresentationCameraState
|
|
215
|
+
>
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Arguments for {@linkcode PluginPresentationCameraApi.set}. All optional, at
|
|
219
|
+
* least one required; omitted fields keep their current value.
|
|
220
|
+
*
|
|
221
|
+
* | Property | Type | Description |
|
|
222
|
+
* |---|---|---|
|
|
223
|
+
* | `x` | `number \| undefined` | Camera pan offset (page units) |
|
|
224
|
+
* | `y` | `number \| undefined` | Camera pan offset (page units) |
|
|
225
|
+
* | `zoom` | `number \| undefined` | Zoom factor, `> 0` (`1` = 100%); clamped to the editor's range (`0.01`–`10`), `x`/`y` still honoured |
|
|
226
|
+
*/
|
|
227
|
+
export const PluginPresentationCameraSetArgs = z
|
|
228
|
+
.object({
|
|
229
|
+
x: z.number().finite().optional(),
|
|
230
|
+
y: z.number().finite().optional(),
|
|
231
|
+
zoom: z.number().finite().positive().optional(),
|
|
232
|
+
})
|
|
233
|
+
.refine(
|
|
234
|
+
(c) => c.x !== undefined || c.y !== undefined || c.zoom !== undefined,
|
|
235
|
+
{
|
|
236
|
+
message: "Pass at least one of x, y, zoom",
|
|
237
|
+
},
|
|
238
|
+
)
|
|
239
|
+
export type PluginPresentationCameraSetArgs = z.infer<
|
|
240
|
+
typeof PluginPresentationCameraSetArgs
|
|
241
|
+
>
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* Arguments for {@linkcode PluginPresentationCameraApi.zoomTo}.
|
|
245
|
+
*
|
|
246
|
+
* | Property | Type | Description |
|
|
247
|
+
* |---|---|---|
|
|
248
|
+
* | `shapeId` | `string` | The sheet or shape to frame |
|
|
249
|
+
*/
|
|
250
|
+
export const PluginPresentationCameraZoomToArgs = z.object({
|
|
251
|
+
shapeId: z.string().min(1),
|
|
252
|
+
})
|
|
253
|
+
export type PluginPresentationCameraZoomToArgs = z.infer<
|
|
254
|
+
typeof PluginPresentationCameraZoomToArgs
|
|
255
|
+
>
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* Arguments for {@linkcode PluginPresentationCameraApi.capture}. All optional.
|
|
259
|
+
*
|
|
260
|
+
* | Property | Type | Description |
|
|
261
|
+
* |---|---|---|
|
|
262
|
+
* | `format` | `"png" \| "jpeg" \| undefined` | Output image format (default `"png"`) |
|
|
263
|
+
* | `pixelRatio` | `number \| undefined` | Output pixels per screen pixel, `1`–`4` (default `1`) |
|
|
264
|
+
*/
|
|
265
|
+
export const PluginPresentationCameraCaptureArgs = z.object({
|
|
266
|
+
format: PluginPresentationImageFormat.optional(),
|
|
267
|
+
pixelRatio: z.number().finite().min(1).max(4).optional(),
|
|
268
|
+
})
|
|
269
|
+
export type PluginPresentationCameraCaptureArgs = z.infer<
|
|
270
|
+
typeof PluginPresentationCameraCaptureArgs
|
|
271
|
+
>
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Result of {@linkcode PluginPresentationCameraApi.capture}.
|
|
275
|
+
*
|
|
276
|
+
* | Property | Type | Description |
|
|
277
|
+
* |---|---|---|
|
|
278
|
+
* | `image` | `string` | The screenshot as a base64 data URL (`data:image/png;base64,…`) |
|
|
279
|
+
* | `width` | `number` | Image width in pixels |
|
|
280
|
+
* | `height` | `number` | Image height in pixels |
|
|
281
|
+
*/
|
|
282
|
+
export const PluginPresentationCameraCaptureResult = z.object({
|
|
283
|
+
image: z.string(),
|
|
284
|
+
width: z.number().int().nonnegative(),
|
|
285
|
+
height: z.number().int().nonnegative(),
|
|
286
|
+
})
|
|
287
|
+
export type PluginPresentationCameraCaptureResult = z.infer<
|
|
288
|
+
typeof PluginPresentationCameraCaptureResult
|
|
289
|
+
>
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { PluginApiReturn } from "../../types"
|
|
2
2
|
import { PluginPresentationViewsApi } from "./views"
|
|
3
|
+
import { PluginPresentationCameraApi } from "./camera"
|
|
3
4
|
import { PluginPresentationAIInspirationApi } from "./aiInspiration"
|
|
4
5
|
import { PluginPresentationSheetsApi } from "./sheets"
|
|
5
6
|
import { PluginPresentationPlacedViewsApi } from "./placedViews"
|
|
@@ -26,6 +27,7 @@ import {
|
|
|
26
27
|
* sheets, diagram placement, and import.
|
|
27
28
|
*
|
|
28
29
|
* - {@linkcode PluginPresentationApi.views} — Saved 2D/3D views (list, get, capture, activate, create)
|
|
30
|
+
* - {@linkcode PluginPresentationApi.camera} — The Present canvas camera (screenshot, pan/zoom, frame sheets)
|
|
29
31
|
* - {@linkcode PluginPresentationApi.sheets} — Layout sheets (list, get, create, place views)
|
|
30
32
|
* - {@linkcode PluginPresentationApi.placedViews} — Views already placed on the canvas (move, scale, crop)
|
|
31
33
|
* - {@linkcode PluginPresentationApi.diagrams} — Generate program/site diagram sheets, place diagram images
|
|
@@ -39,6 +41,8 @@ import {
|
|
|
39
41
|
export abstract class PluginPresentationApi {
|
|
40
42
|
/** Saved 2D/3D views. See {@linkcode PluginPresentationViewsApi}. */
|
|
41
43
|
public abstract views: PluginPresentationViewsApi
|
|
44
|
+
/** The Present canvas camera — screenshot what is on screen, read/pan/zoom it, frame sheets (Present mode). See {@linkcode PluginPresentationCameraApi}. */
|
|
45
|
+
public abstract camera: PluginPresentationCameraApi
|
|
42
46
|
/** Layout sheets — list/get/create and place views (Present mode). See {@linkcode PluginPresentationSheetsApi}. */
|
|
43
47
|
public abstract sheets: PluginPresentationSheetsApi
|
|
44
48
|
/** Placed views — layout of the view shapes on the canvas: move/scale/setScale/setCrop (Present mode). See {@linkcode PluginPresentationPlacedViewsApi}. */
|
|
@@ -100,6 +104,7 @@ export abstract class PluginPresentationApi {
|
|
|
100
104
|
}
|
|
101
105
|
|
|
102
106
|
export * from "./views"
|
|
107
|
+
export * from "./camera"
|
|
103
108
|
export * from "./sheets"
|
|
104
109
|
export * from "./placedViews"
|
|
105
110
|
export * from "./diagrams"
|
|
@@ -83,7 +83,9 @@ export abstract class PluginPresentationViewsApi {
|
|
|
83
83
|
*
|
|
84
84
|
* Captures the **current** viewport by default; pass `viewId` to capture a
|
|
85
85
|
* specific saved view (which briefly applies that view to the scene). Use
|
|
86
|
-
* `format`/`resolution` to control the output.
|
|
86
|
+
* `format`/`resolution` to control the output. This shoots the Design (3D)
|
|
87
|
+
* canvas; to screenshot the Present canvas use
|
|
88
|
+
* {@linkcode PluginPresentationCameraApi.capture}.
|
|
87
89
|
*
|
|
88
90
|
* @param options - All optional: `viewId` (capture this saved view; omit for the
|
|
89
91
|
* current viewport), `format` (default `"png"`), `resolution` (e.g. `"1280x720"`).
|
package/src/handles.ts
CHANGED
|
@@ -145,8 +145,17 @@ export type Vec3Handle = Handle<"vec3">
|
|
|
145
145
|
export type QuatHandle = Handle<"quat">
|
|
146
146
|
export type LineHandle = Handle<"line">
|
|
147
147
|
export type ArcHandle = Handle<"arc">
|
|
148
|
-
/**
|
|
149
|
-
|
|
148
|
+
/**
|
|
149
|
+
* A NURBS curve value handle (open B-spline curve). Minted by
|
|
150
|
+
* `core.geom.create.splineFromPoints` / `splineFromControlPoints`, and returned by
|
|
151
|
+
* `edge.getCurve`, `profile.listCurves` and `update.curve.reverse` for a spline run;
|
|
152
|
+
* accepted everywhere a {@linkcode CurveHandle} is (profileFromCurves, query.curve.*).
|
|
153
|
+
* Closed spline loops never exist as a single handle — a closed run is built
|
|
154
|
+
* directly as a profile via `core.geom.create.profileFromSplinePoints`.
|
|
155
|
+
*/
|
|
156
|
+
export type SplineHandle = Handle<"spline">
|
|
157
|
+
/** A curve is a line, an arc, or a spline — its handle is one of those kinds. */
|
|
158
|
+
export type CurveHandle = LineHandle | ArcHandle | SplineHandle
|
|
150
159
|
/**
|
|
151
160
|
* A circle value handle. A circle is a CLOSED curve — it deliberately does NOT
|
|
152
161
|
* join {@linkcode CurveHandle} (it has no stable start/end and would break the
|
|
@@ -262,7 +271,13 @@ export const Vec3Handle = handleSchema("vec3")
|
|
|
262
271
|
export const QuatHandle = handleSchema("quat")
|
|
263
272
|
export const LineHandle = handleSchema("line")
|
|
264
273
|
export const ArcHandle = handleSchema("arc")
|
|
265
|
-
export const
|
|
274
|
+
export const SplineHandle = handleSchema("spline")
|
|
275
|
+
// Explicitly typed (rather than inferred): the inferred union type prints its
|
|
276
|
+
// three fully-expanded member schemas into handles.d.ts, which is served to
|
|
277
|
+
// agents whole and has a size budget. ZodUnion (not ZodType) keeps `.options`.
|
|
278
|
+
export const CurveHandle: z.ZodUnion<
|
|
279
|
+
readonly [typeof LineHandle, typeof ArcHandle, typeof SplineHandle]
|
|
280
|
+
> = z.union([LineHandle, ArcHandle, SplineHandle])
|
|
266
281
|
export const CircleHandle = handleSchema("circle")
|
|
267
282
|
|
|
268
283
|
// BREP topology handle schemas (§2A.2.1). Prefix-shape validation only; existence,
|
package/src/index.ts
CHANGED
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
import * as z from "zod"
|
|
2
|
+
import {
|
|
3
|
+
ContourRecord,
|
|
4
|
+
CurveRecord,
|
|
5
|
+
LoftOptions,
|
|
6
|
+
MAX_LOFT_SECTIONS,
|
|
7
|
+
MAX_PATH_CURVES,
|
|
8
|
+
MAX_SWEEP_PATH_POINTS,
|
|
9
|
+
SweepAlongCurveRecordOptions,
|
|
10
|
+
SweepOptions,
|
|
11
|
+
XYZ,
|
|
12
|
+
} from "./massParameters"
|
|
13
|
+
import type { CurveKind, SurfaceKind } from "./massParameters"
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* The **operation half** of a mass creation-parameter record: which edge or
|
|
17
|
+
* face of the recipe's solid a kernel step used, the step itself, and the
|
|
18
|
+
* values a `design.update.parameters` patch may carry.
|
|
19
|
+
*
|
|
20
|
+
* Split out of `massParameters.ts` so that each file stays under the size limit
|
|
21
|
+
* at which the agent runtime still serves a type module in ONE whole read (the
|
|
22
|
+
* record module alone had grown past it). Do not merge the two back. It is
|
|
23
|
+
* re-exported from there and from the package root, so every import path keeps
|
|
24
|
+
* working.
|
|
25
|
+
*
|
|
26
|
+
* Everything here is **pure JSON** by construction, exactly as in
|
|
27
|
+
* {@linkcode MassParametersRecord}: plain objects, numbers and arrays only, one
|
|
28
|
+
* `{x, y, z}` point shape, no class instances.
|
|
29
|
+
*/
|
|
30
|
+
|
|
31
|
+
/** Maximum kernel operations chained onto one recipe. */
|
|
32
|
+
export const MAX_OPERATIONS = 8
|
|
33
|
+
/** Maximum edges one fillet/chamfer operation may select. */
|
|
34
|
+
export const MAX_OPERATION_EDGES = 64
|
|
35
|
+
/** Maximum faces one shell operation may open. */
|
|
36
|
+
export const MAX_OPERATION_FACES = 32
|
|
37
|
+
/** Maximum rows in a variable-fillet radius law. */
|
|
38
|
+
export const MAX_FILLET_LAW_SAMPLES = 32
|
|
39
|
+
|
|
40
|
+
// `XYZ` and the record schemas below are resolved through `z.lazy`: this module
|
|
41
|
+
// and `massParameters.ts` re-export each other, and this one is evaluated first,
|
|
42
|
+
// so their consts are not yet initialised while these schemas are built. The
|
|
43
|
+
// closures run at parse time, when both modules are live.
|
|
44
|
+
const At: z.ZodType<XYZ, XYZ> = z.lazy(() => XYZ)
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Which EDGE of the input solid an operation used: its index in
|
|
48
|
+
* `core.geom.query.brep.listEdges` order at authoring time, the indices of the
|
|
49
|
+
* two faces it lies between, and its curve kind. This is topology, not
|
|
50
|
+
* coordinates — it survives a scalar edit of the base recipe (which moves every
|
|
51
|
+
* edge) and trips on a reorder or a topology change. Read-only: to blend a
|
|
52
|
+
* different edge, re-select it on the new shape and re-apply the operation.
|
|
53
|
+
*/
|
|
54
|
+
export type EdgeSelector = {
|
|
55
|
+
index: number
|
|
56
|
+
faces: [number, number]
|
|
57
|
+
curve: CurveKind
|
|
58
|
+
/** Where the edge sits INSIDE its solid: its midpoint in the record's own
|
|
59
|
+
* frame, divided by the solid's bounding-box extent — a ratio per axis,
|
|
60
|
+
* never a length, so it survives a scalar edit that scales the whole shape.
|
|
61
|
+
* Written only when the discriminators above cannot tell two edges apart. A
|
|
62
|
+
* tiebreak, never a coordinate fingerprint: a replay checks it within 0.02 of
|
|
63
|
+
* the solid's own box and refuses on a miss — it never searches for a better
|
|
64
|
+
* candidate. */
|
|
65
|
+
at?: XYZ
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Which FACE of the input solid an operation used: its index in
|
|
70
|
+
* `core.geom.query.brep.listFaces` order, its surface kind, and the number of
|
|
71
|
+
* edges in its outer loop. Read-only, like {@linkcode EdgeSelector}.
|
|
72
|
+
*/
|
|
73
|
+
export type FaceSelector = {
|
|
74
|
+
index: number
|
|
75
|
+
kind: SurfaceKind
|
|
76
|
+
edgeCount: number
|
|
77
|
+
/** The face's centroid under the same normalisation and the same tiebreak
|
|
78
|
+
* rule as {@linkcode EdgeSelector}'s `at` — written only where the
|
|
79
|
+
* discriminators above cannot separate two faces, which on a freeform solid
|
|
80
|
+
* (every face answers `"spline"`) is the common case. */
|
|
81
|
+
at?: XYZ
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/** The input solid's topology at authoring time — the counts a replay checks first. */
|
|
85
|
+
export type TopologyCounts = { faceCount: number; edgeCount: number }
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* One kernel operation applied to the base recipe's solid, in order. `input`
|
|
89
|
+
* pins the topology the operation was authored against, so a base edit that
|
|
90
|
+
* changes the topology is refused rather than mis-applied.
|
|
91
|
+
*
|
|
92
|
+
* Edit one by patching the whole list back:
|
|
93
|
+
* `design.update.parameters(mass, { operations })`.
|
|
94
|
+
*/
|
|
95
|
+
export type OperationRecord =
|
|
96
|
+
| {
|
|
97
|
+
op: "fillet"
|
|
98
|
+
edges: EdgeSelector[]
|
|
99
|
+
radius: number
|
|
100
|
+
/** Radius at the far end of the blend contour, internal length units — a
|
|
101
|
+
* linear variable blend from `radius`. One edge, and never with `radii`. */
|
|
102
|
+
endRadius?: number
|
|
103
|
+
/** The blend's radius law instead: `position` is normalised arc length
|
|
104
|
+
* along the blend contour (a ratio 0..1, never converted), `radius` is
|
|
105
|
+
* internal length units. 2..32 rows, strictly increasing `position`.
|
|
106
|
+
* One edge, and never with `endRadius`. */
|
|
107
|
+
radii?: { position: number; radius: number }[]
|
|
108
|
+
input: TopologyCounts
|
|
109
|
+
}
|
|
110
|
+
| { op: "chamfer"; edges: EdgeSelector[]; distance: number; input: TopologyCounts }
|
|
111
|
+
| { op: "shell"; openFaces: FaceSelector[]; thickness: number; input: TopologyCounts }
|
|
112
|
+
| { op: "offset"; distance: number; input: TopologyCounts }
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* One value of a `MassParametersPatch` — whatever a record's `values` key (or
|
|
116
|
+
* `operations`) may hold. Each key you send replaces that value whole — a
|
|
117
|
+
* scalar, a point, a list or a record (`contour`, `profile`, `sections`,
|
|
118
|
+
* `path`, `options`, `operations`) alike — so send the complete value you read.
|
|
119
|
+
*/
|
|
120
|
+
export type ParameterPatchValue =
|
|
121
|
+
| number
|
|
122
|
+
| XYZ
|
|
123
|
+
| XYZ[]
|
|
124
|
+
| ContourRecord
|
|
125
|
+
| ContourRecord[]
|
|
126
|
+
| CurveRecord[]
|
|
127
|
+
| LoftOptions
|
|
128
|
+
| SweepOptions
|
|
129
|
+
| SweepAlongCurveRecordOptions
|
|
130
|
+
| OperationRecord[]
|
|
131
|
+
|
|
132
|
+
const FaceIndex = z.number().int().nonnegative()
|
|
133
|
+
|
|
134
|
+
/** See {@linkcode EdgeSelector}. */
|
|
135
|
+
export const EdgeSelector: z.ZodType<EdgeSelector, EdgeSelector> = z.strictObject({
|
|
136
|
+
index: FaceIndex,
|
|
137
|
+
faces: z.tuple([FaceIndex, FaceIndex]),
|
|
138
|
+
curve: z.enum(["line", "arc", "circle", "spline"]),
|
|
139
|
+
at: At.optional(),
|
|
140
|
+
})
|
|
141
|
+
|
|
142
|
+
/** See {@linkcode FaceSelector}. */
|
|
143
|
+
export const FaceSelector: z.ZodType<FaceSelector, FaceSelector> = z.strictObject({
|
|
144
|
+
index: FaceIndex,
|
|
145
|
+
kind: z.enum(["plane", "cylinder", "cone", "sphere", "torus", "spline"]),
|
|
146
|
+
edgeCount: z.number().int().positive(),
|
|
147
|
+
at: At.optional(),
|
|
148
|
+
})
|
|
149
|
+
|
|
150
|
+
/** See {@linkcode TopologyCounts}. */
|
|
151
|
+
export const TopologyCounts: z.ZodType<TopologyCounts, TopologyCounts> = z.strictObject({
|
|
152
|
+
faceCount: z.number().int().positive(),
|
|
153
|
+
edgeCount: z.number().int().positive(),
|
|
154
|
+
})
|
|
155
|
+
|
|
156
|
+
/** One row of a variable fillet's radius law. See {@linkcode OperationRecord}. */
|
|
157
|
+
const FilletLawRow = z.strictObject({
|
|
158
|
+
position: z.number().finite().min(0).max(1),
|
|
159
|
+
radius: z.number().finite().positive(),
|
|
160
|
+
})
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* See {@linkcode OperationRecord}.
|
|
164
|
+
*
|
|
165
|
+
* A variable fillet — `endRadius` or `radii` — names ONE edge: the law is a
|
|
166
|
+
* property of the blend contour that edge belongs to, and `position` is measured
|
|
167
|
+
* from that edge's start, so a second edge would have no origin. The two forms
|
|
168
|
+
* are mutually exclusive and `radii` rows run strictly forward.
|
|
169
|
+
*/
|
|
170
|
+
export const OperationRecord: z.ZodType<OperationRecord, OperationRecord> = z
|
|
171
|
+
.discriminatedUnion("op", [
|
|
172
|
+
z.strictObject({
|
|
173
|
+
op: z.literal("fillet"),
|
|
174
|
+
edges: z.array(EdgeSelector).min(1).max(MAX_OPERATION_EDGES),
|
|
175
|
+
radius: z.number().finite().positive(),
|
|
176
|
+
endRadius: z.number().finite().positive().optional(),
|
|
177
|
+
radii: z.array(FilletLawRow).min(2).max(MAX_FILLET_LAW_SAMPLES).optional(),
|
|
178
|
+
input: TopologyCounts,
|
|
179
|
+
}),
|
|
180
|
+
z.strictObject({
|
|
181
|
+
op: z.literal("chamfer"),
|
|
182
|
+
edges: z.array(EdgeSelector).min(1).max(MAX_OPERATION_EDGES),
|
|
183
|
+
distance: z.number().finite().positive(),
|
|
184
|
+
input: TopologyCounts,
|
|
185
|
+
}),
|
|
186
|
+
z.strictObject({
|
|
187
|
+
op: z.literal("shell"),
|
|
188
|
+
openFaces: z.array(FaceSelector).min(1).max(MAX_OPERATION_FACES),
|
|
189
|
+
thickness: z.number().finite().positive(),
|
|
190
|
+
input: TopologyCounts,
|
|
191
|
+
}),
|
|
192
|
+
z.strictObject({
|
|
193
|
+
op: z.literal("offset"),
|
|
194
|
+
distance: z
|
|
195
|
+
.number()
|
|
196
|
+
.finite()
|
|
197
|
+
.refine((value) => value !== 0, { message: "distance must be non-zero" }),
|
|
198
|
+
input: TopologyCounts,
|
|
199
|
+
}),
|
|
200
|
+
])
|
|
201
|
+
.superRefine((operation, ctx) => {
|
|
202
|
+
if (operation.op !== "fillet") return
|
|
203
|
+
const { edges, endRadius, radii } = operation
|
|
204
|
+
if (endRadius === undefined && radii === undefined) return
|
|
205
|
+
if (endRadius !== undefined && radii !== undefined) {
|
|
206
|
+
ctx.addIssue({
|
|
207
|
+
code: "custom",
|
|
208
|
+
message: "endRadius is mutually exclusive with radii",
|
|
209
|
+
})
|
|
210
|
+
}
|
|
211
|
+
if (edges.length !== 1) {
|
|
212
|
+
ctx.addIssue({
|
|
213
|
+
code: "custom",
|
|
214
|
+
message: "a variable fillet names exactly one edge — the blend contour it runs along",
|
|
215
|
+
})
|
|
216
|
+
}
|
|
217
|
+
if (radii?.some((row, i) => i > 0 && row.position <= radii[i - 1].position)) {
|
|
218
|
+
ctx.addIssue({
|
|
219
|
+
code: "custom",
|
|
220
|
+
message: "radii positions must strictly increase",
|
|
221
|
+
})
|
|
222
|
+
}
|
|
223
|
+
})
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* One value of a parameter patch. See {@linkcode ParameterPatchValue}.
|
|
227
|
+
*
|
|
228
|
+
* Deliberately a CLOSED union of the shapes a record's `values` actually hold —
|
|
229
|
+
* no `z.unknown()`, nothing recursive: an unrecognised value is a VALIDATION at
|
|
230
|
+
* the wire, not a silent write of nonsense onto a mass. It only ever widens, so
|
|
231
|
+
* every value it accepted before it still accepts.
|
|
232
|
+
*/
|
|
233
|
+
export const ParameterPatchValue: z.ZodType<ParameterPatchValue, ParameterPatchValue> = z.lazy(() =>
|
|
234
|
+
z.union([
|
|
235
|
+
z.number().finite(),
|
|
236
|
+
XYZ,
|
|
237
|
+
z.array(XYZ).max(MAX_SWEEP_PATH_POINTS),
|
|
238
|
+
ContourRecord,
|
|
239
|
+
z.array(ContourRecord).max(MAX_LOFT_SECTIONS),
|
|
240
|
+
z.array(CurveRecord).max(MAX_PATH_CURVES),
|
|
241
|
+
LoftOptions,
|
|
242
|
+
SweepOptions,
|
|
243
|
+
SweepAlongCurveRecordOptions,
|
|
244
|
+
z.array(OperationRecord).max(MAX_OPERATIONS),
|
|
245
|
+
]),
|
|
246
|
+
)
|