@itwin/core-frontend 3.2.0-dev.9 → 3.2.2

package/lib/esm/render/Decorations.js.map

@@ -1 +1 @@
-{"version":3,"file":"Decorations.js","sourceRoot":"","sources":["../../../src/render/Decorations.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAe,MAAM,qBAAqB,CAAC;AAIzE;;GAEG;AACH,MAAM,OAAO,WAAW;IAUtB,uHAAuH;IACvH,IAAW,MAAM,KAAgC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACvE,IAAW,MAAM,CAAC,MAAiC,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IACtG,kGAAkG;IAClG,IAAW,cAAc,KAAgC,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IACvF,IAAW,cAAc,CAAC,cAAyC,IAAI,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC,CAAC,CAAC;IAC9I,uFAAuF;IACvF,IAAW,MAAM,KAA8B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,IAAW,MAAM,CAAC,MAA+B,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IACzG,wIAAwI;IACxI,IAAW,KAAK,KAA8B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,IAAW,KAAK,CAAC,KAA8B,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;IACpG,yFAAyF;IACzF,IAAW,YAAY,KAA8B,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IACjF,IAAW,YAAY,CAAC,YAAqC,IAAI,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC;IACvI,uFAAuF;IACvF,IAAW,WAAW,KAA8B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/E,IAAW,WAAW,CAAC,WAAoC,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,CAAC,CAAC;IAE3H,OAAO;QACZ,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC;CACF","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 { dispose, disposeArray, IDisposable } from \"@itwin/core-bentley\";\r\nimport { CanvasDecorationList } from \"./CanvasDecoration\";\r\nimport { GraphicList, RenderGraphic } from \"./RenderGraphic\";\r\n\r\n/** A set of [[RenderGraphic]]s and [[CanvasDecoration]]s produced by [[Tool]]s and [[Decorator]]s, used to decorate the contents of a [[Viewport]].\r\n * @public\r\n */\r\nexport class Decorations implements IDisposable {\r\n  private _skyBox?: RenderGraphic;\r\n  private _viewBackground?: RenderGraphic; // drawn first, view units, with no zbuffer, smooth shading, default lighting. e.g., a skybox\r\n  private _normal?: GraphicList;       // drawn with zbuffer, with scene lighting\r\n  private _world?: GraphicList;        // drawn with zbuffer, with default lighting, smooth shading\r\n  private _worldOverlay?: GraphicList; // drawn in overlay mode, world units\r\n  private _viewOverlay?: GraphicList;  // drawn in overlay mode, view units\r\n\r\n  public canvasDecorations?: CanvasDecorationList;\r\n\r\n  /** A view decoration created from a [[SkyBox]] rendered behind all other geometry to provide environmental context. */\r\n  public get skyBox(): RenderGraphic | undefined { return this._skyBox; }\r\n  public set skyBox(skyBox: RenderGraphic | undefined) { dispose(this._skyBox); this._skyBox = skyBox; }\r\n  /** A view decoration drawn as the background of the view. @see [[GraphicType.ViewBackground]]. */\r\n  public get viewBackground(): RenderGraphic | undefined { return this._viewBackground; }\r\n  public set viewBackground(viewBackground: RenderGraphic | undefined) { dispose(this._viewBackground); this._viewBackground = viewBackground; }\r\n  /** Decorations drawn as if they were part of the scene. @see [[GraphicType.Scene]]. */\r\n  public get normal(): GraphicList | undefined { return this._normal; }\r\n  public set normal(normal: GraphicList | undefined) { disposeArray(this._normal); this._normal = normal; }\r\n  /** Decorations drawn as if they were part of the world, but ignoring the view's [[ViewFlags]]. @see [[GraphicType.WorldDecoration]]. */\r\n  public get world(): GraphicList | undefined { return this._world; }\r\n  public set world(world: GraphicList | undefined) { disposeArray(this._world); this._world = world; }\r\n  /** Overlay decorations drawn in world coordinates. @see [[GraphicType.WorldOverlay]]. */\r\n  public get worldOverlay(): GraphicList | undefined { return this._worldOverlay; }\r\n  public set worldOverlay(worldOverlay: GraphicList | undefined) { disposeArray(this._worldOverlay); this._worldOverlay = worldOverlay; }\r\n  /** Overlay decorations drawn in view coordinates. @see [[GraphicType.ViewOverlay]]. */\r\n  public get viewOverlay(): GraphicList | undefined { return this._viewOverlay; }\r\n  public set viewOverlay(viewOverlay: GraphicList | undefined) { disposeArray(this._viewOverlay); this._viewOverlay = viewOverlay; }\r\n\r\n  public dispose() {\r\n    this.skyBox = undefined;\r\n    this.viewBackground = undefined;\r\n    this.world = undefined;\r\n    this.worldOverlay = undefined;\r\n    this.viewOverlay = undefined;\r\n    this.normal = undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Decorations.js","sourceRoot":"","sources":["../../../src/render/Decorations.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAe,MAAM,qBAAqB,CAAC;AAIzE;;;GAGG;AACH,MAAM,OAAO,WAAW;IAUtB,uHAAuH;IACvH,IAAW,MAAM,KAAgC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACvE,IAAW,MAAM,CAAC,MAAiC,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IACtG,kGAAkG;IAClG,IAAW,cAAc,KAAgC,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IACvF,IAAW,cAAc,CAAC,cAAyC,IAAI,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC,CAAC,CAAC;IAC9I,uFAAuF;IACvF,IAAW,MAAM,KAA8B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,IAAW,MAAM,CAAC,MAA+B,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IACzG,wIAAwI;IACxI,IAAW,KAAK,KAA8B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,IAAW,KAAK,CAAC,KAA8B,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;IACpG,yFAAyF;IACzF,IAAW,YAAY,KAA8B,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IACjF,IAAW,YAAY,CAAC,YAAqC,IAAI,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC;IACvI,uFAAuF;IACvF,IAAW,WAAW,KAA8B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/E,IAAW,WAAW,CAAC,WAAoC,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,CAAC,CAAC;IAE3H,OAAO;QACZ,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC;CACF","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 { dispose, disposeArray, IDisposable } from \"@itwin/core-bentley\";\r\nimport { CanvasDecorationList } from \"./CanvasDecoration\";\r\nimport { GraphicList, RenderGraphic } from \"./RenderGraphic\";\r\n\r\n/** A set of [[RenderGraphic]]s and [[CanvasDecoration]]s produced by [[Tool]]s and [[Decorator]]s, used to decorate the contents of a [[Viewport]].\r\n * @public\r\n * @extensions\r\n */\r\nexport class Decorations implements IDisposable {\r\n  private _skyBox?: RenderGraphic;\r\n  private _viewBackground?: RenderGraphic; // drawn first, view units, with no zbuffer, smooth shading, default lighting. e.g., a skybox\r\n  private _normal?: GraphicList;       // drawn with zbuffer, with scene lighting\r\n  private _world?: GraphicList;        // drawn with zbuffer, with default lighting, smooth shading\r\n  private _worldOverlay?: GraphicList; // drawn in overlay mode, world units\r\n  private _viewOverlay?: GraphicList;  // drawn in overlay mode, view units\r\n\r\n  public canvasDecorations?: CanvasDecorationList;\r\n\r\n  /** A view decoration created from a [[SkyBox]] rendered behind all other geometry to provide environmental context. */\r\n  public get skyBox(): RenderGraphic | undefined { return this._skyBox; }\r\n  public set skyBox(skyBox: RenderGraphic | undefined) { dispose(this._skyBox); this._skyBox = skyBox; }\r\n  /** A view decoration drawn as the background of the view. @see [[GraphicType.ViewBackground]]. */\r\n  public get viewBackground(): RenderGraphic | undefined { return this._viewBackground; }\r\n  public set viewBackground(viewBackground: RenderGraphic | undefined) { dispose(this._viewBackground); this._viewBackground = viewBackground; }\r\n  /** Decorations drawn as if they were part of the scene. @see [[GraphicType.Scene]]. */\r\n  public get normal(): GraphicList | undefined { return this._normal; }\r\n  public set normal(normal: GraphicList | undefined) { disposeArray(this._normal); this._normal = normal; }\r\n  /** Decorations drawn as if they were part of the world, but ignoring the view's [[ViewFlags]]. @see [[GraphicType.WorldDecoration]]. */\r\n  public get world(): GraphicList | undefined { return this._world; }\r\n  public set world(world: GraphicList | undefined) { disposeArray(this._world); this._world = world; }\r\n  /** Overlay decorations drawn in world coordinates. @see [[GraphicType.WorldOverlay]]. */\r\n  public get worldOverlay(): GraphicList | undefined { return this._worldOverlay; }\r\n  public set worldOverlay(worldOverlay: GraphicList | undefined) { disposeArray(this._worldOverlay); this._worldOverlay = worldOverlay; }\r\n  /** Overlay decorations drawn in view coordinates. @see [[GraphicType.ViewOverlay]]. */\r\n  public get viewOverlay(): GraphicList | undefined { return this._viewOverlay; }\r\n  public set viewOverlay(viewOverlay: GraphicList | undefined) { disposeArray(this._viewOverlay); this._viewOverlay = viewOverlay; }\r\n\r\n  public dispose() {\r\n    this.skyBox = undefined;\r\n    this.viewBackground = undefined;\r\n    this.world = undefined;\r\n    this.worldOverlay = undefined;\r\n    this.viewOverlay = undefined;\r\n    this.normal = undefined;\r\n  }\r\n}\r\n"]}

package/lib/esm/render/FeatureSymbology.d.ts

@@ -7,6 +7,7 @@ import { Viewport } from "../Viewport";
 import { ViewState } from "../ViewState";
 /** Contains types that enable an application to customize how [Feature]($common)s are drawn within a [[Viewport]].
  * @public
+ * @extensions
  */
 export declare namespace FeatureSymbology {
     /** An object that serves as the source of a [[FeatureSymbology.Overrides]].

package/lib/esm/render/FeatureSymbology.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FeatureSymbology.d.ts","sourceRoot":"","sources":["../../../src/render/FeatureSymbology.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAQ,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAqB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAIzC;;GAEG;AACH,yBAAiB,gBAAgB,CAAC;IAChC;;;;;;;;OAQG;IACH,UAAiB,MAAM;QACrB;;;WAGG;QACH,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;KAChD;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAa,SAAU,SAAQ,gBAAgB;QAC7C,OAAO,CAAC,OAAO,CAAC,CAAS;QAEzB,aAAa;QACb,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAEtC;QAED;;WAEG;oBACgB,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ;QAU9C;;WAEG;eACW,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS;QAMhF;;WAEG;QACI,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;QAK1C;;WAEG;QACI,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;QAiBjD,OAAO,CAAC,aAAa;QAyDrB,OAAO,CAAC,yBAAyB;KA6BlC;CACF"}
+{"version":3,"file":"FeatureSymbology.d.ts","sourceRoot":"","sources":["../../../src/render/FeatureSymbology.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAQ,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAqB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAIzC;;;GAGG;AACH,yBAAiB,gBAAgB,CAAC;IAChC;;;;;;;;OAQG;IACH,UAAiB,MAAM;QACrB;;;WAGG;QACH,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;KAChD;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAa,SAAU,SAAQ,gBAAgB;QAC7C,OAAO,CAAC,OAAO,CAAC,CAAS;QAEzB,aAAa;QACb,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAEtC;QAED;;WAEG;oBACgB,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ;QAU9C;;WAEG;eACW,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS;QAMhF;;WAEG;QACI,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;QAK1C;;WAEG;QACI,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;QAiBjD,OAAO,CAAC,aAAa;QAyDrB,OAAO,CAAC,yBAAyB;KA6BlC;CACF"}

package/lib/esm/render/FeatureSymbology.js

@@ -11,6 +11,7 @@ import { Viewport } from "../Viewport";
 // cspell:ignore subcat subcats
 /** Contains types that enable an application to customize how [Feature]($common)s are drawn within a [[Viewport]].
  * @public
+ * @extensions
  */
 export var FeatureSymbology;
 (function (FeatureSymbology) {

package/lib/esm/render/FeatureSymbology.js.map

@@ -1 +1 @@
-{"version":3,"file":"FeatureSymbology.js","sourceRoot":"","sources":["../../../src/render/FeatureSymbology.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAW,IAAI,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,+BAA+B;AAE/B;;GAEG;AACH,MAAM,KAAW,gBAAgB,CA0LhC;AA1LD,WAAiB,gBAAgB;IAkB/B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAa,SAAU,SAAQ,gBAAgB;QAQ7C;;WAEG;QACH,YAAmB,IAA2B;YAC5C,KAAK,EAAE,CAAC;YACR,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,IAAI,IAAI,YAAY,QAAQ;oBAC1B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;;oBAE5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;aAC3B;QACH,CAAC;QAhBD,aAAa;QACb,IAAW,MAAM;YACf,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QAeD;;WAEG;QACI,MAAM,CAAC,UAAU,CAAC,MAAc,EAAE,IAA2B;YAClE,MAAM,IAAI,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,OAAO,IAAI,CAAC;QACd,CAAC;QAED;;WAEG;QACI,YAAY,CAAC,IAAe;YACjC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QAED;;WAEG;QACI,gBAAgB,CAAC,QAAkB;YACxC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC3B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAEzB,IAAI,SAAS,KAAK,QAAQ,CAAC,UAAU;gBACnC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAE7C,IAAI,SAAS,KAAK,QAAQ,CAAC,WAAW;gBACpC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;YAEhF,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YACnC,QAAQ,CAAC,sCAAsC,CAAC,IAAI,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;YAEvF,gFAAgF;YAChF,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QAEO,aAAa,CAAC,IAAe;;YACnC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;YAC3B,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;YAE1D,IAAI,CAAC,wBAAwB,CAAC,KAAK,EAAE,CAAC;YACtC,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,CAAC;YAEpC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,kBAAkB;gBAClE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAE/B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;YAC9B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC;YAEtC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE;gBACzD,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAC9E,IAAI,SAAS,KAAK,cAAc;oBAC9B,SAAS;gBAEX,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;oBAC1C,IAAI,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,EAAE;wBAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;wBAChD,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;wBAChD,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;wBAE3C,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;wBAC9E,IAAI,SAAS,KAAK,GAAG;4BACnB,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;qBAC7D;iBACF;aACF;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC;YAChC,KAAK,CAAC,QAAQ,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YAErI,KAAK,CAAC,mBAAmB,CAAC,CAAC,YAAY,EAAE,EAAE;gBACzC,IAAI,YAAY,CAAC,mBAAmB,IAAI,YAAY,CAAC,OAAO;oBAC1D,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,mBAAmB,EAAE,CAAC,CAAC;YACnG,CAAC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC;YACnC,IAAI,MAAM;gBACR,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAA,KAAK,CAAC,QAAQ,CAAC,SAAS,mCAAI,CAAC,CAAC,CAAC;YAEpE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,OAAO;YAET,MAAM,sBAAsB,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YACxF,IAAI,SAAS,KAAK,sBAAsB;gBACtC,OAAO;YAET,KAAK,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,sBAAsB,EAAE;gBAC5D,IAAI,SAAS,KAAK,YAAY,CAAC,YAAY;oBACzC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC;aACnH;QACH,CAAC;QAEO,yBAAyB,CAAC,IAAe;YAC/C,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE;gBACjD,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACtD,MAAM,GAAG,GAAG,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;gBACvD,IAAI,SAAS,KAAK,GAAG,EAAE;oBACrB,MAAM,GAAG,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;oBAC3D,IAAI,GAAG,CAAC,kBAAkB;wBACxB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;oBAElD,IAAI,SAAS,KAAK,GAAG,CAAC,QAAQ;wBAC5B,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;iBAC7D;YACH,CAAC,CAAC;YAEF,0DAA0D;YAC1D,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE;gBAChE,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1B,CAAC,CAAC,CAAC;YAEH,kFAAkF;YAClF,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,UAAkB,EAAE,UAAkB,EAAE,OAAuB,EAAE,EAAE;gBAC1G,OAAO,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE;oBAC7C,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;wBAC1C,sFAAsF;wBACtF,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;qBACzB;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;KACF;IAhJY,0BAAS,YAgJrB,CAAA;AACH,CAAC,EA1LgB,gBAAgB,KAAhB,gBAAgB,QA0LhC","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 { BeEvent, Id64 } from \"@itwin/core-bentley\";\r\nimport { FeatureAppearance, FeatureOverrides } from \"@itwin/core-common\";\r\nimport { Viewport } from \"../Viewport\";\r\nimport { ViewState } from \"../ViewState\";\r\n\r\n// cspell:ignore subcat subcats\r\n\r\n/** Contains types that enable an application to customize how [Feature]($common)s are drawn within a [[Viewport]].\r\n * @public\r\n */\r\nexport namespace FeatureSymbology {\r\n  /** An object that serves as the source of a [[FeatureSymbology.Overrides]].\r\n   * Use this if you are drawing the same tiles into a single Viewport and overriding the FeatureSymbology.Overrides applied to them\r\n   * by settings [[GraphicBranch.symbologyOverrides]].\r\n   * Each tile will have a separate set of feature overrides per combination of Source and Viewport. This prevents the display system\r\n   * from constantly recomputing the feature overrides for a tile.\r\n   * You must call `onSourceDisposed.raiseEvent()` when the source is no longer being used by the Viewport to allow the feature overrides\r\n   * and their WebGL resources to be freed - failure to do so will result in memory leaks, which may eventually produce WebGL context loss.\r\n   * @alpha\r\n   */\r\n  export interface Source {\r\n    /** An event raised when this source becomes disassociated with the viewport, indicating any WebGL resources allocated for it\r\n     * can be freed.\r\n     * Failure to invoke this event appropriately will result in memory leaks, which may eventually produce WebGL context loss.\r\n     */\r\n    readonly onSourceDisposed: BeEvent<() => void>;\r\n  }\r\n\r\n  /** Allows a [[Viewport]] to customize the appearance of individual [Feature]($common)s within it.\r\n   *\r\n   * The Viewport computes its base Overrides based on the following:\r\n   *  - The set of categories enabled for display in its [[CategorySelectorState]]. Every [[SubCategory]] belonging to an enabled [[Category]] is added to the set of visible subcategories - all other subcategories are assumed to be invisible.\r\n   *  - For the set of visible subcategories, any [[SubCategoryOverride]]s defined by the view's [[DisplayStyleState]] are applied. This may render some subcategories invisible, and change the symbology of others.\r\n   *  - The visibility of each [GeometryClass]($common) is set based on the view's [ViewFlags]($common).\r\n   *  - The line weight is overridden to 1 pixel for all Features if line weight has been disabled by the view's [ViewFlags]($common).\r\n   *  - The sets of elements which are always drawn and never drawn are initialized from the [[Viewport]]'s sets.\r\n   * An application can further customize the symbology of any Features by registering a [[FeatureOverrideProvider]] with a [[Viewport]]. That provider's addFeatureOverrides function will be invoked\r\n   * whenever the Overrides need to be regenerated.\r\n   *\r\n   * To override the symbology of *most* Features within a view, specify a `defaultOverrides` to be applied to any Feature not explicitly overridden.\r\n   * If default overrides are defined and some Features should draw normally without being affected by the default overrides, override that Feature with\r\n   * an Appearance which defines no overrides.\r\n   *\r\n   * It is possible to override multiple aspects of a Feature. For example, you might specify that all elements belonging to subcategory \"A\" should be drawn in red, and\r\n   * that the element with Id \"0x123\" should be drawn with 0.25 transparency. In this case, when drawing a Feature with subcategory \"A\" and element Id \"0x123\", the two overrides will\r\n   * be merged, causing the Feature's geometry to draw 25% transparent red. On the other hand, if subcategory \"A\" is specified to draw in red and element \"0x123\" to draw in green,\r\n   * the color specified by the element override will take precedence over that specified for the subcategory, resulting in a green Feature.\r\n   *\r\n   * @see [[Viewport.alwaysDrawn]]\r\n   * @see [[Viewport.neverDrawn]]\r\n   */\r\n  export class Overrides extends FeatureOverrides {\r\n    private _source?: Source;\r\n\r\n    /** @alpha */\r\n    public get source(): Source | undefined {\r\n      return this._source;\r\n    }\r\n\r\n    /** Construct a new Overrides. The result is an empty set of overrides if no view or viewport is supplied.\r\n     * @param view If supplied, the overrides will be initialized based on the current state of the view or viewport.\r\n     */\r\n    public constructor(view?: ViewState | Viewport) {\r\n      super();\r\n      if (undefined !== view) {\r\n        if (view instanceof Viewport)\r\n          this.initFromViewport(view);\r\n        else\r\n          this.initFromView(view);\r\n      }\r\n    }\r\n\r\n    /** Create symbology overrides associated with a [[FeatureSymbology.Source]].\r\n     * @alpha\r\n     */\r\n    public static withSource(source: Source, view?: ViewState | Viewport): Overrides {\r\n      const ovrs = new Overrides(view);\r\n      ovrs._source = source;\r\n      return ovrs;\r\n    }\r\n\r\n    /** Initialize these Overrides based on a specific view.\r\n     * @internal\r\n     */\r\n    public initFromView(view: ViewState): void {\r\n      this._initFromView(view);\r\n      this._initSubCategoryOverrides(view);\r\n    }\r\n\r\n    /** Initialize these Overrides based on a specific viewport.\r\n     * @internal\r\n     */\r\n    public initFromViewport(viewport: Viewport): void {\r\n      const view = viewport.view;\r\n      this._initFromView(view);\r\n\r\n      if (undefined !== viewport.neverDrawn)\r\n        this.setNeverDrawnSet(viewport.neverDrawn);\r\n\r\n      if (undefined !== viewport.alwaysDrawn)\r\n        this.setAlwaysDrawnSet(viewport.alwaysDrawn, viewport.isAlwaysDrawnExclusive);\r\n\r\n      viewport.addFeatureOverrides(this);\r\n      viewport.addModelSubCategoryVisibilityOverrides(this, this._modelSubCategoryOverrides);\r\n\r\n      // This will include any per-model subcategory visibility overrides added above.\r\n      this._initSubCategoryOverrides(view);\r\n    }\r\n\r\n    private _initFromView(view: ViewState): void {\r\n      const { viewFlags } = view;\r\n      const { constructions, dimensions, patterns } = viewFlags;\r\n\r\n      this.neverDrawnAnimationNodes.clear();\r\n      this.animationNodeOverrides.clear();\r\n\r\n      for (const excluded of view.displayStyle.settings.excludedElementIds)\r\n        this.setNeverDrawn(excluded);\r\n\r\n      this._constructions = constructions;\r\n      this._dimensions = dimensions;\r\n      this._patterns = patterns;\r\n      this._lineWeights = viewFlags.weights;\r\n\r\n      for (const categoryId of view.categorySelector.categories) {\r\n        const subCategoryIds = view.iModel.subcategories.getSubCategories(categoryId);\r\n        if (undefined === subCategoryIds)\r\n          continue;\r\n\r\n        for (const subCategoryId of subCategoryIds) {\r\n          if (view.isSubCategoryVisible(subCategoryId)) {\r\n            const idLo = Id64.getLowerUint32(subCategoryId);\r\n            const idHi = Id64.getUpperUint32(subCategoryId);\r\n            this._visibleSubCategories.add(idLo, idHi);\r\n\r\n            const app = view.iModel.subcategories.getSubCategoryAppearance(subCategoryId);\r\n            if (undefined !== app)\r\n              this._subCategoryPriorities.set(idLo, idHi, app.priority);\r\n          }\r\n        }\r\n      }\r\n      const style = view.displayStyle;\r\n      style.settings.modelAppearanceOverrides.forEach((appearance, modelId) => this.override({ modelId, appearance, onConflict: \"skip\" }));\r\n\r\n      style.forEachRealityModel((realityModel) => {\r\n        if (realityModel.appearanceOverrides && realityModel.modelId)\r\n          this.override({ modelId: realityModel.modelId, appearance: realityModel.appearanceOverrides });\r\n      });\r\n\r\n      const script = style.scheduleState;\r\n      if (script)\r\n        script.getSymbologyOverrides(this, style.settings.timePoint ?? 0);\r\n\r\n      if (!view.is3d())\r\n        return;\r\n\r\n      const planProjectionSettings = view.getDisplayStyle3d().settings.planProjectionSettings;\r\n      if (undefined === planProjectionSettings)\r\n        return;\r\n\r\n      for (const [modelId, projSettings] of planProjectionSettings) {\r\n        if (undefined !== projSettings.transparency)\r\n          this.override({ modelId, appearance: FeatureAppearance.fromJSON({ transparency: projSettings.transparency }) });\r\n      }\r\n    }\r\n\r\n    private _initSubCategoryOverrides(view: ViewState): void {\r\n      const addOverride = (idLo: number, idHi: number) => {\r\n        const subCategoryId = Id64.fromUint32Pair(idLo, idHi);\r\n        const ovr = view.getSubCategoryOverride(subCategoryId);\r\n        if (undefined !== ovr) {\r\n          const app = FeatureAppearance.fromSubCategoryOverride(ovr);\r\n          if (app.overridesSymbology)\r\n            this._subCategoryOverrides.set(idLo, idHi, app);\r\n\r\n          if (undefined !== ovr.priority)\r\n            this._subCategoryPriorities.set(idLo, idHi, ovr.priority);\r\n        }\r\n      };\r\n\r\n      // Add overrides for all subcategories visible in the view\r\n      this._visibleSubCategories.forEach((idLo: number, idHi: number) => {\r\n        addOverride(idLo, idHi);\r\n      });\r\n\r\n      // Add overrides for all subcategories overridden to be visible in specific models\r\n      this._modelSubCategoryOverrides.forEach((_modelIdLo: number, _modelIdHi: number, subcats: Id64.Uint32Set) => {\r\n        subcats.forEach((idLo: number, idHi: number) => {\r\n          if (!this.isSubCategoryVisible(idLo, idHi)) {\r\n            // Overridden to be visible in one or more models - will need the appearance overrides\r\n            addOverride(idLo, idHi);\r\n          }\r\n        });\r\n      });\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"FeatureSymbology.js","sourceRoot":"","sources":["../../../src/render/FeatureSymbology.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAW,IAAI,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,+BAA+B;AAE/B;;;GAGG;AACH,MAAM,KAAW,gBAAgB,CA0LhC;AA1LD,WAAiB,gBAAgB;IAkB/B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAa,SAAU,SAAQ,gBAAgB;QAQ7C;;WAEG;QACH,YAAmB,IAA2B;YAC5C,KAAK,EAAE,CAAC;YACR,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,IAAI,IAAI,YAAY,QAAQ;oBAC1B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;;oBAE5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;aAC3B;QACH,CAAC;QAhBD,aAAa;QACb,IAAW,MAAM;YACf,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QAeD;;WAEG;QACI,MAAM,CAAC,UAAU,CAAC,MAAc,EAAE,IAA2B;YAClE,MAAM,IAAI,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,OAAO,IAAI,CAAC;QACd,CAAC;QAED;;WAEG;QACI,YAAY,CAAC,IAAe;YACjC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QAED;;WAEG;QACI,gBAAgB,CAAC,QAAkB;YACxC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC3B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAEzB,IAAI,SAAS,KAAK,QAAQ,CAAC,UAAU;gBACnC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAE7C,IAAI,SAAS,KAAK,QAAQ,CAAC,WAAW;gBACpC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;YAEhF,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YACnC,QAAQ,CAAC,sCAAsC,CAAC,IAAI,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;YAEvF,gFAAgF;YAChF,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QAEO,aAAa,CAAC,IAAe;;YACnC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;YAC3B,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;YAE1D,IAAI,CAAC,wBAAwB,CAAC,KAAK,EAAE,CAAC;YACtC,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,CAAC;YAEpC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,kBAAkB;gBAClE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAE/B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;YAC9B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC;YAEtC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE;gBACzD,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAC9E,IAAI,SAAS,KAAK,cAAc;oBAC9B,SAAS;gBAEX,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;oBAC1C,IAAI,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,EAAE;wBAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;wBAChD,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;wBAChD,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;wBAE3C,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC;wBAC9E,IAAI,SAAS,KAAK,GAAG;4BACnB,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;qBAC7D;iBACF;aACF;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC;YAChC,KAAK,CAAC,QAAQ,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YAErI,KAAK,CAAC,mBAAmB,CAAC,CAAC,YAAY,EAAE,EAAE;gBACzC,IAAI,YAAY,CAAC,mBAAmB,IAAI,YAAY,CAAC,OAAO;oBAC1D,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,mBAAmB,EAAE,CAAC,CAAC;YACnG,CAAC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC;YACnC,IAAI,MAAM;gBACR,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAA,KAAK,CAAC,QAAQ,CAAC,SAAS,mCAAI,CAAC,CAAC,CAAC;YAEpE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,OAAO;YAET,MAAM,sBAAsB,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YACxF,IAAI,SAAS,KAAK,sBAAsB;gBACtC,OAAO;YAET,KAAK,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,sBAAsB,EAAE;gBAC5D,IAAI,SAAS,KAAK,YAAY,CAAC,YAAY;oBACzC,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC;aACnH;QACH,CAAC;QAEO,yBAAyB,CAAC,IAAe;YAC/C,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE;gBACjD,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACtD,MAAM,GAAG,GAAG,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;gBACvD,IAAI,SAAS,KAAK,GAAG,EAAE;oBACrB,MAAM,GAAG,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;oBAC3D,IAAI,GAAG,CAAC,kBAAkB;wBACxB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;oBAElD,IAAI,SAAS,KAAK,GAAG,CAAC,QAAQ;wBAC5B,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;iBAC7D;YACH,CAAC,CAAC;YAEF,0DAA0D;YAC1D,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE;gBAChE,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1B,CAAC,CAAC,CAAC;YAEH,kFAAkF;YAClF,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,UAAkB,EAAE,UAAkB,EAAE,OAAuB,EAAE,EAAE;gBAC1G,OAAO,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE;oBAC7C,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;wBAC1C,sFAAsF;wBACtF,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;qBACzB;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;KACF;IAhJY,0BAAS,YAgJrB,CAAA;AACH,CAAC,EA1LgB,gBAAgB,KAAhB,gBAAgB,QA0LhC","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 { BeEvent, Id64 } from \"@itwin/core-bentley\";\r\nimport { FeatureAppearance, FeatureOverrides } from \"@itwin/core-common\";\r\nimport { Viewport } from \"../Viewport\";\r\nimport { ViewState } from \"../ViewState\";\r\n\r\n// cspell:ignore subcat subcats\r\n\r\n/** Contains types that enable an application to customize how [Feature]($common)s are drawn within a [[Viewport]].\r\n * @public\r\n * @extensions\r\n */\r\nexport namespace FeatureSymbology {\r\n  /** An object that serves as the source of a [[FeatureSymbology.Overrides]].\r\n   * Use this if you are drawing the same tiles into a single Viewport and overriding the FeatureSymbology.Overrides applied to them\r\n   * by settings [[GraphicBranch.symbologyOverrides]].\r\n   * Each tile will have a separate set of feature overrides per combination of Source and Viewport. This prevents the display system\r\n   * from constantly recomputing the feature overrides for a tile.\r\n   * You must call `onSourceDisposed.raiseEvent()` when the source is no longer being used by the Viewport to allow the feature overrides\r\n   * and their WebGL resources to be freed - failure to do so will result in memory leaks, which may eventually produce WebGL context loss.\r\n   * @alpha\r\n   */\r\n  export interface Source {\r\n    /** An event raised when this source becomes disassociated with the viewport, indicating any WebGL resources allocated for it\r\n     * can be freed.\r\n     * Failure to invoke this event appropriately will result in memory leaks, which may eventually produce WebGL context loss.\r\n     */\r\n    readonly onSourceDisposed: BeEvent<() => void>;\r\n  }\r\n\r\n  /** Allows a [[Viewport]] to customize the appearance of individual [Feature]($common)s within it.\r\n   *\r\n   * The Viewport computes its base Overrides based on the following:\r\n   *  - The set of categories enabled for display in its [[CategorySelectorState]]. Every [[SubCategory]] belonging to an enabled [[Category]] is added to the set of visible subcategories - all other subcategories are assumed to be invisible.\r\n   *  - For the set of visible subcategories, any [[SubCategoryOverride]]s defined by the view's [[DisplayStyleState]] are applied. This may render some subcategories invisible, and change the symbology of others.\r\n   *  - The visibility of each [GeometryClass]($common) is set based on the view's [ViewFlags]($common).\r\n   *  - The line weight is overridden to 1 pixel for all Features if line weight has been disabled by the view's [ViewFlags]($common).\r\n   *  - The sets of elements which are always drawn and never drawn are initialized from the [[Viewport]]'s sets.\r\n   * An application can further customize the symbology of any Features by registering a [[FeatureOverrideProvider]] with a [[Viewport]]. That provider's addFeatureOverrides function will be invoked\r\n   * whenever the Overrides need to be regenerated.\r\n   *\r\n   * To override the symbology of *most* Features within a view, specify a `defaultOverrides` to be applied to any Feature not explicitly overridden.\r\n   * If default overrides are defined and some Features should draw normally without being affected by the default overrides, override that Feature with\r\n   * an Appearance which defines no overrides.\r\n   *\r\n   * It is possible to override multiple aspects of a Feature. For example, you might specify that all elements belonging to subcategory \"A\" should be drawn in red, and\r\n   * that the element with Id \"0x123\" should be drawn with 0.25 transparency. In this case, when drawing a Feature with subcategory \"A\" and element Id \"0x123\", the two overrides will\r\n   * be merged, causing the Feature's geometry to draw 25% transparent red. On the other hand, if subcategory \"A\" is specified to draw in red and element \"0x123\" to draw in green,\r\n   * the color specified by the element override will take precedence over that specified for the subcategory, resulting in a green Feature.\r\n   *\r\n   * @see [[Viewport.alwaysDrawn]]\r\n   * @see [[Viewport.neverDrawn]]\r\n   */\r\n  export class Overrides extends FeatureOverrides {\r\n    private _source?: Source;\r\n\r\n    /** @alpha */\r\n    public get source(): Source | undefined {\r\n      return this._source;\r\n    }\r\n\r\n    /** Construct a new Overrides. The result is an empty set of overrides if no view or viewport is supplied.\r\n     * @param view If supplied, the overrides will be initialized based on the current state of the view or viewport.\r\n     */\r\n    public constructor(view?: ViewState | Viewport) {\r\n      super();\r\n      if (undefined !== view) {\r\n        if (view instanceof Viewport)\r\n          this.initFromViewport(view);\r\n        else\r\n          this.initFromView(view);\r\n      }\r\n    }\r\n\r\n    /** Create symbology overrides associated with a [[FeatureSymbology.Source]].\r\n     * @alpha\r\n     */\r\n    public static withSource(source: Source, view?: ViewState | Viewport): Overrides {\r\n      const ovrs = new Overrides(view);\r\n      ovrs._source = source;\r\n      return ovrs;\r\n    }\r\n\r\n    /** Initialize these Overrides based on a specific view.\r\n     * @internal\r\n     */\r\n    public initFromView(view: ViewState): void {\r\n      this._initFromView(view);\r\n      this._initSubCategoryOverrides(view);\r\n    }\r\n\r\n    /** Initialize these Overrides based on a specific viewport.\r\n     * @internal\r\n     */\r\n    public initFromViewport(viewport: Viewport): void {\r\n      const view = viewport.view;\r\n      this._initFromView(view);\r\n\r\n      if (undefined !== viewport.neverDrawn)\r\n        this.setNeverDrawnSet(viewport.neverDrawn);\r\n\r\n      if (undefined !== viewport.alwaysDrawn)\r\n        this.setAlwaysDrawnSet(viewport.alwaysDrawn, viewport.isAlwaysDrawnExclusive);\r\n\r\n      viewport.addFeatureOverrides(this);\r\n      viewport.addModelSubCategoryVisibilityOverrides(this, this._modelSubCategoryOverrides);\r\n\r\n      // This will include any per-model subcategory visibility overrides added above.\r\n      this._initSubCategoryOverrides(view);\r\n    }\r\n\r\n    private _initFromView(view: ViewState): void {\r\n      const { viewFlags } = view;\r\n      const { constructions, dimensions, patterns } = viewFlags;\r\n\r\n      this.neverDrawnAnimationNodes.clear();\r\n      this.animationNodeOverrides.clear();\r\n\r\n      for (const excluded of view.displayStyle.settings.excludedElementIds)\r\n        this.setNeverDrawn(excluded);\r\n\r\n      this._constructions = constructions;\r\n      this._dimensions = dimensions;\r\n      this._patterns = patterns;\r\n      this._lineWeights = viewFlags.weights;\r\n\r\n      for (const categoryId of view.categorySelector.categories) {\r\n        const subCategoryIds = view.iModel.subcategories.getSubCategories(categoryId);\r\n        if (undefined === subCategoryIds)\r\n          continue;\r\n\r\n        for (const subCategoryId of subCategoryIds) {\r\n          if (view.isSubCategoryVisible(subCategoryId)) {\r\n            const idLo = Id64.getLowerUint32(subCategoryId);\r\n            const idHi = Id64.getUpperUint32(subCategoryId);\r\n            this._visibleSubCategories.add(idLo, idHi);\r\n\r\n            const app = view.iModel.subcategories.getSubCategoryAppearance(subCategoryId);\r\n            if (undefined !== app)\r\n              this._subCategoryPriorities.set(idLo, idHi, app.priority);\r\n          }\r\n        }\r\n      }\r\n      const style = view.displayStyle;\r\n      style.settings.modelAppearanceOverrides.forEach((appearance, modelId) => this.override({ modelId, appearance, onConflict: \"skip\" }));\r\n\r\n      style.forEachRealityModel((realityModel) => {\r\n        if (realityModel.appearanceOverrides && realityModel.modelId)\r\n          this.override({ modelId: realityModel.modelId, appearance: realityModel.appearanceOverrides });\r\n      });\r\n\r\n      const script = style.scheduleState;\r\n      if (script)\r\n        script.getSymbologyOverrides(this, style.settings.timePoint ?? 0);\r\n\r\n      if (!view.is3d())\r\n        return;\r\n\r\n      const planProjectionSettings = view.getDisplayStyle3d().settings.planProjectionSettings;\r\n      if (undefined === planProjectionSettings)\r\n        return;\r\n\r\n      for (const [modelId, projSettings] of planProjectionSettings) {\r\n        if (undefined !== projSettings.transparency)\r\n          this.override({ modelId, appearance: FeatureAppearance.fromJSON({ transparency: projSettings.transparency }) });\r\n      }\r\n    }\r\n\r\n    private _initSubCategoryOverrides(view: ViewState): void {\r\n      const addOverride = (idLo: number, idHi: number) => {\r\n        const subCategoryId = Id64.fromUint32Pair(idLo, idHi);\r\n        const ovr = view.getSubCategoryOverride(subCategoryId);\r\n        if (undefined !== ovr) {\r\n          const app = FeatureAppearance.fromSubCategoryOverride(ovr);\r\n          if (app.overridesSymbology)\r\n            this._subCategoryOverrides.set(idLo, idHi, app);\r\n\r\n          if (undefined !== ovr.priority)\r\n            this._subCategoryPriorities.set(idLo, idHi, ovr.priority);\r\n        }\r\n      };\r\n\r\n      // Add overrides for all subcategories visible in the view\r\n      this._visibleSubCategories.forEach((idLo: number, idHi: number) => {\r\n        addOverride(idLo, idHi);\r\n      });\r\n\r\n      // Add overrides for all subcategories overridden to be visible in specific models\r\n      this._modelSubCategoryOverrides.forEach((_modelIdLo: number, _modelIdHi: number, subcats: Id64.Uint32Set) => {\r\n        subcats.forEach((idLo: number, idHi: number) => {\r\n          if (!this.isSubCategoryVisible(idLo, idHi)) {\r\n            // Overridden to be visible in one or more models - will need the appearance overrides\r\n            addOverride(idLo, idHi);\r\n          }\r\n        });\r\n      });\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/esm/render/GraphicBranch.d.ts

@@ -33,6 +33,7 @@ export declare enum AnimationNodeId {
  * Branches can be nested to build an arbitrarily-complex scene graph.
  * @see [[RenderSystem.createBranch]]
  * @public
+ * @extensions
  */
 export declare class GraphicBranch implements IDisposable {
     /** The child nodes of this branch */
@@ -79,6 +80,7 @@ export declare class GraphicBranch implements IDisposable {
 }
 /** Options passed to [[RenderSystem.createGraphicBranch]].
  * @public
+ * @extensions
  */
 export interface GraphicBranchOptions {
     /** Clip applied to the graphics in the branch. */

package/lib/esm/render/GraphicBranch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GraphicBranch.d.ts","sourceRoot":"","sources":["../../../src/render/GraphicBranch.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE;QACL,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;CACH;AAED,OAAO,EAAgB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,yBAAyB,EAAE,UAAU,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACzG,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEpD;;;GAGG;AACH,oBAAY,eAAe;IACzB,aAAa,aAAa;CAC3B;AAED;;;;;;GAMG;AACH,qBAAa,aAAc,YAAW,WAAW;IAC/C,qCAAqC;IACrC,SAAgB,OAAO,EAAE,aAAa,EAAE,CAAM;IAC9C,6GAA6G;IAC7G,SAAgB,WAAW,EAAE,OAAO,CAAC;IACrC;;OAEG;IACI,iBAAiB,EAAE,iBAAiB,CAAM;IACjD,gFAAgF;IACzE,kBAAkB,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IACvD;;OAEG;IACI,WAAW,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACI,eAAe,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IAElD;;OAEG;gBACgB,WAAW,GAAE,OAAe;IAI/C,oCAAoC;IAC7B,GAAG,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAIxC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAIhD,uFAAuF;IAChF,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAI3C,oCAAoC;IAC7B,oBAAoB,CAAC,GAAG,EAAE,iBAAiB,GAAG,IAAI;IAIzD,uFAAuF;IAChF,OAAO;IAId,wDAAwD;IACxD,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,sIAAsI;IAC/H,KAAK,IAAI,IAAI;IAOpB,gBAAgB;IACT,iBAAiB,CAAC,KAAK,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;CAI/D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,kDAAkD;IAClD,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,gBAAgB;IAChB,iBAAiB,CAAC,EAAE,sBAAsB,GAAG,kBAAkB,CAAC;IAChE,mFAAmF;IACnF,KAAK,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;IAC5B,qGAAqG;IACrG,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,gBAAgB;IAChB,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,wFAAwF;IACxF,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;IAC/C,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oCAAoC;IACpC,QAAQ,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IACzD,2CAA2C;IAC3C,QAAQ,CAAC,gBAAgB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAChD"}
+{"version":3,"file":"GraphicBranch.d.ts","sourceRoot":"","sources":["../../../src/render/GraphicBranch.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE;QACL,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;CACH;AAED,OAAO,EAAgB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,yBAAyB,EAAE,UAAU,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACzG,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEpD;;;GAGG;AACH,oBAAY,eAAe;IACzB,aAAa,aAAa;CAC3B;AAED;;;;;;;GAOG;AACH,qBAAa,aAAc,YAAW,WAAW;IAC/C,qCAAqC;IACrC,SAAgB,OAAO,EAAE,aAAa,EAAE,CAAM;IAC9C,6GAA6G;IAC7G,SAAgB,WAAW,EAAE,OAAO,CAAC;IACrC;;OAEG;IACI,iBAAiB,EAAE,iBAAiB,CAAM;IACjD,gFAAgF;IACzE,kBAAkB,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IACvD;;OAEG;IACI,WAAW,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACI,eAAe,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IAElD;;OAEG;gBACgB,WAAW,GAAE,OAAe;IAI/C,oCAAoC;IAC7B,GAAG,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAIxC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS;IAIhD,uFAAuF;IAChF,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAI3C,oCAAoC;IAC7B,oBAAoB,CAAC,GAAG,EAAE,iBAAiB,GAAG,IAAI;IAIzD,uFAAuF;IAChF,OAAO;IAId,wDAAwD;IACxD,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,sIAAsI;IAC/H,KAAK,IAAI,IAAI;IAOpB,gBAAgB;IACT,iBAAiB,CAAC,KAAK,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;CAI/D;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,kDAAkD;IAClD,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,gBAAgB;IAChB,iBAAiB,CAAC,EAAE,sBAAsB,GAAG,kBAAkB,CAAC;IAChE,mFAAmF;IACnF,KAAK,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;IAC5B,qGAAqG;IACrG,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,gBAAgB;IAChB,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,wFAAwF;IACxF,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;IAC/C,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oCAAoC;IACpC,QAAQ,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IACzD,2CAA2C;IAC3C,QAAQ,CAAC,gBAAgB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAChD"}

package/lib/esm/render/GraphicBranch.js

@@ -20,6 +20,7 @@ export var AnimationNodeId;
  * Branches can be nested to build an arbitrarily-complex scene graph.
  * @see [[RenderSystem.createBranch]]
  * @public
+ * @extensions
  */
 export class GraphicBranch {
     /** Constructor

package/lib/esm/render/GraphicBranch.js.map

@@ -1 +1 @@
-{"version":3,"file":"GraphicBranch.js","sourceRoot":"","sources":["../../../src/render/GraphicBranch.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAaH,OAAO,EAAE,YAAY,EAAe,MAAM,qBAAqB,CAAC;AAUhE;;;GAGG;AACH,MAAM,CAAN,IAAY,eAEX;AAFD,WAAY,eAAe;IACzB,gFAA0B,CAAA;AAC5B,CAAC,EAFW,eAAe,KAAf,eAAe,QAE1B;AAED;;;;;;GAMG;AACH,MAAM,OAAO,aAAa;IAoBxB;;OAEG;IACH,YAAmB,cAAuB,KAAK;QAtB/C,qCAAqC;QACrB,YAAO,GAAoB,EAAE,CAAC;QAG9C;;WAEG;QACI,sBAAiB,GAAsB,EAAE,CAAC;QAgB/C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,oCAAoC;IAC7B,GAAG,CAAC,OAAsB;QAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,KAAgB;QAClC,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAChD,CAAC;IAED,uFAAuF;IAChF,YAAY,CAAC,KAAgB;QAClC,IAAI,CAAC,iBAAiB,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;IACxC,CAAC;IAED,oCAAoC;IAC7B,oBAAoB,CAAC,GAAsB;QAChD,IAAI,CAAC,iBAAiB,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IACtC,CAAC;IAED,uFAAuF;IAChF,OAAO;QACZ,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,wDAAwD;IACxD,IAAW,OAAO;QAChB,OAAO,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IACnC,CAAC;IAED,sIAAsI;IAC/H,KAAK;QACV,IAAI,IAAI,CAAC,WAAW;YAClB,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;;YAE3B,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,KAA8B;QACrD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO;YAC9B,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;CACF","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\n/** Carries information in a GraphicBranchOptions about a GraphicBranch produced by drawing one view into the context of another.\r\n * @internal\r\n */\r\nexport interface GraphicBranchFrustum {\r\n  is3d: boolean;\r\n  scale: {\r\n    x: number;\r\n    y: number;\r\n  };\r\n}\r\n\r\nimport { disposeArray, IDisposable } from \"@itwin/core-bentley\";\r\nimport { FeatureAppearanceProvider, HiddenLine, ViewFlagOverrides, ViewFlags } from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { FeatureSymbology } from \"./FeatureSymbology\";\r\nimport { RenderClipVolume } from \"./RenderClipVolume\";\r\nimport { RenderGraphic } from \"./RenderGraphic\";\r\nimport { RenderMemory } from \"./RenderMemory\";\r\nimport { RenderPlanarClassifier } from \"./RenderPlanarClassifier\";\r\nimport { RenderTextureDrape } from \"./RenderSystem\";\r\n\r\n/** Special values of [[GraphicBranch.animationNodeId]].\r\n * All other values refer to an [ElementTimeline.batchId]($common) that applies a transform to the graphics in the branch.\r\n * @internal\r\n */\r\nexport enum AnimationNodeId {\r\n  Untransformed = 0xffffffff,\r\n}\r\n\r\n/**\r\n * A node in a scene graph. The branch itself is not renderable. Instead it contains a list of RenderGraphics,\r\n * and a transform, symbology overrides, and clip volume which are to be applied when rendering them.\r\n * Branches can be nested to build an arbitrarily-complex scene graph.\r\n * @see [[RenderSystem.createBranch]]\r\n * @public\r\n */\r\nexport class GraphicBranch implements IDisposable /* , RenderMemory.Consumer */ {\r\n  /** The child nodes of this branch */\r\n  public readonly entries: RenderGraphic[] = [];\r\n  /** If true, when the branch is disposed of, the RenderGraphics in its entries array will also be disposed */\r\n  public readonly ownsEntries: boolean;\r\n  /** Selectively overrides the view's [ViewFlags]($common) while drawing graphics within this branch. The default overrides nothing.\r\n   * @see [[setViewFlagOverrides]].\r\n   */\r\n  public viewFlagOverrides: ViewFlagOverrides = {};\r\n  /** Optional symbology overrides to be applied to all graphics in this branch */\r\n  public symbologyOverrides?: FeatureSymbology.Overrides;\r\n  /** Optional animation branch Id that incorporates the model Id and, for element timelines, the batch Id.\r\n   * @internal\r\n   */\r\n  public animationId?: string;\r\n  /** Identifies the node in the [RenderSchedule.Script]($backend) with which this branch is associated.\r\n   * @internal\r\n   */\r\n  public animationNodeId?: AnimationNodeId | number;\r\n\r\n  /** Constructor\r\n   * @param ownsEntries If true, when this branch is [[dispose]]d, all of the [[RenderGraphic]]s it contains will also be disposed.\r\n   */\r\n  public constructor(ownsEntries: boolean = false) {\r\n    this.ownsEntries = ownsEntries;\r\n  }\r\n\r\n  /** Add a graphic to this branch. */\r\n  public add(graphic: RenderGraphic): void {\r\n    this.entries.push(graphic);\r\n  }\r\n\r\n  /** Compute the view flags that result from applying this branch's [[viewFlagOverrides]] to the input flags.\r\n   * @param flags The input view flags, e.g., from the view's [[DisplayStyleState]].\r\n   * @returns The result of applying [[viewFlagOverrides]] to `flags`.\r\n   */\r\n  public getViewFlags(flags: ViewFlags): ViewFlags {\r\n    return flags.override(this.viewFlagOverrides);\r\n  }\r\n\r\n  /** Set [[viewFlagOverrides]] to override **all** ViewFlags as specified by `flags`. */\r\n  public setViewFlags(flags: ViewFlags): void {\r\n    this.viewFlagOverrides = { ...flags };\r\n  }\r\n\r\n  /** Change [[viewFlagOverrides]]. */\r\n  public setViewFlagOverrides(ovr: ViewFlagOverrides): void {\r\n    this.viewFlagOverrides = { ...ovr };\r\n  }\r\n\r\n  /** Disposes of all graphics in this branch, if and only if [[ownsEntries]] is true. */\r\n  public dispose() {\r\n    this.clear();\r\n  }\r\n\r\n  /** Returns true if this branch contains no graphics. */\r\n  public get isEmpty(): boolean {\r\n    return 0 === this.entries.length;\r\n  }\r\n\r\n  /** Empties the list of [[RenderGraphic]]s contained in this branch, and if the [[ownsEntries]] flag is set, also disposes of them. */\r\n  public clear(): void {\r\n    if (this.ownsEntries)\r\n      disposeArray(this.entries);\r\n    else\r\n      this.entries.length = 0;\r\n  }\r\n\r\n  /** @internal */\r\n  public collectStatistics(stats: RenderMemory.Statistics): void {\r\n    for (const entry of this.entries)\r\n      entry.collectStatistics(stats);\r\n  }\r\n}\r\n\r\n/** Options passed to [[RenderSystem.createGraphicBranch]].\r\n * @public\r\n */\r\nexport interface GraphicBranchOptions {\r\n  /** Clip applied to the graphics in the branch. */\r\n  clipVolume?: RenderClipVolume;\r\n  /** @internal */\r\n  classifierOrDrape?: RenderPlanarClassifier | RenderTextureDrape;\r\n  /** Optionally replaces the view's hidden line settings when drawing the branch. */\r\n  hline?: HiddenLine.Settings;\r\n  /** The iModel from which the graphics originate, if different than that associated with the view. */\r\n  iModel?: IModelConnection;\r\n  /** @internal */\r\n  frustum?: GraphicBranchFrustum;\r\n  /** Supplements the view's [[FeatureSymbology.Overrides]] for graphics in the branch. */\r\n  appearanceProvider?: FeatureAppearanceProvider;\r\n  /** @internal Secondary planar classifiers (map layers) */\r\n  secondaryClassifiers?: Map<number, RenderPlanarClassifier>;\r\n}\r\n\r\n/** Clip/Transform for a branch that are varied over time.\r\n * @internal\r\n */\r\nexport interface AnimationBranchState {\r\n  readonly clip?: RenderClipVolume;\r\n  readonly omit?: boolean;\r\n}\r\n\r\n/** Mapping from node/branch IDs to animation branch state\r\n * @internal\r\n */\r\nexport interface AnimationBranchStates {\r\n  /** Maps node Id to branch state. */\r\n  readonly branchStates: Map<string, AnimationBranchState>;\r\n  /** Ids of nodes that apply a transform. */\r\n  readonly transformNodeIds: ReadonlySet<number>;\r\n}\r\n"]}
+{"version":3,"file":"GraphicBranch.js","sourceRoot":"","sources":["../../../src/render/GraphicBranch.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAaH,OAAO,EAAE,YAAY,EAAe,MAAM,qBAAqB,CAAC;AAUhE;;;GAGG;AACH,MAAM,CAAN,IAAY,eAEX;AAFD,WAAY,eAAe;IACzB,gFAA0B,CAAA;AAC5B,CAAC,EAFW,eAAe,KAAf,eAAe,QAE1B;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,aAAa;IAoBxB;;OAEG;IACH,YAAmB,cAAuB,KAAK;QAtB/C,qCAAqC;QACrB,YAAO,GAAoB,EAAE,CAAC;QAG9C;;WAEG;QACI,sBAAiB,GAAsB,EAAE,CAAC;QAgB/C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,oCAAoC;IAC7B,GAAG,CAAC,OAAsB;QAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,KAAgB;QAClC,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAChD,CAAC;IAED,uFAAuF;IAChF,YAAY,CAAC,KAAgB;QAClC,IAAI,CAAC,iBAAiB,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;IACxC,CAAC;IAED,oCAAoC;IAC7B,oBAAoB,CAAC,GAAsB;QAChD,IAAI,CAAC,iBAAiB,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IACtC,CAAC;IAED,uFAAuF;IAChF,OAAO;QACZ,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,wDAAwD;IACxD,IAAW,OAAO;QAChB,OAAO,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IACnC,CAAC;IAED,sIAAsI;IAC/H,KAAK;QACV,IAAI,IAAI,CAAC,WAAW;YAClB,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;;YAE3B,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,KAA8B;QACrD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO;YAC9B,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;CACF","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\n/** Carries information in a GraphicBranchOptions about a GraphicBranch produced by drawing one view into the context of another.\r\n * @internal\r\n */\r\nexport interface GraphicBranchFrustum {\r\n  is3d: boolean;\r\n  scale: {\r\n    x: number;\r\n    y: number;\r\n  };\r\n}\r\n\r\nimport { disposeArray, IDisposable } from \"@itwin/core-bentley\";\r\nimport { FeatureAppearanceProvider, HiddenLine, ViewFlagOverrides, ViewFlags } from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { FeatureSymbology } from \"./FeatureSymbology\";\r\nimport { RenderClipVolume } from \"./RenderClipVolume\";\r\nimport { RenderGraphic } from \"./RenderGraphic\";\r\nimport { RenderMemory } from \"./RenderMemory\";\r\nimport { RenderPlanarClassifier } from \"./RenderPlanarClassifier\";\r\nimport { RenderTextureDrape } from \"./RenderSystem\";\r\n\r\n/** Special values of [[GraphicBranch.animationNodeId]].\r\n * All other values refer to an [ElementTimeline.batchId]($common) that applies a transform to the graphics in the branch.\r\n * @internal\r\n */\r\nexport enum AnimationNodeId {\r\n  Untransformed = 0xffffffff,\r\n}\r\n\r\n/**\r\n * A node in a scene graph. The branch itself is not renderable. Instead it contains a list of RenderGraphics,\r\n * and a transform, symbology overrides, and clip volume which are to be applied when rendering them.\r\n * Branches can be nested to build an arbitrarily-complex scene graph.\r\n * @see [[RenderSystem.createBranch]]\r\n * @public\r\n * @extensions\r\n */\r\nexport class GraphicBranch implements IDisposable /* , RenderMemory.Consumer */ {\r\n  /** The child nodes of this branch */\r\n  public readonly entries: RenderGraphic[] = [];\r\n  /** If true, when the branch is disposed of, the RenderGraphics in its entries array will also be disposed */\r\n  public readonly ownsEntries: boolean;\r\n  /** Selectively overrides the view's [ViewFlags]($common) while drawing graphics within this branch. The default overrides nothing.\r\n   * @see [[setViewFlagOverrides]].\r\n   */\r\n  public viewFlagOverrides: ViewFlagOverrides = {};\r\n  /** Optional symbology overrides to be applied to all graphics in this branch */\r\n  public symbologyOverrides?: FeatureSymbology.Overrides;\r\n  /** Optional animation branch Id that incorporates the model Id and, for element timelines, the batch Id.\r\n   * @internal\r\n   */\r\n  public animationId?: string;\r\n  /** Identifies the node in the [RenderSchedule.Script]($backend) with which this branch is associated.\r\n   * @internal\r\n   */\r\n  public animationNodeId?: AnimationNodeId | number;\r\n\r\n  /** Constructor\r\n   * @param ownsEntries If true, when this branch is [[dispose]]d, all of the [[RenderGraphic]]s it contains will also be disposed.\r\n   */\r\n  public constructor(ownsEntries: boolean = false) {\r\n    this.ownsEntries = ownsEntries;\r\n  }\r\n\r\n  /** Add a graphic to this branch. */\r\n  public add(graphic: RenderGraphic): void {\r\n    this.entries.push(graphic);\r\n  }\r\n\r\n  /** Compute the view flags that result from applying this branch's [[viewFlagOverrides]] to the input flags.\r\n   * @param flags The input view flags, e.g., from the view's [[DisplayStyleState]].\r\n   * @returns The result of applying [[viewFlagOverrides]] to `flags`.\r\n   */\r\n  public getViewFlags(flags: ViewFlags): ViewFlags {\r\n    return flags.override(this.viewFlagOverrides);\r\n  }\r\n\r\n  /** Set [[viewFlagOverrides]] to override **all** ViewFlags as specified by `flags`. */\r\n  public setViewFlags(flags: ViewFlags): void {\r\n    this.viewFlagOverrides = { ...flags };\r\n  }\r\n\r\n  /** Change [[viewFlagOverrides]]. */\r\n  public setViewFlagOverrides(ovr: ViewFlagOverrides): void {\r\n    this.viewFlagOverrides = { ...ovr };\r\n  }\r\n\r\n  /** Disposes of all graphics in this branch, if and only if [[ownsEntries]] is true. */\r\n  public dispose() {\r\n    this.clear();\r\n  }\r\n\r\n  /** Returns true if this branch contains no graphics. */\r\n  public get isEmpty(): boolean {\r\n    return 0 === this.entries.length;\r\n  }\r\n\r\n  /** Empties the list of [[RenderGraphic]]s contained in this branch, and if the [[ownsEntries]] flag is set, also disposes of them. */\r\n  public clear(): void {\r\n    if (this.ownsEntries)\r\n      disposeArray(this.entries);\r\n    else\r\n      this.entries.length = 0;\r\n  }\r\n\r\n  /** @internal */\r\n  public collectStatistics(stats: RenderMemory.Statistics): void {\r\n    for (const entry of this.entries)\r\n      entry.collectStatistics(stats);\r\n  }\r\n}\r\n\r\n/** Options passed to [[RenderSystem.createGraphicBranch]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GraphicBranchOptions {\r\n  /** Clip applied to the graphics in the branch. */\r\n  clipVolume?: RenderClipVolume;\r\n  /** @internal */\r\n  classifierOrDrape?: RenderPlanarClassifier | RenderTextureDrape;\r\n  /** Optionally replaces the view's hidden line settings when drawing the branch. */\r\n  hline?: HiddenLine.Settings;\r\n  /** The iModel from which the graphics originate, if different than that associated with the view. */\r\n  iModel?: IModelConnection;\r\n  /** @internal */\r\n  frustum?: GraphicBranchFrustum;\r\n  /** Supplements the view's [[FeatureSymbology.Overrides]] for graphics in the branch. */\r\n  appearanceProvider?: FeatureAppearanceProvider;\r\n  /** @internal Secondary planar classifiers (map layers) */\r\n  secondaryClassifiers?: Map<number, RenderPlanarClassifier>;\r\n}\r\n\r\n/** Clip/Transform for a branch that are varied over time.\r\n * @internal\r\n */\r\nexport interface AnimationBranchState {\r\n  readonly clip?: RenderClipVolume;\r\n  readonly omit?: boolean;\r\n}\r\n\r\n/** Mapping from node/branch IDs to animation branch state\r\n * @internal\r\n */\r\nexport interface AnimationBranchStates {\r\n  /** Maps node Id to branch state. */\r\n  readonly branchStates: Map<string, AnimationBranchState>;\r\n  /** Ids of nodes that apply a transform. */\r\n  readonly transformNodeIds: ReadonlySet<number>;\r\n}\r\n"]}

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

@@ -3,7 +3,7 @@
  */
 import { Id64String } from "@itwin/core-bentley";
 import { AnyCurvePrimitive, Arc3d, Loop, Path, Point2d, Point3d, Polyface, Range3d, SolidPrimitive, Transform } from "@itwin/core-geometry";
-import { AnalysisStyle, ColorDef, Frustum, GraphicParams, LinePixels } from "@itwin/core-common";
+import { AnalysisStyle, ColorDef, Feature, Frustum, GeometryClass, GraphicParams, LinePixels } from "@itwin/core-common";
 import { IModelConnection } from "../IModelConnection";
 import { Viewport } from "../Viewport";
 import { RenderGraphic } from "./RenderGraphic";
@@ -15,6 +15,7 @@ import { GraphicPrimitive } from "./GraphicPrimitive";
  *  - 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 {
     /**
@@ -72,6 +73,7 @@ export declare enum GraphicType {
  * 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.
@@ -89,17 +91,26 @@ export interface BatchOptions {
 }
 /** 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 {
-    /** Unique identifier for the graphic.
+    /** 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;
 }
 /** 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]].
  * @public
+ * @extensions
  */
 export interface GraphicBuilderOptions {
     /** The type of graphic to produce. */
@@ -143,6 +154,7 @@ export interface GraphicBuilderOptions {
  * Default values for [[GraphicBuilderOptions.wantNormals]] and [[GraphicBuilderOptions.generateEdges]] will be determined by the viewport's [ViewFlags]($common).
  * The [[GraphicBuilder.iModel]] will be set to the viewport's [[IModelConnection]].
  * @public
+ * @extensions
  */
 export interface ViewportGraphicBuilderOptions extends GraphicBuilderOptions {
     /** The viewport in which the resultant [[RenderGraphic]] is to be drawn. */
@@ -157,6 +169,7 @@ export interface ViewportGraphicBuilderOptions extends GraphicBuilderOptions {
  * For [[GraphicType.ViewOverlay]] and [[GraphicType.ViewBackground]], which already define their geometry in pixels, the chord tolerance should typically be 1.
  * @see [[CustomGraphicBuilderOptions.computeChordTolerance]].
  * @public
+ * @extensions
  */
 export interface ComputeChordToleranceArgs {
     /** The graphic builder being used to produce the graphics. */
@@ -169,6 +182,7 @@ export interface ComputeChordToleranceArgs {
  * This is primarily useful when the same graphic is to be saved and reused for display in multiple viewports and for which a chord tolerance can be computed
  * independently of each viewport's [Frustum]($common).
  * @public
+ * @extensions
  */
 export interface CustomGraphicBuilderOptions extends GraphicBuilderOptions {
     /** Optionally, the IModelConnection with which the graphic is associated. */
@@ -191,6 +205,7 @@ export interface CustomGraphicBuilderOptions extends GraphicBuilderOptions {
  * So, for example, if you pass an array of points to addLineString(), you should not subsequently modify that array.
  *
  * @public
+ * @extensions
  */
 export declare abstract class GraphicBuilder {
     /** The local coordinate system transform applied to this builder's geometry.
@@ -226,6 +241,7 @@ export declare abstract class GraphicBuilder {
     protected constructor(options: ViewportGraphicBuilderOptions | CustomGraphicBuilderOptions);
     /** The Id to be associated with the graphic for picking.
      * @see [[GraphicBuilderOptions.pickable]] for more options.
+     * @deprecated 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.
@@ -252,6 +268,21 @@ export declare abstract class GraphicBuilder {
      * @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.

package/lib/esm/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,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EACL,iBAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,EACrG,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAO,MAAM,oBAAoB,CAAC;AACtG,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;;;;;;;GAOG;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;;;;;GAKG;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;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D;;OAEG;IACH,EAAE,EAAE,UAAU,CAAC;CAChB;AAED;;;;GAIG;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;;;;;GAKG;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;;;;;GAKG;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;;;;;GAKG;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;;;;;;;;;;;;;GAaG;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;;OAEG;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;;;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,+CAA+C;IACxC,WAAW,CAAC,KAAK,EAAE,OAAO;IAIjC,+CAA+C;IACxC,UAAU,CAAC,OAAO,EAAE,OAAO;IAIlC,yCAAyC;IAClC,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE;IAmB1C;;;;;;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,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EACL,iBAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,EACrG,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;CACtB;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,+CAA+C;IACxC,WAAW,CAAC,KAAK,EAAE,OAAO;IAIjC,+CAA+C;IACxC,UAAU,CAAC,OAAO,EAAE,OAAO;IAIlC,yCAAyC;IAClC,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE;IAmB1C;;;;;;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"}

package/lib/esm/render/GraphicBuilder.js

@@ -5,8 +5,9 @@
 /** @packageDocumentation
  * @module Rendering
  */
+import { assert } from "@itwin/core-bentley";
 import { Path, Transform, } from "@itwin/core-geometry";
-import { Frustum, GraphicParams, LinePixels, Npc } from "@itwin/core-common";
+import { Feature, Frustum, GraphicParams, LinePixels, Npc } from "@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.
@@ -14,6 +15,7 @@ import { Frustum, GraphicParams, LinePixels, Npc } from "@itwin/core-common";
  *  - 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 var GraphicType;
 (function (GraphicType) {
@@ -80,6 +82,7 @@ export var GraphicType;
  * So, for example, if you pass an array of points to addLineString(), you should not subsequently modify that array.
  *
  * @public
+ * @extensions
  */
 export class GraphicBuilder {
     /** @internal */
@@ -116,6 +119,7 @@ export class GraphicBuilder {
     }
     /** The Id to be associated with the graphic for picking.
      * @see [[GraphicBuilderOptions.pickable]] for more options.
+     * @deprecated This provides only the **first** pickable Id for this graphic - you should keep track of the **current** pickable Id yourself.
      */
     get pickId() {
         var _a;
@@ -145,6 +149,28 @@ export class GraphicBuilder {
     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) {
+        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 Feature(id, pick === null || pick === void 0 ? void 0 : pick.subCategoryId, pick === null || pick === void 0 ? void 0 : pick.geometryClass));
+    }
     /** Append a [CurvePrimitive]($core-geometry) to the builder. */
     addCurvePrimitive(curve) {
         switch (curve.curvePrimitiveType) {

package/lib/esm/render/GraphicBuilder.js.map

@@ -1 +1 @@
-{"version":3,"file":"GraphicBuilder.js","sourceRoot":"","sources":["../../../src/render/GraphicBuilder.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAC2B,IAAI,EAAuD,SAAS,GACrG,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAA2B,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAMtG;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,WAkDX;AAlDD,WAAY,WAAW;IACrB;;;;;;;OAOG;IACH,iEAAc,CAAA;IACd,qEAAqE;IACrE;;;;;;OAMG;IACH,+CAAK,CAAA;IACL,8GAA8G;IAC9G;;;;;;OAMG;IACH,mEAAe,CAAA;IACf;;;;;;;;;;OAUG;IACH,6DAAY,CAAA;IACZ;;;;;;;;OAQG;IACH,2DAAW,CAAA;AACb,CAAC,EAlDW,WAAW,KAAX,WAAW,QAkDtB;AAgID;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAgB,cAAc;IAuClC,gBAAgB;IAChB,YAAsB,OAAoE;;QACxF,sHAAsH;QACtH,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,SAAS,CAAC,cAAc,EAAE,CAAC;QACjE,IAAI,CAAC,MAAM,GAAG,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,MAAM,mCAAI,OAAO,CAAC,MAAM,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;QACrH,IAAI,CAAC,WAAW,GAAG,MAAA,OAAO,CAAC,WAAW,mCAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK,CAAC,CAAC;QAC9F,IAAI,CAAC,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAExF,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;YACrB,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC;YAC5D,OAAO;SACR;QAED,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC;QAE1E,IAAI,CAAC,sBAAsB,GAAG,CAAC,IAA+B,EAAE,EAAE;YAChE,IAAI,SAAS,GAAG,CAAC,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBAC3B,uGAAuG;gBACvG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,CAAC;gBAC7E,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;gBAErE,kIAAkI;gBAClI,MAAM,IAAI,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3F,IAAI,IAAI,GAAG,CAAC;oBACV,SAAS,IAAI,IAAI,CAAC;aACrB;YAED,OAAO,SAAS,GAAG,IAAI,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;;QACf,OAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,cAAc,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,WAAW,CAAC;IAC3F,CAAC;IAED;;OAEG;IACH,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;IA4ED,gEAAgE;IACzD,iBAAiB,CAAC,KAAwB;QAC/C,QAAQ,KAAK,CAAC,kBAAkB,EAAE;YAChC,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;SACT;IACH,CAAC;IAWD;;OAEG;IACI,YAAY,CAAC,SAA2B;QAC7C,QAAQ,SAAS,CAAC,IAAI,EAAE;YACtB,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;SACT;IACH,CAAC;IAED,+CAA+C;IACxC,WAAW,CAAC,KAAc;QAC/B,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,+CAA+C;IACxC,UAAU,CAAC,OAAgB;QAChC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,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;;;;;;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;CACvH","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 { Id64String } from \"@itwin/core-bentley\";\r\nimport {\r\n  AnyCurvePrimitive, Arc3d, Loop, Path, Point2d, Point3d, Polyface, Range3d, SolidPrimitive, Transform,\r\n} from \"@itwin/core-geometry\";\r\nimport { AnalysisStyle, ColorDef, Frustum, GraphicParams, LinePixels, Npc } from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { Viewport } from \"../Viewport\";\r\nimport { RenderGraphic } from \"./RenderGraphic\";\r\nimport { GraphicPrimitive } from \"./GraphicPrimitive\";\r\n\r\n/**\r\n * Describes the type of a [[GraphicBuilder]], which defines the coordinate system in which the builder's geometry is defined and\r\n * controls the behavior of the [[RenderGraphic]] produced by the builder.\r\n * @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.\r\n *  - Within a [[GraphicList]], each [[RenderGraphic]] is rendered in the order in which it appears in the list; and\r\n *  - Within a single [[RenderGraphic]], each geometric primitive is rendered in the ordered in which it was added to the GraphicBuilder.\r\n * @public\r\n */\r\nexport enum GraphicType {\r\n  /**\r\n   * Renders behind all other graphics. For example, the border of a [[SheetViewState]] is of this type.\r\n   * Coordinates: [[CoordSystem.View]].\r\n   * [[RenderMode]]: [[RenderMode.SmoothShade]].\r\n   * Lighting: none.\r\n   * Depth-testing: disabled.\r\n   * @see [[Decorations.viewBackground]]\r\n   */\r\n  ViewBackground,\r\n  /** Used for the scene itself, dynamics, and 'normal' decorations. */\r\n  /**\r\n   * 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.\r\n   * Coordinates: [[CoordSystem.World]].\r\n   * Lighting and [[RenderMode]]: from view.\r\n   * Depth-testing: enabled.\r\n   * @see [[Decorations.normal]].\r\n   */\r\n  Scene,\r\n  /** Renders within the scene. Coordinates: world. RenderMode: smooth. Lighting: default. Z-testing: enabled */\r\n  /** Renders within the scene, but ignores the view's [[ViewFlags]].\r\n   * Coordinates: [[CoordSystem.World]].\r\n   * Lighting: default.\r\n   * [[RenderMode]]: [[RenderMode.SmoothShade]].\r\n   * Depth-testing: enabled.\r\n   * @see [[Decorations.world]].\r\n   */\r\n  WorldDecoration,\r\n  /**\r\n   * Renders as an overlay on top of the scene. These decorations differ from [[GraphicType.WorldDecoration]] only in that depth-testing is disabled.\r\n   * For example, the ACS triad and [[WindowAreaTool]] decorations are of this type.\r\n   * Coordinates: [[CoordSystem.World]].\r\n   * [[RenderMode]]: [[RenderMode.SmoothShade]]\r\n   * Lighting: default.\r\n   * Depth-testing: disabled.\r\n   * Renders atop the scene. Coordinates: world. RenderMode: smooth. Lighting: none. Z-testing: disabled\r\n   * @note Overlay decorations typically employ some degree of transparency to ensure that they do not fully obscure the scene.\r\n   * @see [[Decorations.worldOverlay]]\r\n   */\r\n  WorldOverlay,\r\n  /**\r\n   * 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.\r\n   * Coordinates: [[CoordSystem.View]].\r\n   * [[RenderMode]]: [[RenderMode.SmoothShade]]\r\n   * Lighting: default.\r\n   * Depth-testing: disabled.\r\n   * @note For more flexibility in defining view overlay decorations, consider using a [[CanvasDecorationList]].\r\n   * @see [[Decorations.viewOverlay]]\r\n   */\r\n  ViewOverlay,\r\n}\r\n\r\n/** Options used when constructing a `Batch` - that is, a [[RenderGraphic]] with an associated [FeatureTable]($common) describing individual [Feature]($common)s within the\r\n * graphic. Individual features can be resymbolized in a variety of ways including flashing and hiliting.\r\n * For example, to prevent graphics produced by [[readElementGraphics]] from being hilited when their corresponding element is in the [[SelectionSet]],\r\n * pass `{ noHilite: true }` to [[readElementGraphics]].\r\n * @public\r\n */\r\nexport interface BatchOptions {\r\n  /** Identifies the [[Tile]] associated with the batch, chiefly for debugging purposes.\r\n   * @beta\r\n   */\r\n  tileId?: string;\r\n  /** If true, features within the batch will not be flashed on mouseover. */\r\n  noFlash?: boolean;\r\n  /** If true, features within the batch will not be hilited when their corresponding element is in the [[SelectionSet]]. */\r\n  noHilite?: boolean;\r\n  /** If true, features within the batch will not be emphasized when the corresponding [[Feature]] is emphasized using [FeatureOverrides]($common). */\r\n  noEmphasis?: boolean;\r\n  /** If true, the contents of the batch will only be drawn by [[Viewport.readPixels]], not [[Viewport.renderFrame]], causing them to be locatable but invisible. */\r\n  locateOnly?: boolean;\r\n}\r\n\r\n/** Options used as part of [[GraphicBuilderOptions]] to describe a [pickable]($docs/learning/frontend/ViewDecorations#pickable-view-graphic-decorations) [[RenderGraphic]].\r\n * @public\r\n */\r\nexport interface PickableGraphicOptions extends BatchOptions {\r\n  /** Unique identifier for the graphic.\r\n   * @see [[IModelConnection.transientIds]] to obtain a unique Id in the context of an iModel.\r\n   */\r\n  id: Id64String;\r\n}\r\n\r\n/** Options for creating a [[GraphicBuilder]] used by functions like [[DecorateContext.createGraphic]] and [[RenderSystem.createGraphic]].\r\n * @see [[ViewportGraphicBuilderOptions]] to create a graphic builder for a [[Viewport]].\r\n * @see [[CustomGraphicBuilderOptions]] to create a graphic builder unassociated with any [[Viewport]].\r\n * @public\r\n */\r\nexport interface GraphicBuilderOptions {\r\n  /** The type of graphic to produce. */\r\n  type: GraphicType;\r\n\r\n  /** The local-to-world transform in which the builder's geometry is to be defined - by default, an identity transform. */\r\n  placement?: Transform;\r\n\r\n  /** If the graphic is to be pickable, specifies the pickable Id and other options. */\r\n  pickable?: PickableGraphicOptions;\r\n\r\n  /** If true, the order in which geometry is added to the builder is preserved.\r\n   * This is useful for overlay and background graphics because they draw without using the depth buffer. For example, to draw an overlay containing a red shape with a white outline,\r\n   * you would add the shape to the GraphicBuilder first, followed by the outline, to ensure the outline draws \"in front of\" the shape.\r\n   * It defaults to true for overlays and background graphics, and false for other graphic types.\r\n   * It is not useful for other types of graphics and imposes a performance penalty due to increased number of draw calls.\r\n   * For overlay and background graphics that do not need to draw in any particular order, the performance penalty can be eliminated by setting this to `false`.\r\n   */\r\n  preserveOrder?: boolean;\r\n\r\n  /** Controls whether normals are generated for surfaces. Normals allow 3d geometry to receive lighting; without them the geometry will be unaffected by lighting.\r\n   * By default, normals are generated only for graphics of type [[GraphicType.Scene]]; or for any type of graphic if [[GraphicBuilder.wantEdges]] is true, because\r\n   * normals are required to prevent z-fighting between surfaces and their edges. This default can be overridden by explicitly specifying `true` or `false`.\r\n   * @see [[GraphicType]] for a description of whether and how different types of graphics are affected by lighting.\r\n   */\r\n  wantNormals?: boolean;\r\n\r\n  /** Controls whether edges are generated for surfaces.\r\n   * Edges are only displayed if [ViewFlags.renderMode]($common) is not [RenderMode.SmoothShade]($common) or [ViewFlags.visibleEdges]($common) is `true`.\r\n   * Since all decoration graphics except [[GraphicType.Scene]] are drawn in smooth shaded mode with no visible edges, by default edges are only produced for scene graphics, and\r\n   * - if a [[Viewport]] is supplied with the options - only if [ViewFlags.edgesRequired]($common) is true for the viewport.\r\n   * That default can be overridden by explicitly specifying `true` or `false`. This can be useful for non-scene decorations contained in a [[GraphicBranch]] that applies [ViewFlagOverrides]($common)\r\n   * that change the edge display settings; or for scene decorations that might be cached for reuse after the viewport's edge settings are changed.\r\n   * @note Edges will tend to z-fight with their surfaces unless the graphic is [[pickable]].\r\n   */\r\n  generateEdges?: boolean;\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}\r\n\r\n/** Options for creating a [[GraphicBuilder]] to produce a [[RenderGraphic]] to be displayed in a specific [[Viewport]].\r\n * The level of detail of the graphic will be computed from the position of its geometry within the viewport's [Frustum]($common).\r\n * Default values for [[GraphicBuilderOptions.wantNormals]] and [[GraphicBuilderOptions.generateEdges]] will be determined by the viewport's [ViewFlags]($common).\r\n * The [[GraphicBuilder.iModel]] will be set to the viewport's [[IModelConnection]].\r\n * @public\r\n */\r\nexport interface ViewportGraphicBuilderOptions extends GraphicBuilderOptions {\r\n  /** The viewport in which the resultant [[RenderGraphic]] is to be drawn. */\r\n  viewport: Viewport;\r\n\r\n  /** If true, [[ViewState.getAspectRatioSkew]] will be taken into account when computing the level of detail for the produced graphics. */\r\n  applyAspectRatioSkew?: boolean;\r\n\r\n  iModel?: never;\r\n  computeChordTolerance?: never;\r\n}\r\n\r\n/** Arguments used to compute the chord tolerance (level of detail) of the [[RenderGraphic]]s produced by a [[GraphicBuilder]].\r\n * Generally, the chord tolerance should be roughly equivalent to the size in meters of one pixel on screen where the graphic is to be displayed.\r\n * For [[GraphicType.ViewOverlay]] and [[GraphicType.ViewBackground]], which already define their geometry in pixels, the chord tolerance should typically be 1.\r\n * @see [[CustomGraphicBuilderOptions.computeChordTolerance]].\r\n * @public\r\n */\r\nexport interface ComputeChordToleranceArgs {\r\n  /** The graphic builder being used to produce the graphics. */\r\n  readonly graphic: GraphicBuilder;\r\n  /** A function that computes a range enclosing all of the geometry that was added to the builder. */\r\n  readonly computeRange: () => Range3d;\r\n}\r\n\r\n/** Options for creating a [[GraphicBuilder]] to produce a [[RenderGraphic]] that is not associated with any particular [[Viewport]] and may not be associated with\r\n * any particular [[IModelConnection]].\r\n * This is primarily useful when the same graphic is to be saved and reused for display in multiple viewports and for which a chord tolerance can be computed\r\n * independently of each viewport's [Frustum]($common).\r\n * @public\r\n */\r\nexport interface CustomGraphicBuilderOptions extends GraphicBuilderOptions {\r\n  /** Optionally, the IModelConnection with which the graphic is associated. */\r\n  iModel?: IModelConnection;\r\n  /** A function that can compute the level of detail for the graphics produced by the builder. */\r\n  computeChordTolerance: (args: ComputeChordToleranceArgs) => number;\r\n\r\n  applyAspectRatioSkew?: never;\r\n  viewport?: never;\r\n}\r\n\r\n/** Provides methods for constructing a [[RenderGraphic]] from geometric primitives.\r\n * GraphicBuilder is primarily used for creating [[Decorations]] to be displayed inside a [[Viewport]].\r\n *\r\n * The typical process for constructing a [[RenderGraphic]] proceeds as follows:\r\n *  1. Use [[DecorateContext.createGraphic]] or [[RenderSystem.createGraphic]] to obtain a builder.\r\n *  2. Set up the symbology using [[GraphicBuilder.activateGraphicParams]] or [[GraphicBuilder.setSymbology]].\r\n *  3. Add one or more geometric primitives using methods like [[GraphicBuilder.addShape]] and [[GraphicBuilder.addLineString]], possibly setting new symbology in between.\r\n *  4. Use [[GraphicBuilder.finish]] to produce the finished [[RenderGraphic]].\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 *\r\n * @public\r\n */\r\nexport abstract class GraphicBuilder {\r\n  /** The local coordinate system transform applied to this builder's geometry.\r\n   * @see [[GraphicBuilderOptions.placement]].\r\n   */\r\n  public readonly placement: Transform;\r\n\r\n  /** The iModel associated with this builder, if any. */\r\n  public readonly iModel?: IModelConnection;\r\n\r\n  /** The type of graphic to be produced by this builder.\r\n   * @see [[GraphicBuilderOptions.type]].\r\n   */\r\n  public readonly type: GraphicType;\r\n\r\n  /** If the graphic is to be pickable, specifies the pickable Id and other options. */\r\n  public readonly pickable?: Readonly<PickableGraphicOptions>;\r\n\r\n  /** If true, the order in which geometry is added to the builder is preserved.\r\n   * @see [[GraphicBuilderOptions.preserveOrder]] for more details.\r\n   */\r\n  public readonly preserveOrder: boolean;\r\n\r\n  /** Controls whether normals are generated for surfaces.\r\n   * @note Normals are required for proper edge display, so by default they are always produced if [[wantEdges]] is `true`.\r\n   * @see [[GraphicBuilderOptions.wantNormals]] for more details.\r\n   */\r\n  public readonly wantNormals: boolean;\r\n\r\n  /** Controls whether edges are generated for surfaces.\r\n   * @see [[GraphicBuilderOptions.generateEdges]] for more details.\r\n   */\r\n  public readonly wantEdges: boolean;\r\n\r\n  /** @alpha */\r\n  public readonly analysisStyle?: AnalysisStyle;\r\n\r\n  protected readonly _computeChordTolerance: (args: ComputeChordToleranceArgs) => number;\r\n  protected readonly _options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions;\r\n\r\n  /** @internal */\r\n  protected constructor(options: ViewportGraphicBuilderOptions | CustomGraphicBuilderOptions) {\r\n    // Stored for potential use later in creating a new GraphicBuilder from this one (see PrimitiveBuilder.finishGraphic).\r\n    this._options = options;\r\n\r\n    const vp = options.viewport;\r\n    this.placement = options.placement ?? Transform.createIdentity();\r\n    this.iModel = vp?.iModel ?? options.iModel;\r\n    this.type = options.type;\r\n    this.pickable = options.pickable;\r\n    this.wantEdges = options.generateEdges ?? (this.type === GraphicType.Scene && (!vp || vp.viewFlags.edgesRequired()));\r\n    this.wantNormals = options.wantNormals ?? (this.wantEdges || this.type === GraphicType.Scene);\r\n    this.preserveOrder = options.preserveOrder ?? (this.isOverlay || this.isViewBackground);\r\n\r\n    if (!options.viewport) {\r\n      this._computeChordTolerance = options.computeChordTolerance;\r\n      return;\r\n    }\r\n\r\n    this.analysisStyle = options.viewport.displayStyle.settings.analysisStyle;\r\n\r\n    this._computeChordTolerance = (args: ComputeChordToleranceArgs) => {\r\n      let pixelSize = 1;\r\n      if (!this.isViewCoordinates) {\r\n        // Compute the horizontal distance in meters between two adjacent pixels at the center of the geometry.\r\n        pixelSize = options.viewport.getPixelSizeAtPoint(args.computeRange().center);\r\n        pixelSize = options.viewport.target.adjustPixelSizeForLOD(pixelSize);\r\n\r\n        // Aspect ratio skew > 1.0 stretches the view in Y. In that case use the smaller vertical pixel distance for our stroke tolerance.\r\n        const skew = options.applyAspectRatioSkew ? options.viewport.view.getAspectRatioSkew() : 0;\r\n        if (skew > 1)\r\n          pixelSize /= skew;\r\n      }\r\n\r\n      return pixelSize * 0.25;\r\n    };\r\n  }\r\n\r\n  /** The Id to be associated with the graphic for picking.\r\n   * @see [[GraphicBuilderOptions.pickable]] for more options.\r\n   */\r\n  public get pickId(): Id64String | undefined {\r\n    return this.pickable?.id;\r\n  }\r\n\r\n  /** Whether the builder's geometry is defined in [[CoordSystem.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.\r\n   * @see [[isViewCoordinates]].\r\n   */\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  /**\r\n   * Processes the accumulated symbology and geometry to produce a renderable graphic.\r\n   * This function can only be called once; after the [[RenderGraphic]] has been extracted the [[GraphicBuilder]] should no longer be used.\r\n   */\r\n  public abstract finish(): RenderGraphic;\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 [[GraphicBuilder.setSymbology]] for a convenient way to set common symbology options.\r\n   */\r\n  public abstract activateGraphicParams(graphicParams: GraphicParams): void;\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 abstract addLineString(points: Point3d[]): void;\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 abstract addLineString2d(points: Point2d[], zDepth: number): void;\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 abstract addPointString(points: Point3d[]): void;\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 abstract addPointString2d(points: Point2d[], zDepth: number): void;\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 abstract addShape(points: Point3d[]): void;\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 abstract addShape2d(points: Point2d[], zDepth: number): void;\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 abstract addArc(arc: Arc3d, isEllipse: boolean, filled: boolean): void;\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 abstract addArc2d(ellipse: Arc3d, isEllipse: boolean, filled: boolean, zDepth: number): void;\r\n\r\n  /** Append a 3d open path to the builder. */\r\n  public abstract addPath(path: Path): void;\r\n\r\n  /** Append a 3d planar region to the builder. */\r\n  public abstract addLoop(loop: Loop): void;\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 abstract addPolyface(meshData: Polyface, filled: boolean): void;\r\n\r\n  /** Append a solid primitive to the builder. */\r\n  public abstract addSolidPrimitive(solidPrimitive: SolidPrimitive): void;\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 Range3d edges. Useful for debugging. */\r\n  public addRangeBox(range: Range3d) {\r\n    this.addFrustum(Frustum.fromRange(range));\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 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  /** 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 [[GraphicBuilder.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"]}
+{"version":3,"file":"GraphicBuilder.js","sourceRoot":"","sources":["../../../src/render/GraphicBuilder.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAC2B,IAAI,EAAuD,SAAS,GACrG,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAA2B,OAAO,EAAE,OAAO,EAAiB,aAAa,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAM9H;;;;;;;;GAQG;AACH,MAAM,CAAN,IAAY,WAkDX;AAlDD,WAAY,WAAW;IACrB;;;;;;;OAOG;IACH,iEAAc,CAAA;IACd,qEAAqE;IACrE;;;;;;OAMG;IACH,+CAAK,CAAA;IACL,8GAA8G;IAC9G;;;;;;OAMG;IACH,mEAAe,CAAA;IACf;;;;;;;;;;OAUG;IACH,6DAAY,CAAA;IACZ;;;;;;;;OAQG;IACH,2DAAW,CAAA;AACb,CAAC,EAlDW,WAAW,KAAX,WAAW,QAkDtB;AA6ID;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,cAAc;IAuClC,gBAAgB;IAChB,YAAsB,OAAoE;;QACxF,sHAAsH;QACtH,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,SAAS,CAAC,cAAc,EAAE,CAAC;QACjE,IAAI,CAAC,MAAM,GAAG,MAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,MAAM,mCAAI,OAAO,CAAC,MAAM,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;QACrH,IAAI,CAAC,WAAW,GAAG,MAAA,OAAO,CAAC,WAAW,mCAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK,CAAC,CAAC;QAC9F,IAAI,CAAC,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAExF,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;YACrB,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC;YAC5D,OAAO;SACR;QAED,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC;QAE1E,IAAI,CAAC,sBAAsB,GAAG,CAAC,IAA+B,EAAE,EAAE;YAChE,IAAI,SAAS,GAAG,CAAC,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBAC3B,uGAAuG;gBACvG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,CAAC;gBAC7E,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;gBAErE,kIAAkI;gBAClI,MAAM,IAAI,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3F,IAAI,IAAI,GAAG,CAAC;oBACV,SAAS,IAAI,IAAI,CAAC;aACrB;YAED,OAAO,SAAS,GAAG,IAAI,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;;QACf,OAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,cAAc,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,WAAW,CAAC;IAC3F,CAAC;IAED;;OAEG;IACH,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;IAcD;;OAEG;IACO,gBAAgB,CAAC,QAAiB,IAAU,CAAC;IAEvD;;;OAGG;IACI,eAAe,CAAC,OAAgB;QACrC,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,0FAA0F,CAAC,CAAC;QACzI,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ;YACxB,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,EAAc;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACpC,IAAI,CAAC,eAAe,CAAC,IAAI,OAAO,CAAC,EAAE,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,CAAC,CAAC,CAAC;IAClF,CAAC;IAgED,gEAAgE;IACzD,iBAAiB,CAAC,KAAwB;QAC/C,QAAQ,KAAK,CAAC,kBAAkB,EAAE;YAChC,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;SACT;IACH,CAAC;IAWD;;OAEG;IACI,YAAY,CAAC,SAA2B;QAC7C,QAAQ,SAAS,CAAC,IAAI,EAAE;YACtB,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;SACT;IACH,CAAC;IAED,+CAA+C;IACxC,WAAW,CAAC,KAAc;QAC/B,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,+CAA+C;IACxC,UAAU,CAAC,OAAgB;QAChC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,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;;;;;;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;CACvH","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, Loop, Path, Point2d, Point3d, Polyface, Range3d, SolidPrimitive, Transform,\r\n} from \"@itwin/core-geometry\";\r\nimport { AnalysisStyle, ColorDef, Feature, Frustum, GeometryClass, GraphicParams, LinePixels, Npc } from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { Viewport } from \"../Viewport\";\r\nimport { RenderGraphic } from \"./RenderGraphic\";\r\nimport { GraphicPrimitive } from \"./GraphicPrimitive\";\r\n\r\n/**\r\n * Describes the type of a [[GraphicBuilder]], which defines the coordinate system in which the builder's geometry is defined and\r\n * controls the behavior of the [[RenderGraphic]] produced by the builder.\r\n * @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.\r\n *  - Within a [[GraphicList]], each [[RenderGraphic]] is rendered in the order in which it appears in the list; and\r\n *  - Within a single [[RenderGraphic]], each geometric primitive is rendered in the ordered in which it was added to the GraphicBuilder.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum GraphicType {\r\n  /**\r\n   * Renders behind all other graphics. For example, the border of a [[SheetViewState]] is of this type.\r\n   * Coordinates: [[CoordSystem.View]].\r\n   * [[RenderMode]]: [[RenderMode.SmoothShade]].\r\n   * Lighting: none.\r\n   * Depth-testing: disabled.\r\n   * @see [[Decorations.viewBackground]]\r\n   */\r\n  ViewBackground,\r\n  /** Used for the scene itself, dynamics, and 'normal' decorations. */\r\n  /**\r\n   * 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.\r\n   * Coordinates: [[CoordSystem.World]].\r\n   * Lighting and [[RenderMode]]: from view.\r\n   * Depth-testing: enabled.\r\n   * @see [[Decorations.normal]].\r\n   */\r\n  Scene,\r\n  /** Renders within the scene. Coordinates: world. RenderMode: smooth. Lighting: default. Z-testing: enabled */\r\n  /** Renders within the scene, but ignores the view's [[ViewFlags]].\r\n   * Coordinates: [[CoordSystem.World]].\r\n   * Lighting: default.\r\n   * [[RenderMode]]: [[RenderMode.SmoothShade]].\r\n   * Depth-testing: enabled.\r\n   * @see [[Decorations.world]].\r\n   */\r\n  WorldDecoration,\r\n  /**\r\n   * Renders as an overlay on top of the scene. These decorations differ from [[GraphicType.WorldDecoration]] only in that depth-testing is disabled.\r\n   * For example, the ACS triad and [[WindowAreaTool]] decorations are of this type.\r\n   * Coordinates: [[CoordSystem.World]].\r\n   * [[RenderMode]]: [[RenderMode.SmoothShade]]\r\n   * Lighting: default.\r\n   * Depth-testing: disabled.\r\n   * Renders atop the scene. Coordinates: world. RenderMode: smooth. Lighting: none. Z-testing: disabled\r\n   * @note Overlay decorations typically employ some degree of transparency to ensure that they do not fully obscure the scene.\r\n   * @see [[Decorations.worldOverlay]]\r\n   */\r\n  WorldOverlay,\r\n  /**\r\n   * 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.\r\n   * Coordinates: [[CoordSystem.View]].\r\n   * [[RenderMode]]: [[RenderMode.SmoothShade]]\r\n   * Lighting: default.\r\n   * Depth-testing: disabled.\r\n   * @note For more flexibility in defining view overlay decorations, consider using a [[CanvasDecorationList]].\r\n   * @see [[Decorations.viewOverlay]]\r\n   */\r\n  ViewOverlay,\r\n}\r\n\r\n/** Options used when constructing a `Batch` - that is, a [[RenderGraphic]] with an associated [FeatureTable]($common) describing individual [Feature]($common)s within the\r\n * graphic. Individual features can be resymbolized in a variety of ways including flashing and hiliting.\r\n * For example, to prevent graphics produced by [[readElementGraphics]] from being hilited when their corresponding element is in the [[SelectionSet]],\r\n * pass `{ noHilite: true }` to [[readElementGraphics]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface BatchOptions {\r\n  /** Identifies the [[Tile]] associated with the batch, chiefly for debugging purposes.\r\n   * @beta\r\n   */\r\n  tileId?: string;\r\n  /** If true, features within the batch will not be flashed on mouseover. */\r\n  noFlash?: boolean;\r\n  /** If true, features within the batch will not be hilited when their corresponding element is in the [[SelectionSet]]. */\r\n  noHilite?: boolean;\r\n  /** If true, features within the batch will not be emphasized when the corresponding [[Feature]] is emphasized using [FeatureOverrides]($common). */\r\n  noEmphasis?: boolean;\r\n  /** If true, the contents of the batch will only be drawn by [[Viewport.readPixels]], not [[Viewport.renderFrame]], causing them to be locatable but invisible. */\r\n  locateOnly?: boolean;\r\n}\r\n\r\n/** Options used as part of [[GraphicBuilderOptions]] to describe a [pickable]($docs/learning/frontend/ViewDecorations#pickable-view-graphic-decorations) [[RenderGraphic]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface PickableGraphicOptions extends BatchOptions {\r\n  /** A unique identifier for the graphic.\r\n   * @see [[IModelConnection.transientIds]] to obtain a unique Id in the context of an iModel.\r\n   * @see [[GraphicBuilder.activatePickableId]] or [[GraphicBuilder.activateFeature]] to change the pickable object while adding geometry.\r\n   */\r\n  id: Id64String;\r\n  /** Optional Id of the subcategory with which the graphic should be associated. */\r\n  subCategoryId?: Id64String;\r\n  /** Optional geometry class for the graphic - defaults to [GeometryClass.Primary]($common). */\r\n  geometryClass?: GeometryClass;\r\n  /** The optional Id of the model with which the graphic should be associated. */\r\n  modelId?: Id64String;\r\n}\r\n\r\n/** Options for creating a [[GraphicBuilder]] used by functions like [[DecorateContext.createGraphic]] and [[RenderSystem.createGraphic]].\r\n * @see [[ViewportGraphicBuilderOptions]] to create a graphic builder for a [[Viewport]].\r\n * @see [[CustomGraphicBuilderOptions]] to create a graphic builder unassociated with any [[Viewport]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GraphicBuilderOptions {\r\n  /** The type of graphic to produce. */\r\n  type: GraphicType;\r\n\r\n  /** The local-to-world transform in which the builder's geometry is to be defined - by default, an identity transform. */\r\n  placement?: Transform;\r\n\r\n  /** If the graphic is to be pickable, specifies the pickable Id and other options. */\r\n  pickable?: PickableGraphicOptions;\r\n\r\n  /** If true, the order in which geometry is added to the builder is preserved.\r\n   * This is useful for overlay and background graphics because they draw without using the depth buffer. For example, to draw an overlay containing a red shape with a white outline,\r\n   * you would add the shape to the GraphicBuilder first, followed by the outline, to ensure the outline draws \"in front of\" the shape.\r\n   * It defaults to true for overlays and background graphics, and false for other graphic types.\r\n   * It is not useful for other types of graphics and imposes a performance penalty due to increased number of draw calls.\r\n   * For overlay and background graphics that do not need to draw in any particular order, the performance penalty can be eliminated by setting this to `false`.\r\n   */\r\n  preserveOrder?: boolean;\r\n\r\n  /** Controls whether normals are generated for surfaces. Normals allow 3d geometry to receive lighting; without them the geometry will be unaffected by lighting.\r\n   * By default, normals are generated only for graphics of type [[GraphicType.Scene]]; or for any type of graphic if [[GraphicBuilder.wantEdges]] is true, because\r\n   * normals are required to prevent z-fighting between surfaces and their edges. This default can be overridden by explicitly specifying `true` or `false`.\r\n   * @see [[GraphicType]] for a description of whether and how different types of graphics are affected by lighting.\r\n   */\r\n  wantNormals?: boolean;\r\n\r\n  /** Controls whether edges are generated for surfaces.\r\n   * Edges are only displayed if [ViewFlags.renderMode]($common) is not [RenderMode.SmoothShade]($common) or [ViewFlags.visibleEdges]($common) is `true`.\r\n   * Since all decoration graphics except [[GraphicType.Scene]] are drawn in smooth shaded mode with no visible edges, by default edges are only produced for scene graphics, and\r\n   * - if a [[Viewport]] is supplied with the options - only if [ViewFlags.edgesRequired]($common) is true for the viewport.\r\n   * That default can be overridden by explicitly specifying `true` or `false`. This can be useful for non-scene decorations contained in a [[GraphicBranch]] that applies [ViewFlagOverrides]($common)\r\n   * that change the edge display settings; or for scene decorations that might be cached for reuse after the viewport's edge settings are changed.\r\n   * @note Edges will tend to z-fight with their surfaces unless the graphic is [[pickable]].\r\n   */\r\n  generateEdges?: boolean;\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}\r\n\r\n/** Options for creating a [[GraphicBuilder]] to produce a [[RenderGraphic]] to be displayed in a specific [[Viewport]].\r\n * The level of detail of the graphic will be computed from the position of its geometry within the viewport's [Frustum]($common).\r\n * Default values for [[GraphicBuilderOptions.wantNormals]] and [[GraphicBuilderOptions.generateEdges]] will be determined by the viewport's [ViewFlags]($common).\r\n * The [[GraphicBuilder.iModel]] will be set to the viewport's [[IModelConnection]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewportGraphicBuilderOptions extends GraphicBuilderOptions {\r\n  /** The viewport in which the resultant [[RenderGraphic]] is to be drawn. */\r\n  viewport: Viewport;\r\n\r\n  /** If true, [[ViewState.getAspectRatioSkew]] will be taken into account when computing the level of detail for the produced graphics. */\r\n  applyAspectRatioSkew?: boolean;\r\n\r\n  iModel?: never;\r\n  computeChordTolerance?: never;\r\n}\r\n\r\n/** Arguments used to compute the chord tolerance (level of detail) of the [[RenderGraphic]]s produced by a [[GraphicBuilder]].\r\n * Generally, the chord tolerance should be roughly equivalent to the size in meters of one pixel on screen where the graphic is to be displayed.\r\n * For [[GraphicType.ViewOverlay]] and [[GraphicType.ViewBackground]], which already define their geometry in pixels, the chord tolerance should typically be 1.\r\n * @see [[CustomGraphicBuilderOptions.computeChordTolerance]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ComputeChordToleranceArgs {\r\n  /** The graphic builder being used to produce the graphics. */\r\n  readonly graphic: GraphicBuilder;\r\n  /** A function that computes a range enclosing all of the geometry that was added to the builder. */\r\n  readonly computeRange: () => Range3d;\r\n}\r\n\r\n/** Options for creating a [[GraphicBuilder]] to produce a [[RenderGraphic]] that is not associated with any particular [[Viewport]] and may not be associated with\r\n * any particular [[IModelConnection]].\r\n * This is primarily useful when the same graphic is to be saved and reused for display in multiple viewports and for which a chord tolerance can be computed\r\n * independently of each viewport's [Frustum]($common).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface CustomGraphicBuilderOptions extends GraphicBuilderOptions {\r\n  /** Optionally, the IModelConnection with which the graphic is associated. */\r\n  iModel?: IModelConnection;\r\n  /** A function that can compute the level of detail for the graphics produced by the builder. */\r\n  computeChordTolerance: (args: ComputeChordToleranceArgs) => number;\r\n\r\n  applyAspectRatioSkew?: never;\r\n  viewport?: never;\r\n}\r\n\r\n/** Provides methods for constructing a [[RenderGraphic]] from geometric primitives.\r\n * GraphicBuilder is primarily used for creating [[Decorations]] to be displayed inside a [[Viewport]].\r\n *\r\n * The typical process for constructing a [[RenderGraphic]] proceeds as follows:\r\n *  1. Use [[DecorateContext.createGraphic]] or [[RenderSystem.createGraphic]] to obtain a builder.\r\n *  2. Set up the symbology using [[GraphicBuilder.activateGraphicParams]] or [[GraphicBuilder.setSymbology]].\r\n *  3. Add one or more geometric primitives using methods like [[GraphicBuilder.addShape]] and [[GraphicBuilder.addLineString]], possibly setting new symbology in between.\r\n *  4. Use [[GraphicBuilder.finish]] to produce the finished [[RenderGraphic]].\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 *\r\n * @public\r\n * @extensions\r\n */\r\nexport abstract class GraphicBuilder {\r\n  /** The local coordinate system transform applied to this builder's geometry.\r\n   * @see [[GraphicBuilderOptions.placement]].\r\n   */\r\n  public readonly placement: Transform;\r\n\r\n  /** The iModel associated with this builder, if any. */\r\n  public readonly iModel?: IModelConnection;\r\n\r\n  /** The type of graphic to be produced by this builder.\r\n   * @see [[GraphicBuilderOptions.type]].\r\n   */\r\n  public readonly type: GraphicType;\r\n\r\n  /** If the graphic is to be pickable, specifies the pickable Id and other options. */\r\n  public readonly pickable?: Readonly<PickableGraphicOptions>;\r\n\r\n  /** If true, the order in which geometry is added to the builder is preserved.\r\n   * @see [[GraphicBuilderOptions.preserveOrder]] for more details.\r\n   */\r\n  public readonly preserveOrder: boolean;\r\n\r\n  /** Controls whether normals are generated for surfaces.\r\n   * @note Normals are required for proper edge display, so by default they are always produced if [[wantEdges]] is `true`.\r\n   * @see [[GraphicBuilderOptions.wantNormals]] for more details.\r\n   */\r\n  public readonly wantNormals: boolean;\r\n\r\n  /** Controls whether edges are generated for surfaces.\r\n   * @see [[GraphicBuilderOptions.generateEdges]] for more details.\r\n   */\r\n  public readonly wantEdges: boolean;\r\n\r\n  /** @alpha */\r\n  public readonly analysisStyle?: AnalysisStyle;\r\n\r\n  protected readonly _computeChordTolerance: (args: ComputeChordToleranceArgs) => number;\r\n  protected readonly _options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions;\r\n\r\n  /** @internal */\r\n  protected constructor(options: ViewportGraphicBuilderOptions | CustomGraphicBuilderOptions) {\r\n    // Stored for potential use later in creating a new GraphicBuilder from this one (see PrimitiveBuilder.finishGraphic).\r\n    this._options = options;\r\n\r\n    const vp = options.viewport;\r\n    this.placement = options.placement ?? Transform.createIdentity();\r\n    this.iModel = vp?.iModel ?? options.iModel;\r\n    this.type = options.type;\r\n    this.pickable = options.pickable;\r\n    this.wantEdges = options.generateEdges ?? (this.type === GraphicType.Scene && (!vp || vp.viewFlags.edgesRequired()));\r\n    this.wantNormals = options.wantNormals ?? (this.wantEdges || this.type === GraphicType.Scene);\r\n    this.preserveOrder = options.preserveOrder ?? (this.isOverlay || this.isViewBackground);\r\n\r\n    if (!options.viewport) {\r\n      this._computeChordTolerance = options.computeChordTolerance;\r\n      return;\r\n    }\r\n\r\n    this.analysisStyle = options.viewport.displayStyle.settings.analysisStyle;\r\n\r\n    this._computeChordTolerance = (args: ComputeChordToleranceArgs) => {\r\n      let pixelSize = 1;\r\n      if (!this.isViewCoordinates) {\r\n        // Compute the horizontal distance in meters between two adjacent pixels at the center of the geometry.\r\n        pixelSize = options.viewport.getPixelSizeAtPoint(args.computeRange().center);\r\n        pixelSize = options.viewport.target.adjustPixelSizeForLOD(pixelSize);\r\n\r\n        // Aspect ratio skew > 1.0 stretches the view in Y. In that case use the smaller vertical pixel distance for our stroke tolerance.\r\n        const skew = options.applyAspectRatioSkew ? options.viewport.view.getAspectRatioSkew() : 0;\r\n        if (skew > 1)\r\n          pixelSize /= skew;\r\n      }\r\n\r\n      return pixelSize * 0.25;\r\n    };\r\n  }\r\n\r\n  /** The Id to be associated with the graphic for picking.\r\n   * @see [[GraphicBuilderOptions.pickable]] for more options.\r\n   * @deprecated This provides only the **first** pickable Id for this graphic - you should keep track of the **current** pickable Id yourself.\r\n   */\r\n  public get pickId(): Id64String | undefined {\r\n    return this.pickable?.id;\r\n  }\r\n\r\n  /** Whether the builder's geometry is defined in [[CoordSystem.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.\r\n   * @see [[isViewCoordinates]].\r\n   */\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  /**\r\n   * Processes the accumulated symbology and geometry to produce a renderable graphic.\r\n   * This function can only be called once; after the [[RenderGraphic]] has been extracted the [[GraphicBuilder]] should no longer be used.\r\n   */\r\n  public abstract finish(): RenderGraphic;\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 [[GraphicBuilder.setSymbology]] for a convenient way to set common symbology options.\r\n   */\r\n  public abstract activateGraphicParams(graphicParams: GraphicParams): void;\r\n\r\n  /** Called by [[activateFeature]] after validation to change the [Feature]($common) to be associated with subsequently-added geometry.\r\n   * This default implementation does nothing.\r\n   */\r\n  protected _activateFeature(_feature: Feature): void { }\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 [[GraphicBuilderOptions.pickable]] was not supplied to the GraphicBuilder's constructor.\r\n   */\r\n  public activateFeature(feature: Feature): void {\r\n    assert(undefined !== this._options.pickable, \"GraphicBuilder.activateFeature has no effect if PickableGraphicOptions were not supplied\");\r\n    if (this._options.pickable)\r\n      this._activateFeature(feature);\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 [[GraphicBuilder.pickable]]\r\n   * at construction, if any.\r\n   * @note This method has no effect if [[GraphicBuilderOptions.pickable]] was not supplied to the GraphicBuilder's constructor.\r\n   */\r\n  public activatePickableId(id: Id64String): void {\r\n    const pick = this._options.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 abstract addLineString(points: Point3d[]): void;\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 abstract addLineString2d(points: Point2d[], zDepth: number): void;\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 abstract addPointString(points: Point3d[]): void;\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 abstract addPointString2d(points: Point2d[], zDepth: number): void;\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 abstract addShape(points: Point3d[]): void;\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 abstract addShape2d(points: Point2d[], zDepth: number): void;\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 abstract addArc(arc: Arc3d, isEllipse: boolean, filled: boolean): void;\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 abstract addArc2d(ellipse: Arc3d, isEllipse: boolean, filled: boolean, zDepth: number): void;\r\n\r\n  /** Append a 3d open path to the builder. */\r\n  public abstract addPath(path: Path): void;\r\n\r\n  /** Append a 3d planar region to the builder. */\r\n  public abstract addLoop(loop: Loop): void;\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 abstract addPolyface(meshData: Polyface, filled: boolean): void;\r\n\r\n  /** Append a solid primitive to the builder. */\r\n  public abstract addSolidPrimitive(solidPrimitive: SolidPrimitive): void;\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 Range3d edges. Useful for debugging. */\r\n  public addRangeBox(range: Range3d) {\r\n    this.addFrustum(Frustum.fromRange(range));\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 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  /** 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 [[GraphicBuilder.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"]}