@snaptrude/plugin-core 0.9.16-networks-20261012.1 → 0.9.17
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 +6 -0
- package/api-manifest.json +9711 -0
- 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 +0 -29
- package/dist/api/core/camera/index.d.ts.map +1 -1
- package/dist/api/core/zoom/index.d.ts +0 -13
- package/dist/api/core/zoom/index.d.ts.map +1 -1
- package/dist/api/design/create/bulk-items.d.ts +21 -40
- package/dist/api/design/create/bulk-items.d.ts.map +1 -1
- package/dist/api/design/create/index.d.ts +97 -120
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/create/opening-fields.d.ts +12 -13
- package/dist/api/design/create/opening-fields.d.ts.map +1 -1
- package/dist/api/design/doors/index.d.ts +24 -18
- package/dist/api/design/doors/index.d.ts.map +1 -1
- package/dist/api/design/family.d.ts +27 -797
- package/dist/api/design/family.d.ts.map +1 -1
- package/dist/api/design/index.d.ts +0 -16
- package/dist/api/design/index.d.ts.map +1 -1
- package/dist/api/design/query/index.d.ts +30 -30
- package/dist/api/design/selection/index.d.ts +10 -10
- package/dist/api/design/types/index.d.ts +24 -40
- package/dist/api/design/types/index.d.ts.map +1 -1
- package/dist/api/design/update/index.d.ts +3 -40
- package/dist/api/design/update/index.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/presentation/aiInspiration.d.ts +10 -10
- package/dist/api/presentation/annotate.d.ts +22 -38
- package/dist/api/presentation/annotate.d.ts.map +1 -1
- package/dist/api/presentation/export.d.ts +5 -23
- package/dist/api/presentation/export.d.ts.map +1 -1
- package/dist/api/presentation/index.d.ts +21 -32
- package/dist/api/presentation/index.d.ts.map +1 -1
- package/dist/api/presentation/placedViews.d.ts +6 -106
- 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 +19 -175
- package/dist/api/presentation/sheets.d.ts.map +1 -1
- package/dist/api/presentation/views.d.ts +5 -103
- package/dist/api/presentation/views.d.ts.map +1 -1
- package/dist/api/presentation/walkthroughs.d.ts +6 -6
- package/dist/index.cjs +2434 -3619
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +2421 -3501
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/scripts/generate-manifest.mjs +0 -5
- package/src/api/core/camera/index.ts +0 -29
- package/src/api/core/zoom/index.ts +0 -13
- package/src/api/design/create/bulk-items.ts +16 -23
- package/src/api/design/create/index.ts +119 -129
- package/src/api/design/create/opening-fields.ts +12 -15
- package/src/api/design/doors/index.ts +42 -58
- package/src/api/design/family.ts +32 -662
- package/src/api/design/index.ts +4 -34
- package/src/api/design/types/index.ts +24 -31
- package/src/api/design/update/index.ts +3 -41
- package/src/api/design/windows/index.ts +22 -40
- package/src/api/presentation/annotate.ts +58 -90
- package/src/api/presentation/export.ts +6 -32
- package/src/api/presentation/index.ts +23 -39
- package/src/api/presentation/placedViews.ts +28 -119
- package/src/api/presentation/sections.ts +420 -0
- package/src/api/presentation/sheets.ts +20 -181
- package/src/api/presentation/views.ts +6 -46
- package/dist/api/design/bim.d.ts +0 -209
- package/dist/api/design/bim.d.ts.map +0 -1
- package/dist/api/design/catalog.d.ts +0 -320
- package/dist/api/design/catalog.d.ts.map +0 -1
- package/dist/api/design/networks.d.ts +0 -1703
- package/dist/api/design/networks.d.ts.map +0 -1
- package/dist/api/presentation/drawingContract.d.ts +0 -32
- package/dist/api/presentation/drawingContract.d.ts.map +0 -1
- package/dist/api/presentation/drawings.d.ts +0 -3523
- package/dist/api/presentation/drawings.d.ts.map +0 -1
- package/dist/api/presentation/viewPresets.d.ts +0 -222
- package/dist/api/presentation/viewPresets.d.ts.map +0 -1
- package/src/api/design/bim.ts +0 -121
- package/src/api/design/catalog.ts +0 -203
- package/src/api/design/networks.ts +0 -607
- package/src/api/presentation/drawingContract.ts +0 -70
- package/src/api/presentation/drawings.ts +0 -1179
- package/src/api/presentation/viewPresets.ts +0 -241
- package/test/drawingContract.test.mjs +0 -288
|
@@ -128,21 +128,14 @@ export declare abstract class PluginPresentationPlacedViewsApi {
|
|
|
128
128
|
abstract scale(shapeId: string, factor: number): PluginApiReturn<PluginPlacedView>;
|
|
129
129
|
/**
|
|
130
130
|
* Set a placed view's architectural scale.
|
|
131
|
-
* `scale` must be a standard architectural scale denominator (100 means 1:100)
|
|
132
|
-
* in the project's unit system; any other value is rejected. Metric: 10, 20, 50,
|
|
133
|
-
* 100, 150, 200, 250, 500, 1000. Imperial detail: 12, 16, 24, 32, 48, 64, 96, 128,
|
|
134
|
-
* 192, 384, 768, 1536 (1" = 1' to 1/128" = 1'; 48 is 1/4" = 1', 96 is 1/8" = 1').
|
|
135
|
-
* Imperial site: 120, 240, 360, 480, 600, 1200, 2400, 3600, 4800 (1" = 10' to
|
|
136
|
-
* 1" = 400'). Pick the LARGEST standard scale (smallest denominator) at which the
|
|
137
|
-
* view still fits its frame or sheet and its room labels stay readable: for a
|
|
138
|
-
* building floor plan that is usually 1:50 to 1:200 (1/4" = 1' to 1/16" = 1').
|
|
139
|
-
* Never use a site-sized scale (1:500 and up, 1/64" = 1' (768) and smaller,
|
|
140
|
-
* 1" = 20' (240) and up) for a single building plan unless the user asked for it.
|
|
141
131
|
*
|
|
142
132
|
* Applies a standard architectural scale — the same write the placed view's
|
|
143
133
|
* Scale dropdown performs. The view (and its labels) is resized about its
|
|
144
|
-
* top-left corner so it prints at the given scale
|
|
145
|
-
*
|
|
134
|
+
* top-left corner so it prints at the given scale. `scale` must be one of
|
|
135
|
+
* the standard values for the project's unit system (metric `10, 20, 50,
|
|
136
|
+
* 100, 150, 200, 250, 500, 1000`; imperial e.g. `48` for 1/4″ = 1′, `96`
|
|
137
|
+
* for 1/8″ = 1′, `120` for 1″ = 10′) — the same validation as
|
|
138
|
+
* `sheets.place`. 3D views have no architectural scale — calling this on
|
|
146
139
|
* one throws. Requires Present mode to be open.
|
|
147
140
|
*
|
|
148
141
|
* @param shapeId - The placed view shape to set the scale of.
|
|
@@ -734,27 +727,12 @@ export type PluginPresentationPlacedViewsSetRotationArgs = z.infer<typeof Plugin
|
|
|
734
727
|
*/
|
|
735
728
|
export declare const PluginViewSettingCategory: z.ZodEnum<{
|
|
736
729
|
Envelope: "Envelope";
|
|
737
|
-
Furniture: "Furniture";
|
|
738
730
|
Department: "Department";
|
|
739
731
|
Site: "Site";
|
|
740
732
|
Topography: "Topography";
|
|
741
733
|
Space: "Space";
|
|
742
734
|
"Facade/Mass": "Facade/Mass";
|
|
743
735
|
Dimension: "Dimension";
|
|
744
|
-
Grid: "Grid";
|
|
745
|
-
Walls: "Walls";
|
|
746
|
-
Columns: "Columns";
|
|
747
|
-
Beams: "Beams";
|
|
748
|
-
Doors: "Doors";
|
|
749
|
-
Windows: "Windows";
|
|
750
|
-
Floors: "Floors";
|
|
751
|
-
Slabs: "Slabs";
|
|
752
|
-
Roofs: "Roofs";
|
|
753
|
-
Ceilings: "Ceilings";
|
|
754
|
-
Staircase: "Staircase";
|
|
755
|
-
Families: "Families";
|
|
756
|
-
Underlay: "Underlay";
|
|
757
|
-
Overlay: "Overlay";
|
|
758
736
|
"Reference Line": "Reference Line";
|
|
759
737
|
"Adjacency Line": "Adjacency Line";
|
|
760
738
|
"Landscape elements": "Landscape elements";
|
|
@@ -783,7 +761,7 @@ export type PluginViewLineStyle = z.infer<typeof PluginViewLineStyle>;
|
|
|
783
761
|
* | `lineStyle` | {@linkcode PluginViewLineStyle}? | Dash pattern |
|
|
784
762
|
* | `lineColor` | `string`? | Line color, 6-digit hex (`#` optional) |
|
|
785
763
|
* | `dashLength` | `number`? | Dash-length multiplier (> 0; `1` = default) |
|
|
786
|
-
* | `lineWidth` | `number`? | Single line weight in mm (
|
|
764
|
+
* | `lineWidth` | `number`? | Single line weight in mm (categories without cut/projection) |
|
|
787
765
|
* | `cutWidth` | `number`? | Cut-line weight in mm |
|
|
788
766
|
* | `projectionWidth` | `number`? | Projection-line weight in mm |
|
|
789
767
|
* | `treeLineWidth` | `number`? | Tree line weight in mm (Landscape) |
|
|
@@ -831,30 +809,6 @@ export declare const PluginPlacedViewStylePatch: z.ZodObject<{
|
|
|
831
809
|
}>>;
|
|
832
810
|
radius: z.ZodOptional<z.ZodNumber>;
|
|
833
811
|
inset: z.ZodOptional<z.ZodNumber>;
|
|
834
|
-
markerKind: z.ZodOptional<z.ZodEnum<{
|
|
835
|
-
architecturalTick: "architecturalTick";
|
|
836
|
-
openArrow: "openArrow";
|
|
837
|
-
closedArrow: "closedArrow";
|
|
838
|
-
}>>;
|
|
839
|
-
markerSize: z.ZodOptional<z.ZodNumber>;
|
|
840
|
-
extensionLineVisible: z.ZodOptional<z.ZodBoolean>;
|
|
841
|
-
extensionLineStyle: z.ZodOptional<z.ZodEnum<{
|
|
842
|
-
center: "center";
|
|
843
|
-
hidden: "hidden";
|
|
844
|
-
solid: "solid";
|
|
845
|
-
dashed: "dashed";
|
|
846
|
-
dashdot: "dashdot";
|
|
847
|
-
phantom: "phantom";
|
|
848
|
-
propertyLine: "propertyLine";
|
|
849
|
-
}>>;
|
|
850
|
-
extensionGap: z.ZodOptional<z.ZodNumber>;
|
|
851
|
-
extensionOvershoot: z.ZodOptional<z.ZodNumber>;
|
|
852
|
-
textColor: z.ZodOptional<z.ZodString>;
|
|
853
|
-
textGap: z.ZodOptional<z.ZodNumber>;
|
|
854
|
-
textPlacement: z.ZodOptional<z.ZodLiteral<"above">>;
|
|
855
|
-
textMask: z.ZodOptional<z.ZodBoolean>;
|
|
856
|
-
textMaskColor: z.ZodOptional<z.ZodString>;
|
|
857
|
-
textMaskPadding: z.ZodOptional<z.ZodNumber>;
|
|
858
812
|
}, z.core.$strict>;
|
|
859
813
|
export type PluginPlacedViewStylePatch = z.infer<typeof PluginPlacedViewStylePatch>;
|
|
860
814
|
/** Label types that carry typography in a category's Text tab. */
|
|
@@ -958,27 +912,12 @@ export declare const PluginPlacedViewsUpdateStylesArgs: z.ZodObject<{
|
|
|
958
912
|
shapeId: z.ZodString;
|
|
959
913
|
category: z.ZodEnum<{
|
|
960
914
|
Envelope: "Envelope";
|
|
961
|
-
Furniture: "Furniture";
|
|
962
915
|
Department: "Department";
|
|
963
916
|
Site: "Site";
|
|
964
917
|
Topography: "Topography";
|
|
965
918
|
Space: "Space";
|
|
966
919
|
"Facade/Mass": "Facade/Mass";
|
|
967
920
|
Dimension: "Dimension";
|
|
968
|
-
Grid: "Grid";
|
|
969
|
-
Walls: "Walls";
|
|
970
|
-
Columns: "Columns";
|
|
971
|
-
Beams: "Beams";
|
|
972
|
-
Doors: "Doors";
|
|
973
|
-
Windows: "Windows";
|
|
974
|
-
Floors: "Floors";
|
|
975
|
-
Slabs: "Slabs";
|
|
976
|
-
Roofs: "Roofs";
|
|
977
|
-
Ceilings: "Ceilings";
|
|
978
|
-
Staircase: "Staircase";
|
|
979
|
-
Families: "Families";
|
|
980
|
-
Underlay: "Underlay";
|
|
981
|
-
Overlay: "Overlay";
|
|
982
921
|
"Reference Line": "Reference Line";
|
|
983
922
|
"Adjacency Line": "Adjacency Line";
|
|
984
923
|
"Landscape elements": "Landscape elements";
|
|
@@ -1015,30 +954,6 @@ export declare const PluginPlacedViewsUpdateStylesArgs: z.ZodObject<{
|
|
|
1015
954
|
}>>;
|
|
1016
955
|
radius: z.ZodOptional<z.ZodNumber>;
|
|
1017
956
|
inset: z.ZodOptional<z.ZodNumber>;
|
|
1018
|
-
markerKind: z.ZodOptional<z.ZodEnum<{
|
|
1019
|
-
architecturalTick: "architecturalTick";
|
|
1020
|
-
openArrow: "openArrow";
|
|
1021
|
-
closedArrow: "closedArrow";
|
|
1022
|
-
}>>;
|
|
1023
|
-
markerSize: z.ZodOptional<z.ZodNumber>;
|
|
1024
|
-
extensionLineVisible: z.ZodOptional<z.ZodBoolean>;
|
|
1025
|
-
extensionLineStyle: z.ZodOptional<z.ZodEnum<{
|
|
1026
|
-
center: "center";
|
|
1027
|
-
hidden: "hidden";
|
|
1028
|
-
solid: "solid";
|
|
1029
|
-
dashed: "dashed";
|
|
1030
|
-
dashdot: "dashdot";
|
|
1031
|
-
phantom: "phantom";
|
|
1032
|
-
propertyLine: "propertyLine";
|
|
1033
|
-
}>>;
|
|
1034
|
-
extensionGap: z.ZodOptional<z.ZodNumber>;
|
|
1035
|
-
extensionOvershoot: z.ZodOptional<z.ZodNumber>;
|
|
1036
|
-
textColor: z.ZodOptional<z.ZodString>;
|
|
1037
|
-
textGap: z.ZodOptional<z.ZodNumber>;
|
|
1038
|
-
textPlacement: z.ZodOptional<z.ZodLiteral<"above">>;
|
|
1039
|
-
textMask: z.ZodOptional<z.ZodBoolean>;
|
|
1040
|
-
textMaskColor: z.ZodOptional<z.ZodString>;
|
|
1041
|
-
textMaskPadding: z.ZodOptional<z.ZodNumber>;
|
|
1042
957
|
}, z.core.$strict>;
|
|
1043
958
|
}, z.core.$strip>;
|
|
1044
959
|
export type PluginPlacedViewsUpdateStylesArgs = z.infer<typeof PluginPlacedViewsUpdateStylesArgs>;
|
|
@@ -1047,27 +962,12 @@ export declare const PluginPlacedViewsUpdateFontStylesArgs: z.ZodObject<{
|
|
|
1047
962
|
shapeId: z.ZodString;
|
|
1048
963
|
category: z.ZodEnum<{
|
|
1049
964
|
Envelope: "Envelope";
|
|
1050
|
-
Furniture: "Furniture";
|
|
1051
965
|
Department: "Department";
|
|
1052
966
|
Site: "Site";
|
|
1053
967
|
Topography: "Topography";
|
|
1054
968
|
Space: "Space";
|
|
1055
969
|
"Facade/Mass": "Facade/Mass";
|
|
1056
970
|
Dimension: "Dimension";
|
|
1057
|
-
Grid: "Grid";
|
|
1058
|
-
Walls: "Walls";
|
|
1059
|
-
Columns: "Columns";
|
|
1060
|
-
Beams: "Beams";
|
|
1061
|
-
Doors: "Doors";
|
|
1062
|
-
Windows: "Windows";
|
|
1063
|
-
Floors: "Floors";
|
|
1064
|
-
Slabs: "Slabs";
|
|
1065
|
-
Roofs: "Roofs";
|
|
1066
|
-
Ceilings: "Ceilings";
|
|
1067
|
-
Staircase: "Staircase";
|
|
1068
|
-
Families: "Families";
|
|
1069
|
-
Underlay: "Underlay";
|
|
1070
|
-
Overlay: "Overlay";
|
|
1071
971
|
"Reference Line": "Reference Line";
|
|
1072
972
|
"Adjacency Line": "Adjacency Line";
|
|
1073
973
|
"Landscape elements": "Landscape elements";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"placedViews.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/placedViews.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;
|
|
1
|
+
{"version":3,"file":"placedViews.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/placedViews.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAE9C;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,gCAAgC;;IAGpD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,IAAI,CAClB,OAAO,CAAC,EAAE,MAAM,GACf,eAAe,CAAC,uCAAuC,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;OAmBG;aACa,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe,CAAC,gBAAgB,CAAC;IAEvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,IAAI,CAClB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,mBAAmB,EAC7B,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7B,eAAe,CAAC,gBAAgB,CAAC;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,gBAAgB,CAAC;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,QAAQ,CACtB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,gBAAgB,CAAC;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,OAAO,CACrB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,oBAAoB,GAAG,IAAI,GAChC,eAAe,CAAC,gBAAgB,CAAC;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;aACa,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,eAAe,CAAC,gBAAgB,CAAC;IAIpC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,SAAS,CACvB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;aACa,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,yBAAyB,EACnC,KAAK,EAAE,0BAA0B,GAChC,eAAe,CAAC,8BAA8B,CAAC;IAElD;;;;;;;;;;;;OAYG;aACa,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;aACa,gBAAgB,CAC9B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,yBAAyB,EACnC,KAAK,EAAE,+BAA+B,GACrC,eAAe,CAAC,IAAI,CAAC;IAIxB;;;;;;;;;;;;;;;;;;OAkBG;aACa,UAAU,CACxB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;OAYG;aACa,SAAS,CACvB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,mBAAmB,GAC5B,eAAe,CAAC,qBAAqB,CAAC;IAEzC;;;;;;;;;;OAUG;aACa,cAAc,CAC5B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,OAAO,GACd,eAAe,CAAC,qBAAqB,CAAC;IAIzC;;;;;;;;;;;;;;;;;;OAkBG;aACa,UAAU,CACxB,OAAO,CAAC,EAAE,MAAM,GACf,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;OAUG;aACa,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe,CAAC,iBAAiB,CAAC;IAE7E;;;;;;;;;;;;;;;OAeG;aACa,SAAS,CACvB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,mBAAmB,EAC7B,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7B,eAAe,CAAC,iBAAiB,CAAC;IAErC;;;;;;;;;;;;OAYG;aACa,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,iBAAiB,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,eAAe,CAAC,iBAAiB,CAAC;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,YAAY,CAC1B,QAAQ,EAAE,MAAM,EAAE,GACjB,eAAe,CAAC,8BAA8B,CAAC;IAElD;;;;;;;;;;;;OAYG;aACa,UAAU,CACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,IAAI,CAAC;IAExB;;;;;;;;;;;OAWG;aACa,OAAO,CACrB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,GACf,eAAe,CAAC,IAAI,CAAC;CACzB;AAQD;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;iBAQ9B,CAAA;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAY3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D,uEAAuE;AACvE,eAAO,MAAM,qCAAqC;;iBAEhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED,mEAAmE;AACnE,eAAO,MAAM,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAElD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED,sEAAsE;AACtE,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,qCAAqC;;;;;;;iBAIhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,sCAAsC;;;iBAGjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,yCAAyC;;;iBAGpD,CAAA;AACF,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,yCAAyC,CACjD,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;iBAGnD,CAAA;AACF,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,4CAA4C;;;iBAGvD,CAAA;AACF,MAAM,MAAM,4CAA4C,GAAG,CAAC,CAAC,KAAK,CAChE,OAAO,4CAA4C,CACpD,CAAA;AAID;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;EAWpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF,+DAA+D;AAC/D,eAAO,MAAM,mBAAmB;;;;;;;;EAQ9B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAgCwD,CAAA;AAC/F,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF,kEAAkE;AAClE,eAAO,MAAM,mBAAmB;;;;EAAkD,CAAA;AAClF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAerE;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAQiD,CAAA;AAC7F,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAE7F,gEAAgE;AAChE,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,yBAAyB,CAAA;IACnC,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,QAAQ,EAAE,0BAA0B,CAAA;IACpC,UAAU,CAAC,EAAE;QACX,YAAY,EAAE,mBAAmB,EAAE,CAAA;QACnC,YAAY,CAAC,EAAE,qBAAqB,CAAA;QACpC,UAAU,CAAC,EAAE,qBAAqB,CAAA;QAClC,KAAK,CAAC,EAAE,qBAAqB,CAAA;KAC9B,CAAA;CACF,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,UAAU,EAAE,8BAA8B,EAAE,CAAA;CAC7C,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA;AAEjG,+EAA+E;AAC/E,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAID;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,mBAAmB,CAAA;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,qBAAqB,EAAE,CAAA;CAChC,CAAA;AAED,wEAAwE;AACxE,eAAO,MAAM,8BAA8B;;;;;;iBAGzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAE3F,6EAA6E;AAC7E,eAAO,MAAM,mCAAmC;;;iBAG9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAID;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;EAQlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,uBAAuB,CAAA;IAC/B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,EAAE,mBAAmB,CAAA;IAC7B,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IACvC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,iBAAiB,EAAE,CAAA;CAC5B,CAAA;AAED,uEAAuE;AACvE,MAAM,MAAM,8BAA8B,GAAG;IAC3C,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB,CAAA;AAED,wEAAwE;AACxE,eAAO,MAAM,8BAA8B;;;;;;;iBAIzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAE3F,0EAA0E;AAC1E,eAAO,MAAM,gCAAgC;;;iBAG3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAE/F,0EAA0E;AAC1E,eAAO,MAAM,4CAA4C;;;iBAGvD,CAAA;AACF,MAAM,MAAM,4CAA4C,GAAG,CAAC,CAAC,KAAK,CAChE,OAAO,4CAA4C,CACpD,CAAA;AAED,2EAA2E;AAC3E,eAAO,MAAM,iCAAiC;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA;AAEjG,yEAAyE;AACzE,eAAO,MAAM,+BAA+B;;;iBAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAE7F,sEAAsE;AACtE,eAAO,MAAM,4BAA4B;;;iBAGvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA"}
|
|
@@ -0,0 +1,461 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
import type { PluginApiReturn } from "../../types";
|
|
3
|
+
/** A point on the plan: world `x` and `z` in babylon units. */
|
|
4
|
+
export declare const PluginSectionPoint: z.ZodObject<{
|
|
5
|
+
x: z.ZodNumber;
|
|
6
|
+
z: z.ZodNumber;
|
|
7
|
+
}, z.core.$strict>;
|
|
8
|
+
export type PluginSectionPoint = z.infer<typeof PluginSectionPoint>;
|
|
9
|
+
/**
|
|
10
|
+
* A section: a line drawn on the plan that cuts the model and looks one way
|
|
11
|
+
* along it.
|
|
12
|
+
*
|
|
13
|
+
* | Property | Type | Description |
|
|
14
|
+
* |---|---|---|
|
|
15
|
+
* | `sectionId` | `string` | The section's id |
|
|
16
|
+
* | `name` | `string` | Its name in the Views panel ("Section 1") |
|
|
17
|
+
* | `tagLabel` | `string` | What its heads are marked with on the plan ("A") |
|
|
18
|
+
* | `buildingId` | `string` | The building it belongs to |
|
|
19
|
+
* | `start` | {@linkcode PluginSectionPoint} | First head on the plan |
|
|
20
|
+
* | `end` | {@linkcode PluginSectionPoint} | Second head on the plan |
|
|
21
|
+
* | `isFlipped` | `boolean` | Looks the other way along the line |
|
|
22
|
+
* | `depth` | `number` | How far behind the line the view keeps, babylon units |
|
|
23
|
+
* | `base` | `number` | Bottom of the slice, world Y |
|
|
24
|
+
* | `top` | `number` | Top of the slice, world Y |
|
|
25
|
+
* | `isHidden` | `boolean` | The line is hidden on the plan |
|
|
26
|
+
* | `isLocked` | `boolean` | Geometry edits are refused |
|
|
27
|
+
* | `isActive` | `boolean` | It is the section view open now |
|
|
28
|
+
*/
|
|
29
|
+
export declare const PluginSection: z.ZodObject<{
|
|
30
|
+
sectionId: z.ZodString;
|
|
31
|
+
name: z.ZodString;
|
|
32
|
+
tagLabel: z.ZodString;
|
|
33
|
+
buildingId: z.ZodString;
|
|
34
|
+
start: z.ZodObject<{
|
|
35
|
+
x: z.ZodNumber;
|
|
36
|
+
z: z.ZodNumber;
|
|
37
|
+
}, z.core.$strict>;
|
|
38
|
+
end: z.ZodObject<{
|
|
39
|
+
x: z.ZodNumber;
|
|
40
|
+
z: z.ZodNumber;
|
|
41
|
+
}, z.core.$strict>;
|
|
42
|
+
isFlipped: z.ZodBoolean;
|
|
43
|
+
depth: z.ZodNumber;
|
|
44
|
+
base: z.ZodNumber;
|
|
45
|
+
top: z.ZodNumber;
|
|
46
|
+
isHidden: z.ZodBoolean;
|
|
47
|
+
isLocked: z.ZodBoolean;
|
|
48
|
+
isActive: z.ZodBoolean;
|
|
49
|
+
}, z.core.$strip>;
|
|
50
|
+
export type PluginSection = z.infer<typeof PluginSection>;
|
|
51
|
+
export declare const PluginSectionIdArgs: z.ZodObject<{
|
|
52
|
+
sectionId: z.ZodString;
|
|
53
|
+
}, z.core.$strict>;
|
|
54
|
+
export type PluginSectionIdArgs = z.infer<typeof PluginSectionIdArgs>;
|
|
55
|
+
/**
|
|
56
|
+
* Options for {@linkcode PluginPresentationSectionsApi.create}.
|
|
57
|
+
*
|
|
58
|
+
* | Property | Type | Description |
|
|
59
|
+
* |---|---|---|
|
|
60
|
+
* | `name` | `string \| undefined` | Name in the Views panel (default: the next "Section N") |
|
|
61
|
+
* | `tagLabel` | `string \| undefined` | Head mark on the plan (default: the next free mark) |
|
|
62
|
+
* | `depth` | `number \| undefined` | How far behind the line the view keeps (default: to the far side of the model) |
|
|
63
|
+
* | `base` | `number \| undefined` | Bottom of the slice, world Y (default: the building's base) |
|
|
64
|
+
* | `top` | `number \| undefined` | Top of the slice, world Y (default: the building's top) |
|
|
65
|
+
* | `buildingId` | `string \| undefined` | Building it belongs to (default: the active one) |
|
|
66
|
+
* | `isActive` | `boolean \| undefined` | Open the section view once created (default `false`) |
|
|
67
|
+
*/
|
|
68
|
+
export declare const PluginSectionCreateOptions: z.ZodObject<{
|
|
69
|
+
name: z.ZodOptional<z.ZodString>;
|
|
70
|
+
tagLabel: z.ZodOptional<z.ZodString>;
|
|
71
|
+
depth: z.ZodOptional<z.ZodNumber>;
|
|
72
|
+
base: z.ZodOptional<z.ZodNumber>;
|
|
73
|
+
top: z.ZodOptional<z.ZodNumber>;
|
|
74
|
+
buildingId: z.ZodOptional<z.ZodString>;
|
|
75
|
+
isActive: z.ZodOptional<z.ZodBoolean>;
|
|
76
|
+
}, z.core.$strict>;
|
|
77
|
+
export type PluginSectionCreateOptions = z.infer<typeof PluginSectionCreateOptions>;
|
|
78
|
+
export declare const PluginSectionCreateArgs: z.ZodObject<{
|
|
79
|
+
start: z.ZodObject<{
|
|
80
|
+
x: z.ZodNumber;
|
|
81
|
+
z: z.ZodNumber;
|
|
82
|
+
}, z.core.$strict>;
|
|
83
|
+
end: z.ZodObject<{
|
|
84
|
+
x: z.ZodNumber;
|
|
85
|
+
z: z.ZodNumber;
|
|
86
|
+
}, z.core.$strict>;
|
|
87
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
88
|
+
name: z.ZodOptional<z.ZodString>;
|
|
89
|
+
tagLabel: z.ZodOptional<z.ZodString>;
|
|
90
|
+
depth: z.ZodOptional<z.ZodNumber>;
|
|
91
|
+
base: z.ZodOptional<z.ZodNumber>;
|
|
92
|
+
top: z.ZodOptional<z.ZodNumber>;
|
|
93
|
+
buildingId: z.ZodOptional<z.ZodString>;
|
|
94
|
+
isActive: z.ZodOptional<z.ZodBoolean>;
|
|
95
|
+
}, z.core.$strict>>;
|
|
96
|
+
}, z.core.$strict>;
|
|
97
|
+
export type PluginSectionCreateArgs = z.infer<typeof PluginSectionCreateArgs>;
|
|
98
|
+
/**
|
|
99
|
+
* The fields to change in {@linkcode PluginPresentationSectionsApi.update};
|
|
100
|
+
* omitted fields keep their value.
|
|
101
|
+
*
|
|
102
|
+
* | Property | Type | Description |
|
|
103
|
+
* |---|---|---|
|
|
104
|
+
* | `name` | `string \| undefined` | Name in the Views panel |
|
|
105
|
+
* | `tagLabel` | `string \| undefined` | Head mark on the plan |
|
|
106
|
+
* | `start` | {@linkcode PluginSectionPoint} `\| undefined` | First head |
|
|
107
|
+
* | `end` | {@linkcode PluginSectionPoint} `\| undefined` | Second head |
|
|
108
|
+
* | `isFlipped` | `boolean \| undefined` | Look the other way; without `depth`, the depth re-spans the model the new way |
|
|
109
|
+
* | `depth` | `number \| undefined` | View depth behind the line, > 0 |
|
|
110
|
+
* | `base` | `number \| undefined` | Bottom of the slice, world Y |
|
|
111
|
+
* | `top` | `number \| undefined` | Top of the slice, world Y; above `base` |
|
|
112
|
+
* | `isHidden` | `boolean \| undefined` | Hide the line on the plan |
|
|
113
|
+
*/
|
|
114
|
+
export declare const PluginSectionPatch: z.ZodObject<{
|
|
115
|
+
name: z.ZodOptional<z.ZodString>;
|
|
116
|
+
tagLabel: z.ZodOptional<z.ZodString>;
|
|
117
|
+
start: z.ZodOptional<z.ZodObject<{
|
|
118
|
+
x: z.ZodNumber;
|
|
119
|
+
z: z.ZodNumber;
|
|
120
|
+
}, z.core.$strict>>;
|
|
121
|
+
end: z.ZodOptional<z.ZodObject<{
|
|
122
|
+
x: z.ZodNumber;
|
|
123
|
+
z: z.ZodNumber;
|
|
124
|
+
}, z.core.$strict>>;
|
|
125
|
+
isFlipped: z.ZodOptional<z.ZodBoolean>;
|
|
126
|
+
depth: z.ZodOptional<z.ZodNumber>;
|
|
127
|
+
base: z.ZodOptional<z.ZodNumber>;
|
|
128
|
+
top: z.ZodOptional<z.ZodNumber>;
|
|
129
|
+
isHidden: z.ZodOptional<z.ZodBoolean>;
|
|
130
|
+
}, z.core.$strict>;
|
|
131
|
+
export type PluginSectionPatch = z.infer<typeof PluginSectionPatch>;
|
|
132
|
+
export declare const PluginSectionUpdateArgs: z.ZodObject<{
|
|
133
|
+
sectionId: z.ZodString;
|
|
134
|
+
patch: z.ZodObject<{
|
|
135
|
+
name: z.ZodOptional<z.ZodString>;
|
|
136
|
+
tagLabel: z.ZodOptional<z.ZodString>;
|
|
137
|
+
start: z.ZodOptional<z.ZodObject<{
|
|
138
|
+
x: z.ZodNumber;
|
|
139
|
+
z: z.ZodNumber;
|
|
140
|
+
}, z.core.$strict>>;
|
|
141
|
+
end: z.ZodOptional<z.ZodObject<{
|
|
142
|
+
x: z.ZodNumber;
|
|
143
|
+
z: z.ZodNumber;
|
|
144
|
+
}, z.core.$strict>>;
|
|
145
|
+
isFlipped: z.ZodOptional<z.ZodBoolean>;
|
|
146
|
+
depth: z.ZodOptional<z.ZodNumber>;
|
|
147
|
+
base: z.ZodOptional<z.ZodNumber>;
|
|
148
|
+
top: z.ZodOptional<z.ZodNumber>;
|
|
149
|
+
isHidden: z.ZodOptional<z.ZodBoolean>;
|
|
150
|
+
}, z.core.$strict>;
|
|
151
|
+
}, z.core.$strict>;
|
|
152
|
+
export type PluginSectionUpdateArgs = z.infer<typeof PluginSectionUpdateArgs>;
|
|
153
|
+
/**
|
|
154
|
+
* Options for {@linkcode PluginPresentationSectionsApi.getCut}.
|
|
155
|
+
*
|
|
156
|
+
* | Property | Type | Description |
|
|
157
|
+
* |---|---|---|
|
|
158
|
+
* | `maxSegmentsPerElement` | `number \| undefined` | Outline segments to return per element, 0 to 2000 (default 0: none) |
|
|
159
|
+
*/
|
|
160
|
+
export declare const PluginSectionCutOptions: z.ZodObject<{
|
|
161
|
+
maxSegmentsPerElement: z.ZodOptional<z.ZodNumber>;
|
|
162
|
+
}, z.core.$strict>;
|
|
163
|
+
export type PluginSectionCutOptions = z.infer<typeof PluginSectionCutOptions>;
|
|
164
|
+
export declare const PluginSectionCutArgs: z.ZodObject<{
|
|
165
|
+
sectionId: z.ZodString;
|
|
166
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
167
|
+
maxSegmentsPerElement: z.ZodOptional<z.ZodNumber>;
|
|
168
|
+
}, z.core.$strict>>;
|
|
169
|
+
}, z.core.$strict>;
|
|
170
|
+
export type PluginSectionCutArgs = z.infer<typeof PluginSectionCutArgs>;
|
|
171
|
+
/**
|
|
172
|
+
* A rect on the cutting plane. `u` runs along the line from the first head
|
|
173
|
+
* (0) to the second (the line's length); `v` is world Y.
|
|
174
|
+
*/
|
|
175
|
+
export declare const PluginSectionExtent: z.ZodObject<{
|
|
176
|
+
uMin: z.ZodNumber;
|
|
177
|
+
uMax: z.ZodNumber;
|
|
178
|
+
vMin: z.ZodNumber;
|
|
179
|
+
vMax: z.ZodNumber;
|
|
180
|
+
}, z.core.$strip>;
|
|
181
|
+
export type PluginSectionExtent = z.infer<typeof PluginSectionExtent>;
|
|
182
|
+
/**
|
|
183
|
+
* One element a section cuts.
|
|
184
|
+
*
|
|
185
|
+
* | Property | Type | Description |
|
|
186
|
+
* |---|---|---|
|
|
187
|
+
* | `entityId` | `string` | The element's component id (a `ComponentHandle`) |
|
|
188
|
+
* | `type` | `string` | Its component type ("wall", "slab", "mass", …) |
|
|
189
|
+
* | `area` | `number` | Cut area inside the section's extents, square babylon units |
|
|
190
|
+
* | `perimeter` | `number` | Length of the cut outline inside the extents, babylon units |
|
|
191
|
+
* | `extent` | {@linkcode PluginSectionExtent} | Where the cut lies on the plane |
|
|
192
|
+
* | `isHatched` | `boolean` | `false` for masses and voids, which the drawing leaves unfilled |
|
|
193
|
+
* | `isOpening` | `boolean` | Doors and windows, which the drawing fills white |
|
|
194
|
+
* | `segments` | `[u0, v0, u1, v1][]` | Cut outline segments, when asked for |
|
|
195
|
+
* | `droppedSegmentCount` | `number` | Segments not returned because of `maxSegmentsPerElement` |
|
|
196
|
+
*/
|
|
197
|
+
export declare const PluginSectionCutElement: z.ZodObject<{
|
|
198
|
+
entityId: z.ZodString;
|
|
199
|
+
type: z.ZodString;
|
|
200
|
+
area: z.ZodNumber;
|
|
201
|
+
perimeter: z.ZodNumber;
|
|
202
|
+
extent: z.ZodObject<{
|
|
203
|
+
uMin: z.ZodNumber;
|
|
204
|
+
uMax: z.ZodNumber;
|
|
205
|
+
vMin: z.ZodNumber;
|
|
206
|
+
vMax: z.ZodNumber;
|
|
207
|
+
}, z.core.$strip>;
|
|
208
|
+
isHatched: z.ZodBoolean;
|
|
209
|
+
isOpening: z.ZodBoolean;
|
|
210
|
+
segments: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>>;
|
|
211
|
+
droppedSegmentCount: z.ZodNumber;
|
|
212
|
+
}, z.core.$strip>;
|
|
213
|
+
export type PluginSectionCutElement = z.infer<typeof PluginSectionCutElement>;
|
|
214
|
+
/**
|
|
215
|
+
* What a section cuts, from {@linkcode PluginPresentationSectionsApi.getCut}.
|
|
216
|
+
*
|
|
217
|
+
* | Property | Type | Description |
|
|
218
|
+
* |---|---|---|
|
|
219
|
+
* | `sectionId` | `string` | The section |
|
|
220
|
+
* | `origin` | `{ x, y, z }` | World point at `u = 0, v = 0`: the first head, at Y 0 |
|
|
221
|
+
* | `uAxis` | `{ x, y, z }` | Unit direction of `u`: from the first head to the second |
|
|
222
|
+
* | `normal` | `{ x, y, z }` | Unit direction the section looks |
|
|
223
|
+
* | `extent` | {@linkcode PluginSectionExtent} | The cut rect: `u` 0 to the line's length, `v` base to top |
|
|
224
|
+
* | `elements` | {@linkcode PluginSectionCutElement}`[]` | What it cuts, largest area first |
|
|
225
|
+
* | `candidateCount` | `number` | Meshes near the plane that were tested |
|
|
226
|
+
* | `durationInMs` | `number` | Time the query took |
|
|
227
|
+
*/
|
|
228
|
+
export declare const PluginSectionCut: z.ZodObject<{
|
|
229
|
+
sectionId: z.ZodString;
|
|
230
|
+
origin: z.ZodObject<{
|
|
231
|
+
x: z.ZodNumber;
|
|
232
|
+
y: z.ZodNumber;
|
|
233
|
+
z: z.ZodNumber;
|
|
234
|
+
}, z.core.$strip>;
|
|
235
|
+
uAxis: z.ZodObject<{
|
|
236
|
+
x: z.ZodNumber;
|
|
237
|
+
y: z.ZodNumber;
|
|
238
|
+
z: z.ZodNumber;
|
|
239
|
+
}, z.core.$strip>;
|
|
240
|
+
normal: z.ZodObject<{
|
|
241
|
+
x: z.ZodNumber;
|
|
242
|
+
y: z.ZodNumber;
|
|
243
|
+
z: z.ZodNumber;
|
|
244
|
+
}, z.core.$strip>;
|
|
245
|
+
extent: z.ZodObject<{
|
|
246
|
+
uMin: z.ZodNumber;
|
|
247
|
+
uMax: z.ZodNumber;
|
|
248
|
+
vMin: z.ZodNumber;
|
|
249
|
+
vMax: z.ZodNumber;
|
|
250
|
+
}, z.core.$strip>;
|
|
251
|
+
elements: z.ZodArray<z.ZodObject<{
|
|
252
|
+
entityId: z.ZodString;
|
|
253
|
+
type: z.ZodString;
|
|
254
|
+
area: z.ZodNumber;
|
|
255
|
+
perimeter: z.ZodNumber;
|
|
256
|
+
extent: z.ZodObject<{
|
|
257
|
+
uMin: z.ZodNumber;
|
|
258
|
+
uMax: z.ZodNumber;
|
|
259
|
+
vMin: z.ZodNumber;
|
|
260
|
+
vMax: z.ZodNumber;
|
|
261
|
+
}, z.core.$strip>;
|
|
262
|
+
isHatched: z.ZodBoolean;
|
|
263
|
+
isOpening: z.ZodBoolean;
|
|
264
|
+
segments: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>>;
|
|
265
|
+
droppedSegmentCount: z.ZodNumber;
|
|
266
|
+
}, z.core.$strip>>;
|
|
267
|
+
candidateCount: z.ZodNumber;
|
|
268
|
+
durationInMs: z.ZodNumber;
|
|
269
|
+
}, z.core.$strip>;
|
|
270
|
+
export type PluginSectionCut = z.infer<typeof PluginSectionCut>;
|
|
271
|
+
/**
|
|
272
|
+
* Sections: lines on the plan that cut the model, each with its own section
|
|
273
|
+
* view.
|
|
274
|
+
*
|
|
275
|
+
* A section is a cutting plane through its line, vertical, looking one way
|
|
276
|
+
* along it; its view keeps `depth` behind the line, between `base` and `top`.
|
|
277
|
+
* Create, read, edit and delete sections (`create`, `list`, `get`, `update`,
|
|
278
|
+
* `delete`), open one's view (`setActive`, `getActive`), and ask what it cuts
|
|
279
|
+
* (`getCut`): which elements the plane passes through, with the area, outline
|
|
280
|
+
* and extent of each cut. `getCut` is computed from the model, needs no open
|
|
281
|
+
* view and changes nothing.
|
|
282
|
+
*
|
|
283
|
+
* Writes are write-gated and each call is one undo step. Geometry edits
|
|
284
|
+
* (`start`, `end`, `isFlipped`, `depth`, `base`, `top`) are refused on a locked
|
|
285
|
+
* section; names, marks and hiding are not, and repeating a locked section's
|
|
286
|
+
* geometry unchanged is not a geometry edit. View-only collaborators cannot
|
|
287
|
+
* write.
|
|
288
|
+
*
|
|
289
|
+
* Positions are world coordinates in internal `babylon` units (1 unit =
|
|
290
|
+
* 0.254 m, Y up); a section's heads are plan points `{ x, z }`. Accessed via
|
|
291
|
+
* `snaptrude.presentation.sections`.
|
|
292
|
+
*/
|
|
293
|
+
export declare abstract class PluginPresentationSectionsApi {
|
|
294
|
+
constructor();
|
|
295
|
+
/**
|
|
296
|
+
* List the project's sections, in Views panel order.
|
|
297
|
+
*
|
|
298
|
+
* @returns Every {@linkcode PluginSection} (`[]` when there are none).
|
|
299
|
+
*
|
|
300
|
+
* @examplePrompt Which sections are there?
|
|
301
|
+
* @examplePrompt List the section lines in this project
|
|
302
|
+
* @examplePrompt Is there a section through the stair?
|
|
303
|
+
*
|
|
304
|
+
* # Example
|
|
305
|
+
* ```ts
|
|
306
|
+
* const sections = await snaptrude.presentation.sections.list()
|
|
307
|
+
* ```
|
|
308
|
+
*/
|
|
309
|
+
abstract list(): PluginApiReturn<PluginSection[]>;
|
|
310
|
+
/**
|
|
311
|
+
* Get one section by id.
|
|
312
|
+
*
|
|
313
|
+
* @param sectionId - The section's id
|
|
314
|
+
* @returns The {@linkcode PluginSection}, or `null` when there is none with that id.
|
|
315
|
+
*
|
|
316
|
+
* @examplePrompt Where does Section A run?
|
|
317
|
+
* @examplePrompt How deep is this section?
|
|
318
|
+
*
|
|
319
|
+
* # Example
|
|
320
|
+
* ```ts
|
|
321
|
+
* const section = await snaptrude.presentation.sections.get(sectionId)
|
|
322
|
+
* console.log(section?.start, section?.end)
|
|
323
|
+
* ```
|
|
324
|
+
*/
|
|
325
|
+
abstract get(sectionId: string): PluginApiReturn<PluginSection | null>;
|
|
326
|
+
/**
|
|
327
|
+
* Get the section whose view is open.
|
|
328
|
+
*
|
|
329
|
+
* @returns The open {@linkcode PluginSection}, or `null` when no section view is open.
|
|
330
|
+
*
|
|
331
|
+
* @examplePrompt Which section am I looking at?
|
|
332
|
+
*
|
|
333
|
+
* # Example
|
|
334
|
+
* ```ts
|
|
335
|
+
* const open = await snaptrude.presentation.sections.getActive()
|
|
336
|
+
* ```
|
|
337
|
+
*/
|
|
338
|
+
abstract getActive(): PluginApiReturn<PluginSection | null>;
|
|
339
|
+
/**
|
|
340
|
+
* Open a section's view, or close the open one with `null`. Opening frames
|
|
341
|
+
* the section's saved camera, or a straight-on view when it has none.
|
|
342
|
+
* Closing returns to 3D; with no section view open, `null` does nothing. Not
|
|
343
|
+
* an edit: nothing is added to the undo history.
|
|
344
|
+
*
|
|
345
|
+
* @param sectionId - The section to open, or `null` to close the section view
|
|
346
|
+
* @returns The open {@linkcode PluginSection}, or `null` after closing.
|
|
347
|
+
* @throws HANDLE_INVALID when there is no section with that id.
|
|
348
|
+
*
|
|
349
|
+
* @examplePrompt Open Section A
|
|
350
|
+
* @examplePrompt Show me the section through the atrium
|
|
351
|
+
* @examplePrompt Close the section view
|
|
352
|
+
*
|
|
353
|
+
* # Example
|
|
354
|
+
* ```ts
|
|
355
|
+
* await snaptrude.presentation.sections.setActive(section.sectionId)
|
|
356
|
+
* await snaptrude.presentation.sections.setActive(null)
|
|
357
|
+
* ```
|
|
358
|
+
*/
|
|
359
|
+
abstract setActive(sectionId: string | null): PluginApiReturn<PluginSection | null>;
|
|
360
|
+
/**
|
|
361
|
+
* Draw a section line from `start` to `end` on the plan. The section looks
|
|
362
|
+
* along the line's direction turned a quarter turn — a line drawn toward +x
|
|
363
|
+
* looks toward +z; flip it with `update(id, { isFlipped: true })`. Its slice
|
|
364
|
+
* defaults to the building's full height and its depth to the far side of
|
|
365
|
+
* the model. Write-gated; one undo step.
|
|
366
|
+
*
|
|
367
|
+
* @param start - First head, a plan point `{ x, z }`
|
|
368
|
+
* @param end - Second head; must differ from `start`
|
|
369
|
+
* @param options - Name, mark, depth, slice, building and whether to open it ({@linkcode PluginSectionCreateOptions})
|
|
370
|
+
* @returns The new {@linkcode PluginSection}.
|
|
371
|
+
* @throws METHOD_NOT_PERMITTED when plugin writes are disabled. VALIDATION when
|
|
372
|
+
* `start` and `end` coincide or `top` is not above `base`. PRECONDITION_FAILED
|
|
373
|
+
* when the project is view-only or has no model to cut.
|
|
374
|
+
*
|
|
375
|
+
* @examplePrompt Cut a section through the middle of the building, east to west
|
|
376
|
+
* @examplePrompt Add a section across the stair core
|
|
377
|
+
* @examplePrompt Draw a longitudinal section and open it
|
|
378
|
+
*
|
|
379
|
+
* # Example
|
|
380
|
+
* ```ts
|
|
381
|
+
* const section = await snaptrude.presentation.sections.create(
|
|
382
|
+
* { x: -40, z: 10 },
|
|
383
|
+
* { x: 40, z: 10 },
|
|
384
|
+
* { name: "Longitudinal", isActive: true },
|
|
385
|
+
* )
|
|
386
|
+
* ```
|
|
387
|
+
*/
|
|
388
|
+
abstract create(start: PluginSectionPoint, end: PluginSectionPoint, options?: PluginSectionCreateOptions): PluginApiReturn<PluginSection>;
|
|
389
|
+
/**
|
|
390
|
+
* Change a section. Only the given fields change; the whole patch is one
|
|
391
|
+
* undo step. Flipping without a `depth` carries the depth to the far side of
|
|
392
|
+
* the model in the new direction, as `create` does. Write-gated.
|
|
393
|
+
*
|
|
394
|
+
* @param sectionId - The section's id
|
|
395
|
+
* @param patch - The fields to change ({@linkcode PluginSectionPatch})
|
|
396
|
+
* @returns The updated {@linkcode PluginSection}.
|
|
397
|
+
* @throws METHOD_NOT_PERMITTED when plugin writes are disabled. HANDLE_INVALID when
|
|
398
|
+
* there is no section with that id. VALIDATION when the heads coincide or `top`
|
|
399
|
+
* is not above `base`. PRECONDITION_FAILED when the project is view-only, or the
|
|
400
|
+
* patch changes a locked section's geometry.
|
|
401
|
+
*
|
|
402
|
+
* @examplePrompt Make Section A look the other way
|
|
403
|
+
* @examplePrompt Only show the ground floor in this section
|
|
404
|
+
* @examplePrompt Rename the section to "Through atrium"
|
|
405
|
+
* @examplePrompt Move the section line 5 m north
|
|
406
|
+
*
|
|
407
|
+
* # Example
|
|
408
|
+
* ```ts
|
|
409
|
+
* await snaptrude.presentation.sections.update(sectionId, {
|
|
410
|
+
* isFlipped: true,
|
|
411
|
+
* depth: 60,
|
|
412
|
+
* })
|
|
413
|
+
* ```
|
|
414
|
+
*/
|
|
415
|
+
abstract update(sectionId: string, patch: PluginSectionPatch): PluginApiReturn<PluginSection>;
|
|
416
|
+
/**
|
|
417
|
+
* Delete a section. Closes its view first if it is open. Write-gated; one
|
|
418
|
+
* undo step.
|
|
419
|
+
*
|
|
420
|
+
* @param sectionId - The section's id
|
|
421
|
+
* @returns `true` once it has been deleted.
|
|
422
|
+
* @throws METHOD_NOT_PERMITTED when plugin writes are disabled. HANDLE_INVALID when
|
|
423
|
+
* there is no section with that id. PRECONDITION_FAILED when the project is view-only.
|
|
424
|
+
*
|
|
425
|
+
* @examplePrompt Delete Section B
|
|
426
|
+
*
|
|
427
|
+
* # Example
|
|
428
|
+
* ```ts
|
|
429
|
+
* await snaptrude.presentation.sections.delete(sectionId)
|
|
430
|
+
* ```
|
|
431
|
+
*/
|
|
432
|
+
abstract delete(sectionId: string): PluginApiReturn<boolean>;
|
|
433
|
+
/**
|
|
434
|
+
* What a section cuts: every element its cutting plane passes through within
|
|
435
|
+
* the section's extents, with the cut's area, outline length and extent on
|
|
436
|
+
* the plane, largest first. Computed from the model, not from the drawing, so
|
|
437
|
+
* it needs no open view and works however the section is shown; furniture is
|
|
438
|
+
* left out, as in the drawing, and so is anything hidden in the model. Areas are exact for closed solids. Repeated
|
|
439
|
+
* calls reuse the cuts of elements that have not changed. Read-only.
|
|
440
|
+
*
|
|
441
|
+
* @param sectionId - The section's id
|
|
442
|
+
* @param options - Whether to return outline segments ({@linkcode PluginSectionCutOptions})
|
|
443
|
+
* @returns The {@linkcode PluginSectionCut}.
|
|
444
|
+
* @throws HANDLE_INVALID when there is no section with that id.
|
|
445
|
+
*
|
|
446
|
+
* @examplePrompt Which walls does Section A cut?
|
|
447
|
+
* @examplePrompt How thick is the slab where the section crosses it?
|
|
448
|
+
* @examplePrompt Does this section go through the stair?
|
|
449
|
+
* @examplePrompt What is the floor-to-floor height in this section?
|
|
450
|
+
*
|
|
451
|
+
* # Example
|
|
452
|
+
* ```ts
|
|
453
|
+
* const cut = await snaptrude.presentation.sections.getCut(sectionId)
|
|
454
|
+
* const walls = cut.elements.filter((element) => element.type === "wall")
|
|
455
|
+
* const thickest = walls[0]
|
|
456
|
+
* console.log(thickest.extent.uMax - thickest.extent.uMin)
|
|
457
|
+
* ```
|
|
458
|
+
*/
|
|
459
|
+
abstract getCut(sectionId: string, options?: PluginSectionCutOptions): PluginApiReturn<PluginSectionCut>;
|
|
460
|
+
}
|
|
461
|
+
//# sourceMappingURL=sections.d.ts.map
|