@itwin/core-frontend 5.0.0-dev.32 → 5.0.0-dev.34

package/lib/cjs/tools/ToolAssistance.js

@@ -69,6 +69,19 @@ var ToolAssistanceInputMethod;
  * @extensions
  */
 class ToolAssistance {
+    /** Up key symbol. */
+    static { this.upSymbol = "\u2bc5"; }
+    /** Down key symbol. */
+    static { this.downSymbol = "\u2bc6"; }
+    /** Left key symbol. */
+    static { this.leftSymbol = "\u2bc7"; }
+    /** Right key symbol. */
+    static { this.rightSymbol = "\u2bc8"; }
+    /** Keyboard info for Arrow keys. */
+    static { this.arrowKeyboardInfo = {
+        keys: [ToolAssistance.upSymbol],
+        bottomKeys: [ToolAssistance.leftSymbol, ToolAssistance.downSymbol, ToolAssistance.rightSymbol],
+    }; }
     static translateKey(key) { return IModelApp_1.IModelApp.localization.getLocalizedString(`${Tool_1.CoreTools.namespace}:toolAssistance.${key}`); }
     static translateTouch(cursor) { return IModelApp_1.IModelApp.localization.getLocalizedString(`${Tool_1.CoreTools.namespace}:touchCursor.${cursor}`); }
     /** Return the translated string for the specified main instruction key */
@@ -103,6 +116,8 @@ class ToolAssistance {
     static get ctrlKeyboardInfo() {
         return { keys: [ToolAssistance.ctrlKey] };
     }
+    /** Shift key symbol. */
+    static { this.shiftSymbol = "\u21e7"; }
     /** Keyboard info for Shift key with symbol. */
     static get shiftKeyboardInfo() {
         return { keys: [`${ToolAssistance.shiftSymbol} ${ToolAssistance.shiftKey}`] };
@@ -115,10 +130,14 @@ class ToolAssistance {
     static get shiftSymbolKeyboardInfo() {
         return { keys: [` ${ToolAssistance.shiftKey} `] };
     }
+    /** Ctrl key symbol. */
+    static { this.ctrlSymbol = "\u2038"; }
     /** Keyboard info for Ctrl key symbol. */
     static get ctrlSymbolKeyboardInfo() {
         return { keys: [ToolAssistance.ctrlSymbol] };
     }
+    /** Alt key symbol. */
+    static { this.altSymbol = "\u2387"; }
     /** Keyboard info for Alt key symbol. */
     static get altSymbolKeyboardInfo() {
         return { keys: [ToolAssistance.altSymbol] };
@@ -210,23 +229,4 @@ class ToolAssistance {
     }
 }
 exports.ToolAssistance = ToolAssistance;
-/** Up key symbol. */
-ToolAssistance.upSymbol = "\u2bc5";
-/** Down key symbol. */
-ToolAssistance.downSymbol = "\u2bc6";
-/** Left key symbol. */
-ToolAssistance.leftSymbol = "\u2bc7";
-/** Right key symbol. */
-ToolAssistance.rightSymbol = "\u2bc8";
-/** Keyboard info for Arrow keys. */
-ToolAssistance.arrowKeyboardInfo = {
-    keys: [ToolAssistance.upSymbol],
-    bottomKeys: [ToolAssistance.leftSymbol, ToolAssistance.downSymbol, ToolAssistance.rightSymbol],
-};
-/** Shift key symbol. */
-ToolAssistance.shiftSymbol = "\u21e7";
-/** Ctrl key symbol. */
-ToolAssistance.ctrlSymbol = "\u2038";
-/** Alt key symbol. */
-ToolAssistance.altSymbol = "\u2387";
 //# sourceMappingURL=ToolAssistance.js.map

package/lib/cjs/tools/ToolAssistance.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolAssistance.js","sourceRoot":"","sources":["../../../src/tools/ToolAssistance.ts"],"names":[],"mappings":";AACA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,4CAAyC;AACzC,iCAAmC;AAEnC;;;GAGG;AACH,IAAY,mBAmCX;AAnCD,WAAY,mBAAmB;IAC7B,wFAAwF;IACxF,qEAAQ,CAAA;IACR,gBAAgB;IAChB,2EAAW,CAAA;IACX,qCAAqC;IACrC,2EAAW,CAAA;IACX,4CAA4C;IAC5C,uEAAS,CAAA;IACT,6CAA6C;IAC7C,yEAAU,CAAA;IACV,6CAA6C;IAC7C,yEAAU,CAAA;IACV,kEAAkE;IAClE,+EAAa,CAAA;IACb,mEAAmE;IACnE,iFAAc,CAAA;IACd,mEAAmE;IACnE,2FAAmB,CAAA;IACnB,kDAAkD;IAClD,2EAAW,CAAA;IACX,mDAAmD;IACnD,wFAAiB,CAAA;IACjB,8CAA8C;IAC9C,8EAAY,CAAA;IACZ,gDAAgD;IAChD,4EAAW,CAAA;IACX,4CAA4C;IAC5C,8EAAY,CAAA;IACZ,4CAA4C;IAC5C,gFAAa,CAAA;IACb,yDAAyD;IACzD,kFAAc,CAAA;IACd,qDAAqD;IACrD,oFAAe,CAAA;AACjB,CAAC,EAnCW,mBAAmB,mCAAnB,mBAAmB,QAmC9B;AAED;;;GAGG;AACH,IAAY,yBAOX;AAPD,WAAY,yBAAyB;IACnC,8DAA8D;IAC9D,yEAAI,CAAA;IACJ,qDAAqD;IACrD,2EAAK,CAAA;IACL,qDAAqD;IACrD,2EAAK,CAAA;AACP,CAAC,EAPW,yBAAyB,yCAAzB,yBAAyB,QAOpC;AAsED;;;GAGG;AACH,MAAa,cAAc;IAiBjB,MAAM,CAAC,YAAY,CAAC,GAAW,IAAI,OAAO,qBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,gBAAS,CAAC,SAAS,mBAAmB,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACtI,MAAM,CAAC,cAAc,CAAC,MAAc,IAAI,OAAO,qBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,gBAAS,CAAC,SAAS,gBAAgB,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAEnJ,0EAA0E;IACnE,MAAM,CAAC,eAAe,CAAC,GAA4B;QACxD,OAAO,qBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,gBAAS,CAAC,KAAK,sBAAsB,GAAG,EAAE,CAAC,CAAC;IAClG,CAAC;IAED,2EAA2E;IACpE,MAAM,CAAC,cAAc,CAAC,GAA2B;QACtD,OAAO,qBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,gBAAS,CAAC,KAAK,qBAAqB,GAAG,EAAE,CAAC,CAAC;IACjG,CAAC;IAED,oBAAoB;IACb,MAAM,KAAK,MAAM;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,qBAAqB;IACd,MAAM,KAAK,OAAO;QACvB,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,sBAAsB;IACf,MAAM,KAAK,QAAQ;QACxB,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;IAED,mBAAmB;IACZ,MAAM,KAAK,WAAW;QAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,iCAAiC;IAC1B,MAAM,KAAK,eAAe;QAC/B,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;IAC3C,CAAC;IAED,kCAAkC;IAC3B,MAAM,KAAK,gBAAgB;QAChC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5C,CAAC;IAKD,+CAA+C;IACxC,MAAM,KAAK,iBAAiB;QACjC,OAAO,EAAE,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC,WAAW,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;IAChF,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,yBAAyB;QACzC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC7C,CAAC;IAED,0CAA0C;IACnC,MAAM,KAAK,uBAAuB;QACvC,OAAO,EAAE,IAAI,EAAE,CAAC,IAAI,cAAc,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;IACpD,CAAC;IAKD,yCAAyC;IAClC,MAAM,KAAK,sBAAsB;QACtC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;IAC/C,CAAC;IAKD,wCAAwC;IACjC,MAAM,KAAK,qBAAqB;QACrC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;IAC9C,CAAC;IAED;OACG;IACI,MAAM,CAAC,iBAAiB,CAAC,KAAmC,EAAE,IAAY,EAAE,KAAe,EAAE,WAAuC,EAAE,YAAyC;QACpL,IAAI,WAAW,KAAK,SAAS;YAC3B,WAAW,GAAG,yBAAyB,CAAC,IAAI,CAAC;QAE/C,MAAM,WAAW,GAA8B;YAC7C,KAAK;YACL,IAAI;YACJ,YAAY;YACZ,KAAK;YACL,WAAW;SACZ,CAAC;QACF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;OACG;IACI,MAAM,CAAC,yBAAyB,CAAC,YAAwC,EAAE,IAAY,EAAE,KAAe,EAAE,WAAuC;QACtJ,IAAI,WAAW,KAAK,SAAS;YAC3B,WAAW,GAAG,yBAAyB,CAAC,KAAK,CAAC;QAEhD,MAAM,WAAW,GAA8B;YAC7C,KAAK,EAAE,mBAAmB,CAAC,QAAQ;YACnC,IAAI;YACJ,YAAY;YACZ,KAAK;YACL,WAAW;SACZ,CAAC;QACF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;OACG;IACI,MAAM,CAAC,4BAA4B,CAAC,WAAmB,EAAE,KAAmC,EAAE,IAAY,EAAE,KAAe,EAAE,WAAuC;QACzK,IAAI,WAAW,KAAK,SAAS;YAC3B,WAAW,GAAG,yBAAyB,CAAC,IAAI,CAAC;QAE/C,MAAM,YAAY,GAAG,EAAE,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC;QAE7C,MAAM,WAAW,GAA8B;YAC7C,KAAK;YACL,IAAI;YACJ,YAAY;YACZ,KAAK;YACL,WAAW;SACZ,CAAC;QAEF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;OACG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAc,EAAE,UAAqB;QACpE,MAAM,YAAY,GAA+B;YAC/C,IAAI;YACJ,UAAU;SACX,CAAC;QACF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;OACG;IACI,MAAM,CAAC,6BAA6B,CAAC,YAAyC;QACnF,MAAM,QAAQ,GAAG,qBAAS,CAAC,QAAQ,CAAC;QACpC,IAAI,SAAS,KAAK,QAAQ,CAAC,WAAW,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;YACrE,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9J,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,IAAI,SAAS,KAAK,QAAQ,CAAC,WAAW,EAAE,CAAC;YAC9C,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,eAAe,EAAE,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC;YACvK,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC;YACpK,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;OACG;IACI,MAAM,CAAC,aAAa,CAAC,YAAyC,EAAE,KAAc;QACnF,MAAM,OAAO,GAA0B;YACrC,YAAY;YACZ,KAAK;SACN,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;OACG;IACI,MAAM,CAAC,kBAAkB,CAAC,eAA0C,EAAE,QAAkC;QAC7G,MAAM,YAAY,GAA+B;YAC/C,eAAe;YACf,QAAQ;SACT,CAAC;QACF,OAAO,YAAY,CAAC;IACtB,CAAC;;AA5LH,wCA6LC;AA3LC,qBAAqB;AACE,uBAAQ,GAAW,QAAQ,CAAC;AACnD,uBAAuB;AACA,yBAAU,GAAW,QAAQ,CAAC;AACrD,uBAAuB;AACA,yBAAU,GAAW,QAAQ,CAAC;AACrD,wBAAwB;AACD,0BAAW,GAAW,QAAQ,CAAC;AAEtD,oCAAoC;AACb,gCAAiB,GAA+B;IACrE,IAAI,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC;IAC/B,UAAU,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,cAAc,CAAC,UAAU,EAAE,cAAc,CAAC,WAAW,CAAC;CAC/F,CAAC;AA6CF,wBAAwB;AACD,0BAAW,GAAW,QAAQ,CAAC;AAiBtD,uBAAuB;AACA,yBAAU,GAAW,QAAQ,CAAC;AAOrD,sBAAsB;AACC,wBAAS,GAAW,QAAQ,CAAC","sourcesContent":["\n/*---------------------------------------------------------------------------------------------\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 Tools\n */\n\nimport { IModelApp } from \"../IModelApp\";\nimport { CoreTools } from \"./Tool\";\n\n/** Tool Assistance known images\n * @public\n * @extensions\n */\nexport enum ToolAssistanceImage {\n  /** When Keyboard is specified, ToolAssistanceInstruction.keyboardInfo should be set. */\n  Keyboard,\n  /** Plus sign */\n  AcceptPoint,\n  /** Cursor image with click symbol */\n  CursorClick,\n  /** Mouse image with darkened left button */\n  LeftClick,\n  /** Mouse image with darkened right button */\n  RightClick,\n  /** Mouse image with darkened scroll wheel */\n  MouseWheel,\n  /** Mouse image with darkened left button and left/right arrows */\n  LeftClickDrag,\n  /** Mouse image with darkened right button and left/right arrows */\n  RightClickDrag,\n  /** Mouse image with darkened scroll wheel and left/right arrows */\n  MouseWheelClickDrag,\n  /** Touch image with single finger tapping once */\n  OneTouchTap,\n  /** Touch image with single finger tapping twice */\n  OneTouchDoubleTap,\n  /** Touch image with single finger dragging */\n  OneTouchDrag,\n  /** Touch image with two fingers tapping once */\n  TwoTouchTap,\n  /** Touch image with two fingers dragging */\n  TwoTouchDrag,\n  /** Touch image with two fingers pinching */\n  TwoTouchPinch,\n  /** Touch cursor image with single finger tapping once */\n  TouchCursorTap,\n  /** Touch cursor image with single finger dragging */\n  TouchCursorDrag,\n}\n\n/** Input Method for Tool Assistance instruction\n * @public\n * @extensions\n */\nexport enum ToolAssistanceInputMethod {\n  /** Instruction applies to both touch & mouse input methods */\n  Both,\n  /** Instruction applies to only mouse input method */\n  Mouse,\n  /** Instruction applies to only touch input method */\n  Touch,\n}\n\n/** Identifies one of a set of commonly-used [[ToolAssistance]] messages prompting the user to specify\n * an element or location for a tool operation.\n * @see [[ToolAssistance.translatePrompt]] to obtain a corresponding localized message appropriate for displaying to the user.\n * @public\n * @extensions\n */\nexport type ToolAssistancePromptKey = \"IdentifyElement\" | \"IdentifyPoint\" | \"StartPoint\" | \"EndPoint\";\n\n/** Identifies one of a set of commonly-used [[ToolAssistance]] messages notifying the user of the result of\n * the next input.\n * @see [[ToolAssistance.translateInput]] to obtain a corresponding localizaed message appropriate for displaying to the user.\n * @public\n * @extensions\n */\nexport type ToolAssistanceInputKey = \"AcceptSelection\" | \"AcceptElement\" | \"AcceptPoint\" | \"AdditionalElement\" | \"AdditionalPoint\" | \"Accept\" | \"Complete\" | \"Cancel\" | \"Restart\" | \"Exit\";\n\n/** Tool Assistance image keyboard keys\n * @public\n * @extensions\n */\nexport interface ToolAssistanceKeyboardInfo {\n  /** Text for keys to display */\n  keys: string[];\n  /** If two rows of keys should be displayed, text for the bottom row of keys */\n  bottomKeys?: string[];\n}\n\n/** Interface used to describe a Tool Assistance instruction.\n * @public\n * @extensions\n */\nexport interface ToolAssistanceInstruction {\n  /** Name of icon WebFont entry, or if specifying an SVG symbol, use \"svg:\" prefix to imported symbol Id.\n   *  ToolAssistanceImage enum also supported. If ToolAssistanceImage.Keyboard specified, also provide keyboardInfo.\n   */\n  image: string | ToolAssistanceImage;\n  /** Text for the instruction. */\n  text: string;\n  /** When ToolAssistanceImage.Keyboard is specified for image, information about the Keyboard keys in the image. */\n  keyboardInfo?: ToolAssistanceKeyboardInfo;\n  /** Indicates whether this instruction is new. Defaults to false. */\n  isNew?: boolean;\n  /** Input Method to which the instruction applies */\n  inputMethod?: ToolAssistanceInputMethod;\n}\n\n/** Interface used to describe a Tool Assistance section with a label and a set of instructions.\n * @public\n * @extensions\n */\nexport interface ToolAssistanceSection {\n  /** Instructions in the section. */\n  instructions: ToolAssistanceInstruction[];\n  /** Label for the section. */\n  label?: string;\n}\n\n/** Interface used to describe Tool Assistance for a tool's state.\n * @public\n * @extensions\n */\nexport interface ToolAssistanceInstructions {\n  /** The main instruction. */\n  mainInstruction: ToolAssistanceInstruction;\n  /** Sections of instructions. */\n  sections?: ToolAssistanceSection[];\n}\n\n/** Tool Assistance helper methods.\n * @public\n * @extensions\n */\nexport class ToolAssistance {\n\n  /** Up key symbol. */\n  public static readonly upSymbol: string = \"\\u2bc5\";\n  /** Down key symbol. */\n  public static readonly downSymbol: string = \"\\u2bc6\";\n  /** Left key symbol. */\n  public static readonly leftSymbol: string = \"\\u2bc7\";\n  /** Right key symbol. */\n  public static readonly rightSymbol: string = \"\\u2bc8\";\n\n  /** Keyboard info for Arrow keys. */\n  public static readonly arrowKeyboardInfo: ToolAssistanceKeyboardInfo = {\n    keys: [ToolAssistance.upSymbol],\n    bottomKeys: [ToolAssistance.leftSymbol, ToolAssistance.downSymbol, ToolAssistance.rightSymbol],\n  };\n\n  private static translateKey(key: string) { return IModelApp.localization.getLocalizedString(`${CoreTools.namespace}:toolAssistance.${key}`); }\n  private static translateTouch(cursor: string) { return IModelApp.localization.getLocalizedString(`${CoreTools.namespace}:touchCursor.${cursor}`); }\n\n  /** Return the translated string for the specified main instruction key */\n  public static translatePrompt(key: ToolAssistancePromptKey): string {\n    return IModelApp.localization.getLocalizedString(`${CoreTools.tools}ElementSet.Prompts.${key}`);\n  }\n\n  /** Return the translated string for the specified input instruction key */\n  public static translateInput(key: ToolAssistanceInputKey): string {\n    return IModelApp.localization.getLocalizedString(`${CoreTools.tools}ElementSet.Inputs.${key}`);\n  }\n\n  /** Alt key text. */\n  public static get altKey(): string {\n    return this.translateKey(\"altKey\");\n  }\n\n  /** Ctrl key text. */\n  public static get ctrlKey(): string {\n    return this.translateKey(\"ctrlKey\");\n  }\n\n  /** Shift key text. */\n  public static get shiftKey(): string {\n    return this.translateKey(\"shiftKey\");\n  }\n\n  /** Inputs text. */\n  public static get inputsLabel(): string {\n    return this.translateKey(\"inputs\");\n  }\n\n  /** Keyboard info for Alt key. */\n  public static get altKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.altKey] };\n  }\n\n  /** Keyboard info for Ctrl key. */\n  public static get ctrlKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.ctrlKey] };\n  }\n\n  /** Shift key symbol. */\n  public static readonly shiftSymbol: string = \"\\u21e7\";\n\n  /** Keyboard info for Shift key with symbol. */\n  public static get shiftKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [`${ToolAssistance.shiftSymbol} ${ToolAssistance.shiftKey}`] };\n  }\n\n  /** Keyboard info for Shift key without symbol. */\n  public static get shiftKeyboardInfoNoSymbol(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.shiftKey] };\n  }\n\n  /** Keyboard info for Shift key symbol. */\n  public static get shiftSymbolKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [` ${ToolAssistance.shiftKey} `] };\n  }\n\n  /** Ctrl key symbol. */\n  public static readonly ctrlSymbol: string = \"\\u2038\";\n\n  /** Keyboard info for Ctrl key symbol. */\n  public static get ctrlSymbolKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.ctrlSymbol] };\n  }\n\n  /** Alt key symbol. */\n  public static readonly altSymbol: string = \"\\u2387\";\n\n  /** Keyboard info for Alt key symbol. */\n  public static get altSymbolKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.altSymbol] };\n  }\n\n  /** Creates a [[ToolAssistanceInstruction]].\n   */\n  public static createInstruction(image: string | ToolAssistanceImage, text: string, isNew?: boolean, inputMethod?: ToolAssistanceInputMethod, keyboardInfo?: ToolAssistanceKeyboardInfo): ToolAssistanceInstruction {\n    if (inputMethod === undefined)\n      inputMethod = ToolAssistanceInputMethod.Both;\n\n    const instruction: ToolAssistanceInstruction = {\n      image,\n      text,\n      keyboardInfo,\n      isNew,\n      inputMethod,\n    };\n    return instruction;\n  }\n\n  /** Creates a [[ToolAssistanceInstruction]] with a [[ToolAssistanceKeyboardInfo]].\n   */\n  public static createKeyboardInstruction(keyboardInfo: ToolAssistanceKeyboardInfo, text: string, isNew?: boolean, inputMethod?: ToolAssistanceInputMethod): ToolAssistanceInstruction {\n    if (inputMethod === undefined)\n      inputMethod = ToolAssistanceInputMethod.Mouse;\n\n    const instruction: ToolAssistanceInstruction = {\n      image: ToolAssistanceImage.Keyboard,\n      text,\n      keyboardInfo,\n      isNew,\n      inputMethod,\n    };\n    return instruction;\n  }\n\n  /** Creates a [[ToolAssistanceInstruction]] with a modifier key and an image.\n   */\n  public static createModifierKeyInstruction(modifierKey: string, image: string | ToolAssistanceImage, text: string, isNew?: boolean, inputMethod?: ToolAssistanceInputMethod): ToolAssistanceInstruction {\n    if (inputMethod === undefined)\n      inputMethod = ToolAssistanceInputMethod.Both;\n\n    const keyboardInfo = { keys: [modifierKey] };\n\n    const instruction: ToolAssistanceInstruction = {\n      image,\n      text,\n      keyboardInfo,\n      isNew,\n      inputMethod,\n    };\n\n    return instruction;\n  }\n\n  /** Creates a [[ToolAssistanceKeyboardInfo]].\n   */\n  public static createKeyboardInfo(keys: string[], bottomKeys?: string[]): ToolAssistanceKeyboardInfo {\n    const keyboardInfo: ToolAssistanceKeyboardInfo = {\n      keys,\n      bottomKeys,\n    };\n    return keyboardInfo;\n  }\n\n  /** Creates instructions for interaction with the touch cursor that are appended to the supplied [[ToolAssistanceInstruction]] array.\n   */\n  public static createTouchCursorInstructions(instructions: ToolAssistanceInstruction[]): boolean {\n    const accuSnap = IModelApp.accuSnap;\n    if (undefined === accuSnap.touchCursor && accuSnap.wantVirtualCursor) {\n      instructions.push(ToolAssistance.createInstruction(ToolAssistanceImage.OneTouchTap, this.translateTouch(\"Activate\"), false, ToolAssistanceInputMethod.Touch));\n      return true;\n    } else if (undefined !== accuSnap.touchCursor) {\n      instructions.push(ToolAssistance.createInstruction(ToolAssistanceImage.TouchCursorDrag, this.translateTouch(\"IdentifyPoint\"), false, ToolAssistanceInputMethod.Touch));\n      instructions.push(ToolAssistance.createInstruction(ToolAssistanceImage.TouchCursorTap, this.translateTouch(\"AcceptPoint\"), false, ToolAssistanceInputMethod.Touch));\n      return true;\n    }\n    return false;\n  }\n\n  /** Creates a [[ToolAssistanceSection]].\n   */\n  public static createSection(instructions: ToolAssistanceInstruction[], label?: string): ToolAssistanceSection {\n    const section: ToolAssistanceSection = {\n      instructions,\n      label,\n    };\n    return section;\n  }\n\n  /** Creates a [[ToolAssistanceInstructions]].\n   */\n  public static createInstructions(mainInstruction: ToolAssistanceInstruction, sections?: ToolAssistanceSection[]): ToolAssistanceInstructions {\n    const instructions: ToolAssistanceInstructions = {\n      mainInstruction,\n      sections,\n    };\n    return instructions;\n  }\n}\n"]}
+{"version":3,"file":"ToolAssistance.js","sourceRoot":"","sources":["../../../src/tools/ToolAssistance.ts"],"names":[],"mappings":";AACA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,4CAAyC;AACzC,iCAAmC;AAEnC;;;GAGG;AACH,IAAY,mBAmCX;AAnCD,WAAY,mBAAmB;IAC7B,wFAAwF;IACxF,qEAAQ,CAAA;IACR,gBAAgB;IAChB,2EAAW,CAAA;IACX,qCAAqC;IACrC,2EAAW,CAAA;IACX,4CAA4C;IAC5C,uEAAS,CAAA;IACT,6CAA6C;IAC7C,yEAAU,CAAA;IACV,6CAA6C;IAC7C,yEAAU,CAAA;IACV,kEAAkE;IAClE,+EAAa,CAAA;IACb,mEAAmE;IACnE,iFAAc,CAAA;IACd,mEAAmE;IACnE,2FAAmB,CAAA;IACnB,kDAAkD;IAClD,2EAAW,CAAA;IACX,mDAAmD;IACnD,wFAAiB,CAAA;IACjB,8CAA8C;IAC9C,8EAAY,CAAA;IACZ,gDAAgD;IAChD,4EAAW,CAAA;IACX,4CAA4C;IAC5C,8EAAY,CAAA;IACZ,4CAA4C;IAC5C,gFAAa,CAAA;IACb,yDAAyD;IACzD,kFAAc,CAAA;IACd,qDAAqD;IACrD,oFAAe,CAAA;AACjB,CAAC,EAnCW,mBAAmB,mCAAnB,mBAAmB,QAmC9B;AAED;;;GAGG;AACH,IAAY,yBAOX;AAPD,WAAY,yBAAyB;IACnC,8DAA8D;IAC9D,yEAAI,CAAA;IACJ,qDAAqD;IACrD,2EAAK,CAAA;IACL,qDAAqD;IACrD,2EAAK,CAAA;AACP,CAAC,EAPW,yBAAyB,yCAAzB,yBAAyB,QAOpC;AAsED;;;GAGG;AACH,MAAa,cAAc;IAEzB,qBAAqB;aACE,aAAQ,GAAW,QAAQ,CAAC;IACnD,uBAAuB;aACA,eAAU,GAAW,QAAQ,CAAC;IACrD,uBAAuB;aACA,eAAU,GAAW,QAAQ,CAAC;IACrD,wBAAwB;aACD,gBAAW,GAAW,QAAQ,CAAC;IAEtD,oCAAoC;aACb,sBAAiB,GAA+B;QACrE,IAAI,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC;QAC/B,UAAU,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,cAAc,CAAC,UAAU,EAAE,cAAc,CAAC,WAAW,CAAC;KAC/F,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,GAAW,IAAI,OAAO,qBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,gBAAS,CAAC,SAAS,mBAAmB,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACtI,MAAM,CAAC,cAAc,CAAC,MAAc,IAAI,OAAO,qBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,gBAAS,CAAC,SAAS,gBAAgB,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAEnJ,0EAA0E;IACnE,MAAM,CAAC,eAAe,CAAC,GAA4B;QACxD,OAAO,qBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,gBAAS,CAAC,KAAK,sBAAsB,GAAG,EAAE,CAAC,CAAC;IAClG,CAAC;IAED,2EAA2E;IACpE,MAAM,CAAC,cAAc,CAAC,GAA2B;QACtD,OAAO,qBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,gBAAS,CAAC,KAAK,qBAAqB,GAAG,EAAE,CAAC,CAAC;IACjG,CAAC;IAED,oBAAoB;IACb,MAAM,KAAK,MAAM;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,qBAAqB;IACd,MAAM,KAAK,OAAO;QACvB,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,sBAAsB;IACf,MAAM,KAAK,QAAQ;QACxB,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;IAED,mBAAmB;IACZ,MAAM,KAAK,WAAW;QAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,iCAAiC;IAC1B,MAAM,KAAK,eAAe;QAC/B,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;IAC3C,CAAC;IAED,kCAAkC;IAC3B,MAAM,KAAK,gBAAgB;QAChC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5C,CAAC;IAED,wBAAwB;aACD,gBAAW,GAAW,QAAQ,CAAC;IAEtD,+CAA+C;IACxC,MAAM,KAAK,iBAAiB;QACjC,OAAO,EAAE,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC,WAAW,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;IAChF,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,yBAAyB;QACzC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC7C,CAAC;IAED,0CAA0C;IACnC,MAAM,KAAK,uBAAuB;QACvC,OAAO,EAAE,IAAI,EAAE,CAAC,IAAI,cAAc,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;IACpD,CAAC;IAED,uBAAuB;aACA,eAAU,GAAW,QAAQ,CAAC;IAErD,yCAAyC;IAClC,MAAM,KAAK,sBAAsB;QACtC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;IAC/C,CAAC;IAED,sBAAsB;aACC,cAAS,GAAW,QAAQ,CAAC;IAEpD,wCAAwC;IACjC,MAAM,KAAK,qBAAqB;QACrC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;IAC9C,CAAC;IAED;OACG;IACI,MAAM,CAAC,iBAAiB,CAAC,KAAmC,EAAE,IAAY,EAAE,KAAe,EAAE,WAAuC,EAAE,YAAyC;QACpL,IAAI,WAAW,KAAK,SAAS;YAC3B,WAAW,GAAG,yBAAyB,CAAC,IAAI,CAAC;QAE/C,MAAM,WAAW,GAA8B;YAC7C,KAAK;YACL,IAAI;YACJ,YAAY;YACZ,KAAK;YACL,WAAW;SACZ,CAAC;QACF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;OACG;IACI,MAAM,CAAC,yBAAyB,CAAC,YAAwC,EAAE,IAAY,EAAE,KAAe,EAAE,WAAuC;QACtJ,IAAI,WAAW,KAAK,SAAS;YAC3B,WAAW,GAAG,yBAAyB,CAAC,KAAK,CAAC;QAEhD,MAAM,WAAW,GAA8B;YAC7C,KAAK,EAAE,mBAAmB,CAAC,QAAQ;YACnC,IAAI;YACJ,YAAY;YACZ,KAAK;YACL,WAAW;SACZ,CAAC;QACF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;OACG;IACI,MAAM,CAAC,4BAA4B,CAAC,WAAmB,EAAE,KAAmC,EAAE,IAAY,EAAE,KAAe,EAAE,WAAuC;QACzK,IAAI,WAAW,KAAK,SAAS;YAC3B,WAAW,GAAG,yBAAyB,CAAC,IAAI,CAAC;QAE/C,MAAM,YAAY,GAAG,EAAE,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC;QAE7C,MAAM,WAAW,GAA8B;YAC7C,KAAK;YACL,IAAI;YACJ,YAAY;YACZ,KAAK;YACL,WAAW;SACZ,CAAC;QAEF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;OACG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAc,EAAE,UAAqB;QACpE,MAAM,YAAY,GAA+B;YAC/C,IAAI;YACJ,UAAU;SACX,CAAC;QACF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;OACG;IACI,MAAM,CAAC,6BAA6B,CAAC,YAAyC;QACnF,MAAM,QAAQ,GAAG,qBAAS,CAAC,QAAQ,CAAC;QACpC,IAAI,SAAS,KAAK,QAAQ,CAAC,WAAW,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;YACrE,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9J,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,IAAI,SAAS,KAAK,QAAQ,CAAC,WAAW,EAAE,CAAC;YAC9C,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,eAAe,EAAE,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC;YACvK,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC;YACpK,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;OACG;IACI,MAAM,CAAC,aAAa,CAAC,YAAyC,EAAE,KAAc;QACnF,MAAM,OAAO,GAA0B;YACrC,YAAY;YACZ,KAAK;SACN,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;OACG;IACI,MAAM,CAAC,kBAAkB,CAAC,eAA0C,EAAE,QAAkC;QAC7G,MAAM,YAAY,GAA+B;YAC/C,eAAe;YACf,QAAQ;SACT,CAAC;QACF,OAAO,YAAY,CAAC;IACtB,CAAC;;AA5LH,wCA6LC","sourcesContent":["\n/*---------------------------------------------------------------------------------------------\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 Tools\n */\n\nimport { IModelApp } from \"../IModelApp\";\nimport { CoreTools } from \"./Tool\";\n\n/** Tool Assistance known images\n * @public\n * @extensions\n */\nexport enum ToolAssistanceImage {\n  /** When Keyboard is specified, ToolAssistanceInstruction.keyboardInfo should be set. */\n  Keyboard,\n  /** Plus sign */\n  AcceptPoint,\n  /** Cursor image with click symbol */\n  CursorClick,\n  /** Mouse image with darkened left button */\n  LeftClick,\n  /** Mouse image with darkened right button */\n  RightClick,\n  /** Mouse image with darkened scroll wheel */\n  MouseWheel,\n  /** Mouse image with darkened left button and left/right arrows */\n  LeftClickDrag,\n  /** Mouse image with darkened right button and left/right arrows */\n  RightClickDrag,\n  /** Mouse image with darkened scroll wheel and left/right arrows */\n  MouseWheelClickDrag,\n  /** Touch image with single finger tapping once */\n  OneTouchTap,\n  /** Touch image with single finger tapping twice */\n  OneTouchDoubleTap,\n  /** Touch image with single finger dragging */\n  OneTouchDrag,\n  /** Touch image with two fingers tapping once */\n  TwoTouchTap,\n  /** Touch image with two fingers dragging */\n  TwoTouchDrag,\n  /** Touch image with two fingers pinching */\n  TwoTouchPinch,\n  /** Touch cursor image with single finger tapping once */\n  TouchCursorTap,\n  /** Touch cursor image with single finger dragging */\n  TouchCursorDrag,\n}\n\n/** Input Method for Tool Assistance instruction\n * @public\n * @extensions\n */\nexport enum ToolAssistanceInputMethod {\n  /** Instruction applies to both touch & mouse input methods */\n  Both,\n  /** Instruction applies to only mouse input method */\n  Mouse,\n  /** Instruction applies to only touch input method */\n  Touch,\n}\n\n/** Identifies one of a set of commonly-used [[ToolAssistance]] messages prompting the user to specify\n * an element or location for a tool operation.\n * @see [[ToolAssistance.translatePrompt]] to obtain a corresponding localized message appropriate for displaying to the user.\n * @public\n * @extensions\n */\nexport type ToolAssistancePromptKey = \"IdentifyElement\" | \"IdentifyPoint\" | \"StartPoint\" | \"EndPoint\";\n\n/** Identifies one of a set of commonly-used [[ToolAssistance]] messages notifying the user of the result of\n * the next input.\n * @see [[ToolAssistance.translateInput]] to obtain a corresponding localizaed message appropriate for displaying to the user.\n * @public\n * @extensions\n */\nexport type ToolAssistanceInputKey = \"AcceptSelection\" | \"AcceptElement\" | \"AcceptPoint\" | \"AdditionalElement\" | \"AdditionalPoint\" | \"Accept\" | \"Complete\" | \"Cancel\" | \"Restart\" | \"Exit\";\n\n/** Tool Assistance image keyboard keys\n * @public\n * @extensions\n */\nexport interface ToolAssistanceKeyboardInfo {\n  /** Text for keys to display */\n  keys: string[];\n  /** If two rows of keys should be displayed, text for the bottom row of keys */\n  bottomKeys?: string[];\n}\n\n/** Interface used to describe a Tool Assistance instruction.\n * @public\n * @extensions\n */\nexport interface ToolAssistanceInstruction {\n  /** Name of icon WebFont entry, or if specifying an SVG symbol, use \"svg:\" prefix to imported symbol Id.\n   *  ToolAssistanceImage enum also supported. If ToolAssistanceImage.Keyboard specified, also provide keyboardInfo.\n   */\n  image: string | ToolAssistanceImage;\n  /** Text for the instruction. */\n  text: string;\n  /** When ToolAssistanceImage.Keyboard is specified for image, information about the Keyboard keys in the image. */\n  keyboardInfo?: ToolAssistanceKeyboardInfo;\n  /** Indicates whether this instruction is new. Defaults to false. */\n  isNew?: boolean;\n  /** Input Method to which the instruction applies */\n  inputMethod?: ToolAssistanceInputMethod;\n}\n\n/** Interface used to describe a Tool Assistance section with a label and a set of instructions.\n * @public\n * @extensions\n */\nexport interface ToolAssistanceSection {\n  /** Instructions in the section. */\n  instructions: ToolAssistanceInstruction[];\n  /** Label for the section. */\n  label?: string;\n}\n\n/** Interface used to describe Tool Assistance for a tool's state.\n * @public\n * @extensions\n */\nexport interface ToolAssistanceInstructions {\n  /** The main instruction. */\n  mainInstruction: ToolAssistanceInstruction;\n  /** Sections of instructions. */\n  sections?: ToolAssistanceSection[];\n}\n\n/** Tool Assistance helper methods.\n * @public\n * @extensions\n */\nexport class ToolAssistance {\n\n  /** Up key symbol. */\n  public static readonly upSymbol: string = \"\\u2bc5\";\n  /** Down key symbol. */\n  public static readonly downSymbol: string = \"\\u2bc6\";\n  /** Left key symbol. */\n  public static readonly leftSymbol: string = \"\\u2bc7\";\n  /** Right key symbol. */\n  public static readonly rightSymbol: string = \"\\u2bc8\";\n\n  /** Keyboard info for Arrow keys. */\n  public static readonly arrowKeyboardInfo: ToolAssistanceKeyboardInfo = {\n    keys: [ToolAssistance.upSymbol],\n    bottomKeys: [ToolAssistance.leftSymbol, ToolAssistance.downSymbol, ToolAssistance.rightSymbol],\n  };\n\n  private static translateKey(key: string) { return IModelApp.localization.getLocalizedString(`${CoreTools.namespace}:toolAssistance.${key}`); }\n  private static translateTouch(cursor: string) { return IModelApp.localization.getLocalizedString(`${CoreTools.namespace}:touchCursor.${cursor}`); }\n\n  /** Return the translated string for the specified main instruction key */\n  public static translatePrompt(key: ToolAssistancePromptKey): string {\n    return IModelApp.localization.getLocalizedString(`${CoreTools.tools}ElementSet.Prompts.${key}`);\n  }\n\n  /** Return the translated string for the specified input instruction key */\n  public static translateInput(key: ToolAssistanceInputKey): string {\n    return IModelApp.localization.getLocalizedString(`${CoreTools.tools}ElementSet.Inputs.${key}`);\n  }\n\n  /** Alt key text. */\n  public static get altKey(): string {\n    return this.translateKey(\"altKey\");\n  }\n\n  /** Ctrl key text. */\n  public static get ctrlKey(): string {\n    return this.translateKey(\"ctrlKey\");\n  }\n\n  /** Shift key text. */\n  public static get shiftKey(): string {\n    return this.translateKey(\"shiftKey\");\n  }\n\n  /** Inputs text. */\n  public static get inputsLabel(): string {\n    return this.translateKey(\"inputs\");\n  }\n\n  /** Keyboard info for Alt key. */\n  public static get altKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.altKey] };\n  }\n\n  /** Keyboard info for Ctrl key. */\n  public static get ctrlKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.ctrlKey] };\n  }\n\n  /** Shift key symbol. */\n  public static readonly shiftSymbol: string = \"\\u21e7\";\n\n  /** Keyboard info for Shift key with symbol. */\n  public static get shiftKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [`${ToolAssistance.shiftSymbol} ${ToolAssistance.shiftKey}`] };\n  }\n\n  /** Keyboard info for Shift key without symbol. */\n  public static get shiftKeyboardInfoNoSymbol(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.shiftKey] };\n  }\n\n  /** Keyboard info for Shift key symbol. */\n  public static get shiftSymbolKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [` ${ToolAssistance.shiftKey} `] };\n  }\n\n  /** Ctrl key symbol. */\n  public static readonly ctrlSymbol: string = \"\\u2038\";\n\n  /** Keyboard info for Ctrl key symbol. */\n  public static get ctrlSymbolKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.ctrlSymbol] };\n  }\n\n  /** Alt key symbol. */\n  public static readonly altSymbol: string = \"\\u2387\";\n\n  /** Keyboard info for Alt key symbol. */\n  public static get altSymbolKeyboardInfo(): ToolAssistanceKeyboardInfo {\n    return { keys: [ToolAssistance.altSymbol] };\n  }\n\n  /** Creates a [[ToolAssistanceInstruction]].\n   */\n  public static createInstruction(image: string | ToolAssistanceImage, text: string, isNew?: boolean, inputMethod?: ToolAssistanceInputMethod, keyboardInfo?: ToolAssistanceKeyboardInfo): ToolAssistanceInstruction {\n    if (inputMethod === undefined)\n      inputMethod = ToolAssistanceInputMethod.Both;\n\n    const instruction: ToolAssistanceInstruction = {\n      image,\n      text,\n      keyboardInfo,\n      isNew,\n      inputMethod,\n    };\n    return instruction;\n  }\n\n  /** Creates a [[ToolAssistanceInstruction]] with a [[ToolAssistanceKeyboardInfo]].\n   */\n  public static createKeyboardInstruction(keyboardInfo: ToolAssistanceKeyboardInfo, text: string, isNew?: boolean, inputMethod?: ToolAssistanceInputMethod): ToolAssistanceInstruction {\n    if (inputMethod === undefined)\n      inputMethod = ToolAssistanceInputMethod.Mouse;\n\n    const instruction: ToolAssistanceInstruction = {\n      image: ToolAssistanceImage.Keyboard,\n      text,\n      keyboardInfo,\n      isNew,\n      inputMethod,\n    };\n    return instruction;\n  }\n\n  /** Creates a [[ToolAssistanceInstruction]] with a modifier key and an image.\n   */\n  public static createModifierKeyInstruction(modifierKey: string, image: string | ToolAssistanceImage, text: string, isNew?: boolean, inputMethod?: ToolAssistanceInputMethod): ToolAssistanceInstruction {\n    if (inputMethod === undefined)\n      inputMethod = ToolAssistanceInputMethod.Both;\n\n    const keyboardInfo = { keys: [modifierKey] };\n\n    const instruction: ToolAssistanceInstruction = {\n      image,\n      text,\n      keyboardInfo,\n      isNew,\n      inputMethod,\n    };\n\n    return instruction;\n  }\n\n  /** Creates a [[ToolAssistanceKeyboardInfo]].\n   */\n  public static createKeyboardInfo(keys: string[], bottomKeys?: string[]): ToolAssistanceKeyboardInfo {\n    const keyboardInfo: ToolAssistanceKeyboardInfo = {\n      keys,\n      bottomKeys,\n    };\n    return keyboardInfo;\n  }\n\n  /** Creates instructions for interaction with the touch cursor that are appended to the supplied [[ToolAssistanceInstruction]] array.\n   */\n  public static createTouchCursorInstructions(instructions: ToolAssistanceInstruction[]): boolean {\n    const accuSnap = IModelApp.accuSnap;\n    if (undefined === accuSnap.touchCursor && accuSnap.wantVirtualCursor) {\n      instructions.push(ToolAssistance.createInstruction(ToolAssistanceImage.OneTouchTap, this.translateTouch(\"Activate\"), false, ToolAssistanceInputMethod.Touch));\n      return true;\n    } else if (undefined !== accuSnap.touchCursor) {\n      instructions.push(ToolAssistance.createInstruction(ToolAssistanceImage.TouchCursorDrag, this.translateTouch(\"IdentifyPoint\"), false, ToolAssistanceInputMethod.Touch));\n      instructions.push(ToolAssistance.createInstruction(ToolAssistanceImage.TouchCursorTap, this.translateTouch(\"AcceptPoint\"), false, ToolAssistanceInputMethod.Touch));\n      return true;\n    }\n    return false;\n  }\n\n  /** Creates a [[ToolAssistanceSection]].\n   */\n  public static createSection(instructions: ToolAssistanceInstruction[], label?: string): ToolAssistanceSection {\n    const section: ToolAssistanceSection = {\n      instructions,\n      label,\n    };\n    return section;\n  }\n\n  /** Creates a [[ToolAssistanceInstructions]].\n   */\n  public static createInstructions(mainInstruction: ToolAssistanceInstruction, sections?: ToolAssistanceSection[]): ToolAssistanceInstructions {\n    const instructions: ToolAssistanceInstructions = {\n      mainInstruction,\n      sections,\n    };\n    return instructions;\n  }\n}\n"]}

package/lib/cjs/tools/ToolSettings.js

@@ -15,69 +15,69 @@ const core_geometry_1 = require("@itwin/core-geometry");
  * @extensions
  */
 class ToolSettings {
+    /** Two tap must be within this period to be a double tap. */
+    static { this.doubleTapTimeout = core_bentley_1.BeDuration.fromMilliseconds(250); }
+    /** Two clicks must be within this period to be a double click. */
+    static { this.doubleClickTimeout = core_bentley_1.BeDuration.fromMilliseconds(500); }
+    /** Number of screen inches of movement allowed between clicks to still qualify as a double-click.  */
+    static { this.doubleClickToleranceInches = 0.05; }
+    /** @beta Use virtual cursor to help with locating elements using touch input. By default it's only enabled for snapping. */
+    static { this.enableVirtualCursorForLocate = false; }
+    /** If true, view rotation tool keeps the up vector (worldZ) aligned with screenY. */
+    static { this.preserveWorldUp = true; }
+    /** Delay with a touch on the surface before a move operation begins. */
+    static { this.touchMoveDelay = core_bentley_1.BeDuration.fromMilliseconds(50); }
+    /** Delay with the mouse down before a drag operation begins. */
+    static { this.startDragDelay = core_bentley_1.BeDuration.fromMilliseconds(110); }
+    /** Distance in screen inches a touch point must move before being considered motion. */
+    static { this.touchMoveDistanceInches = 0.1; }
+    /** Distance in screen inches the cursor must move before a drag operation begins. */
+    static { this.startDragDistanceInches = 0.15; }
+    /** Distance in screen inches touch points must move apart to be considered a change in zoom scale. */
+    static { this.touchZoomChangeThresholdInches = 0.20; }
+    /** Radius in screen inches to search for elements that anchor viewing operations. */
+    static { this.viewToolPickRadiusInches = 0.20; }
+    /** Camera angle enforced for walk tool. */
+    static { this.walkCameraAngle = core_geometry_1.Angle.createDegrees(75.6); }
+    /** Whether the walk tool enforces worldZ be aligned with screenY */
+    static { this.walkEnforceZUp = false; }
+    /** Speed, in meters per second, for the walk tool. */
+    static { this.walkVelocity = 3.5; }
+    /** @beta Integer increment used to compute a walkVelocity multiplier for the look and move tool, capped at 10x */
+    static { this.walkVelocityChange = 0; }
+    /** Whether the walk tool requests pointer lock to hide the cursor for mouse look */
+    static { this.walkRequestPointerLock = true; }
+    /** @beta Whether the look and move tool detects collisions while moving forward */
+    static { this.walkCollisions = false; }
+    /** @beta Whether the look and move tool adjusts the camera height for stairs/ramps when collisions are enabled */
+    static { this.walkDetectFloor = false; }
+    /** @beta Maximum step height in meters above floor/ground to use when floor detection is enabled */
+    static { this.walkStepHeight = 0.3; }
+    /** @beta Camera height in meters above floor/ground to use for set up walk tool */
+    static { this.walkEyeHeight = 1.6; }
+    /** Scale factor applied for wheel events with "per-line" modifier. */
+    static { this.wheelLineFactor = 40; }
+    /** Scale factor applied for wheel events with "per-page" modifier. */
+    static { this.wheelPageFactor = 120; }
+    /** When the zoom-with-wheel tool (with camera enabled) gets closer than this distance to an obstacle, it "bumps" through. */
+    static { this.wheelZoomBumpDistance = core_geometry_1.Constant.oneCentimeter; }
+    /** the speed to scroll for the "scroll view" tool (distance per second). */
+    static { this.scrollSpeed = .75; }
+    /** the speed to zoom for the "zoom view" tool. */
+    static { this.zoomSpeed = 10; }
+    /** Scale factor for zooming with mouse wheel. */
+    static { this.wheelZoomRatio = 1.5; }
+    /** Parameters for viewing operations with *inertia* (i.e. they continue briefly if used with a throwing action) */
+    static { this.viewingInertia = {
+        /** Flag to enable inertia. */
+        enabled: true,
+        /** How quickly the inertia decays. The smaller the damping value the faster the inertia decays. Must be less than 1.0 */
+        damping: .96,
+        /** Maximum duration of the inertia operation. Important when frame rates are low. */
+        duration: core_bentley_1.BeDuration.fromMilliseconds(500),
+    }; }
+    /** Maximum number of times in a second the accuSnap tool's onMotion function is called. */
+    static { this.maxOnMotionSnapCallPerSecond = 15; }
 }
 exports.ToolSettings = ToolSettings;
-/** Two tap must be within this period to be a double tap. */
-ToolSettings.doubleTapTimeout = core_bentley_1.BeDuration.fromMilliseconds(250);
-/** Two clicks must be within this period to be a double click. */
-ToolSettings.doubleClickTimeout = core_bentley_1.BeDuration.fromMilliseconds(500);
-/** Number of screen inches of movement allowed between clicks to still qualify as a double-click.  */
-ToolSettings.doubleClickToleranceInches = 0.05;
-/** @beta Use virtual cursor to help with locating elements using touch input. By default it's only enabled for snapping. */
-ToolSettings.enableVirtualCursorForLocate = false;
-/** If true, view rotation tool keeps the up vector (worldZ) aligned with screenY. */
-ToolSettings.preserveWorldUp = true;
-/** Delay with a touch on the surface before a move operation begins. */
-ToolSettings.touchMoveDelay = core_bentley_1.BeDuration.fromMilliseconds(50);
-/** Delay with the mouse down before a drag operation begins. */
-ToolSettings.startDragDelay = core_bentley_1.BeDuration.fromMilliseconds(110);
-/** Distance in screen inches a touch point must move before being considered motion. */
-ToolSettings.touchMoveDistanceInches = 0.1;
-/** Distance in screen inches the cursor must move before a drag operation begins. */
-ToolSettings.startDragDistanceInches = 0.15;
-/** Distance in screen inches touch points must move apart to be considered a change in zoom scale. */
-ToolSettings.touchZoomChangeThresholdInches = 0.20;
-/** Radius in screen inches to search for elements that anchor viewing operations. */
-ToolSettings.viewToolPickRadiusInches = 0.20;
-/** Camera angle enforced for walk tool. */
-ToolSettings.walkCameraAngle = core_geometry_1.Angle.createDegrees(75.6);
-/** Whether the walk tool enforces worldZ be aligned with screenY */
-ToolSettings.walkEnforceZUp = false;
-/** Speed, in meters per second, for the walk tool. */
-ToolSettings.walkVelocity = 3.5;
-/** @beta Integer increment used to compute a walkVelocity multiplier for the look and move tool, capped at 10x */
-ToolSettings.walkVelocityChange = 0;
-/** Whether the walk tool requests pointer lock to hide the cursor for mouse look */
-ToolSettings.walkRequestPointerLock = true;
-/** @beta Whether the look and move tool detects collisions while moving forward */
-ToolSettings.walkCollisions = false;
-/** @beta Whether the look and move tool adjusts the camera height for stairs/ramps when collisions are enabled */
-ToolSettings.walkDetectFloor = false;
-/** @beta Maximum step height in meters above floor/ground to use when floor detection is enabled */
-ToolSettings.walkStepHeight = 0.3;
-/** @beta Camera height in meters above floor/ground to use for set up walk tool */
-ToolSettings.walkEyeHeight = 1.6;
-/** Scale factor applied for wheel events with "per-line" modifier. */
-ToolSettings.wheelLineFactor = 40;
-/** Scale factor applied for wheel events with "per-page" modifier. */
-ToolSettings.wheelPageFactor = 120;
-/** When the zoom-with-wheel tool (with camera enabled) gets closer than this distance to an obstacle, it "bumps" through. */
-ToolSettings.wheelZoomBumpDistance = core_geometry_1.Constant.oneCentimeter;
-/** the speed to scroll for the "scroll view" tool (distance per second). */
-ToolSettings.scrollSpeed = .75;
-/** the speed to zoom for the "zoom view" tool. */
-ToolSettings.zoomSpeed = 10;
-/** Scale factor for zooming with mouse wheel. */
-ToolSettings.wheelZoomRatio = 1.5;
-/** Parameters for viewing operations with *inertia* (i.e. they continue briefly if used with a throwing action) */
-ToolSettings.viewingInertia = {
-    /** Flag to enable inertia. */
-    enabled: true,
-    /** How quickly the inertia decays. The smaller the damping value the faster the inertia decays. Must be less than 1.0 */
-    damping: .96,
-    /** Maximum duration of the inertia operation. Important when frame rates are low. */
-    duration: core_bentley_1.BeDuration.fromMilliseconds(500),
-};
-/** Maximum number of times in a second the accuSnap tool's onMotion function is called. */
-ToolSettings.maxOnMotionSnapCallPerSecond = 15;
 //# sourceMappingURL=ToolSettings.js.map

package/lib/cjs/tools/ToolSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolSettings.js","sourceRoot":"","sources":["../../../src/tools/ToolSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiD;AACjD,wDAAuD;AAEvD;;;GAGG;AACH,MAAa,YAAY;;AAAzB,oCAgEC;AA/DC,6DAA6D;AAC/C,6BAAgB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAClE,kEAAkE;AACpD,+BAAkB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;AACpE,sGAAsG;AACxF,uCAA0B,GAAG,IAAI,CAAC;AAChD,4HAA4H;AAC9G,yCAA4B,GAAG,KAAK,CAAC;AACnD,qFAAqF;AACvE,4BAAe,GAAG,IAAI,CAAC;AACrC,wEAAwE;AAC1D,2BAAc,GAAG,yBAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;AAC/D,gEAAgE;AAClD,2BAAc,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAChE,wFAAwF;AAC1E,oCAAuB,GAAG,GAAG,CAAC;AAC5C,qFAAqF;AACvE,oCAAuB,GAAG,IAAI,CAAC;AAC7C,sGAAsG;AACxF,2CAA8B,GAAG,IAAI,CAAC;AACpD,qFAAqF;AACvE,qCAAwB,GAAG,IAAI,CAAC;AAC9C,2CAA2C;AAC7B,4BAAe,GAAG,qBAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;AAC1D,oEAAoE;AACtD,2BAAc,GAAG,KAAK,CAAC;AACrC,sDAAsD;AACxC,yBAAY,GAAG,GAAG,CAAC;AACjC,kHAAkH;AACpG,+BAAkB,GAAG,CAAC,CAAC;AACrC,oFAAoF;AACtE,mCAAsB,GAAG,IAAI,CAAC;AAC5C,mFAAmF;AACrE,2BAAc,GAAG,KAAK,CAAC;AACrC,kHAAkH;AACpG,4BAAe,GAAG,KAAK,CAAC;AACtC,oGAAoG;AACtF,2BAAc,GAAG,GAAG,CAAC;AACnC,mFAAmF;AACrE,0BAAa,GAAG,GAAG,CAAC;AAClC,sEAAsE;AACxD,4BAAe,GAAG,EAAE,CAAC;AACnC,sEAAsE;AACxD,4BAAe,GAAG,GAAG,CAAC;AACpC,6HAA6H;AAC/G,kCAAqB,GAAG,wBAAQ,CAAC,aAAa,CAAC;AAC7D,4EAA4E;AAC9D,wBAAW,GAAG,GAAG,CAAC;AAChC,kDAAkD;AACpC,sBAAS,GAAG,EAAE,CAAC;AAC7B,iDAAiD;AACnC,2BAAc,GAAG,GAAG,CAAC;AACnC,mHAAmH;AACrG,2BAAc,GAAG;IAC7B,8BAA8B;IAC9B,OAAO,EAAE,IAAI;IACb,yHAAyH;IACzH,OAAO,EAAE,GAAG;IACZ,qFAAqF;IACrF,QAAQ,EAAE,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC;CAC3C,CAAC;AACF,2FAA2F;AAC7E,yCAA4B,GAAG,EAAE,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 Tools\n */\n\nimport { BeDuration } from \"@itwin/core-bentley\";\nimport { Angle, Constant } from \"@itwin/core-geometry\";\n\n/** Settings that control the behavior of built-in tools. Applications may modify these values.\n * @public\n * @extensions\n */\nexport class ToolSettings {\n  /** Two tap must be within this period to be a double tap. */\n  public static doubleTapTimeout = BeDuration.fromMilliseconds(250);\n  /** Two clicks must be within this period to be a double click. */\n  public static doubleClickTimeout = BeDuration.fromMilliseconds(500);\n  /** Number of screen inches of movement allowed between clicks to still qualify as a double-click.  */\n  public static doubleClickToleranceInches = 0.05;\n  /** @beta Use virtual cursor to help with locating elements using touch input. By default it's only enabled for snapping. */\n  public static enableVirtualCursorForLocate = false;\n  /** If true, view rotation tool keeps the up vector (worldZ) aligned with screenY. */\n  public static preserveWorldUp = true;\n  /** Delay with a touch on the surface before a move operation begins. */\n  public static touchMoveDelay = BeDuration.fromMilliseconds(50);\n  /** Delay with the mouse down before a drag operation begins. */\n  public static startDragDelay = BeDuration.fromMilliseconds(110);\n  /** Distance in screen inches a touch point must move before being considered motion. */\n  public static touchMoveDistanceInches = 0.1;\n  /** Distance in screen inches the cursor must move before a drag operation begins. */\n  public static startDragDistanceInches = 0.15;\n  /** Distance in screen inches touch points must move apart to be considered a change in zoom scale. */\n  public static touchZoomChangeThresholdInches = 0.20;\n  /** Radius in screen inches to search for elements that anchor viewing operations. */\n  public static viewToolPickRadiusInches = 0.20;\n  /** Camera angle enforced for walk tool. */\n  public static walkCameraAngle = Angle.createDegrees(75.6);\n  /** Whether the walk tool enforces worldZ be aligned with screenY */\n  public static walkEnforceZUp = false;\n  /** Speed, in meters per second, for the walk tool. */\n  public static walkVelocity = 3.5;\n  /** @beta Integer increment used to compute a walkVelocity multiplier for the look and move tool, capped at 10x */\n  public static walkVelocityChange = 0;\n  /** Whether the walk tool requests pointer lock to hide the cursor for mouse look */\n  public static walkRequestPointerLock = true;\n  /** @beta Whether the look and move tool detects collisions while moving forward */\n  public static walkCollisions = false;\n  /** @beta Whether the look and move tool adjusts the camera height for stairs/ramps when collisions are enabled */\n  public static walkDetectFloor = false;\n  /** @beta Maximum step height in meters above floor/ground to use when floor detection is enabled */\n  public static walkStepHeight = 0.3;\n  /** @beta Camera height in meters above floor/ground to use for set up walk tool */\n  public static walkEyeHeight = 1.6;\n  /** Scale factor applied for wheel events with \"per-line\" modifier. */\n  public static wheelLineFactor = 40;\n  /** Scale factor applied for wheel events with \"per-page\" modifier. */\n  public static wheelPageFactor = 120;\n  /** When the zoom-with-wheel tool (with camera enabled) gets closer than this distance to an obstacle, it \"bumps\" through. */\n  public static wheelZoomBumpDistance = Constant.oneCentimeter;\n  /** the speed to scroll for the \"scroll view\" tool (distance per second). */\n  public static scrollSpeed = .75;\n  /** the speed to zoom for the \"zoom view\" tool. */\n  public static zoomSpeed = 10;\n  /** Scale factor for zooming with mouse wheel. */\n  public static wheelZoomRatio = 1.5;\n  /** Parameters for viewing operations with *inertia* (i.e. they continue briefly if used with a throwing action) */\n  public static viewingInertia = {\n    /** Flag to enable inertia. */\n    enabled: true,\n    /** How quickly the inertia decays. The smaller the damping value the faster the inertia decays. Must be less than 1.0 */\n    damping: .96,\n    /** Maximum duration of the inertia operation. Important when frame rates are low. */\n    duration: BeDuration.fromMilliseconds(500),\n  };\n  /** Maximum number of times in a second the accuSnap tool's onMotion function is called. */\n  public static maxOnMotionSnapCallPerSecond = 15;\n}\n"]}
+{"version":3,"file":"ToolSettings.js","sourceRoot":"","sources":["../../../src/tools/ToolSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiD;AACjD,wDAAuD;AAEvD;;;GAGG;AACH,MAAa,YAAY;IACvB,6DAA6D;aAC/C,qBAAgB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAClE,kEAAkE;aACpD,uBAAkB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACpE,sGAAsG;aACxF,+BAA0B,GAAG,IAAI,CAAC;IAChD,4HAA4H;aAC9G,iCAA4B,GAAG,KAAK,CAAC;IACnD,qFAAqF;aACvE,oBAAe,GAAG,IAAI,CAAC;IACrC,wEAAwE;aAC1D,mBAAc,GAAG,yBAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC/D,gEAAgE;aAClD,mBAAc,GAAG,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAChE,wFAAwF;aAC1E,4BAAuB,GAAG,GAAG,CAAC;IAC5C,qFAAqF;aACvE,4BAAuB,GAAG,IAAI,CAAC;IAC7C,sGAAsG;aACxF,mCAA8B,GAAG,IAAI,CAAC;IACpD,qFAAqF;aACvE,6BAAwB,GAAG,IAAI,CAAC;IAC9C,2CAA2C;aAC7B,oBAAe,GAAG,qBAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC1D,oEAAoE;aACtD,mBAAc,GAAG,KAAK,CAAC;IACrC,sDAAsD;aACxC,iBAAY,GAAG,GAAG,CAAC;IACjC,kHAAkH;aACpG,uBAAkB,GAAG,CAAC,CAAC;IACrC,oFAAoF;aACtE,2BAAsB,GAAG,IAAI,CAAC;IAC5C,mFAAmF;aACrE,mBAAc,GAAG,KAAK,CAAC;IACrC,kHAAkH;aACpG,oBAAe,GAAG,KAAK,CAAC;IACtC,oGAAoG;aACtF,mBAAc,GAAG,GAAG,CAAC;IACnC,mFAAmF;aACrE,kBAAa,GAAG,GAAG,CAAC;IAClC,sEAAsE;aACxD,oBAAe,GAAG,EAAE,CAAC;IACnC,sEAAsE;aACxD,oBAAe,GAAG,GAAG,CAAC;IACpC,6HAA6H;aAC/G,0BAAqB,GAAG,wBAAQ,CAAC,aAAa,CAAC;IAC7D,4EAA4E;aAC9D,gBAAW,GAAG,GAAG,CAAC;IAChC,kDAAkD;aACpC,cAAS,GAAG,EAAE,CAAC;IAC7B,iDAAiD;aACnC,mBAAc,GAAG,GAAG,CAAC;IACnC,mHAAmH;aACrG,mBAAc,GAAG;QAC7B,8BAA8B;QAC9B,OAAO,EAAE,IAAI;QACb,yHAAyH;QACzH,OAAO,EAAE,GAAG;QACZ,qFAAqF;QACrF,QAAQ,EAAE,yBAAU,CAAC,gBAAgB,CAAC,GAAG,CAAC;KAC3C,CAAC;IACF,2FAA2F;aAC7E,iCAA4B,GAAG,EAAE,CAAC;;AA/DlD,oCAgEC","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 Tools\n */\n\nimport { BeDuration } from \"@itwin/core-bentley\";\nimport { Angle, Constant } from \"@itwin/core-geometry\";\n\n/** Settings that control the behavior of built-in tools. Applications may modify these values.\n * @public\n * @extensions\n */\nexport class ToolSettings {\n  /** Two tap must be within this period to be a double tap. */\n  public static doubleTapTimeout = BeDuration.fromMilliseconds(250);\n  /** Two clicks must be within this period to be a double click. */\n  public static doubleClickTimeout = BeDuration.fromMilliseconds(500);\n  /** Number of screen inches of movement allowed between clicks to still qualify as a double-click.  */\n  public static doubleClickToleranceInches = 0.05;\n  /** @beta Use virtual cursor to help with locating elements using touch input. By default it's only enabled for snapping. */\n  public static enableVirtualCursorForLocate = false;\n  /** If true, view rotation tool keeps the up vector (worldZ) aligned with screenY. */\n  public static preserveWorldUp = true;\n  /** Delay with a touch on the surface before a move operation begins. */\n  public static touchMoveDelay = BeDuration.fromMilliseconds(50);\n  /** Delay with the mouse down before a drag operation begins. */\n  public static startDragDelay = BeDuration.fromMilliseconds(110);\n  /** Distance in screen inches a touch point must move before being considered motion. */\n  public static touchMoveDistanceInches = 0.1;\n  /** Distance in screen inches the cursor must move before a drag operation begins. */\n  public static startDragDistanceInches = 0.15;\n  /** Distance in screen inches touch points must move apart to be considered a change in zoom scale. */\n  public static touchZoomChangeThresholdInches = 0.20;\n  /** Radius in screen inches to search for elements that anchor viewing operations. */\n  public static viewToolPickRadiusInches = 0.20;\n  /** Camera angle enforced for walk tool. */\n  public static walkCameraAngle = Angle.createDegrees(75.6);\n  /** Whether the walk tool enforces worldZ be aligned with screenY */\n  public static walkEnforceZUp = false;\n  /** Speed, in meters per second, for the walk tool. */\n  public static walkVelocity = 3.5;\n  /** @beta Integer increment used to compute a walkVelocity multiplier for the look and move tool, capped at 10x */\n  public static walkVelocityChange = 0;\n  /** Whether the walk tool requests pointer lock to hide the cursor for mouse look */\n  public static walkRequestPointerLock = true;\n  /** @beta Whether the look and move tool detects collisions while moving forward */\n  public static walkCollisions = false;\n  /** @beta Whether the look and move tool adjusts the camera height for stairs/ramps when collisions are enabled */\n  public static walkDetectFloor = false;\n  /** @beta Maximum step height in meters above floor/ground to use when floor detection is enabled */\n  public static walkStepHeight = 0.3;\n  /** @beta Camera height in meters above floor/ground to use for set up walk tool */\n  public static walkEyeHeight = 1.6;\n  /** Scale factor applied for wheel events with \"per-line\" modifier. */\n  public static wheelLineFactor = 40;\n  /** Scale factor applied for wheel events with \"per-page\" modifier. */\n  public static wheelPageFactor = 120;\n  /** When the zoom-with-wheel tool (with camera enabled) gets closer than this distance to an obstacle, it \"bumps\" through. */\n  public static wheelZoomBumpDistance = Constant.oneCentimeter;\n  /** the speed to scroll for the \"scroll view\" tool (distance per second). */\n  public static scrollSpeed = .75;\n  /** the speed to zoom for the \"zoom view\" tool. */\n  public static zoomSpeed = 10;\n  /** Scale factor for zooming with mouse wheel. */\n  public static wheelZoomRatio = 1.5;\n  /** Parameters for viewing operations with *inertia* (i.e. they continue briefly if used with a throwing action) */\n  public static viewingInertia = {\n    /** Flag to enable inertia. */\n    enabled: true,\n    /** How quickly the inertia decays. The smaller the damping value the faster the inertia decays. Must be less than 1.0 */\n    damping: .96,\n    /** Maximum duration of the inertia operation. Important when frame rates are low. */\n    duration: BeDuration.fromMilliseconds(500),\n  };\n  /** Maximum number of times in a second the accuSnap tool's onMotion function is called. */\n  public static maxOnMotionSnapCallPerSecond = 15;\n}\n"]}

