@itwin/core-frontend 4.10.0-dev.2 → 4.10.0-dev.22

package/lib/cjs/internal/render/PrimitiveBuilder.js.map

@@ -1 +1 @@
-{"version":3,"file":"PrimitiveBuilder.js","sourceRoot":"","sources":["../../../../src/internal/render/PrimitiveBuilder.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;AAEH,wDAAmE;AACnE,oDAA6G;AAC7G,gEAAyH;AAMzH,8DAA2D;AAC3D,sDAA6C;AAC7C,2DAAwF;AAExF,gFAAgF;AAChF,IAAI,gBAAgB,GAAG,KAAK,CAAC;AAE7B,gBAAgB;AAChB,MAAa,gBAAiB,SAAQ,+BAAc;IAOlD,YAAmB,MAAoB,EAAE,OAAoE;QAC3G,KAAK,CAAC,OAAO,CAAC,CAAC;QAPD,QAA2B,GAAG,SAAS,CAAC;QAEjD,eAAU,GAAoB,EAAE,CAAC;QAMtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,EAAE,KAAK,EAAE,CAAC;IACvE,CAAC;IAEe,MAAM;QACpB,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,sBAAY,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,sBAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QAC3B,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,aAAa,CAAC,KAA0B;QAC9C,IAAI,MAA4B,CAAC;QACjC,IAAI,KAA0B,CAAC;QAC/B,IAAI,YAAsC,CAAC;QAC3C,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACnB,yIAAyI;YACzI,iHAAiH;YACjH,wFAAwF;YACxF,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAC/C,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjF,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;gBACzB,IAAI,MAAM,CAAC,QAAQ,EAAE,UAAU;oBAC7B,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;gBAEjC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YACvB,CAAC;QACH,CAAC;QAED,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,EAAmB,CAAC;QACvI,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;YAC/B,MAAM,UAAU,GAAG,KAAK,IAAI,IAAI,uBAAO,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC5C,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,gCAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;QAC9G,CAAC;QAED,IAAI,gBAAgB,IAAI,KAAK,EAAE,CAAC;YAC9B,gBAAgB,GAAG,KAAK,CAAC;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAChE,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAC3B,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YACrE,gBAAgB,GAAG,IAAI,CAAC;QAC1B,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,gBAAgB,CAAC,KAA0B;QAChD,OAAO,IAAI,CAAC,sBAAsB,CAAC;YACjC,OAAO,EAAE,IAAI;YACb,YAAY,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE;SACpD,CAAC,CAAC;IACL,CAAC;IAEkB,eAAe,CAAC,QAAuB;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,QAAyB,EAAE,OAAwB,EAAE,SAAiB,EAAE,QAAwE;QACvK,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAY,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM;YACrB,OAAO,SAAS,CAAC;QAEnB,uIAAuI;QACvI,wIAAwI;QACxI,+BAA+B;QAC/B,EAAE;QACF,4HAA4H;QAC5H,mEAAmE;QACnE,MAAM,MAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,eAAoC,CAAC;QACzC,IAAI,iBAAiB,GAAG,KAAK,CAAC;QAE9B,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;YAC1B,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,IAAI,KAAK,YAAY,0BAAY,EAAE,CAAC;oBAClC,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;oBAC9C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAChC,CAAC;qBAAM,CAAC;oBACN,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;oBACrC,6HAA6H;oBAC7H,2IAA2I;oBAC3I,6IAA6I;oBAC7I,8IAA8I;oBAC9I,IAAI,CAAC,iBAAiB,EAAE,CAAC;wBACvB,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;wBACnD,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;wBACpD,iBAAiB,GAAG,IAAI,CAAC;oBAC3B,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAA,qBAAM,EAAC,SAAS,KAAK,eAAe,CAAC,CAAC;gBACtC,IAAI,KAAK,YAAY,0BAAY,EAAE,CAAC;oBAClC,IAAA,qBAAM,EAAC,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;oBAC3D,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAChC,CAAC;qBAAM,CAAC;oBACN,IAAA,qBAAM,EAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;YAClF,IAAI,OAAO;gBACT,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,IAAA,qBAAM,EAAC,SAAS,KAAK,eAAe,CAAC,CAAC;YACtC,MAAM,SAAS,GAAG,yBAAS,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;YAC/D,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;YAC3D,IAAI,iBAAiB,EAAE,CAAC,CAAC,qDAAqD;gBAC5E,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;gBAC9C,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAnID,4CAmIC;KAlIkB,mCAAyB","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 { Point3d, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { FeatureTable, Gradient, PackedFeatureTable, QPoint3dList, RenderTexture } from \"@itwin/core-common\";\r\nimport { CustomGraphicBuilderOptions, GraphicBuilder, ViewportGraphicBuilderOptions } from \"../../render/GraphicBuilder\";\r\nimport { RenderGraphic } from \"../../render/RenderGraphic\";\r\nimport { RenderSystem } from \"../../render/RenderSystem\";\r\nimport { GeometryOptions } from \"../../common/internal/render/Primitives\";\r\nimport { GeometryAccumulator } from \"../../common/internal/render/GeometryAccumulator\";\r\nimport { MeshList } from \"../../common/internal/render/MeshPrimitives\";\r\nimport { GraphicBranch } from \"../../render/GraphicBranch\";\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { _accumulator, _implementationProhibited } from \"../../common/internal/Symbols\";\r\n\r\n// Set to true to add a range box to every graphic produced by PrimitiveBuilder.\r\nlet addDebugRangeBox = false;\r\n\r\n/** @internal */\r\nexport class PrimitiveBuilder extends GraphicBuilder {\r\n  public readonly [_implementationProhibited] = undefined;\r\n  public readonly system: RenderSystem;\r\n  public primitives: RenderGraphic[] = [];\r\n  private readonly _options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions;\r\n  private readonly _viewIndependentOrigin?: Point3d;\r\n\r\n  public constructor(system: RenderSystem, options: ViewportGraphicBuilderOptions | CustomGraphicBuilderOptions) {\r\n    super(options);\r\n    this.system = system;\r\n    this._options = options;\r\n    this._viewIndependentOrigin = options.viewIndependentOrigin?.clone();\r\n  }\r\n\r\n  public override finish(): RenderGraphic {\r\n    const graphic = this.finishGraphic(this[_accumulator]);\r\n    this[_accumulator].clear();\r\n    return graphic;\r\n  }\r\n\r\n  private finishGraphic(accum: GeometryAccumulator): RenderGraphic {\r\n    let meshes: MeshList | undefined;\r\n    let range: Range3d | undefined;\r\n    let featureTable: FeatureTable | undefined;\r\n    if (!accum.isEmpty) {\r\n      // Overlay decorations don't test Z. Tools like to layer multiple primitives on top of one another; they rely on the primitives rendering\r\n      // in that same order to produce correct results (e.g., a thin line rendered atop a thick line of another color).\r\n      // No point generating edges for graphics that are always rendered in smooth shade mode.\r\n      const tolerance = this.computeTolerance(accum);\r\n      meshes = this.saveToGraphicList(this.primitives, this, tolerance, this.pickable);\r\n      if (undefined !== meshes) {\r\n        if (meshes.features?.anyDefined)\r\n          featureTable = meshes.features;\r\n\r\n        range = meshes.range;\r\n      }\r\n    }\r\n\r\n    let graphic = (this.primitives.length !== 1) ? this.system.createGraphicList(this.primitives) : this.primitives.pop() as RenderGraphic;\r\n    if (undefined !== featureTable) {\r\n      const batchRange = range ?? new Range3d();\r\n      const batchOptions = this._options.pickable;\r\n      graphic = this.system.createBatch(graphic, PackedFeatureTable.pack(featureTable), batchRange, batchOptions);\r\n    }\r\n\r\n    if (addDebugRangeBox && range) {\r\n      addDebugRangeBox = false;\r\n      const builder = this.system.createGraphic({ ...this._options });\r\n      builder.addRangeBox(range);\r\n      graphic = this.system.createGraphicList([graphic, builder.finish()]);\r\n      addDebugRangeBox = true;\r\n    }\r\n\r\n    return graphic;\r\n  }\r\n\r\n  public computeTolerance(accum: GeometryAccumulator): number {\r\n    return this._computeChordTolerance({\r\n      graphic: this,\r\n      computeRange: () => accum.geometries.computeRange(),\r\n    });\r\n  }\r\n\r\n  protected override resolveGradient(gradient: Gradient.Symb): RenderTexture | undefined {\r\n    return this.system.getGradientTexture(gradient, this.iModel);\r\n  }\r\n\r\n  /**\r\n   * Populate a list of Graphic objects from the accumulated Geometry objects.\r\n   * removed ViewContext\r\n   */\r\n  public saveToGraphicList(graphics: RenderGraphic[], options: GeometryOptions, tolerance: number, pickable: { isVolumeClassifier?: boolean, modelId?: string } | undefined): MeshList | undefined {\r\n    const meshes = this[_accumulator].toMeshes(options, tolerance, pickable);\r\n    if (0 === meshes.length)\r\n      return undefined;\r\n\r\n    // If the meshes contain quantized positions, they are all quantized to the same range. If that range is small relative to the distance\r\n    // from the origin, quantization errors can produce display artifacts. Remove the translation from the quantization parameters and apply\r\n    // it in the transform instead.\r\n    //\r\n    // If the positions are not quantized, they have already been transformed to be relative to the center of the meshes' range.\r\n    // Apply the inverse translation to put them back into model space.\r\n    const branch = new GraphicBranch(true);\r\n    let transformOrigin: Point3d | undefined;\r\n    let meshesRangeOffset = false;\r\n\r\n    for (const mesh of meshes) {\r\n      const verts = mesh.points;\r\n      if (branch.isEmpty) {\r\n        if (verts instanceof QPoint3dList) {\r\n          transformOrigin = verts.params.origin.clone();\r\n          verts.params.origin.setZero();\r\n        } else {\r\n          transformOrigin = verts.range.center;\r\n          // In this case we need to modify the qOrigin of the graphic that will get created later since we have translated the origin.\r\n          // We can't modify it directly, but if we temporarily modify the range of the mesh used to create it the qOrigin will get created properly.\r\n          // Range is shared (not cloned) by all meshes and the mesh list itself, so modifying the range of the meshlist will modify it for all meshes.\r\n          // We will then later add this offset back to the range once all of the graphics have been created because it is needed unmodified for locate.\r\n          if (!meshesRangeOffset) {\r\n            meshes.range?.low.subtractInPlace(transformOrigin);\r\n            meshes.range?.high.subtractInPlace(transformOrigin);\r\n            meshesRangeOffset = true;\r\n          }\r\n        }\r\n      } else {\r\n        assert(undefined !== transformOrigin);\r\n        if (verts instanceof QPoint3dList) {\r\n          assert(transformOrigin.isAlmostEqual(verts.params.origin));\r\n          verts.params.origin.setZero();\r\n        } else {\r\n          assert(verts.range.center.isAlmostZero);\r\n        }\r\n      }\r\n\r\n      const graphic = this.system.createMeshGraphics(mesh, this._viewIndependentOrigin);\r\n      if (graphic)\r\n        branch.add(graphic);\r\n    }\r\n\r\n    if (!branch.isEmpty) {\r\n      assert(undefined !== transformOrigin);\r\n      const transform = Transform.createTranslation(transformOrigin);\r\n      graphics.push(this.system.createBranch(branch, transform));\r\n      if (meshesRangeOffset) { // restore the meshes range that we modified earlier.\r\n        meshes.range?.low.addInPlace(transformOrigin);\r\n        meshes.range?.high.addInPlace(transformOrigin);\r\n      }\r\n    }\r\n\r\n    return meshes;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"PrimitiveBuilder.js","sourceRoot":"","sources":["../../../../src/internal/render/PrimitiveBuilder.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;AAEH,wDAAmE;AACnE,oDAA+F;AAC/F,gEAAyH;AAMzH,8DAA2D;AAC3D,sDAA6C;AAC7C,2DAAwF;AACxF,kEAA4G;AAG5G,gBAAgB;AAChB,MAAa,gBAAiB,SAAQ,+BAAc;IAOlD,YAAmB,MAAoB,EAAE,OAAoE;QAC3G,KAAK,CAAC,OAAO,CAAC,CAAC;QAPD,QAA2B,GAAG,SAAS,CAAC;QAEjD,eAAU,GAAoB,EAAE,CAAC;QAMtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,EAAE,KAAK,EAAE,CAAC;IACvE,CAAC;IAEe,MAAM;QACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QACpE,OAAO,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;IAEe,cAAc;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAEO,UAAU,CAAC,SAAkB;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,sBAAY,CAAC,CAAC;QACjC,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC9E,KAAK,CAAC,KAAK,EAAE,CAAC;QAEd,OAAO,MAAM,IAAI,IAAA,uCAAqB,EAAC,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IACnE,CAAC;IAEM,gBAAgB,CAAC,KAA0B;QAChD,OAAO,IAAI,CAAC,sBAAsB,CAAC;YACjC,OAAO,EAAE,IAAI;YACb,YAAY,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE;SACpD,CAAC,CAAC;IACL,CAAC;IAEkB,eAAe,CAAC,QAAuB;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,QAAyB,EAAE,OAAwB,EAAE,SAAiB,EAAE,QAAwE;QACvK,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAY,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM;YACrB,OAAO,SAAS,CAAC;QAEnB,uIAAuI;QACvI,wIAAwI;QACxI,+BAA+B;QAC/B,EAAE;QACF,4HAA4H;QAC5H,mEAAmE;QACnE,MAAM,MAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,eAAoC,CAAC;QACzC,IAAI,iBAAiB,GAAG,KAAK,CAAC;QAE9B,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;YAC1B,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,IAAI,KAAK,YAAY,0BAAY,EAAE,CAAC;oBAClC,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;oBAC9C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAChC,CAAC;qBAAM,CAAC;oBACN,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;oBACrC,6HAA6H;oBAC7H,2IAA2I;oBAC3I,6IAA6I;oBAC7I,8IAA8I;oBAC9I,IAAI,CAAC,iBAAiB,EAAE,CAAC;wBACvB,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;wBACnD,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;wBACpD,iBAAiB,GAAG,IAAI,CAAC;oBAC3B,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAA,qBAAM,EAAC,SAAS,KAAK,eAAe,CAAC,CAAC;gBACtC,IAAI,KAAK,YAAY,0BAAY,EAAE,CAAC;oBAClC,IAAA,qBAAM,EAAC,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;oBAC3D,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAChC,CAAC;qBAAM,CAAC;oBACN,IAAA,qBAAM,EAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;YAClF,IAAI,OAAO;gBACT,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,IAAA,qBAAM,EAAC,SAAS,KAAK,eAAe,CAAC,CAAC;YACtC,MAAM,SAAS,GAAG,yBAAS,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;YAC/D,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;YAC3D,IAAI,iBAAiB,EAAE,CAAC,CAAC,qDAAqD;gBAC5E,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;gBAC9C,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,cAAc,CAAC,OAAwB,EAAE,SAAiB,EAAE,QAAwE,EAAE,SAAkB;QAC9J,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAY,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM;YACrB,OAAO,SAAS,CAAC;QAEnB,uIAAuI;QACvI,wIAAwI;QACxI,+BAA+B;QAC/B,EAAE;QACF,4HAA4H;QAC5H,mEAAmE;QACnE,IAAI,eAAoC,CAAC;QACzC,IAAI,iBAAiB,GAAG,KAAK,CAAC;QAC9B,MAAM,QAAQ,GAAqB,EAAE,CAAC;QAEtC,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;YAC1B,IAAI,CAAC,eAAe,EAAC,CAAC;gBACpB,IAAI,KAAK,YAAY,0BAAY,EAAE,CAAC;oBAClC,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;oBAC9C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAChC,CAAC;qBAAM,CAAC;oBACN,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;oBACrC,6HAA6H;oBAC7H,2IAA2I;oBAC3I,6IAA6I;oBAC7I,8IAA8I;oBAC9I,IAAI,CAAC,iBAAiB,EAAE,CAAC;wBACvB,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;wBACnD,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;wBACpD,iBAAiB,GAAG,IAAI,CAAC;oBAC3B,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,KAAK,YAAY,0BAAY,EAAE,CAAC;oBAClC,IAAA,qBAAM,EAAC,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;oBAC3D,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAChC,CAAC;qBAAM,CAAC;oBACN,IAAA,qBAAM,EAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACnF,IAAI,IAAI,EAAE,CAAC;gBACT,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;QAED,IAAI,SAAS,CAAC;QACd,IAAI,eAAe,EAAE,CAAC;YACpB,SAAS,GAAG,yBAAS,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;YACzD,IAAI,iBAAiB,EAAE,CAAC,CAAC,qDAAqD;gBAC5E,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;gBAC9C,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;QAED,IAAI,KAAuC,CAAC;QAC5C,IAAI,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC;YAChC,KAAK,GAAG;gBACN,YAAY,EAAE,gCAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACtD,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,IAAI,uBAAO,EAAE;gBACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;aAChC,CAAC;QACJ,CAAC;QAED,OAAO,IAAA,uCAAqB,EAAC;YAC3B,KAAK;YACL,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;YAChC,SAAS;SACV,CAAC,CAAC;IACL,CAAC;CACF;AArLD,4CAqLC;KApLkB,mCAAyB","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 { Point3d, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { Gradient, PackedFeatureTable, QPoint3dList, RenderTexture } from \"@itwin/core-common\";\r\nimport { CustomGraphicBuilderOptions, GraphicBuilder, ViewportGraphicBuilderOptions } from \"../../render/GraphicBuilder\";\r\nimport { RenderGraphic } from \"../../render/RenderGraphic\";\r\nimport { RenderSystem } from \"../../render/RenderSystem\";\r\nimport { GeometryOptions } from \"../../common/internal/render/Primitives\";\r\nimport { GeometryAccumulator } from \"../../common/internal/render/GeometryAccumulator\";\r\nimport { MeshList } from \"../../common/internal/render/MeshPrimitives\";\r\nimport { GraphicBranch } from \"../../render/GraphicBranch\";\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { _accumulator, _implementationProhibited } from \"../../common/internal/Symbols\";\r\nimport { createGraphicTemplate, GraphicTemplate, GraphicTemplateBatch } from \"../../render/GraphicTemplate\";\r\nimport { RenderGeometry } from \"./RenderGeometry\";\r\n\r\n/** @internal */\r\nexport class PrimitiveBuilder extends GraphicBuilder {\r\n  public readonly [_implementationProhibited] = undefined;\r\n  public readonly system: RenderSystem;\r\n  public primitives: RenderGraphic[] = [];\r\n  private readonly _options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions;\r\n  private readonly _viewIndependentOrigin?: Point3d;\r\n\r\n  public constructor(system: RenderSystem, options: ViewportGraphicBuilderOptions | CustomGraphicBuilderOptions) {\r\n    super(options);\r\n    this.system = system;\r\n    this._options = options;\r\n    this._viewIndependentOrigin = options.viewIndependentOrigin?.clone();\r\n  }\r\n\r\n  public override finish(): RenderGraphic {\r\n    const template = this.toTemplate(false);\r\n    const graphic = this.system.createGraphicFromTemplate({ template });\r\n    return graphic ?? this.system.createGraphicList([]);\r\n  }\r\n\r\n  public override finishTemplate(): GraphicTemplate {\r\n    return this.toTemplate(true);\r\n  }\r\n\r\n  private toTemplate(noDispose: boolean): GraphicTemplate {\r\n    const accum = this[_accumulator];\r\n    const tolerance = this.computeTolerance(accum);\r\n    const result = this.saveToTemplate(this, tolerance, this.pickable, noDispose);\r\n    accum.clear();\r\n\r\n    return result ?? createGraphicTemplate({ nodes: [], noDispose });\r\n  }\r\n\r\n  public computeTolerance(accum: GeometryAccumulator): number {\r\n    return this._computeChordTolerance({\r\n      graphic: this,\r\n      computeRange: () => accum.geometries.computeRange(),\r\n    });\r\n  }\r\n\r\n  protected override resolveGradient(gradient: Gradient.Symb): RenderTexture | undefined {\r\n    return this.system.getGradientTexture(gradient, this.iModel);\r\n  }\r\n\r\n  /**\r\n   * Populate a list of Graphic objects from the accumulated Geometry objects.\r\n   * removed ViewContext\r\n   */\r\n  public saveToGraphicList(graphics: RenderGraphic[], options: GeometryOptions, tolerance: number, pickable: { isVolumeClassifier?: boolean, modelId?: string } | undefined): MeshList | undefined {\r\n    const meshes = this[_accumulator].toMeshes(options, tolerance, pickable);\r\n    if (0 === meshes.length)\r\n      return undefined;\r\n\r\n    // If the meshes contain quantized positions, they are all quantized to the same range. If that range is small relative to the distance\r\n    // from the origin, quantization errors can produce display artifacts. Remove the translation from the quantization parameters and apply\r\n    // it in the transform instead.\r\n    //\r\n    // If the positions are not quantized, they have already been transformed to be relative to the center of the meshes' range.\r\n    // Apply the inverse translation to put them back into model space.\r\n    const branch = new GraphicBranch(true);\r\n    let transformOrigin: Point3d | undefined;\r\n    let meshesRangeOffset = false;\r\n\r\n    for (const mesh of meshes) {\r\n      const verts = mesh.points;\r\n      if (branch.isEmpty) {\r\n        if (verts instanceof QPoint3dList) {\r\n          transformOrigin = verts.params.origin.clone();\r\n          verts.params.origin.setZero();\r\n        } else {\r\n          transformOrigin = verts.range.center;\r\n          // In this case we need to modify the qOrigin of the graphic that will get created later since we have translated the origin.\r\n          // We can't modify it directly, but if we temporarily modify the range of the mesh used to create it the qOrigin will get created properly.\r\n          // Range is shared (not cloned) by all meshes and the mesh list itself, so modifying the range of the meshlist will modify it for all meshes.\r\n          // We will then later add this offset back to the range once all of the graphics have been created because it is needed unmodified for locate.\r\n          if (!meshesRangeOffset) {\r\n            meshes.range?.low.subtractInPlace(transformOrigin);\r\n            meshes.range?.high.subtractInPlace(transformOrigin);\r\n            meshesRangeOffset = true;\r\n          }\r\n        }\r\n      } else {\r\n        assert(undefined !== transformOrigin);\r\n        if (verts instanceof QPoint3dList) {\r\n          assert(transformOrigin.isAlmostEqual(verts.params.origin));\r\n          verts.params.origin.setZero();\r\n        } else {\r\n          assert(verts.range.center.isAlmostZero);\r\n        }\r\n      }\r\n\r\n      const graphic = this.system.createMeshGraphics(mesh, this._viewIndependentOrigin);\r\n      if (graphic)\r\n        branch.add(graphic);\r\n    }\r\n\r\n    if (!branch.isEmpty) {\r\n      assert(undefined !== transformOrigin);\r\n      const transform = Transform.createTranslation(transformOrigin);\r\n      graphics.push(this.system.createBranch(branch, transform));\r\n      if (meshesRangeOffset) { // restore the meshes range that we modified earlier.\r\n        meshes.range?.low.addInPlace(transformOrigin);\r\n        meshes.range?.high.addInPlace(transformOrigin);\r\n      }\r\n    }\r\n\r\n    return meshes;\r\n  }\r\n\r\n  private saveToTemplate(options: GeometryOptions, tolerance: number, pickable: { isVolumeClassifier?: boolean, modelId?: string } | undefined, noDispose: boolean): GraphicTemplate | undefined {\r\n    const meshes = this[_accumulator].toMeshes(options, tolerance, pickable);\r\n    if (0 === meshes.length)\r\n      return undefined;\r\n\r\n    // If the meshes contain quantized positions, they are all quantized to the same range. If that range is small relative to the distance\r\n    // from the origin, quantization errors can produce display artifacts. Remove the translation from the quantization parameters and apply\r\n    // it in the transform instead.\r\n    //\r\n    // If the positions are not quantized, they have already been transformed to be relative to the center of the meshes' range.\r\n    // Apply the inverse translation to put them back into model space.\r\n    let transformOrigin: Point3d | undefined;\r\n    let meshesRangeOffset = false;\r\n    const geometry: RenderGeometry[] = [];\r\n\r\n    for (const mesh of meshes) {\r\n      const verts = mesh.points;\r\n      if (!transformOrigin){\r\n        if (verts instanceof QPoint3dList) {\r\n          transformOrigin = verts.params.origin.clone();\r\n          verts.params.origin.setZero();\r\n        } else {\r\n          transformOrigin = verts.range.center;\r\n          // In this case we need to modify the qOrigin of the graphic that will get created later since we have translated the origin.\r\n          // We can't modify it directly, but if we temporarily modify the range of the mesh used to create it the qOrigin will get created properly.\r\n          // Range is shared (not cloned) by all meshes and the mesh list itself, so modifying the range of the meshlist will modify it for all meshes.\r\n          // We will then later add this offset back to the range once all of the graphics have been created because it is needed unmodified for locate.\r\n          if (!meshesRangeOffset) {\r\n            meshes.range?.low.subtractInPlace(transformOrigin);\r\n            meshes.range?.high.subtractInPlace(transformOrigin);\r\n            meshesRangeOffset = true;\r\n          }\r\n        }\r\n      } else {\r\n        if (verts instanceof QPoint3dList) {\r\n          assert(transformOrigin.isAlmostEqual(verts.params.origin));\r\n          verts.params.origin.setZero();\r\n        } else {\r\n          assert(verts.range.center.isAlmostZero);\r\n        }\r\n      }\r\n\r\n      const geom = this.system.createGeometryFromMesh(mesh, this._viewIndependentOrigin);\r\n      if (geom) {\r\n        geometry.push(geom);\r\n      }\r\n    }\r\n\r\n    let transform;\r\n    if (transformOrigin) {\r\n      transform = Transform.createTranslation(transformOrigin);\r\n      if (meshesRangeOffset) { // restore the meshes range that we modified earlier.\r\n        meshes.range?.low.addInPlace(transformOrigin);\r\n        meshes.range?.high.addInPlace(transformOrigin);\r\n      }\r\n    }\r\n\r\n    let batch: GraphicTemplateBatch | undefined;\r\n    if (meshes.features?.anyDefined) {\r\n      batch = {\r\n        featureTable: PackedFeatureTable.pack(meshes.features),\r\n        range: meshes.range ?? new Range3d(),\r\n        options: this._options.pickable,\r\n      };\r\n    }\r\n\r\n    return createGraphicTemplate({\r\n      batch,\r\n      nodes: [{ geometry, transform }],\r\n      noDispose,\r\n    });\r\n  }\r\n}\r\n"]}

package/lib/cjs/internal/render/RenderGeometry.d.ts

@@ -0,0 +1,20 @@
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { IDisposable } from "@itwin/core-bentley";
+import { RenderMemory } from "../../render/RenderMemory";
+import { Range3d } from "@itwin/core-geometry";
+/** An opaque representation of geometry allocated by a [[RenderSystem]] to be supplied to [[RenderSystem.createRenderGraphic]]. */
+export interface RenderGeometry extends IDisposable, RenderMemory.Consumer {
+    readonly renderGeometryType: "mesh" | "polyline" | "point-string" | "point-cloud" | "reality-mesh";
+    readonly isInstanceable: boolean;
+    readonly isDisposed: boolean;
+    /** If true, this geometry is intended for reuse. Its `dispose` method will do nothing. Instead, we will rely on the JS garbage collector
+     * to dispose of any WebGL resources it contains.
+     * When creating a reusable `GraphicTemplate`, we set this to `true` for all geometry in the template. We never set it to `false`.
+     */
+    noDispose: boolean;
+    /** @internal */
+    computeRange(out?: Range3d): Range3d;
+}
+//# sourceMappingURL=RenderGeometry.d.ts.map

package/lib/cjs/internal/render/RenderGeometry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenderGeometry.d.ts","sourceRoot":"","sources":["../../../../src/internal/render/RenderGeometry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,mIAAmI;AACnI,MAAM,WAAW,cAAe,SAAQ,WAAW,EAAE,YAAY,CAAC,QAAQ;IACxE,QAAQ,CAAC,kBAAkB,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,CAAC;IACnG,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB,gBAAgB;IAChB,YAAY,CAAC,GAAG,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CACtC"}

package/lib/cjs/internal/render/RenderGeometry.js

@@ -0,0 +1,10 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RenderGeometry.js.map

package/lib/cjs/internal/render/RenderGeometry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenderGeometry.js","sourceRoot":"","sources":["../../../../src/internal/render/RenderGeometry.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 { IDisposable } from \"@itwin/core-bentley\";\r\nimport { RenderMemory } from \"../../render/RenderMemory\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\n\r\n/** An opaque representation of geometry allocated by a [[RenderSystem]] to be supplied to [[RenderSystem.createRenderGraphic]]. */\r\nexport interface RenderGeometry extends IDisposable, RenderMemory.Consumer {\r\n  readonly renderGeometryType: \"mesh\" | \"polyline\" | \"point-string\" | \"point-cloud\" | \"reality-mesh\";\r\n  readonly isInstanceable: boolean;\r\n  readonly isDisposed: boolean;\r\n  /** If true, this geometry is intended for reuse. Its `dispose` method will do nothing. Instead, we will rely on the JS garbage collector\r\n   * to dispose of any WebGL resources it contains.\r\n   * When creating a reusable `GraphicTemplate`, we set this to `true` for all geometry in the template. We never set it to `false`.\r\n   */\r\n  noDispose: boolean;\r\n  /** @internal */\r\n  computeRange(out?: Range3d): Range3d;\r\n}\r\n\r\n"]}

