@itwin/core-frontend 5.0.0-dev.40 → 5.0.0-dev.49

package/lib/cjs/tools/AccuDrawViewportUI.d.ts

@@ -0,0 +1,154 @@
+import { AccuDraw, ItemField } from "../AccuDraw";
+import { ViewRect } from "../common/ViewRect";
+import { BeButtonEvent } from "./Tool";
+import { ScreenViewport } from "../Viewport";
+/** Provides an in viewport user interface for AccuDraw that can optionally follow the cursor or remain at a fixed location.
+ * @beta
+ */
+export declare class AccuDrawViewportUI extends AccuDraw {
+    private _focusItem;
+    private _controls?;
+    private _toolTipsSuspended?;
+    private _expression?;
+    /** Settings to control the behavior and visual appearance of the viewport controls.
+     * @note Colors were chosen for visibility against viewport background and contents.
+     */
+    static controlProps: {
+        /** Suspend locate tooltip when controls are shown, may wish to disable when using fixed location. */
+        suspendLocateToolTip: boolean;
+        /** Show controls at a fixed location in the view (currently bottom middle) instead of following the cursor. */
+        fixedLocation: boolean;
+        /** Layout controls in a single row horizontally instead of in columns vertically as an option when using fixed location. */
+        horizontalArrangement: boolean;
+        /** Replace "^", ";", and ".." with "°" or ":" for easier input. */
+        simplifiedInput: boolean;
+        /** Enable simple math operations not supported by quantity parser. */
+        mathOperations: boolean;
+        /** Number of visible characters to show in text input fields. */
+        fieldSize: number;
+        /** Row spacing of text input fields for vertical arrangement. */
+        rowSpacingFactor: number;
+        /** Column spacing of text input fields and buttons for horizontal arrangement. */
+        columnSpacingFactor: number;
+        /** Corner radius of text input fields and locks buttons. */
+        borderRadius: string;
+        /** Background color of unfocused text input fields and unlocked buttons. */
+        backgroundColor: string;
+        /** Settings specific to text input fields and lock button labels. */
+        text: {
+            /** Font family to use for text input field values and button labels. */
+            fontFamily: string;
+            /** Font size to use for text input field values and button labels. */
+            fontSize: string;
+            /** Font color to use for text input field values and button labels. */
+            color: string;
+            /** Background color of focused text input field. */
+            focusColor: string;
+        };
+        /** Settings specific to lock buttons. */
+        button: {
+            /** Background color of locked buttons. */
+            pressedColor: string;
+            /** Padding to use on left and right of label and affects overall width. */
+            padding: string;
+            /** Margin to use on left and right to position relative to text input field. */
+            margin: string;
+            /** Width of border outline. */
+            outlineWidth: string;
+            /** Shadow shown when unlocked to make it appear raised. */
+            shadow: string;
+        };
+    };
+    /** Create a new instance of this class to set as [[IModelAppOptions.accuDraw]] for this session. */
+    constructor();
+    /** Call to set a vertical layout that follows the cursor. This is the default configuration. */
+    setVerticalCursorLayout(): void;
+    /** Call to set a horizontal layout that is anchored to the bottom middle of the view. */
+    setHorizontalFixedLayout(): void;
+    /** Call to update the currently displayed controls after settings are changed. */
+    refreshControls(): void;
+    private suspendToolTips;
+    private unsuspendToolTips;
+    private setDynamicKeyinStatus;
+    private setPartialKeyinStatus;
+    private makeParserHappy;
+    private evaluateExpression;
+    private parseExpression;
+    private processPartialInput;
+    private acceptPartialInput;
+    private acceptSavedValue;
+    private doFocusHome;
+    private doChooseSavedValue;
+    private doNavigate;
+    private doAcceptInput;
+    private doNewInput;
+    private doDeleteInput;
+    private processReplacementKey;
+    private processRepeatedKey;
+    private doProcessOverrideKey;
+    private doProcessExpressionKey;
+    private doProcessKey;
+    private onKeyboardEvent;
+    private removeControls;
+    private createControlDiv;
+    private updateItemFieldKeyinStatus;
+    private updateItemFieldValue;
+    private updateItemFieldLock;
+    private initializeItemStyle;
+    private createItemField;
+    private createItemFieldLock;
+    /** Use to override the position of the controls in the supplied view. */
+    protected modifyControlRect(_rect: ViewRect, _vp: ScreenViewport): void;
+    /** Return the ViewRect currently occupied by the controls in the supplied view. */
+    protected currentControlRect(vp: ScreenViewport): ViewRect | undefined;
+    private updateControlVisibility;
+    private updateControls;
+    private get _isFocusHome();
+    private get _isFocusAccuDraw();
+    private setFocusHome;
+    /** Return whether keyboard shortcuts can or can't be used.
+     * Used to show a visual indication of whether keyboard shortcuts will be processed.
+     * Keyboard shortcuts can be supported when focus is either on AccuDraw or Home.
+     * When returning false the compass displays in monochrome.
+     */
+    get hasInputFocus(): boolean;
+    /** Request to set focus to the specified AccuDraw input field to start entering values.
+     * The focused input field will be indicated by the background color.
+     */
+    setFocusItem(index: ItemField): void;
+    /** Request to set focus to the active AccuDraw input field to start entering values.
+     * The focused input field will be indicated by the background color.
+     */
+    grabInputFocus(): void;
+    private onFocusChange;
+    /** Change notification for when the compass is shown or hidden.
+     * Used to hide the viewport controls when the compass is no longer displayed.
+     */
+    onCompassDisplayChange(state: "show" | "hide"): void;
+    /** Change notification for when the compass mode switches between polar and rectangular inputs.
+     * Used to show or hide the input fields that are applicable to the current mode.
+     */
+    onCompassModeChange(): void;
+    /** Change notification for when the supplied input field switches between dynamic and partial input.
+     * When an input field is in the dynamic state, its value changes according to the current button event unless the field is locked.
+     * When an input field is in the partial state, its value is not changed or formatted to allow the value to be changed.
+     * Locking a field is expected to change the input state to partial.
+     * Unlocking a field or accepting a value by focusing is expected to change the input state to dynamic.
+     */
+    onFieldKeyinStatusChange(item: ItemField): void;
+    /** Change notification for when the supplied input field value has been modified.
+     * Used to update the displayed input field with the value from the active angle or distance formatter.
+     */
+    onFieldValueChange(item: ItemField): void;
+    /** Change notification for when the supplied input field lock status is modified.
+     * Used to update the displayed lock toggles to reflect the current state.
+     */
+    onFieldLockChange(item: ItemField): void;
+    /** Change notification of a motion event in the view.
+     * Used to show as well as update the dynamic input field values to reflect the current deltas when active.
+     * Automatically switches the focused input field between x and y in rectangular mode based on
+     * cursor position when axis isn't locked to support more intuitive user input and "smart lock" keyboard shortcut.
+     */
+    onMotion(ev: BeButtonEvent): void;
+}
+//# sourceMappingURL=AccuDrawViewportUI.d.ts.map