package/lib/cjs/tools/ViewTool.js

@@ -2449,6 +2449,8 @@ class ViewFly extends ViewNavigate {
  * @public
  */
 class PanViewTool extends ViewManip {
+    static { this.toolId = "View.Pan"; }
+    static { this.iconSpec = "icon-hand-2"; }
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
@@ -2458,12 +2460,12 @@ class PanViewTool extends ViewManip {
     }
 }
 exports.PanViewTool = PanViewTool;
-PanViewTool.toolId = "View.Pan";
-PanViewTool.iconSpec = "icon-hand-2";
 /** A tool that performs a Rotate view operation
  * @public
  */
 class RotateViewTool extends ViewManip {
+    static { this.toolId = "View.Rotate"; }
+    static { this.iconSpec = "icon-gyroscope"; }
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Rotate | ViewHandleType.Pan | ViewHandleType.TargetCenter, oneShot, isDraggingRequired);
     }
@@ -2473,12 +2475,12 @@ class RotateViewTool extends ViewManip {
     }
 }
 exports.RotateViewTool = RotateViewTool;
-RotateViewTool.toolId = "View.Rotate";
-RotateViewTool.iconSpec = "icon-gyroscope";
 /** A tool that performs the look operation
  * @public
  */
 class LookViewTool extends ViewManip {
+    static { this.toolId = "View.Look"; }
+    static { this.iconSpec = "icon-view-navigation"; }
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Look | ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
@@ -2488,12 +2490,12 @@ class LookViewTool extends ViewManip {
     }
 }
 exports.LookViewTool = LookViewTool;