package/lib/cjs/internal/render/RenderInstancesParamsImpl.d.ts

@@ -0,0 +1,24 @@
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { _implementationProhibited } from "../../common/internal/Symbols";
+import { InstancedGraphicProps } from "../../common/render/InstancedGraphicParams";
+import { CreateRenderInstancesParamsBuilderArgs, RenderInstancesParams, RenderInstancesParamsBuilder } from "../../common/render/RenderInstancesParams";
+/** Intermediate representation of `RenderInstances[_batch]`. */
+export interface InstancedFeaturesParams {
+    modelId: Id64String;
+    data: Uint32Array;
+    count: number;
+}
+/** This exists so that [[RenderInstancesParams]] can be an opaque type that can be copied between Workers.
+ * (`Symbol`s are dropped during structured cloning).
+ */
+export interface RenderInstancesParamsImpl extends RenderInstancesParams {
+    [_implementationProhibited]: "renderInstancesParams";
+    instances: InstancedGraphicProps;
+    features?: InstancedFeaturesParams;
+}
+export declare function createRenderInstancesParamsBuilder(args: CreateRenderInstancesParamsBuilderArgs): RenderInstancesParamsBuilder;
+export declare function collectRenderInstancesParamsTransferables(xfers: Set<Transferable>, inParams: RenderInstancesParams): void;
+//# sourceMappingURL=RenderInstancesParamsImpl.d.ts.map

