@itwin/editor-frontend 3.6.0-dev.8 → 3.6.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.
Files changed (98) hide show
  1. package/CHANGELOG.md +34 -1
  2. package/LICENSE.md +1 -1
  3. package/lib/cjs/CreateElementTool.d.ts +100 -100
  4. package/lib/cjs/CreateElementTool.js +327 -327
  5. package/lib/cjs/CreateElementTool.js.map +1 -1
  6. package/lib/cjs/DeleteElementsTool.d.ts +13 -13
  7. package/lib/cjs/DeleteElementsTool.js +38 -38
  8. package/lib/cjs/DeleteElementsTool.js.map +1 -1
  9. package/lib/cjs/EditTool.d.ts +38 -36
  10. package/lib/cjs/EditTool.d.ts.map +1 -1
  11. package/lib/cjs/EditTool.js +81 -135
  12. package/lib/cjs/EditTool.js.map +1 -1
  13. package/lib/cjs/EditToolIpc.d.ts +18 -17
  14. package/lib/cjs/EditToolIpc.d.ts.map +1 -1
  15. package/lib/cjs/EditToolIpc.js +28 -27
  16. package/lib/cjs/EditToolIpc.js.map +1 -1
  17. package/lib/cjs/ElementGeometryTool.d.ts +147 -147
  18. package/lib/cjs/ElementGeometryTool.js +709 -709
  19. package/lib/cjs/ElementGeometryTool.js.map +1 -1
  20. package/lib/cjs/ModifyCurveTools.d.ts +139 -139
  21. package/lib/cjs/ModifyCurveTools.js +784 -784
  22. package/lib/cjs/ModifyCurveTools.js.map +1 -1
  23. package/lib/cjs/ModifyElementTool.d.ts +47 -47
  24. package/lib/cjs/ModifyElementTool.js +177 -177
  25. package/lib/cjs/ModifyElementTool.js.map +1 -1
  26. package/lib/cjs/ProjectLocation/ProjectExtentsDecoration.d.ts +135 -135
  27. package/lib/cjs/ProjectLocation/ProjectExtentsDecoration.js +822 -822
  28. package/lib/cjs/ProjectLocation/ProjectExtentsDecoration.js.map +1 -1
  29. package/lib/cjs/ProjectLocation/ProjectGeolocation.d.ts +135 -135
  30. package/lib/cjs/ProjectLocation/ProjectGeolocation.js +532 -532
  31. package/lib/cjs/ProjectLocation/ProjectGeolocation.js.map +1 -1
  32. package/lib/cjs/SketchTools.d.ts +304 -304
  33. package/lib/cjs/SketchTools.js +1705 -1705
  34. package/lib/cjs/SketchTools.js.map +1 -1
  35. package/lib/cjs/SolidModelingTools.d.ts +380 -380
  36. package/lib/cjs/SolidModelingTools.js +1462 -1462
  37. package/lib/cjs/SolidModelingTools.js.map +1 -1
  38. package/lib/cjs/SolidPrimitiveTools.d.ts +318 -318
  39. package/lib/cjs/SolidPrimitiveTools.js +1378 -1378
  40. package/lib/cjs/SolidPrimitiveTools.js.map +1 -1
  41. package/lib/cjs/TransformElementsTool.d.ts +164 -164
  42. package/lib/cjs/TransformElementsTool.js +652 -652
  43. package/lib/cjs/TransformElementsTool.js.map +1 -1
  44. package/lib/cjs/UndoRedoTool.d.ts +16 -16
  45. package/lib/cjs/UndoRedoTool.js +42 -42
  46. package/lib/cjs/UndoRedoTool.js.map +1 -1
  47. package/lib/cjs/editor-frontend.d.ts +17 -17
  48. package/lib/cjs/editor-frontend.js +33 -33
  49. package/lib/cjs/editor-frontend.js.map +1 -1
  50. package/lib/esm/CreateElementTool.d.ts +100 -100
  51. package/lib/esm/CreateElementTool.js +319 -319
  52. package/lib/esm/CreateElementTool.js.map +1 -1
  53. package/lib/esm/DeleteElementsTool.d.ts +13 -13
  54. package/lib/esm/DeleteElementsTool.js +34 -34
  55. package/lib/esm/DeleteElementsTool.js.map +1 -1
  56. package/lib/esm/EditTool.d.ts +38 -36
  57. package/lib/esm/EditTool.d.ts.map +1 -1
  58. package/lib/esm/EditTool.js +77 -131
  59. package/lib/esm/EditTool.js.map +1 -1
  60. package/lib/esm/EditToolIpc.d.ts +18 -17
  61. package/lib/esm/EditToolIpc.d.ts.map +1 -1
  62. package/lib/esm/EditToolIpc.js +24 -23
  63. package/lib/esm/EditToolIpc.js.map +1 -1
  64. package/lib/esm/ElementGeometryTool.d.ts +147 -147
  65. package/lib/esm/ElementGeometryTool.js +701 -701
  66. package/lib/esm/ElementGeometryTool.js.map +1 -1
  67. package/lib/esm/ModifyCurveTools.d.ts +139 -139
  68. package/lib/esm/ModifyCurveTools.js +775 -775
  69. package/lib/esm/ModifyCurveTools.js.map +1 -1
  70. package/lib/esm/ModifyElementTool.d.ts +47 -47
  71. package/lib/esm/ModifyElementTool.js +172 -172
  72. package/lib/esm/ModifyElementTool.js.map +1 -1
  73. package/lib/esm/ProjectLocation/ProjectExtentsDecoration.d.ts +135 -135
  74. package/lib/esm/ProjectLocation/ProjectExtentsDecoration.js +814 -814
  75. package/lib/esm/ProjectLocation/ProjectExtentsDecoration.js.map +1 -1
  76. package/lib/esm/ProjectLocation/ProjectGeolocation.d.ts +135 -135
  77. package/lib/esm/ProjectLocation/ProjectGeolocation.js +526 -526
  78. package/lib/esm/ProjectLocation/ProjectGeolocation.js.map +1 -1
  79. package/lib/esm/SketchTools.d.ts +304 -304
  80. package/lib/esm/SketchTools.js +1695 -1695
  81. package/lib/esm/SketchTools.js.map +1 -1
  82. package/lib/esm/SolidModelingTools.d.ts +380 -380
  83. package/lib/esm/SolidModelingTools.js +1437 -1437
  84. package/lib/esm/SolidModelingTools.js.map +1 -1
  85. package/lib/esm/SolidPrimitiveTools.d.ts +318 -318
  86. package/lib/esm/SolidPrimitiveTools.js +1367 -1367
  87. package/lib/esm/SolidPrimitiveTools.js.map +1 -1
  88. package/lib/esm/TransformElementsTool.d.ts +164 -164
  89. package/lib/esm/TransformElementsTool.js +644 -644
  90. package/lib/esm/TransformElementsTool.js.map +1 -1
  91. package/lib/esm/UndoRedoTool.d.ts +16 -16
  92. package/lib/esm/UndoRedoTool.js +36 -36
  93. package/lib/esm/UndoRedoTool.js.map +1 -1
  94. package/lib/esm/editor-frontend.d.ts +17 -17
  95. package/lib/esm/editor-frontend.js +21 -21
  96. package/lib/esm/editor-frontend.js.map +1 -1
  97. package/lib/public/locales/en/Editor.json +490 -490
  98. package/package.json +15 -15
