@itwin/editor-frontend 3.6.0-dev.8 → 3.6.0

package/lib/cjs/EditTool.js.map

@@ -1 +1 @@
-{"version":3,"file":"EditTool.js","sourceRoot":"","sources":["../../src/EditTool.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAyD;AACzD,wDAAqD;AACrD,6DAA0D;AAC1D,yDAAyG;AACzG,yFAEoD;AACpD,6EAA4I;AAC5I,+CAAgJ;AAChJ,6DAI8B;AAC9B,+DAAiK;AACjK,mEAAiG;AACjG,iDAAiE;AAkBjE,uGAAuG;AACvG,MAAa,SAAS;IAKb,MAAM,CAAC,KAAK,CAAC,YAAY,CAAI,SAAiB,EAAE,SAAiB,EAAE,GAAG,IAAW;QACtF,OAAO,sBAAM,CAAC,cAAc,CAAC,6BAAa,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAI,CAAe,CAAC;IAC3G,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,SAAS,CAAC,MAAc,IAAI,OAAO,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAElH;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAuB;QACpD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QAET,sFAAsF;QACtF,0GAA0G;QAC1G,0FAA0F;QAC1F,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAEzB,oCAAoC;QACpC,yBAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE9D,MAAM,gBAAgB,GAAG,yBAAS,CAAC,YAAY,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAClF,MAAM,gBAAgB,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,CAAC;QAEnD,8BAA8B;QAC9B,IAAI,gBAAgB,KAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,qBAAqB,CAAA,EAAE;YACtD,MAAM,KAAK,GAAG;gBACZ,0BAAW;gBACX,uBAAQ;gBACR,uBAAQ;aACT,CAAC;YAEF,KAAK,MAAM,IAAI,IAAI,KAAK;gBACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACjC;QAED,IAAI,gBAAgB,KAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,4BAA4B,CAAA,EAAE;YAC7D,MAAM,KAAK,GAAG;gBACZ,kDAAuB;gBACvB,kDAAuB;gBACvB,oDAAyB;gBACzB,kDAAuB;gBACvB,+CAA0B;gBAC1B,gDAA2B;gBAC3B,gDAA2B;aAC5B,CAAC;YAEF,KAAK,MAAM,IAAI,IAAI,KAAK;gBACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACjC;QAED,IAAI,gBAAgB,KAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,8BAA8B,CAAA,EAAE;YAC/D,MAAM,KAAK,GAAG;gBACZ,uCAAkB;gBAClB,wCAAgB;gBAChB,wCAAgB;gBAChB,0CAAkB;aACnB,CAAC;YAEF,KAAK,MAAM,IAAI,IAAI,KAAK;gBACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACjC;QAED,IAAI,gBAAgB,KAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,CAAA,EAAE;YACpD,MAAM,KAAK,GAAG;gBACZ,2BAAa;gBACb,8BAAgB;gBAChB,8BAAgB;gBAChB,+BAAiB;gBACjB,kCAAoB;gBACpB,iCAAmB;gBACnB,iCAAc;gBACd,kCAAe;gBACf,kCAAe;aAChB,CAAC;YAEF,KAAK,MAAM,IAAI,IAAI,KAAK;gBACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACjC;QAED,IAAI,gBAAgB,KAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,0BAA0B,CAAA,EAAE;YAC3D,MAAM,KAAK,GAAG;gBACZ,sCAAgB;gBAChB,wCAAkB;gBAClB,oCAAc;gBACd,mCAAa;gBACb,qCAAe;gBACf,sCAAgB;gBAChB,sCAAgB;gBAChB,oCAAiB;gBACjB,2CAAsB;gBACtB,8CAAyB;gBACzB,+CAA0B;gBAC1B,yCAAoB;gBACpB,6CAAwB;gBACxB,yCAAoB;gBACpB,4CAAuB;gBACvB,6CAAwB;gBACxB,uCAAkB;gBAClB,qCAAgB;gBAChB,oCAAe;gBACf,oCAAe;gBACf,mCAAc;gBACd,kCAAa;gBACb,mCAAc;gBACd,qCAAgB;gBAChB,0CAAqB;aACtB,CAAC;YAEF,KAAK,MAAM,IAAI,IAAI,KAAK;gBACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACjC;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,MAAM,CAAC,QAAQ;QACrB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;;AAhIH,8BAiIC;AAhIe,mBAAS,GAAG,QAAQ,CAAC;AACrB,eAAK,GAAG,eAAe,CAAC;AACvB,sBAAY,GAAG,KAAK,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Editing\r\n */\r\n\r\nimport { IModelApp, IpcApp } from \"@itwin/core-frontend\";\r\nimport { editorChannel } from \"@itwin/editor-common\";\r\nimport { DeleteElementsTool } from \"./DeleteElementsTool\";\r\nimport { BreakCurveTool, ExtendCurveTool, OffsetCurveTool, RegionBooleanTool } from \"./ModifyCurveTools\";\r\nimport {\r\n  ProjectLocationCancelTool, ProjectLocationHideTool, ProjectLocationSaveTool, ProjectLocationShowTool,\r\n} from \"./ProjectLocation/ProjectExtentsDecoration\";\r\nimport { ProjectGeolocationMoveTool, ProjectGeolocationNorthTool, ProjectGeolocationPointTool } from \"./ProjectLocation/ProjectGeolocation\";\r\nimport { CreateArcTool, CreateBCurveTool, CreateCircleTool, CreateEllipseTool, CreateLineStringTool, CreateRectangleTool } from \"./SketchTools\";\r\nimport {\r\n  ChamferEdgesTool, CutSolidElementsTool, DeleteSubEntitiesTool, EmbossSolidElementsTool, HollowFacesTool, ImprintSolidElementsTool,\r\n  IntersectSolidElementsTool, LoftProfilesTool, OffsetFacesTool, RoundEdgesTool, SewSheetElementsTool, SpinFacesTool, SubtractSolidElementsTool,\r\n  SweepAlongPathTool, SweepFacesTool, ThickenSheetElementsTool, UniteSolidElementsTool,\r\n} from \"./SolidModelingTools\";\r\nimport { CreateBoxTool, CreateConeTool, CreateCylinderTool, CreateSphereTool, CreateTorusTool, ExtrudeCurveTool, RevolveCurveTool } from \"./SolidPrimitiveTools\";\r\nimport { CopyElementsTool, MoveElementsTool, RotateElementsTool } from \"./TransformElementsTool\";\r\nimport { RedoTool, UndoAllTool, UndoTool } from \"./UndoRedoTool\";\r\n\r\n/** @alpha Options for [[EditTools.initialize]]. */\r\nexport interface EditorOptions {\r\n  /** If true, all tools will be registered. */\r\n  registerAllTools?: true | undefined;\r\n  /** If true, tools for undo/redo will be registered. */\r\n  registerUndoRedoTools?: true | undefined;\r\n  /** If true, tools for updating the project extents and geolocation will be registered. */\r\n  registerProjectLocationTools?: true | undefined;\r\n  /** If true, tools for basic manipulation will be registered. */\r\n  registerBasicManipulationTools?: true | undefined;\r\n  /** If true, tools for sketching will be registered. */\r\n  registerSketchTools?: true | undefined;\r\n  /** If true, tools for solid modeling will be registered. */\r\n  registerSolidModelingTools?: true | undefined;\r\n}\r\n\r\n/** @alpha functions to support PrimitiveTool and InputCollector sub-classes with using EditCommand. */\r\nexport class EditTools {\r\n  public static namespace = \"Editor\";\r\n  public static tools = \"Editor:tools.\";\r\n  private static _initialized = false;\r\n\r\n  public static async startCommand<T>(commandId: string, iModelKey: string, ...args: any[]): Promise<T> {\r\n    return IpcApp.callIpcChannel(editorChannel, \"startCommand\", commandId, iModelKey, ...args) as Promise<T>;\r\n  }\r\n\r\n  /** @internal */\r\n  public static translate(prompt: string) { return IModelApp.localization.getLocalizedString(this.tools + prompt); }\r\n\r\n  /** Call this before using the package (e.g., before attempting to use any of its tools.)\r\n   * To initialize when starting up your app:\r\n   * ```ts\r\n   *   IModelApp.startup();\r\n   *   await EditorTools.initialize();\r\n   * ```\r\n   */\r\n  public static async initialize(options?: EditorOptions): Promise<void> {\r\n    if (this._initialized)\r\n      return;\r\n\r\n    // NOTE: We should clear the active command whenever a new PrimitiveTool is installed.\r\n    //       As tool run/install isn't currently async ToolAdmin.activeToolChanged can't be used at this time.\r\n    //       The active command will be cleared whenever another edit tool calls startCommand.\r\n    this._initialized = true;\r\n\r\n    // clean up if we're being shut down\r\n    IModelApp.onBeforeShutdown.addListener(() => this.shutdown());\r\n\r\n    const namespacePromise = IModelApp.localization.registerNamespace(this.namespace);\r\n    const registerAllTools = options?.registerAllTools;\r\n\r\n    // Register requested tools...\r\n    if (registerAllTools || options?.registerUndoRedoTools) {\r\n      const tools = [\r\n        UndoAllTool,\r\n        UndoTool,\r\n        RedoTool,\r\n      ];\r\n\r\n      for (const tool of tools)\r\n        tool.register(this.namespace);\r\n    }\r\n\r\n    if (registerAllTools || options?.registerProjectLocationTools) {\r\n      const tools = [\r\n        ProjectLocationShowTool,\r\n        ProjectLocationHideTool,\r\n        ProjectLocationCancelTool,\r\n        ProjectLocationSaveTool,\r\n        ProjectGeolocationMoveTool,\r\n        ProjectGeolocationPointTool,\r\n        ProjectGeolocationNorthTool,\r\n      ];\r\n\r\n      for (const tool of tools)\r\n        tool.register(this.namespace);\r\n    }\r\n\r\n    if (registerAllTools || options?.registerBasicManipulationTools) {\r\n      const tools = [\r\n        DeleteElementsTool,\r\n        MoveElementsTool,\r\n        CopyElementsTool,\r\n        RotateElementsTool,\r\n      ];\r\n\r\n      for (const tool of tools)\r\n        tool.register(this.namespace);\r\n    }\r\n\r\n    if (registerAllTools || options?.registerSketchTools) {\r\n      const tools = [\r\n        CreateArcTool,\r\n        CreateBCurveTool,\r\n        CreateCircleTool,\r\n        CreateEllipseTool,\r\n        CreateLineStringTool,\r\n        CreateRectangleTool,\r\n        BreakCurveTool,\r\n        ExtendCurveTool,\r\n        OffsetCurveTool,\r\n      ];\r\n\r\n      for (const tool of tools)\r\n        tool.register(this.namespace);\r\n    }\r\n\r\n    if (registerAllTools || options?.registerSolidModelingTools) {\r\n      const tools = [\r\n        CreateSphereTool,\r\n        CreateCylinderTool,\r\n        CreateConeTool,\r\n        CreateBoxTool,\r\n        CreateTorusTool,\r\n        ExtrudeCurveTool,\r\n        RevolveCurveTool,\r\n        RegionBooleanTool,\r\n        UniteSolidElementsTool,\r\n        SubtractSolidElementsTool,\r\n        IntersectSolidElementsTool,\r\n        SewSheetElementsTool,\r\n        ThickenSheetElementsTool,\r\n        CutSolidElementsTool,\r\n        EmbossSolidElementsTool,\r\n        ImprintSolidElementsTool,\r\n        SweepAlongPathTool,\r\n        LoftProfilesTool,\r\n        OffsetFacesTool,\r\n        HollowFacesTool,\r\n        SweepFacesTool,\r\n        SpinFacesTool,\r\n        RoundEdgesTool,\r\n        ChamferEdgesTool,\r\n        DeleteSubEntitiesTool,\r\n      ];\r\n\r\n      for (const tool of tools)\r\n        tool.register(this.namespace);\r\n    }\r\n\r\n    return namespacePromise;\r\n  }\r\n\r\n  private static shutdown() {\r\n    this._initialized = false;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"EditTool.js","sourceRoot":"","sources":["../../src/EditTool.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiD;AACjD,wDAAyD;AACzD,wDAAwD;AAExD,gDAAgD;AAChD,2DAA2D;AAC3D,uDAAuD;AACvD,8EAA8E;AAC9E,2EAA2E;AAC3E,6CAA6C;AAC7C,2DAA2D;AAC3D,6DAA6D;AAC7D,0DAA0D;AAgB1D;;;GAGG;AACH,MAAa,SAAS;IAMb,MAAM,CAAC,KAAK,CAAC,YAAY,CAAI,QAA6B,EAAE,GAAG,OAAc;;QAClF,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,OAAO,MAAO,sBAAM,CAAC,cAAc,CAAC,gCAAgB,CAAC,OAAO,EAAE,cAAc,EAAE,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,GAAG,OAAO,CAAgB,CAAC;aAClJ;YAAC,OAAO,CAAM,EAAE;gBACf,IAAI,CAAC,CAAC,IAAI,KAAK,gCAAgB,CAAC,WAAW;oBACzC,MAAM,CAAC,CAAC,CAAC,wBAAwB;gBACnC,MAAM,KAAK,GAAG,MAAA,MAAM,CAAA,MAAA,IAAI,CAAC,SAAS,+CAAd,IAAI,EAAa,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA,mCAAI,IAAI,CAAC;gBACnE,MAAM,yBAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;aACjD;SACF;IACH,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,SAAS,CAAC,MAAc;QACpC,OAAO,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU;QAC5B,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QAET,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAEzB,oCAAoC;QACpC,yBAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE9D,MAAM,gBAAgB,GAAG,yBAAS,CAAC,YAAY,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAElF,MAAM,KAAK,GAAG,yBAAS,CAAC,KAAK,CAAC;QAC9B,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEpD,uEAAuE;QACvE,KAAK,CAAC,cAAc,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACtD,KAAK,CAAC,cAAc,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAClD,KAAK,CAAC,cAAc,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,KAAK,CAAC,cAAc,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1D,KAAK,CAAC,cAAc,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,KAAK,CAAC,cAAc,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,KAAK,CAAC,cAAc,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEvD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,MAAM,CAAC,QAAQ;QACrB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;;AA7DH,8BA8DC;AA7DwB,mBAAS,GAAG,QAAQ,CAAC;AACrB,eAAK,GAAG,eAAe,CAAC;AAEhC,sBAAY,GAAG,KAAK,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Editing\n */\n\nimport { BeDuration } from \"@itwin/core-bentley\";\nimport { IModelApp, IpcApp } from \"@itwin/core-frontend\";\nimport { editorIpcStrings } from \"@itwin/editor-common\";\n\nimport * as UndoRedoTools from \"./UndoRedoTool\";\nimport * as DeleteElementsTool from \"./DeleteElementsTool\";\nimport * as ModifyCurveTools from \"./ModifyCurveTools\";\nimport * as ProjectLocation from \"./ProjectLocation/ProjectExtentsDecoration\";\nimport * as ProjectGeoLocation from \"./ProjectLocation/ProjectGeolocation\";\nimport * as SketchTools from \"./SketchTools\";\nimport * as SolidModelingTools from \"./SolidModelingTools\";\nimport * as SolidPrimitiveTools from \"./SolidPrimitiveTools\";\nimport * as TransformTools from \"./TransformElementsTool\";\n\n/** @beta */\nexport namespace EditTools {\n  export interface StartArgs {\n    commandId: string;\n    iModelKey: string;\n  }\n  /** handler for retries when an EditTool attempts to start but a backend command is busy and can't finish its work.\n   * @param attempt the number of times this handler was previously called for this EditTool\n   * @param msg the message about what's happening from the currently busy EditCommand.\n   * @returns the delay (in milliseconds) before attempting again. If `undefined` use default (usually 1 second)\n   */\n  export type BusyRetry = (attempt: number, msg: string) => Promise<number | undefined>;\n}\n\n/**\n * Supports PrimitiveTool and InputCollector sub-classes.\n * @beta\n */\nexport class EditTools {\n  public static readonly namespace = \"Editor\";\n  public static readonly tools = \"Editor:tools.\";\n  public static busyRetry?: EditTools.BusyRetry;\n  private static _initialized = false;\n\n  public static async startCommand<T>(startArg: EditTools.StartArgs, ...cmdArgs: any[]): Promise<T> {\n    let attempt = 0;\n    while (true) {\n      try {\n        return await (IpcApp.callIpcChannel(editorIpcStrings.channel, \"startCommand\", startArg.commandId, startArg.iModelKey, ...cmdArgs) as Promise<T>);\n      } catch (e: any) {\n        if (e.name !== editorIpcStrings.commandBusy)\n          throw e; // unknown backend error\n        const delay = await this.busyRetry?.(attempt++, e.message) ?? 1000;\n        await BeDuration.fromMilliseconds(delay).wait();\n      }\n    }\n  }\n\n  /** @internal */\n  public static translate(prompt: string) {\n    return IModelApp.localization.getLocalizedString(this.tools + prompt);\n  }\n\n  /** Call this before using the package (e.g., before attempting to use any of its tools.)\n   * To initialize when starting up your app:\n   * ```ts\n   *   IModelApp.startup();\n   *   await EditorTools.initialize();\n   * ```\n   */\n  public static async initialize(): Promise<void> {\n    if (this._initialized)\n      return;\n\n    this._initialized = true;\n\n    // clean up if we're being shut down\n    IModelApp.onBeforeShutdown.addListener(() => this.shutdown());\n\n    const namespacePromise = IModelApp.localization.registerNamespace(this.namespace);\n\n    const tools = IModelApp.tools;\n    tools.registerModule(UndoRedoTools, this.namespace);\n\n    // TODO: TEMPORARY - Register tools for testing. To be moved into apps.\n    tools.registerModule(ProjectLocation, this.namespace);\n    tools.registerModule(ProjectGeoLocation, this.namespace);\n    tools.registerModule(SketchTools, this.namespace);\n    tools.registerModule(SolidModelingTools, this.namespace);\n    tools.registerModule(SolidPrimitiveTools, this.namespace);\n    tools.registerModule(TransformTools, this.namespace);\n    tools.registerModule(DeleteElementsTool, this.namespace);\n    tools.registerModule(ModifyCurveTools, this.namespace);\n\n    return namespacePromise;\n  }\n\n  private static shutdown() {\n    this._initialized = false;\n  }\n}\n"]}

