@itwin/core-frontend 4.8.0-dev.4 → 4.8.0-dev.41

package/lib/esm/common/render/GraphicAssembler.js

@@ -0,0 +1,382 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { assert } from "@itwin/core-bentley";
+import { Box, LineSegment3d, LineString3d, Loop, Path, Point3d, Transform, } from "@itwin/core-geometry";
+import { Feature, Frustum, GraphicParams, LinePixels, Npc } from "@itwin/core-common";
+import { _accumulator, _implementationProhibited } from "../internal/Symbols";
+import { GraphicType } from "./GraphicType";
+import { GeometryAccumulator } from "../internal/render/GeometryAccumulator";
+import { DisplayParams } from "../internal/render/DisplayParams";
+;
+/** Provides methods for assembling geometric primitives and symbology into a graphical representation.
+ * Two concrete implementations are provided:
+ *  - [[GraphicBuilder]], for creating [[RenderGraphic]]s directly; and
+ *  - [[GraphicDescriptionBuilder]], for creating a [[GraphicDescription]] from which a [[RenderGraphic]] can be produced.
+ *
+ * GraphicBuilder can only be used on the main JavaScript thread, so its use should be reserved for relatively simple, quick-to-produce graphics like [[Decorations]].
+ * GraphicDescriptionBuilder is designed for use in a [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker). It can be used to assemble more
+ * complex graphics without blocking the main thread.
+ *
+ * @note Most of the methods which add geometry to the builder take ownership of their inputs rather than cloning them.
+ * So, for example, if you pass an array of points to [[addLineString]], you should not subsequently modify that array.
+ * @public
+ * @extensions
+ */
+export class GraphicAssembler {
+    /** @internal */
+    constructor(options) {
+        this._graphicParams = new GraphicParams();
+        this.placement = options.placement?.clone() ?? Transform.createIdentity();
+        this.type = options.type;
+        this.pickable = options.pickable;
+        this.wantEdges = options.wantEdges;
+        this.preserveOrder = options.preserveOrder;
+        this.wantNormals = options.wantNormals;
+        this.analysisStyle = options.analysisStyle;
+        this[_accumulator] = new GeometryAccumulator({
+            analysisStyleDisplacement: this.analysisStyle?.displacement,
+        });
+        if (this.pickable) {
+            this.activateFeature(new Feature(this.pickable.id, this.pickable.subCategoryId, this.pickable.geometryClass));
+        }
+    }
+    /** Whether the builder's geometry is defined in [[CoordSystem.View]] coordinates.
+     * Only graphics of type [[GraphicType.ViewBackground]] or [[GraphicType.ViewOverlay]] are defined in view coordinates.
+     * @see [[isWorldCoordinates]].
+     */
+    get isViewCoordinates() {
+        return this.type === GraphicType.ViewBackground || this.type === GraphicType.ViewOverlay;
+    }
+    /** Whether the builder's geometry is defined in [[CoordSystem.World]] coordinates - the inverse of [[isViewCoordinates]]. */
+    get isWorldCoordinates() {
+        return !this.isViewCoordinates;
+    }
+    /** True if the builder produces a graphic of [[GraphicType.Scene]]. */
+    get isSceneGraphic() {
+        return this.type === GraphicType.Scene;
+    }
+    /** True if the builder produces a graphic of [[GraphicType.ViewBackground]]. */
+    get isViewBackground() {
+        return this.type === GraphicType.ViewBackground;
+    }
+    /** True if the builder produces a graphic of [[GraphicType.WorldOverlay]] or [[GraphicType.ViewOerlay]]. */
+    get isOverlay() {
+        return this.type === GraphicType.ViewOverlay || this.type === GraphicType.WorldOverlay;
+    }
+    /** Sets the current active symbology for this builder. Any new geometry subsequently added to the builder will be drawn using the specified symbology.
+     * @param graphicParams The symbology to apply to subsequent geometry.
+     * @see [[setSymbology]] for a convenient way to set common symbology options.
+     */
+    activateGraphicParams(graphicParams) {
+        graphicParams.clone(this._graphicParams);
+    }
+    /** Change the [Feature]($common) to be associated with subsequently-added geometry. This permits multiple features to be batched together into a single graphic
+     * for more efficient rendering.
+     * @note This method has no effect if [[pickable]] is not defined.
+     */
+    activateFeature(feature) {
+        assert(undefined !== this.pickable, "GraphicAssembler.activateFeature has no effect if PickableGraphicOptions were not supplied");
+        if (this.pickable) {
+            this[_accumulator].currentFeature = feature;
+        }
+    }
+    /** Change the pickable Id to be associated with subsequently-added geometry. This permits multiple pickable objects to be batched  together into a single graphic
+     * for more efficient rendering. This method calls [[activateFeature]], using the subcategory Id and [GeometryClass]($common) specified in [[pickable]]
+     * at construction, if any.
+     * @note This method has no effect if [[pickable]] is not defined.
+     */
+    activatePickableId(id) {
+        const pick = this.pickable;
+        this.activateFeature(new Feature(id, pick?.subCategoryId, pick?.geometryClass));
+    }
+    /**
+     * Appends a 3d line string to the builder.
+     * @param points Array of vertices in the line string.
+     */
+    addLineString(points) {
+        if (2 === points.length && points[0].isAlmostEqual(points[1]))
+            this[_accumulator].addPointString(points, this.getLinearDisplayParams(), this.placement);
+        else
+            this[_accumulator].addLineString(points, this.getLinearDisplayParams(), this.placement);
+    }
+    /**
+     * Appends a 2d line string to the builder.
+     * @param points Array of vertices in the line string.
+     * @param zDepth Z value in local coordinates to use for each point.
+     */
+    addLineString2d(points, zDepth) {
+        const pts3d = copy2dTo3d(points, zDepth);
+        this.addLineString(pts3d);
+    }
+    /**
+     * Appends a 3d point string to the builder. The points are drawn disconnected, with a diameter in pixels defined by the builder's active [[GraphicParams.rasterWidth]].
+     * @param points Array of vertices in the point string.
+     */
+    addPointString(points) {
+        this[_accumulator].addPointString(points, this.getLinearDisplayParams(), this.placement);
+    }
+    /**
+     * Appends a 2d point string to the builder. The points are drawn disconnected, with a diameter in pixels defined by the builder's active [[GraphicParams.rasterWidth]].
+     * @param points Array of vertices in the point string.
+     * @param zDepth Z value in local coordinates to use for each point.
+     */
+    addPointString2d(points, zDepth) {
+        const pts3d = copy2dTo3d(points, zDepth);
+        this.addPointString(pts3d);
+    }
+    /**
+     * Appends a closed 3d planar region to the builder.
+     * @param points Array of vertices of the shape.
+     */
+    addShape(points) {
+        const loop = Loop.create(LineString3d.create(points));
+        this[_accumulator].addLoop(loop, this.getMeshDisplayParams(), this.placement, false);
+    }
+    /**
+     * Appends a closed 2d region to the builder.
+     * @param points Array of vertices of the shape.
+     * @param zDepth Z value in local coordinates to use for each point.
+     */
+    addShape2d(points, zDepth) {
+        const pts3d = copy2dTo3d(points, zDepth);
+        this.addShape(pts3d);
+    }
+    /**
+     * Appends a 3d open arc or closed ellipse to the builder.
+     * @param arc Description of the arc or ellipse.
+     * @param isEllipse If true, and if the arc defines a full sweep, then draw as a closed ellipse instead of an arc.
+     * @param filled If true, and isEllipse is also true, then draw ellipse filled.
+     */
+    addArc(ellipse, isEllipse, filled) {
+        let curve;
+        if (isEllipse || filled) {
+            curve = Loop.create(ellipse);
+        }
+        else {
+            curve = Path.create(ellipse);
+        }
+        if (filled && !isEllipse && !ellipse.sweep.isFullCircle) {
+            const gapSegment = LineSegment3d.create(ellipse.startPoint(), ellipse.endPoint());
+            curve.children.push(gapSegment);
+        }
+        const displayParams = curve.isAnyRegionType ? this.getMeshDisplayParams() : this.getLinearDisplayParams();
+        if (curve instanceof Loop)
+            this[_accumulator].addLoop(curve, displayParams, this.placement, false);
+        else
+            this[_accumulator].addPath(curve, displayParams, this.placement, false);
+    }
+    /**
+     * Appends a 2d open arc or closed ellipse to the builder.
+     * @param arc Description of the arc or ellipse.
+     * @param isEllipse If true, and if the arc defines a full sweep, then draw as a closed ellipse instead of an arc.
+     * @param filled If true, and isEllipse is also true, then draw ellipse filled.
+     * @param zDepth Z value in local coordinates to use for each point in the arc or ellipse.
+     */
+    addArc2d(ellipse, isEllipse, filled, zDepth) {
+        if (0.0 === zDepth) {
+            this.addArc(ellipse, isEllipse, filled);
+        }
+        else {
+            const ell = ellipse;
+            ell.center.z = zDepth;
+            this.addArc(ell, isEllipse, filled);
+        }
+    }
+    /** Append a 3d open path to the builder. */
+    addPath(path) {
+        this[_accumulator].addPath(path, this.getLinearDisplayParams(), this.placement, false);
+    }
+    /** Append a 3d planar region to the builder. */
+    addLoop(loop) {
+        this[_accumulator].addLoop(loop, this.getMeshDisplayParams(), this.placement, false);
+    }
+    /** Append a [CurvePrimitive]($core-geometry) to the builder. */
+    addCurvePrimitive(curve) {
+        switch (curve.curvePrimitiveType) {
+            case "lineString":
+                this.addLineString(curve.points);
+                break;
+            case "lineSegment":
+                this.addLineString([curve.startPoint(), curve.endPoint()]);
+                break;
+            case "arc":
+                this.addArc(curve, false, false);
+                break;
+            default:
+                const path = new Path();
+                if (path.tryAddChild(curve))
+                    this.addPath(path);
+                break;
+        }
+    }
+    /** Append a mesh to the builder.
+     * @param meshData Describes the mesh
+     * @param _filled If the mesh describes a planar region, indicates whether its interior area should be drawn with fill in [[RenderMode.Wireframe]].
+     */
+    addPolyface(meshData, _filled = false) {
+        this[_accumulator].addPolyface(meshData, this.getMeshDisplayParams(), this.placement);
+    }
+    /** Append a solid primitive to the builder. */
+    addSolidPrimitive(primitive) {
+        this[_accumulator].addSolidPrimitive(primitive, this.getMeshDisplayParams(), this.placement);
+    }
+    /** Append any primitive to the builder.
+     * @param primitive The graphic primitive to append.
+     */
+    addPrimitive(primitive) {
+        switch (primitive.type) {
+            case "linestring":
+                this.addLineString(primitive.points);
+                break;
+            case "linestring2d":
+                this.addLineString2d(primitive.points, primitive.zDepth);
+                break;
+            case "pointstring":
+                this.addPointString(primitive.points);
+                break;
+            case "pointstring2d":
+                this.addPointString2d(primitive.points, primitive.zDepth);
+                break;
+            case "shape":
+                this.addShape(primitive.points);
+                break;
+            case "shape2d":
+                this.addShape2d(primitive.points, primitive.zDepth);
+                break;
+            case "arc":
+                this.addArc(primitive.arc, true === primitive.isEllipse, true === primitive.filled);
+                break;
+            case "arc2d":
+                this.addArc2d(primitive.arc, true === primitive.isEllipse, true === primitive.filled, primitive.zDepth);
+                break;
+            case "path":
+                this.addPath(primitive.path);
+                break;
+            case "loop":
+                this.addLoop(primitive.loop);
+                break;
+            case "polyface":
+                this.addPolyface(primitive.polyface, true === primitive.filled);
+                break;
+            case "solidPrimitive":
+                this.addSolidPrimitive(primitive.solidPrimitive);
+                break;
+        }
+    }
+    /** Add a box representing a volume of space. Typically used for debugging purposes.
+     * @param range The volume of space.
+     * @param solid If true, a [[Box]] solid primitive will be added; otherwise, a wireframe outline of the box will be added.
+     */
+    addRangeBox(range, solid = false) {
+        if (!solid) {
+            this.addFrustum(Frustum.fromRange(range));
+            return;
+        }
+        const box = Box.createRange(range, true);
+        if (box)
+            this.addSolidPrimitive(box);
+    }
+    /** Add Frustum edges. Useful for debugging. */
+    addFrustum(frustum) {
+        this.addRangeBoxFromCorners(frustum.points);
+    }
+    /** Add Frustum sides. Useful for debugging. */
+    addFrustumSides(frustum) {
+        this.addRangeBoxSidesFromCorners(frustum.points);
+    }
+    /** Add range edges from corner points */
+    addRangeBoxFromCorners(p) {
+        this.addLineString([
+            p[Npc.LeftBottomFront],
+            p[Npc.LeftTopFront],
+            p[Npc.RightTopFront],
+            p[Npc.RightBottomFront],
+            p[Npc.RightBottomRear],
+            p[Npc.RightTopRear],
+            p[Npc.LeftTopRear],
+            p[Npc.LeftBottomRear],
+            p[Npc.LeftBottomFront].clone(),
+            p[Npc.RightBottomFront].clone(),
+        ]);
+        this.addLineString([p[Npc.LeftTopFront].clone(), p[Npc.LeftTopRear].clone()]);
+        this.addLineString([p[Npc.RightTopFront].clone(), p[Npc.RightTopRear].clone()]);
+        this.addLineString([p[Npc.LeftBottomRear].clone(), p[Npc.RightBottomRear].clone()]);
+    }
+    /** Add range sides from corner points */
+    addRangeBoxSidesFromCorners(p) {
+        this.addShape([
+            p[Npc.LeftBottomFront].clone(),
+            p[Npc.LeftTopFront].clone(),
+            p[Npc.RightTopFront].clone(),
+            p[Npc.RightBottomFront].clone(),
+            p[Npc.LeftBottomFront].clone()
+        ]);
+        this.addShape([
+            p[Npc.RightTopRear].clone(),
+            p[Npc.LeftTopRear].clone(),
+            p[Npc.LeftBottomRear].clone(),
+            p[Npc.RightBottomRear].clone(),
+            p[Npc.RightTopRear].clone()
+        ]);
+        this.addShape([
+            p[Npc.RightTopRear].clone(),
+            p[Npc.LeftTopRear].clone(),
+            p[Npc.LeftTopFront].clone(),
+            p[Npc.RightTopFront].clone(),
+            p[Npc.RightTopRear].clone()
+        ]);
+        this.addShape([
+            p[Npc.RightTopRear].clone(),
+            p[Npc.RightBottomRear].clone(),
+            p[Npc.RightBottomFront].clone(),
+            p[Npc.RightTopFront].clone(),
+            p[Npc.RightTopRear].clone()
+        ]);
+        this.addShape([
+            p[Npc.LeftBottomRear].clone(),
+            p[Npc.RightBottomRear].clone(),
+            p[Npc.RightBottomFront].clone(),
+            p[Npc.LeftBottomFront].clone(),
+            p[Npc.LeftBottomRear].clone()
+        ]);
+        this.addShape([
+            p[Npc.LeftBottomRear].clone(),
+            p[Npc.LeftTopRear].clone(),
+            p[Npc.LeftTopFront].clone(),
+            p[Npc.LeftBottomFront].clone(),
+            p[Npc.LeftBottomRear].clone()
+        ]);
+    }
+    /** Sets the current active symbology for this builder. Any new geometry subsequently added will be drawn using the specified symbology.
+     * @param lineColor The color in which to draw lines.
+     * @param fillColor The color in which to draw filled regions.
+     * @param lineWidth The width in pixels to draw lines. The renderer will clamp this value to an integer in the range [1, 32].
+     * @param linePixels The pixel pattern in which to draw lines.
+     * @see [[activateGraphicParams]] for additional symbology options.
+     */
+    setSymbology(lineColor, fillColor, lineWidth, linePixels = LinePixels.Solid) {
+        this.activateGraphicParams(GraphicParams.fromSymbology(lineColor, fillColor, lineWidth, linePixels));
+    }
+    /** Set the current active symbology for this builder to be a blanking fill before adding a planar region.
+     * A planar region drawn with blanking fill renders behind other geometry in the same graphic.
+     * Blanking fill is not affected by the fill [[ViewFlags]] being disabled.
+     * An example would be to add a line to a graphic containing a shape with blanking fill so that the line is always shown in front of the fill.
+     * @param fillColor The color in which to draw filled regions.
+     */
+    setBlankingFill(fillColor) { this.activateGraphicParams(GraphicParams.fromBlankingFill(fillColor)); }
+    getMeshDisplayParams() { return DisplayParams.createForMesh(this._graphicParams, !this.wantNormals, (grad) => this.resolveGradient(grad)); }
+    getLinearDisplayParams() { return DisplayParams.createForLinear(this._graphicParams); }
+    add(geom) { this[_accumulator].addGeometry(geom); }
+}
+function copy2dTo3d(pts2d, depth) {
+    const pts3d = [];
+    for (const point of pts2d)
+        pts3d.push(Point3d.create(point.x, point.y, depth));
+    return pts3d;
+}
+//# sourceMappingURL=GraphicAssembler.js.map