@@ -1,319 +1,319 @@
1
- import { DialogItem, DialogProperty, DialogPropertySyncItem } from "@itwin/appui-abstract";
2
- import { ElementGeometryBuilderParams, FlatBufferGeometryStream, GeometricElementProps, JsonGeometryStream, PlacementProps } from "@itwin/core-common";
3
- import { BeButtonEvent, DynamicsContext, EventHandled, ToolAssistanceInstruction, Viewport } from "@itwin/core-frontend";
4
- import { CurveCollection, CurvePrimitive, GeometryQuery, Matrix3d, Point3d } from "@itwin/core-geometry";
5
- import { CreateElementWithDynamicsTool } from "./CreateElementTool";
6
- import { ModifyCurveTool } from "./ModifyCurveTools";
7
- /** @alpha Base class for creating a capped or uncapped SolidPrimitive. */
8
- export declare abstract class SolidPrimitiveTool extends CreateElementWithDynamicsTool {
9
- protected readonly accepted: Point3d[];
10
- protected baseRotation?: Matrix3d;
11
- protected current?: GeometryQuery;
12
- protected _startedCmd?: string;
13
- protected allowView(vp: Viewport): boolean;
14
- isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
15
- protected startCommand(): Promise<string>;
16
- protected getPlacementProps(): PlacementProps | undefined;
17
- protected getGeometryProps(placement: PlacementProps): JsonGeometryStream | FlatBufferGeometryStream | undefined;
18
- protected getElementProps(placement: PlacementProps): GeometricElementProps | undefined;
19
- protected doCreateElement(props: GeometricElementProps, data?: ElementGeometryBuilderParams): Promise<void>;
20
- }
21
- /** @alpha Creates a sphere. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
22
- export declare class CreateSphereTool extends SolidPrimitiveTool {
23
- static toolId: string;
24
- static iconSpec: string;
25
- protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
26
- protected setupAccuDraw(): void;
27
- private _useRadiusProperty;
28
- get useRadiusProperty(): DialogProperty<boolean>;
29
- get useRadius(): boolean;
30
- set useRadius(value: boolean);
31
- private _radiusProperty;
32
- get radiusProperty(): DialogProperty<number>;
33
- get radius(): number;
34
- set radius(value: number);
35
- private _cappedProperty;
36
- get cappedProperty(): DialogProperty<boolean>;
37
- get capped(): boolean;
38
- set capped(value: boolean);
39
- protected isComplete(_ev: BeButtonEvent): boolean;
40
- protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
41
- protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
42
- applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
43
- supplyToolSettingsProperties(): DialogItem[] | undefined;
44
- onRestartTool(): Promise<void>;
45
- }
46
- /** @alpha Values for [[CreateCylinderTool.createPhase]. */
47
- export declare enum CreateCylinderPhase {
48
- /** Current tool phase to define center of base */
49
- AcceptBase = 0,
50
- /** Current tool phase to define radius or base axes */
51
- AcceptRadius = 1,
52
- /** Current tool phase to define length or axis */
53
- AcceptLength = 2,
54
- /** Current tool phase to accept result */
55
- AcceptResult = 3
56
- }
57
- /** @alpha Creates a cylinder. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
58
- export declare class CreateCylinderTool extends SolidPrimitiveTool {
59
- static toolId: string;
60
- static iconSpec: string;
61
- protected createPhase: CreateCylinderPhase;
62
- protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
63
- protected setupAccuDraw(): void;
64
- private _useRadiusProperty;
65
- get useRadiusProperty(): DialogProperty<boolean>;
66
- get useRadius(): boolean;
67
- set useRadius(value: boolean);
68
- private _radiusProperty;
69
- get radiusProperty(): DialogProperty<number>;
70
- get radius(): number;
71
- set radius(value: number);
72
- private _useLengthProperty;
73
- get useLengthProperty(): DialogProperty<boolean>;
74
- get useLength(): boolean;
75
- set useLength(value: boolean);
76
- private _lengthProperty;
77
- get lengthProperty(): DialogProperty<number>;
78
- get length(): number;
79
- set length(value: number);
80
- private _cappedProperty;
81
- get cappedProperty(): DialogProperty<boolean>;
82
- get capped(): boolean;
83
- set capped(value: boolean);
84
- private _orthogonalProperty;
85
- get orthogonalProperty(): DialogProperty<boolean>;
86
- get orthogonal(): boolean;
87
- set orthogonal(value: boolean);
88
- protected isComplete(_ev: BeButtonEvent): boolean;
89
- protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
90
- protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
91
- applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
92
- supplyToolSettingsProperties(): DialogItem[] | undefined;
93
- onRestartTool(): Promise<void>;
94
- }
95
- /** @alpha Values for [[CreateConeTool.createPhase]. */
96
- export declare enum CreateConePhase {
97
- /** Current tool phase to define center of base */
98
- AcceptBase = 0,
99
- /** Current tool phase to define base radius or base axes */
100
- AcceptBaseRadius = 1,
101
- /** Current tool phase to define length or axis */
102
- AcceptLength = 2,
103
- /** Current tool phase to define top radius */
104
- AcceptTopRadius = 3,
105
- /** Current tool phase to accept result */
106
- AcceptResult = 4
107
- }
108
- /** @alpha Creates a cone. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
109
- export declare class CreateConeTool extends SolidPrimitiveTool {
110
- static toolId: string;
111
- static iconSpec: string;
112
- protected createPhase: CreateConePhase;
113
- protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
114
- protected setupAccuDraw(): void;
115
- private _useBaseRadiusProperty;
116
- get useBaseRadiusProperty(): DialogProperty<boolean>;
117
- get useBaseRadius(): boolean;
118
- set useBaseRadius(value: boolean);
119
- private _baseRadiusProperty;
120
- get baseRadiusProperty(): DialogProperty<number>;
121
- get baseRadius(): number;
122
- set baseRadius(value: number);
123
- private _useTopRadiusProperty;
124
- get useTopRadiusProperty(): DialogProperty<boolean>;
125
- get useTopRadius(): boolean;
126
- set useTopRadius(value: boolean);
127
- private _topRadiusProperty;
128
- get topRadiusProperty(): DialogProperty<number>;
129
- get topRadius(): number;
130
- set topRadius(value: number);
131
- private _useLengthProperty;
132
- get useLengthProperty(): DialogProperty<boolean>;
133
- get useLength(): boolean;
134
- set useLength(value: boolean);
135
- private _lengthProperty;
136
- get lengthProperty(): DialogProperty<number>;
137
- get length(): number;
138
- set length(value: number);
139
- private _cappedProperty;
140
- get cappedProperty(): DialogProperty<boolean>;
141
- get capped(): boolean;
142
- set capped(value: boolean);
143
- private _orthogonalProperty;
144
- get orthogonalProperty(): DialogProperty<boolean>;
145
- get orthogonal(): boolean;
146
- set orthogonal(value: boolean);
147
- protected isComplete(_ev: BeButtonEvent): boolean;
148
- protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
149
- protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
150
- applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
151
- supplyToolSettingsProperties(): DialogItem[] | undefined;
152
- onRestartTool(): Promise<void>;
153
- }
154
- /** @alpha Creates a bix. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
155
- export declare class CreateBoxTool extends SolidPrimitiveTool {
156
- static toolId: string;
157
- static iconSpec: string;
158
- protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
159
- protected setupAccuDraw(): void;
160
- private _useLengthProperty;
161
- get useLengthProperty(): DialogProperty<boolean>;
162
- get useLength(): boolean;
163
- set useLength(value: boolean);
164
- private _lengthProperty;
165
- get lengthProperty(): DialogProperty<number>;
166
- get length(): number;
167
- set length(value: number);
168
- private _useWidthProperty;
169
- get useWidthProperty(): DialogProperty<boolean>;
170
- get useWidth(): boolean;
171
- set useWidth(value: boolean);
172
- private _widthProperty;
173
- get widthProperty(): DialogProperty<number>;
174
- get width(): number;
175
- set width(value: number);
176
- private _useHeightProperty;
177
- get useHeightProperty(): DialogProperty<boolean>;
178
- get useHeight(): boolean;
179
- set useHeight(value: boolean);
180
- private _heightProperty;
181
- get heightProperty(): DialogProperty<number>;
182
- get height(): number;
183
- set height(value: number);
184
- private _cappedProperty;
185
- get cappedProperty(): DialogProperty<boolean>;
186
- get capped(): boolean;
187
- set capped(value: boolean);
188
- private _orthogonalProperty;
189
- get orthogonalProperty(): DialogProperty<boolean>;
190
- get orthogonal(): boolean;
191
- set orthogonal(value: boolean);
192
- protected isComplete(_ev: BeButtonEvent): boolean;
193
- protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
194
- protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
195
- applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
196
- supplyToolSettingsProperties(): DialogItem[] | undefined;
197
- onRestartTool(): Promise<void>;
198
- }
199
- /** @alpha Values for [[CreateTorusTool.createPhase]. */
200
- export declare enum CreateTorusPhase {
201
- /** Current tool phase to define start point */
202
- AcceptStart = 0,
203
- /** Current tool phase to define center point */
204
- AcceptCenter = 1,
205
- /** Current tool phase to define secondary radius */
206
- AcceptSecondaryRadius = 2,
207
- /** Current tool phase to define sweep angle */
208
- AcceptAngle = 3,
209
- /** Current tool phase to accept result */
210
- AcceptResult = 4
211
- }
212
- /** @alpha Creates a torus pipe. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
213
- export declare class CreateTorusTool extends SolidPrimitiveTool {
214
- static toolId: string;
215
- static iconSpec: string;
216
- protected createPhase: CreateTorusPhase;
217
- protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
218
- protected setupAccuDraw(): void;
219
- private _usePrimaryRadiusProperty;
220
- get usePrimaryRadiusProperty(): DialogProperty<boolean>;
221
- get usePrimaryRadius(): boolean;
222
- set usePrimaryRadius(value: boolean);
223
- private _primaryRadiusProperty;
224
- get primaryRadiusProperty(): DialogProperty<number>;
225
- get primaryRadius(): number;
226
- set primaryRadius(value: number);
227
- private _useSecondaryRadiusProperty;
228
- get useSecondaryRadiusProperty(): DialogProperty<boolean>;
229
- get useSecondaryRadius(): boolean;
230
- set useSecondaryRadius(value: boolean);
231
- private _secondaryRadiusProperty;
232
- get secondaryRadiusProperty(): DialogProperty<number>;
233
- get secondaryRadius(): number;
234
- set secondaryRadius(value: number);
235
- private _useAngleProperty;
236
- get useAngleProperty(): DialogProperty<boolean>;
237
- get useAngle(): boolean;
238
- set useAngle(value: boolean);
239
- private _angleProperty;
240
- get angleProperty(): DialogProperty<number>;
241
- get angle(): number;
242
- set angle(value: number);
243
- private _cappedProperty;
244
- get cappedProperty(): DialogProperty<boolean>;
245
- get capped(): boolean;
246
- set capped(value: boolean);
247
- protected isComplete(_ev: BeButtonEvent): boolean;
248
- protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
249
- protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
250
- applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
251
- supplyToolSettingsProperties(): DialogItem[] | undefined;
252
- onRestartTool(): Promise<void>;
253
- }
254
- /** @alpha Tool for extruding paths and regions. */
255
- export declare class ExtrudeCurveTool extends ModifyCurveTool {
256
- static toolId: string;
257
- static iconSpec: string;
258
- protected allowView(vp: Viewport): boolean;
259
- private _useLengthProperty;
260
- get useLengthProperty(): DialogProperty<boolean>;
261
- get useLength(): boolean;
262
- set useLength(value: boolean);
263
- private _lengthProperty;
264
- get lengthProperty(): DialogProperty<number>;
265
- get length(): number;
266
- set length(value: number);
267
- private _cappedProperty;
268
- get cappedProperty(): DialogProperty<boolean>;
269
- get capped(): boolean;
270
- set capped(value: boolean);
271
- private _orthogonalProperty;
272
- get orthogonalProperty(): DialogProperty<boolean>;
273
- get orthogonal(): boolean;
274
- set orthogonal(value: boolean);
275
- private _keepProfileProperty;
276
- get keepProfileProperty(): DialogProperty<boolean>;
277
- get keepProfile(): boolean;
278
- set keepProfile(value: boolean);
279
- protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
280
- applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
281
- supplyToolSettingsProperties(): DialogItem[] | undefined;
282
- protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
283
- protected modifyCurve(ev: BeButtonEvent, isAccept: boolean): GeometryQuery | undefined;
284
- protected get wantModifyOriginal(): boolean;
285
- protected setupAccuDraw(): void;
286
- protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
287
- onRestartTool(): Promise<void>;
288
- }
289
- /** @alpha Tool for revolving paths and regions. */
290
- export declare class RevolveCurveTool extends ModifyCurveTool {
291
- static toolId: string;
292
- static iconSpec: string;
293
- protected points: Point3d[];
294
- protected allowView(vp: Viewport): boolean;
295
- private _angleProperty;
296
- get angleProperty(): DialogProperty<number>;
297
- get angle(): number;
298
- set angle(value: number);
299
- private _cappedProperty;
300
- get cappedProperty(): DialogProperty<boolean>;
301
- get capped(): boolean;
302
- set capped(value: boolean);
303
- private _keepProfileProperty;
304
- get keepProfileProperty(): DialogProperty<boolean>;
305
- get keepProfile(): boolean;
306
- set keepProfile(value: boolean);
307
- applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
308
- supplyToolSettingsProperties(): DialogItem[] | undefined;
309
- protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
310
- protected modifyCurve(ev: BeButtonEvent, isAccept: boolean): GeometryQuery | undefined;
311
- onDynamicFrame(ev: BeButtonEvent, context: DynamicsContext): void;
312
- protected get wantModifyOriginal(): boolean;
313
- protected get wantAdditionalInput(): boolean;
314
- protected gatherInput(ev: BeButtonEvent): Promise<EventHandled | undefined>;
315
- protected setupAccuDraw(): void;
316
- protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
317
- onRestartTool(): Promise<void>;
318
- }
1
+ import { DialogItem, DialogProperty, DialogPropertySyncItem } from "@itwin/appui-abstract";
2
+ import { ElementGeometryBuilderParams, FlatBufferGeometryStream, GeometricElementProps, JsonGeometryStream, PlacementProps } from "@itwin/core-common";
3
+ import { BeButtonEvent, DynamicsContext, EventHandled, ToolAssistanceInstruction, Viewport } from "@itwin/core-frontend";
4
+ import { CurveCollection, CurvePrimitive, GeometryQuery, Matrix3d, Point3d } from "@itwin/core-geometry";
5
+ import { CreateElementWithDynamicsTool } from "./CreateElementTool";
6
+ import { ModifyCurveTool } from "./ModifyCurveTools";
7
+ /** @alpha Base class for creating a capped or uncapped SolidPrimitive. */
8
+ export declare abstract class SolidPrimitiveTool extends CreateElementWithDynamicsTool {
9
+ protected readonly accepted: Point3d[];
10
+ protected baseRotation?: Matrix3d;
11
+ protected current?: GeometryQuery;
12
+ protected _startedCmd?: string;
13
+ protected allowView(vp: Viewport): boolean;
14
+ isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
15
+ protected startCommand(): Promise<string>;
16
+ protected getPlacementProps(): PlacementProps | undefined;
17
+ protected getGeometryProps(placement: PlacementProps): JsonGeometryStream | FlatBufferGeometryStream | undefined;
18
+ protected getElementProps(placement: PlacementProps): GeometricElementProps | undefined;
19
+ protected doCreateElement(props: GeometricElementProps, data?: ElementGeometryBuilderParams): Promise<void>;
20
+ }
21
+ /** @alpha Creates a sphere. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
22
+ export declare class CreateSphereTool extends SolidPrimitiveTool {
23
+ static toolId: string;
24
+ static iconSpec: string;
25
+ protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
26
+ protected setupAccuDraw(): void;
27
+ private _useRadiusProperty;
28
+ get useRadiusProperty(): DialogProperty<boolean>;
29
+ get useRadius(): boolean;
30
+ set useRadius(value: boolean);
31
+ private _radiusProperty;
32
+ get radiusProperty(): DialogProperty<number>;
33
+ get radius(): number;
34
+ set radius(value: number);
35
+ private _cappedProperty;
36
+ get cappedProperty(): DialogProperty<boolean>;
37
+ get capped(): boolean;
38
+ set capped(value: boolean);
39
+ protected isComplete(_ev: BeButtonEvent): boolean;
40
+ protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
41
+ protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
42
+ applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
43
+ supplyToolSettingsProperties(): DialogItem[] | undefined;
44
+ onRestartTool(): Promise<void>;
45
+ }
46
+ /** @alpha Values for [[CreateCylinderTool.createPhase]. */
47
+ export declare enum CreateCylinderPhase {
48
+ /** Current tool phase to define center of base */
49
+ AcceptBase = 0,
50
+ /** Current tool phase to define radius or base axes */
51
+ AcceptRadius = 1,
52
+ /** Current tool phase to define length or axis */
53
+ AcceptLength = 2,
54
+ /** Current tool phase to accept result */
55
+ AcceptResult = 3
56
+ }
57
+ /** @alpha Creates a cylinder. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
58
+ export declare class CreateCylinderTool extends SolidPrimitiveTool {
59
+ static toolId: string;
60
+ static iconSpec: string;
61
+ protected createPhase: CreateCylinderPhase;
62
+ protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
63
+ protected setupAccuDraw(): void;
64
+ private _useRadiusProperty;
65
+ get useRadiusProperty(): DialogProperty<boolean>;
66
+ get useRadius(): boolean;
67
+ set useRadius(value: boolean);
68
+ private _radiusProperty;
69
+ get radiusProperty(): DialogProperty<number>;
70
+ get radius(): number;
71
+ set radius(value: number);
72
+ private _useLengthProperty;
73
+ get useLengthProperty(): DialogProperty<boolean>;
74
+ get useLength(): boolean;
75
+ set useLength(value: boolean);
76
+ private _lengthProperty;
77
+ get lengthProperty(): DialogProperty<number>;
78
+ get length(): number;
79
+ set length(value: number);
80
+ private _cappedProperty;
81
+ get cappedProperty(): DialogProperty<boolean>;
82
+ get capped(): boolean;
83
+ set capped(value: boolean);
84
+ private _orthogonalProperty;
85
+ get orthogonalProperty(): DialogProperty<boolean>;
86
+ get orthogonal(): boolean;
87
+ set orthogonal(value: boolean);
88
+ protected isComplete(_ev: BeButtonEvent): boolean;
89
+ protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
90
+ protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
91
+ applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
92
+ supplyToolSettingsProperties(): DialogItem[] | undefined;
93
+ onRestartTool(): Promise<void>;
94
+ }
95
+ /** @alpha Values for [[CreateConeTool.createPhase]. */
96
+ export declare enum CreateConePhase {
97
+ /** Current tool phase to define center of base */
98
+ AcceptBase = 0,
99
+ /** Current tool phase to define base radius or base axes */
100
+ AcceptBaseRadius = 1,
101
+ /** Current tool phase to define length or axis */
102
+ AcceptLength = 2,
103
+ /** Current tool phase to define top radius */
104
+ AcceptTopRadius = 3,
105
+ /** Current tool phase to accept result */
106
+ AcceptResult = 4
107
+ }
108
+ /** @alpha Creates a cone. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
109
+ export declare class CreateConeTool extends SolidPrimitiveTool {
110
+ static toolId: string;
111
+ static iconSpec: string;
112
+ protected createPhase: CreateConePhase;
113
+ protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
114
+ protected setupAccuDraw(): void;
115
+ private _useBaseRadiusProperty;
116
+ get useBaseRadiusProperty(): DialogProperty<boolean>;
117
+ get useBaseRadius(): boolean;
118
+ set useBaseRadius(value: boolean);
119
+ private _baseRadiusProperty;
120
+ get baseRadiusProperty(): DialogProperty<number>;
121
+ get baseRadius(): number;
122
+ set baseRadius(value: number);
123
+ private _useTopRadiusProperty;
124
+ get useTopRadiusProperty(): DialogProperty<boolean>;
125
+ get useTopRadius(): boolean;
126
+ set useTopRadius(value: boolean);
127
+ private _topRadiusProperty;
128
+ get topRadiusProperty(): DialogProperty<number>;
129
+ get topRadius(): number;
130
+ set topRadius(value: number);
131
+ private _useLengthProperty;
132
+ get useLengthProperty(): DialogProperty<boolean>;
133
+ get useLength(): boolean;
134
+ set useLength(value: boolean);
135
+ private _lengthProperty;
136
+ get lengthProperty(): DialogProperty<number>;
137
+ get length(): number;
138
+ set length(value: number);
139
+ private _cappedProperty;
140
+ get cappedProperty(): DialogProperty<boolean>;
141
+ get capped(): boolean;
142
+ set capped(value: boolean);
143
+ private _orthogonalProperty;
144
+ get orthogonalProperty(): DialogProperty<boolean>;
145
+ get orthogonal(): boolean;
146
+ set orthogonal(value: boolean);
147
+ protected isComplete(_ev: BeButtonEvent): boolean;
148
+ protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
149
+ protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
150
+ applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
151
+ supplyToolSettingsProperties(): DialogItem[] | undefined;
152
+ onRestartTool(): Promise<void>;
153
+ }
154
+ /** @alpha Creates a bix. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
155
+ export declare class CreateBoxTool extends SolidPrimitiveTool {
156
+ static toolId: string;
157
+ static iconSpec: string;
158
+ protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
159
+ protected setupAccuDraw(): void;
160
+ private _useLengthProperty;
161
+ get useLengthProperty(): DialogProperty<boolean>;
162
+ get useLength(): boolean;
163
+ set useLength(value: boolean);
164
+ private _lengthProperty;
165
+ get lengthProperty(): DialogProperty<number>;
166
+ get length(): number;
167
+ set length(value: number);
168
+ private _useWidthProperty;
169
+ get useWidthProperty(): DialogProperty<boolean>;
170
+ get useWidth(): boolean;
171
+ set useWidth(value: boolean);
172
+ private _widthProperty;
173
+ get widthProperty(): DialogProperty<number>;
174
+ get width(): number;
175
+ set width(value: number);
176
+ private _useHeightProperty;
177
+ get useHeightProperty(): DialogProperty<boolean>;
178
+ get useHeight(): boolean;
179
+ set useHeight(value: boolean);
180
+ private _heightProperty;
181
+ get heightProperty(): DialogProperty<number>;
182
+ get height(): number;
183
+ set height(value: number);
184
+ private _cappedProperty;
185
+ get cappedProperty(): DialogProperty<boolean>;
186
+ get capped(): boolean;
187
+ set capped(value: boolean);
188
+ private _orthogonalProperty;
189
+ get orthogonalProperty(): DialogProperty<boolean>;
190
+ get orthogonal(): boolean;
191
+ set orthogonal(value: boolean);
192
+ protected isComplete(_ev: BeButtonEvent): boolean;
193
+ protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
194
+ protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
195
+ applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
196
+ supplyToolSettingsProperties(): DialogItem[] | undefined;
197
+ onRestartTool(): Promise<void>;
198
+ }
199
+ /** @alpha Values for [[CreateTorusTool.createPhase]. */
200
+ export declare enum CreateTorusPhase {
201
+ /** Current tool phase to define start point */
202
+ AcceptStart = 0,
203
+ /** Current tool phase to define center point */
204
+ AcceptCenter = 1,
205
+ /** Current tool phase to define secondary radius */
206
+ AcceptSecondaryRadius = 2,
207
+ /** Current tool phase to define sweep angle */
208
+ AcceptAngle = 3,
209
+ /** Current tool phase to accept result */
210
+ AcceptResult = 4
211
+ }
212
+ /** @alpha Creates a torus pipe. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
213
+ export declare class CreateTorusTool extends SolidPrimitiveTool {
214
+ static toolId: string;
215
+ static iconSpec: string;
216
+ protected createPhase: CreateTorusPhase;
217
+ protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
218
+ protected setupAccuDraw(): void;
219
+ private _usePrimaryRadiusProperty;
220
+ get usePrimaryRadiusProperty(): DialogProperty<boolean>;
221
+ get usePrimaryRadius(): boolean;
222
+ set usePrimaryRadius(value: boolean);
223
+ private _primaryRadiusProperty;
224
+ get primaryRadiusProperty(): DialogProperty<number>;
225
+ get primaryRadius(): number;
226
+ set primaryRadius(value: number);
227
+ private _useSecondaryRadiusProperty;
228
+ get useSecondaryRadiusProperty(): DialogProperty<boolean>;
229
+ get useSecondaryRadius(): boolean;
230
+ set useSecondaryRadius(value: boolean);
231
+ private _secondaryRadiusProperty;
232
+ get secondaryRadiusProperty(): DialogProperty<number>;
233
+ get secondaryRadius(): number;
234
+ set secondaryRadius(value: number);
235
+ private _useAngleProperty;
236
+ get useAngleProperty(): DialogProperty<boolean>;
237
+ get useAngle(): boolean;
238
+ set useAngle(value: boolean);
239
+ private _angleProperty;
240
+ get angleProperty(): DialogProperty<number>;
241
+ get angle(): number;
242
+ set angle(value: number);
243
+ private _cappedProperty;
244
+ get cappedProperty(): DialogProperty<boolean>;
245
+ get capped(): boolean;
246
+ set capped(value: boolean);
247
+ protected isComplete(_ev: BeButtonEvent): boolean;
248
+ protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
249
+ protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
250
+ applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
251
+ supplyToolSettingsProperties(): DialogItem[] | undefined;
252
+ onRestartTool(): Promise<void>;
253
+ }
254
+ /** @alpha Tool for extruding paths and regions. */
255
+ export declare class ExtrudeCurveTool extends ModifyCurveTool {
256
+ static toolId: string;
257
+ static iconSpec: string;
258
+ protected allowView(vp: Viewport): boolean;
259
+ private _useLengthProperty;
260
+ get useLengthProperty(): DialogProperty<boolean>;
261
+ get useLength(): boolean;
262
+ set useLength(value: boolean);
263
+ private _lengthProperty;
264
+ get lengthProperty(): DialogProperty<number>;
265
+ get length(): number;
266
+ set length(value: number);
267
+ private _cappedProperty;
268
+ get cappedProperty(): DialogProperty<boolean>;
269
+ get capped(): boolean;
270
+ set capped(value: boolean);
271
+ private _orthogonalProperty;
272
+ get orthogonalProperty(): DialogProperty<boolean>;
273
+ get orthogonal(): boolean;
274
+ set orthogonal(value: boolean);
275
+ private _keepProfileProperty;
276
+ get keepProfileProperty(): DialogProperty<boolean>;
277
+ get keepProfile(): boolean;
278
+ set keepProfile(value: boolean);
279
+ protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
280
+ applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
281
+ supplyToolSettingsProperties(): DialogItem[] | undefined;
282
+ protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
283
+ protected modifyCurve(ev: BeButtonEvent, isAccept: boolean): GeometryQuery | undefined;
284
+ protected get wantModifyOriginal(): boolean;
285
+ protected setupAccuDraw(): void;
286
+ protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
287
+ onRestartTool(): Promise<void>;
288
+ }
289
+ /** @alpha Tool for revolving paths and regions. */
290
+ export declare class RevolveCurveTool extends ModifyCurveTool {
291
+ static toolId: string;
292
+ static iconSpec: string;
293
+ protected points: Point3d[];
294
+ protected allowView(vp: Viewport): boolean;
295
+ private _angleProperty;
296
+ get angleProperty(): DialogProperty<number>;
297
+ get angle(): number;
298
+ set angle(value: number);
299
+ private _cappedProperty;
300
+ get cappedProperty(): DialogProperty<boolean>;
301
+ get capped(): boolean;
302
+ set capped(value: boolean);
303
+ private _keepProfileProperty;
304
+ get keepProfileProperty(): DialogProperty<boolean>;
305
+ get keepProfile(): boolean;
306
+ set keepProfile(value: boolean);
307
+ applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
308
+ supplyToolSettingsProperties(): DialogItem[] | undefined;
309
+ protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
310
+ protected modifyCurve(ev: BeButtonEvent, isAccept: boolean): GeometryQuery | undefined;
311
+ onDynamicFrame(ev: BeButtonEvent, context: DynamicsContext): void;
312
+ protected get wantModifyOriginal(): boolean;
313
+ protected get wantAdditionalInput(): boolean;
314
+ protected gatherInput(ev: BeButtonEvent): Promise<EventHandled | undefined>;
315
+ protected setupAccuDraw(): void;
316
+ protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
317
+ onRestartTool(): Promise<void>;
318
+ }
319
319
  //# sourceMappingURL=SolidPrimitiveTools.d.ts.map