@itwin/editor-frontend 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/esm/ModifyCurveTools.d.ts

@@ -1,140 +1,140 @@
-import { DialogItem, DialogProperty, DialogPropertySyncItem } from "@itwin/appui-abstract";
-import { Id64String } from "@itwin/core-bentley";
-import { ElementGeometryInfo, FlatBufferGeometryStream, GeometricElementProps, GeometryParams, JsonGeometryStream } from "@itwin/core-common";
-import { BeButtonEvent, ToolAssistanceInstruction } from "@itwin/core-frontend";
-import { CurveCollection, CurveLocationDetail, CurvePrimitive, GeometryQuery, Path, Plane3dByOriginAndUnitNormal, Point3d } from "@itwin/core-geometry";
-import { ModifyElementWithDynamicsTool } from "./ModifyElementTool";
-/** @alpha */
-export declare class CurveData {
-    props: GeometricElementProps;
-    params: GeometryParams;
-    geom: CurveCollection | CurvePrimitive;
-    constructor(props: GeometricElementProps, params: GeometryParams, geom: CurveCollection | CurvePrimitive);
-}
-/** @alpha Base class for modifying all types of curve geometry. */
-export declare abstract class ModifyCurveTool extends ModifyElementWithDynamicsTool {
-    protected _startedCmd?: string;
-    protected curveData?: CurveData;
-    protected startCommand(): Promise<string>;
-    static isSingleCurve(info: ElementGeometryInfo): {
-        curve: CurveCollection | CurvePrimitive;
-        params: GeometryParams;
-    } | undefined;
-    static isInPlane(curve: CurveCollection | CurvePrimitive, plane: Plane3dByOriginAndUnitNormal): boolean;
-    protected acceptCurve(_curve: CurveCollection | CurvePrimitive): boolean;
-    protected modifyCurve(_ev: BeButtonEvent, _isAccept: boolean): GeometryQuery | undefined;
-    protected getCurveData(id: Id64String): Promise<CurveData | undefined>;
-    protected doAcceptElementForOperation(id: Id64String): Promise<boolean>;
-    protected onAgendaModified(): Promise<void>;
-    protected setupAccuDraw(): void;
-    protected getGeometryProps(ev: BeButtonEvent, isAccept: boolean): JsonGeometryStream | FlatBufferGeometryStream | undefined;
-    protected getElementProps(ev: BeButtonEvent): GeometricElementProps | undefined;
-    protected doUpdateElement(elemProps: GeometricElementProps): Promise<boolean>;
-    protected get wantModifyOriginal(): boolean;
-    protected get wantContinueWithPreviousResult(): boolean;
-    onProcessComplete(): Promise<void>;
-}
-/** @alpha Tool for applying an offset to paths and loops. */
-export declare class OffsetCurveTool extends ModifyCurveTool {
-    static toolId: string;
-    static iconSpec: string;
-    private _useDistanceProperty;
-    get useDistanceProperty(): DialogProperty<boolean>;
-    get useDistance(): boolean;
-    set useDistance(value: boolean);
-    private _distanceProperty;
-    get distanceProperty(): DialogProperty<number>;
-    get distance(): number;
-    set distance(value: number);
-    private _makeCopyProperty;
-    get makeCopyProperty(): DialogProperty<boolean>;
-    get makeCopy(): boolean;
-    set makeCopy(value: boolean);
-    protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
-    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
-    supplyToolSettingsProperties(): DialogItem[] | undefined;
-    protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
-    protected modifyCurve(ev: BeButtonEvent, isAccept: boolean): GeometryQuery | undefined;
-    protected get wantModifyOriginal(): boolean;
-    protected get wantContinueWithPreviousResult(): boolean;
-    protected setupAccuDraw(): void;
-    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
-    onRestartTool(): Promise<void>;
-}
-/** @alpha Tool for opening loops and splitting paths. */
-export declare class BreakCurveTool extends ModifyCurveTool {
-    static toolId: string;
-    static iconSpec: string;
-    protected resultA?: CurveCollection | CurvePrimitive;
-    protected resultB?: CurveCollection | CurvePrimitive;
-    protected modifyOriginal: boolean;
-    protected get wantDynamics(): boolean;
-    protected get wantModifyOriginal(): boolean;
-    protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
-    protected doBreakCurve(ev: BeButtonEvent): void;
-    protected modifyCurve(_ev: BeButtonEvent, _isAccept: boolean): GeometryQuery | undefined;
-    processAgenda(ev: BeButtonEvent): Promise<void>;
-    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
-    onRestartTool(): Promise<void>;
-}
-/** @alpha Tool to extend or trim a path or open curve */
-export declare class ExtendCurveTool extends ModifyCurveTool {
-    static toolId: string;
-    static iconSpec: string;
-    protected modifyingEnd?: CurvePrimitive;
-    protected get wantAgendaAppearanceOverride(): boolean;
-    protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
-    protected extendCurve(geom: CurvePrimitive, pickPoint: Point3d, spacePoint: Point3d): CurvePrimitive | undefined;
-    protected extendPathEnd(geom: Path, closeDetail: CurveLocationDetail, isStart: boolean): Path | undefined;
-    protected extendPath(geom: Path, pickPoint: Point3d, spacePoint: Point3d): Path | CurvePrimitive | undefined;
-    protected modifyCurve(ev: BeButtonEvent, _isAccept: boolean): GeometryQuery | undefined;
-    protected onAgendaModified(): Promise<void>;
-    protected setupAccuDraw(): void;
-    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
-    onRestartTool(): Promise<void>;
-}
-/** @alpha */
-export declare enum RegionBooleanMode {
-    /** Create region from union of all input regions */
-    Unite = 0,
-    /** Create region from subtraction from the first input region */
-    Subtract = 1,
-    /** Create region from intersection of all input regions */
-    Intersect = 2
-}
-/** @alpha Tool to unite, subtract, or intersect planar regions. */
-export declare class RegionBooleanTool extends ModifyCurveTool {
-    static toolId: string;
-    static iconSpec: string;
-    private _makeCopyProperty;
-    get makeCopyProperty(): DialogProperty<boolean>;
-    get makeCopy(): boolean;
-    set makeCopy(value: boolean);
-    private static modeMessage;
-    private static getModeChoices;
-    private _modeProperty;
-    get modeProperty(): DialogProperty<number>;
-    get mode(): RegionBooleanMode;
-    set mode(mode: RegionBooleanMode);
-    protected get clearSelectionSet(): boolean;
-    protected get allowSelectionSet(): boolean;
-    protected get allowDragSelect(): boolean;
-    protected get controlKeyContinuesSelection(): boolean;
-    protected get requiredElementCount(): number;
-    protected get wantAccuSnap(): boolean;
-    protected get wantDynamics(): boolean;
-    protected get wantModifyOriginal(): boolean;
-    protected onAgendaModified(): Promise<void>;
-    protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
-    private regionBinaryOp;
-    private regionFromSignedLoops;
-    private regionBooleanXY;
-    protected doRegionBoolean(_ev: BeButtonEvent): Promise<void>;
-    protected modifyCurve(_ev: BeButtonEvent, _isAccept: boolean): GeometryQuery | undefined;
-    protected applyAgendaOperation(ev: BeButtonEvent): Promise<boolean>;
-    processAgenda(ev: BeButtonEvent): Promise<void>;
-    onRestartTool(): Promise<void>;
-    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
-    supplyToolSettingsProperties(): DialogItem[] | undefined;
-}
+import { DialogItem, DialogProperty, DialogPropertySyncItem } from "@itwin/appui-abstract";
+import { Id64String } from "@itwin/core-bentley";
+import { ElementGeometryInfo, FlatBufferGeometryStream, GeometricElementProps, GeometryParams, JsonGeometryStream } from "@itwin/core-common";
+import { BeButtonEvent, ToolAssistanceInstruction } from "@itwin/core-frontend";
+import { CurveCollection, CurveLocationDetail, CurvePrimitive, GeometryQuery, Path, Plane3dByOriginAndUnitNormal, Point3d } from "@itwin/core-geometry";
+import { ModifyElementWithDynamicsTool } from "./ModifyElementTool";
+/** @alpha */
+export declare class CurveData {
+    props: GeometricElementProps;
+    params: GeometryParams;
+    geom: CurveCollection | CurvePrimitive;
+    constructor(props: GeometricElementProps, params: GeometryParams, geom: CurveCollection | CurvePrimitive);
+}
+/** @alpha Base class for modifying all types of curve geometry. */
+export declare abstract class ModifyCurveTool extends ModifyElementWithDynamicsTool {
+    protected _startedCmd?: string;
+    protected curveData?: CurveData;
+    protected startCommand(): Promise<string>;
+    static isSingleCurve(info: ElementGeometryInfo): {
+        curve: CurveCollection | CurvePrimitive;
+        params: GeometryParams;
+    } | undefined;
+    static isInPlane(curve: CurveCollection | CurvePrimitive, plane: Plane3dByOriginAndUnitNormal): boolean;
+    protected acceptCurve(_curve: CurveCollection | CurvePrimitive): boolean;
+    protected modifyCurve(_ev: BeButtonEvent, _isAccept: boolean): GeometryQuery | undefined;
+    protected getCurveData(id: Id64String): Promise<CurveData | undefined>;
+    protected doAcceptElementForOperation(id: Id64String): Promise<boolean>;
+    protected onAgendaModified(): Promise<void>;
+    protected setupAccuDraw(): void;
+    protected getGeometryProps(ev: BeButtonEvent, isAccept: boolean): JsonGeometryStream | FlatBufferGeometryStream | undefined;
+    protected getElementProps(ev: BeButtonEvent): GeometricElementProps | undefined;
+    protected doUpdateElement(elemProps: GeometricElementProps): Promise<boolean>;
+    protected get wantModifyOriginal(): boolean;
+    protected get wantContinueWithPreviousResult(): boolean;
+    onProcessComplete(): Promise<void>;
+}
+/** @alpha Tool for applying an offset to paths and loops. */
+export declare class OffsetCurveTool extends ModifyCurveTool {
+    static toolId: string;
+    static iconSpec: string;
+    private _useDistanceProperty;
+    get useDistanceProperty(): DialogProperty<boolean>;
+    get useDistance(): boolean;
+    set useDistance(value: boolean);
+    private _distanceProperty;
+    get distanceProperty(): DialogProperty<number>;
+    get distance(): number;
+    set distance(value: number);
+    private _makeCopyProperty;
+    get makeCopyProperty(): DialogProperty<boolean>;
+    get makeCopy(): boolean;
+    set makeCopy(value: boolean);
+    protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
+    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
+    supplyToolSettingsProperties(): DialogItem[] | undefined;
+    protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
+    protected modifyCurve(ev: BeButtonEvent, isAccept: boolean): GeometryQuery | undefined;
+    protected get wantModifyOriginal(): boolean;
+    protected get wantContinueWithPreviousResult(): boolean;
+    protected setupAccuDraw(): void;
+    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
+    onRestartTool(): Promise<void>;
+}
+/** @alpha Tool for opening loops and splitting paths. */
+export declare class BreakCurveTool extends ModifyCurveTool {
+    static toolId: string;
+    static iconSpec: string;
+    protected resultA?: CurveCollection | CurvePrimitive;
+    protected resultB?: CurveCollection | CurvePrimitive;
+    protected modifyOriginal: boolean;
+    protected get wantDynamics(): boolean;
+    protected get wantModifyOriginal(): boolean;
+    protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
+    protected doBreakCurve(ev: BeButtonEvent): void;
+    protected modifyCurve(_ev: BeButtonEvent, _isAccept: boolean): GeometryQuery | undefined;
+    processAgenda(ev: BeButtonEvent): Promise<void>;
+    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
+    onRestartTool(): Promise<void>;
+}
+/** @alpha Tool to extend or trim a path or open curve */
+export declare class ExtendCurveTool extends ModifyCurveTool {
+    static toolId: string;
+    static iconSpec: string;
+    protected modifyingEnd?: CurvePrimitive;
+    protected get wantAgendaAppearanceOverride(): boolean;
+    protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
+    protected extendCurve(geom: CurvePrimitive, pickPoint: Point3d, spacePoint: Point3d): CurvePrimitive | undefined;
+    protected extendPathEnd(geom: Path, closeDetail: CurveLocationDetail, isStart: boolean): Path | undefined;
+    protected extendPath(geom: Path, pickPoint: Point3d, spacePoint: Point3d): Path | CurvePrimitive | undefined;
+    protected modifyCurve(ev: BeButtonEvent, _isAccept: boolean): GeometryQuery | undefined;
+    protected onAgendaModified(): Promise<void>;
+    protected setupAccuDraw(): void;
+    protected provideToolAssistance(_mainInstrText?: string, _additionalInstr?: ToolAssistanceInstruction[]): void;
+    onRestartTool(): Promise<void>;
+}
+/** @alpha */
+export declare enum RegionBooleanMode {
+    /** Create region from union of all input regions */
+    Unite = 0,
+    /** Create region from subtraction from the first input region */
+    Subtract = 1,
+    /** Create region from intersection of all input regions */
+    Intersect = 2
+}
+/** @alpha Tool to unite, subtract, or intersect planar regions. */
+export declare class RegionBooleanTool extends ModifyCurveTool {
+    static toolId: string;
+    static iconSpec: string;
+    private _makeCopyProperty;
+    get makeCopyProperty(): DialogProperty<boolean>;
+    get makeCopy(): boolean;
+    set makeCopy(value: boolean);
+    private static modeMessage;
+    private static getModeChoices;
+    private _modeProperty;
+    get modeProperty(): DialogProperty<number>;
+    get mode(): RegionBooleanMode;
+    set mode(mode: RegionBooleanMode);
+    protected get clearSelectionSet(): boolean;
+    protected get allowSelectionSet(): boolean;
+    protected get allowDragSelect(): boolean;
+    protected get controlKeyContinuesSelection(): boolean;
+    protected get requiredElementCount(): number;
+    protected get wantAccuSnap(): boolean;
+    protected get wantDynamics(): boolean;
+    protected get wantModifyOriginal(): boolean;
+    protected onAgendaModified(): Promise<void>;
+    protected acceptCurve(curve: CurveCollection | CurvePrimitive): boolean;
+    private regionBinaryOp;
+    private regionFromSignedLoops;
+    private regionBooleanXY;
+    protected doRegionBoolean(_ev: BeButtonEvent): Promise<void>;
+    protected modifyCurve(_ev: BeButtonEvent, _isAccept: boolean): GeometryQuery | undefined;
+    protected applyAgendaOperation(ev: BeButtonEvent): Promise<boolean>;
+    processAgenda(ev: BeButtonEvent): Promise<void>;
+    onRestartTool(): Promise<void>;
+    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
+    supplyToolSettingsProperties(): DialogItem[] | undefined;
+}
 //# sourceMappingURL=ModifyCurveTools.d.ts.map