package/lib/cjs/internal/render/RenderInstancesParamsImpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenderInstancesParamsImpl.d.ts","sourceRoot":"","sources":["../../../../src/internal/render/RenderInstancesParamsImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,4CAA4C,CAAC;AACnF,OAAO,EAAE,sCAAsC,EAAY,qBAAqB,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAIlK,gEAAgE;AAChE,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,UAAU,CAAC;IACpB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACtE,CAAC,yBAAyB,CAAC,EAAE,uBAAuB,CAAC;IACrD,SAAS,EAAE,qBAAqB,CAAC;IACjC,QAAQ,CAAC,EAAE,uBAAuB,CAAC;CACpC;AAkDD,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,sCAAsC,GAAG,4BAA4B,CAE7H;AAED,wBAAgB,yCAAyC,CAAC,KAAK,EAAE,GAAG,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,qBAAqB,GAAG,IAAI,CASzH"}

package/lib/cjs/internal/render/RenderInstancesParamsImpl.js

@@ -0,0 +1,69 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.collectRenderInstancesParamsTransferables = exports.createRenderInstancesParamsBuilder = void 0;
+const Symbols_1 = require("../../common/internal/Symbols");
+const InstancedGraphicParams_1 = require("../../common/render/InstancedGraphicParams");
+const InstancedGraphicPropsBuilder_1 = require("../../common/internal/render/InstancedGraphicPropsBuilder");
+const core_common_1 = require("@itwin/core-common");
+class Builder {
+    constructor(modelId) {
+        this[_a] = undefined;
+        this._instances = new InstancedGraphicPropsBuilder_1.InstancedGraphicPropsBuilder();
+        this._containsFeatures = false;
+        this._modelId = modelId;
+    }
+    add(instance) {
+        this._instances.add(instance);
+        if (undefined !== instance.feature) {
+            this._containsFeatures = true;
+        }
+    }
+    finish() {
+        const numInstances = this._instances.length;
+        if (numInstances === 0) {
+            throw new Error("No instances defined");
+        }
+        let featureTable;
+        if (this._containsFeatures) {
+            featureTable = new core_common_1.FeatureTable(numInstances, this._modelId);
+        }
+        const instances = this._instances.finish(featureTable);
+        const result = {
+            [Symbols_1._implementationProhibited]: "renderInstancesParams",
+            instances,
+        };
+        if (featureTable) {
+            const packedTable = core_common_1.PackedFeatureTable.pack(featureTable);
+            result.features = {
+                data: packedTable.data,
+                modelId: packedTable.batchModelId,
+                count: packedTable.numFeatures,
+            };
+        }
+        return result;
+    }
+}
+_a = Symbols_1._implementationProhibited;
+function createRenderInstancesParamsBuilder(args) {
+    return new Builder(args.modelId);
+}
+exports.createRenderInstancesParamsBuilder = createRenderInstancesParamsBuilder;
+function collectRenderInstancesParamsTransferables(xfers, inParams) {
+    const params = inParams;
+    if (params.instances) {
+        InstancedGraphicParams_1.InstancedGraphicProps.collectTransferables(xfers, params.instances);
+    }
+    if (params.features) {
+        xfers.add(params.features.data.buffer);
+    }
+}
+exports.collectRenderInstancesParamsTransferables = collectRenderInstancesParamsTransferables;
+//# sourceMappingURL=RenderInstancesParamsImpl.js.map

