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

package/lib/cjs/ProjectLocation/ProjectGeolocation.d.ts

@@ -1,136 +1,136 @@
-/** @packageDocumentation
- * @module Editing
- */
-import { BeButtonEvent, CanvasDecoration, DecorateContext, EventHandled, PrimitiveTool, Viewport } from "@itwin/core-frontend";
-import { Point3d, Ray3d, XYAndZ } from "@itwin/core-geometry";
-import { DialogItem, DialogProperty, DialogPropertySyncItem } from "@itwin/appui-abstract";
-/** @internal */
-declare class LabelDecoration implements CanvasDecoration {
-    worldLocation: Point3d;
-    position: Point3d;
-    label: string;
-    constructor(worldLocation: XYAndZ, label: string);
-    drawDecoration(ctx: CanvasRenderingContext2D): void;
-    setPosition(vp: Viewport): boolean;
-    addDecoration(context: DecorateContext): void;
-}
-/** Change or update geolocation for project.
- * To show tool settings for specifying lat/long, make sure formatting and parsing data are cached before the tool starts
- * by calling QuantityFormatter.onInitialized at app startup.
- * @beta
- */
-export declare class ProjectGeolocationPointTool extends PrimitiveTool {
-    static toolId: string;
-    static iconSpec: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    protected _haveToolSettings: boolean;
-    protected _cartographicFromArgs: boolean;
-    protected _accept: boolean;
-    protected _scale: number;
-    protected _origin?: Point3d;
-    protected _labelDeco?: LabelDecoration;
-    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
-    isValidLocation(_ev: BeButtonEvent, _isButtonEvent: boolean): boolean;
-    requireWriteableTarget(): boolean;
-    onPostInstall(): Promise<void>;
-    onCleanup(): Promise<void>;
-    onRestartTool(): Promise<void>;
-    onUnsuspend(): Promise<void>;
-    private _latitudeProperty;
-    get latitudeProperty(): DialogProperty<number>;
-    get latitude(): number;
-    set latitude(value: number);
-    private _longitudeProperty;
-    get longitudeProperty(): DialogProperty<number>;
-    get longitude(): number;
-    set longitude(value: number);
-    private _altitudeProperty;
-    get altitudeProperty(): DialogProperty<number>;
-    get altitude(): number;
-    set altitude(value: number);
-    private _northProperty;
-    get northProperty(): DialogProperty<number>;
-    get north(): number;
-    set north(value: number);
-    private syncToolSettingsCoordinates;
-    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
-    supplyToolSettingsProperties(): DialogItem[] | undefined;
-    protected provideToolAssistance(): void;
-    protected setupAndPromptForNextAction(): void;
-    private pulseDecoration;
-    private unsuspendDecorations;
-    decorate(context: DecorateContext): void;
-    onMouseMotion(ev: BeButtonEvent): Promise<void>;
-    onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled>;
-    protected acceptDefaultLocation(): void;
-    acceptKnownLocation(ev: BeButtonEvent): void;
-    acceptCoordinates(): Promise<void>;
-    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
-    onInstall(): Promise<boolean>;
-    /** The keyin takes the following arguments, all of which are optional:
-     *  - `latitude=number` Latitude of accept point in degrees.
-     *  - `longitude=number` Longitude of accept point in degrees.
-     *  - `altitude=number` Height above ellipsoid of accept point.
-     *  - `north=number` North direction in degrees of accept point.
-     */
-    parseAndRun(...inputArgs: string[]): Promise<boolean>;
-    static startTool(): Promise<boolean>;
-}
-/** Change or update geolocation direction to true north.
- * @beta
- */
-export declare class ProjectGeolocationNorthTool extends PrimitiveTool {
-    static toolId: string;
-    static iconSpec: string;
-    protected _origin?: Point3d;
-    protected _northDir?: Ray3d;
-    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
-    isValidLocation(_ev: BeButtonEvent, _isButtonEvent: boolean): boolean;
-    requireWriteableTarget(): boolean;
-    onPostInstall(): Promise<void>;
-    onCleanup(): Promise<void>;
-    onRestartTool(): Promise<void>;
-    onUnsuspend(): Promise<void>;
-    protected provideToolAssistance(): void;
-    protected setupAndPromptForNextAction(): void;
-    private getAdjustedPoint;
-    private unsuspendDecorations;
-    private updateNorthVector;
-    decorate(context: DecorateContext): void;
-    onKeyTransition(wentDown: boolean, keyEvent: KeyboardEvent): Promise<EventHandled>;
-    onMouseMotion(ev: BeButtonEvent): Promise<void>;
-    onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled>;
-    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
-    onInstall(): Promise<boolean>;
-    static startTool(): Promise<boolean>;
-}
-/** Move a geolocated model by specifying two points to define the offset.
- * @beta
- */
-export declare class ProjectGeolocationMoveTool extends PrimitiveTool {
-    static toolId: string;
-    static iconSpec: string;
-    protected _origin?: Point3d;
-    protected _current?: Point3d;
-    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
-    isValidLocation(_ev: BeButtonEvent, _isButtonEvent: boolean): boolean;
-    requireWriteableTarget(): boolean;
-    onPostInstall(): Promise<void>;
-    onCleanup(): Promise<void>;
-    onRestartTool(): Promise<void>;
-    onUnsuspend(): Promise<void>;
-    protected provideToolAssistance(): void;
-    protected setupAndPromptForNextAction(): void;
-    private unsuspendDecorations;
-    private acceptOffset;
-    decorate(context: DecorateContext): void;
-    onKeyTransition(wentDown: boolean, keyEvent: KeyboardEvent): Promise<EventHandled>;
-    onMouseMotion(ev: BeButtonEvent): Promise<void>;
-    onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled>;
-    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
-    onInstall(): Promise<boolean>;
-    static startTool(): Promise<boolean>;
-}
-export {};
+/** @packageDocumentation
+ * @module Editing
+ */
+import { BeButtonEvent, CanvasDecoration, DecorateContext, EventHandled, PrimitiveTool, Viewport } from "@itwin/core-frontend";
+import { Point3d, Ray3d, XYAndZ } from "@itwin/core-geometry";
+import { DialogItem, DialogProperty, DialogPropertySyncItem } from "@itwin/appui-abstract";
+/** @internal */
+declare class LabelDecoration implements CanvasDecoration {
+    worldLocation: Point3d;
+    position: Point3d;
+    label: string;
+    constructor(worldLocation: XYAndZ, label: string);
+    drawDecoration(ctx: CanvasRenderingContext2D): void;
+    setPosition(vp: Viewport): boolean;
+    addDecoration(context: DecorateContext): void;
+}
+/** Change or update geolocation for project.
+ * To show tool settings for specifying lat/long, make sure formatting and parsing data are cached before the tool starts
+ * by calling QuantityFormatter.onInitialized at app startup.
+ * @beta
+ */
+export declare class ProjectGeolocationPointTool extends PrimitiveTool {
+    static toolId: string;
+    static iconSpec: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    protected _haveToolSettings: boolean;
+    protected _cartographicFromArgs: boolean;
+    protected _accept: boolean;
+    protected _scale: number;
+    protected _origin?: Point3d;
+    protected _labelDeco?: LabelDecoration;
+    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
+    isValidLocation(_ev: BeButtonEvent, _isButtonEvent: boolean): boolean;
+    requireWriteableTarget(): boolean;
+    onPostInstall(): Promise<void>;
+    onCleanup(): Promise<void>;
+    onRestartTool(): Promise<void>;
+    onUnsuspend(): Promise<void>;
+    private _latitudeProperty;
+    get latitudeProperty(): DialogProperty<number>;
+    get latitude(): number;
+    set latitude(value: number);
+    private _longitudeProperty;
+    get longitudeProperty(): DialogProperty<number>;
+    get longitude(): number;
+    set longitude(value: number);
+    private _altitudeProperty;
+    get altitudeProperty(): DialogProperty<number>;
+    get altitude(): number;
+    set altitude(value: number);
+    private _northProperty;
+    get northProperty(): DialogProperty<number>;
+    get north(): number;
+    set north(value: number);
+    private syncToolSettingsCoordinates;
+    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
+    supplyToolSettingsProperties(): DialogItem[] | undefined;
+    protected provideToolAssistance(): void;
+    protected setupAndPromptForNextAction(): void;
+    private pulseDecoration;
+    private unsuspendDecorations;
+    decorate(context: DecorateContext): void;
+    onMouseMotion(ev: BeButtonEvent): Promise<void>;
+    onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled>;
+    protected acceptDefaultLocation(): void;
+    acceptKnownLocation(ev: BeButtonEvent): void;
+    acceptCoordinates(): Promise<void>;
+    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
+    onInstall(): Promise<boolean>;
+    /** The keyin takes the following arguments, all of which are optional:
+     *  - `latitude=number` Latitude of accept point in degrees.
+     *  - `longitude=number` Longitude of accept point in degrees.
+     *  - `altitude=number` Height above ellipsoid of accept point.
+     *  - `north=number` North direction in degrees of accept point.
+     */
+    parseAndRun(...inputArgs: string[]): Promise<boolean>;
+    static startTool(): Promise<boolean>;
+}
+/** Change or update geolocation direction to true north.
+ * @beta
+ */
+export declare class ProjectGeolocationNorthTool extends PrimitiveTool {
+    static toolId: string;
+    static iconSpec: string;
+    protected _origin?: Point3d;
+    protected _northDir?: Ray3d;
+    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
+    isValidLocation(_ev: BeButtonEvent, _isButtonEvent: boolean): boolean;
+    requireWriteableTarget(): boolean;
+    onPostInstall(): Promise<void>;
+    onCleanup(): Promise<void>;
+    onRestartTool(): Promise<void>;
+    onUnsuspend(): Promise<void>;
+    protected provideToolAssistance(): void;
+    protected setupAndPromptForNextAction(): void;
+    private getAdjustedPoint;
+    private unsuspendDecorations;
+    private updateNorthVector;
+    decorate(context: DecorateContext): void;
+    onKeyTransition(wentDown: boolean, keyEvent: KeyboardEvent): Promise<EventHandled>;
+    onMouseMotion(ev: BeButtonEvent): Promise<void>;
+    onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled>;
+    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
+    onInstall(): Promise<boolean>;
+    static startTool(): Promise<boolean>;
+}
+/** Move a geolocated model by specifying two points to define the offset.
+ * @beta
+ */
+export declare class ProjectGeolocationMoveTool extends PrimitiveTool {
+    static toolId: string;
+    static iconSpec: string;
+    protected _origin?: Point3d;
+    protected _current?: Point3d;
+    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
+    isValidLocation(_ev: BeButtonEvent, _isButtonEvent: boolean): boolean;
+    requireWriteableTarget(): boolean;
+    onPostInstall(): Promise<void>;
+    onCleanup(): Promise<void>;
+    onRestartTool(): Promise<void>;
+    onUnsuspend(): Promise<void>;
+    protected provideToolAssistance(): void;
+    protected setupAndPromptForNextAction(): void;
+    private unsuspendDecorations;
+    private acceptOffset;
+    decorate(context: DecorateContext): void;
+    onKeyTransition(wentDown: boolean, keyEvent: KeyboardEvent): Promise<EventHandled>;
+    onMouseMotion(ev: BeButtonEvent): Promise<void>;
+    onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled>;
+    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
+    onInstall(): Promise<boolean>;
+    static startTool(): Promise<boolean>;
+}
+export {};
 //# sourceMappingURL=ProjectGeolocation.d.ts.map