@itwin/core-frontend 4.8.0-dev.32 → 4.8.0-dev.34

package/lib/cjs/render/GraphicBuilder.d.ts

@@ -2,112 +2,13 @@
  * @module Rendering
  */
 import { Id64String } from "@itwin/core-bentley";
-import { AnyCurvePrimitive, Arc3d, Loop, Path, Point2d, Point3d, Polyface, Range3d, SolidPrimitive, Transform } from "@itwin/core-geometry";
-import { AnalysisStyle, ColorDef, Feature, Frustum, GeometryClass, GraphicParams, LinePixels } from "@itwin/core-common";
+import { Point3d, Range3d, Transform } from "@itwin/core-geometry";
 import { IModelConnection } from "../IModelConnection";
 import { Viewport } from "../Viewport";
 import { RenderGraphic } from "./RenderGraphic";
-import { GraphicPrimitive } from "./GraphicPrimitive";
-/**
- * Describes the type of a [[GraphicBuilder]], which defines the coordinate system in which the builder's geometry is defined and
- * controls the behavior of the [[RenderGraphic]] produced by the builder.
- * @note For those types for which depth-testing is disabled, the order in which the individual geometric primitives are drawn determines which geometry draws on top of other geometry.
- *  - Within a [[GraphicList]], each [[RenderGraphic]] is rendered in the order in which it appears in the list; and
- *  - Within a single [[RenderGraphic]], each geometric primitive is rendered in the ordered in which it was added to the GraphicBuilder.
- * @public
- * @extensions
- */
-export declare enum GraphicType {
-    /**
-     * Renders behind all other graphics. For example, the border of a [[SheetViewState]] is of this type.
-     * Coordinates: [[CoordSystem.View]].
-     * [[RenderMode]]: [[RenderMode.SmoothShade]].
-     * Lighting: none.
-     * Depth-testing: disabled.
-     * @see [[Decorations.viewBackground]]
-     */
-    ViewBackground = 0,
-    /** Used for the scene itself, dynamics, and 'normal' decorations. */
-    /**
-     * Renders as if it were part of the scene. All of the [[ViewFlags]] applied to the view's normal geometry also applies to these types of decorations.
-     * Coordinates: [[CoordSystem.World]].
-     * Lighting and [[RenderMode]]: from view.
-     * Depth-testing: enabled.
-     * @see [[Decorations.normal]].
-     */
-    Scene = 1,
-    /** Renders within the scene. Coordinates: world. RenderMode: smooth. Lighting: default. Z-testing: enabled */
-    /** Renders within the scene, but ignores the view's [[ViewFlags]].
-     * Coordinates: [[CoordSystem.World]].
-     * Lighting: default.
-     * [[RenderMode]]: [[RenderMode.SmoothShade]].
-     * Depth-testing: enabled.
-     * @see [[Decorations.world]].
-     */
-    WorldDecoration = 2,
-    /**
-     * Renders as an overlay on top of the scene. These decorations differ from [[GraphicType.WorldDecoration]] only in that depth-testing is disabled.
-     * For example, the ACS triad and [[WindowAreaTool]] decorations are of this type.
-     * Coordinates: [[CoordSystem.World]].
-     * [[RenderMode]]: [[RenderMode.SmoothShade]]
-     * Lighting: default.
-     * Depth-testing: disabled.
-     * Renders atop the scene. Coordinates: world. RenderMode: smooth. Lighting: none. Z-testing: disabled
-     * @note Overlay decorations typically employ some degree of transparency to ensure that they do not fully obscure the scene.
-     * @see [[Decorations.worldOverlay]]
-     */
-    WorldOverlay = 3,
-    /**
-     * Renders as an overlay on top of the scene. These decorations differ from [[GraphicType.WorldOverlay]] only in that their geometry is defined in view coordinates rather than world.
-     * Coordinates: [[CoordSystem.View]].
-     * [[RenderMode]]: [[RenderMode.SmoothShade]]
-     * Lighting: default.
-     * Depth-testing: disabled.
-     * @note For more flexibility in defining view overlay decorations, consider using a [[CanvasDecorationList]].
-     * @see [[Decorations.viewOverlay]]
-     */
-    ViewOverlay = 4
-}
-/** Options used when constructing a `Batch` - that is, a [[RenderGraphic]] with an associated [FeatureTable]($common) describing individual [Feature]($common)s within the
- * graphic. Individual features can be resymbolized in a variety of ways including flashing and hiliting.
- * For example, to prevent graphics produced by [[readElementGraphics]] from being hilited when their corresponding element is in the [[SelectionSet]],
- * pass `{ noHilite: true }` to [[readElementGraphics]].
- * @public
- * @extensions
- */
-export interface BatchOptions {
-    /** Identifies the [[Tile]] associated with the batch, chiefly for debugging purposes.
-     * @beta
-     */
-    tileId?: string;
-    /** If true, features within the batch will not be flashed on mouseover. */
-    noFlash?: boolean;
-    /** If true, features within the batch will not be hilited when their corresponding element is in the [[SelectionSet]]. */
-    noHilite?: boolean;
-    /** If true, features within the batch will not be emphasized when the corresponding [[Feature]] is emphasized using [FeatureOverrides]($common). */
-    noEmphasis?: boolean;
-    /** If true, the contents of the batch will only be drawn by [[Viewport.readPixels]], not [[Viewport.renderFrame]], causing them to be locatable but invisible. */
-    locateOnly?: boolean;
-}
-/** Options used as part of [[GraphicBuilderOptions]] to describe a [pickable]($docs/learning/frontend/ViewDecorations#pickable-view-graphic-decorations) [[RenderGraphic]].
- * @public
- * @extensions
- */
-export interface PickableGraphicOptions extends BatchOptions {
-    /** A unique identifier for the graphic.
-     * @see [[IModelConnection.transientIds]] to obtain a unique Id in the context of an iModel.
-     * @see [[GraphicBuilder.activatePickableId]] or [[GraphicBuilder.activateFeature]] to change the pickable object while adding geometry.
-     */
-    id: Id64String;
-    /** Optional Id of the subcategory with which the graphic should be associated. */
-    subCategoryId?: Id64String;
-    /** Optional geometry class for the graphic - defaults to [GeometryClass.Primary]($common). */
-    geometryClass?: GeometryClass;
-    /** The optional Id of the model with which the graphic should be associated. */
-    modelId?: Id64String;
-    /** True if the graphic is to be used as a [[DynamicSpatialClassifier]] to classify volumes of a reality model. */
-    isVolumeClassifier?: boolean;
-}
+import { GraphicType } from "../common/render/GraphicType";
+import type { PickableGraphicOptions } from "../common/render/BatchOptions";
+import { GraphicAssembler } from "../common/render/GraphicAssembler";
 /** Options for creating a [[GraphicBuilder]] used by functions like [[DecorateContext.createGraphic]] and [[RenderSystem.createGraphic]].
  * @see [[ViewportGraphicBuilderOptions]] to create a graphic builder for a [[Viewport]].
  * @see [[CustomGraphicBuilderOptions]] to create a graphic builder unassociated with any [[Viewport]].
@@ -194,7 +95,7 @@ export interface CustomGraphicBuilderOptions extends GraphicBuilderOptions {
     applyAspectRatioSkew?: never;
     viewport?: never;
 }
-/** Provides methods for constructing a [[RenderGraphic]] from geometric primitives.
+/** Provides methods for constructing a [[RenderGraphic]] from geometric primitives and symbology.
  * GraphicBuilder is primarily used for creating [[Decorations]] to be displayed inside a [[Viewport]].
  *
  * The typical process for constructing a [[RenderGraphic]] proceeds as follows:
@@ -209,36 +110,11 @@ export interface CustomGraphicBuilderOptions extends GraphicBuilderOptions {
  * @public
  * @extensions
  */