package/lib/cjs/internal/render/RenderInstancesParamsImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenderInstancesParamsImpl.js","sourceRoot":"","sources":["../../../../src/internal/render/RenderInstancesParamsImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;AAGH,2DAA0E;AAC1E,uFAAmF;AAEnF,4GAAyG;AACzG,oDAAsE;AAkBtE,MAAM,OAAO;IAMX,YAAmB,OAAoB;QALvB,QAA2B,GAAG,SAAS,CAAC;QACvC,eAAU,GAAG,IAAI,2DAA4B,EAAE,CAAC;QAEzD,sBAAiB,GAAG,KAAK,CAAC;QAGhC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAEM,GAAG,CAAC,QAAkB;QAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE9B,IAAI,SAAS,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;YACnC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAChC,CAAC;IACH,CAAC;IAEM,MAAM;QACX,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC5C,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;QAED,IAAI,YAAY,CAAC;QACjB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,YAAY,GAAG,IAAI,0BAAY,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACvD,MAAM,MAAM,GAA8B;YACxC,CAAC,mCAAyB,CAAC,EAAE,uBAAuB;YACpD,SAAS;SACV,CAAC;QAEF,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,WAAW,GAAG,gCAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC1D,MAAM,CAAC,QAAQ,GAAG;gBAChB,IAAI,EAAE,WAAW,CAAC,IAAI;gBACtB,OAAO,EAAE,WAAW,CAAC,YAAY;gBACjC,KAAK,EAAE,WAAW,CAAC,WAAW;aAC/B,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;KA7CkB,mCAAyB;AA+C5C,SAAgB,kCAAkC,CAAC,IAA4C;IAC7F,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAFD,gFAEC;AAED,SAAgB,yCAAyC,CAAC,KAAwB,EAAE,QAA+B;IACjH,MAAM,MAAM,GAAG,QAAqC,CAAC;IACrD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,8CAAqB,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;AACH,CAAC;AATD,8FASC","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 { _implementationProhibited } from \"../../common/internal/Symbols\";\r\nimport { InstancedGraphicProps } from \"../../common/render/InstancedGraphicParams\";\r\nimport { CreateRenderInstancesParamsBuilderArgs, Instance, RenderInstancesParams, RenderInstancesParamsBuilder } from \"../../common/render/RenderInstancesParams\";\r\nimport { InstancedGraphicPropsBuilder } from \"../../common/internal/render/InstancedGraphicPropsBuilder\";\r\nimport { FeatureTable, PackedFeatureTable } from \"@itwin/core-common\";\r\n\r\n/** Intermediate representation of `RenderInstances[_batch]`. */\r\nexport interface InstancedFeaturesParams {\r\n  modelId: Id64String;\r\n  data: Uint32Array;\r\n  count: number;\r\n}\r\n\r\n/** This exists so that [[RenderInstancesParams]] can be an opaque type that can be copied between Workers.\r\n * (`Symbol`s are dropped during structured cloning).\r\n */\r\nexport interface RenderInstancesParamsImpl extends RenderInstancesParams {\r\n  [_implementationProhibited]: \"renderInstancesParams\";\r\n  instances: InstancedGraphicProps;\r\n  features?: InstancedFeaturesParams;\r\n}\r\n\r\nclass Builder implements RenderInstancesParamsBuilder {\r\n  public readonly [_implementationProhibited] = undefined;\r\n  private readonly _instances = new InstancedGraphicPropsBuilder();\r\n  private readonly _modelId?: Id64String;\r\n  private _containsFeatures = false;\r\n\r\n  public constructor(modelId?: Id64String) {\r\n    this._modelId = modelId;\r\n  }\r\n\r\n  public add(instance: Instance): void {\r\n    this._instances.add(instance);\r\n\r\n    if (undefined !== instance.feature) {\r\n      this._containsFeatures = true;\r\n    }\r\n  }\r\n\r\n  public finish(): RenderInstancesParams {\r\n    const numInstances = this._instances.length;\r\n    if (numInstances === 0) {\r\n      throw new Error(\"No instances defined\");\r\n    }\r\n\r\n    let featureTable;\r\n    if (this._containsFeatures) {\r\n      featureTable = new FeatureTable(numInstances, this._modelId);\r\n    }\r\n\r\n    const instances = this._instances.finish(featureTable);\r\n    const result: RenderInstancesParamsImpl = {\r\n      [_implementationProhibited]: \"renderInstancesParams\",\r\n      instances,\r\n    };\r\n\r\n    if (featureTable) {\r\n      const packedTable = PackedFeatureTable.pack(featureTable);\r\n      result.features = {\r\n        data: packedTable.data,\r\n        modelId: packedTable.batchModelId,\r\n        count: packedTable.numFeatures,\r\n      };\r\n    }\r\n\r\n    return result;\r\n  }\r\n}\r\n\r\nexport function createRenderInstancesParamsBuilder(args: CreateRenderInstancesParamsBuilderArgs): RenderInstancesParamsBuilder {\r\n  return new Builder(args.modelId);\r\n}\r\n\r\nexport function collectRenderInstancesParamsTransferables(xfers: Set<Transferable>, inParams: RenderInstancesParams): void {\r\n  const params = inParams as RenderInstancesParamsImpl;\r\n  if (params.instances) {\r\n    InstancedGraphicProps.collectTransferables(xfers, params.instances);\r\n  }\r\n\r\n  if (params.features) {\r\n    xfers.add(params.features.data.buffer);\r\n  }\r\n}\r\n"]}

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

