@itwin/appui-react 3.0.0-dev.100

package/lib/cjs/appui-react/content/ViewportContentControl.d.ts

@@ -0,0 +1,53 @@
+/** @packageDocumentation
+ * @module ContentView
+ */
+/// <reference types="react" />
+import { Id64String } from "@itwin/core-bentley";
+import { IModelConnection, ScreenViewport, ViewState } from "@itwin/core-frontend";
+import { ConfigurableCreateInfo, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+import { ContentControl, SupportsViewSelectorChange } from "./ContentControl";
+/**
+ * The base class for frontstage Viewport content controls that connects to a `ScreenViewport`
+ * that is managed by the `ViewManager`.
+ * @public
+ */
+export declare class ViewportContentControl extends ContentControl implements SupportsViewSelectorChange {
+    private _viewport;
+    private _isReady;
+    private _viewportReadyCallback?;
+    /** Creates an instance of ViewportContentControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided via the applicationData in a [[ContentProps]].
+     */
+    constructor(info: ConfigurableCreateInfo, options: any);
+    /** Gets the type of ConfigurableUiControl, which is 'Viewport' in this case */
+    getType(): ConfigurableUiControlType;
+    /** Returns true if this control is a Viewport control. */
+    get isViewport(): boolean;
+    /** The underlying ScreenViewport */
+    get viewport(): ScreenViewport | undefined;
+    set viewport(v: ScreenViewport | undefined);
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    setIsReady(): void;
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    get isReady(): Promise<void>;
+    /** Called when this ContentControl is activated */
+    onActivated(): void;
+    /** Get the NavigationAidControl associated with this ContentControl */
+    get navigationAidControl(): string;
+    /**
+     * Fetches appropriate NavigationAid based on the class of the current viewport.
+     * @param classFullName The full name of the current viewport class.
+     * @returns The ID of the navigation aid to be displayed.
+     */
+    private _getNavigationAid;
+    /** Returns true if this control supports processing ViewSelector changes. */
+    get supportsViewSelectorChange(): boolean;
+    /** Process a ViewSelector change. */
+    processViewSelectorChange(iModel: IModelConnection, viewDefinitionId: Id64String, viewState: ViewState, name: string): Promise<void>;
+    /** Get the React.Element for a ViewSelector change. */
+    getReactElementForViewSelectorChange(_iModel: IModelConnection, _viewDefinitionId: Id64String, _viewState: ViewState, _name: string): React.ReactNode;
+}
+//# sourceMappingURL=ViewportContentControl.d.ts.map

package/lib/cjs/appui-react/content/ViewportContentControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ViewportContentControl.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/content/ViewportContentControl.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EACwB,gBAAgB,EAAyB,cAAc,EAAoC,SAAS,EAClI,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAK5G,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAG9E;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,cAAe,YAAW,0BAA0B;IAC9F,OAAO,CAAC,SAAS,CAA6B;IAC9C,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,sBAAsB,CAAC,CAAa;IAE5C;;;OAGG;gBACS,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG;IAQtD,+EAA+E;IAC/D,OAAO,IAAI,yBAAyB;IAEpD,0DAA0D;IAC1D,IAAoB,UAAU,IAAI,OAAO,CAAiB;IAE1D,oCAAoC;IACpC,IAAoB,QAAQ,IAAI,cAAc,GAAG,SAAS,CAA2B;IACrF,IAAoB,QAAQ,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,EAGzD;IAED;OACG;IACI,UAAU,IAAI,IAAI;IAOzB;OACG;IACH,IAAoB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAA0B;IAEtE,mDAAmD;IACnC,WAAW,IAAI,IAAI;IAInC,uEAAuE;IACvE,IAAoB,oBAAoB,IAAI,MAAM,CASjD;IAED;;;;OAIG;IACH,OAAO,CAAC,iBAAiB,CAkBvB;IAEF,6EAA6E;IAC7E,IAAW,0BAA0B,IAAI,OAAO,CAAiB;IAEjE,qCAAqC;IAExB,yBAAyB,CAAC,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUjJ,uDAAuD;IAEhD,oCAAoC,CAAC,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS;CAC7J"}

package/lib/cjs/appui-react/content/ViewportContentControl.js

@@ -0,0 +1,110 @@
+"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 ContentView
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewportContentControl = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const ConfigurableUiControl_1 = require("../configurableui/ConfigurableUiControl");
+const CubeNavigationAidControl_1 = require("../navigationaids/CubeNavigationAidControl");
+const DrawingNavigationAidControl_1 = require("../navigationaids/DrawingNavigationAidControl");
+const SheetNavigationAid_1 = require("../navigationaids/SheetNavigationAid");
+const ViewUtilities_1 = require("../utils/ViewUtilities");
+const ContentControl_1 = require("./ContentControl");
+const ContentViewManager_1 = require("./ContentViewManager");
+/**
+ * The base class for frontstage Viewport content controls that connects to a `ScreenViewport`
+ * that is managed by the `ViewManager`.
+ * @public
+ */
+class ViewportContentControl extends ContentControl_1.ContentControl {
+    /** Creates an instance of ViewportContentControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided via the applicationData in a [[ContentProps]].
+     */
+    constructor(info, options) {
+        super(info, options);
+        /**
+         * Fetches appropriate NavigationAid based on the class of the current viewport.
+         * @param classFullName The full name of the current viewport class.
+         * @returns The ID of the navigation aid to be displayed.
+         */
+        this._getNavigationAid = (classFullName) => {
+            const className = ViewUtilities_1.ViewUtilities.getBisBaseClass(classFullName);
+            let navigationAidId = "";
+            switch (className) {
+                case core_frontend_1.SheetViewState.className:
+                    navigationAidId = SheetNavigationAid_1.SheetNavigationAidControl.navigationAidId;
+                    break;
+                case core_frontend_1.DrawingViewState.className:
+                    navigationAidId = DrawingNavigationAidControl_1.DrawingNavigationAidControl.navigationAidId;
+                    break;
+                case core_frontend_1.SpatialViewState.className:
+                case core_frontend_1.OrthographicViewState.className:
+                    navigationAidId = CubeNavigationAidControl_1.CubeNavigationAidControl.navigationAidId;
+                    break;
+            }
+            return navigationAidId;
+        };
+        this._isReady = new Promise((onSuccess, _onFailure) => {
+            this._viewportReadyCallback = onSuccess;
+        });
+    }
+    /** Gets the type of ConfigurableUiControl, which is 'Viewport' in this case */
+    getType() { return ConfigurableUiControl_1.ConfigurableUiControlType.Viewport; }
+    /** Returns true if this control is a Viewport control. */
+    get isViewport() { return true; }
+    /** The underlying ScreenViewport */
+    get viewport() { return this._viewport; }
+    set viewport(v) {
+        this._viewport = v;
+        this.setIsReady();
+    }
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    setIsReady() {
+        // istanbul ignore else
+        if (this._viewportReadyCallback) {
+            this._viewportReadyCallback();
+        }
+    }
+    /** Returns a promise that resolves when the control is ready for usage.
+     */
+    get isReady() { return this._isReady; }
+    /** Called when this ContentControl is activated */
+    onActivated() {
+        super.onActivated();
+    }
+    /** Get the NavigationAidControl associated with this ContentControl */
+    get navigationAidControl() {
+        let navigationAidId = "";
+        // istanbul ignore else
+        if (this.viewport) {
+            navigationAidId = this._getNavigationAid(this.viewport.view.classFullName);
+        }
+        return navigationAidId;
+    }
+    /** Returns true if this control supports processing ViewSelector changes. */
+    get supportsViewSelectorChange() { return true; }
+    /** Process a ViewSelector change. */
+    // istanbul ignore next
+    async processViewSelectorChange(iModel, viewDefinitionId, viewState, name) {
+        if (this.viewport) {
+            if (core_frontend_1.IModelApp.viewManager && this.viewport === core_frontend_1.IModelApp.viewManager.selectedView)
+                this.viewport.changeView(viewState);
+        }
+        else {
+            this.reactNode = this.getReactElementForViewSelectorChange(iModel, viewDefinitionId, viewState, name);
+        }
+        ContentViewManager_1.ContentViewManager.refreshActiveContent(this.reactNode);
+    }
+    /** Get the React.Element for a ViewSelector change. */
+    // istanbul ignore next
+    getReactElementForViewSelectorChange(_iModel, _viewDefinitionId, _viewState, _name) { return null; }
+}
+exports.ViewportContentControl = ViewportContentControl;
+//# sourceMappingURL=ViewportContentControl.js.map

package/lib/cjs/appui-react/content/ViewportContentControl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ViewportContentControl.js","sourceRoot":"","sources":["../../../../src/appui-react/content/ViewportContentControl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAE8B;AAC9B,mFAA4G;AAC5G,yFAAsF;AACtF,+FAA4F;AAC5F,6EAAiF;AACjF,0DAAuD;AACvD,qDAA8E;AAC9E,6DAA0D;AAE1D;;;;GAIG;AACH,MAAa,sBAAuB,SAAQ,+BAAc;IAKxD;;;OAGG;IACH,YAAY,IAA4B,EAAE,OAAY;QACpD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAkDvB;;;;WAIG;QACK,sBAAiB,GAAG,CAAC,aAAqB,EAAE,EAAE;YACpD,MAAM,SAAS,GAAG,6BAAa,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;YAC/D,IAAI,eAAe,GAAG,EAAE,CAAC;YAEzB,QAAQ,SAAS,EAAE;gBACjB,KAAK,8BAAc,CAAC,SAAS;oBAC3B,eAAe,GAAG,8CAAyB,CAAC,eAAe,CAAC;oBAC5D,MAAM;gBACR,KAAK,gCAAgB,CAAC,SAAS;oBAC7B,eAAe,GAAG,yDAA2B,CAAC,eAAe,CAAC;oBAC9D,MAAM;gBACR,KAAK,gCAAgB,CAAC,SAAS,CAAC;gBAChC,KAAK,qCAAqB,CAAC,SAAS;oBAClC,eAAe,GAAG,mDAAwB,CAAC,eAAe,CAAC;oBAC3D,MAAM;aACT;YAED,OAAO,eAAe,CAAC;QACzB,CAAC,CAAC;QAvEA,IAAI,CAAC,QAAQ,GAAG,IAAI,OAAO,CAAO,CAAC,SAAqB,EAAE,UAAsB,EAAQ,EAAE;YACxF,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,+EAA+E;IAC/D,OAAO,KAAgC,OAAO,iDAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEnG,0DAA0D;IAC1D,IAAoB,UAAU,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAE1D,oCAAoC;IACpC,IAAoB,QAAQ,KAAiC,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACrF,IAAoB,QAAQ,CAAC,CAA6B;QACxD,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;OACG;IACI,UAAU;QACf,uBAAuB;QACvB,IAAI,IAAI,CAAC,sBAAsB,EAAE;YAC/B,IAAI,CAAC,sBAAsB,EAAE,CAAC;SAC/B;IACH,CAAC;IAED;OACG;IACH,IAAoB,OAAO,KAAoB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtE,mDAAmD;IACnC,WAAW;QACzB,KAAK,CAAC,WAAW,EAAE,CAAC;IACtB,CAAC;IAED,uEAAuE;IACvE,IAAoB,oBAAoB;QACtC,IAAI,eAAe,GAAG,EAAE,CAAC;QAEzB,uBAAuB;QACvB,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SAC5E;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IA2BD,6EAA6E;IAC7E,IAAW,0BAA0B,KAAc,OAAO,IAAI,CAAC,CAAC,CAAC;IAEjE,qCAAqC;IACrC,uBAAuB;IAChB,KAAK,CAAC,yBAAyB,CAAC,MAAwB,EAAE,gBAA4B,EAAE,SAAoB,EAAE,IAAY;QAC/H,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,yBAAS,CAAC,WAAW,IAAI,IAAI,CAAC,QAAQ,KAAK,yBAAS,CAAC,WAAW,CAAC,YAAY;gBAC/E,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;SACvC;aAAM;YACL,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,oCAAoC,CAAC,MAAM,EAAE,gBAAgB,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;SACvG;QACD,uCAAkB,CAAC,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1D,CAAC;IAED,uDAAuD;IACvD,uBAAuB;IAChB,oCAAoC,CAAC,OAAyB,EAAE,iBAA6B,EAAE,UAAqB,EAAE,KAAa,IAAqB,OAAO,IAAI,CAAC,CAAC,CAAC;CAC9K;AAvGD,wDAuGC","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 ContentView\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport {\r\n  DrawingViewState, IModelApp, IModelConnection, OrthographicViewState, ScreenViewport, SheetViewState, SpatialViewState, ViewState,\r\n} from \"@itwin/core-frontend\";\r\nimport { ConfigurableCreateInfo, ConfigurableUiControlType } from \"../configurableui/ConfigurableUiControl\";\r\nimport { CubeNavigationAidControl } from \"../navigationaids/CubeNavigationAidControl\";\r\nimport { DrawingNavigationAidControl } from \"../navigationaids/DrawingNavigationAidControl\";\r\nimport { SheetNavigationAidControl } from \"../navigationaids/SheetNavigationAid\";\r\nimport { ViewUtilities } from \"../utils/ViewUtilities\";\r\nimport { ContentControl, SupportsViewSelectorChange } from \"./ContentControl\";\r\nimport { ContentViewManager } from \"./ContentViewManager\";\r\n\r\n/**\r\n * The base class for frontstage Viewport content controls that connects to a `ScreenViewport`\r\n * that is managed by the `ViewManager`.\r\n * @public\r\n */\r\nexport class ViewportContentControl extends ContentControl implements SupportsViewSelectorChange {\r\n  private _viewport: ScreenViewport | undefined;\r\n  private _isReady: Promise<void>;\r\n  private _viewportReadyCallback?: () => void;\r\n\r\n  /** Creates an instance of ViewportContentControl.\r\n   * @param info         An object that the subclass must pass to this base class.\r\n   * @param options      Options provided via the applicationData in a [[ContentProps]].\r\n   */\r\n  constructor(info: ConfigurableCreateInfo, options: any) {\r\n    super(info, options);\r\n\r\n    this._isReady = new Promise<void>((onSuccess: () => void, _onFailure: () => void): void => {\r\n      this._viewportReadyCallback = onSuccess;\r\n    });\r\n  }\r\n\r\n  /** Gets the type of ConfigurableUiControl, which is 'Viewport' in this case */\r\n  public override getType(): ConfigurableUiControlType { return ConfigurableUiControlType.Viewport; }\r\n\r\n  /** Returns true if this control is a Viewport control. */\r\n  public override get isViewport(): boolean { return true; }\r\n\r\n  /** The underlying ScreenViewport */\r\n  public override get viewport(): ScreenViewport | undefined { return this._viewport; }\r\n  public override set viewport(v: ScreenViewport | undefined) {\r\n    this._viewport = v;\r\n    this.setIsReady();\r\n  }\r\n\r\n  /** Returns a promise that resolves when the control is ready for usage.\r\n   */\r\n  public setIsReady(): void {\r\n    // istanbul ignore else\r\n    if (this._viewportReadyCallback) {\r\n      this._viewportReadyCallback();\r\n    }\r\n  }\r\n\r\n  /** Returns a promise that resolves when the control is ready for usage.\r\n   */\r\n  public override get isReady(): Promise<void> { return this._isReady; }\r\n\r\n  /** Called when this ContentControl is activated */\r\n  public override onActivated(): void {\r\n    super.onActivated();\r\n  }\r\n\r\n  /** Get the NavigationAidControl associated with this ContentControl */\r\n  public override get navigationAidControl(): string {\r\n    let navigationAidId = \"\";\r\n\r\n    // istanbul ignore else\r\n    if (this.viewport) {\r\n      navigationAidId = this._getNavigationAid(this.viewport.view.classFullName);\r\n    }\r\n\r\n    return navigationAidId;\r\n  }\r\n\r\n  /**\r\n   * Fetches appropriate NavigationAid based on the class of the current viewport.\r\n   * @param classFullName The full name of the current viewport class.\r\n   * @returns The ID of the navigation aid to be displayed.\r\n   */\r\n  private _getNavigationAid = (classFullName: string) => {\r\n    const className = ViewUtilities.getBisBaseClass(classFullName);\r\n    let navigationAidId = \"\";\r\n\r\n    switch (className) {\r\n      case SheetViewState.className:\r\n        navigationAidId = SheetNavigationAidControl.navigationAidId;\r\n        break;\r\n      case DrawingViewState.className:\r\n        navigationAidId = DrawingNavigationAidControl.navigationAidId;\r\n        break;\r\n      case SpatialViewState.className:\r\n      case OrthographicViewState.className:\r\n        navigationAidId = CubeNavigationAidControl.navigationAidId;\r\n        break;\r\n    }\r\n\r\n    return navigationAidId;\r\n  };\r\n\r\n  /** Returns true if this control supports processing ViewSelector changes. */\r\n  public get supportsViewSelectorChange(): boolean { return true; }\r\n\r\n  /** Process a ViewSelector change. */\r\n  // istanbul ignore next\r\n  public async processViewSelectorChange(iModel: IModelConnection, viewDefinitionId: Id64String, viewState: ViewState, name: string): Promise<void> {\r\n    if (this.viewport) {\r\n      if (IModelApp.viewManager && this.viewport === IModelApp.viewManager.selectedView)\r\n        this.viewport.changeView(viewState);\r\n    } else {\r\n      this.reactNode = this.getReactElementForViewSelectorChange(iModel, viewDefinitionId, viewState, name);\r\n    }\r\n    ContentViewManager.refreshActiveContent(this.reactNode);\r\n  }\r\n\r\n  /** Get the React.Element for a ViewSelector change. */\r\n  // istanbul ignore next\r\n  public getReactElementForViewSelectorChange(_iModel: IModelConnection, _viewDefinitionId: Id64String, _viewState: ViewState, _name: string): React.ReactNode { return null; }\r\n}\r\n"]}

