@itwin/editor-frontend 3.3.0-dev.30 → 3.3.0-dev.33

package/lib/esm/SolidPrimitiveTools.d.ts

@@ -0,0 +1,155 @@
+import { GeometryQuery, Matrix3d, Point3d } from "@itwin/core-geometry";
+import { ElementGeometryBuilderParams, FlatBufferGeometryStream, GeometricElementProps, JsonGeometryStream, PlacementProps } from "@itwin/core-common";
+import { BeButtonEvent, ToolAssistanceInstruction, Viewport } from "@itwin/core-frontend";
+import { BasicManipulationCommandIpc } from "@itwin/editor-common";
+import { CreateElementWithDynamicsTool } from "./CreateElementTool";
+import { DialogItem, DialogProperty, DialogPropertySyncItem } from "@itwin/appui-abstract";
+/** @alpha Base class for creating a capped or uncapped SolidPrimitive. */
+export declare abstract class SolidPrimitiveTool extends CreateElementWithDynamicsTool {
+    protected readonly accepted: Point3d[];
+    protected baseRotation?: Matrix3d;
+    protected current?: GeometryQuery;
+    protected _startedCmd?: string;
+    protected allowView(vp: Viewport): boolean;
+    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
+    protected startCommand(): Promise<string>;
+    static callCommand<T extends keyof BasicManipulationCommandIpc>(method: T, ...args: Parameters<BasicManipulationCommandIpc[T]>): ReturnType<BasicManipulationCommandIpc[T]>;
+    protected getPlacementProps(): PlacementProps | undefined;
+    protected getGeometryProps(placement: PlacementProps): JsonGeometryStream | FlatBufferGeometryStream | undefined;
+    protected getElementProps(placement: PlacementProps): GeometricElementProps | undefined;
+    protected doCreateElement(props: GeometricElementProps, data?: ElementGeometryBuilderParams): Promise<void>;
+}
+/** @alpha Creates a sphere. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
+export declare class CreateSphereTool extends SolidPrimitiveTool {
+    static toolId: string;
+    static iconSpec: string;
+    protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
+    protected setupAccuDraw(): void;
+    private _useRadiusProperty;
+    get useRadiusProperty(): DialogProperty<boolean>;
+    get useRadius(): boolean;
+    set useRadius(value: boolean);
+    private _radiusProperty;
+    get radiusProperty(): DialogProperty<number>;
+    get radius(): number;
+    set radius(value: number);
+    private _cappedProperty;
+    get cappedProperty(): DialogProperty<boolean>;
+    get capped(): boolean;
+    set capped(value: boolean);
+    protected isComplete(_ev: BeButtonEvent): boolean;
+    protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
+    protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
+    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
+    supplyToolSettingsProperties(): DialogItem[] | undefined;
+    onRestartTool(): Promise<void>;
+}
+/** @alpha Values for [[CreateCylinderTool.createPhase]. */
+export declare enum CreateCylinderPhase {
+    /** Current tool phase to define center of base */
+    AcceptBase = 0,
+    /** Current tool phase to define radius or base axes */
+    AcceptRadius = 1,
+    /** Current tool phase to define length or axis */
+    AcceptLength = 2,
+    /** Current tool phase to accept result */
+    AcceptResult = 3
+}
+/** @alpha Creates a cylinder. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
+export declare class CreateCylinderTool extends SolidPrimitiveTool {
+    static toolId: string;
+    static iconSpec: string;
+    protected createPhase: CreateCylinderPhase;
+    protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
+    protected setupAccuDraw(): void;
+    private _useRadiusProperty;
+    get useRadiusProperty(): DialogProperty<boolean>;
+    get useRadius(): boolean;
+    set useRadius(value: boolean);
+    private _radiusProperty;
+    get radiusProperty(): DialogProperty<number>;
+    get radius(): number;
+    set radius(value: number);
+    private _useLengthProperty;
+    get useLengthProperty(): DialogProperty<boolean>;
+    get useLength(): boolean;
+    set useLength(value: boolean);
+    private _lengthProperty;
+    get lengthProperty(): DialogProperty<number>;
+    get length(): number;
+    set length(value: number);
+    private _cappedProperty;
+    get cappedProperty(): DialogProperty<boolean>;
+    get capped(): boolean;
+    set capped(value: boolean);
+    private _orthogonalProperty;
+    get orthogonalProperty(): DialogProperty<boolean>;
+    get orthogonal(): boolean;
+    set orthogonal(value: boolean);
+    protected isComplete(_ev: BeButtonEvent): boolean;
+    protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
+    protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
+    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
+    supplyToolSettingsProperties(): DialogItem[] | undefined;
+    onRestartTool(): Promise<void>;
+}
+/** @alpha Values for [[CreateConeTool.createPhase]. */
+export declare enum CreateConePhase {
+    /** Current tool phase to define center of base */
+    AcceptBase = 0,
+    /** Current tool phase to define base radius or base axes */
+    AcceptBaseRadius = 1,
+    /** Current tool phase to define length or axis */
+    AcceptLength = 2,
+    /** Current tool phase to define top radius */
+    AcceptTopRadius = 3,
+    /** Current tool phase to accept result */
+    AcceptResult = 4
+}
+/** @alpha Creates a cone. Uses model and category from [[BriefcaseConnection.editorToolSettings]]. */
+export declare class CreateConeTool extends SolidPrimitiveTool {
+    static toolId: string;
+    static iconSpec: string;
+    protected createPhase: CreateConePhase;
+    protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
+    protected setupAccuDraw(): void;
+    private _useBaseRadiusProperty;
+    get useBaseRadiusProperty(): DialogProperty<boolean>;
+    get useBaseRadius(): boolean;
+    set useBaseRadius(value: boolean);
+    private _baseRadiusProperty;
+    get baseRadiusProperty(): DialogProperty<number>;
+    get baseRadius(): number;
+    set baseRadius(value: number);
+    private _useTopRadiusProperty;
+    get useTopRadiusProperty(): DialogProperty<boolean>;
+    get useTopRadius(): boolean;
+    set useTopRadius(value: boolean);
+    private _topRadiusProperty;
+    get topRadiusProperty(): DialogProperty<number>;
+    get topRadius(): number;
+    set topRadius(value: number);
+    private _useLengthProperty;
+    get useLengthProperty(): DialogProperty<boolean>;
+    get useLength(): boolean;
+    set useLength(value: boolean);
+    private _lengthProperty;
+    get lengthProperty(): DialogProperty<number>;
+    get length(): number;
+    set length(value: number);
+    private _cappedProperty;
+    get cappedProperty(): DialogProperty<boolean>;
+    get capped(): boolean;
+    set capped(value: boolean);
+    private _orthogonalProperty;
+    get orthogonalProperty(): DialogProperty<boolean>;
+    get orthogonal(): boolean;
+    set orthogonal(value: boolean);
+    protected isComplete(_ev: BeButtonEvent): boolean;
+    protected updateElementData(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
+    protected getToolSettingPropertyLocked(property: DialogProperty<any>): DialogProperty<any> | undefined;
+    applyToolSettingPropertyChange(updatedValue: DialogPropertySyncItem): Promise<boolean>;
+    supplyToolSettingsProperties(): DialogItem[] | undefined;
+    onRestartTool(): Promise<void>;
+}
+//# sourceMappingURL=SolidPrimitiveTools.d.ts.map

package/lib/esm/SolidPrimitiveTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SolidPrimitiveTools.d.ts","sourceRoot":"","sources":["../../src/SolidPrimitiveTools.ts"],"names":[],"mappings":"AAKA,OAAO,EAA6B,aAAa,EAAQ,QAAQ,EAAE,OAAO,EAAwD,MAAM,sBAAsB,CAAC;AAC/J,OAAO,EAAyB,4BAA4B,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC9K,OAAO,EAAuB,aAAa,EAA6E,yBAAyB,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC1L,OAAO,EAAE,2BAA2B,EAAuB,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAEpE,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,sBAAsB,EAA6B,MAAM,uBAAuB,CAAC;AAEtH,0EAA0E;AAC1E,8BAAsB,kBAAmB,SAAQ,6BAA6B;IAC5E,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAM;IAC5C,SAAS,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC;IAClC,SAAS,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC;IAClC,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE/B,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,QAAQ;IAChB,oBAAoB,CAAC,EAAE,EAAE,QAAQ,GAAG,SAAS,EAAE,oBAAoB,EAAE,OAAO,GAAG,OAAO;cAEtF,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;WAMjC,WAAW,CAAC,CAAC,SAAS,MAAM,2BAA2B,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC;IAIlL,SAAS,CAAC,iBAAiB,IAAI,cAAc,GAAG,SAAS;IAgBzD,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,GAAG,kBAAkB,GAAG,wBAAwB,GAAG,SAAS;IAahH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,cAAc,GAAG,qBAAqB,GAAG,SAAS;cAO9D,eAAe,CAAC,KAAK,EAAE,qBAAqB,EAAE,IAAI,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;CAS3H;AAED,wGAAwG;AACxG,qBAAa,gBAAiB,SAAQ,kBAAkB;IACtD,OAAuB,MAAM,SAAkB;IAC/C,OAAuB,QAAQ,SAAiB;cAE7B,qBAAqB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,yBAAyB,EAAE,GAAG,IAAI;cAKlG,aAAa,IAAI,IAAI;IAcxC,OAAO,CAAC,kBAAkB,CAAsC;IAChE,IAAW,iBAAiB,4BAI3B;IAED,IAAW,SAAS,IAAI,OAAO,CAAyC;IACxE,IAAW,SAAS,CAAC,KAAK,EAAE,OAAO,EAA2C;IAE9E,OAAO,CAAC,eAAe,CAAqC;IAC5D,IAAW,cAAc,2BAIxB;IAED,IAAW,MAAM,IAAI,MAAM,CAAsC;IACjE,IAAW,MAAM,CAAC,KAAK,EAAE,MAAM,EAAwC;IAEvE,OAAO,CAAC,eAAe,CAAsC;IAC7D,IAAW,cAAc,4BAKxB;IAED,IAAW,MAAM,IAAI,OAAO,CAAsC;IAClE,IAAW,MAAM,CAAC,KAAK,EAAE,OAAO,EAAwC;cAErD,UAAU,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;cAIjC,iBAAiB,CAAC,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;cA4C9E,4BAA4B,CAAC,QAAQ,EAAE,cAAc,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,SAAS;IAIzF,8BAA8B,CAAC,YAAY,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5F,4BAA4B,IAAI,UAAU,EAAE,GAAG,SAAS;IAa3D,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;CAK5C;AAED,2DAA2D;AAC3D,oBAAY,mBAAmB;IAC7B,kDAAkD;IAClD,UAAU,IAAA;IACV,uDAAuD;IACvD,YAAY,IAAA;IACZ,kDAAkD;IAClD,YAAY,IAAA;IACZ,0CAA0C;IAC1C,YAAY,IAAA;CACb;AAED,0GAA0G;AAC1G,qBAAa,kBAAmB,SAAQ,kBAAkB;IACxD,OAAuB,MAAM,SAAoB;IACjD,OAAuB,QAAQ,SAAiB;IAEhD,SAAS,CAAC,WAAW,sBAAkC;cAEpC,qBAAqB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,yBAAyB,EAAE,GAAG,IAAI;cAgBlG,aAAa,IAAI,IAAI;IAwBxC,OAAO,CAAC,kBAAkB,CAAsC;IAChE,IAAW,iBAAiB,4BAI3B;IAED,IAAW,SAAS,IAAI,OAAO,CAAyC;IACxE,IAAW,SAAS,CAAC,KAAK,EAAE,OAAO,EAA2C;IAE9E,OAAO,CAAC,eAAe,CAAqC;IAC5D,IAAW,cAAc,2BAIxB;IAED,IAAW,MAAM,IAAI,MAAM,CAAsC;IACjE,IAAW,MAAM,CAAC,KAAK,EAAE,MAAM,EAAwC;IAEvE,OAAO,CAAC,kBAAkB,CAAsC;IAChE,IAAW,iBAAiB,4BAI3B;IAED,IAAW,SAAS,IAAI,OAAO,CAAyC;IACxE,IAAW,SAAS,CAAC,KAAK,EAAE,OAAO,EAA2C;IAE9E,OAAO,CAAC,eAAe,CAAqC;IAC5D,IAAW,cAAc,2BAIxB;IAED,IAAW,MAAM,IAAI,MAAM,CAAsC;IACjE,IAAW,MAAM,CAAC,KAAK,EAAE,MAAM,EAAwC;IAEvE,OAAO,CAAC,eAAe,CAAsC;IAC7D,IAAW,cAAc,4BAKxB;IAED,IAAW,MAAM,IAAI,OAAO,CAAsC;IAClE,IAAW,MAAM,CAAC,KAAK,EAAE,OAAO,EAAwC;IAExE,OAAO,CAAC,mBAAmB,CAAsC;IACjE,IAAW,kBAAkB,4BAK5B;IAED,IAAW,UAAU,IAAI,OAAO,CAA0C;IAC1E,IAAW,UAAU,CAAC,KAAK,EAAE,OAAO,EAA4C;cAE7D,UAAU,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;cAIjC,iBAAiB,CAAC,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;cAwF9E,4BAA4B,CAAC,QAAQ,EAAE,cAAc,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,SAAS;IAQzF,8BAA8B,CAAC,YAAY,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5F,4BAA4B,IAAI,UAAU,EAAE,GAAG,SAAS;IAmB3D,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;CAK5C;AAED,uDAAuD;AACvD,oBAAY,eAAe;IACzB,kDAAkD;IAClD,UAAU,IAAA;IACV,4DAA4D;IAC5D,gBAAgB,IAAA;IAChB,kDAAkD;IAClD,YAAY,IAAA;IACZ,8CAA8C;IAC9C,eAAe,IAAA;IACf,0CAA0C;IAC1C,YAAY,IAAA;CACb;AAED,sGAAsG;AACtG,qBAAa,cAAe,SAAQ,kBAAkB;IACpD,OAAuB,MAAM,SAAgB;IAC7C,OAAuB,QAAQ,SAAiB;IAEhD,SAAS,CAAC,WAAW,kBAA8B;cAEhC,qBAAqB,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,yBAAyB,EAAE,GAAG,IAAI;cAmBlG,aAAa,IAAI,IAAI;IA4BxC,OAAO,CAAC,sBAAsB,CAAsC;IACpE,IAAW,qBAAqB,4BAI/B;IAED,IAAW,aAAa,IAAI,OAAO,CAA6C;IAChF,IAAW,aAAa,CAAC,KAAK,EAAE,OAAO,EAA+C;IAEtF,OAAO,CAAC,mBAAmB,CAAqC;IAChE,IAAW,kBAAkB,2BAI5B;IAED,IAAW,UAAU,IAAI,MAAM,CAA0C;IACzE,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,EAA4C;IAE/E,OAAO,CAAC,qBAAqB,CAAsC;IACnE,IAAW,oBAAoB,4BAI9B;IAED,IAAW,YAAY,IAAI,OAAO,CAA4C;IAC9E,IAAW,YAAY,CAAC,KAAK,EAAE,OAAO,EAA8C;IAEpF,OAAO,CAAC,kBAAkB,CAAqC;IAC/D,IAAW,iBAAiB,2BAI3B;IAED,IAAW,SAAS,IAAI,MAAM,CAAyC;IACvE,IAAW,SAAS,CAAC,KAAK,EAAE,MAAM,EAA2C;IAE7E,OAAO,CAAC,kBAAkB,CAAsC;IAChE,IAAW,iBAAiB,4BAI3B;IAED,IAAW,SAAS,IAAI,OAAO,CAAyC;IACxE,IAAW,SAAS,CAAC,KAAK,EAAE,OAAO,EAA2C;IAE9E,OAAO,CAAC,eAAe,CAAqC;IAC5D,IAAW,cAAc,2BAIxB;IAED,IAAW,MAAM,IAAI,MAAM,CAAsC;IACjE,IAAW,MAAM,CAAC,KAAK,EAAE,MAAM,EAAwC;IAEvE,OAAO,CAAC,eAAe,CAAsC;IAC7D,IAAW,cAAc,4BAKxB;IAED,IAAW,MAAM,IAAI,OAAO,CAAsC;IAClE,IAAW,MAAM,CAAC,KAAK,EAAE,OAAO,EAAwC;IAExE,OAAO,CAAC,mBAAmB,CAAsC;IACjE,IAAW,kBAAkB,4BAK5B;IAED,IAAW,UAAU,IAAI,OAAO,CAA0C;IAC1E,IAAW,UAAU,CAAC,KAAK,EAAE,OAAO,EAA4C;cAE7D,UAAU,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;cAIjC,iBAAiB,CAAC,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;cAmH9E,4BAA4B,CAAC,QAAQ,EAAE,cAAc,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,SAAS;IAUzF,8BAA8B,CAAC,YAAY,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5F,4BAA4B,IAAI,UAAU,EAAE,GAAG,SAAS;IAuB3D,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;CAK5C"}