@snaptrude/plugin-core 0.7.1 → 0.8.0
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 +14 -0
- package/api-manifest.full.json +6442 -0
- package/api-manifest.json +2029 -128
- package/dist/api/core/camera/index.d.ts +208 -0
- package/dist/api/core/camera/index.d.ts.map +1 -0
- package/dist/api/core/comment/index.d.ts +105 -2
- package/dist/api/core/comment/index.d.ts.map +1 -1
- package/dist/api/core/geom/create/index.d.ts +13 -13
- package/dist/api/core/geom/delete/index.d.ts +8 -2
- package/dist/api/core/geom/delete/index.d.ts.map +1 -1
- package/dist/api/core/geom/query/arc.d.ts +5 -5
- package/dist/api/core/geom/query/brep.d.ts +18 -18
- package/dist/api/core/geom/query/circle.d.ts +18 -18
- package/dist/api/core/geom/query/contour.d.ts +20 -20
- package/dist/api/core/geom/query/curve.d.ts +49 -49
- package/dist/api/core/geom/query/edge.d.ts +5 -5
- package/dist/api/core/geom/query/face.d.ts +16 -16
- package/dist/api/core/geom/query/halfedge.d.ts +8 -8
- package/dist/api/core/geom/query/profile.d.ts +19 -19
- package/dist/api/core/geom/query/vertex.d.ts +8 -8
- package/dist/api/core/geom/update/contour.d.ts +14 -14
- package/dist/api/core/geom/update/curve.d.ts +7 -7
- package/dist/api/core/geom/update/profile.d.ts +16 -16
- package/dist/api/core/handles/index.d.ts +210 -0
- package/dist/api/core/handles/index.d.ts.map +1 -0
- package/dist/api/core/index.d.ts +15 -0
- package/dist/api/core/index.d.ts.map +1 -1
- package/dist/api/core/io/export/index.d.ts +132 -0
- package/dist/api/core/io/export/index.d.ts.map +1 -0
- package/dist/api/core/io/import/index.d.ts +1 -1
- package/dist/api/core/io/index.d.ts +5 -0
- package/dist/api/core/io/index.d.ts.map +1 -1
- package/dist/api/core/layers.d.ts +7 -7
- package/dist/api/core/proposals/index.d.ts +65 -9
- package/dist/api/core/proposals/index.d.ts.map +1 -1
- package/dist/api/core/user.d.ts +44 -0
- package/dist/api/core/user.d.ts.map +1 -0
- package/dist/api/design/boolean/index.d.ts +4 -4
- package/dist/api/design/create/index.d.ts +139 -44
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/doors/index.d.ts +36 -0
- package/dist/api/design/doors/index.d.ts.map +1 -1
- package/dist/api/design/edit/index.d.ts +1 -1
- package/dist/api/design/erase/index.d.ts +2 -2
- package/dist/api/design/furniture/index.d.ts +114 -3
- package/dist/api/design/furniture/index.d.ts.map +1 -1
- package/dist/api/design/index.d.ts +10 -0
- package/dist/api/design/index.d.ts.map +1 -1
- package/dist/api/design/materials/index.d.ts +111 -14
- package/dist/api/design/materials/index.d.ts.map +1 -1
- package/dist/api/design/query/index.d.ts +31 -1
- 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/transform/index.d.ts +83 -14
- package/dist/api/design/transform/index.d.ts.map +1 -1
- package/dist/api/design/types/index.d.ts +181 -0
- package/dist/api/design/types/index.d.ts.map +1 -0
- package/dist/api/design/update/index.d.ts +335 -2
- package/dist/api/design/update/index.d.ts.map +1 -1
- package/dist/api/design/visibility.d.ts +98 -0
- package/dist/api/design/visibility.d.ts.map +1 -0
- package/dist/api/entity/referenceLine.d.ts +2 -2
- package/dist/api/entity/space.d.ts +19 -19
- package/dist/api/entity/story.d.ts +128 -15
- package/dist/api/entity/story.d.ts.map +1 -1
- package/dist/api/presentation/annotate.d.ts +448 -0
- package/dist/api/presentation/annotate.d.ts.map +1 -0
- package/dist/api/presentation/diagrams.d.ts +49 -8
- package/dist/api/presentation/diagrams.d.ts.map +1 -1
- package/dist/api/presentation/export.d.ts +104 -0
- package/dist/api/presentation/export.d.ts.map +1 -0
- package/dist/api/presentation/index.d.ts +38 -0
- package/dist/api/presentation/index.d.ts.map +1 -1
- package/dist/api/presentation/sheets.d.ts +410 -13
- package/dist/api/presentation/sheets.d.ts.map +1 -1
- package/dist/api/presentation/views.d.ts +165 -10
- package/dist/api/presentation/views.d.ts.map +1 -1
- package/dist/api/program/areas.d.ts +63 -3
- package/dist/api/program/areas.d.ts.map +1 -1
- package/dist/api/program/cores.d.ts +3 -99
- package/dist/api/program/cores.d.ts.map +1 -1
- package/dist/api/program/index.d.ts +2 -2
- package/dist/api/program/index.d.ts.map +1 -1
- package/dist/api/program/layout.d.ts +172 -12
- package/dist/api/program/layout.d.ts.map +1 -1
- package/dist/api/program/site.d.ts +11 -8
- package/dist/api/program/site.d.ts.map +1 -1
- package/dist/api/program/spreadsheet.d.ts +105 -13
- package/dist/api/program/spreadsheet.d.ts.map +1 -1
- package/dist/handles.d.ts +64 -25
- package/dist/handles.d.ts.map +1 -1
- package/dist/index.cjs +2316 -1644
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +2224 -1639
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/api/core/camera/index.ts +212 -0
- package/src/api/core/comment/index.ts +120 -2
- package/src/api/core/geom/delete/index.ts +6 -0
- package/src/api/core/handles/index.ts +233 -0
- package/src/api/core/index.ts +15 -0
- package/src/api/core/io/export/index.ts +124 -0
- package/src/api/core/io/index.ts +5 -0
- package/src/api/core/proposals/index.ts +71 -11
- package/src/api/core/user.ts +46 -0
- package/src/api/design/create/index.ts +166 -36
- package/src/api/design/doors/index.ts +40 -0
- package/src/api/design/furniture/index.ts +127 -3
- package/src/api/design/index.ts +10 -0
- package/src/api/design/materials/index.ts +157 -30
- package/src/api/design/query/index.ts +33 -7
- package/src/api/design/transform/index.ts +89 -12
- package/src/api/design/types/index.ts +156 -0
- package/src/api/design/update/index.ts +402 -6
- package/src/api/design/visibility.ts +109 -0
- package/src/api/entity/story.ts +141 -15
- package/src/api/presentation/annotate.ts +360 -0
- package/src/api/presentation/diagrams.ts +53 -8
- package/src/api/presentation/export.ts +104 -0
- package/src/api/presentation/index.ts +46 -0
- package/src/api/presentation/sheets.ts +346 -13
- package/src/api/presentation/views.ts +164 -12
- package/src/api/program/areas.ts +57 -6
- package/src/api/program/cores.ts +3 -91
- package/src/api/program/index.ts +2 -2
- package/src/api/program/layout.ts +182 -12
- package/src/api/program/site.ts +11 -8
- package/src/api/program/spreadsheet.ts +125 -29
- package/src/handles.ts +77 -13
- package/tsconfig.json +7 -2
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
import { PluginApiReturn } from "../../../types";
|
|
3
|
+
import { Vec3Handle } from "../../../handles";
|
|
4
|
+
/**
|
|
5
|
+
* Camera controls.
|
|
6
|
+
*
|
|
7
|
+
* Position the viewport camera, snap it to a standard orthographic/isometric
|
|
8
|
+
* view, and toggle between the 2D (plan) and 3D modelling modes — mirrors the
|
|
9
|
+
* canvas view menu and the 2D/3D toggle. Like {@linkcode PluginZoomApi}, these
|
|
10
|
+
* are transient VIEW-STATE changes: they are not model edits, so they are not
|
|
11
|
+
* write-gated and are not undoable. Accessed via `snaptrude.core.camera`.
|
|
12
|
+
*/
|
|
13
|
+
export declare abstract class PluginCameraApi {
|
|
14
|
+
constructor();
|
|
15
|
+
/**
|
|
16
|
+
* Point the camera: place its eye at `eye` looking toward `target` (world
|
|
17
|
+
* coordinates, internal `babylon` units). View-state only — not undoable.
|
|
18
|
+
*
|
|
19
|
+
* @param eye - Camera position as a {@linkcode Vec3Handle}
|
|
20
|
+
* @param target - Point the camera looks at as a {@linkcode Vec3Handle}
|
|
21
|
+
* @returns `true` once the camera has been positioned.
|
|
22
|
+
*
|
|
23
|
+
* @examplePrompt Look at the model from above the north-east corner
|
|
24
|
+
* @examplePrompt Position the camera at (50, 30, 50) looking at the origin
|
|
25
|
+
* @examplePrompt Point the camera at the centre of the building from the side
|
|
26
|
+
* @examplePrompt Set the eye to this point and aim it at that point
|
|
27
|
+
*
|
|
28
|
+
* # Example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const { vec3 } = snaptrude.core.math
|
|
31
|
+
* await snaptrude.core.camera.lookFrom(vec3.new(50, 30, 50), vec3.new(0, 0, 0))
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
abstract lookFrom(eye: Vec3Handle, target: Vec3Handle): PluginApiReturn<boolean>;
|
|
35
|
+
/**
|
|
36
|
+
* Snap the camera to a standard view — the five orthographic elevations
|
|
37
|
+
* (`top` / `front` / `back` / `left` / `right`) or the 3D `iso` (isometric
|
|
38
|
+
* perspective) view. Mirrors the canvas view menu. View-state only — not
|
|
39
|
+
* undoable. The orthographic presets exit 2D mode first if needed.
|
|
40
|
+
*
|
|
41
|
+
* @param view - The standard view to snap to ({@linkcode PluginStandardView})
|
|
42
|
+
* @returns `true` once the view has been applied.
|
|
43
|
+
*
|
|
44
|
+
* @examplePrompt Switch to the top view
|
|
45
|
+
* @examplePrompt Show me the front elevation
|
|
46
|
+
* @examplePrompt Go to the isometric view
|
|
47
|
+
* @examplePrompt Look at the model from the left
|
|
48
|
+
* @examplePrompt Give me a plan view from the top
|
|
49
|
+
*
|
|
50
|
+
* # Example
|
|
51
|
+
* ```ts
|
|
52
|
+
* await snaptrude.core.camera.setStandardView("top")
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
abstract setStandardView(view: PluginStandardView): PluginApiReturn<boolean>;
|
|
56
|
+
/**
|
|
57
|
+
* Toggle the modelling mode between `2d` (plan) and `3d`. Mirrors the canvas
|
|
58
|
+
* 2D/3D toggle: `3d` enters the isometric perspective view, `2d` drops to the
|
|
59
|
+
* orthographic plan of the active storey. View-state only — not undoable.
|
|
60
|
+
*
|
|
61
|
+
* @param mode - `"2d"` or `"3d"` ({@linkcode PluginCameraMode})
|
|
62
|
+
* @returns `true` once the mode switch has been requested.
|
|
63
|
+
*
|
|
64
|
+
* @examplePrompt Switch to 3D view
|
|
65
|
+
* @examplePrompt Drop into 2D plan mode
|
|
66
|
+
* @examplePrompt Go back to 3D
|
|
67
|
+
* @examplePrompt Show the floor plan in 2D
|
|
68
|
+
*
|
|
69
|
+
* # Example
|
|
70
|
+
* ```ts
|
|
71
|
+
* await snaptrude.core.camera.setMode("3d")
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
abstract setMode(mode: PluginCameraMode): PluginApiReturn<boolean>;
|
|
75
|
+
/**
|
|
76
|
+
* Read the camera's current projection: `"perspective"` (the default 3D
|
|
77
|
+
* view) or `"orthographic"`. In 2D (plan) mode this always reports
|
|
78
|
+
* `"orthographic"` — a plan is an orthographic projection.
|
|
79
|
+
*
|
|
80
|
+
* @returns The current {@linkcode PluginCameraProjection}.
|
|
81
|
+
*
|
|
82
|
+
* @examplePrompt Is the camera in perspective or orthographic?
|
|
83
|
+
* @examplePrompt What projection is the 3D view using?
|
|
84
|
+
* @examplePrompt Check whether perspective is on
|
|
85
|
+
*
|
|
86
|
+
* # Example
|
|
87
|
+
* ```ts
|
|
88
|
+
* const projection = await snaptrude.core.camera.getProjection()
|
|
89
|
+
* console.log(projection) // "perspective" | "orthographic"
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
abstract getProjection(): PluginApiReturn<PluginCameraProjection>;
|
|
93
|
+
/**
|
|
94
|
+
* Switch the 3D camera between `"perspective"` and `"orthographic"`
|
|
95
|
+
* projection — the Perspective/Orthographic control in the Design tab's
|
|
96
|
+
* View Settings panel. Like {@linkcode PluginCameraApi.setMode}, this is a
|
|
97
|
+
* transient view-state change: not write-gated, not undoable.
|
|
98
|
+
*
|
|
99
|
+
* In 2D (plan) mode the canvas is always an orthographic plan:
|
|
100
|
+
* `"orthographic"` is accepted as a no-op, while `"perspective"` is
|
|
101
|
+
* rejected — switch to 3D first via `setMode("3d")`.
|
|
102
|
+
*
|
|
103
|
+
* @param projection - `"perspective"` or `"orthographic"` ({@linkcode PluginCameraProjection})
|
|
104
|
+
* @returns `true` once the projection has been applied.
|
|
105
|
+
*
|
|
106
|
+
* @examplePrompt Switch the camera to orthographic
|
|
107
|
+
* @examplePrompt Turn perspective off
|
|
108
|
+
* @examplePrompt Give me a perspective view of the model
|
|
109
|
+
* @examplePrompt Make the 3D view orthographic like an axonometric drawing
|
|
110
|
+
*
|
|
111
|
+
* # Example
|
|
112
|
+
* ```ts
|
|
113
|
+
* await snaptrude.core.camera.setProjection("orthographic")
|
|
114
|
+
* const projection = await snaptrude.core.camera.getProjection() // "orthographic"
|
|
115
|
+
* ```
|
|
116
|
+
*/
|
|
117
|
+
abstract setProjection(projection: PluginCameraProjection): PluginApiReturn<boolean>;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* A standard camera view: the five orthographic elevations (`top`/`front`/
|
|
121
|
+
* `back`/`left`/`right`) or the 3D isometric perspective (`iso`).
|
|
122
|
+
*/
|
|
123
|
+
export declare const PluginStandardView: z.ZodEnum<{
|
|
124
|
+
top: "top";
|
|
125
|
+
front: "front";
|
|
126
|
+
back: "back";
|
|
127
|
+
left: "left";
|
|
128
|
+
right: "right";
|
|
129
|
+
iso: "iso";
|
|
130
|
+
}>;
|
|
131
|
+
export type PluginStandardView = z.infer<typeof PluginStandardView>;
|
|
132
|
+
/**
|
|
133
|
+
* The modelling mode: `2d` (orthographic plan) or `3d` (isometric perspective).
|
|
134
|
+
*/
|
|
135
|
+
export declare const PluginCameraMode: z.ZodEnum<{
|
|
136
|
+
"2d": "2d";
|
|
137
|
+
"3d": "3d";
|
|
138
|
+
}>;
|
|
139
|
+
export type PluginCameraMode = z.infer<typeof PluginCameraMode>;
|
|
140
|
+
/**
|
|
141
|
+
* The 3D camera projection: `perspective` (the default) or `orthographic` —
|
|
142
|
+
* the Perspective/Orthographic control in the Design tab's View Settings panel.
|
|
143
|
+
*/
|
|
144
|
+
export declare const PluginCameraProjection: z.ZodEnum<{
|
|
145
|
+
perspective: "perspective";
|
|
146
|
+
orthographic: "orthographic";
|
|
147
|
+
}>;
|
|
148
|
+
export type PluginCameraProjection = z.infer<typeof PluginCameraProjection>;
|
|
149
|
+
/**
|
|
150
|
+
* Arguments for {@linkcode PluginCameraApi.lookFrom}.
|
|
151
|
+
*
|
|
152
|
+
* | Property | Type | Description |
|
|
153
|
+
* |---|---|---|
|
|
154
|
+
* | `eye` | {@linkcode Vec3Handle} | Camera position (world, `babylon` units) |
|
|
155
|
+
* | `target` | {@linkcode Vec3Handle} | Point the camera looks at |
|
|
156
|
+
*/
|
|
157
|
+
export declare const PluginCameraLookFromArgs: z.ZodObject<{
|
|
158
|
+
eye: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
|
|
159
|
+
target: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
|
|
160
|
+
}, z.core.$strip>;
|
|
161
|
+
export type PluginCameraLookFromArgs = z.infer<typeof PluginCameraLookFromArgs>;
|
|
162
|
+
/**
|
|
163
|
+
* Arguments for {@linkcode PluginCameraApi.setStandardView}.
|
|
164
|
+
*
|
|
165
|
+
* | Property | Type | Description |
|
|
166
|
+
* |---|---|---|
|
|
167
|
+
* | `view` | {@linkcode PluginStandardView} | The standard view to snap to |
|
|
168
|
+
*/
|
|
169
|
+
export declare const PluginCameraSetStandardViewArgs: z.ZodObject<{
|
|
170
|
+
view: z.ZodEnum<{
|
|
171
|
+
top: "top";
|
|
172
|
+
front: "front";
|
|
173
|
+
back: "back";
|
|
174
|
+
left: "left";
|
|
175
|
+
right: "right";
|
|
176
|
+
iso: "iso";
|
|
177
|
+
}>;
|
|
178
|
+
}, z.core.$strip>;
|
|
179
|
+
export type PluginCameraSetStandardViewArgs = z.infer<typeof PluginCameraSetStandardViewArgs>;
|
|
180
|
+
/**
|
|
181
|
+
* Arguments for {@linkcode PluginCameraApi.setMode}.
|
|
182
|
+
*
|
|
183
|
+
* | Property | Type | Description |
|
|
184
|
+
* |---|---|---|
|
|
185
|
+
* | `mode` | {@linkcode PluginCameraMode} | `"2d"` or `"3d"` |
|
|
186
|
+
*/
|
|
187
|
+
export declare const PluginCameraSetModeArgs: z.ZodObject<{
|
|
188
|
+
mode: z.ZodEnum<{
|
|
189
|
+
"2d": "2d";
|
|
190
|
+
"3d": "3d";
|
|
191
|
+
}>;
|
|
192
|
+
}, z.core.$strip>;
|
|
193
|
+
export type PluginCameraSetModeArgs = z.infer<typeof PluginCameraSetModeArgs>;
|
|
194
|
+
/**
|
|
195
|
+
* Arguments for {@linkcode PluginCameraApi.setProjection}.
|
|
196
|
+
*
|
|
197
|
+
* | Property | Type | Description |
|
|
198
|
+
* |---|---|---|
|
|
199
|
+
* | `projection` | {@linkcode PluginCameraProjection} | `"perspective"` or `"orthographic"` |
|
|
200
|
+
*/
|
|
201
|
+
export declare const PluginCameraSetProjectionArgs: z.ZodObject<{
|
|
202
|
+
projection: z.ZodEnum<{
|
|
203
|
+
perspective: "perspective";
|
|
204
|
+
orthographic: "orthographic";
|
|
205
|
+
}>;
|
|
206
|
+
}, z.core.$strip>;
|
|
207
|
+
export type PluginCameraSetProjectionArgs = z.infer<typeof PluginCameraSetProjectionArgs>;
|
|
208
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/camera/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C;;;;;;;;GAQG;AACH,8BAAsB,eAAe;;IAGnC;;;;;;;;;;;;;;;;;;OAkBG;aACa,QAAQ,CACtB,GAAG,EAAE,UAAU,EACf,MAAM,EAAE,UAAU,GACjB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;OAmBG;aACa,eAAe,CAC7B,IAAI,EAAE,kBAAkB,GACvB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;OAiBG;aACa,OAAO,CAAC,IAAI,EAAE,gBAAgB,GAAG,eAAe,CAAC,OAAO,CAAC;IAEzE;;;;;;;;;;;;;;;;OAgBG;aACa,aAAa,IAAI,eAAe,CAAC,sBAAsB,CAAC;IAExE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,aAAa,CAC3B,UAAU,EAAE,sBAAsB,GACjC,eAAe,CAAC,OAAO,CAAC;CAC5B;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;EAO7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;EAAuB,CAAA;AACpD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;EAA0C,CAAA;AAC7E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;iBAElC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;;;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as z from "zod";
|
|
2
2
|
import { PluginApiReturn } from "../../../types";
|
|
3
|
-
import { Vec3Handle, ComponentHandle } from "../../../handles";
|
|
3
|
+
import { Vec3Handle, ComponentHandle, Vec3Components } from "../../../handles";
|
|
4
4
|
/**
|
|
5
5
|
* Comments — create, edit, resolve, tag, and list scene/project comments.
|
|
6
6
|
*
|
|
@@ -158,6 +158,50 @@ export declare abstract class PluginCommentApi {
|
|
|
158
158
|
* ```
|
|
159
159
|
*/
|
|
160
160
|
abstract list(): PluginApiReturn<CommentHandle[]>;
|
|
161
|
+
/**
|
|
162
|
+
* Read a comment's full detail — its text, author, pin location, resolved
|
|
163
|
+
* state, and reply thread. Comments are otherwise write-only; this is the read
|
|
164
|
+
* side. Pass a top-level comment handle or a reply handle (a reply has an empty
|
|
165
|
+
* `thread`). Returns `null` if the handle doesn't match a live comment.
|
|
166
|
+
*
|
|
167
|
+
* @param comment - The comment (or reply) to read.
|
|
168
|
+
* @returns the {@link PluginCommentDetails}, or `null` if not found.
|
|
169
|
+
*
|
|
170
|
+
* @examplePrompt Read the comment on this wall and tell me what it says
|
|
171
|
+
* @examplePrompt Who left this comment and where is it pinned?
|
|
172
|
+
* @examplePrompt Show me the full thread for this comment
|
|
173
|
+
* @examplePrompt Get the text and author of the selected comment
|
|
174
|
+
*
|
|
175
|
+
* # Example
|
|
176
|
+
* ```ts
|
|
177
|
+
* const [first] = await snaptrude.core.comment.list()
|
|
178
|
+
* const details = await snaptrude.core.comment.get(first)
|
|
179
|
+
* console.log(details?.content, "by", details?.author?.name)
|
|
180
|
+
* console.log(`${details?.thread.length ?? 0} replies`)
|
|
181
|
+
* ```
|
|
182
|
+
*/
|
|
183
|
+
abstract get(comment: CommentHandle): PluginApiReturn<PluginCommentDetails | null>;
|
|
184
|
+
/**
|
|
185
|
+
* Reply to a comment — posts a new comment threaded under `comment` (which must
|
|
186
|
+
* be a top-level comment, not itself a reply). Notifies the thread's
|
|
187
|
+
* participants, mirroring the sidebar Reply action.
|
|
188
|
+
*
|
|
189
|
+
* @param comment - The top-level comment to reply to.
|
|
190
|
+
* @param text - The reply text (emojis = plain unicode).
|
|
191
|
+
* @returns the new reply's {@link CommentHandle}.
|
|
192
|
+
*
|
|
193
|
+
* @examplePrompt Reply to this comment saying I fixed the wall height
|
|
194
|
+
* @examplePrompt Add a reply to the review note confirming it's done
|
|
195
|
+
* @examplePrompt Respond to the comment about the door with "looks good now"
|
|
196
|
+
* @examplePrompt Post a follow-up on the selected comment thread
|
|
197
|
+
*
|
|
198
|
+
* # Example
|
|
199
|
+
* ```ts
|
|
200
|
+
* const [thread] = await snaptrude.core.comment.list()
|
|
201
|
+
* const reply = await snaptrude.core.comment.reply(thread, "Fixed 👍")
|
|
202
|
+
* ```
|
|
203
|
+
*/
|
|
204
|
+
abstract reply(comment: CommentHandle, text: string): PluginApiReturn<CommentHandle>;
|
|
161
205
|
}
|
|
162
206
|
/**
|
|
163
207
|
* Opaque handle to a comment — its server-assigned id (entity-style: a raw,
|
|
@@ -182,7 +226,7 @@ export declare const CommentHandle: z.ZodPipe<z.ZodString, z.ZodTransform<Commen
|
|
|
182
226
|
*/
|
|
183
227
|
export declare const PluginCommentCreateArgs: z.ZodObject<{
|
|
184
228
|
component: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
|
|
185
|
-
position: z.ZodOptional<z.ZodPipe<z.
|
|
229
|
+
position: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
|
|
186
230
|
message: z.ZodString;
|
|
187
231
|
mentions: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
188
232
|
}, z.core.$strip>;
|
|
@@ -227,4 +271,63 @@ export declare const PluginCommentTagArgs: z.ZodObject<{
|
|
|
227
271
|
email: z.ZodString;
|
|
228
272
|
}, z.core.$strip>;
|
|
229
273
|
export type PluginCommentTagArgs = z.infer<typeof PluginCommentTagArgs>;
|
|
274
|
+
/**
|
|
275
|
+
* Arguments for {@link PluginCommentApi.reply}.
|
|
276
|
+
*
|
|
277
|
+
* | Property | Type | Description |
|
|
278
|
+
* |---|---|---|
|
|
279
|
+
* | `comment` | {@link CommentHandle} | The top-level comment to reply to |
|
|
280
|
+
* | `text` | `string` | The reply text (emojis = unicode) |
|
|
281
|
+
*/
|
|
282
|
+
export declare const PluginCommentReplyArgs: z.ZodObject<{
|
|
283
|
+
comment: z.ZodPipe<z.ZodString, z.ZodTransform<CommentHandle, string>>;
|
|
284
|
+
text: z.ZodString;
|
|
285
|
+
}, z.core.$strip>;
|
|
286
|
+
export type PluginCommentReplyArgs = z.infer<typeof PluginCommentReplyArgs>;
|
|
287
|
+
/**
|
|
288
|
+
* The author of a comment or reply — the display name and email of the teammate
|
|
289
|
+
* who posted it. `null` on the rare comment with no recorded author.
|
|
290
|
+
*/
|
|
291
|
+
export interface PluginCommentAuthor {
|
|
292
|
+
/** The author's display name (falls back to their email). */
|
|
293
|
+
name: string;
|
|
294
|
+
/** The author's email. */
|
|
295
|
+
email: string;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* One reply in a comment's thread (returned by {@link PluginCommentApi.get}).
|
|
299
|
+
*/
|
|
300
|
+
export interface PluginCommentReply {
|
|
301
|
+
/** The reply's own {@link CommentHandle}. */
|
|
302
|
+
id: CommentHandle;
|
|
303
|
+
/** The reply text. */
|
|
304
|
+
content: string;
|
|
305
|
+
/** Who posted the reply. */
|
|
306
|
+
author: PluginCommentAuthor | null;
|
|
307
|
+
/** ISO-8601 timestamp of when the reply was posted (empty if unknown). */
|
|
308
|
+
createdAt: string;
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* The read model of a comment — returned by {@link PluginCommentApi.get}. The
|
|
312
|
+
* inverse of {@link PluginCommentApi.create}: `content`/`component`/`position`
|
|
313
|
+
* echo what was posted, plus the resolved state and reply `thread`.
|
|
314
|
+
*/
|
|
315
|
+
export interface PluginCommentDetails {
|
|
316
|
+
/** The comment's {@link CommentHandle}. */
|
|
317
|
+
id: CommentHandle;
|
|
318
|
+
/** The comment text. */
|
|
319
|
+
content: string;
|
|
320
|
+
/** Who posted the comment. */
|
|
321
|
+
author: PluginCommentAuthor | null;
|
|
322
|
+
/** The pin point (engine world coordinates), or `null` if un-anchored. */
|
|
323
|
+
position: Vec3Components | null;
|
|
324
|
+
/** The component the comment is anchored to, or `null` if un-anchored. */
|
|
325
|
+
component: ComponentHandle | null;
|
|
326
|
+
/** Whether the comment has been marked resolved. */
|
|
327
|
+
isResolved: boolean;
|
|
328
|
+
/** ISO-8601 timestamp of when the comment was posted (empty if unknown). */
|
|
329
|
+
createdAt: string;
|
|
330
|
+
/** The reply thread, oldest first. Empty for a comment with no replies. */
|
|
331
|
+
thread: PluginCommentReply[];
|
|
332
|
+
}
|
|
230
333
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/comment/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/comment/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAE9E;;;;;;GAMG;AACH,8BAAsB,gBAAgB;;IAGpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,MAAM,CACpB,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,eAAe,EAC3B,QAAQ,CAAC,EAAE,UAAU,EACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,eAAe,CAAC,aAAa,CAAC;IAEjC;;;;;;;;;;;;;;;;;OAiBG;aACa,MAAM,CACpB,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,EAAE,GAClB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;OAeG;aACa,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC;IAEzE;;;;;;;;;;;;;;;OAeG;aACa,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC;IAExE;;;;;;;;;;;;;;;;OAgBG;aACa,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC;IAE5E;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;OAeG;aACa,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC;IAExE;;;;;;;;;;;;;;OAcG;aACa,IAAI,IAAI,eAAe,CAAC,aAAa,EAAE,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,GAAG,CACjB,OAAO,EAAE,aAAa,GACrB,eAAe,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAE/C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,KAAK,CACnB,OAAO,EAAE,aAAa,EACtB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,aAAa,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAA;CAAE,CAAA;AACrE,eAAO,MAAM,aAAa,+DAGa,CAAA;AAEvC;;iDAEiD;AAEjD;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB;;;;;iBAKlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB;;;;iBAIlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB;;iBAE/B,CAAA;AAEF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB;;;iBAG/B,CAAA;AAEF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB;;;iBAGjC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,6CAA6C;IAC7C,EAAE,EAAE,aAAa,CAAA;IACjB,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,4BAA4B;IAC5B,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAClC,0EAA0E;IAC1E,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,2CAA2C;IAC3C,EAAE,EAAE,aAAa,CAAA;IACjB,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,8BAA8B;IAC9B,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAClC,0EAA0E;IAC1E,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAA;IAC/B,0EAA0E;IAC1E,SAAS,EAAE,eAAe,GAAG,IAAI,CAAA;IACjC,oDAAoD;IACpD,UAAU,EAAE,OAAO,CAAA;IACnB,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAA;IACjB,2EAA2E;IAC3E,MAAM,EAAE,kBAAkB,EAAE,CAAA;CAC7B"}
|
|
@@ -162,8 +162,8 @@ export declare abstract class PluginGeomCreateApi {
|
|
|
162
162
|
* | `endPoint` | {@linkcode Vec3Handle} | End point of the line segment |
|
|
163
163
|
*/
|
|
164
164
|
export declare const PluginGeomCreateLineArgs: z.ZodObject<{
|
|
165
|
-
startPoint: z.ZodPipe<z.
|
|
166
|
-
endPoint: z.ZodPipe<z.
|
|
165
|
+
startPoint: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"vec3">, string>>;
|
|
166
|
+
endPoint: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"vec3">, string>>;
|
|
167
167
|
}, z.core.$strip>;
|
|
168
168
|
export type PluginGeomCreateLineArgs = z.infer<typeof PluginGeomCreateLineArgs>;
|
|
169
169
|
/**
|
|
@@ -177,10 +177,10 @@ export type PluginGeomCreateLineArgs = z.infer<typeof PluginGeomCreateLineArgs>;
|
|
|
177
177
|
* | `axis` | {@linkcode Vec3Handle} | Axis direction of the arc |
|
|
178
178
|
*/
|
|
179
179
|
export declare const PluginGeomCreateArcArgs: z.ZodObject<{
|
|
180
|
-
startPoint: z.ZodPipe<z.
|
|
181
|
-
endPoint: z.ZodPipe<z.
|
|
182
|
-
centrePoint: z.ZodPipe<z.
|
|
183
|
-
axis: z.ZodPipe<z.
|
|
180
|
+
startPoint: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"vec3">, string>>;
|
|
181
|
+
endPoint: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"vec3">, string>>;
|
|
182
|
+
centrePoint: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"vec3">, string>>;
|
|
183
|
+
axis: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"vec3">, string>>;
|
|
184
184
|
}, z.core.$strip>;
|
|
185
185
|
export type PluginGeomCreateArcArgs = z.infer<typeof PluginGeomCreateArcArgs>;
|
|
186
186
|
/**
|
|
@@ -193,8 +193,8 @@ export type PluginGeomCreateArcArgs = z.infer<typeof PluginGeomCreateArcArgs>;
|
|
|
193
193
|
* | `radius` | `number` | Radius of the circle |
|
|
194
194
|
*/
|
|
195
195
|
export declare const PluginGeomCreateCircleArgs: z.ZodObject<{
|
|
196
|
-
centrePoint: z.ZodPipe<z.
|
|
197
|
-
axis: z.ZodPipe<z.
|
|
196
|
+
centrePoint: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"vec3">, string>>;
|
|
197
|
+
axis: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"vec3">, string>>;
|
|
198
198
|
radius: z.ZodNumber;
|
|
199
199
|
}, z.core.$strip>;
|
|
200
200
|
export type PluginGeomCreateCircleArgs = z.infer<typeof PluginGeomCreateCircleArgs>;
|
|
@@ -206,7 +206,7 @@ export type PluginGeomCreateCircleArgs = z.infer<typeof PluginGeomCreateCircleAr
|
|
|
206
206
|
* | `points` | {@linkcode Vec3Handle}`[]` | Ordered vertex handles of the profile |
|
|
207
207
|
*/
|
|
208
208
|
export declare const PluginGeomCreateProfileFromLinePointsArgs: z.ZodObject<{
|
|
209
|
-
points: z.ZodArray<z.ZodPipe<z.
|
|
209
|
+
points: z.ZodArray<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"vec3">, string>>>;
|
|
210
210
|
}, z.core.$strip>;
|
|
211
211
|
export type PluginGeomCreateProfileFromLinePointsArgs = z.infer<typeof PluginGeomCreateProfileFromLinePointsArgs>;
|
|
212
212
|
/**
|
|
@@ -217,7 +217,7 @@ export type PluginGeomCreateProfileFromLinePointsArgs = z.infer<typeof PluginGeo
|
|
|
217
217
|
* | `curves` | {@linkcode CurveHandle}`[]` | Ordered curve handles forming a closed loop |
|
|
218
218
|
*/
|
|
219
219
|
export declare const PluginGeomCreateProfileFromCurvesArgs: z.ZodObject<{
|
|
220
|
-
curves: z.ZodArray<z.ZodUnion<readonly [z.ZodPipe<z.
|
|
220
|
+
curves: z.ZodArray<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"line">, string>>, z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"arc">, string>>]>>;
|
|
221
221
|
}, z.core.$strip>;
|
|
222
222
|
export type PluginGeomCreateProfileFromCurvesArgs = z.infer<typeof PluginGeomCreateProfileFromCurvesArgs>;
|
|
223
223
|
/**
|
|
@@ -228,7 +228,7 @@ export type PluginGeomCreateProfileFromCurvesArgs = z.infer<typeof PluginGeomCre
|
|
|
228
228
|
* | `outer` | {@linkcode ProfileHandle} | The outer boundary loop |
|
|
229
229
|
*/
|
|
230
230
|
export declare const PluginGeomCreateContourFromProfileArgs: z.ZodObject<{
|
|
231
|
-
outer: z.ZodPipe<z.
|
|
231
|
+
outer: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"profile">, string>>;
|
|
232
232
|
}, z.core.$strip>;
|
|
233
233
|
export type PluginGeomCreateContourFromProfileArgs = z.infer<typeof PluginGeomCreateContourFromProfileArgs>;
|
|
234
234
|
/**
|
|
@@ -240,8 +240,8 @@ export type PluginGeomCreateContourFromProfileArgs = z.infer<typeof PluginGeomCr
|
|
|
240
240
|
* | `holes` | {@linkcode ProfileHandle}`[]` | Optional inner hole loops |
|
|
241
241
|
*/
|
|
242
242
|
export declare const PluginGeomCreateContourFromProfilesArgs: z.ZodObject<{
|
|
243
|
-
outer: z.ZodPipe<z.
|
|
244
|
-
holes: z.ZodOptional<z.ZodArray<z.ZodPipe<z.
|
|
243
|
+
outer: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"profile">, string>>;
|
|
244
|
+
holes: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"profile">, string>>>>;
|
|
245
245
|
}, z.core.$strip>;
|
|
246
246
|
export type PluginGeomCreateContourFromProfilesArgs = z.infer<typeof PluginGeomCreateContourFromProfilesArgs>;
|
|
247
247
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -18,6 +18,9 @@ export declare abstract class PluginGeomDeleteApi {
|
|
|
18
18
|
* reclaims its share of the plugin's resource quota. This is a handle-lifecycle
|
|
19
19
|
* operation only and does NOT tear down any engine-side geometry.
|
|
20
20
|
*
|
|
21
|
+
* @deprecated Use `core.handles.release([profile])` — the universal, batched
|
|
22
|
+
* release API for every arena handle kind.
|
|
23
|
+
*
|
|
21
24
|
* @param profile The transient profile handle to release
|
|
22
25
|
* @returns Nothing
|
|
23
26
|
*
|
|
@@ -34,6 +37,9 @@ export declare abstract class PluginGeomDeleteApi {
|
|
|
34
37
|
* reclaims its share of the plugin's resource quota. Handle-lifecycle only; does
|
|
35
38
|
* NOT tear down engine-side geometry, nor the contour's child profile handles.
|
|
36
39
|
*
|
|
40
|
+
* @deprecated Use `core.handles.release([contour])` — the universal, batched
|
|
41
|
+
* release API for every arena handle kind.
|
|
42
|
+
*
|
|
37
43
|
* @param contour The transient contour handle to release
|
|
38
44
|
* @returns Nothing
|
|
39
45
|
*
|
|
@@ -55,7 +61,7 @@ export declare abstract class PluginGeomDeleteApi {
|
|
|
55
61
|
* | `profile` | {@linkcode ProfileHandle} | The transient profile handle to release |
|
|
56
62
|
*/
|
|
57
63
|
export declare const PluginGeomDeleteProfileArgs: z.ZodObject<{
|
|
58
|
-
profile: z.ZodPipe<z.
|
|
64
|
+
profile: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"profile">, string>>;
|
|
59
65
|
}, z.core.$strip>;
|
|
60
66
|
export type PluginGeomDeleteProfileArgs = z.infer<typeof PluginGeomDeleteProfileArgs>;
|
|
61
67
|
/**
|
|
@@ -66,7 +72,7 @@ export type PluginGeomDeleteProfileArgs = z.infer<typeof PluginGeomDeleteProfile
|
|
|
66
72
|
* | `contour` | {@linkcode ContourHandle} | The transient contour handle to release |
|
|
67
73
|
*/
|
|
68
74
|
export declare const PluginGeomDeleteContourArgs: z.ZodObject<{
|
|
69
|
-
contour: z.ZodPipe<z.
|
|
75
|
+
contour: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"contour">, string>>;
|
|
70
76
|
}, z.core.$strip>;
|
|
71
77
|
export type PluginGeomDeleteContourArgs = z.infer<typeof PluginGeomDeleteContourArgs>;
|
|
72
78
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/api/core/geom/delete/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAElE;;;;;;;;;GASG;AACH,8BAAsB,mBAAmB;;IAGvC
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/api/core/geom/delete/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAElE;;;;;;;;;GASG;AACH,8BAAsB,mBAAmB;;IAGvC;;;;;;;;;;;;;;;;;OAiBG;aACa,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC;IAEtE;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC;CACvE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B;;iBAEtC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAErF;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B;;iBAEtC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA"}
|
|
@@ -119,7 +119,7 @@ export declare abstract class PluginGeomQueryArcApi {
|
|
|
119
119
|
* | `arc` | {@linkcode ArcHandle} | The arc to query |
|
|
120
120
|
*/
|
|
121
121
|
export declare const PluginGeomQueryArcGetRadiusArgs: z.ZodObject<{
|
|
122
|
-
arc: z.ZodPipe<z.
|
|
122
|
+
arc: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"arc">, string>>;
|
|
123
123
|
}, z.core.$strip>;
|
|
124
124
|
export type PluginGeomQueryArcGetRadiusArgs = z.infer<typeof PluginGeomQueryArcGetRadiusArgs>;
|
|
125
125
|
/**
|
|
@@ -130,7 +130,7 @@ export type PluginGeomQueryArcGetRadiusArgs = z.infer<typeof PluginGeomQueryArcG
|
|
|
130
130
|
* | `arc` | {@linkcode ArcHandle} | The arc to query |
|
|
131
131
|
*/
|
|
132
132
|
export declare const PluginGeomQueryArcGetCentreArgs: z.ZodObject<{
|
|
133
|
-
arc: z.ZodPipe<z.
|
|
133
|
+
arc: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"arc">, string>>;
|
|
134
134
|
}, z.core.$strip>;
|
|
135
135
|
export type PluginGeomQueryArcGetCentreArgs = z.infer<typeof PluginGeomQueryArcGetCentreArgs>;
|
|
136
136
|
/**
|
|
@@ -141,7 +141,7 @@ export type PluginGeomQueryArcGetCentreArgs = z.infer<typeof PluginGeomQueryArcG
|
|
|
141
141
|
* | `arc` | {@linkcode ArcHandle} | The arc to query |
|
|
142
142
|
*/
|
|
143
143
|
export declare const PluginGeomQueryArcGetAxisArgs: z.ZodObject<{
|
|
144
|
-
arc: z.ZodPipe<z.
|
|
144
|
+
arc: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"arc">, string>>;
|
|
145
145
|
}, z.core.$strip>;
|
|
146
146
|
export type PluginGeomQueryArcGetAxisArgs = z.infer<typeof PluginGeomQueryArcGetAxisArgs>;
|
|
147
147
|
/**
|
|
@@ -152,7 +152,7 @@ export type PluginGeomQueryArcGetAxisArgs = z.infer<typeof PluginGeomQueryArcGet
|
|
|
152
152
|
* | `arc` | {@linkcode ArcHandle} | The arc to query |
|
|
153
153
|
*/
|
|
154
154
|
export declare const PluginGeomQueryArcGetSweepAngleArgs: z.ZodObject<{
|
|
155
|
-
arc: z.ZodPipe<z.
|
|
155
|
+
arc: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"arc">, string>>;
|
|
156
156
|
}, z.core.$strip>;
|
|
157
157
|
export type PluginGeomQueryArcGetSweepAngleArgs = z.infer<typeof PluginGeomQueryArcGetSweepAngleArgs>;
|
|
158
158
|
/**
|
|
@@ -163,7 +163,7 @@ export type PluginGeomQueryArcGetSweepAngleArgs = z.infer<typeof PluginGeomQuery
|
|
|
163
163
|
* | `arc` | {@linkcode ArcHandle} | The arc to query |
|
|
164
164
|
*/
|
|
165
165
|
export declare const PluginGeomQueryArcIsValidArgs: z.ZodObject<{
|
|
166
|
-
arc: z.ZodPipe<z.
|
|
166
|
+
arc: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../../..").Handle<"arc">, string>>;
|
|
167
167
|
}, z.core.$strip>;
|
|
168
168
|
export type PluginGeomQueryArcIsValidArgs = z.infer<typeof PluginGeomQueryArcIsValidArgs>;
|
|
169
169
|
//# sourceMappingURL=arc.d.ts.map
|