-LookViewTool.toolId = "View.Look";
-LookViewTool.iconSpec = "icon-view-navigation";
 /** A tool that performs the scroll operation
  * @public
  */
 class ScrollViewTool extends ViewManip {
+    static { this.toolId = "View.Scroll"; }
+    static { this.iconSpec = "icon-move"; }
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Scroll, oneShot, isDraggingRequired);
     }
@@ -2503,12 +2505,12 @@ class ScrollViewTool extends ViewManip {
     }
 }
 exports.ScrollViewTool = ScrollViewTool;
-ScrollViewTool.toolId = "View.Scroll";
-ScrollViewTool.iconSpec = "icon-move";
 /** A tool that performs the zoom operation
  * @public
  */
 class ZoomViewTool extends ViewManip {
+    static { this.toolId = "View.Zoom"; }
+    static { this.iconSpec = "icon-zoom"; }
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Zoom | ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
@@ -2518,8 +2520,6 @@ class ZoomViewTool extends ViewManip {
     }
 }
 exports.ZoomViewTool = ZoomViewTool;
-ZoomViewTool.toolId = "View.Zoom";
-ZoomViewTool.iconSpec = "icon-zoom";
 /** A tool that performs the walk operation using mouse+keyboard or touch controls.
  * Keyboard and mouse controls are similar to those used by many video games:
  *  - Mouse motion: look around.
@@ -2529,6 +2529,8 @@ ZoomViewTool.iconSpec = "icon-zoom";
  * @public
  */
 class LookAndMoveTool extends ViewManip {
+    static { this.toolId = "View.LookAndMove"; }
+    static { this.iconSpec = "icon-walk"; }
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         const viewport = (undefined === vp ? IModelApp_1.IModelApp.viewManager.selectedView : vp); // Need vp to enable camera/check lens in onReinitialize...
         super(viewport, ViewHandleType.LookAndMove | ViewHandleType.Pan, oneShot, isDraggingRequired);
@@ -2567,12 +2569,12 @@ class LookAndMoveTool extends ViewManip {
     }
 }
 exports.LookAndMoveTool = LookAndMoveTool;