package/lib/esm/common/render/GraphicAssembler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphicAssembler.js","sourceRoot":"","sources":["../../../../src/common/render/GraphicAssembler.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EACqB,GAAG,EAAmC,aAAa,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAW,OAAO,EAAqC,SAAS,GACxK,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAA2B,OAAO,EAAE,OAAO,EAAY,aAAa,EAAE,UAAU,EAAE,GAAG,EAAiB,MAAM,oBAAoB,CAAC;AACxI,OAAO,EAAE,YAAY,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAgBhE,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAgB,gBAAgB;IA4BpC,gBAAgB;IAChB,YAAsB,OAAgC;QAxBrC,mBAAc,GAAG,IAAI,aAAa,EAAE,CAAC;QAyBpD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,SAAS,CAAC,cAAc,EAAE,CAAC;QAC1E,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAE3C,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,mBAAmB,CAAC;YAC3C,yBAAyB,EAAE,IAAI,CAAC,aAAa,EAAE,YAAY;SAC5D,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,eAAe,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;QAChH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,cAAc,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,WAAW,CAAC;IAC3F,CAAC;IAED,6HAA6H;IAC7H,IAAW,kBAAkB;QAC3B,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC;IACjC,CAAC;IAED,uEAAuE;IACvE,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK,CAAC;IACzC,CAAC;IAED,gFAAgF;IAChF,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,cAAc,CAAC;IAClD,CAAC;IAED,4GAA4G;IAC5G,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,WAAW,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,YAAY,CAAC;IACzF,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAAC,aAA4B;QACvD,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,OAAgB;QACrC,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE,4FAA4F,CAAC,CAAC;QAClI,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,YAAY,CAAC,CAAC,cAAc,GAAG,OAAO,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,EAAc;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC3B,IAAI,CAAC,eAAe,CAAC,IAAI,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;IAClF,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,MAAiB;QACpC,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC3D,IAAI,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;;YAEzF,IAAI,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC5F,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,MAAiB,EAAE,MAAc;QACtD,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,MAAiB;QACrC,IAAI,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3F,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,MAAiB,EAAE,MAAc;QACvD,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,MAAiB;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACvF,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAiB,EAAE,MAAc;QACjD,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,OAAc,EAAE,SAAkB,EAAE,MAAe;QAC/D,IAAI,KAAK,CAAC;QACV,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;YACxB,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YACxD,MAAM,UAAU,GAAmB,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YAClG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;QACD,MAAM,aAAa,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC1G,IAAI,KAAK,YAAY,IAAI;YACvB,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;;YAExE,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,OAAc,EAAE,SAAkB,EAAE,MAAe,EAAE,MAAc;QACjF,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;YACnB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,GAAU,OAAO,CAAC;YAC3B,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED,4CAA4C;IACrC,OAAO,CAAC,IAAU;QACvB,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACzF,CAAC;IAED,gDAAgD;IACzC,OAAO,CAAC,IAAU;QACvB,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACvF,CAAC;IAED,gEAAgE;IACzD,iBAAiB,CAAC,KAAwB;QAC/C,QAAQ,KAAK,CAAC,kBAAkB,EAAE,CAAC;YACjC,KAAK,YAAY;gBACf,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACjC,MAAM;YACR,KAAK,aAAa;gBAChB,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;gBAC3D,MAAM;YACR,KAAK,KAAK;gBACR,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;gBACjC,MAAM;YACR;gBACE,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;oBACzB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAErB,MAAM;QACV,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,QAAkB,EAAE,OAAO,GAAG,KAAK;QACpD,IAAI,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC,QAA2B,EAAE,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3G,CAAC;IAED,+CAA+C;IACxC,iBAAiB,CAAC,SAAyB;QAChD,IAAI,CAAC,YAAY,CAAC,CAAC,iBAAiB,CAAC,SAAS,EAAE,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/F,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,SAA2B;QAC7C,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;YACvB,KAAK,YAAY;gBACf,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACrC,MAAM;YACR,KAAK,cAAc;gBACjB,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;gBACzD,MAAM;YACR,KAAK,aAAa;gBAChB,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACtC,MAAM;YACR,KAAK,eAAe;gBAClB,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;gBAC1D,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAChC,MAAM;YACR,KAAK,SAAS;gBACZ,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;gBACpD,MAAM;YACR,KAAK,KAAK;gBACR,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,KAAK,SAAS,CAAC,SAAS,EAAE,IAAI,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC;gBACpF,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,KAAK,SAAS,CAAC,SAAS,EAAE,IAAI,KAAK,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;gBACxG,MAAM;YACR,KAAK,MAAM;gBACT,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBAC7B,MAAM;YACR,KAAK,MAAM;gBACT,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBAC7B,MAAM;YACR,KAAK,UAAU;gBACb,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC;gBAChE,MAAM;YACR,KAAK,gBAAgB;gBACnB,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;gBACjD,MAAM;QACV,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,KAAc,EAAE,KAAK,GAAG,KAAK;QAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,OAAO;QACT,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACzC,IAAI,GAAG;YACL,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED,+CAA+C;IACxC,UAAU,CAAC,OAAgB;QAChC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,+CAA+C;IACxC,eAAe,CAAC,OAAgB;QACrC,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,yCAAyC;IAClC,sBAAsB,CAAC,CAAY;QACxC,IAAI,CAAC,aAAa,CAAC;YACjB,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC;YACtB,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC;YACnB,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC;YACpB,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC;YACvB,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC;YACtB,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC;YACnB,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC;YAClB,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC;YACrB,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE;YAC9B,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE;SAChC,CAAC,CAAC;QAEH,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAChF,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,yCAAyC;IAClC,2BAA2B,CAAC,CAAY;QAC7C,IAAI,CAAC,QAAQ,CAAC;YACZ,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE;YAC9B,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE;YAC3B,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE;YAC5B,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE;YAC/B,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE;SAAC,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC;YACZ,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE;YAC3B,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE;YAC1B,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE;YAC7B,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE;YAC9B,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE;SAAC,CAAC,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC;YACZ,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE;YAC3B,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE;YAC1B,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE;YAC3B,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE;YAC5B,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE;SAAC,CAAC,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC;YACZ,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE;YAC3B,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE;YAC9B,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE;YAC/B,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE;YAC5B,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE;SAAC,CAAC,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC;YACZ,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE;YAC7B,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE;YAC9B,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE;YAC/B,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE;YAC9B,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE;SAAC,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC;YACZ,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE;YAC7B,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE;YAC1B,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE;YAC3B,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE;YAC9B,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE;SAAC,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACI,YAAY,CAAC,SAAmB,EAAE,SAAmB,EAAE,SAAiB,EAAE,UAAU,GAAG,UAAU,CAAC,KAAK;QAC5G,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;IACvG,CAAC;IAED;;;;;OAKG;IACI,eAAe,CAAC,SAAmB,IAAI,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9G,oBAAoB,KAAoB,OAAO,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3J,sBAAsB,KAAoB,OAAO,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAKvG,GAAG,CAAC,IAAc,IAAU,IAAI,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC3E;AAED,SAAS,UAAU,CAAC,KAAgB,EAAE,KAAa;IACjD,MAAM,KAAK,GAAc,EAAE,CAAC;IAC5B,KAAK,MAAM,KAAK,IAAI,KAAK;QACvB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IACtD,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport {\r\n  AnyCurvePrimitive, Arc3d, Box, CurvePrimitive, IndexedPolyface, LineSegment3d, LineString3d, Loop, Path, Point2d, Point3d, Polyface, Range3d, SolidPrimitive, Transform,\r\n} from \"@itwin/core-geometry\";\r\nimport { AnalysisStyle, ColorDef, Feature, Frustum, Gradient, GraphicParams, LinePixels, Npc, RenderTexture } from \"@itwin/core-common\";\r\nimport { _accumulator, _implementationProhibited } from \"../internal/Symbols\";\r\nimport { GraphicType } from \"./GraphicType\";\r\nimport { PickableGraphicOptions } from \"./BatchOptions\";\r\nimport { GraphicPrimitive } from \"./GraphicPrimitive\";\r\nimport { GeometryAccumulator } from \"../internal/render/GeometryAccumulator\";\r\nimport { DisplayParams } from \"../internal/render/DisplayParams\";\r\nimport { Geometry } from \"../internal/render/GeometryPrimitives\";\r\n\r\n/** @internal Used by GraphicAssembler's internal constructor. Subclasses define their own constructor arguments. */\r\nexport interface GraphicAssemblerOptions {\r\n  /** The constructor is internal, but protected.\r\n   * Prevent anyone outside of itwinjs-core from being able to invoke it, thereby preventing them from creating their own subclasses of GraphicAssembler.\r\n   */\r\n  [_implementationProhibited]: unknown;\r\n  type: GraphicType;\r\n  placement: Transform;\r\n  pickable?: PickableGraphicOptions;\r\n  preserveOrder: boolean;\r\n  wantNormals: boolean;\r\n  wantEdges: boolean;\r\n  analysisStyle?: AnalysisStyle;\r\n};\r\n\r\n/** Provides methods for assembling geometric primitives and symbology into a graphical representation.\r\n * Two concrete implementations are provided:\r\n *  - [[GraphicBuilder]], for creating [[RenderGraphic]]s directly; and\r\n *  - [[GraphicDescriptionBuilder]], for creating a [[GraphicDescription]] from which a [[RenderGraphic]] can be produced.\r\n *\r\n * GraphicBuilder can only be used on the main JavaScript thread, so its use should be reserved for relatively simple, quick-to-produce graphics like [[Decorations]].\r\n * GraphicDescriptionBuilder is designed for use in a [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker). It can be used to assemble more\r\n * complex graphics without blocking the main thread.\r\n *\r\n * @note Most of the methods which add geometry to the builder take ownership of their inputs rather than cloning them.\r\n * So, for example, if you pass an array of points to [[addLineString]], you should not subsequently modify that array.\r\n * @public\r\n * @extensions\r\n */\r\nexport abstract class GraphicAssembler {\r\n  /** @internal */\r\n  public abstract [_implementationProhibited]: unknown;\r\n  /** @internal */\r\n  public readonly [_accumulator]: GeometryAccumulator;\r\n  private readonly _graphicParams = new GraphicParams();\r\n\r\n  /** The local-to-world transform in which the builder's geometry is to be defined. */\r\n  public readonly placement: Transform;\r\n  /** The type of graphic to be produced. */\r\n  public readonly type: GraphicType;\r\n  /** If the graphic is to be interactive, specifies its Id and other options. */\r\n  public readonly pickable?: Readonly<PickableGraphicOptions>;\r\n  /** If true, the order in which geometry is added to the builder is preserved.\r\n   * This enables overlay and background graphics, which draw without using the depth buffer, to specify which geometry display in front of others when\r\n   * they overlap.\r\n   * For example, to draw an overlay containing a red shape with a white outline, you would add the shape to the GraphicAssember first, followed by its outline,\r\n   * to ensure the outline draws on top of the shape.\r\n   * This incurs a performance penalty due to the increased number of draw calls, and is never useful for graphics that draw using the depth buffer.\r\n   */\r\n  public readonly preserveOrder: boolean;\r\n  /** If true, normal vectors will be generated for surfaces, allowing 3d geometry to receive lighting and reduce z-fighting. */\r\n  public readonly wantNormals: boolean;\r\n  /** If true, edges are generated for surfaces, to be drawn if edge display is enabled for the view in which the graphic is drawn. */\r\n  public readonly wantEdges: boolean;\r\n  /** @alpha */\r\n  public readonly analysisStyle?: AnalysisStyle;\r\n\r\n  /** @internal */\r\n  protected constructor(options: GraphicAssemblerOptions) {\r\n    this.placement = options.placement?.clone() ?? Transform.createIdentity();\r\n    this.type = options.type;\r\n    this.pickable = options.pickable;\r\n    this.wantEdges = options.wantEdges;\r\n    this.preserveOrder = options.preserveOrder;\r\n    this.wantNormals = options.wantNormals;\r\n    this.analysisStyle = options.analysisStyle;\r\n\r\n    this[_accumulator] = new GeometryAccumulator({\r\n      analysisStyleDisplacement: this.analysisStyle?.displacement,\r\n    });\r\n\r\n    if (this.pickable) {\r\n      this.activateFeature(new Feature(this.pickable.id, this.pickable.subCategoryId, this.pickable.geometryClass));\r\n    }\r\n  }\r\n\r\n  /** Whether the builder's geometry is defined in [[CoordSystem.View]] coordinates.\r\n   * Only graphics of type [[GraphicType.ViewBackground]] or [[GraphicType.ViewOverlay]] are defined in view coordinates.\r\n   * @see [[isWorldCoordinates]].\r\n   */\r\n  public get isViewCoordinates(): boolean {\r\n    return this.type === GraphicType.ViewBackground || this.type === GraphicType.ViewOverlay;\r\n  }\r\n\r\n  /** Whether the builder's geometry is defined in [[CoordSystem.World]] coordinates - the inverse of [[isViewCoordinates]]. */\r\n  public get isWorldCoordinates(): boolean {\r\n    return !this.isViewCoordinates;\r\n  }\r\n\r\n  /** True if the builder produces a graphic of [[GraphicType.Scene]]. */\r\n  public get isSceneGraphic(): boolean {\r\n    return this.type === GraphicType.Scene;\r\n  }\r\n\r\n  /** True if the builder produces a graphic of [[GraphicType.ViewBackground]]. */\r\n  public get isViewBackground(): boolean {\r\n    return this.type === GraphicType.ViewBackground;\r\n  }\r\n\r\n  /** True if the builder produces a graphic of [[GraphicType.WorldOverlay]] or [[GraphicType.ViewOerlay]]. */\r\n  public get isOverlay(): boolean {\r\n    return this.type === GraphicType.ViewOverlay || this.type === GraphicType.WorldOverlay;\r\n  }\r\n\r\n  /** Sets the current active symbology for this builder. Any new geometry subsequently added to the builder will be drawn using the specified symbology.\r\n   * @param graphicParams The symbology to apply to subsequent geometry.\r\n   * @see [[setSymbology]] for a convenient way to set common symbology options.\r\n   */\r\n  public activateGraphicParams(graphicParams: GraphicParams): void {\r\n    graphicParams.clone(this._graphicParams);\r\n  }\r\n\r\n  /** Change the [Feature]($common) to be associated with subsequently-added geometry. This permits multiple features to be batched together into a single graphic\r\n   * for more efficient rendering.\r\n   * @note This method has no effect if [[pickable]] is not defined.\r\n   */\r\n  public activateFeature(feature: Feature): void {\r\n    assert(undefined !== this.pickable, \"GraphicAssembler.activateFeature has no effect if PickableGraphicOptions were not supplied\");\r\n    if (this.pickable) {\r\n      this[_accumulator].currentFeature = feature;\r\n    }\r\n  }\r\n\r\n  /** Change the pickable Id to be associated with subsequently-added geometry. This permits multiple pickable objects to be batched  together into a single graphic\r\n   * for more efficient rendering. This method calls [[activateFeature]], using the subcategory Id and [GeometryClass]($common) specified in [[pickable]]\r\n   * at construction, if any.\r\n   * @note This method has no effect if [[pickable]] is not defined.\r\n   */\r\n  public activatePickableId(id: Id64String): void {\r\n    const pick = this.pickable;\r\n    this.activateFeature(new Feature(id, pick?.subCategoryId, pick?.geometryClass));\r\n  }\r\n\r\n  /**\r\n   * Appends a 3d line string to the builder.\r\n   * @param points Array of vertices in the line string.\r\n   */\r\n  public addLineString(points: Point3d[]): void {\r\n    if (2 === points.length && points[0].isAlmostEqual(points[1]))\r\n      this[_accumulator].addPointString(points, this.getLinearDisplayParams(), this.placement);\r\n    else\r\n      this[_accumulator].addLineString(points, this.getLinearDisplayParams(), this.placement);\r\n  }\r\n\r\n  /**\r\n   * Appends a 2d line string to the builder.\r\n   * @param points Array of vertices in the line string.\r\n   * @param zDepth Z value in local coordinates to use for each point.\r\n   */\r\n  public addLineString2d(points: Point2d[], zDepth: number): void {\r\n    const pts3d = copy2dTo3d(points, zDepth);\r\n    this.addLineString(pts3d);\r\n  }\r\n\r\n  /**\r\n   * Appends a 3d point string to the builder. The points are drawn disconnected, with a diameter in pixels defined by the builder's active [[GraphicParams.rasterWidth]].\r\n   * @param points Array of vertices in the point string.\r\n   */\r\n  public addPointString(points: Point3d[]): void {\r\n    this[_accumulator].addPointString(points, this.getLinearDisplayParams(), this.placement);\r\n  }\r\n\r\n  /**\r\n   * Appends a 2d point string to the builder. The points are drawn disconnected, with a diameter in pixels defined by the builder's active [[GraphicParams.rasterWidth]].\r\n   * @param points Array of vertices in the point string.\r\n   * @param zDepth Z value in local coordinates to use for each point.\r\n   */\r\n  public addPointString2d(points: Point2d[], zDepth: number): void {\r\n    const pts3d = copy2dTo3d(points, zDepth);\r\n    this.addPointString(pts3d);\r\n  }\r\n\r\n  /**\r\n   * Appends a closed 3d planar region to the builder.\r\n   * @param points Array of vertices of the shape.\r\n   */\r\n  public addShape(points: Point3d[]): void {\r\n    const loop = Loop.create(LineString3d.create(points));\r\n    this[_accumulator].addLoop(loop, this.getMeshDisplayParams(), this.placement, false);\r\n  }\r\n\r\n  /**\r\n   * Appends a closed 2d region to the builder.\r\n   * @param points Array of vertices of the shape.\r\n   * @param zDepth Z value in local coordinates to use for each point.\r\n   */\r\n  public addShape2d(points: Point2d[], zDepth: number): void {\r\n    const pts3d = copy2dTo3d(points, zDepth);\r\n    this.addShape(pts3d);\r\n  }\r\n\r\n  /**\r\n   * Appends a 3d open arc or closed ellipse to the builder.\r\n   * @param arc Description of the arc or ellipse.\r\n   * @param isEllipse If true, and if the arc defines a full sweep, then draw as a closed ellipse instead of an arc.\r\n   * @param filled If true, and isEllipse is also true, then draw ellipse filled.\r\n   */\r\n  public addArc(ellipse: Arc3d, isEllipse: boolean, filled: boolean): void {\r\n    let curve;\r\n    if (isEllipse || filled) {\r\n      curve = Loop.create(ellipse);\r\n    } else {\r\n      curve = Path.create(ellipse);\r\n    }\r\n\r\n    if (filled && !isEllipse && !ellipse.sweep.isFullCircle) {\r\n      const gapSegment: CurvePrimitive = LineSegment3d.create(ellipse.startPoint(), ellipse.endPoint());\r\n      curve.children.push(gapSegment);\r\n    }\r\n    const displayParams = curve.isAnyRegionType ? this.getMeshDisplayParams() : this.getLinearDisplayParams();\r\n    if (curve instanceof Loop)\r\n      this[_accumulator].addLoop(curve, displayParams, this.placement, false);\r\n    else\r\n      this[_accumulator].addPath(curve, displayParams, this.placement, false);\r\n  }\r\n\r\n  /**\r\n   * Appends a 2d open arc or closed ellipse to the builder.\r\n   * @param arc Description of the arc or ellipse.\r\n   * @param isEllipse If true, and if the arc defines a full sweep, then draw as a closed ellipse instead of an arc.\r\n   * @param filled If true, and isEllipse is also true, then draw ellipse filled.\r\n   * @param zDepth Z value in local coordinates to use for each point in the arc or ellipse.\r\n   */\r\n  public addArc2d(ellipse: Arc3d, isEllipse: boolean, filled: boolean, zDepth: number): void {\r\n    if (0.0 === zDepth) {\r\n      this.addArc(ellipse, isEllipse, filled);\r\n    } else {\r\n      const ell: Arc3d = ellipse;\r\n      ell.center.z = zDepth;\r\n      this.addArc(ell, isEllipse, filled);\r\n    }\r\n  }\r\n\r\n  /** Append a 3d open path to the builder. */\r\n  public addPath(path: Path): void {\r\n    this[_accumulator].addPath(path, this.getLinearDisplayParams(), this.placement, false);\r\n  }\r\n\r\n  /** Append a 3d planar region to the builder. */\r\n  public addLoop(loop: Loop): void {\r\n    this[_accumulator].addLoop(loop, this.getMeshDisplayParams(), this.placement, false);\r\n  }\r\n\r\n  /** Append a [CurvePrimitive]($core-geometry) to the builder. */\r\n  public addCurvePrimitive(curve: AnyCurvePrimitive): void {\r\n    switch (curve.curvePrimitiveType) {\r\n      case \"lineString\":\r\n        this.addLineString(curve.points);\r\n        break;\r\n      case \"lineSegment\":\r\n        this.addLineString([curve.startPoint(), curve.endPoint()]);\r\n        break;\r\n      case \"arc\":\r\n        this.addArc(curve, false, false);\r\n        break;\r\n      default:\r\n        const path = new Path();\r\n        if (path.tryAddChild(curve))\r\n          this.addPath(path);\r\n\r\n        break;\r\n    }\r\n  }\r\n\r\n  /** Append a mesh to the builder.\r\n   * @param meshData Describes the mesh\r\n   * @param _filled If the mesh describes a planar region, indicates whether its interior area should be drawn with fill in [[RenderMode.Wireframe]].\r\n   */\r\n  public addPolyface(meshData: Polyface, _filled = false): void {\r\n    this[_accumulator].addPolyface(meshData as IndexedPolyface, this.getMeshDisplayParams(), this.placement);\r\n  }\r\n\r\n  /** Append a solid primitive to the builder. */\r\n  public addSolidPrimitive(primitive: SolidPrimitive): void {\r\n    this[_accumulator].addSolidPrimitive(primitive, this.getMeshDisplayParams(), this.placement);\r\n  }\r\n\r\n  /** Append any primitive to the builder.\r\n   * @param primitive The graphic primitive to append.\r\n   */\r\n  public addPrimitive(primitive: GraphicPrimitive): void {\r\n    switch (primitive.type) {\r\n      case \"linestring\":\r\n        this.addLineString(primitive.points);\r\n        break;\r\n      case \"linestring2d\":\r\n        this.addLineString2d(primitive.points, primitive.zDepth);\r\n        break;\r\n      case \"pointstring\":\r\n        this.addPointString(primitive.points);\r\n        break;\r\n      case \"pointstring2d\":\r\n        this.addPointString2d(primitive.points, primitive.zDepth);\r\n        break;\r\n      case \"shape\":\r\n        this.addShape(primitive.points);\r\n        break;\r\n      case \"shape2d\":\r\n        this.addShape2d(primitive.points, primitive.zDepth);\r\n        break;\r\n      case \"arc\":\r\n        this.addArc(primitive.arc, true === primitive.isEllipse, true === primitive.filled);\r\n        break;\r\n      case \"arc2d\":\r\n        this.addArc2d(primitive.arc, true === primitive.isEllipse, true === primitive.filled, primitive.zDepth);\r\n        break;\r\n      case \"path\":\r\n        this.addPath(primitive.path);\r\n        break;\r\n      case \"loop\":\r\n        this.addLoop(primitive.loop);\r\n        break;\r\n      case \"polyface\":\r\n        this.addPolyface(primitive.polyface, true === primitive.filled);\r\n        break;\r\n      case \"solidPrimitive\":\r\n        this.addSolidPrimitive(primitive.solidPrimitive);\r\n        break;\r\n    }\r\n  }\r\n\r\n  /** Add a box representing a volume of space. Typically used for debugging purposes.\r\n   * @param range The volume of space.\r\n   * @param solid If true, a [[Box]] solid primitive will be added; otherwise, a wireframe outline of the box will be added.\r\n   */\r\n  public addRangeBox(range: Range3d, solid = false): void {\r\n    if (!solid) {\r\n      this.addFrustum(Frustum.fromRange(range));\r\n      return;\r\n    }\r\n\r\n    const box = Box.createRange(range, true);\r\n    if (box)\r\n      this.addSolidPrimitive(box);\r\n  }\r\n\r\n  /** Add Frustum edges. Useful for debugging. */\r\n  public addFrustum(frustum: Frustum) {\r\n    this.addRangeBoxFromCorners(frustum.points);\r\n  }\r\n\r\n  /** Add Frustum sides. Useful for debugging. */\r\n  public addFrustumSides(frustum: Frustum) {\r\n    this.addRangeBoxSidesFromCorners(frustum.points);\r\n  }\r\n\r\n  /** Add range edges from corner points */\r\n  public addRangeBoxFromCorners(p: Point3d[]) {\r\n    this.addLineString([\r\n      p[Npc.LeftBottomFront],\r\n      p[Npc.LeftTopFront],\r\n      p[Npc.RightTopFront],\r\n      p[Npc.RightBottomFront],\r\n      p[Npc.RightBottomRear],\r\n      p[Npc.RightTopRear],\r\n      p[Npc.LeftTopRear],\r\n      p[Npc.LeftBottomRear],\r\n      p[Npc.LeftBottomFront].clone(),\r\n      p[Npc.RightBottomFront].clone(),\r\n    ]);\r\n\r\n    this.addLineString([p[Npc.LeftTopFront].clone(), p[Npc.LeftTopRear].clone()]);\r\n    this.addLineString([p[Npc.RightTopFront].clone(), p[Npc.RightTopRear].clone()]);\r\n    this.addLineString([p[Npc.LeftBottomRear].clone(), p[Npc.RightBottomRear].clone()]);\r\n  }\r\n\r\n  /** Add range sides from corner points */\r\n  public addRangeBoxSidesFromCorners(p: Point3d[]) {\r\n    this.addShape([\r\n      p[Npc.LeftBottomFront].clone(),\r\n      p[Npc.LeftTopFront].clone(),\r\n      p[Npc.RightTopFront].clone(),\r\n      p[Npc.RightBottomFront].clone(),\r\n      p[Npc.LeftBottomFront].clone()]);\r\n    this.addShape([\r\n      p[Npc.RightTopRear].clone(),\r\n      p[Npc.LeftTopRear].clone(),\r\n      p[Npc.LeftBottomRear].clone(),\r\n      p[Npc.RightBottomRear].clone(),\r\n      p[Npc.RightTopRear].clone()]);\r\n    this.addShape([\r\n      p[Npc.RightTopRear].clone(),\r\n      p[Npc.LeftTopRear].clone(),\r\n      p[Npc.LeftTopFront].clone(),\r\n      p[Npc.RightTopFront].clone(),\r\n      p[Npc.RightTopRear].clone()]);\r\n    this.addShape([\r\n      p[Npc.RightTopRear].clone(),\r\n      p[Npc.RightBottomRear].clone(),\r\n      p[Npc.RightBottomFront].clone(),\r\n      p[Npc.RightTopFront].clone(),\r\n      p[Npc.RightTopRear].clone()]);\r\n    this.addShape([\r\n      p[Npc.LeftBottomRear].clone(),\r\n      p[Npc.RightBottomRear].clone(),\r\n      p[Npc.RightBottomFront].clone(),\r\n      p[Npc.LeftBottomFront].clone(),\r\n      p[Npc.LeftBottomRear].clone()]);\r\n    this.addShape([\r\n      p[Npc.LeftBottomRear].clone(),\r\n      p[Npc.LeftTopRear].clone(),\r\n      p[Npc.LeftTopFront].clone(),\r\n      p[Npc.LeftBottomFront].clone(),\r\n      p[Npc.LeftBottomRear].clone()]);\r\n  }\r\n\r\n  /** Sets the current active symbology for this builder. Any new geometry subsequently added will be drawn using the specified symbology.\r\n   * @param lineColor The color in which to draw lines.\r\n   * @param fillColor The color in which to draw filled regions.\r\n   * @param lineWidth The width in pixels to draw lines. The renderer will clamp this value to an integer in the range [1, 32].\r\n   * @param linePixels The pixel pattern in which to draw lines.\r\n   * @see [[activateGraphicParams]] for additional symbology options.\r\n   */\r\n  public setSymbology(lineColor: ColorDef, fillColor: ColorDef, lineWidth: number, linePixels = LinePixels.Solid) {\r\n    this.activateGraphicParams(GraphicParams.fromSymbology(lineColor, fillColor, lineWidth, linePixels));\r\n  }\r\n\r\n  /** Set the current active symbology for this builder to be a blanking fill before adding a planar region.\r\n   * A planar region drawn with blanking fill renders behind other geometry in the same graphic.\r\n   * Blanking fill is not affected by the fill [[ViewFlags]] being disabled.\r\n   * An example would be to add a line to a graphic containing a shape with blanking fill so that the line is always shown in front of the fill.\r\n   * @param fillColor The color in which to draw filled regions.\r\n   */\r\n  public setBlankingFill(fillColor: ColorDef) { this.activateGraphicParams(GraphicParams.fromBlankingFill(fillColor)); }\r\n\r\n  private getMeshDisplayParams(): DisplayParams { return DisplayParams.createForMesh(this._graphicParams, !this.wantNormals, (grad) => this.resolveGradient(grad)); }\r\n  private getLinearDisplayParams(): DisplayParams { return DisplayParams.createForLinear(this._graphicParams); }\r\n\r\n  /** @internal */\r\n  protected abstract resolveGradient(gradient: Gradient.Symb): RenderTexture | undefined;\r\n\r\n  public add(geom: Geometry): void { this[_accumulator].addGeometry(geom); }\r\n}\r\n\r\nfunction copy2dTo3d(pts2d: Point2d[], depth: number): Point3d[] {\r\n  const pts3d: Point3d[] = [];\r\n  for (const point of pts2d)\r\n    pts3d.push(Point3d.create(point.x, point.y, depth));\r\n  return pts3d;\r\n}\r\n"]}

