@itwin/core-frontend/lib/esm/common/render/InstancedGraphicParams.d.ts

iTwin.js frontend components

/** @packageDocumentation
 * @module Rendering
 */
import { LowAndHighXYZ, Point2d, Point3d, Range3d, Transform, XYAndZ } from "@itwin/core-geometry";
/** Parameters for creating a [[RenderGraphic]] representing a collection of instances of shared geometry.
 * Each instance is drawn using the same graphics, but with its own transform and (optionally) [[Feature]] Id.
 * @public
 */
export interface InstancedGraphicParams {
    /** The number of instances.
     * Must be greater than zero.
     * Must be equal to (transforms.length / 12)
     * If featureIds is defined, must be equal to (featureIds.length / 3)
     * If symbologyOverrides is defined, must be equal to (symbologyOverrides.length / 8)
     */
    readonly count: number;
    /** An array of instance-to-model transforms.
     * Each transform consists of 3 rows of 4 columns where the 4th column holds the translation.
     * The translations are relative to the [[transformCenter]] property.
     */
    readonly transforms: Float32Array;
    /** A point roughly in the center of the range of all of the instances, to which each instance's translation is relative.
     * This is used to reduce precision errors when transforming the instances in shader code.
     */
    readonly transformCenter: Point3d;
    /** If defined, an array of little-endian 24-bit unsigned integers containing the feature ID of each instance. */
    readonly featureIds?: Uint8Array;
    /** If defined, as array of bytes (8 per instance) encoding the symbology overrides for each instance.
     * The encoding matches that used by FeatureOverrides, though only the RGB, alpha, line weight, and line code are used.
     */
    readonly symbologyOverrides?: Uint8Array;
    /** If defined, the combined range of all instances of the geometry. */
    readonly range?: Range3d;
}
/** A representation of an [[InstancedGraphicParams]] that can be copied using [structured cloning](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone),
 * e.g., when transferring between Workers. This representation is used by [[RenderInstancesParams]].
 * @see [[InstancedGraphicParams.toProps]] and [[InstancedGraphicParams.fromProps]] to convert between representations.
 * @see [[InstancedGraphicProps.collectTransferables]] to extract Transferable objects for structured clone.
 * @public
 */
export type InstancedGraphicProps = Omit<InstancedGraphicParams, "transformCenter" | "range"> & {
    transformCenter: XYAndZ;
    range?: LowAndHighXYZ;
};
/** @public */
export declare namespace InstancedGraphicProps {
    /** Add all [Transferable objects](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects) from `props`
     * into `xfers`.
     */
    function collectTransferables(xfers: Set<Transferable>, props: InstancedGraphicProps): void;
}
/** @public */
export declare namespace InstancedGraphicParams {
    /** Convert `params` to a representation that can be copied using [structured cloning](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone). */
    function toProps(params: InstancedGraphicParams): InstancedGraphicProps;
    /** Create an [[InstancedGraphicParams]] from an [[InstancedGraphicProps]]. */
    function fromProps(props: InstancedGraphicProps): InstancedGraphicParams;
}
/** Parameters for creating a [[RenderGraphic]] representing a patterned area.
 * A patterned area is a planar region filled with a pattern symbol repeated in
 * a regular grid and clipped by the region's boundary.
 * @internal
 */
export interface PatternGraphicParams {
    readonly xyOffsets: Float32Array;
    readonly featureId?: number;
    readonly orgTransform: Transform;
    readonly scale: number;
    readonly spacing: Point2d;
    readonly origin: Point2d;
    /** Usually, to tile tree coordinates. */
    readonly patternToModel: Transform;
    /** Range of pattern boundary in model (tile tree, usually) coordinates. */
    readonly range: Range3d;
    readonly symbolTranslation: Point3d;
    readonly viewIndependentOrigin?: Point3d;
}
//# sourceMappingURL=InstancedGraphicParams.d.ts.map