@snaptrude/plugin-core 0.9.10 → 0.9.12
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 +27 -0
- package/api-manifest.json +108 -409
- 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/family.d.ts +561 -0
- package/dist/api/design/family.d.ts.map +1 -0
- 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 +9 -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 +36 -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 +2230 -1967
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +2199 -1970
- 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/family.ts +591 -0
- package/src/api/design/grids.ts +237 -0
- package/src/api/design/index.ts +10 -0
- package/src/api/design/query/grids.ts +197 -0
- package/src/api/design/query/index.ts +29 -0
- package/src/api/design/update/index.ts +53 -0
|
@@ -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,8 @@ import { PluginDesignQueryReferenceLinesApi } from "./referenceLines";
|
|
|
29
30
|
* | `"curtainWall"` | Parametric curtain wall |
|
|
30
31
|
* | `"mullion"` | Curtain-wall mullion |
|
|
31
32
|
* | `"panel"` | Curtain-wall panel |
|
|
33
|
+
* | `"parametricComponent"` | A placed parametric family instance (native or Revit-imported). Its geometry is rebuilt from `design.family` parameters, so read and drive it through `design.family.getParameters` / `setParameters` rather than editing its meshes. |
|
|
34
|
+
* | `"grid"` | Structural grid group |
|
|
32
35
|
*/
|
|
33
36
|
export declare const PluginEntityType: z.ZodEnum<{
|
|
34
37
|
mass: "mass";
|
|
@@ -48,6 +51,8 @@ export declare const PluginEntityType: z.ZodEnum<{
|
|
|
48
51
|
curtainWall: "curtainWall";
|
|
49
52
|
mullion: "mullion";
|
|
50
53
|
panel: "panel";
|
|
54
|
+
parametricComponent: "parametricComponent";
|
|
55
|
+
grid: "grid";
|
|
51
56
|
}>;
|
|
52
57
|
export type PluginEntityType = z.infer<typeof PluginEntityType>;
|
|
53
58
|
/**
|
|
@@ -94,6 +99,8 @@ export declare const PluginEntityFilter: z.ZodObject<{
|
|
|
94
99
|
curtainWall: "curtainWall";
|
|
95
100
|
mullion: "mullion";
|
|
96
101
|
panel: "panel";
|
|
102
|
+
parametricComponent: "parametricComponent";
|
|
103
|
+
grid: "grid";
|
|
97
104
|
}>>>;
|
|
98
105
|
storeys: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
99
106
|
buildingIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
@@ -173,6 +180,8 @@ export declare const PluginDesignQueryListByTypeArgs: z.ZodObject<{
|
|
|
173
180
|
curtainWall: "curtainWall";
|
|
174
181
|
mullion: "mullion";
|
|
175
182
|
panel: "panel";
|
|
183
|
+
parametricComponent: "parametricComponent";
|
|
184
|
+
grid: "grid";
|
|
176
185
|
}>>>;
|
|
177
186
|
storeys: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
178
187
|
buildingIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
@@ -245,6 +254,8 @@ export declare const PluginDesignQueryListByTypeArgs: z.ZodObject<{
|
|
|
245
254
|
curtainWall: "curtainWall";
|
|
246
255
|
mullion: "mullion";
|
|
247
256
|
panel: "panel";
|
|
257
|
+
parametricComponent: "parametricComponent";
|
|
258
|
+
grid: "grid";
|
|
248
259
|
}>;
|
|
249
260
|
}, z.core.$strip>;
|
|
250
261
|
export type PluginDesignQueryListByTypeArgs = z.infer<typeof PluginDesignQueryListByTypeArgs>;
|
|
@@ -308,6 +319,8 @@ export declare const PluginEntityProperties: z.ZodObject<{
|
|
|
308
319
|
curtainWall: "curtainWall";
|
|
309
320
|
mullion: "mullion";
|
|
310
321
|
panel: "panel";
|
|
322
|
+
parametricComponent: "parametricComponent";
|
|
323
|
+
grid: "grid";
|
|
311
324
|
}>>;
|
|
312
325
|
label: z.ZodOptional<z.ZodString>;
|
|
313
326
|
storey: z.ZodOptional<z.ZodNumber>;
|
|
@@ -499,6 +512,8 @@ export declare abstract class PluginDesignQueryApi {
|
|
|
499
512
|
abstract spaces: PluginDesignQuerySpacesApi;
|
|
500
513
|
/** Reference-line-specific reads. See {@linkcode PluginDesignQueryReferenceLinesApi}. */
|
|
501
514
|
abstract referenceLines: PluginDesignQueryReferenceLinesApi;
|
|
515
|
+
/** Structural-grid-specific reads. See {@linkcode PluginDesignQueryGridsApi}. */
|
|
516
|
+
abstract grids: PluginDesignQueryGridsApi;
|
|
502
517
|
constructor();
|
|
503
518
|
/**
|
|
504
519
|
* List **all** BIM entities in the project matching the filter.
|
|
@@ -860,6 +875,24 @@ export declare abstract class PluginDesignQueryApi {
|
|
|
860
875
|
* ```
|
|
861
876
|
*/
|
|
862
877
|
abstract listMullions(filter?: PluginEntityFilter): PluginApiReturn<ComponentHandle[]>;
|
|
878
|
+
/**
|
|
879
|
+
* List all the structural grids (grid groups) in the project, optionally
|
|
880
|
+
* filtered by storey, building, selection state, or region.
|
|
881
|
+
*
|
|
882
|
+
* @param filter - an optional {@linkcode PluginEntityFilter}
|
|
883
|
+
* @returns grid-group {@linkcode ComponentHandle}`[]`
|
|
884
|
+
*
|
|
885
|
+
* @examplePrompt List all the structural grids in the model
|
|
886
|
+
* @examplePrompt How many grids are on the ground floor?
|
|
887
|
+
* @examplePrompt Show the grids on this storey
|
|
888
|
+
* @examplePrompt Which grids are currently selected?
|
|
889
|
+
*
|
|
890
|
+
* # Example
|
|
891
|
+
* ```ts
|
|
892
|
+
* const groundFloorGrids = await snaptrude.design.query.listGrids({ storeys: [1] })
|
|
893
|
+
* ```
|
|
894
|
+
*/
|
|
895
|
+
abstract listGrids(filter?: PluginEntityFilter): PluginApiReturn<ComponentHandle[]>;
|
|
863
896
|
/**
|
|
864
897
|
* Look an entity up by id — returns the same handle if it still resolves live,
|
|
865
898
|
* else `null`. A cheap validity probe (distinct from {@linkcode PluginDesignQueryApi.exists}).
|
|
@@ -1226,6 +1259,8 @@ export declare const PluginStoreyOutlineOptions: z.ZodObject<{
|
|
|
1226
1259
|
curtainWall: "curtainWall";
|
|
1227
1260
|
mullion: "mullion";
|
|
1228
1261
|
panel: "panel";
|
|
1262
|
+
parametricComponent: "parametricComponent";
|
|
1263
|
+
grid: "grid";
|
|
1229
1264
|
}>>>;
|
|
1230
1265
|
minArea: z.ZodDefault<z.ZodNumber>;
|
|
1231
1266
|
}, z.core.$strip>;
|
|
@@ -1279,4 +1314,5 @@ export type PluginStoreyOutlineResult = z.infer<typeof PluginStoreyOutlineResult
|
|
|
1279
1314
|
export * from "./geometry";
|
|
1280
1315
|
export * from "./spaces";
|
|
1281
1316
|
export * from "./referenceLines";
|
|
1317
|
+
export * from "./grids";
|
|
1282
1318
|
//# 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;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;EAoB3B,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"}
|