@@ -10,7 +10,7 @@ import { RenderGraphic } from "./RenderGraphic";
 import { RenderMemory } from "./RenderMemory";
 import { RenderPlanarClassifier } from "./RenderPlanarClassifier";
 import { RenderTextureDrape } from "./RenderSystem";
-import { Range3d } from "@itwin/core-geometry";
+import { Range3d, Transform } from "@itwin/core-geometry";
 import { AnimationNodeId } from "../common/internal/render/AnimationNodeId";
 /** Carries information in a GraphicBranchOptions about a GraphicBranch produced by drawing one view into the context of another.
  * @internal
@@ -102,6 +102,11 @@ export interface GraphicBranchOptions {
     hline?: HiddenLine.Settings;
     /** The iModel from which the graphics originate, if different than that associated with the view. */
     iModel?: IModelConnection;
+    /** An optional transform from the coordinate system of [[iModel]] to those of a different [[IModelConnection]].
+     * This is used by [[AccuSnap]] when displaying one iModel in the context of another iModel (i.e., the iModel associated
+     * with the [[Viewport]]).
+     */
+    transformFromIModel?: Transform;
     /** @internal */
     frustum?: GraphicBranchFrustum;
     /** Supplements the view's [[FeatureSymbology.Overrides]] for graphics in the branch. */