package/lib/esm/common/render/GraphicDescriptionBuilder.d.ts

@@ -0,0 +1,89 @@
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { GraphicAssembler } from "./GraphicAssembler";
+import { Point3d, Range3d, Transform } from "@itwin/core-geometry";
+import { GraphicType } from "./GraphicType";
+import { PickableGraphicOptions } from "./BatchOptions";
+import { _implementationProhibited } from "../internal/Symbols";
+import { WorkerGraphicDescriptionContext } from "./GraphicDescriptionContext";
+/** An opaque representation of a [[RenderGraphic]] created by a [[GraphicDescriptionBuilder]].
+ * Unlike `RenderGraphic`, a `GraphicDescription` does not allocate any WebGL resources like textures, vertex buffers, etc, so
+ * it can be created on and/or passed to and from a [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker).
+ * @see [[RenderSystem.createGraphicFromDescription]] to convert it to a [[RenderGraphic]].
+ * @beta
+ */
+export interface GraphicDescription {
+    /** @internal */
+    readonly [_implementationProhibited]: unknown;
+}
+/** @beta */
+export declare namespace GraphicDescription {
+    /** Adds to `transferables` all of the [Transferable objects](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects) like
+     * `ArrayBuffer`s that are included in `description`. This makes copying a [[GraphicDescription]] to and from a [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker)
+     * much more efficient.
+     */
+    function collectTransferables(transferables: Set<Transferable>, description: GraphicDescription): void;
+}
+/** Arguments supplied to [[GraphicDescriptionBuilderOptions.computeChordTolerance]] to help compute an appropriate level of detail for the [[GraphicDescription]].
+ * @beta
+ */
+export interface ComputeGraphicDescriptionChordToleranceArgs {
+    /** The builder that is constructing the [[GraphicDescription]]. */
+    builder: GraphicDescriptionBuilder;
+    /** A function that computes a bounding box enclosing all of the geometry in the [[builder]]. */
+    computeRange: () => Range3d;
+}
+/** Options supplied to [[GraphicDescriptionBuilder.create]].
+ * @beta
+ */
+export type GraphicDescriptionBuilderOptions = {
+    /** The type of graphic to create. This influences the default values of some other options like [[generateEdges]] and
+     * properties like [[GraphicDescriptionBuilder.wantNormals]].
+     */
+    type: GraphicType;
+    /** The local-to-world transform in which the builder's geoemtry is to be defined.
+     * Default: an identity transform.
+     */
+    placement?: Transform;
+    /** If the graphic is to contain one or more [Feature]($common)s, specifies the initial pickable Id and other options. */
+    pickable?: PickableGraphicOptions;
+    /** Specifies whether edges are generated for surfaces.
+     * By default, edges are only produced if [[type]] is [[GraphicType.Scene]].
+     */
+    generateEdges?: boolean;
+    /** Computes the level of detail in meters for the graphics produced by the builder. */
+    computeChordTolerance: (args: ComputeGraphicDescriptionChordToleranceArgs) => number;
+    /** Context in which the graphic description will be created, obtained from the [[RenderSystem]] on the main thread. */
+    context: WorkerGraphicDescriptionContext;
+} & ({
+    /** If defined, specifies a point about which the graphic will rotate such that it always faces the viewer.
+     * This can be particular useful for planar regions to create a billboarding effect - e.g., to implement [[Marker]]-like WebGL decorations.
+     * The graphic's [[placement]] transform is not applied to the point.
+     * @note This has no effect for graphics displayed in a 2d view.
+     */
+    viewIndependentOrigin?: Point3d;
+    /** @internal */
+    instances?: never;
+});
+/** An equivalent of a [[GraphicBuilder]] that is designed for use on a [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker).
+ * Unlike [[GraphicBuilder.finish]], which produces a [[RenderGraphic]], [[GraphicDescriptionBuilder.finish]] produces a [[GraphicDescription]].
+ * The `GraphicDescription` can be returned from the Worker to the main thread, where [[RenderSystem.createGraphicFromDescription]] can be used
+ * to quickly convert it to a `RenderGraphic`.
+ * Produce graphics using `GraphicDescriptionBuilder` on a Worker instead of using `GraphicBuilder` when you have graphics that may take a non-trivial
+ * amount of time to create, to avoid blocking the main JavaScript event loop.
+ * @see [[GraphicDescriptionBuilder.create]] to instantiate this type.
+ * @beta
+ */
+export interface GraphicDescriptionBuilder extends GraphicAssembler {
+    /** Processes the accumulated symbology and geometry to produce a description of a renderable graphic.
+     * This function should only be called once; after the [[GraphicDescription]] has been extracted, the [[GraphicDescriptionBuilder]] should no longer be used.
+     */
+    finish(): GraphicDescription;
+}
+/** @beta */
+export declare namespace GraphicDescriptionBuilder {
+    /** Create a [[GraphicDescriptionBuilder]] using the specified `options`. */
+    function create(options: GraphicDescriptionBuilderOptions): GraphicDescriptionBuilder;
+}
+//# sourceMappingURL=GraphicDescriptionBuilder.d.ts.map

