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

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

@@ -1,136 +1,136 @@
-/** @packageDocumentation
- * @module Editing
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { Cartographic, EcefLocation, EcefLocationProps } from "@itwin/core-common";
-import { BeButtonEvent, BriefcaseConnection, DecorateContext, EditManipulator, EventHandled, HitDetail, IModelConnection, ScreenViewport, Tool, ViewClipControlArrow } from "@itwin/core-frontend";
-import { Angle, ClipShape, ClipVector, Point3d, Range1d, Range3d, Range3dProps, Ray3d } from "@itwin/core-geometry";
-declare class ProjectExtentsControlArrow extends ViewClipControlArrow {
-    extentValid: boolean;
-}
-/** Values for [[ProjectExtentsClipDecoration.onChanged] event.
- * @beta
- */
-export declare enum ProjectLocationChanged {
-    /** Extents has been modified (unsaved changes) */
-    Extents = 0,
-    /** Geolocation has been modified (unsaved changes) */
-    Geolocation = 1,
-    /** Abandon unsaved changes to extents */
-    ResetExtents = 2,
-    /** Abandon unsaved changes to geolocation */
-    ResetGeolocation = 3,
-    /** Decoration hidden (unsaved changes preserved) */
-    Hide = 4,
-    /** Decoration shown (unsaved changes restored) */
-    Show = 5,
-    /** Save changes to extents and geolocation */
-    Save = 6
-}
-/** Controls to modify project extents shown using view clip
- * @beta
- */
-export declare class ProjectExtentsClipDecoration extends EditManipulator.HandleProvider {
-    viewport: ScreenViewport;
-    private static _decorator?;
-    protected _clip?: ClipVector;
-    protected _clipId?: string;
-    protected _clipShape?: ClipShape;
-    protected _clipShapeExtents?: Range1d;
-    protected _clipRange?: Range3d;
-    protected _extentsLengthValid: boolean;
-    protected _extentsWidthValid: boolean;
-    protected _extentsHeightValid: boolean;
-    protected _ecefLocation?: EcefLocation;
-    protected _allowEcefLocationChange: boolean;
-    protected _controlIds: string[];
-    protected _controls: ProjectExtentsControlArrow[];
-    protected _monumentPoint?: Point3d;
-    protected _northDirection?: Ray3d;
-    protected _monumentId?: string;
-    protected _northId?: string;
-    protected _suspendDecorator: boolean;
-    protected _removeViewCloseListener?: () => void;
-    suspendGeolocationDecorations: boolean;
-    /** Called when project extents or geolocation is modified */
-    readonly onChanged: BeEvent<(iModel: IModelConnection, ev: ProjectLocationChanged) => void>;
-    constructor(viewport: ScreenViewport);
-    protected start(): void;
-    protected stop(): void;
-    protected init(): boolean;
-    onViewClose(vp: ScreenViewport): void;
-    private getClipData;
-    private ensureNumControls;
-    private createClipShapeControls;
-    /** Allow project extents for map projections to be larger since curvature of the earth is accounted for. */
-    protected get maxExtentLength(): number;
-    /** Impose some reasonable height limit for project extents. */
-    protected get maxExtentHeight(): number;
-    protected hasValidGCS(): boolean;
-    protected createControls(): Promise<boolean>;
-    protected clearControls(): void;
-    protected modifyControls(hit: HitDetail, _ev: BeButtonEvent): Promise<boolean>;
-    protected onRightClick(_hit: HitDetail, _ev: BeButtonEvent): Promise<EventHandled>;
-    protected onTouchTap(hit: HitDetail, ev: BeButtonEvent): Promise<EventHandled>;
-    onDecorationButtonEvent(hit: HitDetail, ev: BeButtonEvent): Promise<EventHandled>;
-    onManipulatorEvent(eventType: EditManipulator.EventType): void;
-    getDecorationToolTip(hit: HitDetail): Promise<HTMLElement | string>;
-    testDecorationHit(id: string): boolean;
-    protected updateDecorationListener(_add: boolean): void;
-    getMonumentPoint(): Point3d;
-    getClockwiseAngleToNorth(): Angle;
-    getNorthAngle(): Angle;
-    getNorthDirection(refOrigin?: Point3d): Ray3d;
-    drawNorthArrow(context: DecorateContext, northDir: Ray3d, id?: string): void;
-    drawMonumentPoint(context: DecorateContext, point: Point3d, scaleFactor: number, id?: string): void;
-    protected drawAreaTooLargeIndicator(context: DecorateContext): void;
-    protected drawExtentTooLargeIndicator(context: DecorateContext, worldPoint: Point3d, sizePixels: number): void;
-    decorate(context: DecorateContext): void;
-    resetViewClip(): boolean;
-    resetGeolocation(): boolean;
-    updateEcefLocation(origin: Cartographic, point?: Point3d, angle?: Angle): boolean;
-    updateNorthDirection(northDir: Ray3d): boolean;
-    getModifiedEcefLocation(): EcefLocation | undefined;
-    getModifiedExtents(): Range3d | undefined;
-    static allowEcefLocationChange(requireExisting: boolean, outputError?: boolean): boolean;
-    fitExtents(): void;
-    static get(): ProjectExtentsClipDecoration | undefined;
-    static show(vp: ScreenViewport, fitExtents?: boolean): boolean;
-    static hide(): void;
-    static clear(clearClip?: boolean, resetGeolocation?: boolean): void;
-    static update(): Promise<void>;
-}
-/** Show project location decoration. Project extents represented by view clip.
- * @beta
- */
-export declare class ProjectLocationShowTool extends Tool {
-    static toolId: string;
-    run(): Promise<boolean>;
-}
-/** Hide project location decoration. Preserves changes to project extents view clip and geolocation.
- * @beta
- */
-export declare class ProjectLocationHideTool extends Tool {
-    static toolId: string;
-    run(): Promise<boolean>;
-}
-/** Clear project location decoration. Restore modified geolocation and remove view clip.
- * @beta
- */
-export declare class ProjectLocationCancelTool extends Tool {
-    static toolId: string;
-    run(): Promise<boolean>;
-}
-/** Save modified project extents and geolocation. Updates decoration to reflect saved state.
- * @note Allowing this change to be undone is both problematic and undesirable.
- * Warns the user if called with previous changes to cancel restarting the TxnManager session.
- * @beta
- */
-export declare class ProjectLocationSaveTool extends Tool {
-    static toolId: string;
-    protected allowRestartTxnSession(iModel: BriefcaseConnection): Promise<boolean>;
-    protected saveChanges(deco: ProjectExtentsClipDecoration, extents?: Range3dProps, ecefLocation?: EcefLocationProps): Promise<void>;
-    run(): Promise<boolean>;
-}
-export {};
+/** @packageDocumentation
+ * @module Editing
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { Cartographic, EcefLocation, EcefLocationProps } from "@itwin/core-common";
+import { BeButtonEvent, BriefcaseConnection, DecorateContext, EditManipulator, EventHandled, HitDetail, IModelConnection, ScreenViewport, Tool, ViewClipControlArrow } from "@itwin/core-frontend";
+import { Angle, ClipShape, ClipVector, Point3d, Range1d, Range3d, Range3dProps, Ray3d } from "@itwin/core-geometry";
+declare class ProjectExtentsControlArrow extends ViewClipControlArrow {
+    extentValid: boolean;
+}
+/** Values for [[ProjectExtentsClipDecoration.onChanged] event.
+ * @beta
+ */
+export declare enum ProjectLocationChanged {
+    /** Extents has been modified (unsaved changes) */
+    Extents = 0,
+    /** Geolocation has been modified (unsaved changes) */
+    Geolocation = 1,
+    /** Abandon unsaved changes to extents */
+    ResetExtents = 2,
+    /** Abandon unsaved changes to geolocation */
+    ResetGeolocation = 3,
+    /** Decoration hidden (unsaved changes preserved) */
+    Hide = 4,
+    /** Decoration shown (unsaved changes restored) */
+    Show = 5,
+    /** Save changes to extents and geolocation */
+    Save = 6
+}
+/** Controls to modify project extents shown using view clip
+ * @beta
+ */
+export declare class ProjectExtentsClipDecoration extends EditManipulator.HandleProvider {
+    viewport: ScreenViewport;
+    private static _decorator?;
+    protected _clip?: ClipVector;
+    protected _clipId?: string;
+    protected _clipShape?: ClipShape;
+    protected _clipShapeExtents?: Range1d;
+    protected _clipRange?: Range3d;
+    protected _extentsLengthValid: boolean;
+    protected _extentsWidthValid: boolean;
+    protected _extentsHeightValid: boolean;
+    protected _ecefLocation?: EcefLocation;
+    protected _allowEcefLocationChange: boolean;
+    protected _controlIds: string[];
+    protected _controls: ProjectExtentsControlArrow[];
+    protected _monumentPoint?: Point3d;
+    protected _northDirection?: Ray3d;
+    protected _monumentId?: string;
+    protected _northId?: string;
+    protected _suspendDecorator: boolean;
+    protected _removeViewCloseListener?: () => void;
+    suspendGeolocationDecorations: boolean;
+    /** Called when project extents or geolocation is modified */
+    readonly onChanged: BeEvent<(iModel: IModelConnection, ev: ProjectLocationChanged) => void>;
+    constructor(viewport: ScreenViewport);
+    protected start(): void;
+    protected stop(): void;
+    protected init(): boolean;
+    onViewClose(vp: ScreenViewport): void;
+    private getClipData;
+    private ensureNumControls;
+    private createClipShapeControls;
+    /** Allow project extents for map projections to be larger since curvature of the earth is accounted for. */
+    protected get maxExtentLength(): number;
+    /** Impose some reasonable height limit for project extents. */
+    protected get maxExtentHeight(): number;
+    protected hasValidGCS(): boolean;
+    protected createControls(): Promise<boolean>;
+    protected clearControls(): void;
+    protected modifyControls(hit: HitDetail, _ev: BeButtonEvent): Promise<boolean>;
+    protected onRightClick(_hit: HitDetail, _ev: BeButtonEvent): Promise<EventHandled>;
+    protected onTouchTap(hit: HitDetail, ev: BeButtonEvent): Promise<EventHandled>;
+    onDecorationButtonEvent(hit: HitDetail, ev: BeButtonEvent): Promise<EventHandled>;
+    onManipulatorEvent(eventType: EditManipulator.EventType): void;
+    getDecorationToolTip(hit: HitDetail): Promise<HTMLElement | string>;
+    testDecorationHit(id: string): boolean;
+    protected updateDecorationListener(_add: boolean): void;
+    getMonumentPoint(): Point3d;
+    getClockwiseAngleToNorth(): Angle;
+    getNorthAngle(): Angle;
+    getNorthDirection(refOrigin?: Point3d): Ray3d;
+    drawNorthArrow(context: DecorateContext, northDir: Ray3d, id?: string): void;
+    drawMonumentPoint(context: DecorateContext, point: Point3d, scaleFactor: number, id?: string): void;
+    protected drawAreaTooLargeIndicator(context: DecorateContext): void;
+    protected drawExtentTooLargeIndicator(context: DecorateContext, worldPoint: Point3d, sizePixels: number): void;
+    decorate(context: DecorateContext): void;
+    resetViewClip(): boolean;
+    resetGeolocation(): boolean;
+    updateEcefLocation(origin: Cartographic, point?: Point3d, angle?: Angle): boolean;
+    updateNorthDirection(northDir: Ray3d): boolean;
+    getModifiedEcefLocation(): EcefLocation | undefined;
+    getModifiedExtents(): Range3d | undefined;
+    static allowEcefLocationChange(requireExisting: boolean, outputError?: boolean): boolean;
+    fitExtents(): void;
+    static get(): ProjectExtentsClipDecoration | undefined;
+    static show(vp: ScreenViewport, fitExtents?: boolean): boolean;
+    static hide(): void;
+    static clear(clearClip?: boolean, resetGeolocation?: boolean): void;
+    static update(): Promise<void>;
+}
+/** Show project location decoration. Project extents represented by view clip.
+ * @beta
+ */
+export declare class ProjectLocationShowTool extends Tool {
+    static toolId: string;
+    run(): Promise<boolean>;
+}
+/** Hide project location decoration. Preserves changes to project extents view clip and geolocation.
+ * @beta
+ */
+export declare class ProjectLocationHideTool extends Tool {
+    static toolId: string;
+    run(): Promise<boolean>;
+}
+/** Clear project location decoration. Restore modified geolocation and remove view clip.
+ * @beta
+ */
+export declare class ProjectLocationCancelTool extends Tool {
+    static toolId: string;
+    run(): Promise<boolean>;
+}
+/** Save modified project extents and geolocation. Updates decoration to reflect saved state.
+ * @note Allowing this change to be undone is both problematic and undesirable.
+ * Warns the user if called with previous changes to cancel restarting the TxnManager session.
+ * @beta
+ */
+export declare class ProjectLocationSaveTool extends Tool {
+    static toolId: string;
+    protected allowRestartTxnSession(iModel: BriefcaseConnection): Promise<boolean>;
+    protected saveChanges(deco: ProjectExtentsClipDecoration, extents?: Range3dProps, ecefLocation?: EcefLocationProps): Promise<void>;
+    run(): Promise<boolean>;
+}
+export {};
 //# sourceMappingURL=ProjectExtentsDecoration.d.ts.map