@itwin/core-frontend 4.10.0-dev.3 → 4.10.0-dev.6

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/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"}

package/lib/cjs/render/GraphicTemplate.js

@@ -0,0 +1,41 @@
+"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 });
+exports.createGraphicTemplate = void 0;
+const Symbols_1 = require("../common/internal/Symbols");
+/** 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
+ */
+function createGraphicTemplate(args) {
+    let isInstanceable = true;
+    for (const node of args.nodes) {
+        if (node.instances) {
+            isInstanceable = false;
+        }
+        for (const geometry of node.geometry) {
+            geometry.noDispose = args.noDispose;
+            if (!geometry.isInstanceable) {
+                isInstanceable = false;
+            }
+        }
+    }
+    return {
+        [Symbols_1._implementationProhibited]: undefined,
+        isInstanceable,
+        [Symbols_1._nodes]: args.nodes,
+        [Symbols_1._batch]: args.batch,
+        [Symbols_1._branch]: args.branch,
+    };
+}
+exports.createGraphicTemplate = createGraphicTemplate;
+//# sourceMappingURL=GraphicTemplate.js.map

package/lib/cjs/render/GraphicTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphicTemplate.js","sourceRoot":"","sources":["../../../src/render/GraphicTemplate.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAAgG;AAiEhG;;;;;;GAMG;AACH,SAAgB,qBAAqB,CAAC,IAKrC;IACC,IAAI,cAAc,GAAG,IAAI,CAAC;IAC1B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,cAAc,GAAG,KAAK,CAAC;QACzB,CAAC;QAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACrC,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;gBAC7B,cAAc,GAAG,KAAK,CAAC;YACzB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,CAAC,mCAAyB,CAAC,EAAE,SAAS;QACtC,cAAc;QACd,CAAC,gBAAM,CAAC,EAAE,IAAI,CAAC,KAAK;QACpB,CAAC,gBAAM,CAAC,EAAE,IAAI,CAAC,KAAK;QACpB,CAAC,iBAAO,CAAC,EAAE,IAAI,CAAC,MAAM;KACvB,CAAC;AACJ,CAAC;AA3BD,sDA2BC","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 { Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { _batch, _branch, _implementationProhibited, _nodes } from \"../common/internal/Symbols\";\r\nimport { RenderGeometry } from \"../internal/render/RenderGeometry\";\r\nimport { RenderFeatureTable, ViewFlagOverrides } from \"@itwin/core-common\";\r\nimport { InstancedGraphicParams } from \"../common/render/InstancedGraphicParams\";\r\nimport { BatchOptions } from \"../common/render/BatchOptions\";\r\n\r\n/** @internal */\r\nexport interface GraphicTemplateNode {\r\n  geometry: RenderGeometry[];\r\n  /** For glTF models, the flattened transform of the scene graph node. */\r\n  transform?: Transform;\r\n  /** For glTF models, the instances associated with the scene graph node, or with the model as a whole. */\r\n  instances?: InstancedGraphicParams;\r\n}\r\n\r\n/** Describes the collection of $[Feature]($common)s in a [[GraphicTemplate]].\r\n * If the template is used for instancing, the batch information in the [[RenderInstances]] overrides this.\r\n * @internal\r\n */\r\nexport interface GraphicTemplateBatch {\r\n  readonly featureTable: RenderFeatureTable;\r\n  readonly options?: BatchOptions;\r\n  readonly range: Range3d;\r\n}\r\n\r\n/** Applies a transform and/or view flag overrides to all of the nodes in a [[GraphicTemplate]].\r\n * @internal\r\n */\r\nexport interface GraphicTemplateBranch {\r\n  readonly transform?: Transform;\r\n  readonly viewFlagOverrides?: ViewFlagOverrides;\r\n}\r\n\r\n/** A reusable representation of a [[RenderGraphic]].\r\n * You can use [[RenderSystem.createGraphicFromTemplate]] to produce a [[RenderGraphic]] from a template.\r\n * The template contains all of the WebGL resources required to render the graphics, so no matter how many times you use the template,\r\n * no additional GPU resources will be allocated.\r\n * The primary use for a template is [instanced rendering](https://webglfundamentals.org/webgl/lessons/webgl-instanced-drawing.html) - efficiently\r\n * drawing many repetitions of the same graphic with different positions, scales, rotations, and symbology.\r\n * Using instancing to draw 1 template N times is far more efficient than drawing N [[RenderGraphic]]s created from the same template.\r\n * You can instance a template by supplying a [[RenderInstances]] to [[RenderSystem.createGraphicFromTemplate]], unless [[isInstanceable]] is `false`.\r\n * @see [[GraphicBuilder.finishTemplate]] to create a template from a [[GraphicBuilder]].\r\n * @see [[RenderSystem.createTemplateFromDescription]] to create a template from a [[GraphicDescription]].\r\n * @see [[readGltfTemplate]] to create a template from a glTF model.\r\n * @beta\r\n */\r\nexport interface GraphicTemplate {\r\n  /** @internal */\r\n  readonly [_implementationProhibited]: unknown;\r\n\r\n  /** Whether the graphics in this template can be instanced. Non-instanceable graphics include those produced from glTF models that already\r\n   * contain instanced geometry and view-independent geometry created from a [[GraphicBuilder]].\r\n   * [[RenderSystem.createGraphicFromTemplate]] will throw an error if you attempt to instance a non-instanceable template by supplying\r\n   * [[CreateGraphicFromTemplateArgs.instances]].\r\n   */\r\n  readonly isInstanceable: boolean;\r\n\r\n  /** @internal */\r\n  readonly [_nodes]: GraphicTemplateNode[];\r\n  /** @internal */\r\n  readonly [_batch]?: GraphicTemplateBatch;\r\n  /** @internal */\r\n  readonly [_branch]?: GraphicTemplateBranch;\r\n}\r\n\r\n/** Create a GraphicTemplate.\r\n * If the caller specifies `noDispose` as `true`, every RenderGeometry in every node will be marked `noDispose`;\r\n * this permits the same template to be reused by multiple graphics. The garbage collector will reclaim its\r\n * WebGL resources and its `dispose` method will do nothing.\r\n * The `isInstancable` flag will be calculated from the nodes and their geometry.\r\n * @internal\r\n */\r\nexport function createGraphicTemplate(args: {\r\n  nodes: GraphicTemplateNode[];\r\n  batch?: GraphicTemplateBatch;\r\n  noDispose: boolean;\r\n  branch?: GraphicTemplateBranch;\r\n}): GraphicTemplate {\r\n  let isInstanceable = true;\r\n  for (const node of args.nodes) {\r\n    if (node.instances) {\r\n      isInstanceable = false;\r\n    }\r\n\r\n    for (const geometry of node.geometry) {\r\n      geometry.noDispose = args.noDispose;\r\n      if (!geometry.isInstanceable) {\r\n        isInstanceable = false;\r\n      }\r\n    }\r\n  }\r\n\r\n  return {\r\n    [_implementationProhibited]: undefined,\r\n    isInstanceable,\r\n    [_nodes]: args.nodes,\r\n    [_batch]: args.batch,\r\n    [_branch]: args.branch,\r\n  };\r\n}\r\n"]}

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

@@ -1,4 +1,4 @@
-import { Transform } from "@itwin/core-geometry";
+import { Range3d, Transform } from "@itwin/core-geometry";
 import { ElementAlignedBox3d, RenderFeatureTable } from "@itwin/core-common";
 import { IModelAppOptions } from "../IModelApp";
 import { IModelConnection } from "../IModelConnection";
@@ -15,10 +15,11 @@ import { PointCloudArgs } from "../common/internal/render/PointCloudPrimitive";
 import { GraphicList, RenderGraphic } from "./RenderGraphic";
 import { RenderMemory } from "./RenderMemory";
 import { RenderPlan } from "./RenderPlan";
