@itwin/editor-frontend 4.0.0-dev.8 → 4.0.0-dev.81

package/lib/esm/TransformElementsTool.d.ts

@@ -1,165 +1,165 @@
-import { DialogItem, DialogProperty, DialogPropertySyncItem } from "@itwin/appui-abstract";
-import { Id64Arg, Id64Array, Id64String } from "@itwin/core-bentley";
-import { Placement } from "@itwin/core-common";
-import { BeButtonEvent, DynamicsContext, ElementSetTool, IModelConnection, RenderGraphic, RenderGraphicOwner, ToolAssistanceInstruction } from "@itwin/core-frontend";
-import { Point3d, Transform } from "@itwin/core-geometry";
-/** @alpha */
-export interface TransformGraphicsData {
-    id: Id64String;
-    placement: Placement;
-    graphic: RenderGraphicOwner;
-}
-/** @alpha */
-export declare class TransformGraphicsProvider {
-    readonly iModel: IModelConnection;
-    readonly data: TransformGraphicsData[];
-    readonly pending: Map<Id64String, string>;
-    readonly prefix: string;
-    /** Chord tolerance to use to stroke the element's geometry in meters. */
-    chordTolerance: number;
-    constructor(iModel: IModelConnection, prefix: string);
-    private getRequestId;
-    private getToleranceLog10;
-    private createRequest;
-    private disposeOfGraphics;
-    private cancelPendingRequests;
-    /** Call to request a RenderGraphic for the supplied element id.
-   * @see [[cleanupGraphics]] Must be called when the tool exits.
-   */
-    createSingleGraphic(id: Id64String): Promise<boolean>;
-    /** Call to request RenderGraphics for the supplied element ids. Does not wait for results as
-     * generating graphics for a large number of elements can take time. Instead an array of [[RenderGraphicOwner]]
-     * is populated as requests are resolved and the current dynamics frame displays what is available.
-     * @see [[cleanupGraphics]] Must be called when the tool exits.
-     */
-    createGraphics(elements: Id64Arg): void;
-    /** Call to dispose of [[RenderGraphic]] held by [[RenderGraphicOwner]] and cancel requests that are still pending.
-     * @note Must be called when the tool exits to avoid leaks of graphics memory or other webgl resources.
-     */
-    cleanupGraphics(): Promise<void>;
-    addSingleGraphic(graphic: RenderGraphic, transform: Transform, context: DynamicsContext): void;
-    addGraphics(transform: Transform, context: DynamicsContext): void;
-}
-/** @alpha Base class for applying a transform to element placements. */
-export declare abstract class TransformElementsTool extends ElementSetTool {
-    protected get allowSelectionSet(): boolean;
-    protected get allowGroups(): boolean;
-    protected get allowDragSelect(): boolean;
-    protected get controlKeyContinuesSelection(): boolean;
-    protected get wantAccuSnap(): boolean;
-    protected get wantDynamics(): boolean;
-    protected get wantMakeCopy(): boolean;
-    protected get wantRepeatOperation(): boolean;
-    protected _graphicsProvider?: TransformGraphicsProvider;
-    protected _startedCmd?: string;
-    protected abstract calculateTransform(ev: BeButtonEvent): Transform | undefined;
-    protected createAgendaGraphics(changed: boolean): Promise<void>;
-    protected clearAgendaGraphics(): Promise<void>;
-    protected onAgendaModified(): Promise<void>;
-    protected initAgendaDynamics(): Promise<boolean>;
-    protected transformAgendaDynamics(transform: Transform, context: DynamicsContext): void;
-    onDynamicFrame(ev: BeButtonEvent, context: DynamicsContext): void;
-    protected updateAnchorLocation(transform: Transform): void;
-    protected startCommand(): Promise<string>;
-    protected replaceAgenda(newIds: Id64Arg | undefined): Promise<void>;
-    protected transformAndCopyAgenda(_transform: Transform): Promise<Id64Arg | undefined>;
-    protected transformAgenda(transform: Transform): Promise<void>;
-    processAgenda(ev: BeButtonEvent): Promise<void>;
-    onProcessComplete(): Promise<void>;
-    onCleanup(): Promise<void>;
-}
-/** @alpha Move elements by applying translation to placement. */
-export declare class MoveElementsTool extends TransformElementsTool {
-    static toolId: string;
-    static iconSpec: string;
-    protected calculateTransform(ev: BeButtonEvent): Transform | undefined;
-    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
-    onRestartTool(): Promise<void>;
-}
-/** Create new elements with translation applied to placement.
- * This is a brute force implementation strictly for example and testing purposes.
- * The new elements are Generic:PhysicalObject or BisCore:DrawingGraphic using the model and category of original.
- * Does not preserve assemblies and geometric elements without geometry are not copied.
- * Using loadProps to return json format geometry to the frontend for each element in the tool agenda is very inefficient.
- * Applications that wish to support copy are expected to sub-class TransformElementsTool and register their
- * own EditCommand that can correctly copy their application elements.
- * @alpha
- */
-export declare class CopyElementsTool extends MoveElementsTool {
-    static toolId: string;
-    static iconSpec: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    private _numCopiesProperty;
-    get numCopiesProperty(): DialogProperty<number>;
-    get numCopies(): number;
-    set numCopies(value: number);
-    protected get wantMakeCopy(): boolean;
-    protected updateAnchorLocation(transform: Transform): void;
-    protected doTransformedCopy(ids: Id64Array, transform: Transform, numCopies: number): Promise<Id64Arg | undefined>;
-    protected transformAndCopyAgenda(transform: Transform): Promise<Id64Arg | undefined>;
-    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
-    supplyToolSettingsProperties(): DialogItem[] | undefined;
-    onRestartTool(): Promise<void>;
-    /** The keyin takes the following arguments, all of which are optional:
-     *  - `numCopies=number` Number of copies of each element to create, default is 1.
-     */
-    parseAndRun(...inputArgs: string[]): Promise<boolean>;
-}
-/** @alpha */
-export declare enum RotateMethod {
-    By3Points = 0,
-    ByAngle = 1
-}
-/** @alpha */
-export declare enum RotateAbout {
-    Point = 0,
-    Origin = 1,
-    Center = 2
-}
-/** @alpha Rotate elements by applying transform to placement. */
-export declare class RotateElementsTool extends TransformElementsTool {
-    static toolId: string;
-    static iconSpec: string;
-    protected xAxisPoint?: Point3d;
-    protected havePivotPoint: boolean;
-    protected haveFinalPoint: boolean;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    private static methodMessage;
-    private static getMethodChoices;
-    private _methodProperty;
-    get methodProperty(): DialogProperty<number>;
-    get rotateMethod(): RotateMethod;
-    set rotateMethod(method: RotateMethod);
-    private static aboutMessage;
-    private static getAboutChoices;
-    private _aboutProperty;
-    get aboutProperty(): DialogProperty<number>;
-    get rotateAbout(): RotateAbout;
-    set rotateAbout(method: RotateAbout);
-    private _angleProperty;
-    get angleProperty(): DialogProperty<number>;
-    get rotateAngle(): number;
-    set rotateAngle(value: number);
-    protected get requireAcceptForSelectionSetDynamics(): boolean;
-    protected calculateTransform(ev: BeButtonEvent): Transform | undefined;
-    protected transformAgendaDynamics(transform: Transform, context: DynamicsContext): void;
-    protected transformAgenda(transform: Transform): Promise<void>;
-    onDynamicFrame(ev: BeButtonEvent, context: DynamicsContext): void;
-    protected get wantAdditionalInput(): boolean;
-    protected wantProcessAgenda(ev: BeButtonEvent): boolean;
-    protected setupAndPromptForNextAction(): void;
-    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
-    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
-    supplyToolSettingsProperties(): DialogItem[] | undefined;
-    onRestartTool(): Promise<void>;
-    onInstall(): Promise<boolean>;
-    /** The keyin takes the following arguments, all of which are optional:
-     *  - `method=0|1` How rotate angle will be specified. 0 for by 3 points, 1 for by specified angle.
-     *  - `about=0|1|2` Location to rotate about. 0 for point, 1 for placement origin, and 2 for center of range.
-     *  - `angle=number` Rotation angle in degrees when not defining angle by points.
-     */
-    parseAndRun(...inputArgs: string[]): Promise<boolean>;
-}
+import { DialogItem, DialogProperty, DialogPropertySyncItem } from "@itwin/appui-abstract";
+import { Id64Arg, Id64Array, Id64String } from "@itwin/core-bentley";
+import { Placement } from "@itwin/core-common";
+import { BeButtonEvent, DynamicsContext, ElementSetTool, IModelConnection, RenderGraphic, RenderGraphicOwner, ToolAssistanceInstruction } from "@itwin/core-frontend";
+import { Point3d, Transform } from "@itwin/core-geometry";
+/** @alpha */
+export interface TransformGraphicsData {
+    id: Id64String;
+    placement: Placement;
+    graphic: RenderGraphicOwner;
+}
+/** @alpha */
+export declare class TransformGraphicsProvider {
+    readonly iModel: IModelConnection;
+    readonly data: TransformGraphicsData[];
+    readonly pending: Map<Id64String, string>;
+    readonly prefix: string;
+    /** Chord tolerance to use to stroke the element's geometry in meters. */
+    chordTolerance: number;
+    constructor(iModel: IModelConnection, prefix: string);
+    private getRequestId;
+    private getToleranceLog10;
+    private createRequest;
+    private disposeOfGraphics;
+    private cancelPendingRequests;
+    /** Call to request a RenderGraphic for the supplied element id.
+   * @see [[cleanupGraphics]] Must be called when the tool exits.
+   */
+    createSingleGraphic(id: Id64String): Promise<boolean>;
+    /** Call to request RenderGraphics for the supplied element ids. Does not wait for results as
+     * generating graphics for a large number of elements can take time. Instead an array of [[RenderGraphicOwner]]
+     * is populated as requests are resolved and the current dynamics frame displays what is available.
+     * @see [[cleanupGraphics]] Must be called when the tool exits.
+     */
+    createGraphics(elements: Id64Arg): void;
+    /** Call to dispose of [[RenderGraphic]] held by [[RenderGraphicOwner]] and cancel requests that are still pending.
+     * @note Must be called when the tool exits to avoid leaks of graphics memory or other webgl resources.
+     */
+    cleanupGraphics(): Promise<void>;
+    addSingleGraphic(graphic: RenderGraphic, transform: Transform, context: DynamicsContext): void;
+    addGraphics(transform: Transform, context: DynamicsContext): void;
+}
+/** @alpha Base class for applying a transform to element placements. */
+export declare abstract class TransformElementsTool extends ElementSetTool {
+    protected get allowSelectionSet(): boolean;
+    protected get allowGroups(): boolean;
+    protected get allowDragSelect(): boolean;
+    protected get controlKeyContinuesSelection(): boolean;
+    protected get wantAccuSnap(): boolean;
+    protected get wantDynamics(): boolean;
+    protected get wantMakeCopy(): boolean;
+    protected get wantRepeatOperation(): boolean;
+    protected _graphicsProvider?: TransformGraphicsProvider;
+    protected _startedCmd?: string;
+    protected abstract calculateTransform(ev: BeButtonEvent): Transform | undefined;
+    protected createAgendaGraphics(changed: boolean): Promise<void>;
+    protected clearAgendaGraphics(): Promise<void>;
+    protected onAgendaModified(): Promise<void>;
+    protected initAgendaDynamics(): Promise<boolean>;
+    protected transformAgendaDynamics(transform: Transform, context: DynamicsContext): void;
+    onDynamicFrame(ev: BeButtonEvent, context: DynamicsContext): void;
+    protected updateAnchorLocation(transform: Transform): void;
+    protected startCommand(): Promise<string>;
+    protected replaceAgenda(newIds: Id64Arg | undefined): Promise<void>;
+    protected transformAndCopyAgenda(_transform: Transform): Promise<Id64Arg | undefined>;
+    protected transformAgenda(transform: Transform): Promise<void>;
+    processAgenda(ev: BeButtonEvent): Promise<void>;
+    onProcessComplete(): Promise<void>;
+    onCleanup(): Promise<void>;
+}
+/** @alpha Move elements by applying translation to placement. */
+export declare class MoveElementsTool extends TransformElementsTool {
+    static toolId: string;
+    static iconSpec: string;
+    protected calculateTransform(ev: BeButtonEvent): Transform | undefined;
+    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
+    onRestartTool(): Promise<void>;
+}
+/** Create new elements with translation applied to placement.
+ * This is a brute force implementation strictly for example and testing purposes.
+ * The new elements are Generic:PhysicalObject or BisCore:DrawingGraphic using the model and category of original.
+ * Does not preserve assemblies and geometric elements without geometry are not copied.
+ * Using loadProps to return json format geometry to the frontend for each element in the tool agenda is very inefficient.
+ * Applications that wish to support copy are expected to sub-class TransformElementsTool and register their
+ * own EditCommand that can correctly copy their application elements.
+ * @alpha
+ */
+export declare class CopyElementsTool extends MoveElementsTool {
+    static toolId: string;
+    static iconSpec: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _numCopiesProperty;
+    get numCopiesProperty(): DialogProperty<number>;
+    get numCopies(): number;
+    set numCopies(value: number);
+    protected get wantMakeCopy(): boolean;
+    protected updateAnchorLocation(transform: Transform): void;
+    protected doTransformedCopy(ids: Id64Array, transform: Transform, numCopies: number): Promise<Id64Arg | undefined>;
+    protected transformAndCopyAgenda(transform: Transform): Promise<Id64Arg | undefined>;
+    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
+    supplyToolSettingsProperties(): DialogItem[] | undefined;
+    onRestartTool(): Promise<void>;
+    /** The keyin takes the following arguments, all of which are optional:
+     *  - `numCopies=number` Number of copies of each element to create, default is 1.
+     */
+    parseAndRun(...inputArgs: string[]): Promise<boolean>;
+}
+/** @alpha */
+export declare enum RotateMethod {
+    By3Points = 0,
+    ByAngle = 1
+}
+/** @alpha */
+export declare enum RotateAbout {
+    Point = 0,
+    Origin = 1,
+    Center = 2
+}
+/** @alpha Rotate elements by applying transform to placement. */
+export declare class RotateElementsTool extends TransformElementsTool {
+    static toolId: string;
+    static iconSpec: string;
+    protected xAxisPoint?: Point3d;
+    protected havePivotPoint: boolean;
+    protected haveFinalPoint: boolean;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private static methodMessage;
+    private static getMethodChoices;
+    private _methodProperty;
+    get methodProperty(): DialogProperty<number>;
+    get rotateMethod(): RotateMethod;
+    set rotateMethod(method: RotateMethod);
+    private static aboutMessage;
+    private static getAboutChoices;
+    private _aboutProperty;
+    get aboutProperty(): DialogProperty<number>;
+    get rotateAbout(): RotateAbout;
+    set rotateAbout(method: RotateAbout);
+    private _angleProperty;
+    get angleProperty(): DialogProperty<number>;
+    get rotateAngle(): number;
+    set rotateAngle(value: number);
+    protected get requireAcceptForSelectionSetDynamics(): boolean;
+    protected calculateTransform(ev: BeButtonEvent): Transform | undefined;
+    protected transformAgendaDynamics(transform: Transform, context: DynamicsContext): void;
+    protected transformAgenda(transform: Transform): Promise<void>;
+    onDynamicFrame(ev: BeButtonEvent, context: DynamicsContext): void;
+    protected get wantAdditionalInput(): boolean;
+    protected wantProcessAgenda(ev: BeButtonEvent): boolean;
+    protected setupAndPromptForNextAction(): void;
+    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
+    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
+    supplyToolSettingsProperties(): DialogItem[] | undefined;
+    onRestartTool(): Promise<void>;
+    onInstall(): Promise<boolean>;
+    /** The keyin takes the following arguments, all of which are optional:
+     *  - `method=0|1` How rotate angle will be specified. 0 for by 3 points, 1 for by specified angle.
+     *  - `about=0|1|2` Location to rotate about. 0 for point, 1 for placement origin, and 2 for center of range.
+     *  - `angle=number` Rotation angle in degrees when not defining angle by points.
+     */
+    parseAndRun(...inputArgs: string[]): Promise<boolean>;
+}
 //# sourceMappingURL=TransformElementsTool.d.ts.map