package/lib/cjs/EditToolIpc.d.ts

@@ -1,18 +1,19 @@
-/** @packageDocumentation
- * @module Editing
- */
-import { PickAsyncMethods } from "@itwin/core-bentley";
-import { BasicManipulationCommandIpc, EditCommandIpc, SolidModelingCommandIpc } from "@itwin/editor-common";
-/** Create a type safe Proxy object to make IPC calls to methods of the current `EditCommand`
- * @alpha
- */
-export declare function makeEditToolIpc<K extends EditCommandIpc>(): PickAsyncMethods<K>;
-/** Proxy for calling methods in `BasicManipulationCommandIpc`
- * @alpha
- */
-export declare const basicManipulationIpc: PickAsyncMethods<BasicManipulationCommandIpc>;
-/** Proxy for calling methods in `SolidModelingCommandIpc`
-* @alpha
-*/
-export declare const solidModelingIpc: PickAsyncMethods<SolidModelingCommandIpc>;
+/** @packageDocumentation
+ * @module Editing
+ */
+import { PickAsyncMethods } from "@itwin/core-bentley";
+import { BasicManipulationCommandIpc, EditCommandIpc, SolidModelingCommandIpc } from "@itwin/editor-common";
+/**
+ * Create a type safe Proxy object to make IPC calls from an [[EditTool]] to methods of an `EditCommandIpc` interface of the current `EditCommand`.
+ * @beta
+ */
+export declare function makeEditToolIpc<K extends EditCommandIpc>(): PickAsyncMethods<K>;
+/** Proxy for calling methods in `BasicManipulationCommandIpc`
+ * @internal
+ */
+export declare const basicManipulationIpc: PickAsyncMethods<BasicManipulationCommandIpc>;
+/** Proxy for calling methods in `SolidModelingCommandIpc`
+* @internal
+*/
+export declare const solidModelingIpc: PickAsyncMethods<SolidModelingCommandIpc>;
 //# sourceMappingURL=EditToolIpc.d.ts.map