-import { RenderAreaPattern, RenderGeometry, RenderSystem } from "./RenderSystem";
+import { RenderAreaPattern, RenderSystem } from "./RenderSystem";
 import { RenderTarget } from "./RenderTarget";
 import { Scene } from "./Scene";
 import { _implementationProhibited } from "../common/internal/Symbols";
+import { RenderGeometry } from "../internal/render/RenderGeometry";
 /** Contains extensible mock implementations of the various components of a RenderSystem, intended for use in tests.
  * Use these for tests instead of the default RenderSystem wherever possible because:
  *  (1) Electron has a bug on Windows in which it fails to obtain a WebGLRenderingContext when running inside a VM (e.g., during CI job); and
@@ -96,11 +97,18 @@ export declare namespace MockRender {
     }
     /** @internal */
     class Geometry implements RenderGeometry {
+        readonly renderGeometryType: "mesh" | "polyline" | "point-string";
+        noDispose: boolean;
+        readonly isInstanceable = true;
+        isDisposed: boolean;
+        constructor(renderGeometryType: "mesh" | "polyline" | "point-string");
         dispose(): void;
         collectStatistics(): void;
+        computeRange(): Range3d;
     }
     /** @internal */
     class AreaPattern implements RenderAreaPattern {
+        readonly [_implementationProhibited] = "renderAreaPattern";
         dispose(): void;
         collectStatistics(): void;
     }
@@ -136,6 +144,8 @@ export declare namespace MockRender {
         createPointStringGeometry(): Geometry;
         /** @internal */
         createAreaPattern(): AreaPattern;
+        /** @internal */
+        createGraphicFromTemplate(): Graphic;
     }
     type SystemFactory = () => RenderSystem;
     /** An implementation of IModelApp which uses a MockRender.System by default. */

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