package/lib/cjs/appui-react/cursor/CursorInformation.d.ts

@@ -0,0 +1,70 @@
+/** @packageDocumentation
+ * @module Cursor
+ */
+import { PointProps, RelativePosition } from "@itwin/appui-abstract";
+import { UiEvent } from "@itwin/core-react";
+/** Enum for Cursor Direction parts
+ *  @public
+ */
+export declare enum CursorDirectionParts {
+    Top = 4096,
+    Left = 256,
+    Right = 16,
+    Bottom = 1
+}
+/** Enum for Cursor Direction
+ * @public
+ */
+export declare enum CursorDirection {
+    None = 0,
+    Top = 4096,
+    Left = 256,
+    Right = 16,
+    Bottom = 1,
+    TopLeft = 4352,
+    TopRight = 4112,
+    BottomLeft = 257,
+    BottomRight = 17
+}
+/** Cursor Updated Event Args interface.
+ * @public
+ */
+export interface CursorUpdatedEventArgs {
+    oldPt: PointProps;
+    newPt: PointProps;
+    direction: CursorDirection;
+}
+/** Cursor Updated Event class.
+ * @public
+ */
+export declare class CursorUpdatedEvent extends UiEvent<CursorUpdatedEventArgs> {
+}
+/** Cursor Information class
+ * @public
+ */
+export declare class CursorInformation {
+    private static _cursorPosition;
+    private static _cursorDirection;
+    private static _cursorDirections;
+    /** The cursor position. */
+    static get cursorPosition(): PointProps;
+    static set cursorPosition(pt: PointProps);
+    /** Gets the cursor X position. */
+    static get cursorX(): number;
+    /** Gets the cursor Y position. */
+    static get cursorY(): number;
+    /** Gets the general cursor movement direction. */
+    static get cursorDirection(): CursorDirection;
+    /** Gets the [[CursorUpdatedEvent]]. */
+    static readonly onCursorUpdatedEvent: CursorUpdatedEvent;
+    /** Handles the mouse movement.  Sets the cursor position and direction and emits onCursorUpdatedEvent. */
+    static handleMouseMove(point: PointProps): void;
+    private static _determineMostFrequentDirection;
+    private static _mostFrequent;
+    private static _determineCursorDirection;
+    /** Gets the relative position based on the cursor direction. */
+    static getRelativePositionFromCursorDirection(cursorDirection: CursorDirection): RelativePosition;
+    /** @internal - for testing */
+    static clearCursorDirections(): void;
+}
+//# sourceMappingURL=CursorInformation.d.ts.map

