@snaptrude/plugin-core 0.9.10 → 0.9.11
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 +19 -0
- package/api-manifest.json +77 -415
- package/dist/api/design/create/grids.d.ts +132 -0
- package/dist/api/design/create/grids.d.ts.map +1 -0
- package/dist/api/design/create/index.d.ts +109 -1
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/grids.d.ts +237 -0
- package/dist/api/design/grids.d.ts.map +1 -0
- package/dist/api/design/index.d.ts +4 -0
- package/dist/api/design/index.d.ts.map +1 -1
- package/dist/api/design/query/grids.d.ts +287 -0
- package/dist/api/design/query/grids.d.ts.map +1 -0
- package/dist/api/design/query/index.d.ts +29 -0
- package/dist/api/design/query/index.d.ts.map +1 -1
- package/dist/api/design/update/index.d.ts +74 -0
- package/dist/api/design/update/index.d.ts.map +1 -1
- package/dist/index.cjs +2163 -1968
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +2143 -1973
- package/dist/index.js.map +1 -1
- package/package.json +13 -13
- package/src/api/design/create/grids.ts +137 -0
- package/src/api/design/create/index.ts +131 -0
- package/src/api/design/grids.ts +237 -0
- package/src/api/design/index.ts +5 -0
- package/src/api/design/query/grids.ts +197 -0
- package/src/api/design/query/index.ts +27 -0
- package/src/api/design/update/index.ts +53 -0
|
@@ -0,0 +1,287 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
import { PluginApiReturn } from "../../../types";
|
|
3
|
+
/**
|
|
4
|
+
* Visual properties of grid lines — the group's defaults and any per-line
|
|
5
|
+
* overrides share this shape (values mirror the engine's `GridLineProps`).
|
|
6
|
+
*
|
|
7
|
+
* | Property | Type | Description |
|
|
8
|
+
* |---|---|---|
|
|
9
|
+
* | `style` | {@linkcode PluginReferenceLineStyle} | Line style (`"SOLID"` \| `"DASHED"` \| `"DOT_DASH"`) |
|
|
10
|
+
* | `weight` | `number` | Line weight |
|
|
11
|
+
* | `color` | `string` | Line color as a `#rrggbb` hex string |
|
|
12
|
+
* | `showStart` | `boolean` | Whether the start-end tag bubble is shown |
|
|
13
|
+
* | `showEnd` | `boolean` | Whether the end-end tag bubble is shown |
|
|
14
|
+
*/
|
|
15
|
+
export declare const PluginGridLineProps: z.ZodObject<{
|
|
16
|
+
style: z.ZodEnum<{
|
|
17
|
+
SOLID: "SOLID";
|
|
18
|
+
DASHED: "DASHED";
|
|
19
|
+
DOT_DASH: "DOT_DASH";
|
|
20
|
+
}>;
|
|
21
|
+
weight: z.ZodNumber;
|
|
22
|
+
color: z.ZodString;
|
|
23
|
+
showStart: z.ZodBoolean;
|
|
24
|
+
showEnd: z.ZodBoolean;
|
|
25
|
+
}, z.core.$strip>;
|
|
26
|
+
export type PluginGridLineProps = z.infer<typeof PluginGridLineProps>;
|
|
27
|
+
/**
|
|
28
|
+
* One grid line within a wing.
|
|
29
|
+
*
|
|
30
|
+
* | Property | Type | Description |
|
|
31
|
+
* |---|---|---|
|
|
32
|
+
* | `curve` | {@linkcode CurveHandle} | The line's geometry in **world space** (a line or arc; read coordinates via `core.geom.curve`) |
|
|
33
|
+
* | `tag` | `string` | The line's grid tag (e.g. `"A"`, `"3"`) |
|
|
34
|
+
* | `visible` | `boolean` | Persisted per-line visibility |
|
|
35
|
+
* | `props` | {@linkcode PluginGridLineProps} | **Effective** visual properties (group defaults merged with this line's overrides) |
|
|
36
|
+
* | `overrides` | `Partial<`{@linkcode PluginGridLineProps}`>`? | This line's raw overrides, when any exist |
|
|
37
|
+
*/
|
|
38
|
+
export declare const PluginGridLineRecord: z.ZodObject<{
|
|
39
|
+
curve: 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>>]>;
|
|
40
|
+
tag: z.ZodString;
|
|
41
|
+
visible: z.ZodBoolean;
|
|
42
|
+
props: z.ZodObject<{
|
|
43
|
+
style: z.ZodEnum<{
|
|
44
|
+
SOLID: "SOLID";
|
|
45
|
+
DASHED: "DASHED";
|
|
46
|
+
DOT_DASH: "DOT_DASH";
|
|
47
|
+
}>;
|
|
48
|
+
weight: z.ZodNumber;
|
|
49
|
+
color: z.ZodString;
|
|
50
|
+
showStart: z.ZodBoolean;
|
|
51
|
+
showEnd: z.ZodBoolean;
|
|
52
|
+
}, z.core.$strip>;
|
|
53
|
+
overrides: z.ZodOptional<z.ZodObject<{
|
|
54
|
+
style: z.ZodOptional<z.ZodEnum<{
|
|
55
|
+
SOLID: "SOLID";
|
|
56
|
+
DASHED: "DASHED";
|
|
57
|
+
DOT_DASH: "DOT_DASH";
|
|
58
|
+
}>>;
|
|
59
|
+
weight: z.ZodOptional<z.ZodNumber>;
|
|
60
|
+
color: z.ZodOptional<z.ZodString>;
|
|
61
|
+
showStart: z.ZodOptional<z.ZodBoolean>;
|
|
62
|
+
showEnd: z.ZodOptional<z.ZodBoolean>;
|
|
63
|
+
}, z.core.$strip>>;
|
|
64
|
+
}, z.core.$strip>;
|
|
65
|
+
export type PluginGridLineRecord = z.infer<typeof PluginGridLineRecord>;
|
|
66
|
+
/**
|
|
67
|
+
* One wing of a grid — a family of parallel lines sharing a local frame.
|
|
68
|
+
* `spacing` and `span` are measured along the wing's local axes in
|
|
69
|
+
* Snaptrude units; line addresses used by mutating APIs are
|
|
70
|
+
* `{ wing, line }` index pairs into these arrays.
|
|
71
|
+
*
|
|
72
|
+
* | Property | Type | Description |
|
|
73
|
+
* |---|---|---|
|
|
74
|
+
* | `spacing` | `number` | Nominal spacing between adjacent lines (Snaptrude units) |
|
|
75
|
+
* | `tagStart` | `string` | First tag of the wing's deterministic tag sequence |
|
|
76
|
+
* | `span` | `{ min: number; max: number }`? | Explicit family length along the wing's line axis, when baked |
|
|
77
|
+
* | `lines` | {@linkcode PluginGridLineRecord}`[]` | The wing's lines, in wing order (index = the `line` address) |
|
|
78
|
+
*/
|
|
79
|
+
export declare const PluginGridWingRecord: z.ZodObject<{
|
|
80
|
+
spacing: z.ZodNumber;
|
|
81
|
+
tagStart: z.ZodString;
|
|
82
|
+
span: z.ZodOptional<z.ZodObject<{
|
|
83
|
+
min: z.ZodNumber;
|
|
84
|
+
max: z.ZodNumber;
|
|
85
|
+
}, z.core.$strip>>;
|
|
86
|
+
lines: z.ZodArray<z.ZodObject<{
|
|
87
|
+
curve: 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>>]>;
|
|
88
|
+
tag: z.ZodString;
|
|
89
|
+
visible: z.ZodBoolean;
|
|
90
|
+
props: z.ZodObject<{
|
|
91
|
+
style: z.ZodEnum<{
|
|
92
|
+
SOLID: "SOLID";
|
|
93
|
+
DASHED: "DASHED";
|
|
94
|
+
DOT_DASH: "DOT_DASH";
|
|
95
|
+
}>;
|
|
96
|
+
weight: z.ZodNumber;
|
|
97
|
+
color: z.ZodString;
|
|
98
|
+
showStart: z.ZodBoolean;
|
|
99
|
+
showEnd: z.ZodBoolean;
|
|
100
|
+
}, z.core.$strip>;
|
|
101
|
+
overrides: z.ZodOptional<z.ZodObject<{
|
|
102
|
+
style: z.ZodOptional<z.ZodEnum<{
|
|
103
|
+
SOLID: "SOLID";
|
|
104
|
+
DASHED: "DASHED";
|
|
105
|
+
DOT_DASH: "DOT_DASH";
|
|
106
|
+
}>>;
|
|
107
|
+
weight: z.ZodOptional<z.ZodNumber>;
|
|
108
|
+
color: z.ZodOptional<z.ZodString>;
|
|
109
|
+
showStart: z.ZodOptional<z.ZodBoolean>;
|
|
110
|
+
showEnd: z.ZodOptional<z.ZodBoolean>;
|
|
111
|
+
}, z.core.$strip>>;
|
|
112
|
+
}, z.core.$strip>>;
|
|
113
|
+
}, z.core.$strip>;
|
|
114
|
+
export type PluginGridWingRecord = z.infer<typeof PluginGridWingRecord>;
|
|
115
|
+
/**
|
|
116
|
+
* Per-storey 2D-plan visibility of a grid.
|
|
117
|
+
*
|
|
118
|
+
* | Property | Type | Description |
|
|
119
|
+
* |---|---|---|
|
|
120
|
+
* | `activeStorey` | `number` | The storey the grid belongs to |
|
|
121
|
+
* | `disabledOnStoreys` | `number[]` | Storeys on whose 2D plan the grid is hidden |
|
|
122
|
+
*/
|
|
123
|
+
export declare const PluginGridStoreyVisibility: z.ZodObject<{
|
|
124
|
+
activeStorey: z.ZodNumber;
|
|
125
|
+
disabledOnStoreys: z.ZodArray<z.ZodNumber>;
|
|
126
|
+
}, z.core.$strip>;
|
|
127
|
+
export type PluginGridStoreyVisibility = z.infer<typeof PluginGridStoreyVisibility>;
|
|
128
|
+
/**
|
|
129
|
+
* Property names readable via {@linkcode PluginDesignQueryGridsApi.get}.
|
|
130
|
+
*
|
|
131
|
+
* | Value | Description |
|
|
132
|
+
* |---|---|
|
|
133
|
+
* | `"angle"` | World rotation about +Y, in **degrees** |
|
|
134
|
+
* | `"props"` | Group-level default line properties |
|
|
135
|
+
* | `"storeyVisibility"` | Active storey + storeys where the grid is hidden in 2D |
|
|
136
|
+
* | `"wings"` | Full wing/line structure with world-space curve handles |
|
|
137
|
+
* | `"bounds"` | World-space axis-aligned bounding box of the grid geometry |
|
|
138
|
+
*/
|
|
139
|
+
export declare const PluginGridGetProperty: z.ZodEnum<{
|
|
140
|
+
angle: "angle";
|
|
141
|
+
props: "props";
|
|
142
|
+
storeyVisibility: "storeyVisibility";
|
|
143
|
+
wings: "wings";
|
|
144
|
+
bounds: "bounds";
|
|
145
|
+
}>;
|
|
146
|
+
export type PluginGridGetProperty = z.infer<typeof PluginGridGetProperty>;
|
|
147
|
+
/**
|
|
148
|
+
* Arguments for {@linkcode PluginDesignQueryGridsApi.get}.
|
|
149
|
+
*
|
|
150
|
+
* | Property | Type | Description |
|
|
151
|
+
* |---|---|---|
|
|
152
|
+
* | `gridId` | `string` | The grid group ID to query |
|
|
153
|
+
* | `properties` | {@linkcode PluginGridGetProperty}`[]` | Properties to retrieve |
|
|
154
|
+
*/
|
|
155
|
+
export declare const PluginGridGetArgs: z.ZodObject<{
|
|
156
|
+
gridId: z.ZodString;
|
|
157
|
+
properties: z.ZodArray<z.ZodEnum<{
|
|
158
|
+
angle: "angle";
|
|
159
|
+
props: "props";
|
|
160
|
+
storeyVisibility: "storeyVisibility";
|
|
161
|
+
wings: "wings";
|
|
162
|
+
bounds: "bounds";
|
|
163
|
+
}>>;
|
|
164
|
+
}, z.core.$strip>;
|
|
165
|
+
export type PluginGridGetArgs = z.infer<typeof PluginGridGetArgs>;
|
|
166
|
+
/**
|
|
167
|
+
* Result of {@linkcode PluginDesignQueryGridsApi.get} — only the requested
|
|
168
|
+
* properties are present.
|
|
169
|
+
*/
|
|
170
|
+
export declare const PluginGridGetResult: z.ZodObject<{
|
|
171
|
+
angle: z.ZodOptional<z.ZodNumber>;
|
|
172
|
+
props: z.ZodOptional<z.ZodObject<{
|
|
173
|
+
style: z.ZodEnum<{
|
|
174
|
+
SOLID: "SOLID";
|
|
175
|
+
DASHED: "DASHED";
|
|
176
|
+
DOT_DASH: "DOT_DASH";
|
|
177
|
+
}>;
|
|
178
|
+
weight: z.ZodNumber;
|
|
179
|
+
color: z.ZodString;
|
|
180
|
+
showStart: z.ZodBoolean;
|
|
181
|
+
showEnd: z.ZodBoolean;
|
|
182
|
+
}, z.core.$strip>>;
|
|
183
|
+
storeyVisibility: z.ZodOptional<z.ZodObject<{
|
|
184
|
+
activeStorey: z.ZodNumber;
|
|
185
|
+
disabledOnStoreys: z.ZodArray<z.ZodNumber>;
|
|
186
|
+
}, z.core.$strip>>;
|
|
187
|
+
wings: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
188
|
+
spacing: z.ZodNumber;
|
|
189
|
+
tagStart: z.ZodString;
|
|
190
|
+
span: z.ZodOptional<z.ZodObject<{
|
|
191
|
+
min: z.ZodNumber;
|
|
192
|
+
max: z.ZodNumber;
|
|
193
|
+
}, z.core.$strip>>;
|
|
194
|
+
lines: z.ZodArray<z.ZodObject<{
|
|
195
|
+
curve: 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>>]>;
|
|
196
|
+
tag: z.ZodString;
|
|
197
|
+
visible: z.ZodBoolean;
|
|
198
|
+
props: z.ZodObject<{
|
|
199
|
+
style: z.ZodEnum<{
|
|
200
|
+
SOLID: "SOLID";
|
|
201
|
+
DASHED: "DASHED";
|
|
202
|
+
DOT_DASH: "DOT_DASH";
|
|
203
|
+
}>;
|
|
204
|
+
weight: z.ZodNumber;
|
|
205
|
+
color: z.ZodString;
|
|
206
|
+
showStart: z.ZodBoolean;
|
|
207
|
+
showEnd: z.ZodBoolean;
|
|
208
|
+
}, z.core.$strip>;
|
|
209
|
+
overrides: z.ZodOptional<z.ZodObject<{
|
|
210
|
+
style: z.ZodOptional<z.ZodEnum<{
|
|
211
|
+
SOLID: "SOLID";
|
|
212
|
+
DASHED: "DASHED";
|
|
213
|
+
DOT_DASH: "DOT_DASH";
|
|
214
|
+
}>>;
|
|
215
|
+
weight: z.ZodOptional<z.ZodNumber>;
|
|
216
|
+
color: z.ZodOptional<z.ZodString>;
|
|
217
|
+
showStart: z.ZodOptional<z.ZodBoolean>;
|
|
218
|
+
showEnd: z.ZodOptional<z.ZodBoolean>;
|
|
219
|
+
}, z.core.$strip>>;
|
|
220
|
+
}, z.core.$strip>>;
|
|
221
|
+
}, z.core.$strip>>>;
|
|
222
|
+
bounds: z.ZodOptional<z.ZodObject<{
|
|
223
|
+
min: z.ZodObject<{
|
|
224
|
+
x: z.ZodNumber;
|
|
225
|
+
y: z.ZodNumber;
|
|
226
|
+
z: z.ZodNumber;
|
|
227
|
+
}, z.core.$strip>;
|
|
228
|
+
max: z.ZodObject<{
|
|
229
|
+
x: z.ZodNumber;
|
|
230
|
+
y: z.ZodNumber;
|
|
231
|
+
z: z.ZodNumber;
|
|
232
|
+
}, z.core.$strip>;
|
|
233
|
+
}, z.core.$strip>>;
|
|
234
|
+
}, z.core.$strip>;
|
|
235
|
+
export type PluginGridGetResult = z.infer<typeof PluginGridGetResult>;
|
|
236
|
+
/**
|
|
237
|
+
* `design.query.grids.*` — structural-grid-specific reads.
|
|
238
|
+
*
|
|
239
|
+
* A **grid** (grid group) is a structural/documentation grid: one or more
|
|
240
|
+
* *wings* (families of parallel lines with a shared local frame), each holding
|
|
241
|
+
* tagged grid *lines* (straight lines, or a lone arc). Enumerate grids with
|
|
242
|
+
* `design.query.listGrids`; read an individual grid's structure here.
|
|
243
|
+
*
|
|
244
|
+
* Lines have no stable identity of their own — mutating APIs address them
|
|
245
|
+
* positionally as `{ wing, line }` index pairs into the `wings` arrays
|
|
246
|
+
* returned by {@linkcode get}. Structural edits (adding/removing lines,
|
|
247
|
+
* count changes) re-index lines; re-query after mutating.
|
|
248
|
+
*
|
|
249
|
+
* Accessed via `snaptrude.design.query.grids`.
|
|
250
|
+
*/
|
|
251
|
+
export declare abstract class PluginDesignQueryGridsApi {
|
|
252
|
+
constructor();
|
|
253
|
+
/**
|
|
254
|
+
* Get properties of a grid by its ID.
|
|
255
|
+
*
|
|
256
|
+
* Only the properties listed in `properties` are returned — unlisted
|
|
257
|
+
* properties will be `undefined` in the result. `wings` is the heavy
|
|
258
|
+
* read (it registers a world-space {@linkcode CurveHandle} per line);
|
|
259
|
+
* request it only when the geometry is needed.
|
|
260
|
+
*
|
|
261
|
+
* Units: `angle` is in **degrees** (positive = CCW about +Y); `spacing`,
|
|
262
|
+
* `span`, `bounds`, and curve coordinates are in **Snaptrude units**,
|
|
263
|
+
* world space.
|
|
264
|
+
*
|
|
265
|
+
* @param gridId - The unique grid group ID
|
|
266
|
+
* @param properties - Array of property names to retrieve. See
|
|
267
|
+
* {@linkcode PluginGridGetProperty}.
|
|
268
|
+
* @returns A partial {@linkcode PluginGridGetResult} containing only the
|
|
269
|
+
* requested properties
|
|
270
|
+
* @throws If the grid does not exist
|
|
271
|
+
*
|
|
272
|
+
* @examplePrompt What is the spacing of this grid?
|
|
273
|
+
* @examplePrompt Read the grid line tags on this structural grid
|
|
274
|
+
* @examplePrompt Get the geometry of every line in this grid
|
|
275
|
+
* @examplePrompt Which storeys is this grid hidden on?
|
|
276
|
+
*
|
|
277
|
+
* # Example
|
|
278
|
+
* ```ts
|
|
279
|
+
* const [grid] = await snaptrude.design.query.listGrids()
|
|
280
|
+
* const { wings } = await snaptrude.design.query.grids.get(grid, ["wings"])
|
|
281
|
+
* // wings[0].lines[0].curve is an opaque CurveHandle in world space;
|
|
282
|
+
* // read its coordinates via `snaptrude.core.geom.curve`.
|
|
283
|
+
* ```
|
|
284
|
+
*/
|
|
285
|
+
abstract get(gridId: string, properties: z.infer<typeof PluginGridGetProperty>[]): PluginApiReturn<PluginGridGetResult>;
|
|
286
|
+
}
|
|
287
|
+
//# sourceMappingURL=grids.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"grids.d.ts","sourceRoot":"","sources":["../../../../src/api/design/query/grids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAQhD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;iBAM9B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;iBAM/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAMnF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB;;;;;;EAMhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;iBAG5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQpB,CAAA;AACZ,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAMrE;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,yBAAyB;;IAG7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;aACa,GAAG,CACjB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,EAAE,GAClD,eAAe,CAAC,mBAAmB,CAAC;CACxC"}
|
|
@@ -4,6 +4,7 @@ import { ComponentHandle, BBoxComponents } from "../../../handles";
|
|
|
4
4
|
import { PluginDesignQueryGeometryApi } from "./geometry";
|
|
5
5
|
import { PluginDesignQuerySpacesApi } from "./spaces";
|
|
6
6
|
import { PluginDesignQueryReferenceLinesApi } from "./referenceLines";
|
|
7
|
+
import { PluginDesignQueryGridsApi } from "./grids";
|
|
7
8
|
/**
|
|
8
9
|
* The kind of a BIM entity — the discovery/filter vocabulary for the whole
|
|
9
10
|
* `design.query.*` surface. Values are clean `lowerCamel` tokens; the host maps
|
|
@@ -29,6 +30,7 @@ import { PluginDesignQueryReferenceLinesApi } from "./referenceLines";
|
|
|
29
30
|
* | `"curtainWall"` | Parametric curtain wall |
|
|
30
31
|
* | `"mullion"` | Curtain-wall mullion |
|
|
31
32
|
* | `"panel"` | Curtain-wall panel |
|
|
33
|
+
* | `"grid"` | Structural grid group |
|
|
32
34
|
*/
|
|
33
35
|
export declare const PluginEntityType: z.ZodEnum<{
|
|
34
36
|
mass: "mass";
|
|
@@ -48,6 +50,7 @@ export declare const PluginEntityType: z.ZodEnum<{
|
|
|
48
50
|
curtainWall: "curtainWall";
|
|
49
51
|
mullion: "mullion";
|
|
50
52
|
panel: "panel";
|
|
53
|
+
grid: "grid";
|
|
51
54
|
}>;
|
|
52
55
|
export type PluginEntityType = z.infer<typeof PluginEntityType>;
|
|
53
56
|
/**
|
|
@@ -94,6 +97,7 @@ export declare const PluginEntityFilter: z.ZodObject<{
|
|
|
94
97
|
curtainWall: "curtainWall";
|
|
95
98
|
mullion: "mullion";
|
|
96
99
|
panel: "panel";
|
|
100
|
+
grid: "grid";
|
|
97
101
|
}>>>;
|
|
98
102
|
storeys: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
99
103
|
buildingIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
@@ -173,6 +177,7 @@ export declare const PluginDesignQueryListByTypeArgs: z.ZodObject<{
|
|
|
173
177
|
curtainWall: "curtainWall";
|
|
174
178
|
mullion: "mullion";
|
|
175
179
|
panel: "panel";
|
|
180
|
+
grid: "grid";
|
|
176
181
|
}>>>;
|
|
177
182
|
storeys: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
178
183
|
buildingIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
@@ -245,6 +250,7 @@ export declare const PluginDesignQueryListByTypeArgs: z.ZodObject<{
|
|
|
245
250
|
curtainWall: "curtainWall";
|
|
246
251
|
mullion: "mullion";
|
|
247
252
|
panel: "panel";
|
|
253
|
+
grid: "grid";
|
|
248
254
|
}>;
|
|
249
255
|
}, z.core.$strip>;
|
|
250
256
|
export type PluginDesignQueryListByTypeArgs = z.infer<typeof PluginDesignQueryListByTypeArgs>;
|
|
@@ -308,6 +314,7 @@ export declare const PluginEntityProperties: z.ZodObject<{
|
|
|
308
314
|
curtainWall: "curtainWall";
|
|
309
315
|
mullion: "mullion";
|
|
310
316
|
panel: "panel";
|
|
317
|
+
grid: "grid";
|
|
311
318
|
}>>;
|
|
312
319
|
label: z.ZodOptional<z.ZodString>;
|
|
313
320
|
storey: z.ZodOptional<z.ZodNumber>;
|
|
@@ -499,6 +506,8 @@ export declare abstract class PluginDesignQueryApi {
|
|
|
499
506
|
abstract spaces: PluginDesignQuerySpacesApi;
|
|
500
507
|
/** Reference-line-specific reads. See {@linkcode PluginDesignQueryReferenceLinesApi}. */
|
|
501
508
|
abstract referenceLines: PluginDesignQueryReferenceLinesApi;
|
|
509
|
+
/** Structural-grid-specific reads. See {@linkcode PluginDesignQueryGridsApi}. */
|
|
510
|
+
abstract grids: PluginDesignQueryGridsApi;
|
|
502
511
|
constructor();
|
|
503
512
|
/**
|
|
504
513
|
* List **all** BIM entities in the project matching the filter.
|
|
@@ -860,6 +869,24 @@ export declare abstract class PluginDesignQueryApi {
|
|
|
860
869
|
* ```
|
|
861
870
|
*/
|
|
862
871
|
abstract listMullions(filter?: PluginEntityFilter): PluginApiReturn<ComponentHandle[]>;
|
|
872
|
+
/**
|
|
873
|
+
* List all the structural grids (grid groups) in the project, optionally
|
|
874
|
+
* filtered by storey, building, selection state, or region.
|
|
875
|
+
*
|
|
876
|
+
* @param filter - an optional {@linkcode PluginEntityFilter}
|
|
877
|
+
* @returns grid-group {@linkcode ComponentHandle}`[]`
|
|
878
|
+
*
|
|
879
|
+
* @examplePrompt List all the structural grids in the model
|
|
880
|
+
* @examplePrompt How many grids are on the ground floor?
|
|
881
|
+
* @examplePrompt Show the grids on this storey
|
|
882
|
+
* @examplePrompt Which grids are currently selected?
|
|
883
|
+
*
|
|
884
|
+
* # Example
|
|
885
|
+
* ```ts
|
|
886
|
+
* const groundFloorGrids = await snaptrude.design.query.listGrids({ storeys: [1] })
|
|
887
|
+
* ```
|
|
888
|
+
*/
|
|
889
|
+
abstract listGrids(filter?: PluginEntityFilter): PluginApiReturn<ComponentHandle[]>;
|
|
863
890
|
/**
|
|
864
891
|
* Look an entity up by id — returns the same handle if it still resolves live,
|
|
865
892
|
* else `null`. A cheap validity probe (distinct from {@linkcode PluginDesignQueryApi.exists}).
|
|
@@ -1226,6 +1253,7 @@ export declare const PluginStoreyOutlineOptions: z.ZodObject<{
|
|
|
1226
1253
|
curtainWall: "curtainWall";
|
|
1227
1254
|
mullion: "mullion";
|
|
1228
1255
|
panel: "panel";
|
|
1256
|
+
grid: "grid";
|
|
1229
1257
|
}>>>;
|
|
1230
1258
|
minArea: z.ZodDefault<z.ZodNumber>;
|
|
1231
1259
|
}, z.core.$strip>;
|
|
@@ -1279,4 +1307,5 @@ export type PluginStoreyOutlineResult = z.infer<typeof PluginStoreyOutlineResult
|
|
|
1279
1307
|
export * from "./geometry";
|
|
1280
1308
|
export * from "./spaces";
|
|
1281
1309
|
export * from "./referenceLines";
|
|
1310
|
+
export * from "./grids";
|
|
1282
1311
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/query/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAQlE,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAA;AACzD,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAA;AACrD,OAAO,EAAE,kCAAkC,EAAE,MAAM,kBAAkB,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/query/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAQlE,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAA;AACzD,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAA;AACrD,OAAO,EAAE,kCAAkC,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAA;AAMnD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;EAmB3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAM/D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAe7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAMD,qFAAqF;AACrF,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,0DAA0D;AAC1D,eAAO,MAAM,uBAAuB;;iBAElC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,kFAAkF;AAClF,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAMD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmBvB,CAAA;AACZ,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;iBAOnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgBhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAMzE;;;;;;;;;;;;GAYG;AACH,8BAAsB,oBAAoB;IACxC,kGAAkG;IAClG,SAAgB,QAAQ,EAAE,4BAA4B,CAAA;IACtD,uFAAuF;IACvF,SAAgB,MAAM,EAAE,0BAA0B,CAAA;IAClD,yFAAyF;IACzF,SAAgB,cAAc,EAAE,kCAAkC,CAAA;IAClE,iFAAiF;IACjF,SAAgB,KAAK,EAAE,yBAAyB,CAAA;;IAMhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,YAAY,CAC1B,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,UAAU,CACxB,IAAI,EAAE,gBAAgB,EACtB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;OAmBG;aACa,SAAS,CACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,UAAU,CACxB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;OAmBG;aACa,UAAU,CACxB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,SAAS,CACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,WAAW,CACzB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,UAAU,CACxB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,SAAS,CACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,SAAS,CACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,WAAW,CACzB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,SAAS,CACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,YAAY,CAC1B,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,cAAc,CAC5B,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,aAAa,CAC3B,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,kBAAkB,CAChC,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,YAAY,CAC1B,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;OAgBG;aACa,SAAS,CACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,eAAe,CAAC,eAAe,EAAE,CAAC;IAIrC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,OAAO,CACrB,EAAE,EAAE,eAAe,GAClB,eAAe,CAAC,eAAe,GAAG,IAAI,CAAC;IAE1C;;;;;;;;;;;;;;;;;;OAkBG;aACa,MAAM,CAAC,EAAE,EAAE,eAAe,GAAG,eAAe,CAAC,OAAO,CAAC;IAErE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,aAAa,CAC3B,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,QAAQ,CAAC,SAAS,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC;IAE7E;;;;;;;;;;;;;;;;;;OAkBG;aACa,YAAY,CAC1B,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,eAAe,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,YAAY,CAC1B,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,eAAe,EAAE,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,OAAO,CACrB,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,eAAe,GAAG,IAAI,CAAC;IAI1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;aACa,aAAa,CAC3B,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,sBAAsB,CAAC;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,OAAO,CACrB,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,wBAAwB,GAAG,IAAI,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,kBAAkB,CAChC,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,cAAc,CAC5B,UAAU,EAAE,eAAe,EAAE,GAC5B,eAAe,CAAC,cAAc,GAAG,IAAI,CAAC;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;aACa,aAAa,CAC3B,OAAO,CAAC,EAAE,0BAA0B,GACnC,eAAe,CAAC,yBAAyB,CAAC;CAC9C;AAGD,mFAAmF;AACnF,eAAO,MAAM,sBAAsB;;;iBAA6C,CAAA;AAChF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;iBAIrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;iBAUhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,4DAA4D;AAC5D,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;iBAKpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA"}
|
|
@@ -278,6 +278,53 @@ export declare const PluginDesignSetStoreyArgs: z.ZodObject<{
|
|
|
278
278
|
storey: z.ZodNumber;
|
|
279
279
|
}, z.core.$strip>;
|
|
280
280
|
export type PluginDesignSetStoreyArgs = z.infer<typeof PluginDesignSetStoreyArgs>;
|
|
281
|
+
/**
|
|
282
|
+
* The sparse GROUP-LEVEL patch accepted by {@linkcode PluginDesignUpdateApi.grid}.
|
|
283
|
+
* Only provided fields change. Wing- and line-level updates live on the grids
|
|
284
|
+
* entity family: `design.grids.updateWings` / `design.grids.updateLines`.
|
|
285
|
+
*/
|
|
286
|
+
export declare const PluginGridPatch: z.ZodObject<{
|
|
287
|
+
angle: z.ZodOptional<z.ZodNumber>;
|
|
288
|
+
props: z.ZodOptional<z.ZodObject<{
|
|
289
|
+
style: z.ZodOptional<z.ZodEnum<{
|
|
290
|
+
SOLID: "SOLID";
|
|
291
|
+
DASHED: "DASHED";
|
|
292
|
+
DOT_DASH: "DOT_DASH";
|
|
293
|
+
}>>;
|
|
294
|
+
weight: z.ZodOptional<z.ZodNumber>;
|
|
295
|
+
color: z.ZodOptional<z.ZodString>;
|
|
296
|
+
showStart: z.ZodOptional<z.ZodBoolean>;
|
|
297
|
+
showEnd: z.ZodOptional<z.ZodBoolean>;
|
|
298
|
+
}, z.core.$strip>>;
|
|
299
|
+
storeyVisibility: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
300
|
+
storey: z.ZodNumber;
|
|
301
|
+
visible: z.ZodBoolean;
|
|
302
|
+
}, z.core.$strip>>>;
|
|
303
|
+
}, z.core.$strip>;
|
|
304
|
+
export type PluginGridPatch = z.infer<typeof PluginGridPatch>;
|
|
305
|
+
/** Arguments for {@linkcode PluginDesignUpdateApi.grid}. */
|
|
306
|
+
export declare const PluginDesignUpdateGridArgs: z.ZodObject<{
|
|
307
|
+
grid: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
|
|
308
|
+
patch: z.ZodObject<{
|
|
309
|
+
angle: z.ZodOptional<z.ZodNumber>;
|
|
310
|
+
props: z.ZodOptional<z.ZodObject<{
|
|
311
|
+
style: z.ZodOptional<z.ZodEnum<{
|
|
312
|
+
SOLID: "SOLID";
|
|
313
|
+
DASHED: "DASHED";
|
|
314
|
+
DOT_DASH: "DOT_DASH";
|
|
315
|
+
}>>;
|
|
316
|
+
weight: z.ZodOptional<z.ZodNumber>;
|
|
317
|
+
color: z.ZodOptional<z.ZodString>;
|
|
318
|
+
showStart: z.ZodOptional<z.ZodBoolean>;
|
|
319
|
+
showEnd: z.ZodOptional<z.ZodBoolean>;
|
|
320
|
+
}, z.core.$strip>>;
|
|
321
|
+
storeyVisibility: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
322
|
+
storey: z.ZodNumber;
|
|
323
|
+
visible: z.ZodBoolean;
|
|
324
|
+
}, z.core.$strip>>>;
|
|
325
|
+
}, z.core.$strip>;
|
|
326
|
+
}, z.core.$strip>;
|
|
327
|
+
export type PluginDesignUpdateGridArgs = z.infer<typeof PluginDesignUpdateGridArgs>;
|
|
281
328
|
/**
|
|
282
329
|
* `snaptrude.design.update` — edit existing scene entities (properties + geometry).
|
|
283
330
|
*
|
|
@@ -325,6 +372,33 @@ export declare abstract class PluginDesignUpdateApi {
|
|
|
325
372
|
* ```
|
|
326
373
|
*/
|
|
327
374
|
abstract setLabel(component: ComponentHandle, label: string): PluginApiReturn<boolean>;
|
|
375
|
+
/**
|
|
376
|
+
* Update a structural grid's **group-level** fields with a sparse patch —
|
|
377
|
+
* default line styling, absolute angle, and per-storey 2D visibility. Only
|
|
378
|
+
* provided fields change. Wing- and line-level updates live on the grids
|
|
379
|
+
* entity family: {@linkcode PluginDesignGridsApi.updateWings} /
|
|
380
|
+
* {@linkcode PluginDesignGridsApi.updateLines}.
|
|
381
|
+
*
|
|
382
|
+
* Every change routes through the exact setters the native panel uses —
|
|
383
|
+
* each changed field commits its own undoable command, identical to editing
|
|
384
|
+
* that field in the panel. `angle` is an absolute target in degrees (CCW
|
|
385
|
+
* about +Y).
|
|
386
|
+
*
|
|
387
|
+
* @param grid - The grid group to update
|
|
388
|
+
* @param patch - The sparse {@linkcode PluginGridPatch}
|
|
389
|
+
* @returns `true` once applied
|
|
390
|
+
*
|
|
391
|
+
* @examplePrompt Rotate the grid to 45 degrees
|
|
392
|
+
* @examplePrompt Make this grid's lines dashed and grey
|
|
393
|
+
* @examplePrompt Hide this grid on storey 3's plan
|
|
394
|
+
*
|
|
395
|
+
* # Example
|
|
396
|
+
* ```ts
|
|
397
|
+
* const [grid] = await snaptrude.design.query.listGrids()
|
|
398
|
+
* await snaptrude.design.update.grid(grid, { angle: 45, props: { style: "DASHED" } })
|
|
399
|
+
* ```
|
|
400
|
+
*/
|
|
401
|
+
abstract grid(grid: ComponentHandle, patch: PluginGridPatch): PluginApiReturn<boolean>;
|
|
328
402
|
/**
|
|
329
403
|
* Update a single space (room) — change its properties (room label, space
|
|
330
404
|
* type, mass type, area class, department) and/or replace its geometry by
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/update/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAiB,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAKL,uBAAuB,EACxB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EACL,oCAAoC,EACpC,kCAAkC,EAClC,kCAAkC,EAClC,mCAAmC,EACpC,MAAM,gCAAgC,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/update/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAiB,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAKL,uBAAuB,EACxB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EACL,oCAAoC,EACpC,kCAAkC,EAClC,kCAAkC,EAClC,mCAAmC,EACpC,MAAM,gCAAgC,CAAA;AAGvC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,+DAA+D;AAC/D,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED,wEAAwE;AACxE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;iBAmBpC,CAAA;AACJ,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;iBAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB;;;;iBAQ1B,CAAA;AACJ,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB;;;iBAO1B,CAAA;AACJ,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE,4DAA4D;AAC5D,eAAO,MAAM,0BAA0B;;;;;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,oEAAoE;AACpE,eAAO,MAAM,4BAA4B;;;iBAGvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,qEAAqE;AACrE,eAAO,MAAM,6BAA6B;;;iBAGxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;iBAM1B,CAAA;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D,4DAA4D;AAC5D,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;GAKG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;aACa,QAAQ,CACtB,SAAS,EAAE,eAAe,EAC1B,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,IAAI,CAClB,IAAI,EAAE,eAAe,EACrB,KAAK,EAAE,eAAe,GACrB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,KAAK,CACnB,KAAK,EAAE,eAAe,EACtB,OAAO,EAAE;QACP,UAAU,CAAC,EAAE,0BAA0B,CAAA;QACvC,QAAQ,CAAC,EAAE,yBAAyB,CAAA;KACrC,GACA,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,MAAM,CACpB,KAAK,EAAE,qBAAqB,EAAE,GAC7B,eAAe,CAAC,uBAAuB,EAAE,CAAC;IAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;aACa,SAAS,CACvB,UAAU,EAAE,eAAe,EAAE,EAC7B,MAAM,EAAE,2BAA2B,GAClC,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;aACa,IAAI,CAClB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,IAAI,CAClB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,KAAK,CACnB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,IAAI,CAClB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,OAAO,CACrB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,YAAY,CAC1B,SAAS,EAAE,eAAe,EAC1B,SAAS,EAAE,MAAM,GAChB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,aAAa,CAC3B,SAAS,EAAE,eAAe,EAC1B,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,SAAS,CACvB,UAAU,EAAE,eAAe,EAAE,EAC7B,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;aACa,iBAAiB,CAC/B,mBAAmB,EAAE,MAAM,EAC3B,WAAW,EAAE,oCAAoC,EAAE,EACnD,UAAU,EAAE,IAAI,GAAG,GAAG,EACtB,QAAQ,EAAE,kCAAkC,EAAE,EAC9C,WAAW,EAAE,kCAAkC,EAC/C,YAAY,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,MAAM,GACzB,eAAe,CAAC,mCAAmC,CAAC;CACxD"}
|