@@ -1 +1 @@
-{"version":3,"file":"MockRender.d.ts","sourceRoot":"","sources":["../../../src/render/MockRender.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAqB,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAChG,OAAO,EAAa,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,cAAc,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAC;AAC9G,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,+CAA+C,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAEvE;;;;;;;;;;;GAWG;AACH,yBAAiB,UAAU,CAAC;IAC1B,gBAAgB;IAChB,eAAsB,MAAO,SAAQ,YAAY;QAGzB,OAAO,CAAC,QAAQ,CAAC,OAAO;QAF9C,mBAA4B,CAAC,yBAAyB,CAAC,YAAa;QAEpE,SAAS,aAA8B,OAAO,EAAE,YAAY;QAE5D,IAAW,YAAY,IAAI,YAAY,CAAyB;QAChE,IAAW,yBAAyB,YAAoB;QACxD,IAAW,gBAAgB,IACY,MAAM,CADF;QAC3C,IAAW,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAK;QAC3C,WAAW,CAAC,MAAM,EAAE,KAAK;QACzB,cAAc,CAAC,SAAS,CAAC,EAAE,WAAW;QACtC,iBAAiB,CAAC,KAAK,EAAE,WAAW;QACpC,gBAAgB,CAAC,KAAK,EAAE,UAAU;QAClC,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM;QAC7B,cAAc;QACd,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,oBAAoB,EAAE,OAAO;QACrH,IAAW,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAe;QAChE,IAAW,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAK;KAC9D;IAED,gBAAgB;IAChB,MAAa,cAAe,SAAQ,MAAM;QACC,OAAO,CAAC,QAAQ,CAAC,OAAO;oBAA9C,MAAM,EAAE,YAAY,EAAmB,OAAO,EAAE,iBAAiB;QAEpF,IAAW,QAAQ,aAAsF;QAClG,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO;KACnD;IAED,gBAAgB;IAChB,MAAa,eAAgB,SAAQ,MAAM;QACA,OAAO,CAAC,QAAQ,CAAC,SAAS;oBAAhD,MAAM,EAAE,YAAY,EAAmB,SAAS,EAAE,QAAQ;QAE7E,IAAW,QAAQ,aAA6B;QACzC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO;KAClD;IAED,gBAAgB;IAChB,MAAa,OAAQ,SAAQ,gBAAgB;oBACxB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,2BAA2B,GAAG,6BAA6B;KAGxG;IAED,MAAa,OAAQ,SAAQ,aAAa;;QAGjC,OAAO;QACP,iBAAiB,CAAC,MAAM,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;QACxD,UAAU;KAClB;IAED,MAAa,IAAK,SAAQ,OAAO;iBACI,QAAQ,EAAE,aAAa,EAAE;oBAAzB,QAAQ,EAAE,aAAa,EAAE;QAE5C,OAAO;KAMxB;IAED,MAAa,MAAO,SAAQ,OAAO;iBACE,MAAM,EAAE,aAAa;iBAAkB,SAAS,EAAE,SAAS;iBAAkB,OAAO,CAAC;oBAArF,MAAM,EAAE,aAAa,EAAkB,SAAS,EAAE,SAAS,EAAkB,OAAO,CAAC,kCAAsB;QAE9H,OAAO;KACxB;IAED,MAAa,KAAM,SAAQ,OAAO;iBACG,OAAO,EAAE,aAAa;iBAAkB,YAAY,EAAE,kBAAkB;iBAAkB,KAAK,EAAE,mBAAmB;oBAApH,OAAO,EAAE,aAAa,EAAkB,YAAY,EAAE,kBAAkB,EAAkB,KAAK,EAAE,mBAAmB;QAEvI,OAAO;KAGxB;IAED,gBAAgB;IAChB,MAAa,QAAS,YAAW,cAAc;QACtC,OAAO,IAAI,IAAI;QACf,iBAAiB,IAAI,IAAI;KACjC;IAED,gBAAgB;IAChB,MAAa,WAAY,YAAW,iBAAiB;QAC5C,OAAO,IAAI,IAAI;QACf,iBAAiB,IAAI,IAAI;KACjC;IAED,MAAa,MAAO,SAAQ,YAAY;QACtC,IAAW,OAAO,YAAmB;QAC9B,OAAO,IAAI,IAAI;QACtB,IAAoB,cAAc,WAAmB;;QAIrD,gBAAgB;QACA,UAAU,IAAI,OAAO;QAErC,gBAAgB;QACA,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,cAAc;QACvE,gBAAgB;QACA,qBAAqB,CAAC,IAAI,EAAE,QAAQ,GAAG,YAAY;QAEnD,aAAa,CAAC,OAAO,EAAE,2BAA2B,GAAG,6BAA6B,GAAG,cAAc;QAInG,iBAAiB,CAAC,UAAU,EAAE,aAAa,EAAE;QAC7C,mBAAmB,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,oBAAoB;QAC/F,WAAW,CAAC,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,kBAAkB,EAAE,KAAK,EAAE,mBAAmB;QAE5G,gBAAgB;QACA,UAAU,CAAC,OAAO,EAAE,UAAU;QAC9C,gBAAgB;QACA,cAAc,CAAC,OAAO,EAAE,cAAc;QACtD,gBAAgB;QACA,iBAAiB,CAAC,OAAO,EAAE,iBAAiB;QAC5D,gBAAgB;QACA,gBAAgB,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,gBAAgB;QACjE,mBAAmB;QAEnC,gBAAgB;QACA,kBAAkB;QAClC,gBAAgB;QACA,sBAAsB;QACtC,gBAAgB;QACA,yBAAyB;QACzC,gBAAgB;QACA,iBAAiB;KAClC;IAED,KAAY,aAAa,GAAG,MAAM,YAAY,CAAC;IAE/C,gFAAgF;IAChF,MAAa,GAAG;QACd,OAAc,aAAa,EAAE,aAAa,CAAyC;eAE/D,OAAO,CAAC,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;eAO/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;QAK7C,SAAS,CAAC,MAAM,CAAC,yBAAyB;KAC3C;CACF"}
+{"version":3,"file":"MockRender.d.ts","sourceRoot":"","sources":["../../../src/render/MockRender.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAqB,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAChG,OAAO,EAAa,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,cAAc,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAC;AAC9G,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,+CAA+C,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAEnE;;;;;;;;;;;GAWG;AACH,yBAAiB,UAAU,CAAC;IAC1B,gBAAgB;IAChB,eAAsB,MAAO,SAAQ,YAAY;QAGzB,OAAO,CAAC,QAAQ,CAAC,OAAO;QAF9C,mBAA4B,CAAC,yBAAyB,CAAC,YAAa;QAEpE,SAAS,aAA8B,OAAO,EAAE,YAAY;QAE5D,IAAW,YAAY,IAAI,YAAY,CAAyB;QAChE,IAAW,yBAAyB,YAAoB;QACxD,IAAW,gBAAgB,IACY,MAAM,CADF;QAC3C,IAAW,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAK;QAC3C,WAAW,CAAC,MAAM,EAAE,KAAK;QACzB,cAAc,CAAC,SAAS,CAAC,EAAE,WAAW;QACtC,iBAAiB,CAAC,KAAK,EAAE,WAAW;QACpC,gBAAgB,CAAC,KAAK,EAAE,UAAU;QAClC,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM;QAC7B,cAAc;QACd,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,oBAAoB,EAAE,OAAO;QACrH,IAAW,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAe;QAChE,IAAW,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAK;KAC9D;IAED,gBAAgB;IAChB,MAAa,cAAe,SAAQ,MAAM;QACC,OAAO,CAAC,QAAQ,CAAC,OAAO;oBAA9C,MAAM,EAAE,YAAY,EAAmB,OAAO,EAAE,iBAAiB;QAEpF,IAAW,QAAQ,aAAsF;QAClG,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO;KACnD;IAED,gBAAgB;IAChB,MAAa,eAAgB,SAAQ,MAAM;QACA,OAAO,CAAC,QAAQ,CAAC,SAAS;oBAAhD,MAAM,EAAE,YAAY,EAAmB,SAAS,EAAE,QAAQ;QAE7E,IAAW,QAAQ,aAA6B;QACzC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO;KAClD;IAED,gBAAgB;IAChB,MAAa,OAAQ,SAAQ,gBAAgB;oBACxB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,2BAA2B,GAAG,6BAA6B;KAGxG;IAED,MAAa,OAAQ,SAAQ,aAAa;;QAGjC,OAAO;QACP,iBAAiB,CAAC,MAAM,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI;QACxD,UAAU;KAClB;IAED,MAAa,IAAK,SAAQ,OAAO;iBACI,QAAQ,EAAE,aAAa,EAAE;oBAAzB,QAAQ,EAAE,aAAa,EAAE;QAE5C,OAAO;KAMxB;IAED,MAAa,MAAO,SAAQ,OAAO;iBACE,MAAM,EAAE,aAAa;iBAAkB,SAAS,EAAE,SAAS;iBAAkB,OAAO,CAAC;oBAArF,MAAM,EAAE,aAAa,EAAkB,SAAS,EAAE,SAAS,EAAkB,OAAO,CAAC,kCAAsB;QAE9H,OAAO;KACxB;IAED,MAAa,KAAM,SAAQ,OAAO;iBACG,OAAO,EAAE,aAAa;iBAAkB,YAAY,EAAE,kBAAkB;iBAAkB,KAAK,EAAE,mBAAmB;oBAApH,OAAO,EAAE,aAAa,EAAkB,YAAY,EAAE,kBAAkB,EAAkB,KAAK,EAAE,mBAAmB;QAEvI,OAAO;KAGxB;IAED,gBAAgB;IAChB,MAAa,QAAS,YAAW,cAAc;iBAIV,kBAAkB,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc;QAHpF,SAAS,UAAS;QACzB,SAAgB,cAAc,QAAQ;QAC/B,UAAU,UAAS;oBACS,kBAAkB,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc;QAGpF,OAAO,IAAI,IAAI;QACf,iBAAiB,IAAI,IAAI;QACzB,YAAY;KACpB;IAED,gBAAgB;IAChB,MAAa,WAAY,YAAW,iBAAiB;QACnD,SAAgB,CAAC,yBAAyB,CAAC,uBAAuB;QAC3D,OAAO,IAAI,IAAI;QACf,iBAAiB,IAAI,IAAI;KACjC;IAED,MAAa,MAAO,SAAQ,YAAY;QACtC,IAAW,OAAO,YAAmB;QAC9B,OAAO,IAAI,IAAI;QACtB,IAAoB,cAAc,WAAmB;;QAIrD,gBAAgB;QACA,UAAU,IAAI,OAAO;QAErC,gBAAgB;QACA,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,cAAc;QACvE,gBAAgB;QACA,qBAAqB,CAAC,IAAI,EAAE,QAAQ,GAAG,YAAY;QAEnD,aAAa,CAAC,OAAO,EAAE,2BAA2B,GAAG,6BAA6B,GAAG,cAAc;QAInG,iBAAiB,CAAC,UAAU,EAAE,aAAa,EAAE;QAC7C,mBAAmB,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,oBAAoB;QAC/F,WAAW,CAAC,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,kBAAkB,EAAE,KAAK,EAAE,mBAAmB;QAE5G,gBAAgB;QACA,UAAU,CAAC,OAAO,EAAE,UAAU;QAC9C,gBAAgB;QACA,cAAc,CAAC,OAAO,EAAE,cAAc;QACtD,gBAAgB;QACA,iBAAiB,CAAC,OAAO,EAAE,iBAAiB;QAC5D,gBAAgB;QACA,gBAAgB,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,gBAAgB;QACjE,mBAAmB;QAEnC,gBAAgB;QACA,kBAAkB;QAClC,gBAAgB;QACA,sBAAsB;QACtC,gBAAgB;QACA,yBAAyB;QACzC,gBAAgB;QACA,iBAAiB;QACjC,gBAAgB;QACA,yBAAyB;KAC1C;IAED,KAAY,aAAa,GAAG,MAAM,YAAY,CAAC;IAE/C,gFAAgF;IAChF,MAAa,GAAG;QACd,OAAc,aAAa,EAAE,aAAa,CAAyC;eAE/D,OAAO,CAAC,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;eAO/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;QAK7C,SAAS,CAAC,MAAM,CAAC,yBAAyB;KAC3C;CACF"}

package/lib/cjs/render/MockRender.js

@@ -9,6 +9,7 @@ exports.MockRender = void 0;
  * @module Utils
  */
 const core_bentley_1 = require("@itwin/core-bentley");
+const core_geometry_1 = require("@itwin/core-geometry");
 const core_common_1 = require("@itwin/core-common");
 const IModelApp_1 = require("../IModelApp");
 const ViewRect_1 = require("../common/ViewRect");
@@ -31,7 +32,7 @@ const Symbols_1 = require("../common/internal/Symbols");
  */
 var MockRender;
 (function (MockRender) {
-    var _a;
+    var _a, _b;
     /** @internal */
     class Target extends RenderTarget_1.RenderTarget {
         constructor(_system) {
@@ -125,15 +126,26 @@ var MockRender;
     MockRender.Batch = Batch;
     /** @internal */
     class Geometry {
-        dispose() { }
+        constructor(renderGeometryType) {
+            this.renderGeometryType = renderGeometryType;
+            this.noDispose = false;
+            this.isInstanceable = true;
+            this.isDisposed = false;
+        }
+        dispose() { this.isDisposed = true; }
         collectStatistics() { }
+        computeRange() { return new core_geometry_1.Range3d(); }
     }
     MockRender.Geometry = Geometry;
     /** @internal */
     class AreaPattern {
+        constructor() {
+            this[_b] = "renderAreaPattern";
+        }
         dispose() { }
         collectStatistics() { }
     }
+    _b = Symbols_1._implementationProhibited;
     MockRender.AreaPattern = AreaPattern;
     class System extends RenderSystem_1.RenderSystem {
         get isValid() { return true; }
@@ -162,13 +174,15 @@ var MockRender;
         createPointCloud(_args, _imodel) { return new Graphic(); }
         createRenderGraphic() { return new Graphic(); }
         /** @internal */
-        createMeshGeometry() { return new Geometry(); }
+        createMeshGeometry() { return new Geometry("mesh"); }
         /** @internal */
-        createPolylineGeometry() { return new Geometry(); }
+        createPolylineGeometry() { return new Geometry("polyline"); }
         /** @internal */
-        createPointStringGeometry() { return new Geometry(); }
+        createPointStringGeometry() { return new Geometry("point-string"); }
         /** @internal */
         createAreaPattern() { return new AreaPattern(); }
+        /** @internal */
+        createGraphicFromTemplate() { return new Graphic(); }
     }
     MockRender.System = System;
     /** An implementation of IModelApp which uses a MockRender.System by default. */

package/lib/cjs/render/MockRender.js.map

@@ -1 +1 @@
-{"version":3,"file":"MockRender.js","sourceRoot":"","sources":["../../../src/render/MockRender.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sDAA8C;AAE9C,oDAAgG;AAChG,4CAA2D;AAK3D,iDAA8C;AAK9C,0EAAuE;AAEvE,mDAA6D;AAG7D,iDAAiF;AACjF,iDAA8C;AAE9C,wDAAuE;AAEvE;;;;;;;;;;;GAWG;AACH,IAAiB,UAAU,CAyJ1B;AAzJD,WAAiB,UAAU;;IACzB,gBAAgB;IAChB,MAAsB,MAAO,SAAQ,2BAAY;QAG/C,YAAuC,OAAqB;YAAI,KAAK,EAAE,CAAC;YAAjC,YAAO,GAAP,OAAO,CAAc;YAFhC,QAA2B,GAAG,SAAS,CAAC;QAEK,CAAC;QAE1E,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAChE,IAAW,yBAAyB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;QACxD,IAAW,gBAAgB,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAW,gBAAgB,CAAC,SAAiB,IAAI,CAAC;QAC3C,WAAW,CAAC,MAAa,IAAI,CAAC;QAC9B,cAAc,CAAC,SAAuB,IAAI,CAAC;QAC3C,iBAAiB,CAAC,KAAkB,IAAI,CAAC;QACzC,gBAAgB,CAAC,KAAiB,IAAI,CAAC;QACvC,SAAS,CAAC,UAAmB,IAAI,CAAC;QAClC,cAAc,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;QAClC,UAAU,CAAC,KAAe,EAAE,SAAyB,EAAE,QAAwB,EAAE,oBAA6B,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/I,IAAW,kBAAkB,KAAuB,OAAO,EAAE,CAAC,CAAC,CAAC;QAChE,IAAW,kBAAkB,CAAC,QAA0B,IAAI,CAAC;KAC9D;SAjB8B,mCAAyB;IADlC,iBAAM,SAkB3B,CAAA;IAED,gBAAgB;IAChB,MAAa,cAAe,SAAQ,MAAM;QACxC,YAAmB,MAAoB,EAAmB,OAA0B;YAAI,KAAK,CAAC,MAAM,CAAC,CAAC;YAA5C,YAAO,GAAP,OAAO,CAAmB;QAAmB,CAAC;QAExG,IAAW,QAAQ,KAAK,OAAO,IAAI,mBAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAClG,WAAW,CAAC,KAAe,EAAE,KAAc,IAAI,CAAC;KACxD;IALY,yBAAc,iBAK1B,CAAA;IAED,gBAAgB;IAChB,MAAa,eAAgB,SAAQ,MAAM;QACzC,YAAmB,MAAoB,EAAmB,SAAmB;YAAI,KAAK,CAAC,MAAM,CAAC,CAAC;YAArC,cAAS,GAAT,SAAS,CAAU;QAAmB,CAAC;QAEjG,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,WAAW,CAAC,IAAc,EAAE,KAAc,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACrF;IALY,0BAAe,kBAK3B,CAAA;IAED,gBAAgB;IAChB,MAAa,OAAQ,SAAQ,mCAAgB;QAC3C,YAAmB,MAAc,EAAE,OAAoE;YACrG,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzB,CAAC;KACF;IAJY,kBAAO,UAInB,CAAA;IAED,MAAa,OAAQ,SAAQ,6BAAa;QACxC,gBAAuB,KAAK,EAAE,CAAC,CAAC,CAAC;QAE1B,OAAO,KAAK,CAAC;QACb,iBAAiB,CAAC,MAA+B,IAAU,CAAC;QAC5D,UAAU,KAAK,CAAC;KACxB;IANY,kBAAO,UAMnB,CAAA;IAED,MAAa,IAAK,SAAQ,OAAO;QAC/B,YAAmC,QAAyB;YAAI,KAAK,EAAE,CAAC;YAArC,aAAQ,GAAR,QAAQ,CAAiB;QAAa,CAAC;QAE1D,OAAO;YACrB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ;gBACjC,IAAA,sBAAO,EAAC,OAAO,CAAC,CAAC;YAEnB,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;QAC3B,CAAC;KACF;IATY,eAAI,OAShB,CAAA;IAED,MAAa,MAAO,SAAQ,OAAO;QACjC,YAAmC,MAAqB,EAAkB,SAAoB,EAAkB,OAA8B;YAAI,KAAK,EAAE,CAAC;YAAvH,WAAM,GAAN,MAAM,CAAe;YAAkB,cAAS,GAAT,SAAS,CAAW;YAAkB,YAAO,GAAP,OAAO,CAAuB;QAAa,CAAC;QAE5I,OAAO,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;KACrD;IAJY,iBAAM,SAIlB,CAAA;IAED,MAAa,KAAM,SAAQ,OAAO;QAChC,YAAmC,OAAsB,EAAkB,YAAgC,EAAkB,KAA0B;YAAI,KAAK,EAAE,CAAC;YAAhI,YAAO,GAAP,OAAO,CAAe;YAAkB,iBAAY,GAAZ,YAAY,CAAoB;YAAkB,UAAK,GAAL,KAAK,CAAqB;QAAa,CAAC;QAErJ,OAAO;YACrB,IAAA,sBAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;KACF;IANY,gBAAK,QAMjB,CAAA;IAED,gBAAgB;IAChB,MAAa,QAAQ;QACZ,OAAO,KAAW,CAAC;QACnB,iBAAiB,KAAW,CAAC;KACrC;IAHY,mBAAQ,WAGpB,CAAA;IAED,gBAAgB;IAChB,MAAa,WAAW;QACf,OAAO,KAAW,CAAC;QACnB,iBAAiB,KAAW,CAAC;KACrC;IAHY,sBAAW,cAGvB,CAAA;IAED,MAAa,MAAO,SAAQ,2BAAY;QACtC,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC9B,OAAO,KAAW,CAAC;QAC1B,IAAoB,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAErD,gBAAuB,KAAK,EAAE,CAAC,CAAC,CAAC;QAEjC,gBAAgB;QACA,UAAU,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;QAEvD,gBAAgB;QACA,YAAY,CAAC,MAAyB,IAAoB,OAAO,IAAI,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACpH,gBAAgB;QACA,qBAAqB,CAAC,IAAc,IAAkB,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAE/F,aAAa,CAAC,OAAoE;YAChG,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpC,CAAC;QAEe,iBAAiB,CAAC,UAA2B,IAAI,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC/E,mBAAmB,CAAC,MAAqB,EAAE,SAAoB,EAAE,OAA8B,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QACnJ,WAAW,CAAC,OAAsB,EAAE,QAA4B,EAAE,KAA0B,IAAI,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAE7J,gBAAgB;QACA,UAAU,CAAC,OAAmB,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QACzE,gBAAgB;QACA,cAAc,CAAC,OAAuB,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QACjF,gBAAgB;QACA,iBAAiB,CAAC,OAA0B,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QACvF,gBAAgB;QACA,gBAAgB,CAAC,KAAqB,EAAE,OAAyB,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QAC5F,mBAAmB,KAAK,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QAE/D,gBAAgB;QACA,kBAAkB,KAAK,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC/D,gBAAgB;QACA,sBAAsB,KAAK,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;QACnE,gBAAgB;QACA,yBAAyB,KAAK,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;QACtE,gBAAgB;QACA,iBAAiB,KAAK,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC;KAClE;IAzCY,iBAAM,SAyClB,CAAA;IAID,gFAAgF;IAChF,MAAa,GAAG;QAGP,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAuB;YACjD,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,+BAAiB,EAAE,CAAC;YACjE,MAAM,qBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAEM,MAAM,CAAC,KAAK,CAAC,QAAQ;YAC1B,IAAI,CAAC,aAAa,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,yBAAyB,EAAE,CAAC;YAC3D,MAAM,qBAAS,CAAC,QAAQ,EAAE,CAAC;QAC7B,CAAC;QAES,MAAM,CAAC,yBAAyB,KAAK,OAAO,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC;;IAdvD,iBAAa,GAAkB,GAAG,EAAE,CAAC,GAAG,CAAC,yBAAyB,EAAE,CAAC;IADxE,cAAG,MAgBf,CAAA;AACH,CAAC,EAzJgB,UAAU,0BAAV,UAAU,QAyJ1B","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\r\n/** @packageDocumentation\r\n * @module Utils\r\n */\r\n\r\nimport { dispose } from \"@itwin/core-bentley\";\r\nimport { Transform } from \"@itwin/core-geometry\";\r\nimport { ElementAlignedBox3d, EmptyLocalization, RenderFeatureTable } from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions } from \"../IModelApp\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { MeshParams } from \"../common/internal/render/MeshParams\";\r\nimport { PointStringParams } from \"../common/internal/render/PointStringParams\";\r\nimport { PolylineParams } from \"../common/internal/render/PolylineParams\";\r\nimport { ViewRect } from \"../common/ViewRect\";\r\nimport { Decorations } from \"./Decorations\";\r\nimport { GraphicBranch, GraphicBranchOptions } from \"./GraphicBranch\";\r\nimport { CustomGraphicBuilderOptions, GraphicBuilder, ViewportGraphicBuilderOptions } from \"./GraphicBuilder\";\r\nimport { Pixel } from \"./Pixel\";\r\nimport { PrimitiveBuilder } from \"../internal/render/PrimitiveBuilder\";\r\nimport { PointCloudArgs } from \"../common/internal/render/PointCloudPrimitive\";\r\nimport { GraphicList, RenderGraphic } from \"./RenderGraphic\";\r\nimport { RenderMemory } from \"./RenderMemory\";\r\nimport { RenderPlan } from \"./RenderPlan\";\r\nimport { RenderAreaPattern, RenderGeometry, RenderSystem } from \"./RenderSystem\";\r\nimport { RenderTarget } from \"./RenderTarget\";\r\nimport { Scene } from \"./Scene\";\r\nimport { _implementationProhibited } from \"../common/internal/Symbols\";\r\n\r\n/** Contains extensible mock implementations of the various components of a RenderSystem, intended for use in tests.\r\n * Use these for tests instead of the default RenderSystem wherever possible because:\r\n *  (1) Electron has a bug on Windows in which it fails to obtain a WebGLRenderingContext when running inside a VM (e.g., during CI job); and\r\n *  (2) To decouple the logic which uses aspects of the RenderSystem from the full implementation.\r\n * Any and all of these types can be extended for the purposes of specific tests.\r\n * To use this:\r\n *  (1) If overriding anything in the implementation supplied herein, pass a SystemFactory function to MockRender.App.systemFactory.\r\n *  (2) Call MockRender.App.startup() instead of IModelApp.startup() before tests begin.\r\n *  (3) Likewise call MockRender.App.shutdown() when finished. This resets the SystemFactory to its default.\r\n * @note The APIs within this namespace are intended *strictly* for use with unit tests.\r\n * @internal\r\n */\r\nexport namespace MockRender {\r\n  /** @internal */\r\n  export abstract class Target extends RenderTarget {\r\n    protected override readonly [_implementationProhibited] = undefined;\r\n\r\n    protected constructor(private readonly _system: RenderSystem) { super(); }\r\n\r\n    public get renderSystem(): RenderSystem { return this._system; }\r\n    public get wantInvertBlackBackground() { return false; }\r\n    public get analysisFraction() { return 0; }\r\n    public set analysisFraction(_fraction: number) { }\r\n    public changeScene(_scene: Scene) { }\r\n    public changeDynamics(_dynamics?: GraphicList) { }\r\n    public changeDecorations(_decs: Decorations) { }\r\n    public changeRenderPlan(_plan: RenderPlan) { }\r\n    public drawFrame(_sceneTime?: number) { }\r\n    public updateViewRect() { return false; }\r\n    public readPixels(_rect: ViewRect, _selector: Pixel.Selector, receiver: Pixel.Receiver, _excludeNonLocatable: boolean) { receiver(undefined); }\r\n    public get screenSpaceEffects(): Iterable<string> { return []; }\r\n    public set screenSpaceEffects(_effects: Iterable<string>) { }\r\n  }\r\n\r\n  /** @internal */\r\n  export class OnScreenTarget extends Target {\r\n    public constructor(system: RenderSystem, private readonly _canvas: HTMLCanvasElement) { super(system); }\r\n\r\n    public get viewRect() { return new ViewRect(0, 0, this._canvas.clientWidth, this._canvas.clientHeight); }\r\n    public setViewRect(_rect: ViewRect, _temp: boolean) { }\r\n  }\r\n\r\n  /** @internal */\r\n  export class OffScreenTarget extends Target {\r\n    public constructor(system: RenderSystem, private readonly _viewRect: ViewRect) { super(system); }\r\n\r\n    public get viewRect() { return this._viewRect; }\r\n    public setViewRect(rect: ViewRect, _temp: boolean) { this._viewRect.setFrom(rect); }\r\n  }\r\n\r\n  /** @internal */\r\n  export class Builder extends PrimitiveBuilder {\r\n    public constructor(system: System, options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions) {\r\n      super(system, options);\r\n    }\r\n  }\r\n\r\n  export class Graphic extends RenderGraphic {\r\n    public constructor() { super(); }\r\n\r\n    public dispose() { }\r\n    public collectStatistics(_stats: RenderMemory.Statistics): void { }\r\n    public unionRange() { }\r\n  }\r\n\r\n  export class List extends Graphic {\r\n    public constructor(public readonly graphics: RenderGraphic[]) { super(); }\r\n\r\n    public override dispose() {\r\n      for (const graphic of this.graphics)\r\n        dispose(graphic);\r\n\r\n      this.graphics.length = 0;\r\n    }\r\n  }\r\n\r\n  export class Branch extends Graphic {\r\n    public constructor(public readonly branch: GraphicBranch, public readonly transform: Transform, public readonly options?: GraphicBranchOptions) { super(); }\r\n\r\n    public override dispose() { this.branch.dispose(); }\r\n  }\r\n\r\n  export class Batch extends Graphic {\r\n    public constructor(public readonly graphic: RenderGraphic, public readonly featureTable: RenderFeatureTable, public readonly range: ElementAlignedBox3d) { super(); }\r\n\r\n    public override dispose() {\r\n      dispose(this.graphic);\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  export class Geometry implements RenderGeometry {\r\n    public dispose(): void { }\r\n    public collectStatistics(): void { }\r\n  }\r\n\r\n  /** @internal */\r\n  export class AreaPattern implements RenderAreaPattern {\r\n    public dispose(): void { }\r\n    public collectStatistics(): void { }\r\n  }\r\n\r\n  export class System extends RenderSystem {\r\n    public get isValid() { return true; }\r\n    public dispose(): void { }\r\n    public override get maxTextureSize() { return 4096; }\r\n\r\n    public constructor() { super(); }\r\n\r\n    /** @internal */\r\n    public override doIdleWork(): boolean { return false; }\r\n\r\n    /** @internal */\r\n    public override createTarget(canvas: HTMLCanvasElement): OnScreenTarget { return new OnScreenTarget(this, canvas); }\r\n    /** @internal */\r\n    public override createOffscreenTarget(rect: ViewRect): RenderTarget { return new OffScreenTarget(this, rect); }\r\n\r\n    public override createGraphic(options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions): GraphicBuilder {\r\n      return new Builder(this, options);\r\n    }\r\n\r\n    public override createGraphicList(primitives: RenderGraphic[]) { return new List(primitives); }\r\n    public override createGraphicBranch(branch: GraphicBranch, transform: Transform, options?: GraphicBranchOptions) { return new Branch(branch, transform, options); }\r\n    public override createBatch(graphic: RenderGraphic, features: RenderFeatureTable, range: ElementAlignedBox3d) { return new Batch(graphic, features, range); }\r\n\r\n    /** @internal */\r\n    public override createMesh(_params: MeshParams) { return new Graphic(); }\r\n    /** @internal */\r\n    public override createPolyline(_params: PolylineParams) { return new Graphic(); }\r\n    /** @internal */\r\n    public override createPointString(_params: PointStringParams) { return new Graphic(); }\r\n    /** @internal */\r\n    public override createPointCloud(_args: PointCloudArgs, _imodel: IModelConnection) { return new Graphic(); }\r\n    public override createRenderGraphic() { return new Graphic(); }\r\n\r\n    /** @internal */\r\n    public override createMeshGeometry() { return new Geometry(); }\r\n    /** @internal */\r\n    public override createPolylineGeometry() { return new Geometry(); }\r\n    /** @internal */\r\n    public override createPointStringGeometry() { return new Geometry(); }\r\n    /** @internal */\r\n    public override createAreaPattern() { return new AreaPattern(); }\r\n  }\r\n\r\n  export type SystemFactory = () => RenderSystem;\r\n\r\n  /** An implementation of IModelApp which uses a MockRender.System by default. */\r\n  export class App {\r\n    public static systemFactory: SystemFactory = () => App.createDefaultRenderSystem();\r\n\r\n    public static async startup(opts?: IModelAppOptions): Promise<void> {\r\n      opts = opts ? opts : {};\r\n      opts.renderSys = this.systemFactory();\r\n      opts.localization = opts.localization ?? new EmptyLocalization();\r\n      await IModelApp.startup(opts);\r\n    }\r\n\r\n    public static async shutdown(): Promise<void> {\r\n      this.systemFactory = () => App.createDefaultRenderSystem();\r\n      await IModelApp.shutdown();\r\n    }\r\n\r\n    protected static createDefaultRenderSystem() { return new System(); }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"MockRender.js","sourceRoot":"","sources":["../../../src/render/MockRender.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sDAA8C;AAC9C,wDAA0D;AAC1D,oDAAgG;AAChG,4CAA2D;AAK3D,iDAA8C;AAK9C,0EAAuE;AAEvE,mDAA6D;AAG7D,iDAAiE;AACjE,iDAA8C;AAE9C,wDAAuE;AAGvE;;;;;;;;;;;GAWG;AACH,IAAiB,UAAU,CAmK1B;AAnKD,WAAiB,UAAU;;IACzB,gBAAgB;IAChB,MAAsB,MAAO,SAAQ,2BAAY;QAG/C,YAAuC,OAAqB;YAAI,KAAK,EAAE,CAAC;YAAjC,YAAO,GAAP,OAAO,CAAc;YAFhC,QAA2B,GAAG,SAAS,CAAC;QAEK,CAAC;QAE1E,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAChE,IAAW,yBAAyB,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;QACxD,IAAW,gBAAgB,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAW,gBAAgB,CAAC,SAAiB,IAAI,CAAC;QAC3C,WAAW,CAAC,MAAa,IAAI,CAAC;QAC9B,cAAc,CAAC,SAAuB,IAAI,CAAC;QAC3C,iBAAiB,CAAC,KAAkB,IAAI,CAAC;QACzC,gBAAgB,CAAC,KAAiB,IAAI,CAAC;QACvC,SAAS,CAAC,UAAmB,IAAI,CAAC;QAClC,cAAc,KAAK,OAAO,KAAK,CAAC,CAAC,CAAC;QAClC,UAAU,CAAC,KAAe,EAAE,SAAyB,EAAE,QAAwB,EAAE,oBAA6B,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/I,IAAW,kBAAkB,KAAuB,OAAO,EAAE,CAAC,CAAC,CAAC;QAChE,IAAW,kBAAkB,CAAC,QAA0B,IAAI,CAAC;KAC9D;SAjB8B,mCAAyB;IADlC,iBAAM,SAkB3B,CAAA;IAED,gBAAgB;IAChB,MAAa,cAAe,SAAQ,MAAM;QACxC,YAAmB,MAAoB,EAAmB,OAA0B;YAAI,KAAK,CAAC,MAAM,CAAC,CAAC;YAA5C,YAAO,GAAP,OAAO,CAAmB;QAAmB,CAAC;QAExG,IAAW,QAAQ,KAAK,OAAO,IAAI,mBAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAClG,WAAW,CAAC,KAAe,EAAE,KAAc,IAAI,CAAC;KACxD;IALY,yBAAc,iBAK1B,CAAA;IAED,gBAAgB;IAChB,MAAa,eAAgB,SAAQ,MAAM;QACzC,YAAmB,MAAoB,EAAmB,SAAmB;YAAI,KAAK,CAAC,MAAM,CAAC,CAAC;YAArC,cAAS,GAAT,SAAS,CAAU;QAAmB,CAAC;QAEjG,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,WAAW,CAAC,IAAc,EAAE,KAAc,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACrF;IALY,0BAAe,kBAK3B,CAAA;IAED,gBAAgB;IAChB,MAAa,OAAQ,SAAQ,mCAAgB;QAC3C,YAAmB,MAAc,EAAE,OAAoE;YACrG,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzB,CAAC;KACF;IAJY,kBAAO,UAInB,CAAA;IAED,MAAa,OAAQ,SAAQ,6BAAa;QACxC,gBAAuB,KAAK,EAAE,CAAC,CAAC,CAAC;QAE1B,OAAO,KAAK,CAAC;QACb,iBAAiB,CAAC,MAA+B,IAAU,CAAC;QAC5D,UAAU,KAAK,CAAC;KACxB;IANY,kBAAO,UAMnB,CAAA;IAED,MAAa,IAAK,SAAQ,OAAO;QAC/B,YAAmC,QAAyB;YAAI,KAAK,EAAE,CAAC;YAArC,aAAQ,GAAR,QAAQ,CAAiB;QAAa,CAAC;QAE1D,OAAO;YACrB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ;gBACjC,IAAA,sBAAO,EAAC,OAAO,CAAC,CAAC;YAEnB,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;QAC3B,CAAC;KACF;IATY,eAAI,OAShB,CAAA;IAED,MAAa,MAAO,SAAQ,OAAO;QACjC,YAAmC,MAAqB,EAAkB,SAAoB,EAAkB,OAA8B;YAAI,KAAK,EAAE,CAAC;YAAvH,WAAM,GAAN,MAAM,CAAe;YAAkB,cAAS,GAAT,SAAS,CAAW;YAAkB,YAAO,GAAP,OAAO,CAAuB;QAAa,CAAC;QAE5I,OAAO,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;KACrD;IAJY,iBAAM,SAIlB,CAAA;IAED,MAAa,KAAM,SAAQ,OAAO;QAChC,YAAmC,OAAsB,EAAkB,YAAgC,EAAkB,KAA0B;YAAI,KAAK,EAAE,CAAC;YAAhI,YAAO,GAAP,OAAO,CAAe;YAAkB,iBAAY,GAAZ,YAAY,CAAoB;YAAkB,UAAK,GAAL,KAAK,CAAqB;QAAa,CAAC;QAErJ,OAAO;YACrB,IAAA,sBAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;KACF;IANY,gBAAK,QAMjB,CAAA;IAED,gBAAgB;IAChB,MAAa,QAAQ;QAInB,YAAmC,kBAAwD;YAAxD,uBAAkB,GAAlB,kBAAkB,CAAsC;YAHpF,cAAS,GAAG,KAAK,CAAC;YACT,mBAAc,GAAG,IAAI,CAAC;YAC/B,eAAU,GAAG,KAAK,CAAC;QAG1B,CAAC;QACM,OAAO,KAAW,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC;QAC3C,iBAAiB,KAAW,CAAC;QAC7B,YAAY,KAAK,OAAO,IAAI,uBAAO,EAAE,CAAC,CAAC,CAAC;KAChD;IAVY,mBAAQ,WAUpB,CAAA;IAED,gBAAgB;IAChB,MAAa,WAAW;QAAxB;YACkB,QAA2B,GAAG,mBAAmB,CAAC;QAGpE,CAAC;QAFQ,OAAO,KAAW,CAAC;QACnB,iBAAiB,KAAW,CAAC;KACrC;SAHkB,mCAAyB;IAD/B,sBAAW,cAIvB,CAAA;IAED,MAAa,MAAO,SAAQ,2BAAY;QACtC,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAC9B,OAAO,KAAW,CAAC;QAC1B,IAAoB,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QAErD,gBAAuB,KAAK,EAAE,CAAC,CAAC,CAAC;QAEjC,gBAAgB;QACA,UAAU,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;QAEvD,gBAAgB;QACA,YAAY,CAAC,MAAyB,IAAoB,OAAO,IAAI,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACpH,gBAAgB;QACA,qBAAqB,CAAC,IAAc,IAAkB,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAE/F,aAAa,CAAC,OAAoE;YAChG,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpC,CAAC;QAEe,iBAAiB,CAAC,UAA2B,IAAI,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC/E,mBAAmB,CAAC,MAAqB,EAAE,SAAoB,EAAE,OAA8B,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QACnJ,WAAW,CAAC,OAAsB,EAAE,QAA4B,EAAE,KAA0B,IAAI,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAE7J,gBAAgB;QACA,UAAU,CAAC,OAAmB,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QACzE,gBAAgB;QACA,cAAc,CAAC,OAAuB,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QACjF,gBAAgB;QACA,iBAAiB,CAAC,OAA0B,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QACvF,gBAAgB;QACA,gBAAgB,CAAC,KAAqB,EAAE,OAAyB,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QAC5F,mBAAmB,KAAK,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QAE/D,gBAAgB;QACA,kBAAkB,KAAK,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACrE,gBAAgB;QACA,sBAAsB,KAAK,OAAO,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC7E,gBAAgB;QACA,yBAAyB,KAAK,OAAO,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACpF,gBAAgB;QACA,iBAAiB,KAAK,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC;QACjE,gBAAgB;QACA,yBAAyB,KAAK,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;KACtE;IA3CY,iBAAM,SA2ClB,CAAA;IAID,gFAAgF;IAChF,MAAa,GAAG;QAGP,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAuB;YACjD,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,+BAAiB,EAAE,CAAC;YACjE,MAAM,qBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAEM,MAAM,CAAC,KAAK,CAAC,QAAQ;YAC1B,IAAI,CAAC,aAAa,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,yBAAyB,EAAE,CAAC;YAC3D,MAAM,qBAAS,CAAC,QAAQ,EAAE,CAAC;QAC7B,CAAC;QAES,MAAM,CAAC,yBAAyB,KAAK,OAAO,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC;;IAdvD,iBAAa,GAAkB,GAAG,EAAE,CAAC,GAAG,CAAC,yBAAyB,EAAE,CAAC;IADxE,cAAG,MAgBf,CAAA;AACH,CAAC,EAnKgB,UAAU,0BAAV,UAAU,QAmK1B","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\r\n/** @packageDocumentation\r\n * @module Utils\r\n */\r\n\r\nimport { dispose } from \"@itwin/core-bentley\";\r\nimport { Range3d, Transform } from \"@itwin/core-geometry\";\r\nimport { ElementAlignedBox3d, EmptyLocalization, RenderFeatureTable } from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions } from \"../IModelApp\";\r\nimport { IModelConnection } from \"../IModelConnection\";\r\nimport { MeshParams } from \"../common/internal/render/MeshParams\";\r\nimport { PointStringParams } from \"../common/internal/render/PointStringParams\";\r\nimport { PolylineParams } from \"../common/internal/render/PolylineParams\";\r\nimport { ViewRect } from \"../common/ViewRect\";\r\nimport { Decorations } from \"./Decorations\";\r\nimport { GraphicBranch, GraphicBranchOptions } from \"./GraphicBranch\";\r\nimport { CustomGraphicBuilderOptions, GraphicBuilder, ViewportGraphicBuilderOptions } from \"./GraphicBuilder\";\r\nimport { Pixel } from \"./Pixel\";\r\nimport { PrimitiveBuilder } from \"../internal/render/PrimitiveBuilder\";\r\nimport { PointCloudArgs } from \"../common/internal/render/PointCloudPrimitive\";\r\nimport { GraphicList, RenderGraphic } from \"./RenderGraphic\";\r\nimport { RenderMemory } from \"./RenderMemory\";\r\nimport { RenderPlan } from \"./RenderPlan\";\r\nimport { RenderAreaPattern, RenderSystem } from \"./RenderSystem\";\r\nimport { RenderTarget } from \"./RenderTarget\";\r\nimport { Scene } from \"./Scene\";\r\nimport { _implementationProhibited } from \"../common/internal/Symbols\";\r\nimport { RenderGeometry } from \"../internal/render/RenderGeometry\";\r\n\r\n/** Contains extensible mock implementations of the various components of a RenderSystem, intended for use in tests.\r\n * Use these for tests instead of the default RenderSystem wherever possible because:\r\n *  (1) Electron has a bug on Windows in which it fails to obtain a WebGLRenderingContext when running inside a VM (e.g., during CI job); and\r\n *  (2) To decouple the logic which uses aspects of the RenderSystem from the full implementation.\r\n * Any and all of these types can be extended for the purposes of specific tests.\r\n * To use this:\r\n *  (1) If overriding anything in the implementation supplied herein, pass a SystemFactory function to MockRender.App.systemFactory.\r\n *  (2) Call MockRender.App.startup() instead of IModelApp.startup() before tests begin.\r\n *  (3) Likewise call MockRender.App.shutdown() when finished. This resets the SystemFactory to its default.\r\n * @note The APIs within this namespace are intended *strictly* for use with unit tests.\r\n * @internal\r\n */\r\nexport namespace MockRender {\r\n  /** @internal */\r\n  export abstract class Target extends RenderTarget {\r\n    protected override readonly [_implementationProhibited] = undefined;\r\n\r\n    protected constructor(private readonly _system: RenderSystem) { super(); }\r\n\r\n    public get renderSystem(): RenderSystem { return this._system; }\r\n    public get wantInvertBlackBackground() { return false; }\r\n    public get analysisFraction() { return 0; }\r\n    public set analysisFraction(_fraction: number) { }\r\n    public changeScene(_scene: Scene) { }\r\n    public changeDynamics(_dynamics?: GraphicList) { }\r\n    public changeDecorations(_decs: Decorations) { }\r\n    public changeRenderPlan(_plan: RenderPlan) { }\r\n    public drawFrame(_sceneTime?: number) { }\r\n    public updateViewRect() { return false; }\r\n    public readPixels(_rect: ViewRect, _selector: Pixel.Selector, receiver: Pixel.Receiver, _excludeNonLocatable: boolean) { receiver(undefined); }\r\n    public get screenSpaceEffects(): Iterable<string> { return []; }\r\n    public set screenSpaceEffects(_effects: Iterable<string>) { }\r\n  }\r\n\r\n  /** @internal */\r\n  export class OnScreenTarget extends Target {\r\n    public constructor(system: RenderSystem, private readonly _canvas: HTMLCanvasElement) { super(system); }\r\n\r\n    public get viewRect() { return new ViewRect(0, 0, this._canvas.clientWidth, this._canvas.clientHeight); }\r\n    public setViewRect(_rect: ViewRect, _temp: boolean) { }\r\n  }\r\n\r\n  /** @internal */\r\n  export class OffScreenTarget extends Target {\r\n    public constructor(system: RenderSystem, private readonly _viewRect: ViewRect) { super(system); }\r\n\r\n    public get viewRect() { return this._viewRect; }\r\n    public setViewRect(rect: ViewRect, _temp: boolean) { this._viewRect.setFrom(rect); }\r\n  }\r\n\r\n  /** @internal */\r\n  export class Builder extends PrimitiveBuilder {\r\n    public constructor(system: System, options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions) {\r\n      super(system, options);\r\n    }\r\n  }\r\n\r\n  export class Graphic extends RenderGraphic {\r\n    public constructor() { super(); }\r\n\r\n    public dispose() { }\r\n    public collectStatistics(_stats: RenderMemory.Statistics): void { }\r\n    public unionRange() { }\r\n  }\r\n\r\n  export class List extends Graphic {\r\n    public constructor(public readonly graphics: RenderGraphic[]) { super(); }\r\n\r\n    public override dispose() {\r\n      for (const graphic of this.graphics)\r\n        dispose(graphic);\r\n\r\n      this.graphics.length = 0;\r\n    }\r\n  }\r\n\r\n  export class Branch extends Graphic {\r\n    public constructor(public readonly branch: GraphicBranch, public readonly transform: Transform, public readonly options?: GraphicBranchOptions) { super(); }\r\n\r\n    public override dispose() { this.branch.dispose(); }\r\n  }\r\n\r\n  export class Batch extends Graphic {\r\n    public constructor(public readonly graphic: RenderGraphic, public readonly featureTable: RenderFeatureTable, public readonly range: ElementAlignedBox3d) { super(); }\r\n\r\n    public override dispose() {\r\n      dispose(this.graphic);\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  export class Geometry implements RenderGeometry {\r\n    public noDispose = false;\r\n    public readonly isInstanceable = true;\r\n    public isDisposed = false;\r\n    public constructor(public readonly renderGeometryType: \"mesh\" | \"polyline\" | \"point-string\") {\r\n\r\n    }\r\n    public dispose(): void { this.isDisposed = true; }\r\n    public collectStatistics(): void { }\r\n    public computeRange() { return new Range3d(); }\r\n  }\r\n\r\n  /** @internal */\r\n  export class AreaPattern implements RenderAreaPattern {\r\n    public readonly [_implementationProhibited] = \"renderAreaPattern\";\r\n    public dispose(): void { }\r\n    public collectStatistics(): void { }\r\n  }\r\n\r\n  export class System extends RenderSystem {\r\n    public get isValid() { return true; }\r\n    public dispose(): void { }\r\n    public override get maxTextureSize() { return 4096; }\r\n\r\n    public constructor() { super(); }\r\n\r\n    /** @internal */\r\n    public override doIdleWork(): boolean { return false; }\r\n\r\n    /** @internal */\r\n    public override createTarget(canvas: HTMLCanvasElement): OnScreenTarget { return new OnScreenTarget(this, canvas); }\r\n    /** @internal */\r\n    public override createOffscreenTarget(rect: ViewRect): RenderTarget { return new OffScreenTarget(this, rect); }\r\n\r\n    public override createGraphic(options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions): GraphicBuilder {\r\n      return new Builder(this, options);\r\n    }\r\n\r\n    public override createGraphicList(primitives: RenderGraphic[]) { return new List(primitives); }\r\n    public override createGraphicBranch(branch: GraphicBranch, transform: Transform, options?: GraphicBranchOptions) { return new Branch(branch, transform, options); }\r\n    public override createBatch(graphic: RenderGraphic, features: RenderFeatureTable, range: ElementAlignedBox3d) { return new Batch(graphic, features, range); }\r\n\r\n    /** @internal */\r\n    public override createMesh(_params: MeshParams) { return new Graphic(); }\r\n    /** @internal */\r\n    public override createPolyline(_params: PolylineParams) { return new Graphic(); }\r\n    /** @internal */\r\n    public override createPointString(_params: PointStringParams) { return new Graphic(); }\r\n    /** @internal */\r\n    public override createPointCloud(_args: PointCloudArgs, _imodel: IModelConnection) { return new Graphic(); }\r\n    public override createRenderGraphic() { return new Graphic(); }\r\n\r\n    /** @internal */\r\n    public override createMeshGeometry() { return new Geometry(\"mesh\"); }\r\n    /** @internal */\r\n    public override createPolylineGeometry() { return new Geometry(\"polyline\"); }\r\n    /** @internal */\r\n    public override createPointStringGeometry() { return new Geometry(\"point-string\"); }\r\n    /** @internal */\r\n    public override createAreaPattern() { return new AreaPattern(); }\r\n    /** @internal */\r\n    public override createGraphicFromTemplate() { return new Graphic(); }\r\n  }\r\n\r\n  export type SystemFactory = () => RenderSystem;\r\n\r\n  /** An implementation of IModelApp which uses a MockRender.System by default. */\r\n  export class App {\r\n    public static systemFactory: SystemFactory = () => App.createDefaultRenderSystem();\r\n\r\n    public static async startup(opts?: IModelAppOptions): Promise<void> {\r\n      opts = opts ? opts : {};\r\n      opts.renderSys = this.systemFactory();\r\n      opts.localization = opts.localization ?? new EmptyLocalization();\r\n      await IModelApp.startup(opts);\r\n    }\r\n\r\n    public static async shutdown(): Promise<void> {\r\n      this.systemFactory = () => App.createDefaultRenderSystem();\r\n      await IModelApp.shutdown();\r\n    }\r\n\r\n    protected static createDefaultRenderSystem() { return new System(); }\r\n  }\r\n}\r\n"]}