package/lib/cjs/appui-react/cursor/CursorInformation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CursorInformation.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/cursor/CursorInformation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAS,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,GAAG,OAAS;IACZ,IAAI,MAAS;IACb,KAAK,KAAS;IACd,MAAM,IAAS;CAChB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,IAAI,IAAI;IACR,GAAG,OAA2B;IAC9B,IAAI,MAA4B;IAChC,KAAK,KAA6B;IAClC,MAAM,IAA8B;IACpC,OAAO,OAAuD;IAC9D,QAAQ,OAAwD;IAChE,UAAU,MAA0D;IACpE,WAAW,KAA2D;CACvE;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,UAAU,CAAC;IAClB,KAAK,EAAE,UAAU,CAAC;IAClB,SAAS,EAAE,eAAe,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,sBAAsB,CAAC;CAAI;AAE3E;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAC,eAAe,CAAsB;IACpD,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgD;IAE/E,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAgC;IAEhE,2BAA2B;IAC3B,WAAkB,cAAc,IAAI,UAAU,CAAiC;IAC/E,WAAkB,cAAc,CAAC,EAAE,EAAE,UAAU,EAA8C;IAE7F,kCAAkC;IAClC,WAAkB,OAAO,IAAI,MAAM,CAAmC;IACtE,kCAAkC;IAClC,WAAkB,OAAO,IAAI,MAAM,CAAmC;IAEtE,kDAAkD;IAClD,WAAkB,eAAe,IAAI,eAAe,CAAkC;IAEtF,uCAAuC;IACvC,gBAAuB,oBAAoB,qBAA4B;IAEvE,0GAA0G;WAC5F,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAUtD,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAQ9C,OAAO,CAAC,MAAM,CAAC,aAAa;IAwB5B,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAkBxC,gEAAgE;WAClD,sCAAsC,CAAC,eAAe,EAAE,eAAe,GAAG,gBAAgB;IAiCxG,8BAA8B;WAChB,qBAAqB,IAAI,IAAI;CAG5C"}

