@itwin/core-frontend/lib/esm/internal/render/GraphicTemplateImpl.d.ts

iTwin.js frontend components

/** @packageDocumentation
 * @module Rendering
 */
import { Range3d, Transform } from "@itwin/core-geometry";
import { RenderGeometry } from "./RenderGeometry";
import { RenderFeatureTable, ViewFlagOverrides } from "@itwin/core-common";
import { InstancedGraphicParams } from "../../common/render/InstancedGraphicParams";
import { BatchOptions } from "../../common/render/BatchOptions";
import { GraphicTemplate } from "../../render/GraphicTemplate";
/** @internal */
export interface GraphicTemplateNode {
    geometry: RenderGeometry[];
    /** For glTF models, the flattened transform of the scene graph node. */
    transform?: Transform;
    /** For glTF models, the instances associated with the scene graph node, or with the model as a whole. */
    instances?: InstancedGraphicParams;
}
/** Describes the collection of $[Feature]($common)s in a [[GraphicTemplate]].
 * If the template is used for instancing, the batch information in the [[RenderInstances]] overrides this.
 * @internal
 */
export interface GraphicTemplateBatch {
    readonly featureTable: RenderFeatureTable;
    readonly options?: BatchOptions;
    readonly range: Range3d;
}
/** Applies a transform and/or view flag overrides to all of the nodes in a [[GraphicTemplate]].
 * @internal
 */
export interface GraphicTemplateBranch {
    readonly transform?: Transform;
    readonly viewFlagOverrides?: ViewFlagOverrides;
}
/** Create a GraphicTemplate.
 * If the caller specifies `noDispose` as `true`, every RenderGeometry in every node will be marked `noDispose`;
 * this permits the same template to be reused by multiple graphics. The garbage collector will reclaim its
 * WebGL resources and its `dispose` method will do nothing.
 * The `isInstancable` flag will be calculated from the nodes and their geometry.
 * @internal
 */
export declare function createGraphicTemplate(args: {
    nodes: GraphicTemplateNode[];
    batch?: GraphicTemplateBatch;
    noDispose: boolean;
    branch?: GraphicTemplateBranch;
}): GraphicTemplate;
//# sourceMappingURL=GraphicTemplateImpl.d.ts.map