package/lib/cjs/EditToolIpc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EditToolIpc.d.ts","sourceRoot":"","sources":["../../src/EditToolIpc.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,EAAE,2BAA2B,EAAE,cAAc,EAAiB,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAE3H;;GAEG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,cAAc,KAAK,gBAAgB,CAAC,CAAC,CAAC,CAE/E;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,+CAAiD,CAAC;AACnF;;EAEE;AACF,eAAO,MAAM,gBAAgB,2CAA6C,CAAC"}
+{"version":3,"file":"EditToolIpc.d.ts","sourceRoot":"","sources":["../../src/EditToolIpc.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,EAAE,2BAA2B,EAAE,cAAc,EAAoB,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAE9H;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,cAAc,KAAK,gBAAgB,CAAC,CAAC,CAAC,CAE/E;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,+CAAiD,CAAC;AACnF;;EAEE;AACF,eAAO,MAAM,gBAAgB,2CAA6C,CAAC"}

package/lib/cjs/EditToolIpc.js

@@ -1,28 +1,29 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Editing
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.solidModelingIpc = exports.basicManipulationIpc = exports.makeEditToolIpc = void 0;
-const core_frontend_1 = require("@itwin/core-frontend");
-const editor_common_1 = require("@itwin/editor-common");
-/** Create a type safe Proxy object to make IPC calls to methods of the current `EditCommand`
- * @alpha
- */
-function makeEditToolIpc() {
-    return core_frontend_1.IpcApp.makeIpcFunctionProxy(editor_common_1.editorChannel, "callMethod");
-}
-exports.makeEditToolIpc = makeEditToolIpc;
-/** Proxy for calling methods in `BasicManipulationCommandIpc`
- * @alpha
- */
-exports.basicManipulationIpc = makeEditToolIpc();
-/** Proxy for calling methods in `SolidModelingCommandIpc`
-* @alpha
-*/
-exports.solidModelingIpc = makeEditToolIpc();
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Editing
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.solidModelingIpc = exports.basicManipulationIpc = exports.makeEditToolIpc = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const editor_common_1 = require("@itwin/editor-common");
+/**
+ * Create a type safe Proxy object to make IPC calls from an [[EditTool]] to methods of an `EditCommandIpc` interface of the current `EditCommand`.
+ * @beta
+ */
+function makeEditToolIpc() {
+    return core_frontend_1.IpcApp.makeIpcFunctionProxy(editor_common_1.editorIpcStrings.channel, "callMethod");
+}
+exports.makeEditToolIpc = makeEditToolIpc;
+/** Proxy for calling methods in `BasicManipulationCommandIpc`
+ * @internal
+ */
+exports.basicManipulationIpc = makeEditToolIpc();
+/** Proxy for calling methods in `SolidModelingCommandIpc`
+* @internal
+*/
+exports.solidModelingIpc = makeEditToolIpc();
 //# sourceMappingURL=EditToolIpc.js.map

package/lib/cjs/EditToolIpc.js.map

@@ -1 +1 @@
-{"version":3,"file":"EditToolIpc.js","sourceRoot":"","sources":["../../src/EditToolIpc.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAA8C;AAC9C,wDAA2H;AAE3H;;GAEG;AACH,SAAgB,eAAe;IAC7B,OAAO,sBAAM,CAAC,oBAAoB,CAAI,6BAAa,EAAE,YAAY,CAAC,CAAC;AACrE,CAAC;AAFD,0CAEC;AAED;;GAEG;AACU,QAAA,oBAAoB,GAAG,eAAe,EAA+B,CAAC;AACnF;;EAEE;AACW,QAAA,gBAAgB,GAAG,eAAe,EAA2B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Editing\r\n */\r\n\r\nimport { PickAsyncMethods } from \"@itwin/core-bentley\";\r\nimport { IpcApp } from \"@itwin/core-frontend\";\r\nimport { BasicManipulationCommandIpc, EditCommandIpc, editorChannel, SolidModelingCommandIpc } from \"@itwin/editor-common\";\r\n\r\n/** Create a type safe Proxy object to make IPC calls to methods of the current `EditCommand`\r\n * @alpha\r\n */\r\nexport function makeEditToolIpc<K extends EditCommandIpc>(): PickAsyncMethods<K> {\r\n  return IpcApp.makeIpcFunctionProxy<K>(editorChannel, \"callMethod\");\r\n}\r\n\r\n/** Proxy for calling methods in `BasicManipulationCommandIpc`\r\n * @alpha\r\n */\r\nexport const basicManipulationIpc = makeEditToolIpc<BasicManipulationCommandIpc>();\r\n/** Proxy for calling methods in `SolidModelingCommandIpc`\r\n* @alpha\r\n*/\r\nexport const solidModelingIpc = makeEditToolIpc<SolidModelingCommandIpc>();\r\n"]}
+{"version":3,"file":"EditToolIpc.js","sourceRoot":"","sources":["../../src/EditToolIpc.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAA8C;AAC9C,wDAA8H;AAE9H;;;GAGG;AACH,SAAgB,eAAe;IAC7B,OAAO,sBAAM,CAAC,oBAAoB,CAAI,gCAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;AAChF,CAAC;AAFD,0CAEC;AAED;;GAEG;AACU,QAAA,oBAAoB,GAAG,eAAe,EAA+B,CAAC;AACnF;;EAEE;AACW,QAAA,gBAAgB,GAAG,eAAe,EAA2B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Editing\n */\n\nimport { PickAsyncMethods } from \"@itwin/core-bentley\";\nimport { IpcApp } from \"@itwin/core-frontend\";\nimport { BasicManipulationCommandIpc, EditCommandIpc, editorIpcStrings, SolidModelingCommandIpc } from \"@itwin/editor-common\";\n\n/**\n * Create a type safe Proxy object to make IPC calls from an [[EditTool]] to methods of an `EditCommandIpc` interface of the current `EditCommand`.\n * @beta\n */\nexport function makeEditToolIpc<K extends EditCommandIpc>(): PickAsyncMethods<K> {\n  return IpcApp.makeIpcFunctionProxy<K>(editorIpcStrings.channel, \"callMethod\");\n}\n\n/** Proxy for calling methods in `BasicManipulationCommandIpc`\n * @internal\n */\nexport const basicManipulationIpc = makeEditToolIpc<BasicManipulationCommandIpc>();\n/** Proxy for calling methods in `SolidModelingCommandIpc`\n* @internal\n*/\nexport const solidModelingIpc = makeEditToolIpc<SolidModelingCommandIpc>();\n"]}

package/lib/cjs/ElementGeometryTool.d.ts

@@ -1,148 +1,148 @@
-/** @packageDocumentation
- * @module Editing
- */
-import { Id64Arg, Id64String } from "@itwin/core-bentley";
-import { FeatureAppearance } from "@itwin/core-common";
-import { BeButtonEvent, BeModifierKeys, CoordinateLockOverrides, DecorateContext, DynamicsContext, ElementSetTool, EventHandled, FeatureOverrideProvider, FeatureSymbology, GraphicBranchOptions, GraphicType, HitDetail, IModelConnection, LocateResponse, RenderGraphicOwner, SelectionMethod, SelectionSet, ToolAssistanceInstruction, Viewport } from "@itwin/core-frontend";
-import { Point3d, Ray3d, Transform } from "@itwin/core-geometry";
-import { BRepEntityType, ElementGeometryCacheFilter, ElementGeometryResultProps, SubEntityFilter, SubEntityGeometryProps, SubEntityLocationProps, SubEntityProps, SubEntityType } from "@itwin/editor-common";
-/** @alpha */
-export declare class ElementGeometryGraphicsProvider {
-    readonly iModel: IModelConnection;
-    graphic?: RenderGraphicOwner;
-    constructor(iModel: IModelConnection);
-    /** Call to request a RenderGraphic for the supplied graphic data.
-     * @see [[cleanupGraphic]] Must be called when the tool exits.
-     */
-    createGraphic(graphicData: Uint8Array): Promise<boolean>;
-    /** Call to dispose of [[RenderGraphic]] held by [[RenderGraphicOwner]].
-     * @note Must be called when the tool exits to avoid leaks of graphics memory or other webgl resources.
-     */
-    cleanupGraphic(): void;
-    addGraphic(context: DynamicsContext, transform?: Transform, opts?: GraphicBranchOptions): void;
-    addDecoration(context: DecorateContext, type: GraphicType, transform?: Transform, opts?: GraphicBranchOptions): void;
-}
-/** @alpha */
-export declare function isSameSubEntity(a: SubEntityProps, b: SubEntityProps): boolean;
-/** @alpha */
-export declare class SubEntityData {
-    toolData?: any;
-    chordTolerance?: number;
-    private _props;
-    private _geometry?;
-    private _graphicsProvider?;
-    constructor(props: SubEntityProps);
-    get props(): SubEntityProps;
-    set props(value: SubEntityProps);
-    get geometry(): SubEntityGeometryProps | undefined;
-    set geometry(value: SubEntityGeometryProps | undefined);
-    isSame(other: SubEntityProps): boolean;
-    getAppearance(vp: Viewport, accepted: boolean): FeatureAppearance;
-    createGraphic(iModel: IModelConnection): Promise<boolean>;
-    cleanupGraphic(): void;
-    get hasGraphic(): boolean;
-    display(context: DecorateContext, accepted: boolean): void;
-}
-/** @alpha Base class for tools that want to use the backend geometry cache. */
-export declare abstract class ElementGeometryCacheTool extends ElementSetTool implements FeatureOverrideProvider {
-    protected _startedCmd?: string;
-    protected readonly _checkedIds: Map<string, boolean>;
-    protected _graphicsProvider?: ElementGeometryGraphicsProvider;
-    protected _graphicsPending?: true;
-    protected _firstResult: boolean;
-    protected _agendaAppearanceDefault?: FeatureAppearance;
-    protected _agendaAppearanceDynamic?: FeatureAppearance;
-    protected allowView(vp: Viewport): boolean;
-    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
-    protected startCommand(): Promise<string>;
-    protected agendaAppearance(isDynamics: boolean): FeatureAppearance;
-    protected get wantAgendaAppearanceOverride(): boolean;
-    addFeatureOverrides(overrides: FeatureSymbology.Overrides, _vp: Viewport): void;
-    protected updateAgendaAppearanceProvider(drop?: true): void;
-    protected get geometryCacheFilter(): ElementGeometryCacheFilter | undefined;
-    protected onGeometryCacheFilterChanged(): void;
-    protected createElementGeometryCache(id: Id64String): Promise<boolean>;
-    protected acceptElementForOperation(id: Id64String): Promise<boolean>;
-    protected isElementValidForOperation(hit: HitDetail, out?: LocateResponse): Promise<boolean>;
-    protected postFilterIds(arg: Id64Arg): Promise<Id64Arg>;
-    protected getGroupIds(id: Id64String): Promise<Id64Arg>;
-    protected getSelectionSetCandidates(ss: SelectionSet): Promise<Id64Arg>;
-    protected getDragSelectCandidates(vp: Viewport, origin: Point3d, corner: Point3d, method: SelectionMethod, overlap: boolean): Promise<Id64Arg>;
-    onDynamicFrame(_ev: BeButtonEvent, context: DynamicsContext): void;
-    onMouseMotion(ev: BeButtonEvent): Promise<void>;
-    protected getGraphicData(_ev: BeButtonEvent): Promise<Uint8Array | undefined>;
-    protected updateGraphic(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
-    protected createGraphic(graphicData: Uint8Array): Promise<void>;
-    protected clearGraphic(): void;
-    protected clearElementGeometryCache(): Promise<void>;
-    onUnsuspend(): Promise<void>;
-    onSuspend(): Promise<void>;
-    onPostInstall(): Promise<void>;
-    onCleanup(): Promise<void>;
-}
-/** @alpha Base class for tools that need to locate faces, edges, and vertices. */
-export declare abstract class LocateSubEntityTool extends ElementGeometryCacheTool {
-    protected _currentSubEntity?: SubEntityData;
-    protected _acceptedSubEntities: SubEntityData[];
-    protected _locatedSubEntities?: SubEntityLocationProps[];
-    protected _subEntityGraphicPending?: true;
-    protected readonly _summaryIds: Map<string, BRepEntityType[]>;
-    protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
-    protected get wantAgendaAppearanceOverride(): boolean;
-    protected get wantGeometrySummary(): boolean;
-    protected get wantSubEntitySnap(): boolean;
-    protected wantSubEntityType(type: SubEntityType): boolean;
-    protected getMaximumSubEntityHits(type: SubEntityType): number;
-    protected get requiredSubEntityCount(): number;
-    protected get haveAcceptedSubEntities(): boolean;
-    protected get inhibitSubEntityDisplay(): boolean;
-    protected get allowSubEntityControlSelect(): boolean;
-    protected get allowSubEntityControlDeselect(): boolean;
-    protected get allowSubEntitySelectNext(): boolean;
-    protected getBRepEntityTypeForSubEntity(id: Id64String, subEntity: SubEntityProps): BRepEntityType;
-    protected createElementGeometrySummary(id: Id64String): Promise<boolean>;
-    protected createElementGeometryCache(id: Id64String): Promise<boolean>;
-    protected getAcceptedSubEntityData(index?: number): SubEntityData | undefined;
-    protected getAcceptedSubEntities(): SubEntityProps[];
-    protected drawSubEntity(context: DecorateContext, subEntity: SubEntityData, accepted: boolean): void;
-    protected drawAcceptedSubEntities(context: DecorateContext): void;
-    decorate(context: DecorateContext): void;
-    decorateSuspended(context: DecorateContext): void;
-    protected getLocateAperture(ev: BeButtonEvent): number;
-    protected getMaxRayDistance(ev: BeButtonEvent, aperture: number): number;
-    protected getRayOrigin(ev: BeButtonEvent): Point3d;
-    protected wantHiddenEdges(vp: Viewport): boolean;
-    protected getSubEntityFilter(): SubEntityFilter | undefined;
-    protected pickSubEntities(id: Id64String, boresite: Ray3d, maxFace: number, maxEdge: number, maxVertex: number, maxDistance: number, hiddenEdgesVisible: boolean, filter?: SubEntityFilter): Promise<SubEntityLocationProps[] | undefined>;
-    protected doPickSubEntities(id: Id64String, ev: BeButtonEvent): Promise<SubEntityLocationProps[] | undefined>;
-    protected createSubEntityData(id: Id64String, hit: SubEntityLocationProps): Promise<SubEntityData>;
-    /** Append specified sub-entity to accepted array. */
-    protected addSubEntity(id: Id64String, props: SubEntityLocationProps): Promise<void>;
-    /** Remove specified sub-entity from accepted array, or pop last sub-entity if undefined. */
-    protected removeSubEntity(_id: Id64String, props?: SubEntityLocationProps): Promise<void>;
-    /** Locate sub-entities for the most recently added (last) agenda entry. Tool sub-classes that wish to identity
-     * sub-entities from multiple elements are responsible for maintaining the sub-entities per-element.
-     */
-    protected doLocateSubEntity(ev: BeButtonEvent, newSearch: boolean): Promise<boolean>;
-    protected chooseNextHit(ev: BeButtonEvent): Promise<EventHandled>;
-    protected get wantAdditionalSubEntities(): boolean;
-    protected gatherInput(ev: BeButtonEvent): Promise<EventHandled | undefined>;
-    protected getCurrentElement(): Id64String | undefined;
-    protected clearCurrentSubEntity(): void;
-    protected setCurrentSubEntity(id: Id64String, hit: SubEntityLocationProps, chordTolerance?: number): Promise<boolean>;
-    protected changeCurrentSubEntity(id?: Id64String, current?: SubEntityLocationProps, chordTolerance?: number): Promise<boolean>;
-    protected updateCurrentSubEntity(ev: BeButtonEvent): Promise<boolean>;
-    protected createSubEntityGraphic(id: Id64String, data: SubEntityData, chordTolerance?: number): Promise<boolean>;
-    protected updateGraphic(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
-    protected getGraphicData(ev: BeButtonEvent): Promise<Uint8Array | undefined>;
-    protected applyAgendaOperation(_ev: BeButtonEvent, _isAccept: boolean): Promise<ElementGeometryResultProps | undefined>;
-    processAgenda(ev: BeButtonEvent): Promise<void>;
-    onModifierKeyTransition(wentDown: boolean, modifier: BeModifierKeys, event: KeyboardEvent): Promise<EventHandled>;
-    changeLocateState(enableLocate: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void;
-    protected get shouldEnableSnap(): boolean;
-    protected setupAccuDraw(): void;
-    protected setupAndPromptForNextAction(): void;
-    protected clearSubEntityGraphics(): void;
-    onCleanup(): Promise<void>;
-}
+/** @packageDocumentation
+ * @module Editing
+ */
+import { Id64Arg, Id64String } from "@itwin/core-bentley";
+import { FeatureAppearance } from "@itwin/core-common";
+import { BeButtonEvent, BeModifierKeys, CoordinateLockOverrides, DecorateContext, DynamicsContext, ElementSetTool, EventHandled, FeatureOverrideProvider, FeatureSymbology, GraphicBranchOptions, GraphicType, HitDetail, IModelConnection, LocateResponse, RenderGraphicOwner, SelectionMethod, SelectionSet, ToolAssistanceInstruction, Viewport } from "@itwin/core-frontend";
+import { Point3d, Ray3d, Transform } from "@itwin/core-geometry";
+import { BRepEntityType, ElementGeometryCacheFilter, ElementGeometryResultProps, SubEntityFilter, SubEntityGeometryProps, SubEntityLocationProps, SubEntityProps, SubEntityType } from "@itwin/editor-common";
+/** @alpha */
+export declare class ElementGeometryGraphicsProvider {
+    readonly iModel: IModelConnection;
+    graphic?: RenderGraphicOwner;
+    constructor(iModel: IModelConnection);
+    /** Call to request a RenderGraphic for the supplied graphic data.
+     * @see [[cleanupGraphic]] Must be called when the tool exits.
+     */
+    createGraphic(graphicData: Uint8Array): Promise<boolean>;
+    /** Call to dispose of [[RenderGraphic]] held by [[RenderGraphicOwner]].
+     * @note Must be called when the tool exits to avoid leaks of graphics memory or other webgl resources.
+     */
+    cleanupGraphic(): void;
+    addGraphic(context: DynamicsContext, transform?: Transform, opts?: GraphicBranchOptions): void;
+    addDecoration(context: DecorateContext, type: GraphicType, transform?: Transform, opts?: GraphicBranchOptions): void;
+}
+/** @alpha */
+export declare function isSameSubEntity(a: SubEntityProps, b: SubEntityProps): boolean;
+/** @alpha */
+export declare class SubEntityData {
+    toolData?: any;
+    chordTolerance?: number;
+    private _props;
+    private _geometry?;
+    private _graphicsProvider?;
+    constructor(props: SubEntityProps);
+    get props(): SubEntityProps;
+    set props(value: SubEntityProps);
+    get geometry(): SubEntityGeometryProps | undefined;
+    set geometry(value: SubEntityGeometryProps | undefined);
+    isSame(other: SubEntityProps): boolean;
+    getAppearance(vp: Viewport, accepted: boolean): FeatureAppearance;
+    createGraphic(iModel: IModelConnection): Promise<boolean>;
+    cleanupGraphic(): void;
+    get hasGraphic(): boolean;
+    display(context: DecorateContext, accepted: boolean): void;
+}
+/** @alpha Base class for tools that want to use the backend geometry cache. */
+export declare abstract class ElementGeometryCacheTool extends ElementSetTool implements FeatureOverrideProvider {
+    protected _startedCmd?: string;
+    protected readonly _checkedIds: Map<string, boolean>;
+    protected _graphicsProvider?: ElementGeometryGraphicsProvider;
+    protected _graphicsPending?: true;
+    protected _firstResult: boolean;
+    protected _agendaAppearanceDefault?: FeatureAppearance;
+    protected _agendaAppearanceDynamic?: FeatureAppearance;
+    protected allowView(vp: Viewport): boolean;
+    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
+    protected startCommand(): Promise<string>;
+    protected agendaAppearance(isDynamics: boolean): FeatureAppearance;
+    protected get wantAgendaAppearanceOverride(): boolean;
+    addFeatureOverrides(overrides: FeatureSymbology.Overrides, _vp: Viewport): void;
+    protected updateAgendaAppearanceProvider(drop?: true): void;
+    protected get geometryCacheFilter(): ElementGeometryCacheFilter | undefined;
+    protected onGeometryCacheFilterChanged(): void;
+    protected createElementGeometryCache(id: Id64String): Promise<boolean>;
+    protected acceptElementForOperation(id: Id64String): Promise<boolean>;
+    protected isElementValidForOperation(hit: HitDetail, out?: LocateResponse): Promise<boolean>;
+    protected postFilterIds(arg: Id64Arg): Promise<Id64Arg>;
+    protected getGroupIds(id: Id64String): Promise<Id64Arg>;
+    protected getSelectionSetCandidates(ss: SelectionSet): Promise<Id64Arg>;
+    protected getDragSelectCandidates(vp: Viewport, origin: Point3d, corner: Point3d, method: SelectionMethod, overlap: boolean): Promise<Id64Arg>;
+    onDynamicFrame(_ev: BeButtonEvent, context: DynamicsContext): void;
+    onMouseMotion(ev: BeButtonEvent): Promise<void>;
+    protected getGraphicData(_ev: BeButtonEvent): Promise<Uint8Array | undefined>;
+    protected updateGraphic(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
+    protected createGraphic(graphicData: Uint8Array): Promise<void>;
+    protected clearGraphic(): void;
+    protected clearElementGeometryCache(): Promise<void>;
+    onUnsuspend(): Promise<void>;
+    onSuspend(): Promise<void>;
+    onPostInstall(): Promise<void>;
+    onCleanup(): Promise<void>;
+}
+/** @alpha Base class for tools that need to locate faces, edges, and vertices. */
+export declare abstract class LocateSubEntityTool extends ElementGeometryCacheTool {
+    protected _currentSubEntity?: SubEntityData;
+    protected _acceptedSubEntities: SubEntityData[];
+    protected _locatedSubEntities?: SubEntityLocationProps[];
+    protected _subEntityGraphicPending?: true;
+    protected readonly _summaryIds: Map<string, BRepEntityType[]>;
+    protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
+    protected get wantAgendaAppearanceOverride(): boolean;
+    protected get wantGeometrySummary(): boolean;
+    protected get wantSubEntitySnap(): boolean;
+    protected wantSubEntityType(type: SubEntityType): boolean;
+    protected getMaximumSubEntityHits(type: SubEntityType): number;
+    protected get requiredSubEntityCount(): number;
+    protected get haveAcceptedSubEntities(): boolean;
+    protected get inhibitSubEntityDisplay(): boolean;
+    protected get allowSubEntityControlSelect(): boolean;
+    protected get allowSubEntityControlDeselect(): boolean;
+    protected get allowSubEntitySelectNext(): boolean;
+    protected getBRepEntityTypeForSubEntity(id: Id64String, subEntity: SubEntityProps): BRepEntityType;
+    protected createElementGeometrySummary(id: Id64String): Promise<boolean>;
+    protected createElementGeometryCache(id: Id64String): Promise<boolean>;
+    protected getAcceptedSubEntityData(index?: number): SubEntityData | undefined;
+    protected getAcceptedSubEntities(): SubEntityProps[];
+    protected drawSubEntity(context: DecorateContext, subEntity: SubEntityData, accepted: boolean): void;
+    protected drawAcceptedSubEntities(context: DecorateContext): void;
+    decorate(context: DecorateContext): void;
+    decorateSuspended(context: DecorateContext): void;
+    protected getLocateAperture(ev: BeButtonEvent): number;
+    protected getMaxRayDistance(ev: BeButtonEvent, aperture: number): number;
+    protected getRayOrigin(ev: BeButtonEvent): Point3d;
+    protected wantHiddenEdges(vp: Viewport): boolean;
+    protected getSubEntityFilter(): SubEntityFilter | undefined;
+    protected pickSubEntities(id: Id64String, boresite: Ray3d, maxFace: number, maxEdge: number, maxVertex: number, maxDistance: number, hiddenEdgesVisible: boolean, filter?: SubEntityFilter): Promise<SubEntityLocationProps[] | undefined>;
+    protected doPickSubEntities(id: Id64String, ev: BeButtonEvent): Promise<SubEntityLocationProps[] | undefined>;
+    protected createSubEntityData(id: Id64String, hit: SubEntityLocationProps): Promise<SubEntityData>;
+    /** Append specified sub-entity to accepted array. */
+    protected addSubEntity(id: Id64String, props: SubEntityLocationProps): Promise<void>;
+    /** Remove specified sub-entity from accepted array, or pop last sub-entity if undefined. */
+    protected removeSubEntity(_id: Id64String, props?: SubEntityLocationProps): Promise<void>;
+    /** Locate sub-entities for the most recently added (last) agenda entry. Tool sub-classes that wish to identity
+     * sub-entities from multiple elements are responsible for maintaining the sub-entities per-element.
+     */
+    protected doLocateSubEntity(ev: BeButtonEvent, newSearch: boolean): Promise<boolean>;
+    protected chooseNextHit(ev: BeButtonEvent): Promise<EventHandled>;
+    protected get wantAdditionalSubEntities(): boolean;
+    protected gatherInput(ev: BeButtonEvent): Promise<EventHandled | undefined>;
+    protected getCurrentElement(): Id64String | undefined;
+    protected clearCurrentSubEntity(): void;
+    protected setCurrentSubEntity(id: Id64String, hit: SubEntityLocationProps, chordTolerance?: number): Promise<boolean>;
+    protected changeCurrentSubEntity(id?: Id64String, current?: SubEntityLocationProps, chordTolerance?: number): Promise<boolean>;
+    protected updateCurrentSubEntity(ev: BeButtonEvent): Promise<boolean>;
+    protected createSubEntityGraphic(id: Id64String, data: SubEntityData, chordTolerance?: number): Promise<boolean>;
+    protected updateGraphic(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
+    protected getGraphicData(ev: BeButtonEvent): Promise<Uint8Array | undefined>;
+    protected applyAgendaOperation(_ev: BeButtonEvent, _isAccept: boolean): Promise<ElementGeometryResultProps | undefined>;
+    processAgenda(ev: BeButtonEvent): Promise<void>;
+    onModifierKeyTransition(wentDown: boolean, modifier: BeModifierKeys, event: KeyboardEvent): Promise<EventHandled>;
+    changeLocateState(enableLocate: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void;
+    protected get shouldEnableSnap(): boolean;
+    protected setupAccuDraw(): void;
+    protected setupAndPromptForNextAction(): void;
+    protected clearSubEntityGraphics(): void;
+    onCleanup(): Promise<void>;
+}
 //# sourceMappingURL=ElementGeometryTool.d.ts.map