package/lib/cjs/appui-react/cursor/CursorInformation.js

@@ -0,0 +1,145 @@
+"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 Cursor
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CursorInformation = exports.CursorUpdatedEvent = exports.CursorDirection = exports.CursorDirectionParts = void 0;
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const core_react_1 = require("@itwin/core-react");
+/** Enum for Cursor Direction parts
+ *  @public
+ */
+var CursorDirectionParts;
+(function (CursorDirectionParts) {
+    CursorDirectionParts[CursorDirectionParts["Top"] = 4096] = "Top";
+    CursorDirectionParts[CursorDirectionParts["Left"] = 256] = "Left";
+    CursorDirectionParts[CursorDirectionParts["Right"] = 16] = "Right";
+    CursorDirectionParts[CursorDirectionParts["Bottom"] = 1] = "Bottom";
+})(CursorDirectionParts = exports.CursorDirectionParts || (exports.CursorDirectionParts = {}));
+/** Enum for Cursor Direction
+ * @public
+ */
+var CursorDirection;
+(function (CursorDirection) {
+    CursorDirection[CursorDirection["None"] = 0] = "None";
+    CursorDirection[CursorDirection["Top"] = 4096] = "Top";
+    CursorDirection[CursorDirection["Left"] = 256] = "Left";
+    CursorDirection[CursorDirection["Right"] = 16] = "Right";
+    CursorDirection[CursorDirection["Bottom"] = 1] = "Bottom";
+    CursorDirection[CursorDirection["TopLeft"] = 4352] = "TopLeft";
+    CursorDirection[CursorDirection["TopRight"] = 4112] = "TopRight";
+    CursorDirection[CursorDirection["BottomLeft"] = 257] = "BottomLeft";
+    CursorDirection[CursorDirection["BottomRight"] = 17] = "BottomRight";
+})(CursorDirection = exports.CursorDirection || (exports.CursorDirection = {}));
+/** Cursor Updated Event class.
+ * @public
+ */
+class CursorUpdatedEvent extends core_react_1.UiEvent {
+}
+exports.CursorUpdatedEvent = CursorUpdatedEvent;
+/** Cursor Information class
+ * @public
+ */
+class CursorInformation {
+    /** The cursor position. */
+    static get cursorPosition() { return this._cursorPosition; }
+    static set cursorPosition(pt) { this._cursorPosition = core_react_1.Point.create(pt); }
+    /** Gets the cursor X position. */
+    static get cursorX() { return this._cursorPosition.x; }
+    /** Gets the cursor Y position. */
+    static get cursorY() { return this._cursorPosition.y; }
+    /** Gets the general cursor movement direction. */
+    static get cursorDirection() { return this._cursorDirection; }
+    /** Handles the mouse movement.  Sets the cursor position and direction and emits onCursorUpdatedEvent. */
+    static handleMouseMove(point) {
+        const oldPt = CursorInformation.cursorPosition;
+        const direction = this._determineMostFrequentDirection(this._cursorDirections, this._cursorPosition, core_react_1.Point.create(point));
+        this.cursorPosition = point;
+        this._cursorDirection = direction;
+        this.onCursorUpdatedEvent.emit({ oldPt, newPt: point, direction });
+    }
+    static _determineMostFrequentDirection(cursorDirections, oldPt, newPt) {
+        const cursorDirection = this._determineCursorDirection(oldPt, newPt);
+        cursorDirections.push(cursorDirection);
+        if (cursorDirections.length > 10)
+            cursorDirections.shift();
+        return this._mostFrequent(cursorDirections);
+    }
+    static _mostFrequent(array) {
+        const hashMap = new Map();
+        let maxCount = 0, mostFrequent = CursorDirection.None;
+        array.forEach((value) => {
+            const key = value;
+            let frequency = hashMap.get(key);
+            if (frequency !== undefined)
+                frequency++;
+            else
+                frequency = 1;
+            hashMap.set(key, frequency);
+            if (frequency > maxCount) {
+                mostFrequent = key;
+                maxCount = frequency;
+            }
+        });
+        return mostFrequent;
+    }
+    static _determineCursorDirection(oldPt, newPt) {
+        let directionParts = 0;
+        if (newPt.x < oldPt.x)
+            directionParts |= CursorDirectionParts.Left;
+        else if (newPt.x > oldPt.x)
+            directionParts |= CursorDirectionParts.Right;
+        if (newPt.y < oldPt.y)
+            directionParts |= CursorDirectionParts.Top;
+        else if (newPt.y > oldPt.y)
+            directionParts |= CursorDirectionParts.Bottom;
+        const direction = directionParts;
+        return direction;
+    }
+    /** Gets the relative position based on the cursor direction. */
+    static getRelativePositionFromCursorDirection(cursorDirection) {
+        let relativePosition = appui_abstract_1.RelativePosition.BottomRight;
+        switch (cursorDirection) {
+            case CursorDirection.Top:
+                relativePosition = appui_abstract_1.RelativePosition.Top;
+                break;
+            case CursorDirection.Left:
+                relativePosition = appui_abstract_1.RelativePosition.Left;
+                break;
+            case CursorDirection.Right:
+                relativePosition = appui_abstract_1.RelativePosition.Right;
+                break;
+            case CursorDirection.Bottom:
+                relativePosition = appui_abstract_1.RelativePosition.Bottom;
+                break;
+            case CursorDirection.TopLeft:
+                relativePosition = appui_abstract_1.RelativePosition.TopLeft;
+                break;
+            case CursorDirection.TopRight:
+                relativePosition = appui_abstract_1.RelativePosition.TopRight;
+                break;
+            case CursorDirection.BottomLeft:
+                relativePosition = appui_abstract_1.RelativePosition.BottomLeft;
+                break;
+            case CursorDirection.BottomRight:
+                relativePosition = appui_abstract_1.RelativePosition.BottomRight;
+                break;
+        }
+        return relativePosition;
+    }
+    /** @internal - for testing */
+    static clearCursorDirections() {
+        this._cursorDirections.length = 0;
+    }
+}
+exports.CursorInformation = CursorInformation;
+CursorInformation._cursorPosition = new core_react_1.Point();
+CursorInformation._cursorDirection = CursorDirection.BottomRight;
+CursorInformation._cursorDirections = new Array();
+/** Gets the [[CursorUpdatedEvent]]. */
+CursorInformation.onCursorUpdatedEvent = new CursorUpdatedEvent();
+//# sourceMappingURL=CursorInformation.js.map