-LookAndMoveTool.toolId = "View.LookAndMove";
-LookAndMoveTool.iconSpec = "icon-walk";
 /** A tool that performs the walk operation
  * @public
  */
 class WalkViewTool extends ViewManip {
+    static { this.toolId = "View.Walk"; }
+    static { this.iconSpec = "icon-walk"; }
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         const viewport = (undefined === vp ? IModelApp_1.IModelApp.viewManager.selectedView : vp); // Need vp to enable camera/check lens in onReinitialize...
         super(viewport, ViewHandleType.Walk | ViewHandleType.Pan, oneShot, isDraggingRequired);
@@ -2590,12 +2592,12 @@ class WalkViewTool extends ViewManip {
     }
 }
 exports.WalkViewTool = WalkViewTool;
-WalkViewTool.toolId = "View.Walk";
-WalkViewTool.iconSpec = "icon-walk";
 /** A tool that performs the fly operation
  * @public
  */
 class FlyViewTool extends ViewManip {
+    static { this.toolId = "View.Fly"; }
+    static { this.iconSpec = "icon-airplane"; }
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Fly | ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
@@ -2612,12 +2614,12 @@ class FlyViewTool extends ViewManip {
     }
 }
 exports.FlyViewTool = FlyViewTool;
-FlyViewTool.toolId = "View.Fly";
-FlyViewTool.iconSpec = "icon-airplane";
 /** A tool that performs a fit view
  * @public
  */
 class FitViewTool extends ViewTool {
+    static { this.toolId = "View.Fit"; }
+    static { this.iconSpec = "icon-fit-to-view"; }
     constructor(viewport, oneShot, doAnimate = true, isolatedOnly = true) {
         super(viewport);
         this.viewport = viewport;
@@ -2663,12 +2665,11 @@ class FitViewTool extends ViewTool {
     }
 }
 exports.FitViewTool = FitViewTool;
-FitViewTool.toolId = "View.Fit";
-FitViewTool.iconSpec = "icon-fit-to-view";
 /** A tool that views a location on the background map from a satellite's perspective; the viewed location is derived from the position of the current camera's eye above the background map. Operates on the selected view.
  * @public
  */
 class ViewGlobeSatelliteTool extends ViewTool {
+    static { this.toolId = "View.GlobeSatellite"; }
     constructor(viewport, oneShot = true, doAnimate = true) {
         super(viewport);
         this.viewport = viewport;
@@ -2714,11 +2715,11 @@ class ViewGlobeSatelliteTool extends ViewTool {
     }
 }
 exports.ViewGlobeSatelliteTool = ViewGlobeSatelliteTool;
-ViewGlobeSatelliteTool.toolId = "View.GlobeSatellite";
 /** A tool that views a location on the background map from a bird's eye perspective; the viewed location is derived from the position of the current camera's eye above the background map. Operates on the selected view.
  * @public
  */
 class ViewGlobeBirdTool extends ViewTool {
+    static { this.toolId = "View.GlobeBird"; }
     constructor(viewport, oneShot = true, doAnimate = true) {
         super(viewport);
         this.viewport = viewport;
@@ -2761,13 +2762,13 @@ class ViewGlobeBirdTool extends ViewTool {
     }
 }
 exports.ViewGlobeBirdTool = ViewGlobeBirdTool;
-ViewGlobeBirdTool.toolId = "View.GlobeBird";
 /** A tool that views a location on the background map corresponding to a specified string.
  * This will either look down at the location using a bird's eye height, or, if a range is available, the entire range corresponding to the location will be viewed.
  * Operates on the selected view.
  * @public
  */
 class ViewGlobeLocationTool extends ViewTool {
+    static { this.toolId = "View.GlobeLocation"; }
     constructor(viewport, oneShot = true, doAnimate = true) {
         super(viewport);
         this.viewport = viewport;
@@ -2828,11 +2829,11 @@ class ViewGlobeLocationTool extends ViewTool {
     }
 }
 exports.ViewGlobeLocationTool = ViewGlobeLocationTool;
-ViewGlobeLocationTool.toolId = "View.GlobeLocation";
 /** A tool that views the current iModel on the background map so that the extent of the project is visible. Operates on the selected view.
  * @public
  */
 class ViewGlobeIModelTool extends ViewTool {
+    static { this.toolId = "View.GlobeIModel"; }
     constructor(viewport, oneShot = true, doAnimate = true) {
         super(viewport);
         this.viewport = viewport;
@@ -2870,11 +2871,12 @@ class ViewGlobeIModelTool extends ViewTool {
     }
 }
 exports.ViewGlobeIModelTool = ViewGlobeIModelTool;
-ViewGlobeIModelTool.toolId = "View.GlobeIModel";
 /** A tool that rotates the view to one of the standard views.
  * @public
  */
 class StandardViewTool extends ViewTool {
+    static { this.toolId = "View.Standard"; }
+    static { this.iconSpec = "icon-cube-faces-top"; }
     constructor(viewport, _standardViewId) {
         super(viewport);
         this._standardViewId = _standardViewId;
@@ -2899,8 +2901,6 @@ class StandardViewTool extends ViewTool {
     }
 }
 exports.StandardViewTool = StandardViewTool;
-StandardViewTool.toolId = "View.Standard";
-StandardViewTool.iconSpec = "icon-cube-faces-top";
 /** A tool that performs a Window-area view operation
  * @public
  */
@@ -2914,6 +2914,8 @@ class WindowAreaTool extends ViewTool {
         this._shapePts = [new core_geometry_1.Point3d(), new core_geometry_1.Point3d(), new core_geometry_1.Point3d(), new core_geometry_1.Point3d(), new core_geometry_1.Point3d()];
         this._fillColor = core_common_1.ColorDef.from(0, 0, 255, 200);
     }
+    static { this.toolId = "View.WindowArea"; }
+    static { this.iconSpec = "icon-window-area"; }
     async onPostInstall() {
         await super.onPostInstall();
         this.provideToolAssistance();
@@ -3138,10 +3140,9 @@ class WindowAreaTool extends ViewTool {
     }
 }
 exports.WindowAreaTool = WindowAreaTool;
-WindowAreaTool.toolId = "View.WindowArea";
-WindowAreaTool.iconSpec = "icon-window-area";
 /** @internal */
 class DefaultViewTouchTool extends ViewManip {
+    static { this.toolId = ""; } // touch tools installed by IdleTool are never registered
     /** Move this handle during the inertia duration */
     animate() {
         if (undefined === this._inertiaVec)
@@ -3358,11 +3359,12 @@ class DefaultViewTouchTool extends ViewManip {
     }
 }
 exports.DefaultViewTouchTool = DefaultViewTouchTool;
-DefaultViewTouchTool.toolId = ""; // touch tools installed by IdleTool are never registered
 /** A tool that performs view undo operation. An application could also just call Viewport.doUndo directly, creating a ViewTool isn't required.
  * @public
  */
 class ViewUndoTool extends ViewTool {
+    static { this.toolId = "View.Undo"; }
+    static { this.iconSpec = "icon-window-backward"; }
     async onPostInstall() {
         if (this.viewport)
             this.viewport.doUndo(Viewport_1.ScreenViewport.animation.time.normal);
@@ -3370,12 +3372,12 @@ class ViewUndoTool extends ViewTool {
     }
 }
 exports.ViewUndoTool = ViewUndoTool;
-ViewUndoTool.toolId = "View.Undo";
-ViewUndoTool.iconSpec = "icon-window-backward";
 /** A tool that performs view redo operation. An application could also just call Viewport.doRedo directly, creating a ViewTool isn't required.
  * @public
  */
 class ViewRedoTool extends ViewTool {
+    static { this.toolId = "View.Redo"; }
+    static { this.iconSpec = "icon-window-forward"; }
     async onPostInstall() {
         if (this.viewport)
             this.viewport.doRedo(Viewport_1.ScreenViewport.animation.time.normal);
@@ -3383,12 +3385,12 @@ class ViewRedoTool extends ViewTool {
     }
 }
 exports.ViewRedoTool = ViewRedoTool;
-ViewRedoTool.toolId = "View.Redo";
-ViewRedoTool.iconSpec = "icon-window-forward";
 /** A tool that toggles the camera on/off in a spatial view
  * @public
  */
 class ViewToggleCameraTool extends ViewTool {
+    static { this.toolId = "View.ToggleCamera"; }
+    static { this.iconSpec = "icon-camera"; }
     async onInstall() { return (undefined !== this.viewport && this.viewport.view.allow3dManipulations()); }
     async onPostInstall() {
         if (this.viewport) {
@@ -3403,8 +3405,6 @@ class ViewToggleCameraTool extends ViewTool {
     }
 }
 exports.ViewToggleCameraTool = ViewToggleCameraTool;
-ViewToggleCameraTool.toolId = "View.ToggleCamera";
-ViewToggleCameraTool.iconSpec = "icon-camera";
 /** A tool that sets the view camera by two points. This is a PrimitiveTool and not a ViewTool to allow the view to be panned, zoomed, and rotated while defining the points.
  * To show tool settings for specifying camera and target heights above the snap point, make sure formatting and parsing data are cached before the tool starts
  * by calling QuantityFormatter.onInitialized at app startup.
@@ -3417,6 +3417,8 @@ class SetupCameraTool extends PrimitiveTool_1.PrimitiveTool {
         this._eyePtWorld = core_geometry_1.Point3d.create();
         this._targetPtWorld = core_geometry_1.Point3d.create();
     }
+    static { this.toolId = "View.SetupCamera"; }
+    static { this.iconSpec = "icon-camera-location"; }
     isCompatibleViewport(vp, isSelectedViewChange) { return (super.isCompatibleViewport(vp, isSelectedViewChange) && undefined !== vp && vp.view.allow3dManipulations()); }
     isValidLocation(_ev, _isButtonEvent) { return true; }
     requireWriteableTarget() { return false; }
@@ -3664,8 +3666,6 @@ class SetupCameraTool extends PrimitiveTool_1.PrimitiveTool {
     }
 }
 exports.SetupCameraTool = SetupCameraTool;
-SetupCameraTool.toolId = "View.SetupCamera";
-SetupCameraTool.iconSpec = "icon-camera-location";
 /** A tool that sets a walk tool starting position by a floor point and look direction. This is a PrimitiveTool and not a ViewTool to allow the view to be panned, zoomed, and rotated while defining the points.
  * @public
  */
@@ -3676,6 +3676,8 @@ class SetupWalkCameraTool extends PrimitiveTool_1.PrimitiveTool {
         this._eyePtWorld = core_geometry_1.Point3d.create();
         this._targetPtWorld = core_geometry_1.Point3d.create();
     }
+    static { this.toolId = "View.SetupWalkCamera"; }
+    static { this.iconSpec = "icon-camera-location"; }
     isCompatibleViewport(vp, isSelectedViewChange) { return (super.isCompatibleViewport(vp, isSelectedViewChange) && undefined !== vp && vp.view.allow3dManipulations()); }
     isValidLocation(_ev, _isButtonEvent) { return true; }
     requireWriteableTarget() { return false; }
@@ -3845,6 +3847,4 @@ class SetupWalkCameraTool extends PrimitiveTool_1.PrimitiveTool {
     }
 }
 exports.SetupWalkCameraTool = SetupWalkCameraTool;
-SetupWalkCameraTool.toolId = "View.SetupWalkCamera";
-SetupWalkCameraTool.iconSpec = "icon-camera-location";
 //# sourceMappingURL=ViewTool.js.map