package/lib/esm/common/render/GraphicDescriptionBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphicDescriptionBuilder.d.ts","sourceRoot":"","sources":["../../../../src/common/render/GraphicDescriptionBuilder.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,+BAA+B,EAAE,MAAM,6BAA6B,CAAC;AAE9E;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,gBAAgB;IAChB,QAAQ,CAAC,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;CAC/C;AAED,YAAY;AACZ,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,SAAgB,oBAAoB,CAAC,aAAa,EAAE,GAAG,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,kBAAkB,GAAG,IAAI,CAE5G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,2CAA2C;IAC1D,mEAAmE;IACnE,OAAO,EAAE,yBAAyB,CAAC;IACnC,gGAAgG;IAChG,YAAY,EAAE,MAAM,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,yHAAyH;IACzH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,uFAAuF;IACvF,qBAAqB,EAAE,CAAC,IAAI,EAAE,2CAA2C,KAAK,MAAM,CAAC;IACrF,uHAAuH;IACvH,OAAO,EAAE,+BAA+B,CAAC;CAC1C,GAAG,CAAC;IACH;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,gBAAgB;IAChB,SAAS,CAAC,EAAE,KAAK,CAAC;CACnB,CAGG,CAAC;AAEL;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE;;OAEG;IACH,MAAM,IAAI,kBAAkB,CAAC;CAC9B;AAED,YAAY;AACZ,yBAAiB,yBAAyB,CAAC;IACzC,4EAA4E;IAC5E,SAAgB,MAAM,CAAC,OAAO,EAAE,gCAAgC,GAAG,yBAAyB,CAE3F;CACF"}