package/lib/cjs/appui-react/cursor/CursorInformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CursorInformation.js","sourceRoot":"","sources":["../../../../src/appui-react/cursor/CursorInformation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAqE;AACrE,kDAAmD;AAEnD;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,gEAAY,CAAA;IACZ,iEAAa,CAAA;IACb,kEAAc,CAAA;IACd,mEAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAED;;GAEG;AACH,IAAY,eAUX;AAVD,WAAY,eAAe;IACzB,qDAAQ,CAAA;IACR,sDAA8B,CAAA;IAC9B,uDAAgC,CAAA;IAChC,wDAAkC,CAAA;IAClC,yDAAoC,CAAA;IACpC,8DAA8D,CAAA;IAC9D,gEAAgE,CAAA;IAChE,mEAAoE,CAAA;IACpE,oEAAsE,CAAA;AACxE,CAAC,EAVW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAU1B;AAWD;;GAEG;AACH,MAAa,kBAAmB,SAAQ,oBAA+B;CAAI;AAA3E,gDAA2E;AAE3E;;GAEG;AACH,MAAa,iBAAiB;IAM5B,2BAA2B;IACpB,MAAM,KAAK,cAAc,KAAiB,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IACxE,MAAM,KAAK,cAAc,CAAC,EAAc,IAAI,IAAI,CAAC,eAAe,GAAG,kBAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE7F,kCAAkC;IAC3B,MAAM,KAAK,OAAO,KAAa,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,kCAAkC;IAC3B,MAAM,KAAK,OAAO,KAAa,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtE,kDAAkD;IAC3C,MAAM,KAAK,eAAe,KAAsB,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAKtF,0GAA0G;IACnG,MAAM,CAAC,eAAe,CAAC,KAAiB;QAC7C,MAAM,KAAK,GAAG,iBAAiB,CAAC,cAAc,CAAC;QAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,eAAe,EAAE,kBAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAE1H,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;QAC5B,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAElC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACrE,CAAC;IAEO,MAAM,CAAC,+BAA+B,CAAC,gBAAmC,EAAE,KAAY,EAAE,KAAY;QAC5G,MAAM,eAAe,GAAG,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACvC,IAAI,gBAAgB,CAAC,MAAM,GAAG,EAAE;YAC9B,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAC9C,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,KAAwB;QACnD,MAAM,OAAO,GAAG,IAAI,GAAG,EAA2B,CAAC;QACnD,IAAI,QAAQ,GAAG,CAAC,EAAE,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC;QAEtD,KAAK,CAAC,OAAO,CAAC,CAAC,KAAsB,EAAE,EAAE;YACvC,MAAM,GAAG,GAAG,KAAK,CAAC;YAClB,IAAI,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAEjC,IAAI,SAAS,KAAK,SAAS;gBACzB,SAAS,EAAE,CAAC;;gBAEZ,SAAS,GAAG,CAAC,CAAC;YAEhB,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAE5B,IAAI,SAAS,GAAG,QAAQ,EAAE;gBACxB,YAAY,GAAG,GAAG,CAAC;gBACnB,QAAQ,GAAG,SAAS,CAAC;aACtB;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACtB,CAAC;IAEO,MAAM,CAAC,yBAAyB,CAAC,KAAY,EAAE,KAAY;QACjE,IAAI,cAAc,GAAW,CAAC,CAAC;QAE/B,IAAI,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;YACnB,cAAc,IAAI,oBAAoB,CAAC,IAAI,CAAC;aACzC,IAAI,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;YACxB,cAAc,IAAI,oBAAoB,CAAC,KAAK,CAAC;QAE/C,IAAI,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;YACnB,cAAc,IAAI,oBAAoB,CAAC,GAAG,CAAC;aACxC,IAAI,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;YACxB,cAAc,IAAI,oBAAoB,CAAC,MAAM,CAAC;QAEhD,MAAM,SAAS,GAAG,cAAiC,CAAC;QAEpD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,sCAAsC,CAAC,eAAgC;QACnF,IAAI,gBAAgB,GAAqB,iCAAgB,CAAC,WAAW,CAAC;QAEtE,QAAQ,eAAe,EAAE;YACvB,KAAK,eAAe,CAAC,GAAG;gBACtB,gBAAgB,GAAG,iCAAgB,CAAC,GAAG,CAAC;gBACxC,MAAM;YACR,KAAK,eAAe,CAAC,IAAI;gBACvB,gBAAgB,GAAG,iCAAgB,CAAC,IAAI,CAAC;gBACzC,MAAM;YACR,KAAK,eAAe,CAAC,KAAK;gBACxB,gBAAgB,GAAG,iCAAgB,CAAC,KAAK,CAAC;gBAC1C,MAAM;YACR,KAAK,eAAe,CAAC,MAAM;gBACzB,gBAAgB,GAAG,iCAAgB,CAAC,MAAM,CAAC;gBAC3C,MAAM;YACR,KAAK,eAAe,CAAC,OAAO;gBAC1B,gBAAgB,GAAG,iCAAgB,CAAC,OAAO,CAAC;gBAC5C,MAAM;YACR,KAAK,eAAe,CAAC,QAAQ;gBAC3B,gBAAgB,GAAG,iCAAgB,CAAC,QAAQ,CAAC;gBAC7C,MAAM;YACR,KAAK,eAAe,CAAC,UAAU;gBAC7B,gBAAgB,GAAG,iCAAgB,CAAC,UAAU,CAAC;gBAC/C,MAAM;YACR,KAAK,eAAe,CAAC,WAAW;gBAC9B,gBAAgB,GAAG,iCAAgB,CAAC,WAAW,CAAC;gBAChD,MAAM;SACT;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,qBAAqB;QACjC,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;IACpC,CAAC;;AAvHH,8CAwHC;AAvHgB,iCAAe,GAAU,IAAI,kBAAK,EAAE,CAAC;AACrC,kCAAgB,GAAoB,eAAe,CAAC,WAAW,CAAC;AAEhE,mCAAiB,GAAG,IAAI,KAAK,EAAmB,CAAC;AAchE,uCAAuC;AAChB,sCAAoB,GAAG,IAAI,kBAAkB,EAAE,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 Cursor\r\n */\r\n\r\nimport { PointProps, RelativePosition } from \"@itwin/appui-abstract\";\r\nimport { Point, UiEvent } from \"@itwin/core-react\";\r\n\r\n/** Enum for Cursor Direction parts\r\n *  @public\r\n */\r\nexport enum CursorDirectionParts {\r\n  Top = 0x1000,\r\n  Left = 0x0100,\r\n  Right = 0x0010,\r\n  Bottom = 0x0001,\r\n}\r\n\r\n/** Enum for Cursor Direction\r\n * @public\r\n */\r\nexport enum CursorDirection {\r\n  None = 0,\r\n  Top = CursorDirectionParts.Top,\r\n  Left = CursorDirectionParts.Left,\r\n  Right = CursorDirectionParts.Right,\r\n  Bottom = CursorDirectionParts.Bottom,\r\n  TopLeft = CursorDirectionParts.Top | CursorDirectionParts.Left,\r\n  TopRight = CursorDirectionParts.Top | CursorDirectionParts.Right,\r\n  BottomLeft = CursorDirectionParts.Bottom | CursorDirectionParts.Left,\r\n  BottomRight = CursorDirectionParts.Bottom | CursorDirectionParts.Right,\r\n}\r\n\r\n/** Cursor Updated Event Args interface.\r\n * @public\r\n */\r\nexport interface CursorUpdatedEventArgs {\r\n  oldPt: PointProps;\r\n  newPt: PointProps;\r\n  direction: CursorDirection;\r\n}\r\n\r\n/** Cursor Updated Event class.\r\n * @public\r\n */\r\nexport class CursorUpdatedEvent extends UiEvent<CursorUpdatedEventArgs> { }\r\n\r\n/** Cursor Information class\r\n * @public\r\n */\r\nexport class CursorInformation {\r\n  private static _cursorPosition: Point = new Point();\r\n  private static _cursorDirection: CursorDirection = CursorDirection.BottomRight;\r\n\r\n  private static _cursorDirections = new Array<CursorDirection>();\r\n\r\n  /** The cursor position. */\r\n  public static get cursorPosition(): PointProps { return this._cursorPosition; }\r\n  public static set cursorPosition(pt: PointProps) { this._cursorPosition = Point.create(pt); }\r\n\r\n  /** Gets the cursor X position. */\r\n  public static get cursorX(): number { return this._cursorPosition.x; }\r\n  /** Gets the cursor Y position. */\r\n  public static get cursorY(): number { return this._cursorPosition.y; }\r\n\r\n  /** Gets the general cursor movement direction. */\r\n  public static get cursorDirection(): CursorDirection { return this._cursorDirection; }\r\n\r\n  /** Gets the [[CursorUpdatedEvent]]. */\r\n  public static readonly onCursorUpdatedEvent = new CursorUpdatedEvent();\r\n\r\n  /** Handles the mouse movement.  Sets the cursor position and direction and emits onCursorUpdatedEvent. */\r\n  public static handleMouseMove(point: PointProps): void {\r\n    const oldPt = CursorInformation.cursorPosition;\r\n    const direction = this._determineMostFrequentDirection(this._cursorDirections, this._cursorPosition, Point.create(point));\r\n\r\n    this.cursorPosition = point;\r\n    this._cursorDirection = direction;\r\n\r\n    this.onCursorUpdatedEvent.emit({ oldPt, newPt: point, direction });\r\n  }\r\n\r\n  private static _determineMostFrequentDirection(cursorDirections: CursorDirection[], oldPt: Point, newPt: Point): CursorDirection {\r\n    const cursorDirection = this._determineCursorDirection(oldPt, newPt);\r\n    cursorDirections.push(cursorDirection);\r\n    if (cursorDirections.length > 10)\r\n      cursorDirections.shift();\r\n    return this._mostFrequent(cursorDirections);\r\n  }\r\n\r\n  private static _mostFrequent(array: CursorDirection[]): CursorDirection {\r\n    const hashMap = new Map<CursorDirection, number>();\r\n    let maxCount = 0, mostFrequent = CursorDirection.None;\r\n\r\n    array.forEach((value: CursorDirection) => {\r\n      const key = value;\r\n      let frequency = hashMap.get(key);\r\n\r\n      if (frequency !== undefined)\r\n        frequency++;\r\n      else\r\n        frequency = 1;\r\n\r\n      hashMap.set(key, frequency);\r\n\r\n      if (frequency > maxCount) {\r\n        mostFrequent = key;\r\n        maxCount = frequency;\r\n      }\r\n    });\r\n\r\n    return mostFrequent;\r\n  }\r\n\r\n  private static _determineCursorDirection(oldPt: Point, newPt: Point): CursorDirection {\r\n    let directionParts: number = 0;\r\n\r\n    if (newPt.x < oldPt.x)\r\n      directionParts |= CursorDirectionParts.Left;\r\n    else if (newPt.x > oldPt.x)\r\n      directionParts |= CursorDirectionParts.Right;\r\n\r\n    if (newPt.y < oldPt.y)\r\n      directionParts |= CursorDirectionParts.Top;\r\n    else if (newPt.y > oldPt.y)\r\n      directionParts |= CursorDirectionParts.Bottom;\r\n\r\n    const direction = directionParts as CursorDirection;\r\n\r\n    return direction;\r\n  }\r\n\r\n  /** Gets the relative position based on the cursor direction. */\r\n  public static getRelativePositionFromCursorDirection(cursorDirection: CursorDirection): RelativePosition {\r\n    let relativePosition: RelativePosition = RelativePosition.BottomRight;\r\n\r\n    switch (cursorDirection) {\r\n      case CursorDirection.Top:\r\n        relativePosition = RelativePosition.Top;\r\n        break;\r\n      case CursorDirection.Left:\r\n        relativePosition = RelativePosition.Left;\r\n        break;\r\n      case CursorDirection.Right:\r\n        relativePosition = RelativePosition.Right;\r\n        break;\r\n      case CursorDirection.Bottom:\r\n        relativePosition = RelativePosition.Bottom;\r\n        break;\r\n      case CursorDirection.TopLeft:\r\n        relativePosition = RelativePosition.TopLeft;\r\n        break;\r\n      case CursorDirection.TopRight:\r\n        relativePosition = RelativePosition.TopRight;\r\n        break;\r\n      case CursorDirection.BottomLeft:\r\n        relativePosition = RelativePosition.BottomLeft;\r\n        break;\r\n      case CursorDirection.BottomRight:\r\n        relativePosition = RelativePosition.BottomRight;\r\n        break;\r\n    }\r\n\r\n    return relativePosition;\r\n  }\r\n\r\n  /** @internal - for testing */\r\n  public static clearCursorDirections(): void {\r\n    this._cursorDirections.length = 0;\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/cursor/cursormenu/CursorMenu.d.ts

