@snaptrude/plugin-core 0.10.0 → 1.0.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/AGENTS.md +4 -0
- package/CHANGELOG.md +187 -3
- package/api-manifest.json +929 -25
- package/dist/api/analysis/daylight.d.ts +5 -5
- package/dist/api/analysis/solar.d.ts +2 -2
- package/dist/api/core/camera/index.d.ts +463 -0
- package/dist/api/core/camera/index.d.ts.map +1 -1
- package/dist/api/core/geom/create/index.d.ts +942 -101
- package/dist/api/core/geom/create/index.d.ts.map +1 -1
- package/dist/api/core/geom/query/brep.d.ts +59 -2
- package/dist/api/core/geom/query/brep.d.ts.map +1 -1
- package/dist/api/core/geom/query/curve.d.ts +59 -35
- package/dist/api/core/geom/query/curve.d.ts.map +1 -1
- package/dist/api/core/geom/query/edge.d.ts +2 -2
- package/dist/api/core/geom/query/face.d.ts +105 -0
- package/dist/api/core/geom/query/face.d.ts.map +1 -1
- package/dist/api/core/geom/update/contour.d.ts +10 -2
- package/dist/api/core/geom/update/contour.d.ts.map +1 -1
- package/dist/api/core/geom/update/curve.d.ts +5 -5
- package/dist/api/core/geom/update/profile.d.ts +3 -1
- package/dist/api/core/geom/update/profile.d.ts.map +1 -1
- package/dist/api/core/handles/index.d.ts +4 -2
- package/dist/api/core/handles/index.d.ts.map +1 -1
- package/dist/api/core/index.d.ts +4 -4
- package/dist/api/core/index.d.ts.map +1 -1
- package/dist/api/core/io/import/index.d.ts +3 -1
- package/dist/api/core/io/import/index.d.ts.map +1 -1
- package/dist/api/core/layers.d.ts +377 -255
- package/dist/api/core/layers.d.ts.map +1 -1
- package/dist/api/core/mode/index.d.ts +19 -7
- package/dist/api/core/mode/index.d.ts.map +1 -1
- package/dist/api/core/project/index.d.ts +68 -1
- package/dist/api/core/project/index.d.ts.map +1 -1
- package/dist/api/core/proposals/index.d.ts +4 -3
- package/dist/api/core/proposals/index.d.ts.map +1 -1
- package/dist/api/core/storeys/index.d.ts +31 -2
- package/dist/api/core/storeys/index.d.ts.map +1 -1
- package/dist/api/core/storeys/layers.d.ts +408 -0
- package/dist/api/core/storeys/layers.d.ts.map +1 -0
- package/dist/api/core/tags.d.ts +84 -3
- package/dist/api/core/tags.d.ts.map +1 -1
- package/dist/api/core/zoom/index.d.ts +13 -0
- package/dist/api/core/zoom/index.d.ts.map +1 -1
- package/dist/api/design/bim.d.ts +299 -0
- package/dist/api/design/bim.d.ts.map +1 -0
- package/dist/api/design/boolean/index.d.ts +2 -0
- package/dist/api/design/boolean/index.d.ts.map +1 -1
- package/dist/api/design/catalog.d.ts +320 -0
- package/dist/api/design/catalog.d.ts.map +1 -0
- package/dist/api/design/create/bulk-items.d.ts +269 -0
- package/dist/api/design/create/bulk-items.d.ts.map +1 -0
- 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 +752 -78
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/create/opening-fields.d.ts +38 -0
- package/dist/api/design/create/opening-fields.d.ts.map +1 -0
- package/dist/api/design/delete/index.d.ts +5 -0
- package/dist/api/design/delete/index.d.ts.map +1 -1
- package/dist/api/design/dimensions.d.ts +427 -0
- package/dist/api/design/dimensions.d.ts.map +1 -0
- package/dist/api/design/doors/index.d.ts +24 -23
- package/dist/api/design/doors/index.d.ts.map +1 -1
- package/dist/api/design/family.d.ts +1446 -0
- package/dist/api/design/family.d.ts.map +1 -0
- package/dist/api/design/furniture/index.d.ts +33 -0
- package/dist/api/design/furniture/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 +30 -0
- package/dist/api/design/index.d.ts.map +1 -1
- package/dist/api/design/networks.d.ts +1703 -0
- package/dist/api/design/networks.d.ts.map +1 -0
- package/dist/api/design/query/geometry/index.d.ts +33 -5
- package/dist/api/design/query/geometry/index.d.ts.map +1 -1
- package/dist/api/design/query/grids.d.ts +287 -0
- package/dist/api/design/query/grids.d.ts.map +1 -0
- package/dist/api/design/query/index.d.ts +143 -34
- package/dist/api/design/query/index.d.ts.map +1 -1
- package/dist/api/design/query/spaces.d.ts +5 -5
- package/dist/api/design/selection/index.d.ts +12 -12
- package/dist/api/design/types/index.d.ts +40 -24
- package/dist/api/design/types/index.d.ts.map +1 -1
- package/dist/api/design/update/index.d.ts +412 -8
- package/dist/api/design/update/index.d.ts.map +1 -1
- package/dist/api/design/visibility.d.ts +28 -0
- package/dist/api/design/visibility.d.ts.map +1 -1
- package/dist/api/design/windows/index.d.ts +8 -8
- package/dist/api/design/windows/index.d.ts.map +1 -1
- package/dist/api/entity/buildableEnvelope.d.ts +84 -2
- package/dist/api/entity/buildableEnvelope.d.ts.map +1 -1
- package/dist/api/entity/referenceLine.d.ts +13 -1
- package/dist/api/entity/referenceLine.d.ts.map +1 -1
- package/dist/api/entity/space.d.ts +12 -12
- package/dist/api/entity/story.d.ts +4 -4
- package/dist/api/presentation/aiInspiration.d.ts +24 -24
- package/dist/api/presentation/annotate.d.ts +38 -22
- package/dist/api/presentation/annotate.d.ts.map +1 -1
- package/dist/api/presentation/camera.d.ts +265 -0
- package/dist/api/presentation/camera.d.ts.map +1 -0
- package/dist/api/presentation/drawingContract.d.ts +32 -0
- package/dist/api/presentation/drawingContract.d.ts.map +1 -0
- package/dist/api/presentation/drawings.d.ts +3523 -0
- package/dist/api/presentation/drawings.d.ts.map +1 -0
- package/dist/api/presentation/export.d.ts +23 -5
- package/dist/api/presentation/export.d.ts.map +1 -1
- package/dist/api/presentation/graphics.d.ts +419 -0
- package/dist/api/presentation/graphics.d.ts.map +1 -0
- package/dist/api/presentation/index.d.ts +66 -12
- package/dist/api/presentation/index.d.ts.map +1 -1
- package/dist/api/presentation/placedViews.d.ts +116 -16
- package/dist/api/presentation/placedViews.d.ts.map +1 -1
- package/dist/api/presentation/sections.d.ts +461 -0
- package/dist/api/presentation/sections.d.ts.map +1 -0
- package/dist/api/presentation/shapes.d.ts +2 -2
- package/dist/api/presentation/sheets.d.ts +175 -19
- package/dist/api/presentation/sheets.d.ts.map +1 -1
- package/dist/api/presentation/standards.d.ts +590 -0
- package/dist/api/presentation/standards.d.ts.map +1 -0
- package/dist/api/presentation/viewPresets.d.ts +222 -0
- package/dist/api/presentation/viewPresets.d.ts.map +1 -0
- package/dist/api/presentation/views.d.ts +144 -9
- package/dist/api/presentation/views.d.ts.map +1 -1
- package/dist/api/presentation/walkthroughs.d.ts +1350 -0
- package/dist/api/presentation/walkthroughs.d.ts.map +1 -0
- package/dist/api/program/departments.d.ts +58 -2
- package/dist/api/program/departments.d.ts.map +1 -1
- package/dist/api/program/index.d.ts +16 -6
- package/dist/api/program/index.d.ts.map +1 -1
- package/dist/api/program/labels.d.ts +355 -0
- package/dist/api/program/labels.d.ts.map +1 -0
- package/dist/api/program/metadata.d.ts +328 -0
- package/dist/api/program/metadata.d.ts.map +1 -0
- package/dist/api/program/site.d.ts +4 -4
- package/dist/api/program/spreadsheet.d.ts +267 -4
- package/dist/api/program/spreadsheet.d.ts.map +1 -1
- package/dist/api/workspace/index.d.ts +49 -2
- package/dist/api/workspace/index.d.ts.map +1 -1
- package/dist/errors/codes.d.ts +3 -1
- package/dist/errors/codes.d.ts.map +1 -1
- package/dist/handles.d.ts +32 -3
- package/dist/handles.d.ts.map +1 -1
- package/dist/index.cjs +6539 -2804
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6121 -2801
- package/dist/index.js.map +1 -1
- package/dist/massParameters.d.ts +287 -0
- package/dist/massParameters.d.ts.map +1 -0
- package/dist/massParameters.ops.d.ts +138 -0
- package/dist/massParameters.ops.d.ts.map +1 -0
- package/package.json +14 -13
- package/scripts/check-dist-fresh.mjs +22 -0
- package/scripts/generate-manifest.mjs +5 -0
- package/scripts/generate-manifest.test.mjs +14 -3
- package/src/api/core/camera/index.ts +446 -1
- package/src/api/core/geom/create/index.ts +1037 -102
- package/src/api/core/geom/query/brep.ts +60 -2
- package/src/api/core/geom/query/curve.ts +26 -2
- package/src/api/core/geom/query/edge.ts +2 -2
- package/src/api/core/geom/query/face.ts +109 -4
- package/src/api/core/geom/update/contour.ts +10 -2
- package/src/api/core/geom/update/profile.ts +2 -0
- package/src/api/core/handles/index.ts +3 -2
- package/src/api/core/index.ts +4 -4
- package/src/api/core/io/import/index.ts +11 -3
- package/src/api/core/layers.ts +380 -173
- package/src/api/core/mode/index.ts +19 -7
- package/src/api/core/project/index.ts +62 -1
- package/src/api/core/proposals/index.ts +4 -3
- package/src/api/core/storeys/index.ts +34 -2
- package/src/api/core/storeys/layers.ts +339 -0
- package/src/api/core/tags.ts +76 -0
- package/src/api/core/zoom/index.ts +13 -0
- package/src/api/design/bim.ts +210 -0
- package/src/api/design/boolean/index.ts +2 -0
- package/src/api/design/catalog.ts +203 -0
- package/src/api/design/create/bulk-items.ts +294 -0
- package/src/api/design/create/grids.ts +137 -0
- package/src/api/design/create/index.ts +823 -114
- package/src/api/design/create/opening-fields.ts +40 -0
- package/src/api/design/delete/index.ts +5 -0
- package/src/api/design/dimensions.ts +453 -0
- package/src/api/design/doors/index.ts +64 -41
- package/src/api/design/family.ts +1342 -0
- package/src/api/design/furniture/index.ts +34 -0
- package/src/api/design/grids.ts +237 -0
- package/src/api/design/index.ts +49 -4
- package/src/api/design/networks.ts +607 -0
- package/src/api/design/query/geometry/index.ts +35 -4
- package/src/api/design/query/grids.ts +197 -0
- package/src/api/design/query/index.ts +105 -3
- package/src/api/design/types/index.ts +31 -24
- package/src/api/design/update/index.ts +398 -4
- package/src/api/design/visibility.ts +34 -0
- package/src/api/design/windows/index.ts +40 -22
- package/src/api/entity/buildableEnvelope.ts +77 -2
- package/src/api/entity/referenceLine.ts +25 -12
- package/src/api/presentation/annotate.ts +90 -58
- package/src/api/presentation/camera.ts +289 -0
- package/src/api/presentation/drawingContract.ts +70 -0
- package/src/api/presentation/drawings.ts +1179 -0
- package/src/api/presentation/export.ts +32 -6
- package/src/api/presentation/graphics.ts +324 -0
- package/src/api/presentation/index.ts +73 -14
- package/src/api/presentation/placedViews.ts +119 -28
- package/src/api/presentation/sections.ts +420 -0
- package/src/api/presentation/sheets.ts +181 -20
- package/src/api/presentation/standards.ts +445 -0
- package/src/api/presentation/viewPresets.ts +241 -0
- package/src/api/presentation/views.ts +81 -10
- package/src/api/presentation/walkthroughs.ts +1201 -0
- package/src/api/program/departments.ts +54 -2
- package/src/api/program/index.ts +16 -6
- package/src/api/program/labels.ts +332 -0
- package/src/api/program/metadata.ts +364 -0
- package/src/api/program/spreadsheet.ts +282 -0
- package/src/api/workspace/index.ts +51 -2
- package/src/errors/codes.ts +7 -0
- package/src/handles.ts +42 -3
- package/src/index.ts +2 -0
- package/src/massParameters.ops.ts +246 -0
- package/src/massParameters.ts +427 -0
- package/test/drawingContract.test.mjs +288 -0
- package/test/errors.test.mjs +1 -0
- package/test/massParameters.test.mjs +952 -0
- package/test/paperPensContract.test.mjs +75 -0
- package/test/presentationViewSettings.test.mjs +85 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"layers.d.ts","sourceRoot":"","sources":["../../../src/api/core/layers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"layers.d.ts","sourceRoot":"","sources":["../../../src/api/core/layers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,8BAAsB,mBAAmB;;IAGvC;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,IAAI,eAAe,CAAC,0BAA0B,CAAC;IAEnE;;;;;;;;;;;;;;;;;OAiBG;aACa,GAAG,CACjB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,yBAAyB,CAAC;IAE7C;;;;;;;;;;;;;;;OAeG;aACa,SAAS,IAAI,eAAe,CAAC,+BAA+B,CAAC;IAE7E;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,MAAM,CACpB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,MAAM,CACpB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,MAAM,CACpB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAC/C,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,SAAS,CACvB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;aACa,MAAM,CACpB,OAAO,EAAE,MAAM,EACf,OAAO,EACH;QAAE,aAAa,EAAE,IAAI,CAAC;QAAC,aAAa,CAAC,EAAE,KAAK,CAAA;KAAE,GAC9C;QAAE,aAAa,CAAC,EAAE,KAAK,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,GACnD,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,MAAM,CACpB,YAAY,EAAE,eAAe,EAAE,EAC/B,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,4BAA4B,CAAC;CACjD;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe;;;;;;;;;iBAS1B,CAAA;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D,wEAAwE;AACxE,eAAO,MAAM,mBAAmB,aAAmC,CAAA;AAEnE;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;iBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;iBAAoC,CAAA;AACxE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,2EAA2E;AAC3E,eAAO,MAAM,yBAAyB;;;;;;;;;kBAA6B,CAAA;AACnE,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED,wFAAwF;AACxF,eAAO,MAAM,+BAA+B;;;;;;;;;kBAA6B,CAAA;AACzE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,4BAA4B;;;;;;;;;iBAAkB,CAAA;AAC3D,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,4BAA4B;;;;;;;;;iBAAkB,CAAA;AAC3D,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,0BAA0B;;;;kBAI5B,CAAA;AACX,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,4BAA4B;;;;;;;;;iBAAkB,CAAA;AAC3D,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;iBAAoC,CAAA;AAC9E,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;;iBAYnC,CAAA;AACJ,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;iBAQvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA"}
|
|
@@ -34,10 +34,14 @@ export interface PluginCoreModeSetResult {
|
|
|
34
34
|
* Not to be confused with the viewport's 2D/3D camera mode
|
|
35
35
|
* (`core.camera.setMode`) or saved presentation views (`presentation.views`).
|
|
36
36
|
*
|
|
37
|
-
* `set` covers `design`, `bim`, and `present` — in-page switches
|
|
38
|
-
* `program
|
|
39
|
-
*
|
|
40
|
-
*
|
|
37
|
+
* `set` covers `design`, `bim`, and `present` — in-page switches — and
|
|
38
|
+
* `program`, which opens the Program tab (a paired browser window) through the
|
|
39
|
+
* same path as the top bar's Program button. Because the open happens outside a
|
|
40
|
+
* user gesture the browser may block the pop-up; the editor then shows its
|
|
41
|
+
* "Allow pop-up to continue" modal and the tab opens when the user confirms.
|
|
42
|
+
* `get()` reports `"program"` only for code running in the Program tab itself.
|
|
43
|
+
* Prefer {@linkcode PluginWorkspaceApi.openProgramMode} when you need to know
|
|
44
|
+
* the tab is ready before calling `program.spreadsheet.*`.
|
|
41
45
|
*/
|
|
42
46
|
export declare abstract class PluginCoreModeApi {
|
|
43
47
|
constructor();
|
|
@@ -76,16 +80,24 @@ export declare abstract class PluginCoreModeApi {
|
|
|
76
80
|
* Switch the editor to another application mode — the same action as
|
|
77
81
|
* clicking that tab in the top menu bar.
|
|
78
82
|
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
83
|
+
* `"design"`, `"bim"` and `"present"` switch in place. `"program"` opens
|
|
84
|
+
* the Program tab (a paired browser window) exactly as the top bar's Program
|
|
85
|
+
* button does, and resolves once that tab has connected to the editor (up to
|
|
86
|
+
* ~90s — the browser may block the pop-up, in which case the editor shows an
|
|
87
|
+
* "Allow pop-up to continue" modal and waits for the user to confirm).
|
|
88
|
+
* Idempotent when the Program tab is already open. Note `get()` in the model
|
|
89
|
+
* tab keeps reporting the model tab's own mode afterwards; the Program tab is
|
|
90
|
+
* a separate window.
|
|
82
91
|
*
|
|
83
92
|
* @param mode - Target mode token from {@linkcode PluginAppMode}
|
|
84
93
|
* @returns The committed `{ mode }` after the switch.
|
|
94
|
+
* @throws `PRECONDITION_FAILED` for `"program"` when the user dismisses the
|
|
95
|
+
* pop-up modal or the tab does not connect within the timeout.
|
|
85
96
|
*
|
|
86
97
|
* @examplePrompt Switch to present mode
|
|
87
98
|
* @examplePrompt Open BIM mode
|
|
88
99
|
* @examplePrompt Go back to design mode
|
|
100
|
+
* @examplePrompt Open program mode
|
|
89
101
|
*
|
|
90
102
|
* # Example
|
|
91
103
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/mode/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;;EAAkD,CAAA;AAC5E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAEzD,eAAO,MAAM,qBAAqB;;;;;;;iBAEhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,aAAa,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,aAAa,CAAA;CACpB;AAED
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/mode/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;;EAAkD,CAAA;AAC5E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAEzD,eAAO,MAAM,qBAAqB;;;;;;;iBAEhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,aAAa,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,aAAa,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,iBAAiB;;IAGrC;;;;;;;;;;;;;OAaG;aACa,IAAI,IAAI,eAAe,CAAC,wBAAwB,CAAC;IAEjE;;;;;;;;;;;;;;OAcG;aACa,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,GAAG,CAAC,IAAI,EAAE,aAAa,GAAG,eAAe,CAAC,uBAAuB,CAAC;CACnF"}
|
|
@@ -3,11 +3,41 @@ import { PluginApiReturn } from "../../../types";
|
|
|
3
3
|
/**
|
|
4
4
|
* Project-level settings and info.
|
|
5
5
|
*
|
|
6
|
-
* Accessed via `snaptrude.core.project`.
|
|
6
|
+
* Accessed via `snaptrude.core.project`. Exposes
|
|
7
|
+
* {@linkcode PluginProjectApi.getInfo} (project identity) and
|
|
7
8
|
* {@linkcode PluginProjectApi.settings} (snap + grid controls).
|
|
8
9
|
*/
|
|
9
10
|
export declare abstract class PluginProjectApi {
|
|
10
11
|
constructor();
|
|
12
|
+
/**
|
|
13
|
+
* Read identity and headline facts about the currently open project — id,
|
|
14
|
+
* display name, unit type, storey count, active storey, and site location
|
|
15
|
+
* when the project is geo-located.
|
|
16
|
+
*
|
|
17
|
+
* `activeStorey` and `storeyCount` are both scoped to the ACTIVE BUILDING, so
|
|
18
|
+
* they always describe the same building. In a multi-building project
|
|
19
|
+
* `storeyCount` is therefore NOT the total across every building — use
|
|
20
|
+
* `core.storeys.list()`, which spans all buildings, for that.
|
|
21
|
+
*
|
|
22
|
+
* @returns A {@linkcode PluginProjectInfo}. `name` is `null` only when the
|
|
23
|
+
* project genuinely has no title; `location` is `null` only when the project
|
|
24
|
+
* is not geo-located. Neither is used to signal a failure.
|
|
25
|
+
* @throws PRECONDITION_FAILED when no project is open.
|
|
26
|
+
* @throws OPERATION_FAILED when the project lookup or the site-location read
|
|
27
|
+
* fails. A failed read is never reported as `null`.
|
|
28
|
+
*
|
|
29
|
+
* @examplePrompt What is this project called?
|
|
30
|
+
* @examplePrompt Where is this project located?
|
|
31
|
+
* @examplePrompt Give me a summary of this project
|
|
32
|
+
* @examplePrompt How many storeys does this project have?
|
|
33
|
+
*
|
|
34
|
+
* # Example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const info = await snaptrude.core.project.getInfo()
|
|
37
|
+
* console.log(info.name, info.units, info.storeyCount)
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
abstract getInfo(): PluginApiReturn<PluginProjectInfo>;
|
|
11
41
|
/** Project settings — snaps and grid. See {@linkcode PluginProjectSettingsApi}. */
|
|
12
42
|
abstract settings: PluginProjectSettingsApi;
|
|
13
43
|
}
|
|
@@ -396,4 +426,41 @@ export declare const PluginToleranceArgs: z.ZodObject<{
|
|
|
396
426
|
value: z.ZodNumber;
|
|
397
427
|
}, z.core.$strip>;
|
|
398
428
|
export type PluginToleranceArgs = z.infer<typeof PluginToleranceArgs>;
|
|
429
|
+
/**
|
|
430
|
+
* Identity and headline facts about the currently open project.
|
|
431
|
+
*
|
|
432
|
+
* `location` is a read-only projection of {@linkcode PluginProgramSiteApi.getLocation}
|
|
433
|
+
* — `program.site.*` remains the full site surface (context, weather, polygons).
|
|
434
|
+
* It is mirrored here because "what and where is this project" is one question.
|
|
435
|
+
*
|
|
436
|
+
* | Property | Type | Description |
|
|
437
|
+
* |---|---|---|
|
|
438
|
+
* | `projectId` | `string` | The open project's id (floorkey) |
|
|
439
|
+
* | `name` | `string \| null` | Display name; `null` only when the project has no title (a failed lookup throws) |
|
|
440
|
+
* | `units` | {@linkcode PUnitType} | The project's unit type |
|
|
441
|
+
* | `activeStorey` | `number` | The active storey value, in the active building |
|
|
442
|
+
* | `storeyCount` | `number` | How many storeys the ACTIVE BUILDING has (not the project-wide total — `core.storeys.list()` spans all buildings) |
|
|
443
|
+
* | `location` | `{ latitude, longitude } \| null` | Site location; `null` only when not geo-located (a failed read throws) |
|
|
444
|
+
*/
|
|
445
|
+
export declare const PluginProjectInfo: z.ZodObject<{
|
|
446
|
+
projectId: z.ZodString;
|
|
447
|
+
name: z.ZodNullable<z.ZodString>;
|
|
448
|
+
units: z.ZodEnum<{
|
|
449
|
+
meters: "meters";
|
|
450
|
+
"feet-inches": "feet-inches";
|
|
451
|
+
inches: "inches";
|
|
452
|
+
centimeters: "centimeters";
|
|
453
|
+
millimeters: "millimeters";
|
|
454
|
+
kilometers: "kilometers";
|
|
455
|
+
miles: "miles";
|
|
456
|
+
babylon: "babylon";
|
|
457
|
+
}>;
|
|
458
|
+
activeStorey: z.ZodNumber;
|
|
459
|
+
storeyCount: z.ZodNumber;
|
|
460
|
+
location: z.ZodNullable<z.ZodObject<{
|
|
461
|
+
latitude: z.ZodNumber;
|
|
462
|
+
longitude: z.ZodNumber;
|
|
463
|
+
}, z.core.$strip>>;
|
|
464
|
+
}, z.core.$strip>;
|
|
465
|
+
export type PluginProjectInfo = z.infer<typeof PluginProjectInfo>;
|
|
399
466
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/project/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/project/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAGhD;;;;;;GAMG;AACH,8BAAsB,gBAAgB;;IAGpC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,OAAO,IAAI,eAAe,CAAC,iBAAiB,CAAC;IAE7D,mFAAmF;IACnF,SAAgB,QAAQ,EAAE,wBAAwB,CAAA;CACnD;AAED;;;;GAIG;AACH,8BAAsB,wBAAwB;;IAG5C;;;;;;;;;;;;;;;;;OAiBG;aACa,YAAY,IAAI,eAAe,CAAC,MAAM,CAAC;IAEvD;;;;;;;;;;;;;;;;;;OAkBG;aACa,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;IAErE,wGAAwG;IACxG,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,oDAAoD;IACpD,SAAgB,IAAI,EAAE,aAAa,CAAA;CACpC;AAED;;;;;;GAMG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;OAiBG;aACa,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;IACrE;;;;;;;;;;;;;;OAcG;aACa,YAAY,IAAI,eAAe,CAAC,MAAM,CAAC;IACvD;;;;;;;;;;;;;OAaG;aACa,eAAe,IAAI,eAAe,CAAC,OAAO,CAAC;IAC3D;;;;;;;;;;;;;OAaG;aACa,gBAAgB,IAAI,eAAe,CAAC,OAAO,CAAC;IAE5D;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;IACjE;;;;;;;;;;;;;;OAcG;aACa,QAAQ,IAAI,eAAe,CAAC,MAAM,CAAC;IACnD;;;;;;;;;;;;;OAaG;aACa,WAAW,IAAI,eAAe,CAAC,OAAO,CAAC;IACvD;;;;;;;;;;;;;OAaG;aACa,YAAY,IAAI,eAAe,CAAC,OAAO,CAAC;IAExD;;;;;;;;;;;;;OAaG;aACa,cAAc,IAAI,eAAe,CAAC,OAAO,CAAC;IAC1D;;;;;;;;;;;;;OAaG;aACa,eAAe,IAAI,eAAe,CAAC,OAAO,CAAC;IAE3D;;;;;;;;;;;;;OAaG;aACa,YAAY,IAAI,eAAe,CAAC,OAAO,CAAC;IACxD;;;;;;;;;;;;;OAaG;aACa,aAAa,IAAI,eAAe,CAAC,OAAO,CAAC;IAEzD;;;;;;;;;;;;;OAaG;aACa,cAAc,IAAI,eAAe,CAAC,OAAO,CAAC;IAC1D;;;;;;;;;;;;;OAaG;aACa,eAAe,IAAI,eAAe,CAAC,OAAO,CAAC;CAC5D;AAED;;;;GAIG;AACH,8BAAsB,aAAa;;IAGjC;;;;;;;;;;;;OAYG;aACa,MAAM,IAAI,eAAe,CAAC,OAAO,CAAC;IAClD;;;;;;;;;;;;OAYG;aACa,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC;IACnD;;;;;;;;;;;;;;;;OAgBG;aACa,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;IACjE;;;;;;;;;;;;;;OAcG;aACa,QAAQ,IAAI,eAAe,CAAC,MAAM,CAAC;CACpD;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB;;iBAE9B,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;;iBAE9B,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;;iBAE9B,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;iBAS5B,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA"}
|
|
@@ -5,7 +5,8 @@ import { ComponentHandle } from "../../../handles";
|
|
|
5
5
|
* Proposals — read and edit the project's design options ("proposals").
|
|
6
6
|
*
|
|
7
7
|
* A **proposal** is a design option: one of several variants of the same
|
|
8
|
-
* project. Each proposal owns a set of buckets (a bucket
|
|
8
|
+
* project. Each proposal owns a set of buckets (a bucket is a layer in the
|
|
9
|
+
* Layers panel; read them with `core.layers.get` / {@linkcode PluginCoreLayersApi}),
|
|
9
10
|
* and switching the active proposal shows/hides the buckets it owns. Proposals
|
|
10
11
|
* are **infrastructure**, not design — they own the buckets/layers geometry
|
|
11
12
|
* lives in — so they sit under `core`, not `design` (constitution §2A).
|
|
@@ -305,8 +306,8 @@ export declare abstract class PluginCoreProposalsApi {
|
|
|
305
306
|
* | `id` | `string` | Stable public proposal id (e.g. `"prop_1"`) |
|
|
306
307
|
* | `name` | `string` | Display name (≤ 24 chars) |
|
|
307
308
|
* | `isActive` | `boolean` | Whether this is the active proposal |
|
|
308
|
-
* | `defaultBucketId` | `string` | Id of the proposal's default
|
|
309
|
-
* | `bucketIds` | `string[]` | Ids of every
|
|
309
|
+
* | `defaultBucketId` | `string` | Id of the proposal's default layer (cannot be unshared); read it with `core.layers.get` ({@linkcode PluginCoreLayersApi}) |
|
|
310
|
+
* | `bucketIds` | `string[]` | Ids of every layer in the Layers panel the proposal owns; read them with `core.layers.get` ({@linkcode PluginCoreLayersApi}) |
|
|
310
311
|
* | `createdAt` | `string` | ISO creation timestamp |
|
|
311
312
|
* | `createdBy` | `string` | User id of the creator |
|
|
312
313
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/proposals/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAElD
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/proposals/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;OAeG;aACa,IAAI,IAAI,eAAe,CAAC,6BAA6B,CAAC;IAEtE;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,SAAS,IAAI,eAAe,CAAC,kCAAkC,CAAC;IAEhF;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,gBAAgB,CAC9B,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,yCAAyC,CAAC;IAE7D;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;IAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;aACa,MAAM,CACpB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,cAAc,EAAE,MAAM,CAAA;QACtB,MAAM,CAAC,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,OAAO,GAAG,WAAW,CAAA;SAAE,EAAE,CAAA;KAC/D,GACA,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;aACa,SAAS,CACvB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,OAAO,EACH;QAAE,aAAa,EAAE,IAAI,CAAC;QAAC,gBAAgB,CAAC,EAAE,KAAK,CAAA;KAAE,GACjD;QAAE,aAAa,CAAC,EAAE,KAAK,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,GACtD,eAAe,CAAC,+BAA+B,CAAC;CACpD;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;iBAQhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;kBAAmC,CAAA;AAC5E,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;kBACb,CAAA;AAClC,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uCAAuC;;iBAElD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,yCAAyC;;;;;;;;;;iBACvB,CAAA;AAC/B,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,yCAAyC,CACjD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;iBAA6B,CAAA;AACzE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;iBAgBtC,CAAA;AACJ,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;;;iBAGxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,gFAAgF;AAChF,eAAO,MAAM,+BAA+B;;;;;;;;iBAAwB,CAAA;AACpE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,6BAA6B;;;;iBAevC,CAAA;AACH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA"}
|
|
@@ -2,6 +2,7 @@ import * as z from "zod";
|
|
|
2
2
|
import { PluginApiReturn } from "../../../types";
|
|
3
3
|
import { ComponentHandle } from "../../../handles";
|
|
4
4
|
import { PluginStoryGetProperty, PluginStoryGetResult, PluginStoryCreateResult, PluginStoryUpdateResult, PluginStorySetActiveResult, PluginStoryDeleteResult, PluginStoryDuplicateResult } from "../../entity/story";
|
|
5
|
+
import { PluginCoreStoreysLayersApi } from "./layers";
|
|
5
6
|
/**
|
|
6
7
|
* Storey (floor) management.
|
|
7
8
|
*
|
|
@@ -14,10 +15,20 @@ import { PluginStoryGetProperty, PluginStoryGetResult, PluginStoryCreateResult,
|
|
|
14
15
|
* API calls** that return Promises and support undo/redo via Snaptrude's command
|
|
15
16
|
* system (except {@linkcode PluginCoreStoreysApi.setActive}, a view change).
|
|
16
17
|
*
|
|
18
|
+
* - {@linkcode PluginCoreStoreysApi.layers} — each storey's sketch surfaces
|
|
19
|
+
* (Wall, Rough) and imported underlays (CAD, PDF, image, terrain): list, get,
|
|
20
|
+
* active layer get/set, show/hide. Not the Layers panel; that is `core.layers`.
|
|
21
|
+
*
|
|
17
22
|
* Accessed via `snaptrude.core.storeys`.
|
|
18
23
|
*/
|
|
19
24
|
export declare abstract class PluginCoreStoreysApi {
|
|
20
25
|
constructor();
|
|
26
|
+
/**
|
|
27
|
+
* Storey layers — each storey's sketch surfaces and imported underlays (ids
|
|
28
|
+
* like `ly_5`), formerly `core.layers`. Not the layers in the Layers panel;
|
|
29
|
+
* use `core.layers` for those. See {@linkcode PluginCoreStoreysLayersApi}.
|
|
30
|
+
*/
|
|
31
|
+
abstract layers: PluginCoreStoreysLayersApi;
|
|
21
32
|
/**
|
|
22
33
|
* Get properties of a storey by its storey number.
|
|
23
34
|
*
|
|
@@ -137,15 +148,32 @@ export declare abstract class PluginCoreStoreysApi {
|
|
|
137
148
|
abstract update(storyValue: number, height?: number, options?: {
|
|
138
149
|
name?: string;
|
|
139
150
|
}): PluginApiReturn<PluginStoryUpdateResult>;
|
|
151
|
+
/**
|
|
152
|
+
* Get the active storey's value. Paired with {@linkcode PluginCoreStoreysApi.setActive}.
|
|
153
|
+
*
|
|
154
|
+
* @returns The active storey value, in the same numbering `list` and `get` use.
|
|
155
|
+
*
|
|
156
|
+
* @examplePrompt Which storey am I on?
|
|
157
|
+
* @examplePrompt What is the current storey?
|
|
158
|
+
*
|
|
159
|
+
* # Example
|
|
160
|
+
* ```ts
|
|
161
|
+
* const storey = await snaptrude.core.storeys.getActive()
|
|
162
|
+
* ```
|
|
163
|
+
*/
|
|
164
|
+
abstract getActive(): PluginApiReturn<number>;
|
|
140
165
|
/**
|
|
141
166
|
* Make a storey the active storey — the same as clicking it in the storey/layer
|
|
142
167
|
* panel. Subsequent draws and creates target this storey, and in 2D the
|
|
143
|
-
* viewport switches to
|
|
168
|
+
* viewport switches to that storey's plan (and its cut range), unless the
|
|
169
|
+
* active view is already a plan on it.
|
|
170
|
+
* This is a view/navigation change: it is **not**
|
|
144
171
|
* undoable and commits nothing to the model.
|
|
145
172
|
*
|
|
146
173
|
* @param storyValue - Integer storey number to activate
|
|
147
174
|
* @returns A {@linkcode PluginStorySetActiveResult} echoing the now-active `storyValue`
|
|
148
|
-
* @throws `PRECONDITION_FAILED` if no storey has the given value
|
|
175
|
+
* @throws `PRECONDITION_FAILED` if no storey has the given value, or in 2D if
|
|
176
|
+
* the storey has no plan
|
|
149
177
|
*
|
|
150
178
|
* @examplePrompt Switch to the second floor
|
|
151
179
|
* @examplePrompt Make the ground storey active
|
|
@@ -248,4 +276,5 @@ export declare const PluginCoreStoreysListResult: z.ZodObject<{
|
|
|
248
276
|
}, z.core.$strip>>;
|
|
249
277
|
}, z.core.$strip>;
|
|
250
278
|
export type PluginCoreStoreysListResult = z.infer<typeof PluginCoreStoreysListResult>;
|
|
279
|
+
export * from "./layers";
|
|
251
280
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/storeys/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EAEpB,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,oBAAoB,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/storeys/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EAEpB,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAA;AAErD;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,oBAAoB;;IAGxC;;;;OAIG;IACH,SAAgB,MAAM,EAAE,0BAA0B,CAAA;IAElD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,sBAAsB,EAAE,GACnC,eAAe,CAAC,oBAAoB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,IAAI,IAAI,eAAe,CAAC,2BAA2B,CAAC;IAEpE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1B,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;OAYG;aACa,SAAS,IAAI,eAAe,CAAC,MAAM,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,SAAS,CACvB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,IAAI,CAClB,SAAS,EAAE,IAAI,GAAG,MAAM,EACxB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7D,eAAe,CAAC,0BAA0B,CAAC;CAC/C;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B;;;;;;iBAEtC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED,cAAc,UAAU,CAAA"}
|