@itwin/editor-frontend 4.0.0-dev.8 → 4.0.0-dev.81

package/lib/esm/CreateElementTool.d.ts

@@ -1,101 +1,101 @@
-import { Id64String } from "@itwin/core-bentley";
-import { Point3d, Range3d, Transform } from "@itwin/core-geometry";
-import { ElementGeometryBuilderParams, FlatBufferGeometryStream, GeometricElementProps, JsonGeometryStream, PlacementProps } from "@itwin/core-common";
-import { BeButtonEvent, DynamicsContext, EventHandled, IModelConnection, PrimitiveTool, RenderGraphicOwner, ToolAssistanceInstruction, Viewport } from "@itwin/core-frontend";
-/** @alpha */
-export declare function computeChordToleranceFromPoint(vp: Viewport, pt: Point3d, radius?: number): number;
-/** @alpha */
-export declare function computeChordToleranceFromRange(vp: Viewport, range: Range3d): number;
-/** @alpha */
-export declare class DynamicGraphicsProvider {
-    readonly iModel: IModelConnection;
-    readonly prefix: string;
-    graphic?: RenderGraphicOwner;
-    /** Current request for graphic */
-    private _graphicPromise?;
-    /** Optional element id generated graphics will be associated to */
-    elementId?: Id64String;
-    /** Optional model id generated graphics will be associated to */
-    modelId?: Id64String;
-    /** Chord tolerance to use to stroke the element's geometry in meters */
-    chordTolerance: number;
-    constructor(iModel: IModelConnection, prefix: string);
-    private getRequestId;
-    private getToleranceLog10;
-    private createRequest;
-    /** Call to request a RenderGraphic for the supplied geometry and placement.
-     * @see [[cleanupGraphic]] Must be called when the tool exits.
-     */
-    createGraphic(categoryId: Id64String, placement: PlacementProps, geometry: JsonGeometryStream | FlatBufferGeometryStream): Promise<boolean>;
-    /** Call to request a RenderGraphic for the supplied geometry and trigger a dynamic update upon fulfillment.
-     * @note May be useful to update a dynamic preview outside of normal button and motion events, ex. modifier key change.
-     * @see [[cleanupGraphic]] Must be called when the tool exits.
-     */
-    createGraphicAndUpdateDynamics(ev: BeButtonEvent, categoryId: Id64String, placement: PlacementProps, geometry: JsonGeometryStream | FlatBufferGeometryStream): void;
-    /** Call to dispose of [[RenderGraphic]] held by [[RenderGraphicOwner]].
-     * @note Must be called when the tool exits to avoid leaks of graphics memory or other webgl resources.
-     */
-    cleanupGraphic(): void;
-    addGraphic(context: DynamicsContext, transform?: Transform): void;
-}
-/** @alpha Placement tool base class for creating new elements. */
-export declare abstract class CreateElementTool extends PrimitiveTool {
-    get targetCategory(): Id64String;
-    get targetModelId(): Id64String;
-    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
-    /** Whether [[setupAndPromptForNextAction]] should call [[AccuSnap.enableSnap]] for current tool phase.
-     * @return true to enable snapping to elements.
-     */
-    protected get wantAccuSnap(): boolean;
-    /** Whether to automatically start element dynamics on button event.
-     * @return true if tool will implement [[InteractiveTool.onDynamicFrame]] to show element dynamics.
-     */
-    protected get wantDynamics(): boolean;
-    /** Whether tool is ready to insert the new element.
-     * @return true to call [[createElement]].
-     */
-    protected isComplete(_ev: BeButtonEvent): boolean;
-    /** Insert new element and call [[saveChanges]] */
-    protected abstract createElement(): Promise<void>;
-    /** Orchestrates advancing the internal state of the tool on a data button event.
-     * - Gather input: Initiates element dynamics and accepts additional points as required.
-     * - Complete operation: Create new element, restart or exit tool.
-     * @returns EventHandled.Yes if onReinitialize was called to restart or exit tool.
-     */
-    protected processDataButton(ev: BeButtonEvent): Promise<EventHandled>;
-    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
-    onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled>;
-    /** Setup initial tool state, prompts, etc. */
-    onPostInstall(): Promise<void>;
-    /** Restore tool assistance after no longer being suspended by either a [[ViewTool]] or [[InputCollector]]. */
-    onUnsuspend(): Promise<void>;
-    /** Setup auto-locate, AccuSnap, AccuDraw, and supply tool assistance. */
-    protected setupAndPromptForNextAction(): void;
-    /** Sub-classes should override to provide tool specific instructions. */
-    protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
-}
-/** @alpha Placement tool base class for creating new elements that use dynamics to show intermediate results. */
-export declare abstract class CreateElementWithDynamicsTool extends CreateElementTool {
-    protected _graphicsProvider?: DynamicGraphicsProvider;
-    protected get wantAccuSnap(): boolean;
-    protected get wantDynamics(): boolean;
-    protected clearGraphics(): void;
-    protected createGraphics(ev: BeButtonEvent): Promise<void>;
-    onDynamicFrame(_ev: BeButtonEvent, context: DynamicsContext): void;
-    onMouseMotion(ev: BeButtonEvent): Promise<void>;
-    protected abstract getPlacementProps(): PlacementProps | undefined;
-    protected abstract getGeometryProps(placement: PlacementProps): JsonGeometryStream | FlatBufferGeometryStream | undefined;
-    protected abstract getElementProps(placement: PlacementProps): GeometricElementProps | undefined;
-    protected doCreateElement(_props: GeometricElementProps, _data?: ElementGeometryBuilderParams): Promise<void>;
-    protected updateElementData(_ev: BeButtonEvent, _isDynamics: boolean): Promise<void>;
-    protected updateDynamicData(ev: BeButtonEvent): Promise<boolean>;
-    protected createElement(): Promise<void>;
-    protected setupAccuDraw(): void;
-    protected setupAndPromptForNextAction(): void;
-    protected acceptPoint(ev: BeButtonEvent): Promise<boolean>;
-    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
-    protected cancelPoint(_ev: BeButtonEvent): Promise<boolean>;
-    onResetButtonUp(ev: BeButtonEvent): Promise<EventHandled>;
-    onCleanup(): Promise<void>;
-}
+import { Id64String } from "@itwin/core-bentley";
+import { Point3d, Range3d, Transform } from "@itwin/core-geometry";
+import { ElementGeometryBuilderParams, FlatBufferGeometryStream, GeometricElementProps, JsonGeometryStream, PlacementProps } from "@itwin/core-common";
+import { BeButtonEvent, DynamicsContext, EventHandled, IModelConnection, PrimitiveTool, RenderGraphicOwner, ToolAssistanceInstruction, Viewport } from "@itwin/core-frontend";
+/** @alpha */
+export declare function computeChordToleranceFromPoint(vp: Viewport, pt: Point3d, radius?: number): number;
+/** @alpha */
+export declare function computeChordToleranceFromRange(vp: Viewport, range: Range3d): number;
+/** @alpha */
+export declare class DynamicGraphicsProvider {
+    readonly iModel: IModelConnection;
+    readonly prefix: string;
+    graphic?: RenderGraphicOwner;
+    /** Current request for graphic */
+    private _graphicPromise?;
+    /** Optional element id generated graphics will be associated to */
+    elementId?: Id64String;
+    /** Optional model id generated graphics will be associated to */
+    modelId?: Id64String;
+    /** Chord tolerance to use to stroke the element's geometry in meters */
+    chordTolerance: number;
+    constructor(iModel: IModelConnection, prefix: string);
+    private getRequestId;
+    private getToleranceLog10;
+    private createRequest;
+    /** Call to request a RenderGraphic for the supplied geometry and placement.
+     * @see [[cleanupGraphic]] Must be called when the tool exits.
+     */
+    createGraphic(categoryId: Id64String, placement: PlacementProps, geometry: JsonGeometryStream | FlatBufferGeometryStream): Promise<boolean>;
+    /** Call to request a RenderGraphic for the supplied geometry and trigger a dynamic update upon fulfillment.
+     * @note May be useful to update a dynamic preview outside of normal button and motion events, ex. modifier key change.
+     * @see [[cleanupGraphic]] Must be called when the tool exits.
+     */
+    createGraphicAndUpdateDynamics(ev: BeButtonEvent, categoryId: Id64String, placement: PlacementProps, geometry: JsonGeometryStream | FlatBufferGeometryStream): void;
+    /** Call to dispose of [[RenderGraphic]] held by [[RenderGraphicOwner]].
+     * @note Must be called when the tool exits to avoid leaks of graphics memory or other webgl resources.
+     */
+    cleanupGraphic(): void;
+    addGraphic(context: DynamicsContext, transform?: Transform): void;
+}
+/** @alpha Placement tool base class for creating new elements. */
+export declare abstract class CreateElementTool extends PrimitiveTool {
+    get targetCategory(): Id64String;
+    get targetModelId(): Id64String;
+    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
+    /** Whether [[setupAndPromptForNextAction]] should call [[AccuSnap.enableSnap]] for current tool phase.
+     * @return true to enable snapping to elements.
+     */
+    protected get wantAccuSnap(): boolean;
+    /** Whether to automatically start element dynamics on button event.
+     * @return true if tool will implement [[InteractiveTool.onDynamicFrame]] to show element dynamics.
+     */
+    protected get wantDynamics(): boolean;
+    /** Whether tool is ready to insert the new element.
+     * @return true to call [[createElement]].
+     */
+    protected isComplete(_ev: BeButtonEvent): boolean;
+    /** Insert new element and call [[saveChanges]] */
+    protected abstract createElement(): Promise<void>;
+    /** Orchestrates advancing the internal state of the tool on a data button event.
+     * - Gather input: Initiates element dynamics and accepts additional points as required.
+     * - Complete operation: Create new element, restart or exit tool.
+     * @returns EventHandled.Yes if onReinitialize was called to restart or exit tool.
+     */
+    protected processDataButton(ev: BeButtonEvent): Promise<EventHandled>;
+    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
+    onResetButtonUp(_ev: BeButtonEvent): Promise<EventHandled>;
+    /** Setup initial tool state, prompts, etc. */
+    onPostInstall(): Promise<void>;
+    /** Restore tool assistance after no longer being suspended by either a [[ViewTool]] or [[InputCollector]]. */
+    onUnsuspend(): Promise<void>;
+    /** Setup auto-locate, AccuSnap, AccuDraw, and supply tool assistance. */
+    protected setupAndPromptForNextAction(): void;
+    /** Sub-classes should override to provide tool specific instructions. */
+    protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
+}
+/** @alpha Placement tool base class for creating new elements that use dynamics to show intermediate results. */
+export declare abstract class CreateElementWithDynamicsTool extends CreateElementTool {
+    protected _graphicsProvider?: DynamicGraphicsProvider;
+    protected get wantAccuSnap(): boolean;
+    protected get wantDynamics(): boolean;
+    protected clearGraphics(): void;
+    protected createGraphics(ev: BeButtonEvent): Promise<void>;
+    onDynamicFrame(_ev: BeButtonEvent, context: DynamicsContext): void;
+    onMouseMotion(ev: BeButtonEvent): Promise<void>;
+    protected abstract getPlacementProps(): PlacementProps | undefined;
+    protected abstract getGeometryProps(placement: PlacementProps): JsonGeometryStream | FlatBufferGeometryStream | undefined;
+    protected abstract getElementProps(placement: PlacementProps): GeometricElementProps | undefined;
+    protected doCreateElement(_props: GeometricElementProps, _data?: ElementGeometryBuilderParams): Promise<void>;
+    protected updateElementData(_ev: BeButtonEvent, _isDynamics: boolean): Promise<void>;
+    protected updateDynamicData(ev: BeButtonEvent): Promise<boolean>;
+    protected createElement(): Promise<void>;
+    protected setupAccuDraw(): void;
+    protected setupAndPromptForNextAction(): void;
+    protected acceptPoint(ev: BeButtonEvent): Promise<boolean>;
+    onDataButtonDown(ev: BeButtonEvent): Promise<EventHandled>;
+    protected cancelPoint(_ev: BeButtonEvent): Promise<boolean>;
+    onResetButtonUp(ev: BeButtonEvent): Promise<EventHandled>;
+    onCleanup(): Promise<void>;
+}
 //# sourceMappingURL=CreateElementTool.d.ts.map