@@ -0,0 +1,33 @@
+/** @packageDocumentation
+ * @module Cursor
+ */
+import * as React from "react";
+import { CommonProps } from "@itwin/core-react";
+import { MenuItemProps } from "../../shared/MenuItem";
+/** State for [[CursorPopupMenu]] component
+ * @alpha
+ */
+interface CursorPopupMenuState {
+    menuX: number;
+    menuY: number;
+    menuVisible: boolean;
+    items?: MenuItemProps[];
+}
+/** Popup Menu to show at cursor typically used by tools to provide a right-click context menu.
+ * @alpha
+ */
+export declare class CursorPopupMenu extends React.PureComponent<CommonProps, CursorPopupMenuState> {
+    private _componentUnmounting;
+    private _hostChildWindowId?;
+    /** @internal */
+    readonly state: CursorPopupMenuState;
+    private _handleSyncUiEvent;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _handleRefSet;
+    render(): React.ReactNode;
+    private _hideContextMenu;
+    private _itemPicked;
+}
+export {};
+//# sourceMappingURL=CursorMenu.d.ts.map

package/lib/cjs/appui-react/cursor/cursormenu/CursorMenu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CursorMenu.d.ts","sourceRoot":"","sources":["../../../../../src/appui-react/cursor/cursormenu/CursorMenu.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAqB,MAAM,mBAAmB,CAAC;AAEnE,OAAO,EAAmB,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAKvE;;GAEG;AACH,UAAU,oBAAoB;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;CACzB;AAED;;GAEG;AAEH,qBAAa,eAAgB,SAAQ,KAAK,CAAC,aAAa,CAAC,WAAW,EAAE,oBAAoB,CAAC;IACzF,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,kBAAkB,CAAC,CAAS;IAEpC,gBAAgB;IAChB,SAAyB,KAAK,EAAE,oBAAoB,CAKlD;IAEF,OAAO,CAAC,kBAAkB,CAcxB;IAEc,iBAAiB;IAIjB,oBAAoB;IAKpC,OAAO,CAAC,aAAa,CAKnB;IAEc,MAAM,IAAI,KAAK,CAAC,SAAS;IA0BzC,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,WAAW,CAEjB;CACH"}

