@itwin/core-frontend/lib/esm/tile/RenderGraphicTileTree.d.ts

iTwin.js frontend components

/** @packageDocumentation
 * @module Tiles
 */
import { Id64String } from "@itwin/core-bentley";
import { ViewFlagOverrides } from "@itwin/core-common";
import { TileTreeReference } from "./internal";
import { RenderGraphic } from "../render/RenderGraphic";
import { IModelConnection } from "../IModelConnection";
import { HitDetail } from "../HitDetail";
/** Arguments supplied to [[TileTreeReference.createFromRenderGraphic]].
 * @beta
 */
export interface RenderGraphicTileTreeArgs {
    /** The graphics that will be drawn by the [[TileTreeReference]]. */
    graphic: RenderGraphic;
    /** The iModel with which to associate the [[TileTreeReference]]. */
    iModel: IModelConnection;
    /** A transient Id to serve as the [[TileTree.modelId]], obtained from the [[iModel]]'s [TransientIdSequence]($bentley).
     * This model Id will be associated with any pickable [Feature]($common)s contained in your [[graphic]].
     */
    modelId: Id64String;
    /** Optional overrides for a subset of the [[Viewport]]'s [ViewFlags]($common) when drawing your [[graphic]].
     * If, for example, you always want your graphic to be drawn as illuminated 3d surfaces, specify the following:
     * ```ts
     * { renderMode: RenderMode.SmoothShade, lighting: true }
     * ```
     */
    viewFlags?: ViewFlagOverrides;
    /** A function that returns a tooltip describing a pickable [Feature]($common) inside your [[graphic]] when the user hovers the mouse over it. */
    getToolTip?: (hit: HitDetail) => Promise<HTMLElement | string | undefined>;
    /** Optionally overrides the default [[TileTreeReference.planarClipMaskPriority]]. */
    planarClipMaskPriority?: number;
}
/** @internal */
export declare function tileTreeReferenceFromRenderGraphic(args: RenderGraphicTileTreeArgs): TileTreeReference;
//# sourceMappingURL=RenderGraphicTileTree.d.ts.map