-export declare abstract class GraphicBuilder {
-    /** The local coordinate system transform applied to this builder's geometry.
-     * @see [[GraphicBuilderOptions.placement]].
-     */
-    readonly placement: Transform;
+export declare abstract class GraphicBuilder extends GraphicAssembler {
     /** The iModel associated with this builder, if any. */
     readonly iModel?: IModelConnection;
-    /** The type of graphic to be produced by this builder.
-     * @see [[GraphicBuilderOptions.type]].
-     */
-    readonly type: GraphicType;
-    /** If the graphic is to be pickable, specifies the pickable Id and other options. */
-    readonly pickable?: Readonly<PickableGraphicOptions>;
-    /** If true, the order in which geometry is added to the builder is preserved.
-     * @see [[GraphicBuilderOptions.preserveOrder]] for more details.
-     */
-    readonly preserveOrder: boolean;
-    /** Controls whether normals are generated for surfaces.
-     * @note Normals are required for proper edge display, so by default they are always produced if [[wantEdges]] is `true`.
-     * @see [[GraphicBuilderOptions.wantNormals]] for more details.
-     */
-    readonly wantNormals: boolean;
-    /** Controls whether edges are generated for surfaces.
-     * @see [[GraphicBuilderOptions.generateEdges]] for more details.
-     */
-    readonly wantEdges: boolean;
-    /** @alpha */
-    readonly analysisStyle?: AnalysisStyle;
+    /** @internal */
     protected readonly _computeChordTolerance: (args: ComputeChordToleranceArgs) => number;
-    protected readonly _options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions;
     /** @internal */
     protected constructor(options: ViewportGraphicBuilderOptions | CustomGraphicBuilderOptions);
     /** The Id to be associated with the graphic for picking.
@@ -246,137 +122,10 @@ export declare abstract class GraphicBuilder {
      * @deprecated in 3.x. This provides only the **first** pickable Id for this graphic - you should keep track of the **current** pickable Id yourself.
      */
     get pickId(): Id64String | undefined;
-    /** Whether the builder's geometry is defined in [[CoordSystem.View]] coordinates.
-     * @see [[isWorldCoordinates]].
-     */
-    get isViewCoordinates(): boolean;
-    /** Whether the builder's geometry is defined in [[CoordSystem.World]] coordinates.
-     * @see [[isViewCoordinates]].
-     */
-    get isWorldCoordinates(): boolean;
-    /** True if the builder produces a graphic of [[GraphicType.Scene]]. */
-    get isSceneGraphic(): boolean;
-    /** True if the builder produces a graphic of [[GraphicType.ViewBackground]]. */
-    get isViewBackground(): boolean;
-    /** True if the builder produces a graphic of [[GraphicType.WorldOverlay]] or [[GraphicType.ViewOerlay]]. */
-    get isOverlay(): boolean;
     /**
      * Processes the accumulated symbology and geometry to produce a renderable graphic.
      * This function can only be called once; after the [[RenderGraphic]] has been extracted the [[GraphicBuilder]] should no longer be used.
      */
     abstract finish(): RenderGraphic;
-    /** 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 [[GraphicBuilder.setSymbology]] for a convenient way to set common symbology options.
-     */
-    abstract activateGraphicParams(graphicParams: GraphicParams): void;
-    /** Called by [[activateFeature]] after validation to change the [Feature]($common) to be associated with subsequently-added geometry.
-     * This default implementation does nothing.
-     */
-    protected _activateFeature(_feature: Feature): void;
-    /** 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 [[GraphicBuilderOptions.pickable]] was not supplied to the GraphicBuilder's constructor.
-     */
-    activateFeature(feature: Feature): void;
-    /** 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 [[GraphicBuilder.pickable]]
-     * at construction, if any.
-     * @note This method has no effect if [[GraphicBuilderOptions.pickable]] was not supplied to the GraphicBuilder's constructor.
-     */
-    activatePickableId(id: Id64String): void;
-    /**
-     * Appends a 3d line string to the builder.
-     * @param points Array of vertices in the line string.
-     */
-    abstract addLineString(points: Point3d[]): void;
-    /**
-     * 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.
-     */
-    abstract addLineString2d(points: Point2d[], zDepth: number): void;
-    /**
-     * 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.
-     */
-    abstract addPointString(points: Point3d[]): void;
-    /**
-     * 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.
-     */
-    abstract addPointString2d(points: Point2d[], zDepth: number): void;
-    /**
-     * Appends a closed 3d planar region to the builder.
-     * @param points Array of vertices of the shape.
-     */
-    abstract addShape(points: Point3d[]): void;
-    /**
-     * 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.
-     */
-    abstract addShape2d(points: Point2d[], zDepth: number): void;
-    /**
-     * 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.
-     */
-    abstract addArc(arc: Arc3d, isEllipse: boolean, filled: boolean): void;
-    /**
-     * 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.
-     */
-    abstract addArc2d(ellipse: Arc3d, isEllipse: boolean, filled: boolean, zDepth: number): void;
-    /** Append a 3d open path to the builder. */
-    abstract addPath(path: Path): void;
-    /** Append a 3d planar region to the builder. */
-    abstract addLoop(loop: Loop): void;
-    /** Append a [CurvePrimitive]($core-geometry) to the builder. */
-    addCurvePrimitive(curve: AnyCurvePrimitive): void;
-    /** 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]].
-     */
-    abstract addPolyface(meshData: Polyface, filled: boolean): void;
-    /** Append a solid primitive to the builder. */
-    abstract addSolidPrimitive(solidPrimitive: SolidPrimitive): void;
-    /** Append any primitive to the builder.
-     * @param primitive The graphic primitive to append.
-     */
-    addPrimitive(primitive: GraphicPrimitive): void;
-    /** 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: Range3d, solid?: boolean): void;
-    /** Add Frustum edges. Useful for debugging. */
-    addFrustum(frustum: Frustum): void;
-    /** Add Frustum sides. Useful for debugging. */
-    addFrustumSides(frustum: Frustum): void;
-    /** Add range edges from corner points */
-    addRangeBoxFromCorners(p: Point3d[]): void;
-    /** Add range sides from corner points */
-    addRangeBoxSidesFromCorners(p: Point3d[]): void;
-    /** 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 [[GraphicBuilder.activateGraphicParams]] for additional symbology options.
-     */
-    setSymbology(lineColor: ColorDef, fillColor: ColorDef, lineWidth: number, linePixels?: LinePixels): void;
-    /** 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: ColorDef): void;
 }
 //# sourceMappingURL=GraphicBuilder.d.ts.map

package/lib/cjs/render/GraphicBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GraphicBuilder.d.ts","sourceRoot":"","sources":["../../../src/render/GraphicBuilder.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EACL,iBAAiB,EAAE,KAAK,EAAO,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,EAC1G,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,UAAU,EAAO,MAAM,oBAAoB,CAAC;AAC9H,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;;;;;;;GAQG;AACH,oBAAY,WAAW;IACrB;;;;;;;OAOG;IACH,cAAc,IAAA;IACd,qEAAqE;IACrE;;;;;;OAMG;IACH,KAAK,IAAA;IACL,8GAA8G;IAC9G;;;;;;OAMG;IACH,eAAe,IAAA;IACf;;;;;;;;;;OAUG;IACH,YAAY,IAAA;IACZ;;;;;;;;OAQG;IACH,WAAW,IAAA;CACZ;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2EAA2E;IAC3E,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0HAA0H;IAC1H,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oJAAoJ;IACpJ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kKAAkK;IAClK,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D;;;OAGG;IACH,EAAE,EAAE,UAAU,CAAC;IACf,kFAAkF;IAClF,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B,8FAA8F;IAC9F,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,gFAAgF;IAChF,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,kHAAkH;IAClH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,sCAAsC;IACtC,IAAI,EAAE,WAAW,CAAC;IAElB,yHAAyH;IACzH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,qFAAqF;IACrF,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E,4EAA4E;IAC5E,QAAQ,EAAE,QAAQ,CAAC;IAEnB,yIAAyI;IACzI,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,qBAAqB,CAAC,EAAE,KAAK,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,oGAAoG;IACpG,QAAQ,CAAC,YAAY,EAAE,MAAM,OAAO,CAAC;CACtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,6EAA6E;IAC7E,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,gGAAgG;IAChG,qBAAqB,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,MAAM,CAAC;IAEnE,oBAAoB,CAAC,EAAE,KAAK,CAAC;IAC7B,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,cAAc;IAClC;;OAEG;IACH,SAAgB,SAAS,EAAE,SAAS,CAAC;IAErC,uDAAuD;IACvD,SAAgB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1C;;OAEG;IACH,SAAgB,IAAI,EAAE,WAAW,CAAC;IAElC,qFAAqF;IACrF,SAAgB,QAAQ,CAAC,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IAE5D;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IAEvC;;;OAGG;IACH,SAAgB,WAAW,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,SAAgB,SAAS,EAAE,OAAO,CAAC;IAEnC,aAAa;IACb,SAAgB,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9C,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,MAAM,CAAC;IACvF,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,2BAA2B,GAAG,6BAA6B,CAAC;IAEzF,gBAAgB;IAChB,SAAS,aAAa,OAAO,EAAE,6BAA6B,GAAG,2BAA2B;IAqC1F;;;OAGG;IACH,IAAW,MAAM,IAAI,UAAU,GAAG,SAAS,CAE1C;IAED;;OAEG;IACH,IAAW,iBAAiB,IAAI,OAAO,CAEtC;IAED;;OAEG;IACH,IAAW,kBAAkB,IAAI,OAAO,CAEvC;IAED,uEAAuE;IACvE,IAAW,cAAc,IAAI,OAAO,CAEnC;IAED,gFAAgF;IAChF,IAAW,gBAAgB,IAAI,OAAO,CAErC;IAED,4GAA4G;IAC5G,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;OAGG;aACa,MAAM,IAAI,aAAa;IAEvC;;;OAGG;aACa,qBAAqB,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAEzE;;OAEG;IACH,SAAS,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;IAEnD;;;OAGG;IACI,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAM9C;;;;OAIG;IACI,kBAAkB,CAAC,EAAE,EAAE,UAAU,GAAG,IAAI;IAK/C;;;OAGG;aACa,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI;IAEtD;;;;OAIG;aACa,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAExE;;;OAGG;aACa,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI;IAEvD;;;;OAIG;aACa,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAEzE;;;OAGG;aACa,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI;IAEjD;;;;OAIG;aACa,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAEnE;;;;;OAKG;aACa,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAE7E;;;;;;OAMG;aACa,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAEnG,4CAA4C;aAC5B,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAEzC,gDAAgD;aAChC,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAEzC,gEAAgE;IACzD,iBAAiB,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAoBxD;;;OAGG;aACa,WAAW,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAEtE,+CAA+C;aAC/B,iBAAiB,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI;IAEvE;;OAEG;IACI,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,IAAI;IAyCtD;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,UAAQ,GAAG,IAAI;IAWvD,+CAA+C;IACxC,UAAU,CAAC,OAAO,EAAE,OAAO;IAIlC,+CAA+C;IACxC,eAAe,CAAC,OAAO,EAAE,OAAO;IAIvC,yCAAyC;IAClC,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE;IAmB1C,yCAAyC;IAClC,2BAA2B,CAAC,CAAC,EAAE,OAAO,EAAE;IAuC/C;;;;;;OAMG;IACI,YAAY,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,aAAmB;IAI9G;;;;;OAKG;IACI,eAAe,CAAC,SAAS,EAAE,QAAQ;CAC3C"}
+{"version":3,"file":"GraphicBuilder.d.ts","sourceRoot":"","sources":["../../../src/render/GraphicBuilder.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,EAAE,sBAAsB,EAAC,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAGrE;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,sCAAsC;IACtC,IAAI,EAAE,WAAW,CAAC;IAElB,yHAAyH;IACzH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,qFAAqF;IACrF,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E,4EAA4E;IAC5E,QAAQ,EAAE,QAAQ,CAAC;IAEnB,yIAAyI;IACzI,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,qBAAqB,CAAC,EAAE,KAAK,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,oGAAoG;IACpG,QAAQ,CAAC,YAAY,EAAE,MAAM,OAAO,CAAC;CACtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,6EAA6E;IAC7E,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,gGAAgG;IAChG,qBAAqB,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,MAAM,CAAC;IAEnE,oBAAoB,CAAC,EAAE,KAAK,CAAC;IAC7B,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,cAAe,SAAQ,gBAAgB;IAC3D,uDAAuD;IACvD,SAAgB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1C,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,MAAM,CAAC;IAEvF,gBAAgB;IAChB,SAAS,aAAa,OAAO,EAAE,6BAA6B,GAAG,2BAA2B;IAuC1F;;;OAGG;IACH,IAAW,MAAM,IAAI,UAAU,GAAG,SAAS,CAE1C;IAED;;;OAGG;aACa,MAAM,IAAI,aAAa;CACxC"}

package/lib/cjs/render/GraphicBuilder.js

@@ -7,72 +7,12 @@
  * @module Rendering
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GraphicBuilder = exports.GraphicType = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
+exports.GraphicBuilder = void 0;
 const core_geometry_1 = require("@itwin/core-geometry");
-const core_common_1 = require("@itwin/core-common");
-/**
- * Describes the type of a [[GraphicBuilder]], which defines the coordinate system in which the builder's geometry is defined and
- * controls the behavior of the [[RenderGraphic]] produced by the builder.
- * @note For those types for which depth-testing is disabled, the order in which the individual geometric primitives are drawn determines which geometry draws on top of other geometry.
- *  - Within a [[GraphicList]], each [[RenderGraphic]] is rendered in the order in which it appears in the list; and
- *  - Within a single [[RenderGraphic]], each geometric primitive is rendered in the ordered in which it was added to the GraphicBuilder.
- * @public
- * @extensions
- */
-var GraphicType;
-(function (GraphicType) {
-    /**
-     * Renders behind all other graphics. For example, the border of a [[SheetViewState]] is of this type.
-     * Coordinates: [[CoordSystem.View]].
-     * [[RenderMode]]: [[RenderMode.SmoothShade]].
-     * Lighting: none.
-     * Depth-testing: disabled.
-     * @see [[Decorations.viewBackground]]
-     */
-    GraphicType[GraphicType["ViewBackground"] = 0] = "ViewBackground";
-    /** Used for the scene itself, dynamics, and 'normal' decorations. */
-    /**
-     * Renders as if it were part of the scene. All of the [[ViewFlags]] applied to the view's normal geometry also applies to these types of decorations.
-     * Coordinates: [[CoordSystem.World]].
-     * Lighting and [[RenderMode]]: from view.
-     * Depth-testing: enabled.
-     * @see [[Decorations.normal]].
-     */
-    GraphicType[GraphicType["Scene"] = 1] = "Scene";
-    /** Renders within the scene. Coordinates: world. RenderMode: smooth. Lighting: default. Z-testing: enabled */
-    /** Renders within the scene, but ignores the view's [[ViewFlags]].
-     * Coordinates: [[CoordSystem.World]].
-     * Lighting: default.
-     * [[RenderMode]]: [[RenderMode.SmoothShade]].
-     * Depth-testing: enabled.
-     * @see [[Decorations.world]].
-     */
-    GraphicType[GraphicType["WorldDecoration"] = 2] = "WorldDecoration";
-    /**
-     * Renders as an overlay on top of the scene. These decorations differ from [[GraphicType.WorldDecoration]] only in that depth-testing is disabled.
-     * For example, the ACS triad and [[WindowAreaTool]] decorations are of this type.
-     * Coordinates: [[CoordSystem.World]].
-     * [[RenderMode]]: [[RenderMode.SmoothShade]]
-     * Lighting: default.
-     * Depth-testing: disabled.
-     * Renders atop the scene. Coordinates: world. RenderMode: smooth. Lighting: none. Z-testing: disabled
-     * @note Overlay decorations typically employ some degree of transparency to ensure that they do not fully obscure the scene.
-     * @see [[Decorations.worldOverlay]]
-     */
-    GraphicType[GraphicType["WorldOverlay"] = 3] = "WorldOverlay";
-    /**
-     * Renders as an overlay on top of the scene. These decorations differ from [[GraphicType.WorldOverlay]] only in that their geometry is defined in view coordinates rather than world.
-     * Coordinates: [[CoordSystem.View]].
-     * [[RenderMode]]: [[RenderMode.SmoothShade]]
-     * Lighting: default.
-     * Depth-testing: disabled.
-     * @note For more flexibility in defining view overlay decorations, consider using a [[CanvasDecorationList]].
-     * @see [[Decorations.viewOverlay]]
-     */
-    GraphicType[GraphicType["ViewOverlay"] = 4] = "ViewOverlay";
-})(GraphicType || (exports.GraphicType = GraphicType = {}));
-/** Provides methods for constructing a [[RenderGraphic]] from geometric primitives.
+const GraphicType_1 = require("../common/render/GraphicType");
+const GraphicAssembler_1 = require("../common/render/GraphicAssembler");
+const Symbols_1 = require("../common/internal/Symbols");
+/** Provides methods for constructing a [[RenderGraphic]] from geometric primitives and symbology.
  * GraphicBuilder is primarily used for creating [[Decorations]] to be displayed inside a [[Viewport]].
  *
  * The typical process for constructing a [[RenderGraphic]] proceeds as follows:
@@ -87,24 +27,27 @@ var GraphicType;
  * @public
  * @extensions
  */
-class GraphicBuilder {
+class GraphicBuilder extends GraphicAssembler_1.GraphicAssembler {
     /** @internal */
     constructor(options) {
-        // Stored for potential use later in creating a new GraphicBuilder from this one (see PrimitiveBuilder.finishGraphic).
-        this._options = options;
         const vp = options.viewport;
-        this.placement = options.placement ?? core_geometry_1.Transform.createIdentity();
+        const placement = options.placement ?? core_geometry_1.Transform.createIdentity();
+        const wantEdges = options.generateEdges ?? (options.type === GraphicType_1.GraphicType.Scene && (!vp || vp.viewFlags.edgesRequired()));
+        const wantNormals = options.wantNormals ?? (wantEdges || options.type === GraphicType_1.GraphicType.Scene);
+        const preserveOrder = options.preserveOrder ?? (options.type === GraphicType_1.GraphicType.ViewOverlay || options.type === GraphicType_1.GraphicType.WorldOverlay || options.type === GraphicType_1.GraphicType.ViewBackground);
+        super({
+            ...options,
+            [Symbols_1._implementationProhibited]: undefined,
+            placement,
+            wantEdges,
+            wantNormals,
+            preserveOrder,
+        });
         this.iModel = vp?.iModel ?? options.iModel;
-        this.type = options.type;
-        this.pickable = options.pickable;
-        this.wantEdges = options.generateEdges ?? (this.type === GraphicType.Scene && (!vp || vp.viewFlags.edgesRequired()));
-        this.wantNormals = options.wantNormals ?? (this.wantEdges || this.type === GraphicType.Scene);
-        this.preserveOrder = options.preserveOrder ?? (this.isOverlay || this.isViewBackground);
         if (!options.viewport) {
             this._computeChordTolerance = options.computeChordTolerance;
             return;
         }
-        this.analysisStyle = options.viewport.displayStyle.settings.analysisStyle;
         this._computeChordTolerance = (args) => {
             let pixelSize = 1;
             if (!this.isViewCoordinates) {
@@ -126,215 +69,6 @@ class GraphicBuilder {
     get pickId() {
         return this.pickable?.id;
     }
-    /** Whether the builder's geometry is defined in [[CoordSystem.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.
-     * @see [[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;
-    }
-    /** Called by [[activateFeature]] after validation to change the [Feature]($common) to be associated with subsequently-added geometry.
-     * This default implementation does nothing.
-     */
-    _activateFeature(_feature) { }
-    /** 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 [[GraphicBuilderOptions.pickable]] was not supplied to the GraphicBuilder's constructor.
-     */
-    activateFeature(feature) {
-        (0, core_bentley_1.assert)(undefined !== this._options.pickable, "GraphicBuilder.activateFeature has no effect if PickableGraphicOptions were not supplied");
-        if (this._options.pickable)
-            this._activateFeature(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 [[GraphicBuilder.pickable]]
-     * at construction, if any.
-     * @note This method has no effect if [[GraphicBuilderOptions.pickable]] was not supplied to the GraphicBuilder's constructor.
-     */
-    activatePickableId(id) {
-        const pick = this._options.pickable;
-        this.activateFeature(new core_common_1.Feature(id, pick?.subCategoryId, pick?.geometryClass));
-    }
-    /** 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 core_geometry_1.Path();
-                if (path.tryAddChild(curve))
-                    this.addPath(path);
-                break;
-        }
-    }
-    /** 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(core_common_1.Frustum.fromRange(range));
-            return;
-        }
-        const box = core_geometry_1.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[core_common_1.Npc.LeftBottomFront],
-            p[core_common_1.Npc.LeftTopFront],
-            p[core_common_1.Npc.RightTopFront],
-            p[core_common_1.Npc.RightBottomFront],
-            p[core_common_1.Npc.RightBottomRear],
-            p[core_common_1.Npc.RightTopRear],
-            p[core_common_1.Npc.LeftTopRear],
-            p[core_common_1.Npc.LeftBottomRear],
-            p[core_common_1.Npc.LeftBottomFront].clone(),
-            p[core_common_1.Npc.RightBottomFront].clone(),
-        ]);
-        this.addLineString([p[core_common_1.Npc.LeftTopFront].clone(), p[core_common_1.Npc.LeftTopRear].clone()]);
-        this.addLineString([p[core_common_1.Npc.RightTopFront].clone(), p[core_common_1.Npc.RightTopRear].clone()]);
-        this.addLineString([p[core_common_1.Npc.LeftBottomRear].clone(), p[core_common_1.Npc.RightBottomRear].clone()]);
-    }
-    /** Add range sides from corner points */
-    addRangeBoxSidesFromCorners(p) {
-        this.addShape([
-            p[core_common_1.Npc.LeftBottomFront].clone(),
-            p[core_common_1.Npc.LeftTopFront].clone(),
-            p[core_common_1.Npc.RightTopFront].clone(),
-            p[core_common_1.Npc.RightBottomFront].clone(),
-            p[core_common_1.Npc.LeftBottomFront].clone()
-        ]);
-        this.addShape([
-            p[core_common_1.Npc.RightTopRear].clone(),
-            p[core_common_1.Npc.LeftTopRear].clone(),
-            p[core_common_1.Npc.LeftBottomRear].clone(),
-            p[core_common_1.Npc.RightBottomRear].clone(),
-            p[core_common_1.Npc.RightTopRear].clone()
-        ]);
-        this.addShape([
-            p[core_common_1.Npc.RightTopRear].clone(),
-            p[core_common_1.Npc.LeftTopRear].clone(),
-            p[core_common_1.Npc.LeftTopFront].clone(),
-            p[core_common_1.Npc.RightTopFront].clone(),
-            p[core_common_1.Npc.RightTopRear].clone()
-        ]);
-        this.addShape([
-            p[core_common_1.Npc.RightTopRear].clone(),
-            p[core_common_1.Npc.RightBottomRear].clone(),
-            p[core_common_1.Npc.RightBottomFront].clone(),
-            p[core_common_1.Npc.RightTopFront].clone(),
-            p[core_common_1.Npc.RightTopRear].clone()
-        ]);
-        this.addShape([
-            p[core_common_1.Npc.LeftBottomRear].clone(),
-            p[core_common_1.Npc.RightBottomRear].clone(),
-            p[core_common_1.Npc.RightBottomFront].clone(),
-            p[core_common_1.Npc.LeftBottomFront].clone(),
-            p[core_common_1.Npc.LeftBottomRear].clone()
-        ]);
-        this.addShape([
-            p[core_common_1.Npc.LeftBottomRear].clone(),
-            p[core_common_1.Npc.LeftTopRear].clone(),
-            p[core_common_1.Npc.LeftTopFront].clone(),
-            p[core_common_1.Npc.LeftBottomFront].clone(),
-            p[core_common_1.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 [[GraphicBuilder.activateGraphicParams]] for additional symbology options.
-     */
-    setSymbology(lineColor, fillColor, lineWidth, linePixels = core_common_1.LinePixels.Solid) {
-        this.activateGraphicParams(core_common_1.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(core_common_1.GraphicParams.fromBlankingFill(fillColor)); }
 }
 exports.GraphicBuilder = GraphicBuilder;
 //# sourceMappingURL=GraphicBuilder.js.map