@@ -112,6 +117,10 @@ export interface GraphicBranchOptions {
      * @internal
      */
     viewAttachmentId?: Id64String;
+    /** If true, the view's [DisplayStyleSettings.clipStyle]($common) will be disabled for this branch.
+     * No [ClipStyle.insideColor]($common), [ClipStyle.outsideColor]($common), or [ClipStyle.intersectionStyle]($common) will be applied.
+     */
+    disableClipStyle?: true;
 }
 /** Clip/Transform for a branch that are varied over time.
  * @internal

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

@@ -1 +1 @@
-{"version":3,"file":"GraphicBranch.d.ts","sourceRoot":"","sources":["../../../src/render/GraphicBranch.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAgB,UAAU,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EACL,yBAAyB,EAAE,UAAU,EAAE,2BAA2B,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EACjH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,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;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAE5E;;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;;;;;;;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;;OAEG;IACI,2BAA2B,CAAC,EAAE,2BAA2B,CAAC;IACjE,gBAAgB;IACT,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACnC,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;;;;;;;;OAQG;IACI,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B;;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;IAC3D;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKrF;AASD;;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;AAED,gBAAgB;AAChB,yBAAiB,qBAAqB,CAAC;IACrC,SAAgB,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAmBzG;CACF"}
+{"version":3,"file":"GraphicBranch.d.ts","sourceRoot":"","sources":["../../../src/render/GraphicBranch.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAgB,UAAU,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EACL,yBAAyB,EAAE,UAAU,EAAE,2BAA2B,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EACjH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,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;AACpD,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAE5E;;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;;;;;;;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;;OAEG;IACI,2BAA2B,CAAC,EAAE,2BAA2B,CAAC;IACjE,gBAAgB;IACT,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACnC,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;;;;;;;;OAQG;IACI,WAAW,CAAC,EAAE,MAAM,CAAC;IAE5B;;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;;;OAGG;IACH,mBAAmB,CAAC,EAAE,SAAS,CAAC;IAChC,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;IAC3D;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC;IAC9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKrF;AASD;;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;AAED,gBAAgB;AAChB,yBAAiB,qBAAqB,CAAC;IACrC,SAAgB,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAmBzG;CACF"}

package/lib/cjs/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;;;AAEH,sDAA4E;AAK5E,4CAAyC;AAqBzC;;;;;;;GAOG;AACH,MAAa,aAAa;IAqCxB;;OAEG;IACH,YAAmB,cAAuB,KAAK;QAvC/C,qCAAqC;QACrB,YAAO,GAAoB,EAAE,CAAC;QAG9C;;WAEG;QACI,sBAAiB,GAAsB,EAAE,CAAC;QAiC/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,IAAA,2BAAY,EAAC,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;AA1FD,sCA0FC;AAmCD,gBAAgB;AAChB,SAAgB,uBAAuB,CAAC,OAAmB,EAAE,QAAgB;IAC3E,IAAI,QAAQ,GAAG,CAAC;QACd,OAAO,OAAO,CAAC;IAEjB,OAAO,GAAG,OAAO,SAAS,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC;AAClD,CAAC;AALD,0DAKC;AAED,SAAS,kBAAkB,CAAC,OAAmB,EAAE,QAAiC,EAAE,QAAgB,EAAE,QAA2C,EAAE,IAAY;IAC7J,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,qBAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1F,IAAI,IAAI;QACN,QAAQ,CAAC,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACvE,CAAC;AAYD,gBAAgB;AAChB,IAAiB,qBAAqB,CAqBrC;AArBD,WAAiB,qBAAqB;IACpC,SAAgB,UAAU,CAAC,MAA6B,EAAE,IAAY;QACpE,IAAI,CAAC,MAAM,CAAC,qBAAqB,IAAI,CAAC,MAAM,CAAC,gBAAgB;YAC3D,OAAO,SAAS,CAAC;QAEnB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAgC,CAAC;QACzD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;YAC1C,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC7D,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;gBAC1C,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;oBAC/B,QAAQ,CAAC,GAAG,CAAC,uBAAuB,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;;oBAEnF,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;QAED,OAAO;YACL,YAAY,EAAE,QAAQ;YACtB,gBAAgB,EAAE,MAAM,CAAC,iBAAiB;SAC3C,CAAC;IACJ,CAAC;IAnBe,gCAAU,aAmBzB,CAAA;AACH,CAAC,EArBgB,qBAAqB,qCAArB,qBAAqB,QAqBrC","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 { disposeArray, Id64String, IDisposable } from \"@itwin/core-bentley\";\r\nimport {\r\n  FeatureAppearanceProvider, HiddenLine, RealityModelDisplaySettings, RenderSchedule, ViewFlagOverrides, ViewFlags,\r\n} from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { IModelApp } from \"../IModelApp\";\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\nimport { Range3d } from \"@itwin/core-geometry\";\r\nimport { AnimationNodeId } from \"../common/internal/render/AnimationNodeId\";\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\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  /** Controls how reality models are displayed within this branch.\r\n   * @beta\r\n   */\r\n  public realityModelDisplaySettings?: RealityModelDisplaySettings;\r\n  /** @internal */\r\n  public realityModelRange?: Range3d;\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  /** Identifies the \"group\" to which this branch belongs.\r\n   * Groups represent cross-cutting subsets of a tile tree's contents.\r\n   * For example, if a tile tree contains geometry from multiple models, each model (or smaller groups of multiple models) could be considered a group.\r\n   * The top-level branches containing graphics from multiple tiles will each specify the group they represent, and the child branches within each\r\n   * tile will likewise specify the group to which they belong.\r\n   * When drawing, only the graphics within a tile that correlate with the current group will be drawn.\r\n   * Groups cannot nest.\r\n   * @internal\r\n   */\r\n  public groupNodeId?: 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  /** The Id of the [ViewAttachment]($backend) from which this branch's graphics originated.\r\n   * @internal\r\n   */\r\n  viewAttachmentId?: Id64String;\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/** @internal */\r\nexport function formatAnimationBranchId(modelId: Id64String, branchId: number): string {\r\n  if (branchId < 0)\r\n    return modelId;\r\n\r\n  return `${modelId}_Node_${branchId.toString()}`;\r\n}\r\n\r\nfunction addAnimationBranch(modelId: Id64String, timeline: RenderSchedule.Timeline, branchId: number, branches: Map<string, AnimationBranchState>, time: number): void {\r\n  const clipVector = timeline.getClipVector(time);\r\n  const clip = clipVector ? IModelApp.renderSystem.createClipVolume(clipVector) : undefined;\r\n  if (clip)\r\n    branches.set(formatAnimationBranchId(modelId, branchId), { clip });\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\r\n/** @internal */\r\nexport namespace AnimationBranchStates {\r\n  export function fromScript(script: RenderSchedule.Script, time: number): AnimationBranchStates | undefined {\r\n    if (!script.containsModelClipping && !script.requiresBatching)\r\n      return undefined;\r\n\r\n    const branches = new Map<string, AnimationBranchState>();\r\n    for (const model of script.modelTimelines) {\r\n      addAnimationBranch(model.modelId, model, -1, branches, time);\r\n      for (const elem of model.elementTimelines) {\r\n        if (elem.getVisibility(time) <= 0)\r\n          branches.set(formatAnimationBranchId(model.modelId, elem.batchId), { omit: true });\r\n        else\r\n          addAnimationBranch(model.modelId, elem, elem.batchId, branches, time);\r\n      }\r\n    }\r\n\r\n    return {\r\n      branchStates: branches,\r\n      transformNodeIds: script.transformBatchIds,\r\n    };\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"GraphicBranch.js","sourceRoot":"","sources":["../../../src/render/GraphicBranch.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4E;AAK5E,4CAAyC;AAqBzC;;;;;;;GAOG;AACH,MAAa,aAAa;IAqCxB;;OAEG;IACH,YAAmB,cAAuB,KAAK;QAvC/C,qCAAqC;QACrB,YAAO,GAAoB,EAAE,CAAC;QAG9C;;WAEG;QACI,sBAAiB,GAAsB,EAAE,CAAC;QAiC/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,IAAA,2BAAY,EAAC,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;AA1FD,sCA0FC;AA4CD,gBAAgB;AAChB,SAAgB,uBAAuB,CAAC,OAAmB,EAAE,QAAgB;IAC3E,IAAI,QAAQ,GAAG,CAAC;QACd,OAAO,OAAO,CAAC;IAEjB,OAAO,GAAG,OAAO,SAAS,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC;AAClD,CAAC;AALD,0DAKC;AAED,SAAS,kBAAkB,CAAC,OAAmB,EAAE,QAAiC,EAAE,QAAgB,EAAE,QAA2C,EAAE,IAAY;IAC7J,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,qBAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1F,IAAI,IAAI;QACN,QAAQ,CAAC,GAAG,CAAC,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACvE,CAAC;AAYD,gBAAgB;AAChB,IAAiB,qBAAqB,CAqBrC;AArBD,WAAiB,qBAAqB;IACpC,SAAgB,UAAU,CAAC,MAA6B,EAAE,IAAY;QACpE,IAAI,CAAC,MAAM,CAAC,qBAAqB,IAAI,CAAC,MAAM,CAAC,gBAAgB;YAC3D,OAAO,SAAS,CAAC;QAEnB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAgC,CAAC;QACzD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;YAC1C,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC7D,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,gBAAgB,EAAE,CAAC;gBAC1C,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;oBAC/B,QAAQ,CAAC,GAAG,CAAC,uBAAuB,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;;oBAEnF,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;QAED,OAAO;YACL,YAAY,EAAE,QAAQ;YACtB,gBAAgB,EAAE,MAAM,CAAC,iBAAiB;SAC3C,CAAC;IACJ,CAAC;IAnBe,gCAAU,aAmBzB,CAAA;AACH,CAAC,EArBgB,qBAAqB,qCAArB,qBAAqB,QAqBrC","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 { disposeArray, Id64String, IDisposable } from \"@itwin/core-bentley\";\r\nimport {\r\n  FeatureAppearanceProvider, HiddenLine, RealityModelDisplaySettings, RenderSchedule, ViewFlagOverrides, ViewFlags,\r\n} from \"@itwin/core-common\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { IModelApp } from \"../IModelApp\";\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\nimport { Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { AnimationNodeId } from \"../common/internal/render/AnimationNodeId\";\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\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  /** Controls how reality models are displayed within this branch.\r\n   * @beta\r\n   */\r\n  public realityModelDisplaySettings?: RealityModelDisplaySettings;\r\n  /** @internal */\r\n  public realityModelRange?: Range3d;\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  /** Identifies the \"group\" to which this branch belongs.\r\n   * Groups represent cross-cutting subsets of a tile tree's contents.\r\n   * For example, if a tile tree contains geometry from multiple models, each model (or smaller groups of multiple models) could be considered a group.\r\n   * The top-level branches containing graphics from multiple tiles will each specify the group they represent, and the child branches within each\r\n   * tile will likewise specify the group to which they belong.\r\n   * When drawing, only the graphics within a tile that correlate with the current group will be drawn.\r\n   * Groups cannot nest.\r\n   * @internal\r\n   */\r\n  public groupNodeId?: 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  /** An optional transform from the coordinate system of [[iModel]] to those of a different [[IModelConnection]].\r\n   * This is used by [[AccuSnap]] when displaying one iModel in the context of another iModel (i.e., the iModel associated\r\n   * with the [[Viewport]]).\r\n   */\r\n  transformFromIModel?: Transform;\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  /** The Id of the [ViewAttachment]($backend) from which this branch's graphics originated.\r\n   * @internal\r\n   */\r\n  viewAttachmentId?: Id64String;\r\n  /** If true, the view's [DisplayStyleSettings.clipStyle]($common) will be disabled for this branch.\r\n   * No [ClipStyle.insideColor]($common), [ClipStyle.outsideColor]($common), or [ClipStyle.intersectionStyle]($common) will be applied.\r\n   */\r\n  disableClipStyle?: true;\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/** @internal */\r\nexport function formatAnimationBranchId(modelId: Id64String, branchId: number): string {\r\n  if (branchId < 0)\r\n    return modelId;\r\n\r\n  return `${modelId}_Node_${branchId.toString()}`;\r\n}\r\n\r\nfunction addAnimationBranch(modelId: Id64String, timeline: RenderSchedule.Timeline, branchId: number, branches: Map<string, AnimationBranchState>, time: number): void {\r\n  const clipVector = timeline.getClipVector(time);\r\n  const clip = clipVector ? IModelApp.renderSystem.createClipVolume(clipVector) : undefined;\r\n  if (clip)\r\n    branches.set(formatAnimationBranchId(modelId, branchId), { clip });\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\r\n/** @internal */\r\nexport namespace AnimationBranchStates {\r\n  export function fromScript(script: RenderSchedule.Script, time: number): AnimationBranchStates | undefined {\r\n    if (!script.containsModelClipping && !script.requiresBatching)\r\n      return undefined;\r\n\r\n    const branches = new Map<string, AnimationBranchState>();\r\n    for (const model of script.modelTimelines) {\r\n      addAnimationBranch(model.modelId, model, -1, branches, time);\r\n      for (const elem of model.elementTimelines) {\r\n        if (elem.getVisibility(time) <= 0)\r\n          branches.set(formatAnimationBranchId(model.modelId, elem.batchId), { omit: true });\r\n        else\r\n          addAnimationBranch(model.modelId, elem, elem.batchId, branches, time);\r\n      }\r\n    }\r\n\r\n    return {\r\n      branchStates: branches,\r\n      transformNodeIds: script.transformBatchIds,\r\n    };\r\n  }\r\n}\r\n"]}

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

@@ -9,6 +9,7 @@ import { RenderGraphic } from "./RenderGraphic";
 import { GraphicType } from "../common/render/GraphicType";
 import type { PickableGraphicOptions } from "../common/render/BatchOptions";
 import { GraphicAssembler } from "../common/render/GraphicAssembler";
+import { GraphicTemplate } from "./GraphicTemplate";
 /** 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]].
@@ -67,7 +68,7 @@ export interface ViewportGraphicBuilderOptions extends GraphicBuilderOptions {
     iModel?: never;
     computeChordTolerance?: never;
 }
-/** Arguments used to compute the chord tolerance (level of detail) of the [[RenderGraphic]]s produced by a [[GraphicBuilder]].
+/** Arguments used to compute the chord tolerance (level of detail) of the [[RenderGraphic]] or [[GraphicTemplate]] produced by a [[GraphicBuilder]].
  * 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.
  * For [[GraphicType.ViewOverlay]] and [[GraphicType.ViewBackground]], which already define their geometry in pixels, the chord tolerance should typically be 1.
  * @see [[CustomGraphicBuilderOptions.computeChordTolerance]].
@@ -80,7 +81,7 @@ export interface ComputeChordToleranceArgs {
     /** A function that computes a range enclosing all of the geometry that was added to the builder. */
     readonly computeRange: () => Range3d;
 }
-/** Options for creating a [[GraphicBuilder]] to produce a [[RenderGraphic]] that is not associated with any particular [[Viewport]] and may not be associated with
+/** Options for creating a [[GraphicBuilder]] to produce a [[RenderGraphic]] or [[GraphicTemplate]] that is not associated with any particular [[Viewport]] and may not be associated with
  * any particular [[IModelConnection]].
  * 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).
@@ -95,7 +96,7 @@ export interface CustomGraphicBuilderOptions extends GraphicBuilderOptions {
     applyAspectRatioSkew?: never;
     viewport?: never;
 }
-/** Provides methods for constructing a [[RenderGraphic]] from geometric primitives and symbology.
+/** Provides methods for constructing a [[RenderGraphic]] or [[GraphicTemplate]] from geometric primitives and symbology.
  * GraphicBuilder is primarily used for creating [[Decorations]] to be displayed inside a [[Viewport]].
  *
  * The typical process for constructing a [[RenderGraphic]] proceeds as follows:
@@ -104,6 +105,12 @@ export interface CustomGraphicBuilderOptions extends GraphicBuilderOptions {
  *  3. Add one or more geometric primitives using methods like [[GraphicBuilder.addShape]] and [[GraphicBuilder.addLineString]], possibly setting new symbology in between.
  *  4. Use [[GraphicBuilder.finish]] to produce the finished [[RenderGraphic]].
  *
+ * The process for constructing a [[GraphicTemplate]] is similar:
+ *  1. Use [[RenderSystem.createGraphic]] to obtain a builder.
+ *  2. Set up the symbology using [[GraphicBuilder.activateGraphicParams]] or [[GraphicBuilder.setSymbology]].
+ *  3. Add one or more geometric primitives using methods like [[GraphicBuilder.addShape]] and [[GraphicBuilder.addLineString]], possibly setting new symbology in between.
+ *  4. Use [[GraphicBuilder.finishTemplate]] to produce the finished [[GraphicTemplate]].
+ *
  * @note Most of the methods which add geometry to the builder take ownership of their inputs rather than cloning them.
  * So, for example, if you pass an array of points to addLineString(), you should not subsequently modify that array.
  *
@@ -125,7 +132,14 @@ export declare abstract class GraphicBuilder extends GraphicAssembler {
     /**
      * Processes the accumulated symbology and geometry to produce a renderable graphic.
      * This function can only be called once; after the [[RenderGraphic]] has been extracted the [[GraphicBuilder]] should no longer be used.
+     * @see [[finishTemplate]] to obtain a [[GraphicTemplate]] instead.
      */
     abstract finish(): RenderGraphic;
+    /** Processes the accumulated symbology and geometry to produce a reusable template for a [[RenderGraphic]].
+     * This function can only be called once; after the [[GraphicTemplate]] has been extracted the [[GraphicBuilder]] should no longer be used.
+     * @see [[finish]] to obtain a [[RenderGraphic]] instead.
+     * @beta
+     */
+    abstract finishTemplate(): GraphicTemplate;
 }
 //# sourceMappingURL=GraphicBuilder.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"GraphicBuilder.d.ts","sourceRoot":"","sources":["../../../src/render/GraphicBuilder.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,EAAE,sBAAsB,EAAC,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAGrE;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,sCAAsC;IACtC,IAAI,EAAE,WAAW,CAAC;IAElB,yHAAyH;IACzH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,qFAAqF;IACrF,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E,4EAA4E;IAC5E,QAAQ,EAAE,QAAQ,CAAC;IAEnB,yIAAyI;IACzI,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,qBAAqB,CAAC,EAAE,KAAK,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,oGAAoG;IACpG,QAAQ,CAAC,YAAY,EAAE,MAAM,OAAO,CAAC;CACtC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,6EAA6E;IAC7E,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,gGAAgG;IAChG,qBAAqB,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,MAAM,CAAC;IAEnE,oBAAoB,CAAC,EAAE,KAAK,CAAC;IAC7B,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,cAAe,SAAQ,gBAAgB;IAC3D,uDAAuD;IACvD,SAAgB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1C,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,MAAM,CAAC;IAEvF,gBAAgB;IAChB,SAAS,aAAa,OAAO,EAAE,6BAA6B,GAAG,2BAA2B;IAuC1F;;;OAGG;IACH,IAAW,MAAM,IAAI,UAAU,GAAG,SAAS,CAE1C;IAED;;;OAGG;aACa,MAAM,IAAI,aAAa;CACxC"}
