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

package/lib/esm/ElementGeometryTool.d.ts

@@ -1,148 +1,148 @@
-/** @packageDocumentation
- * @module Editing
- */
-import { Id64Arg, Id64String } from "@itwin/core-bentley";
-import { FeatureAppearance } from "@itwin/core-common";
-import { BeButtonEvent, BeModifierKeys, CoordinateLockOverrides, DecorateContext, DynamicsContext, ElementSetTool, EventHandled, FeatureOverrideProvider, FeatureSymbology, GraphicBranchOptions, GraphicType, HitDetail, IModelConnection, LocateResponse, RenderGraphicOwner, SelectionMethod, SelectionSet, ToolAssistanceInstruction, Viewport } from "@itwin/core-frontend";
-import { Point3d, Ray3d, Transform } from "@itwin/core-geometry";
-import { BRepEntityType, ElementGeometryCacheFilter, ElementGeometryResultProps, SubEntityFilter, SubEntityGeometryProps, SubEntityLocationProps, SubEntityProps, SubEntityType } from "@itwin/editor-common";
-/** @alpha */
-export declare class ElementGeometryGraphicsProvider {
-    readonly iModel: IModelConnection;
-    graphic?: RenderGraphicOwner;
-    constructor(iModel: IModelConnection);
-    /** Call to request a RenderGraphic for the supplied graphic data.
-     * @see [[cleanupGraphic]] Must be called when the tool exits.
-     */
-    createGraphic(graphicData: Uint8Array): Promise<boolean>;
-    /** 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, opts?: GraphicBranchOptions): void;
-    addDecoration(context: DecorateContext, type: GraphicType, transform?: Transform, opts?: GraphicBranchOptions): void;
-}
-/** @alpha */
-export declare function isSameSubEntity(a: SubEntityProps, b: SubEntityProps): boolean;
-/** @alpha */
-export declare class SubEntityData {
-    toolData?: any;
-    chordTolerance?: number;
-    private _props;
-    private _geometry?;
-    private _graphicsProvider?;
-    constructor(props: SubEntityProps);
-    get props(): SubEntityProps;
-    set props(value: SubEntityProps);
-    get geometry(): SubEntityGeometryProps | undefined;
-    set geometry(value: SubEntityGeometryProps | undefined);
-    isSame(other: SubEntityProps): boolean;
-    getAppearance(vp: Viewport, accepted: boolean): FeatureAppearance;
-    createGraphic(iModel: IModelConnection): Promise<boolean>;
-    cleanupGraphic(): void;
-    get hasGraphic(): boolean;
-    display(context: DecorateContext, accepted: boolean): void;
-}
-/** @alpha Base class for tools that want to use the backend geometry cache. */
-export declare abstract class ElementGeometryCacheTool extends ElementSetTool implements FeatureOverrideProvider {
-    protected _startedCmd?: string;
-    protected readonly _checkedIds: Map<string, boolean>;
-    protected _graphicsProvider?: ElementGeometryGraphicsProvider;
-    protected _graphicsPending?: true;
-    protected _firstResult: boolean;
-    protected _agendaAppearanceDefault?: FeatureAppearance;
-    protected _agendaAppearanceDynamic?: FeatureAppearance;
-    protected allowView(vp: Viewport): boolean;
-    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
-    protected startCommand(): Promise<string>;
-    protected agendaAppearance(isDynamics: boolean): FeatureAppearance;
-    protected get wantAgendaAppearanceOverride(): boolean;
-    addFeatureOverrides(overrides: FeatureSymbology.Overrides, _vp: Viewport): void;
-    protected updateAgendaAppearanceProvider(drop?: true): void;
-    protected get geometryCacheFilter(): ElementGeometryCacheFilter | undefined;
-    protected onGeometryCacheFilterChanged(): void;
-    protected createElementGeometryCache(id: Id64String): Promise<boolean>;
-    protected acceptElementForOperation(id: Id64String): Promise<boolean>;
-    protected isElementValidForOperation(hit: HitDetail, out?: LocateResponse): Promise<boolean>;
-    protected postFilterIds(arg: Id64Arg): Promise<Id64Arg>;
-    protected getGroupIds(id: Id64String): Promise<Id64Arg>;
-    protected getSelectionSetCandidates(ss: SelectionSet): Promise<Id64Arg>;
-    protected getDragSelectCandidates(vp: Viewport, origin: Point3d, corner: Point3d, method: SelectionMethod, overlap: boolean): Promise<Id64Arg>;
-    onDynamicFrame(_ev: BeButtonEvent, context: DynamicsContext): void;
-    onMouseMotion(ev: BeButtonEvent): Promise<void>;
-    protected getGraphicData(_ev: BeButtonEvent): Promise<Uint8Array | undefined>;
-    protected updateGraphic(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
-    protected createGraphic(graphicData: Uint8Array): Promise<void>;
-    protected clearGraphic(): void;
-    protected clearElementGeometryCache(): Promise<void>;
-    onUnsuspend(): Promise<void>;
-    onSuspend(): Promise<void>;
-    onPostInstall(): Promise<void>;
-    onCleanup(): Promise<void>;
-}
-/** @alpha Base class for tools that need to locate faces, edges, and vertices. */
-export declare abstract class LocateSubEntityTool extends ElementGeometryCacheTool {
-    protected _currentSubEntity?: SubEntityData;
-    protected _acceptedSubEntities: SubEntityData[];
-    protected _locatedSubEntities?: SubEntityLocationProps[];
-    protected _subEntityGraphicPending?: true;
-    protected readonly _summaryIds: Map<string, BRepEntityType[]>;
-    protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
-    protected get wantAgendaAppearanceOverride(): boolean;
-    protected get wantGeometrySummary(): boolean;
-    protected get wantSubEntitySnap(): boolean;
-    protected wantSubEntityType(type: SubEntityType): boolean;
-    protected getMaximumSubEntityHits(type: SubEntityType): number;
-    protected get requiredSubEntityCount(): number;
-    protected get haveAcceptedSubEntities(): boolean;
-    protected get inhibitSubEntityDisplay(): boolean;
-    protected get allowSubEntityControlSelect(): boolean;
-    protected get allowSubEntityControlDeselect(): boolean;
-    protected get allowSubEntitySelectNext(): boolean;
-    protected getBRepEntityTypeForSubEntity(id: Id64String, subEntity: SubEntityProps): BRepEntityType;
-    protected createElementGeometrySummary(id: Id64String): Promise<boolean>;
-    protected createElementGeometryCache(id: Id64String): Promise<boolean>;
-    protected getAcceptedSubEntityData(index?: number): SubEntityData | undefined;
-    protected getAcceptedSubEntities(): SubEntityProps[];
-    protected drawSubEntity(context: DecorateContext, subEntity: SubEntityData, accepted: boolean): void;
-    protected drawAcceptedSubEntities(context: DecorateContext): void;
-    decorate(context: DecorateContext): void;
-    decorateSuspended(context: DecorateContext): void;
-    protected getLocateAperture(ev: BeButtonEvent): number;
-    protected getMaxRayDistance(ev: BeButtonEvent, aperture: number): number;
-    protected getRayOrigin(ev: BeButtonEvent): Point3d;
-    protected wantHiddenEdges(vp: Viewport): boolean;
-    protected getSubEntityFilter(): SubEntityFilter | undefined;
-    protected pickSubEntities(id: Id64String, boresite: Ray3d, maxFace: number, maxEdge: number, maxVertex: number, maxDistance: number, hiddenEdgesVisible: boolean, filter?: SubEntityFilter): Promise<SubEntityLocationProps[] | undefined>;
-    protected doPickSubEntities(id: Id64String, ev: BeButtonEvent): Promise<SubEntityLocationProps[] | undefined>;
-    protected createSubEntityData(id: Id64String, hit: SubEntityLocationProps): Promise<SubEntityData>;
-    /** Append specified sub-entity to accepted array. */
-    protected addSubEntity(id: Id64String, props: SubEntityLocationProps): Promise<void>;
-    /** Remove specified sub-entity from accepted array, or pop last sub-entity if undefined. */
-    protected removeSubEntity(_id: Id64String, props?: SubEntityLocationProps): Promise<void>;
-    /** Locate sub-entities for the most recently added (last) agenda entry. Tool sub-classes that wish to identity
-     * sub-entities from multiple elements are responsible for maintaining the sub-entities per-element.
-     */
-    protected doLocateSubEntity(ev: BeButtonEvent, newSearch: boolean): Promise<boolean>;
-    protected chooseNextHit(ev: BeButtonEvent): Promise<EventHandled>;
-    protected get wantAdditionalSubEntities(): boolean;
-    protected gatherInput(ev: BeButtonEvent): Promise<EventHandled | undefined>;
-    protected getCurrentElement(): Id64String | undefined;
-    protected clearCurrentSubEntity(): void;
-    protected setCurrentSubEntity(id: Id64String, hit: SubEntityLocationProps, chordTolerance?: number): Promise<boolean>;
-    protected changeCurrentSubEntity(id?: Id64String, current?: SubEntityLocationProps, chordTolerance?: number): Promise<boolean>;
-    protected updateCurrentSubEntity(ev: BeButtonEvent): Promise<boolean>;
-    protected createSubEntityGraphic(id: Id64String, data: SubEntityData, chordTolerance?: number): Promise<boolean>;
-    protected updateGraphic(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
-    protected getGraphicData(ev: BeButtonEvent): Promise<Uint8Array | undefined>;
-    protected applyAgendaOperation(_ev: BeButtonEvent, _isAccept: boolean): Promise<ElementGeometryResultProps | undefined>;
-    processAgenda(ev: BeButtonEvent): Promise<void>;
-    onModifierKeyTransition(wentDown: boolean, modifier: BeModifierKeys, event: KeyboardEvent): Promise<EventHandled>;
-    changeLocateState(enableLocate: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void;
-    protected get shouldEnableSnap(): boolean;
-    protected setupAccuDraw(): void;
-    protected setupAndPromptForNextAction(): void;
-    protected clearSubEntityGraphics(): void;
-    onCleanup(): Promise<void>;
-}
+/** @packageDocumentation
+ * @module Editing
+ */
+import { Id64Arg, Id64String } from "@itwin/core-bentley";
+import { FeatureAppearance } from "@itwin/core-common";
+import { BeButtonEvent, BeModifierKeys, CoordinateLockOverrides, DecorateContext, DynamicsContext, ElementSetTool, EventHandled, FeatureOverrideProvider, FeatureSymbology, GraphicBranchOptions, GraphicType, HitDetail, IModelConnection, LocateResponse, RenderGraphicOwner, SelectionMethod, SelectionSet, ToolAssistanceInstruction, Viewport } from "@itwin/core-frontend";
+import { Point3d, Ray3d, Transform } from "@itwin/core-geometry";
+import { BRepEntityType, ElementGeometryCacheFilter, ElementGeometryResultProps, SubEntityFilter, SubEntityGeometryProps, SubEntityLocationProps, SubEntityProps, SubEntityType } from "@itwin/editor-common";
+/** @alpha */
+export declare class ElementGeometryGraphicsProvider {
+    readonly iModel: IModelConnection;
+    graphic?: RenderGraphicOwner;
+    constructor(iModel: IModelConnection);
+    /** Call to request a RenderGraphic for the supplied graphic data.
+     * @see [[cleanupGraphic]] Must be called when the tool exits.
+     */
+    createGraphic(graphicData: Uint8Array): Promise<boolean>;
+    /** 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, opts?: GraphicBranchOptions): void;
+    addDecoration(context: DecorateContext, type: GraphicType, transform?: Transform, opts?: GraphicBranchOptions): void;
+}
+/** @alpha */
+export declare function isSameSubEntity(a: SubEntityProps, b: SubEntityProps): boolean;
+/** @alpha */
+export declare class SubEntityData {
+    toolData?: any;
+    chordTolerance?: number;
+    private _props;
+    private _geometry?;
+    private _graphicsProvider?;
+    constructor(props: SubEntityProps);
+    get props(): SubEntityProps;
+    set props(value: SubEntityProps);
+    get geometry(): SubEntityGeometryProps | undefined;
+    set geometry(value: SubEntityGeometryProps | undefined);
+    isSame(other: SubEntityProps): boolean;
+    getAppearance(vp: Viewport, accepted: boolean): FeatureAppearance;
+    createGraphic(iModel: IModelConnection): Promise<boolean>;
+    cleanupGraphic(): void;
+    get hasGraphic(): boolean;
+    display(context: DecorateContext, accepted: boolean): void;
+}
+/** @alpha Base class for tools that want to use the backend geometry cache. */
+export declare abstract class ElementGeometryCacheTool extends ElementSetTool implements FeatureOverrideProvider {
+    protected _startedCmd?: string;
+    protected readonly _checkedIds: Map<string, boolean>;
+    protected _graphicsProvider?: ElementGeometryGraphicsProvider;
+    protected _graphicsPending?: true;
+    protected _firstResult: boolean;
+    protected _agendaAppearanceDefault?: FeatureAppearance;
+    protected _agendaAppearanceDynamic?: FeatureAppearance;
+    protected allowView(vp: Viewport): boolean;
+    isCompatibleViewport(vp: Viewport | undefined, isSelectedViewChange: boolean): boolean;
+    protected startCommand(): Promise<string>;
+    protected agendaAppearance(isDynamics: boolean): FeatureAppearance;
+    protected get wantAgendaAppearanceOverride(): boolean;
+    addFeatureOverrides(overrides: FeatureSymbology.Overrides, _vp: Viewport): void;
+    protected updateAgendaAppearanceProvider(drop?: true): void;
+    protected get geometryCacheFilter(): ElementGeometryCacheFilter | undefined;
+    protected onGeometryCacheFilterChanged(): void;
+    protected createElementGeometryCache(id: Id64String): Promise<boolean>;
+    protected acceptElementForOperation(id: Id64String): Promise<boolean>;
+    protected isElementValidForOperation(hit: HitDetail, out?: LocateResponse): Promise<boolean>;
+    protected postFilterIds(arg: Id64Arg): Promise<Id64Arg>;
+    protected getGroupIds(id: Id64String): Promise<Id64Arg>;
+    protected getSelectionSetCandidates(ss: SelectionSet): Promise<Id64Arg>;
+    protected getDragSelectCandidates(vp: Viewport, origin: Point3d, corner: Point3d, method: SelectionMethod, overlap: boolean): Promise<Id64Arg>;
+    onDynamicFrame(_ev: BeButtonEvent, context: DynamicsContext): void;
+    onMouseMotion(ev: BeButtonEvent): Promise<void>;
+    protected getGraphicData(_ev: BeButtonEvent): Promise<Uint8Array | undefined>;
+    protected updateGraphic(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
+    protected createGraphic(graphicData: Uint8Array): Promise<void>;
+    protected clearGraphic(): void;
+    protected clearElementGeometryCache(): Promise<void>;
+    onUnsuspend(): Promise<void>;
+    onSuspend(): Promise<void>;
+    onPostInstall(): Promise<void>;
+    onCleanup(): Promise<void>;
+}
+/** @alpha Base class for tools that need to locate faces, edges, and vertices. */
+export declare abstract class LocateSubEntityTool extends ElementGeometryCacheTool {
+    protected _currentSubEntity?: SubEntityData;
+    protected _acceptedSubEntities: SubEntityData[];
+    protected _locatedSubEntities?: SubEntityLocationProps[];
+    protected _subEntityGraphicPending?: true;
+    protected readonly _summaryIds: Map<string, BRepEntityType[]>;
+    protected provideToolAssistance(mainInstrText?: string, additionalInstr?: ToolAssistanceInstruction[]): void;
+    protected get wantAgendaAppearanceOverride(): boolean;
+    protected get wantGeometrySummary(): boolean;
+    protected get wantSubEntitySnap(): boolean;
+    protected wantSubEntityType(type: SubEntityType): boolean;
+    protected getMaximumSubEntityHits(type: SubEntityType): number;
+    protected get requiredSubEntityCount(): number;
+    protected get haveAcceptedSubEntities(): boolean;
+    protected get inhibitSubEntityDisplay(): boolean;
+    protected get allowSubEntityControlSelect(): boolean;
+    protected get allowSubEntityControlDeselect(): boolean;
+    protected get allowSubEntitySelectNext(): boolean;
+    protected getBRepEntityTypeForSubEntity(id: Id64String, subEntity: SubEntityProps): BRepEntityType;
+    protected createElementGeometrySummary(id: Id64String): Promise<boolean>;
+    protected createElementGeometryCache(id: Id64String): Promise<boolean>;
+    protected getAcceptedSubEntityData(index?: number): SubEntityData | undefined;
+    protected getAcceptedSubEntities(): SubEntityProps[];
+    protected drawSubEntity(context: DecorateContext, subEntity: SubEntityData, accepted: boolean): void;
+    protected drawAcceptedSubEntities(context: DecorateContext): void;
+    decorate(context: DecorateContext): void;
+    decorateSuspended(context: DecorateContext): void;
+    protected getLocateAperture(ev: BeButtonEvent): number;
+    protected getMaxRayDistance(ev: BeButtonEvent, aperture: number): number;
+    protected getRayOrigin(ev: BeButtonEvent): Point3d;
+    protected wantHiddenEdges(vp: Viewport): boolean;
+    protected getSubEntityFilter(): SubEntityFilter | undefined;
+    protected pickSubEntities(id: Id64String, boresite: Ray3d, maxFace: number, maxEdge: number, maxVertex: number, maxDistance: number, hiddenEdgesVisible: boolean, filter?: SubEntityFilter): Promise<SubEntityLocationProps[] | undefined>;
+    protected doPickSubEntities(id: Id64String, ev: BeButtonEvent): Promise<SubEntityLocationProps[] | undefined>;
+    protected createSubEntityData(id: Id64String, hit: SubEntityLocationProps): Promise<SubEntityData>;
+    /** Append specified sub-entity to accepted array. */
+    protected addSubEntity(id: Id64String, props: SubEntityLocationProps): Promise<void>;
+    /** Remove specified sub-entity from accepted array, or pop last sub-entity if undefined. */
+    protected removeSubEntity(_id: Id64String, props?: SubEntityLocationProps): Promise<void>;
+    /** Locate sub-entities for the most recently added (last) agenda entry. Tool sub-classes that wish to identity
+     * sub-entities from multiple elements are responsible for maintaining the sub-entities per-element.
+     */
+    protected doLocateSubEntity(ev: BeButtonEvent, newSearch: boolean): Promise<boolean>;
+    protected chooseNextHit(ev: BeButtonEvent): Promise<EventHandled>;
+    protected get wantAdditionalSubEntities(): boolean;
+    protected gatherInput(ev: BeButtonEvent): Promise<EventHandled | undefined>;
+    protected getCurrentElement(): Id64String | undefined;
+    protected clearCurrentSubEntity(): void;
+    protected setCurrentSubEntity(id: Id64String, hit: SubEntityLocationProps, chordTolerance?: number): Promise<boolean>;
+    protected changeCurrentSubEntity(id?: Id64String, current?: SubEntityLocationProps, chordTolerance?: number): Promise<boolean>;
+    protected updateCurrentSubEntity(ev: BeButtonEvent): Promise<boolean>;
+    protected createSubEntityGraphic(id: Id64String, data: SubEntityData, chordTolerance?: number): Promise<boolean>;
+    protected updateGraphic(ev: BeButtonEvent, isDynamics: boolean): Promise<void>;
+    protected getGraphicData(ev: BeButtonEvent): Promise<Uint8Array | undefined>;
+    protected applyAgendaOperation(_ev: BeButtonEvent, _isAccept: boolean): Promise<ElementGeometryResultProps | undefined>;
+    processAgenda(ev: BeButtonEvent): Promise<void>;
+    onModifierKeyTransition(wentDown: boolean, modifier: BeModifierKeys, event: KeyboardEvent): Promise<EventHandled>;
+    changeLocateState(enableLocate: boolean, enableSnap?: boolean, cursor?: string, coordLockOvr?: CoordinateLockOverrides): void;
+    protected get shouldEnableSnap(): boolean;
+    protected setupAccuDraw(): void;
+    protected setupAndPromptForNextAction(): void;
+    protected clearSubEntityGraphics(): void;
+    onCleanup(): Promise<void>;
+}
 //# sourceMappingURL=ElementGeometryTool.d.ts.map