package/lib/esm/common/render/GraphicDescriptionBuilder.js

@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { collectGraphicDescriptionTransferables, GraphicDescriptionBuilderImpl } from "../internal/render/GraphicDescriptionBuilderImpl";
+import { _implementationProhibited } from "../internal/Symbols";
+/** @beta */
+export var GraphicDescription;
+(function (GraphicDescription) {
+    /** Adds to `transferables` all of the [Transferable objects](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects) like
+     * `ArrayBuffer`s that are included in `description`. This makes copying a [[GraphicDescription]] to and from a [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker)
+     * much more efficient.
+     */
+    function collectTransferables(transferables, description) {
+        return collectGraphicDescriptionTransferables(transferables, description);
+    }
+    GraphicDescription.collectTransferables = collectTransferables;
+})(GraphicDescription || (GraphicDescription = {}));
+/** @beta */
+export var GraphicDescriptionBuilder;
+(function (GraphicDescriptionBuilder) {
+    /** Create a [[GraphicDescriptionBuilder]] using the specified `options`. */
+    function create(options) {
+        return new GraphicDescriptionBuilderImpl(options);
+    }
+    GraphicDescriptionBuilder.create = create;
+})(GraphicDescriptionBuilder || (GraphicDescriptionBuilder = {}));
+//# sourceMappingURL=GraphicDescriptionBuilder.js.map