package/lib/cjs/appui-react/cursor/cursormenu/CursorMenu.js

@@ -0,0 +1,77 @@
+"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 Cursor
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CursorPopupMenu = void 0;
+const React = require("react");
+const core_react_1 = require("@itwin/core-react"); // ContextSubMenu,
+const SessionState_1 = require("../../redux/SessionState");
+const MenuItem_1 = require("../../shared/MenuItem");
+const SyncUiEventDispatcher_1 = require("../../syncui/SyncUiEventDispatcher");
+const UiFramework_1 = require("../../UiFramework");
+const core_bentley_1 = require("@itwin/core-bentley");
+/** Popup Menu to show at cursor typically used by tools to provide a right-click context menu.
+ * @alpha
+ */
+// istanbul ignore next
+class CursorPopupMenu extends React.PureComponent {
+    constructor() {
+        super(...arguments);
+        this._componentUnmounting = false; // used to ensure _handleSyncUiEvent callback is not processed after componentWillUnmount is called
+        /** @internal */
+        this.state = {
+            menuX: 0,
+            menuY: 0,
+            menuVisible: false,
+            items: undefined,
+        };
+        this._handleSyncUiEvent = (args) => {
+            /* istanbul ignore next */
+            if (this._componentUnmounting)
+                return;
+            /* istanbul ignore else */
+            if (SyncUiEventDispatcher_1.SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [SessionState_1.SessionStateActionId.UpdateCursorMenu])) {
+                const menuData = UiFramework_1.UiFramework.getCursorMenuData();
+                if (menuData && this._hostChildWindowId === menuData.childWindowId) {
+                    this.setState({ menuVisible: menuData.items && menuData.items.length > 0, items: menuData.items, menuX: menuData.position.x, menuY: menuData.position.y });
+                }
+                else {
+                    this.setState({ menuVisible: false, items: undefined });
+                }
+            }
+        };
+        this._handleRefSet = (popupDiv) => {
+            var _a, _b;
+            const parentWindow = (_a = popupDiv === null || popupDiv === void 0 ? void 0 : popupDiv.ownerDocument.defaultView) !== null && _a !== void 0 ? _a : undefined;
+            // if the window is not a pop out set to undefined
+            this._hostChildWindowId = UiFramework_1.UiFramework.childWindowManager.findChildWindowId(parentWindow);
+            core_bentley_1.Logger.logInfo(UiFramework_1.UiFramework.loggerCategory(UiFramework_1.UiFramework), `Cursor Menu for ${(_b = this._hostChildWindowId) !== null && _b !== void 0 ? _b : "main"} window`);
+        };
+        this._hideContextMenu = () => {
+            this.setState({ menuVisible: false });
+        };
+        this._itemPicked = () => {
+            this._hideContextMenu();
+        };
+    }
+    componentDidMount() {
+        SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);
+    }
+    componentWillUnmount() {
+        this._componentUnmounting = true;
+        SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleSyncUiEvent);
+    }
+    render() {
+        const { menuX, menuY, items, menuVisible } = this.state;
+        const onClose = this._hideContextMenu;
+        return (React.createElement("div", { className: "uifw-cursor-menu-container-div", ref: this._handleRefSet }, items && items.length > 0 && menuVisible &&
+            React.createElement(core_react_1.GlobalContextMenu, { className: this.props.className, style: this.props.style, identifier: "cursor-popup-menu", x: menuX, y: menuY, opened: menuVisible, onEsc: onClose, onOutsideClick: onClose, edgeLimit: false, autoflip: true }, MenuItem_1.MenuItemHelpers.createMenuItemNodes(MenuItem_1.MenuItemHelpers.createMenuItems(items, this._itemPicked)))));
+    }
+}
+exports.CursorPopupMenu = CursorPopupMenu;
+//# sourceMappingURL=CursorMenu.js.map

