@itwin/unified-selection/lib/esm/unified-selection/types/IModel.d.ts

Package for managing unified selection in iTwin.js applications.

import { Id64Arg, Id64Set } from "@itwin/core-bentley";
import { Event } from "@itwin/presentation-shared";
/**
 * A collection of geometric element, model and subcategory ids that can be added to
 * a [[SelectionSet]] or [[HiliteSet]].
 *
 * **Warning:** This type was added to `@itwin/core-frontend` in 5.0.
 *
 * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectableids/
 * @public
 */
export interface CoreSelectableIds {
    elements?: Id64Arg;
    models?: Id64Arg;
    subcategories?: Id64Arg;
}
/**
 * Identifies the type of changes made to the `CoreIModelSelectionSet` to produce a `CoreSelectionSetEvent`.
 * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/
 * @internal
 */
export declare enum CoreSelectionSetEventType {
    /** Elements have been added to the set. */
    Add = 0,
    /** Elements have been removed from the set. */
    Remove = 1,
    /** Some elements have been added to the set and others have been removed. */
    Replace = 2,
    /** All elements are about to be removed from the set. */
    Clear = 3
}
/**
 * Payload sent to `CoreIModelSelectionSet.onChanged` event listeners to describe how the contents of the set have changed.
 * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionsetevent/
 * @public
 */
export interface CoreSelectionSetEventUnsafe {
    /**
     * The type of operation that produced this event.
     *
     * Actually, this should be `CoreSelectionSetEventType`, however we can't use it here because in TS two identical enums with
     * different names aren't equal, so [`SelectionSetEventType `](https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/)
     * doesn't map to `CoreSelectionSetEventType` as far as TS is concerned. Due to this reason, this interface is marked as `unsafe`.
     */
    type: number;
    /** The element Ids added to the set. */
    added?: Id64Arg;
    /**
     * A collection of geometric element, model and subcategory ids that have been removed from selection set.
     *
     * **Warning:** This property was added to `@itwin/core-frontend` in 5.0.
     */
    additions?: CoreSelectableIds;
    /** The element Ids removed from the set. */
    removed?: Id64Arg;
    /**
     * A collection of geometric element, model and subcategory ids that have been added to selection set.
     *
     * **Warning:** This property was added to `@itwin/core-frontend` in 5.0.
     */
    removals?: CoreSelectableIds;
    /** The affected `CoreIModelSelectionSet`. */
    set: CoreIModelSelectionSet;
}
/**
 * A set of *currently selected* elements in an iModel.
 * @see https://www.itwinjs.org/reference/core-frontend/selectionset/
 * @public
 */
export type CoreIModelSelectionSet = {
    /** Event called whenever elements are added or removed from this SelectionSet. */
    onChanged: Event<(ev: CoreSelectionSetEventUnsafe) => void>;
    /** The IDs of the selected elements. */
    readonly elements: Set<string>;
    /** Clear current selection set. */
    emptyAll(): void;
} & ({
    /** Add one or more Ids to the current selection set. */
    add(elem: Id64Arg): boolean;
    /** Remove one or more Ids from the current selection set. */
    remove(elem: Id64Arg): boolean;
} | {
    /**
     * Get the active selection as a collection of geometric element, model and subcategory ids.
     */
    readonly active: {
        [P in keyof CoreSelectableIds]-?: Id64Set;
    };
    /**
     * Adds a collection of geometric element, model and subcategory ids to this selection set.
     *
     * The overload was added only in 5.0 `@itwin/core-frontend`. The `active` property can be used
     * to check if this `overload` is available.
     */
    add: (ids: Id64Arg | CoreSelectableIds) => boolean;
    /**
     * Adds a collection of geometric element, model and subcategory ids to this selection set.
     *
     * The overload was added only in 5.0 `@itwin/core-frontend`. The `active` property can be used
     * to check if this `overload` is available.
     */
    remove: (ids: Id64Arg | CoreSelectableIds) => boolean;
});
/**
 * A set if ID's optimized for performance-critical code which represents large sets of ID's as pairs of 32-bit integers.
 * @see https://www.itwinjs.org/reference/core-bentley/ids/id64/id64.uint32set/
 * @public
 */
interface Uint32Set {
    /** Add any number of Ids to the set. */
    addIds(ids: Id64Arg): void;
    /** Remove any number of Ids from the set. */
    deleteIds(ids: Id64Arg): void;
}
/**
 * A set of *hilited* elements in an iModel, by element id.
 * @see https://www.itwinjs.org/reference/core-frontend/selectionset/hiliteset/
 * @public
 */
export interface CoreIModelHiliteSet {
    /** Control whether the hilited elements should be synchronized with the contents of `CoreIModelSelectionSet`.*/
    wantSyncWithSelectionSet: boolean;
    /** The set of hilited elements. */
    readonly elements: Uint32Set;
    /** The set of hilited subcategories. */
    readonly subcategories: Uint32Set;
    /** The set of hilited models. */
    readonly models: Uint32Set;
    /** Remove all elements from the hilited set. */
    clear(): void;
}
export {};
//# sourceMappingURL=IModel.d.ts.map