+{"version":3,"file":"GraphicBuilder.d.ts","sourceRoot":"","sources":["../../../src/render/GraphicBuilder.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,EAAE,sBAAsB,EAAC,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAErE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;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;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,cAAe,SAAQ,gBAAgB;IAC3D,uDAAuD;IACvD,SAAgB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1C,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,MAAM,CAAC;IAEvF,gBAAgB;IAChB,SAAS,aAAa,OAAO,EAAE,6BAA6B,GAAG,2BAA2B;IAuC1F;;;OAGG;IACH,IAAW,MAAM,IAAI,UAAU,GAAG,SAAS,CAE1C;IAED;;;;OAIG;aACa,MAAM,IAAI,aAAa;IAEvC;;;;OAIG;aACa,cAAc,IAAI,eAAe;CAClD"}

package/lib/cjs/render/GraphicBuilder.js

@@ -12,7 +12,7 @@ const core_geometry_1 = require("@itwin/core-geometry");
 const GraphicType_1 = require("../common/render/GraphicType");
 const GraphicAssembler_1 = require("../common/render/GraphicAssembler");
 const Symbols_1 = require("../common/internal/Symbols");
-/** Provides methods for constructing a [[RenderGraphic]] from geometric primitives and symbology.
+/** Provides methods for constructing a [[RenderGraphic]] or [[GraphicTemplate]] from geometric primitives and symbology.
  * GraphicBuilder is primarily used for creating [[Decorations]] to be displayed inside a [[Viewport]].
  *
  * The typical process for constructing a [[RenderGraphic]] proceeds as follows:
@@ -21,6 +21,12 @@ const Symbols_1 = require("../common/internal/Symbols");
  *  3. Add one or more geometric primitives using methods like [[GraphicBuilder.addShape]] and [[GraphicBuilder.addLineString]], possibly setting new symbology in between.
  *  4. Use [[GraphicBuilder.finish]] to produce the finished [[RenderGraphic]].
  *
+ * The process for constructing a [[GraphicTemplate]] is similar:
+ *  1. Use [[RenderSystem.createGraphic]] to obtain a builder.
+ *  2. Set up the symbology using [[GraphicBuilder.activateGraphicParams]] or [[GraphicBuilder.setSymbology]].
+ *  3. Add one or more geometric primitives using methods like [[GraphicBuilder.addShape]] and [[GraphicBuilder.addLineString]], possibly setting new symbology in between.
+ *  4. Use [[GraphicBuilder.finishTemplate]] to produce the finished [[GraphicTemplate]].
+ *
  * @note Most of the methods which add geometry to the builder take ownership of their inputs rather than cloning them.
  * So, for example, if you pass an array of points to addLineString(), you should not subsequently modify that array.
  *

package/lib/cjs/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,wDAAmE;AAInE,8DAA2D;AAE3D,wEAAqE;AACrE,wDAAuE;AAqGvE;;;;;;;;;;;;;;GAcG;AACH,MAAsB,cAAe,SAAQ,mCAAgB;IAO3D,gBAAgB;IAChB,YAAsB,OAAoE;QACxF,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC5B,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,yBAAS,CAAC,cAAc,EAAE,CAAC;QAClE,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,KAAK,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;QACzH,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,KAAK,CAAC,CAAC;QAC7F,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,WAAW,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,YAAY,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,cAAc,CAAC,CAAC;QAEtL,KAAK,CAAC;YACJ,GAAG,OAAO;YACV,CAAC,mCAAyB,CAAC,EAAE,SAAS;YACtC,SAAS;YACT,SAAS;YACT,WAAW;YACX,aAAa;SACd,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YACtB,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC;YAC5D,OAAO;QACT,CAAC;QAED,IAAI,CAAC,sBAAsB,GAAG,CAAC,IAA+B,EAAE,EAAE;YAChE,IAAI,SAAS,GAAG,CAAC,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC5B,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;YACtB,CAAC;YAED,OAAO,SAAS,GAAG,IAAI,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC3B,CAAC;CAOF;AA5DD,wCA4DC","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 { Point3d, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { Viewport } from \"../Viewport\";\r\nimport { RenderGraphic } from \"./RenderGraphic\";\r\nimport { GraphicType } from \"../common/render/GraphicType\";\r\nimport type { PickableGraphicOptions} from \"../common/render/BatchOptions\";\r\nimport { GraphicAssembler } from \"../common/render/GraphicAssembler\";\r\nimport { _implementationProhibited } from \"../common/internal/Symbols\";\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 and symbology.\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 extends GraphicAssembler {\r\n  /** The iModel associated with this builder, if any. */\r\n  public readonly iModel?: IModelConnection;\r\n\r\n  /** @internal */\r\n  protected readonly _computeChordTolerance: (args: ComputeChordToleranceArgs) => number;\r\n\r\n  /** @internal */\r\n  protected constructor(options: ViewportGraphicBuilderOptions | CustomGraphicBuilderOptions) {\r\n    const vp = options.viewport;\r\n    const placement = options.placement ?? Transform.createIdentity();\r\n    const wantEdges = options.generateEdges ?? (options.type === GraphicType.Scene && (!vp || vp.viewFlags.edgesRequired()));\r\n    const wantNormals = options.wantNormals ?? (wantEdges || options.type === GraphicType.Scene);\r\n    const preserveOrder = options.preserveOrder ?? (options.type === GraphicType.ViewOverlay || options.type === GraphicType.WorldOverlay || options.type === GraphicType.ViewBackground);\r\n\r\n    super({\r\n      ...options,\r\n      [_implementationProhibited]: undefined,\r\n      placement,\r\n      wantEdges,\r\n      wantNormals,\r\n      preserveOrder,\r\n    });\r\n\r\n    this.iModel = vp?.iModel ?? options.iModel;\r\n    if (!options.viewport) {\r\n      this._computeChordTolerance = options.computeChordTolerance;\r\n      return;\r\n    }\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 in 3.x. 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  /**\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"]}
+{"version":3,"file":"GraphicBuilder.js","sourceRoot":"","sources":["../../../src/render/GraphicBuilder.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAAmE;AAInE,8DAA2D;AAE3D,wEAAqE;AACrE,wDAAuE;AAsGvE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAsB,cAAe,SAAQ,mCAAgB;IAO3D,gBAAgB;IAChB,YAAsB,OAAoE;QACxF,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC5B,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,yBAAS,CAAC,cAAc,EAAE,CAAC;QAClE,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,KAAK,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;QACzH,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,KAAK,CAAC,CAAC;QAC7F,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,WAAW,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,YAAY,IAAI,OAAO,CAAC,IAAI,KAAK,yBAAW,CAAC,cAAc,CAAC,CAAC;QAEtL,KAAK,CAAC;YACJ,GAAG,OAAO;YACV,CAAC,mCAAyB,CAAC,EAAE,SAAS;YACtC,SAAS;YACT,SAAS;YACT,WAAW;YACX,aAAa;SACd,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YACtB,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC;YAC5D,OAAO;QACT,CAAC;QAED,IAAI,CAAC,sBAAsB,GAAG,CAAC,IAA+B,EAAE,EAAE;YAChE,IAAI,SAAS,GAAG,CAAC,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC5B,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;YACtB,CAAC;YAED,OAAO,SAAS,GAAG,IAAI,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC3B,CAAC;CAeF;AApED,wCAoEC","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 { Point3d, Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { Viewport } from \"../Viewport\";\r\nimport { RenderGraphic } from \"./RenderGraphic\";\r\nimport { GraphicType } from \"../common/render/GraphicType\";\r\nimport type { PickableGraphicOptions} from \"../common/render/BatchOptions\";\r\nimport { GraphicAssembler } from \"../common/render/GraphicAssembler\";\r\nimport { _implementationProhibited } from \"../common/internal/Symbols\";\r\nimport { GraphicTemplate } from \"./GraphicTemplate\";\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]] or [[GraphicTemplate]] 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]] or [[GraphicTemplate]] 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]] or [[GraphicTemplate]] from geometric primitives and symbology.\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 * The process for constructing a [[GraphicTemplate]] is similar:\r\n *  1. Use [[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.finishTemplate]] to produce the finished [[GraphicTemplate]].\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 extends GraphicAssembler {\r\n  /** The iModel associated with this builder, if any. */\r\n  public readonly iModel?: IModelConnection;\r\n\r\n  /** @internal */\r\n  protected readonly _computeChordTolerance: (args: ComputeChordToleranceArgs) => number;\r\n\r\n  /** @internal */\r\n  protected constructor(options: ViewportGraphicBuilderOptions | CustomGraphicBuilderOptions) {\r\n    const vp = options.viewport;\r\n    const placement = options.placement ?? Transform.createIdentity();\r\n    const wantEdges = options.generateEdges ?? (options.type === GraphicType.Scene && (!vp || vp.viewFlags.edgesRequired()));\r\n    const wantNormals = options.wantNormals ?? (wantEdges || options.type === GraphicType.Scene);\r\n    const preserveOrder = options.preserveOrder ?? (options.type === GraphicType.ViewOverlay || options.type === GraphicType.WorldOverlay || options.type === GraphicType.ViewBackground);\r\n\r\n    super({\r\n      ...options,\r\n      [_implementationProhibited]: undefined,\r\n      placement,\r\n      wantEdges,\r\n      wantNormals,\r\n      preserveOrder,\r\n    });\r\n\r\n    this.iModel = vp?.iModel ?? options.iModel;\r\n    if (!options.viewport) {\r\n      this._computeChordTolerance = options.computeChordTolerance;\r\n      return;\r\n    }\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 in 3.x. 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  /**\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   * @see [[finishTemplate]] to obtain a [[GraphicTemplate]] instead.\r\n   */\r\n  public abstract finish(): RenderGraphic;\r\n\r\n  /** Processes the accumulated symbology and geometry to produce a reusable template for a [[RenderGraphic]].\r\n   * This function can only be called once; after the [[GraphicTemplate]] has been extracted the [[GraphicBuilder]] should no longer be used.\r\n   * @see [[finish]] to obtain a [[RenderGraphic]] instead.\r\n   * @beta\r\n   */\r\n  public abstract finishTemplate(): GraphicTemplate;\r\n}\r\n"]}

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

@@ -0,0 +1,76 @@
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { Range3d, Transform } from "@itwin/core-geometry";
+import { _batch, _branch, _implementationProhibited, _nodes } from "../common/internal/Symbols";
+import { RenderGeometry } from "../internal/render/RenderGeometry";
+import { RenderFeatureTable, ViewFlagOverrides } from "@itwin/core-common";
+import { InstancedGraphicParams } from "../common/render/InstancedGraphicParams";
+import { BatchOptions } from "../common/render/BatchOptions";
+/** @internal */
+export interface GraphicTemplateNode {
+    geometry: RenderGeometry[];
+    /** For glTF models, the flattened transform of the scene graph node. */
+    transform?: Transform;
+    /** For glTF models, the instances associated with the scene graph node, or with the model as a whole. */
+    instances?: InstancedGraphicParams;
+}
+/** Describes the collection of $[Feature]($common)s in a [[GraphicTemplate]].
+ * If the template is used for instancing, the batch information in the [[RenderInstances]] overrides this.
+ * @internal
+ */
+export interface GraphicTemplateBatch {
+    readonly featureTable: RenderFeatureTable;
+    readonly options?: BatchOptions;
+    readonly range: Range3d;
+}
+/** Applies a transform and/or view flag overrides to all of the nodes in a [[GraphicTemplate]].
+ * @internal
+ */
+export interface GraphicTemplateBranch {
+    readonly transform?: Transform;
+    readonly viewFlagOverrides?: ViewFlagOverrides;
+}
+/** A reusable representation of a [[RenderGraphic]].
+ * You can use [[RenderSystem.createGraphicFromTemplate]] to produce a [[RenderGraphic]] from a template.
+ * The template contains all of the WebGL resources required to render the graphics, so no matter how many times you use the template,
+ * no additional GPU resources will be allocated.
+ * The primary use for a template is [instanced rendering](https://webglfundamentals.org/webgl/lessons/webgl-instanced-drawing.html) - efficiently
+ * drawing many repetitions of the same graphic with different positions, scales, rotations, and symbology.
+ * Using instancing to draw 1 template N times is far more efficient than drawing N [[RenderGraphic]]s created from the same template.
+ * You can instance a template by supplying a [[RenderInstances]] to [[RenderSystem.createGraphicFromTemplate]], unless [[isInstanceable]] is `false`.
+ * @see [[GraphicBuilder.finishTemplate]] to create a template from a [[GraphicBuilder]].
+ * @see [[RenderSystem.createTemplateFromDescription]] to create a template from a [[GraphicDescription]].
+ * @see [[readGltfTemplate]] to create a template from a glTF model.
+ * @beta
+ */
+export interface GraphicTemplate {
+    /** @internal */
+    readonly [_implementationProhibited]: unknown;
+    /** Whether the graphics in this template can be instanced. Non-instanceable graphics include those produced from glTF models that already
+     * contain instanced geometry and view-independent geometry created from a [[GraphicBuilder]].
+     * [[RenderSystem.createGraphicFromTemplate]] will throw an error if you attempt to instance a non-instanceable template by supplying
+     * [[CreateGraphicFromTemplateArgs.instances]].
+     */
+    readonly isInstanceable: boolean;
+    /** @internal */
+    readonly [_nodes]: GraphicTemplateNode[];
+    /** @internal */
+    readonly [_batch]?: GraphicTemplateBatch;
+    /** @internal */
+    readonly [_branch]?: GraphicTemplateBranch;
+}
+/** Create a GraphicTemplate.
+ * If the caller specifies `noDispose` as `true`, every RenderGeometry in every node will be marked `noDispose`;
+ * this permits the same template to be reused by multiple graphics. The garbage collector will reclaim its
+ * WebGL resources and its `dispose` method will do nothing.
+ * The `isInstancable` flag will be calculated from the nodes and their geometry.
+ * @internal
+ */
+export declare function createGraphicTemplate(args: {
+    nodes: GraphicTemplateNode[];
+    batch?: GraphicTemplateBatch;
+    noDispose: boolean;
+    branch?: GraphicTemplateBranch;
+}): GraphicTemplate;
+//# sourceMappingURL=GraphicTemplate.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"GraphicTemplate.d.ts","sourceRoot":"","sources":["../../../src/render/GraphicTemplate.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAyB,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,wEAAwE;IACxE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,yGAAyG;IACzG,SAAS,CAAC,EAAE,sBAAsB,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC;IAC1C,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CAChD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,QAAQ,CAAC,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAE9C;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IAEjC,gBAAgB;IAChB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACzC,gBAAgB;IAChB,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,oBAAoB,CAAC;IACzC,gBAAgB;IAChB,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,qBAAqB,CAAC;CAC5C;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE;IAC1C,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAChC,GAAG,eAAe,CAsBlB"}