package/lib/cjs/appui-react/cursor/cursormenu/CursorMenu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CursorMenu.js","sourceRoot":"","sources":["../../../../../src/appui-react/cursor/cursormenu/CursorMenu.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,kDAAmE,CAAC,kBAAkB;AACtF,2DAAgE;AAChE,oDAAuE;AACvE,8EAA4F;AAC5F,mDAAgD;AAChD,sDAA6C;AAY7C;;GAEG;AACH,uBAAuB;AACvB,MAAa,eAAgB,SAAQ,KAAK,CAAC,aAAgD;IAA3F;;QACU,yBAAoB,GAAG,KAAK,CAAC,CAAE,mGAAmG;QAG1I,gBAAgB;QACS,UAAK,GAAyB;YACrD,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,SAAS;SACjB,CAAC;QAEM,uBAAkB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YAC3D,0BAA0B;YAC1B,IAAI,IAAI,CAAC,oBAAoB;gBAC3B,OAAO;YAET,0BAA0B;YAC1B,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,mCAAoB,CAAC,gBAAgB,CAAC,CAAC,EAAE;gBACpG,MAAM,QAAQ,GAAG,yBAAW,CAAC,iBAAiB,EAAE,CAAC;gBACjD,IAAI,QAAQ,IAAI,IAAI,CAAC,kBAAkB,KAAK,QAAQ,CAAC,aAAa,EAAE;oBAClE,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;iBAC5J;qBAAM;oBACL,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;iBACzD;aACF;QACH,CAAC,CAAC;QAWM,kBAAa,GAAG,CAAC,QAA4B,EAAE,EAAE;;YACvD,MAAM,YAAY,GAAG,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,aAAa,CAAC,WAAW,mCAAI,SAAS,CAAC;YACtE,kDAAkD;YAClD,IAAI,CAAC,kBAAkB,GAAG,yBAAW,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YACzF,qBAAM,CAAC,OAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,yBAAW,CAAC,EAAE,mBAAmB,MAAA,IAAI,CAAC,kBAAkB,mCAAI,MAAM,SAAS,CAAC,CAAC;QACzH,CAAC,CAAC;QA4BM,qBAAgB,GAAG,GAAG,EAAE;YAC9B,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC;QAEM,gBAAW,GAAG,GAAS,EAAE;YAC/B,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC;IAjDiB,iBAAiB;QAC/B,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC3E,CAAC;IAEe,oBAAoB;QAClC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,6CAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC9E,CAAC;IASe,MAAM;QACpB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAEtC,OAAO,CACL,6BAAK,SAAS,EAAC,gCAAgC,EAAC,GAAG,EAAE,IAAI,CAAC,aAAa,IACpE,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,WAAW;YACvC,oBAAC,8BAAiB,IAChB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,UAAU,EAAC,mBAAmB,EAC9B,CAAC,EAAE,KAAK,EACR,CAAC,EAAE,KAAK,EACR,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,OAAO,EACvB,SAAS,EAAE,KAAK,EAChB,QAAQ,EAAE,IAAI,IAEb,0BAAe,CAAC,mBAAmB,CAAC,0BAAe,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAC5E,CAElB,CACP,CAAC;IACJ,CAAC;CASF;AA7ED,0CA6EC","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 Cursor\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonProps, GlobalContextMenu } from \"@itwin/core-react\"; // ContextSubMenu,\r\nimport { SessionStateActionId } from \"../../redux/SessionState\";\r\nimport { MenuItemHelpers, MenuItemProps } from \"../../shared/MenuItem\";\r\nimport { SyncUiEventArgs, SyncUiEventDispatcher } from \"../../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework } from \"../../UiFramework\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\n\r\n/** State for [[CursorPopupMenu]] component\r\n * @alpha\r\n */\r\ninterface CursorPopupMenuState {\r\n  menuX: number;\r\n  menuY: number;\r\n  menuVisible: boolean;\r\n  items?: MenuItemProps[];\r\n}\r\n\r\n/** Popup Menu to show at cursor typically used by tools to provide a right-click context menu.\r\n * @alpha\r\n */\r\n// istanbul ignore next\r\nexport class CursorPopupMenu extends React.PureComponent<CommonProps, CursorPopupMenuState> {\r\n  private _componentUnmounting = false;  // used to ensure _handleSyncUiEvent callback is not processed after componentWillUnmount is called\r\n  private _hostChildWindowId?: string;\r\n\r\n  /** @internal */\r\n  public override readonly state: CursorPopupMenuState = {\r\n    menuX: 0,\r\n    menuY: 0,\r\n    menuVisible: false,\r\n    items: undefined,\r\n  };\r\n\r\n  private _handleSyncUiEvent = (args: SyncUiEventArgs): void => {\r\n    /* istanbul ignore next */\r\n    if (this._componentUnmounting)\r\n      return;\r\n\r\n    /* istanbul ignore else */\r\n    if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [SessionStateActionId.UpdateCursorMenu])) {\r\n      const menuData = UiFramework.getCursorMenuData();\r\n      if (menuData && this._hostChildWindowId === menuData.childWindowId) {\r\n        this.setState({ menuVisible: menuData.items && menuData.items.length > 0, items: menuData.items, menuX: menuData.position.x, menuY: menuData.position.y });\r\n      } else {\r\n        this.setState({ menuVisible: false, items: undefined });\r\n      }\r\n    }\r\n  };\r\n\r\n  public override componentDidMount() {\r\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    this._componentUnmounting = true;\r\n    SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleSyncUiEvent);\r\n  }\r\n\r\n  private _handleRefSet = (popupDiv: HTMLElement | null) => {\r\n    const parentWindow = popupDiv?.ownerDocument.defaultView ?? undefined;\r\n    // if the window is not a pop out set to undefined\r\n    this._hostChildWindowId = UiFramework.childWindowManager.findChildWindowId(parentWindow);\r\n    Logger.logInfo(UiFramework.loggerCategory(UiFramework), `Cursor Menu for ${this._hostChildWindowId ?? \"main\"} window`);\r\n  };\r\n\r\n  public override render(): React.ReactNode {\r\n    const { menuX, menuY, items, menuVisible } = this.state;\r\n    const onClose = this._hideContextMenu;\r\n\r\n    return (\r\n      <div className=\"uifw-cursor-menu-container-div\" ref={this._handleRefSet}>\r\n        {items && items.length > 0 && menuVisible &&\r\n          <GlobalContextMenu\r\n            className={this.props.className}\r\n            style={this.props.style}\r\n            identifier=\"cursor-popup-menu\"\r\n            x={menuX}\r\n            y={menuY}\r\n            opened={menuVisible}\r\n            onEsc={onClose}\r\n            onOutsideClick={onClose}\r\n            edgeLimit={false}\r\n            autoflip={true}\r\n          >\r\n            {MenuItemHelpers.createMenuItemNodes(MenuItemHelpers.createMenuItems(items, this._itemPicked))}\r\n          </GlobalContextMenu>\r\n        }\r\n      </div>\r\n    );\r\n  }\r\n\r\n  private _hideContextMenu = () => {\r\n    this.setState({ menuVisible: false });\r\n  };\r\n\r\n  private _itemPicked = (): void => {\r\n    this._hideContextMenu();\r\n  };\r\n}\r\n"]}

package/lib/cjs/appui-react/cursor/cursorpopup/CursorPopup.d.ts

@@ -0,0 +1,59 @@
+/** @packageDocumentation
+ * @module Cursor
+ */
+import "./CursorPopup.scss";
+import * as React from "react";
+import { PointProps, RelativePosition } from "@itwin/appui-abstract";
+import { CommonDivProps, CommonProps, RectangleProps, Size, SizeProps } from "@itwin/core-react";
+/** Properties for the [[CursorPopup]] React component
+ * @public
+ */
+export interface CursorPopupProps extends CommonProps {
+    id: string;
+    content: React.ReactNode;
+    pt: PointProps;
+    offset: PointProps;
+    relativePosition: RelativePosition;
+    title?: string;
+    shadow?: boolean;
+    /** Function called when size is known. */
+    onSizeKnown?: (size: SizeProps) => void;
+}
+/** Enum for showing CursorPopup
+ * @internal - unit testing
+ */
+export declare enum CursorPopupShow {
+    Open = 0,
+    FadeOut = 1
+}
+/** State for the [[CursorPopup]] React component
+ * @internal
+ */
+interface CursorPopupState {
+    showPopup: CursorPopupShow;
+    size: Size;
+}
+/** CursorPopup React component
+ * @public
+ */
+export declare class CursorPopup extends React.Component<CursorPopupProps, CursorPopupState> {
+    private _isMounted;
+    /** @internal */
+    static fadeOutTime: number;
+    /** @internal */
+    constructor(props: CursorPopupProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _handleCursorPopupFadeOutEvent;
+    /** @internal */
+    static getPopupRect(pt: PointProps, offset: PointProps, popupSize: SizeProps | undefined, relativePosition: RelativePosition): RectangleProps;
+    private setDivRef;
+    /** @internal */
+    render(): JSX.Element;
+}
+/** CursorPopup content with padding
+ * @public
+ */
+export declare function CursorPopupContent(props: CommonDivProps): JSX.Element;
+export {};
+//# sourceMappingURL=CursorPopup.d.ts.map

package/lib/cjs/appui-react/cursor/cursorpopup/CursorPopup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CursorPopup.d.ts","sourceRoot":"","sources":["../../../../../src/appui-react/cursor/cursorpopup/CursorPopup.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,oBAAoB,CAAC;AAC5B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAO,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAItG;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB,EAAE,EAAE,UAAU,CAAC;IACf,MAAM,EAAE,UAAU,CAAC;IACnB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;CACzC;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,IAAI,IAAA;IACJ,OAAO,IAAA;CACR;AAED;;GAEG;AACH,UAAU,gBAAgB;IACxB,SAAS,EAAE,eAAe,CAAC;IAC3B,IAAI,EAAE,IAAI,CAAC;CACZ;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK,CAAC,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IAElF,OAAO,CAAC,UAAU,CAAkB;IAEpC,gBAAgB;IAChB,OAAc,WAAW,SAAO;IAEhC,gBAAgB;gBACJ,KAAK,EAAE,gBAAgB;IASnB,iBAAiB;IAKjB,oBAAoB;IAKpC,OAAO,CAAC,8BAA8B,CAMpC;IAEF,gBAAgB;WACF,YAAY,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,cAAc;IA4DpJ,OAAO,CAAC,SAAS;IAmBjB,gBAAgB;IACA,MAAM;CAyBvB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,eAEvD"}