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

iTwin.js frontend components

/** @packageDocumentation
 * @module Tiles
 */
import type { ByteStream, Id64Set, Id64String } from "@itwin/core-bentley";
import { BatchType } from "@itwin/core-common";
import type { IModelConnection } from "../../IModelConnection";
import { RenderSystem } from "../../render/RenderSystem";
import type { ImdlTimeline } from "../../common/imdl/ParseImdlDocument";
import { ImdlReaderResult } from "../../tile/internal";
import { BatchOptions } from "../../common/render/BatchOptions";
import { LayerTileData } from "../render/webgl/MapLayerParams";
/** Arguments supplied to [[ImdlDecoder.decode]].
 */
export interface ImdlDecodeArgs {
    /** The encoded tile content. */
    stream: ByteStream;
    /** The render system used to create graphics from the tile content. */
    system: RenderSystem;
    isLeaf?: boolean;
    sizeMultiplier?: number;
    options?: BatchOptions | false;
    isCanceled?: () => boolean;
    /** An array of model groups. If supplied, the graphics associated with each group of models will be decoded into a separate GraphciBranch
     * with [[GraphicBranch.groupNodeId]] set to the index of the group to which the model belongs.
     */
    modelGroups?: Id64Set[];
    tileData?: LayerTileData;
}
/** An object that can decode graphics in iMdl format.
 * @note decoders are reference-counted. When you are finished using one, call [[release]].
 * @see [[acquireImdlDecoder]] to acquire a decoder.
 * @internal
 */
export interface ImdlDecoder {
    decode(args: ImdlDecodeArgs): Promise<ImdlReaderResult>;
    release(): void;
}
/** Arguments supplied to [[acquireImdlDecoder]].
 */
export interface AcquireImdlDecoderArgs {
    iModel: IModelConnection;
    batchModelId: Id64String;
    is3d: boolean;
    type?: BatchType;
    omitEdges?: boolean;
    containsTransformNodes?: boolean;
    timeline?: ImdlTimeline;
    noWorker?: boolean;
}
/** Acquire shared ownership of an [[ImdlDecoder]].
 * Decoders are reference-counted, because they make use of reference-counted [[ImdlParser]]s internally.
 * The caller of this function increments the reference count of the decoder and is responsible
 * for decrementing it by calling [[ImdlDecoder.release]] when it is no longer needed. Typically, a decoder's lifetime is tied to the
 * lifetime of some `Disposable` object like a [[TileTree]] - acquired in the constructor, and released in the `[Symbol.dispose]` method.
 * @internal
 */
export declare function acquireImdlDecoder(args: AcquireImdlDecoderArgs): ImdlDecoder;
//# sourceMappingURL=ImdlDecoder.d.ts.map