package/lib/cjs/tools/AccuDrawViewportUI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccuDrawViewportUI.d.ts","sourceRoot":"","sources":["../../../src/tools/AccuDrawViewportUI.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,QAAQ,EAAe,SAAS,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAG9C,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAS7C;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,QAAQ;IAC9C,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,SAAS,CAAC,CAAmB;IACrC,OAAO,CAAC,kBAAkB,CAAC,CAAO;IAClC,OAAO,CAAC,WAAW,CAAC,CAAwC;IAE5D;;OAEG;IACH,OAAc,YAAY;QACxB,qGAAqG;;QAErG,+GAA+G;;QAE/G,4HAA4H;;QAE5H,mEAAmE;;QAEnE,sEAAsE;;QAEtE,iEAAiE;;QAEjE,iEAAiE;;QAEjE,kFAAkF;;QAElF,4DAA4D;;QAE5D,4EAA4E;;QAG5E,qEAAqE;;YAEnE,wEAAwE;;YAExE,sEAAsE;;YAEtE,uEAAuE;;YAEvE,oDAAoD;;;QAItD,yCAAyC;;YAEvC,0CAA0C;;YAE1C,2EAA2E;;YAE3E,gFAAgF;;YAEhF,+BAA+B;;YAE/B,2DAA2D;;;MAG7D;IAEF,oGAAoG;;IAMpG,gGAAgG;IACzF,uBAAuB;IAO9B,yFAAyF;IAClF,wBAAwB;IAO/B,kFAAkF;IAC3E,eAAe,IAAI,IAAI;IAc9B,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,qBAAqB;IAK7B,OAAO,CAAC,qBAAqB;IAY7B,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,kBAAkB;IAe1B,OAAO,CAAC,eAAe;YA4CT,mBAAmB;YAmBnB,kBAAkB;IAehC,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,WAAW;YAUL,kBAAkB;YAUlB,UAAU;YAUV,aAAa;IAS3B,OAAO,CAAC,UAAU;YAOJ,aAAa;IAO3B,OAAO,CAAC,qBAAqB;IAuB7B,OAAO,CAAC,kBAAkB;IA2B1B,OAAO,CAAC,oBAAoB;IAgB5B,OAAO,CAAC,sBAAsB;YA+EhB,YAAY;YAkBZ,eAAe;IA4C7B,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,0BAA0B;IASlC,OAAO,CAAC,oBAAoB;IAM5B,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,eAAe;IAkBvB,OAAO,CAAC,mBAAmB;IAqC3B,yEAAyE;IACzE,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI;IAEvE,mFAAmF;IACnF,SAAS,CAAC,kBAAkB,CAAC,EAAE,EAAE,cAAc,GAAG,QAAQ,GAAG,SAAS;IAWtE,OAAO,CAAC,uBAAuB;IAuB/B,OAAO,CAAC,cAAc;IA+FtB,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,KAAK,gBAAgB,GAE3B;IAED,OAAO,CAAC,YAAY;IAOpB;;;;OAIG;IACH,IAAoB,aAAa,IAAI,OAAO,CAG3C;IAED;;OAEG;IACa,YAAY,CAAC,KAAK,EAAE,SAAS;IAQ7C;;OAEG;IACa,cAAc;IAO9B,OAAO,CAAC,aAAa;IAarB;;OAEG;IACa,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAMpE;;OAEG;IACa,mBAAmB,IAAI,IAAI;IAK3C;;;;;OAKG;IACa,wBAAwB,CAAC,IAAI,EAAE,SAAS;IAMxD;;OAEG;IACa,kBAAkB,CAAC,IAAI,EAAE,SAAS;IAMlD;;OAEG;IACa,iBAAiB,CAAC,IAAI,EAAE,SAAS;IAMjD;;;;OAIG;IACa,QAAQ,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI;CAIlD"}