package/lib/esm/common/render/GraphicDescriptionBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphicDescriptionBuilder.js","sourceRoot":"","sources":["../../../../src/common/render/GraphicDescriptionBuilder.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,sCAAsC,EAAE,6BAA6B,EAAE,MAAM,kDAAkD,CAAC;AAIzI,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAchE,YAAY;AACZ,MAAM,KAAW,kBAAkB,CAQlC;AARD,WAAiB,kBAAkB;IACjC;;;OAGG;IACH,SAAgB,oBAAoB,CAAC,aAAgC,EAAE,WAA+B;QACpG,OAAO,sCAAsC,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IAC5E,CAAC;IAFe,uCAAoB,uBAEnC,CAAA;AACH,CAAC,EARgB,kBAAkB,KAAlB,kBAAkB,QAQlC;AAgED,YAAY;AACZ,MAAM,KAAW,yBAAyB,CAKzC;AALD,WAAiB,yBAAyB;IACxC,4EAA4E;IAC5E,SAAgB,MAAM,CAAC,OAAyC;QAC9D,OAAO,IAAI,6BAA6B,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAFe,gCAAM,SAErB,CAAA;AACH,CAAC,EALgB,yBAAyB,KAAzB,yBAAyB,QAKzC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { GraphicAssembler } from \"./GraphicAssembler\";\r\nimport { collectGraphicDescriptionTransferables, GraphicDescriptionBuilderImpl } from \"../internal/render/GraphicDescriptionBuilderImpl\";\r\nimport { Point3d, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { GraphicType } from \"./GraphicType\";\r\nimport { PickableGraphicOptions } from \"./BatchOptions\";\r\nimport { _implementationProhibited } from \"../internal/Symbols\";\r\nimport { WorkerGraphicDescriptionContext } from \"./GraphicDescriptionContext\";\r\n\r\n/** An opaque representation of a [[RenderGraphic]] created by a [[GraphicDescriptionBuilder]].\r\n * Unlike `RenderGraphic`, a `GraphicDescription` does not allocate any WebGL resources like textures, vertex buffers, etc, so\r\n * it can be created on and/or passed to and from a [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker).\r\n * @see [[RenderSystem.createGraphicFromDescription]] to convert it to a [[RenderGraphic]].\r\n * @beta\r\n */\r\nexport interface GraphicDescription {\r\n  /** @internal */\r\n  readonly [_implementationProhibited]: unknown;\r\n}\r\n\r\n/** @beta */\r\nexport namespace GraphicDescription {\r\n  /** Adds to `transferables` all of the [Transferable objects](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects) like\r\n   * `ArrayBuffer`s that are included in `description`. This makes copying a [[GraphicDescription]] to and from a [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker)\r\n   * much more efficient.\r\n   */\r\n  export function collectTransferables(transferables: Set<Transferable>, description: GraphicDescription): void {\r\n    return collectGraphicDescriptionTransferables(transferables, description);\r\n  }\r\n}\r\n\r\n/** Arguments supplied to [[GraphicDescriptionBuilderOptions.computeChordTolerance]] to help compute an appropriate level of detail for the [[GraphicDescription]].\r\n * @beta\r\n */\r\nexport interface ComputeGraphicDescriptionChordToleranceArgs {\r\n  /** The builder that is constructing the [[GraphicDescription]]. */\r\n  builder: GraphicDescriptionBuilder;\r\n  /** A function that computes a bounding box enclosing all of the geometry in the [[builder]]. */\r\n  computeRange: () => Range3d;\r\n}\r\n\r\n/** Options supplied to [[GraphicDescriptionBuilder.create]].\r\n * @beta\r\n */\r\nexport type GraphicDescriptionBuilderOptions = {\r\n  /** The type of graphic to create. This influences the default values of some other options like [[generateEdges]] and\r\n   * properties like [[GraphicDescriptionBuilder.wantNormals]].\r\n   */\r\n  type: GraphicType;\r\n  /** The local-to-world transform in which the builder's geoemtry is to be defined.\r\n   * Default: an identity transform.\r\n   */\r\n  placement?: Transform;\r\n  /** If the graphic is to contain one or more [Feature]($common)s, specifies the initial pickable Id and other options. */\r\n  pickable?: PickableGraphicOptions;\r\n  /** Specifies whether edges are generated for surfaces.\r\n   * By default, edges are only produced if [[type]] is [[GraphicType.Scene]].\r\n   */\r\n  generateEdges?: boolean;\r\n  /** Computes the level of detail in meters for the graphics produced by the builder. */\r\n  computeChordTolerance: (args: ComputeGraphicDescriptionChordToleranceArgs) => number;\r\n  /** Context in which the graphic description will be created, obtained from the [[RenderSystem]] on the main thread. */\r\n  context: WorkerGraphicDescriptionContext;\r\n} & ({\r\n  /** If defined, specifies a point about which the graphic will rotate such that it always faces the viewer.\r\n   * This can be particular useful for planar regions to create a billboarding effect - e.g., to implement [[Marker]]-like WebGL decorations.\r\n   * The graphic's [[placement]] transform is not applied to the point.\r\n   * @note This has no effect for graphics displayed in a 2d view.\r\n   */\r\n  viewIndependentOrigin?: Point3d;\r\n  /** @internal */\r\n  instances?: never;\r\n}/* ) | {\r\n  instances?: InstancedGraphicParams;\r\n  viewIndependentOrigin?: never;\r\n}*/);\r\n\r\n/** An equivalent of a [[GraphicBuilder]] that is designed for use on a [Worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker).\r\n * Unlike [[GraphicBuilder.finish]], which produces a [[RenderGraphic]], [[GraphicDescriptionBuilder.finish]] produces a [[GraphicDescription]].\r\n * The `GraphicDescription` can be returned from the Worker to the main thread, where [[RenderSystem.createGraphicFromDescription]] can be used\r\n * to quickly convert it to a `RenderGraphic`.\r\n * Produce graphics using `GraphicDescriptionBuilder` on a Worker instead of using `GraphicBuilder` when you have graphics that may take a non-trivial\r\n * amount of time to create, to avoid blocking the main JavaScript event loop.\r\n * @see [[GraphicDescriptionBuilder.create]] to instantiate this type.\r\n * @beta\r\n */\r\nexport interface GraphicDescriptionBuilder extends GraphicAssembler {\r\n  /** Processes the accumulated symbology and geometry to produce a description of a renderable graphic.\r\n   * This function should only be called once; after the [[GraphicDescription]] has been extracted, the [[GraphicDescriptionBuilder]] should no longer be used.\r\n   */\r\n  finish(): GraphicDescription;\r\n}\r\n\r\n/** @beta */\r\nexport namespace GraphicDescriptionBuilder {\r\n  /** Create a [[GraphicDescriptionBuilder]] using the specified `options`. */\r\n  export function create(options: GraphicDescriptionBuilderOptions): GraphicDescriptionBuilder {\r\n    return new GraphicDescriptionBuilderImpl(options);\r\n  }\r\n}\r\n"]}