@itwin/frontend-tiles 4.4.0-dev.20 → 4.4.0-dev.24

package/lib/cjs/ModelGroup.js

@@ -0,0 +1,89 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.groupModels = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+function createPlanProjectionInfo(modelId, context) {
+    const settings = context.getPlanProjectionSettings(modelId);
+    if (!settings)
+        return undefined;
+    return {
+        elevation: settings.elevation ?? context.getDefaultElevation(modelId),
+        transparency: settings.transparency ?? 0,
+        overlay: settings.overlay,
+    };
+}
+function equalPlanProjections(a, b) {
+    return a.elevation === b.elevation && a.overlay === b.overlay && a.transparency === b.transparency;
+}
+function createModelGroupInfo(context, modelId) {
+    const planProjection = createPlanProjectionInfo(modelId, context);
+    const viewFlags = { ...context.getViewFlagOverrides(modelId) };
+    if (planProjection) {
+        // Always enable improved z-fighting mitigation for plan projections (they're planar models).
+        viewFlags.forceSurfaceDiscard = true;
+    }
+    return {
+        displayTransform: context.modelGroupDisplayTransforms.getDisplayTransform(modelId),
+        clip: context.getModelClip(modelId),
+        planProjection,
+        viewFlags,
+        timeline: context.getModelTimeline(modelId),
+    };
+}
+function equalViewFlags(a, b) {
+    const lhs = Object.keys(a);
+    const rhs = Object.keys(b);
+    if (lhs.length !== rhs.length) {
+        return false;
+    }
+    for (const propName of lhs) {
+        const key = propName;
+        if (a[key] !== b[key])
+            return false;
+    }
+    return true;
+}
+function equalModelGroupInfo(a, b) {
+    // If a model has a timeline it cannot be grouped
+    if (a.timeline !== b.timeline)
+        return false;
+    // Display transforms are obtained from ModelGroupDisplayTransforms - they are guaranteed to be the same object if they are equivalent.
+    if (a.displayTransform !== b.displayTransform)
+        return false;
+    if (a.clip || b.clip) {
+        // Note: ClipVector lacks an `isAlmostEqual` method.
+        // For two models belonging to the same clip group, we should have the same exact object.
+        // But we won't currently detect two different objects that represent effectively identical clips.
+        if (!a.clip || !b.clip || a.clip.clipVector !== b.clip.clipVector)
+            return false;
+    }
+    if (a.planProjection || b.planProjection) {
+        if (!a.planProjection || !b.planProjection || !equalPlanProjections(a.planProjection, b.planProjection)) {
+            return false;
+        }
+    }
+    if (!equalViewFlags(a.viewFlags, b.viewFlags))
+        return false;
+    return true;
+}
+/** Group the supplied `modelIds` such that all models that are to be drawn with equivalent display settings are grouped together.
+ * @internal
+ */
+function groupModels(context, modelIds) {
+    const groups = [];
+    for (const modelId of modelIds) {
+        const info = createModelGroupInfo(context, modelId);
+        let group = groups.find((x) => equalModelGroupInfo(x, info));
+        if (!group)
+            groups.push(group = { ...info, modelIds: new Set() });
+        (0, core_bentley_1.assert)(!group.modelIds.has(modelId));
+        group.modelIds.add(modelId);
+    }
+    return groups;
+}
+exports.groupModels = groupModels;
+//# sourceMappingURL=ModelGroup.js.map

package/lib/cjs/ModelGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelGroup.js","sourceRoot":"","sources":["../../src/ModelGroup.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAAkE;AAgDlE,SAAS,wBAAwB,CAAC,OAAmB,EAAE,OAA6B;IAClF,MAAM,QAAQ,GAAG,OAAO,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAC5D,IAAI,CAAC,QAAQ;QACX,OAAO,SAAS,CAAC;IAEnB,OAAO;QACL,SAAS,EAAE,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC;QACrE,YAAY,EAAE,QAAQ,CAAC,YAAY,IAAI,CAAC;QACxC,OAAO,EAAE,QAAQ,CAAC,OAAO;KAC1B,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,CAAqB,EAAE,CAAqB;IACxE,OAAO,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,YAAY,CAAC;AACrG,CAAC;AAED,SAAS,oBAAoB,CAAC,OAA6B,EAAE,OAAmB;IAC9E,MAAM,cAAc,GAAG,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAClE,MAAM,SAAS,GAAG,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC;IAC/D,IAAI,cAAc,EAAE;QAClB,6FAA6F;QAC7F,SAAS,CAAC,mBAAmB,GAAG,IAAI,CAAC;KACtC;IAED,OAAO;QACL,gBAAgB,EAAE,OAAO,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,OAAO,CAAC;QAClF,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC;QACnC,cAAc;QACd,SAAS;QACT,QAAQ,EAAE,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC;KAC5C,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,CAAoB,EAAE,CAAoB;IAChE,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE;QAC7B,OAAO,KAAK,CAAC;KACd;IAED,KAAK,MAAM,QAAQ,IAAI,GAAG,EAAE;QAC1B,MAAM,GAAG,GAAG,QAAmC,CAAC;QAChD,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC;YACnB,OAAO,KAAK,CAAC;KAChB;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,mBAAmB,CAAC,CAAiB,EAAE,CAAiB;IAC/D,iDAAiD;IACjD,IAAI,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ;QAC3B,OAAO,KAAK,CAAC;IAEf,uIAAuI;IACvI,IAAI,CAAC,CAAC,gBAAgB,KAAK,CAAC,CAAC,gBAAgB;QAC3C,OAAO,KAAK,CAAC;IAEf,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,EAAE;QACpB,oDAAoD;QACpD,yFAAyF;QACzF,kGAAkG;QAClG,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU;YAC/D,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,CAAC,CAAC,cAAc,IAAI,CAAC,CAAC,cAAc,EAAE;QACxC,IAAI,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,cAAc,CAAC,EAAE;YACvG,OAAO,KAAK,CAAC;SACd;KACF;IAED,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;QAC3C,OAAO,KAAK,CAAC;IAEf,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,OAA6B,EAAE,QAAiB;IAC1E,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;QAC9B,MAAM,IAAI,GAAG,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACpD,IAAI,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,KAAK;YACR,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAU,EAAE,CAAC,CAAC;QAEhE,IAAA,qBAAM,EAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACrC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KAC7B;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAbD,kCAaC","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\nimport { assert, Id64Set, Id64String } from \"@itwin/core-bentley\";\r\nimport { PlanProjectionSettings, RenderSchedule, ViewFlagOverrides } from \"@itwin/core-common\";\r\nimport { ModelDisplayTransform, RenderClipVolume } from \"@itwin/core-frontend\";\r\nimport { ModelGroupDisplayTransforms } from \"./ModelGroupDisplayTransforms\";\r\n\r\n/** Plan projection settings relevant to a [[ModelGroupInfo]].\r\n * @internal\r\n */\r\nexport interface PlanProjectionInfo {\r\n  /** Z elevation, from [PlanProjectionSettings.elevation]($common) if specified, else the default elevation of the model (computed from model extents). */\r\n  elevation: number;\r\n  /** Transparency in [0..1] with 0 being fully opaque. */\r\n  transparency: number;\r\n  /** If true, the graphics are drawn as overlays with no depth test. */\r\n  overlay: boolean;\r\n}\r\n\r\n/** Display settings to be applied to a group of models.\r\n * @internal\r\n */\r\nexport interface ModelGroupInfo {\r\n  displayTransform?: ModelDisplayTransform;\r\n  clip?: RenderClipVolume;\r\n  planProjection?: PlanProjectionInfo;\r\n  timeline?: RenderSchedule.ModelTimeline;\r\n  viewFlags: ViewFlagOverrides;\r\n}\r\n\r\n/** Represents a group of models and the display settings to be applied to them.\r\n * @internal\r\n */\r\nexport interface ModelGroup extends ModelGroupInfo {\r\n  /** The set of models belonging to this group. */\r\n  modelIds: Id64Set;\r\n}\r\n\r\n/** Context supplied to [[groupModels]].\r\n * @internal\r\n */\r\nexport interface ModelGroupingContext {\r\n  modelGroupDisplayTransforms: ModelGroupDisplayTransforms;\r\n  getModelClip(modelId: Id64String): RenderClipVolume | undefined;\r\n  getPlanProjectionSettings(modelId: Id64String): PlanProjectionSettings | undefined;\r\n  getModelTimeline(modelId: Id64String): RenderSchedule.ModelTimeline | undefined;\r\n  getDefaultElevation(modelId: Id64String): number;\r\n  getViewFlagOverrides(modelId: Id64String): ViewFlagOverrides | undefined;\r\n}\r\n\r\nfunction createPlanProjectionInfo(modelId: Id64String, context: ModelGroupingContext): PlanProjectionInfo | undefined {\r\n  const settings = context.getPlanProjectionSettings(modelId);\r\n  if (!settings)\r\n    return undefined;\r\n\r\n  return {\r\n    elevation: settings.elevation ?? context.getDefaultElevation(modelId),\r\n    transparency: settings.transparency ?? 0,\r\n    overlay: settings.overlay,\r\n  };\r\n}\r\n\r\nfunction equalPlanProjections(a: PlanProjectionInfo, b: PlanProjectionInfo): boolean {\r\n  return a.elevation === b.elevation && a.overlay === b.overlay && a.transparency === b.transparency;\r\n}\r\n\r\nfunction createModelGroupInfo(context: ModelGroupingContext, modelId: Id64String): ModelGroupInfo {\r\n  const planProjection = createPlanProjectionInfo(modelId, context);\r\n  const viewFlags = { ...context.getViewFlagOverrides(modelId) };\r\n  if (planProjection) {\r\n    // Always enable improved z-fighting mitigation for plan projections (they're planar models).\r\n    viewFlags.forceSurfaceDiscard = true;\r\n  }\r\n\r\n  return {\r\n    displayTransform: context.modelGroupDisplayTransforms.getDisplayTransform(modelId),\r\n    clip: context.getModelClip(modelId),\r\n    planProjection,\r\n    viewFlags,\r\n    timeline: context.getModelTimeline(modelId),\r\n  };\r\n}\r\n\r\nfunction equalViewFlags(a: ViewFlagOverrides, b: ViewFlagOverrides): boolean {\r\n  const lhs = Object.keys(a);\r\n  const rhs = Object.keys(b);\r\n  if (lhs.length !== rhs.length) {\r\n    return false;\r\n  }\r\n\r\n  for (const propName of lhs) {\r\n    const key = propName as keyof ViewFlagOverrides;\r\n    if (a[key] !== b[key])\r\n      return false;\r\n  }\r\n\r\n  return true;\r\n}\r\n\r\nfunction equalModelGroupInfo(a: ModelGroupInfo, b: ModelGroupInfo): boolean {\r\n  // If a model has a timeline it cannot be grouped\r\n  if (a.timeline !== b.timeline)\r\n    return false;\r\n\r\n  // Display transforms are obtained from ModelGroupDisplayTransforms - they are guaranteed to be the same object if they are equivalent.\r\n  if (a.displayTransform !== b.displayTransform)\r\n    return false;\r\n\r\n  if (a.clip || b.clip) {\r\n    // Note: ClipVector lacks an `isAlmostEqual` method.\r\n    // For two models belonging to the same clip group, we should have the same exact object.\r\n    // But we won't currently detect two different objects that represent effectively identical clips.\r\n    if (!a.clip || !b.clip || a.clip.clipVector !== b.clip.clipVector)\r\n      return false;\r\n  }\r\n\r\n  if (a.planProjection || b.planProjection) {\r\n    if (!a.planProjection || !b.planProjection || !equalPlanProjections(a.planProjection, b.planProjection)) {\r\n      return false;\r\n    }\r\n  }\r\n\r\n  if (!equalViewFlags(a.viewFlags, b.viewFlags))\r\n    return false;\r\n\r\n  return true;\r\n}\r\n\r\n/** Group the supplied `modelIds` such that all models that are to be drawn with equivalent display settings are grouped together.\r\n * @internal\r\n */\r\nexport function groupModels(context: ModelGroupingContext, modelIds: Id64Set): ModelGroup[] {\r\n  const groups: ModelGroup[] = [];\r\n  for (const modelId of modelIds) {\r\n    const info = createModelGroupInfo(context, modelId);\r\n    let group = groups.find((x) => equalModelGroupInfo(x, info));\r\n    if (!group)\r\n      groups.push(group = { ...info, modelIds: new Set<string>() });\r\n\r\n    assert(!group.modelIds.has(modelId));\r\n    group.modelIds.add(modelId);\r\n  }\r\n\r\n  return groups;\r\n}\r\n"]}

package/lib/cjs/ModelGroupDisplayTransforms.d.ts

@@ -0,0 +1,22 @@
+import { Id64Set, Id64String } from "@itwin/core-bentley";
+import { ModelDisplayTransform, ModelDisplayTransformProvider } from "@itwin/core-frontend";
+/** Manages the display transforms to be applied to all of the models in a BatchedTileTree, enabling all models that share an equivalent transform
+ * to be drawn together.
+ * Call `update` whenever the transforms may have changed (e.g., after the viewport's scene is invalidated).
+ * @internal
+ */
+export declare class ModelGroupDisplayTransforms {
+    private _state;
+    private readonly _modelIds;
+    /** Create a new set of groups for the specified `modelIds`. If `provider` is supplied, the grouping will be applied to those models immediately. */
+    constructor(modelIds: Id64Set, provider?: ModelDisplayTransformProvider);
+    /** A string uniquely identifying the current grouping. */
+    get guid(): string;
+    /** Get the display transform for the specified model.
+     * @note This method is guaranteed to return the same object for all models in the same group, at least between calls to `update`.
+     */
+    getDisplayTransform(modelId: Id64String): ModelDisplayTransform | undefined;
+    update(provider: ModelDisplayTransformProvider | undefined): boolean;
+    private computeState;
+}
+//# sourceMappingURL=ModelGroupDisplayTransforms.d.ts.map

package/lib/cjs/ModelGroupDisplayTransforms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelGroupDisplayTransforms.d.ts","sourceRoot":"","sources":["../../src/ModelGroupDisplayTransforms.ts"],"names":[],"mappings":"AAKA,OAAO,EAAqB,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAqB5F;;;;GAIG;AACH,qBAAa,2BAA2B;IACtC,OAAO,CAAC,MAAM,CAAgD;IAC9D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IAEpC,oJAAoJ;gBACjI,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,6BAA6B;IAM9E,0DAA0D;IAC1D,IAAW,IAAI,IAAI,MAAM,CAA6B;IAEtD;;OAEG;IACI,mBAAmB,CAAC,OAAO,EAAE,UAAU,GAAG,qBAAqB,GAAG,SAAS;IAM3E,MAAM,CAAC,QAAQ,EAAE,6BAA6B,GAAG,SAAS,GAAG,OAAO;IAM3E,OAAO,CAAC,YAAY;CAsBrB"}

package/lib/cjs/ModelGroupDisplayTransforms.js

@@ -0,0 +1,62 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelGroupDisplayTransforms = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+function equalDisplayTransforms(a, b) {
+    return !!a.premultiply === !!b.premultiply && a.transform.isAlmostEqual(b.transform);
+}
+/** Optimization for the common case in which no display transforms are to be applied. */
+const emptyState = { transforms: [], guid: "" };
+/** Manages the display transforms to be applied to all of the models in a BatchedTileTree, enabling all models that share an equivalent transform
+ * to be drawn together.
+ * Call `update` whenever the transforms may have changed (e.g., after the viewport's scene is invalidated).
+ * @internal
+ */
+class ModelGroupDisplayTransforms {
+    /** Create a new set of groups for the specified `modelIds`. If `provider` is supplied, the grouping will be applied to those models immediately. */
+    constructor(modelIds, provider) {
+        this._state = emptyState;
+        this._modelIds = modelIds;
+        if (provider)
+            this.update(provider);
+    }
+    /** A string uniquely identifying the current grouping. */
+    get guid() { return this._state.guid; }
+    /** Get the display transform for the specified model.
+     * @note This method is guaranteed to return the same object for all models in the same group, at least between calls to `update`.
+     */
+    getDisplayTransform(modelId) {
+        return this._state.transforms.find((x) => x.modelIds.has(modelId))?.transform;
+    }
+    // Update the display transforms and the model groupings based on the transforms supplied by `provider`.
+    // Return `true` if the groupings changed as a result.
+    update(provider) {
+        const prevState = this._state;
+        this._state = this.computeState(provider);
+        return this._state.guid !== prevState.guid;
+    }
+    computeState(provider) {
+        if (!provider)
+            return emptyState;
+        const transforms = [];
+        for (const modelId of this._modelIds) {
+            const transform = provider.getModelDisplayTransform(modelId);
+            if (transform) {
+                let entry = transforms.find((x) => equalDisplayTransforms(transform, x.transform));
+                if (!entry)
+                    transforms.push(entry = { transform, modelIds: new Set() });
+                entry.modelIds.add(modelId);
+            }
+        }
+        if (transforms.length === 0)
+            return emptyState;
+        const guid = transforms.map((x) => core_bentley_1.CompressedId64Set.compressSet(x.modelIds)).sort().join("_");
+        return { transforms, guid };
+    }
+}
+exports.ModelGroupDisplayTransforms = ModelGroupDisplayTransforms;
+//# sourceMappingURL=ModelGroupDisplayTransforms.js.map

package/lib/cjs/ModelGroupDisplayTransforms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelGroupDisplayTransforms.js","sourceRoot":"","sources":["../../src/ModelGroupDisplayTransforms.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,sDAA6E;AAG7E,SAAS,sBAAsB,CAAC,CAAwB,EAAE,CAAwB;IAChF,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACvF,CAAC;AAcD,yFAAyF;AACzF,MAAM,UAAU,GAAqC,EAAE,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AAElF;;;;GAIG;AACH,MAAa,2BAA2B;IAItC,oJAAoJ;IACpJ,YAAmB,QAAiB,EAAE,QAAwC;QAJtE,WAAM,GAAqC,UAAU,CAAC;QAK5D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,QAAQ;YACV,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED,0DAA0D;IAC1D,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACI,mBAAmB,CAAC,OAAmB;QAC5C,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC;IAChF,CAAC;IAED,wGAAwG;IACxG,sDAAsD;IAC/C,MAAM,CAAC,QAAmD;QAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC;IAC7C,CAAC;IAEO,YAAY,CAAC,QAAmD;QACtE,IAAI,CAAC,QAAQ;YACX,OAAO,UAAU,CAAC;QAEpB,MAAM,UAAU,GAAiC,EAAE,CAAC;QACpD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YACpC,MAAM,SAAS,GAAG,QAAQ,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;YAC7D,IAAI,SAAS,EAAE;gBACb,IAAI,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;gBACnF,IAAI,CAAC,KAAK;oBACR,UAAU,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;gBAE9D,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aAC7B;SACF;QAED,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACzB,OAAO,UAAU,CAAC;QAEpB,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/F,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAC9B,CAAC;CACF;AAnDD,kEAmDC","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\nimport { CompressedId64Set, Id64Set, Id64String } from \"@itwin/core-bentley\";\r\nimport { ModelDisplayTransform, ModelDisplayTransformProvider } from \"@itwin/core-frontend\";\r\n\r\nfunction equalDisplayTransforms(a: ModelDisplayTransform, b: ModelDisplayTransform): boolean {\r\n  return !!a.premultiply === !!b.premultiply && a.transform.isAlmostEqual(b.transform);\r\n}\r\n\r\n/** A display transform to be applied to a set of models. */\r\ninterface ModelGroupDisplayTransform {\r\n  modelIds: Id64Set;\r\n  transform: ModelDisplayTransform;\r\n}\r\n\r\n/** A collection of model Ids grouped according to the unique transforms to be applied to each group. */\r\ninterface ModelGroupDisplayTransformsState {\r\n  readonly transforms: ReadonlyArray<ModelGroupDisplayTransform>;\r\n  readonly guid: string;\r\n}\r\n\r\n/** Optimization for the common case in which no display transforms are to be applied. */\r\nconst emptyState: ModelGroupDisplayTransformsState = { transforms: [], guid: \"\" };\r\n\r\n/** Manages the display transforms to be applied to all of the models in a BatchedTileTree, enabling all models that share an equivalent transform\r\n * to be drawn together.\r\n * Call `update` whenever the transforms may have changed (e.g., after the viewport's scene is invalidated).\r\n * @internal\r\n */\r\nexport class ModelGroupDisplayTransforms {\r\n  private _state: ModelGroupDisplayTransformsState = emptyState;\r\n  private readonly _modelIds: Id64Set;\r\n\r\n  /** Create a new set of groups for the specified `modelIds`. If `provider` is supplied, the grouping will be applied to those models immediately. */\r\n  public constructor(modelIds: Id64Set, provider?: ModelDisplayTransformProvider) {\r\n    this._modelIds = modelIds;\r\n    if (provider)\r\n      this.update(provider);\r\n  }\r\n\r\n  /** A string uniquely identifying the current grouping. */\r\n  public get guid(): string { return this._state.guid; }\r\n\r\n  /** Get the display transform for the specified model.\r\n   * @note This method is guaranteed to return the same object for all models in the same group, at least between calls to `update`.\r\n   */\r\n  public getDisplayTransform(modelId: Id64String): ModelDisplayTransform | undefined {\r\n    return this._state.transforms.find((x) => x.modelIds.has(modelId))?.transform;\r\n  }\r\n\r\n  // Update the display transforms and the model groupings based on the transforms supplied by `provider`.\r\n  // Return `true` if the groupings changed as a result.\r\n  public update(provider: ModelDisplayTransformProvider | undefined): boolean {\r\n    const prevState = this._state;\r\n    this._state = this.computeState(provider);\r\n    return this._state.guid !== prevState.guid;\r\n  }\r\n\r\n  private computeState(provider: ModelDisplayTransformProvider | undefined): ModelGroupDisplayTransformsState {\r\n    if (!provider)\r\n      return emptyState;\r\n\r\n    const transforms: ModelGroupDisplayTransform[] = [];\r\n    for (const modelId of this._modelIds) {\r\n      const transform = provider.getModelDisplayTransform(modelId);\r\n      if (transform) {\r\n        let entry = transforms.find((x) => equalDisplayTransforms(transform, x.transform));\r\n        if (!entry)\r\n          transforms.push(entry = { transform, modelIds: new Set() });\r\n\r\n        entry.modelIds.add(modelId);\r\n      }\r\n    }\r\n\r\n    if (transforms.length === 0)\r\n      return emptyState;\r\n\r\n    const guid = transforms.map((x) => CompressedId64Set.compressSet(x.modelIds)).sort().join(\"_\");\r\n    return { transforms, guid };\r\n  }\r\n}\r\n"]}

package/lib/esm/BatchedModelGroups.d.ts

@@ -0,0 +1,45 @@
+import { ModelGroupDisplayTransforms } from "./ModelGroupDisplayTransforms";
+import { ModelGroup, ModelGroupingContext } from "./ModelGroup";
+import { RenderClipVolume, SpatialViewState } from "@itwin/core-frontend";
+import { Id64Set, Id64String } from "@itwin/core-bentley";
+import { PlanProjectionSettings, RenderSchedule, ViewFlagOverrides } from "@itwin/core-common";
+import { ModelMetadata } from "./BatchedTilesetReader";
+/** Groups the set of spatial models included in a [[BatchedSpatialTileTreeReferences]] based on their display settings.
+ * This ensures that models are displayed correctly, while using batching to reduce the number of draw calls to a minimum.
+ * The groupings are re-evaluated only when there's a possibility that they may have changed (e.g., if the view's plan projection settings or model clip groups were modified).
+ * Unfortunately, there is currently no way to know when the transforms supplied by a [ModelDisplayTransformProvider]($frontend) may have changed, so
+ * display transforms are re-evaluated every time the Viewport's scene is invalidated. This may (but usually won't) affect the groupings.
+ * The BatchedSpatialTileTreeReferences object allocates new [[BatchedTileTreeReferences]] whenever the groupings change.
+ * @internal
+ */
+export declare class BatchedModelGroups implements ModelGroupingContext {
+    private readonly _view;
+    private readonly _includedModelIds;
+    private readonly _metadata;
+    private _script?;
+    private _transformsValid;
+    private _groupsValid;
+    private _scriptValid;
+    /** A stringified representation of the current groupings, of the format:
+     * group1_group2_group3_..._groupN
+     * where each group is a [CompressedId64Set]($bentley).
+     * @see [[BatchedTileTreeId.modelGroups]].
+     */
+    guid: string;
+    groups: ModelGroup[];
+    modelGroupDisplayTransforms: ModelGroupDisplayTransforms;
+    constructor(view: SpatialViewState, script: RenderSchedule.Script | undefined, includedModelIds: Id64Set, metadata: Map<Id64String, ModelMetadata>);
+    setScript(script: RenderSchedule.Script | undefined): void;
+    invalidateTransforms(): void;
+    private listenForDisplayStyleEvents;
+    getModelClip(modelId: Id64String): RenderClipVolume | undefined;
+    getPlanProjectionSettings(modelId: Id64String): PlanProjectionSettings | undefined;
+    getModelTimeline(modelId: Id64String): RenderSchedule.ModelTimeline | undefined;
+    getViewFlagOverrides(modelId: Id64String): ViewFlagOverrides | undefined;
+    getDefaultElevation(modelId: Id64String): number;
+    /** Re-evaluate transforms and groupings if they may be out of date.
+     * @returns true if the groupings changed as a result.
+     */
+    update(): boolean;
+}
+//# sourceMappingURL=BatchedModelGroups.d.ts.map

package/lib/esm/BatchedModelGroups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BatchedModelGroups.d.ts","sourceRoot":"","sources":["../../src/BatchedModelGroups.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAe,UAAU,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAA6B,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACrF,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC/F,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD;;;;;;;GAOG;AACH,qBAAa,kBAAmB,YAAW,oBAAoB;IAC7D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAmB;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiC;IAC3D,OAAO,CAAC,OAAO,CAAC,CAAwB;IACxC,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,YAAY,CAAS;IAC7B;;;;OAIG;IACI,IAAI,SAAM;IACV,MAAM,EAAE,UAAU,EAAE,CAAM;IAC1B,2BAA2B,EAAE,2BAA2B,CAAC;gBAE7C,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM,GAAG,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC;IAclJ,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM,GAAG,SAAS,GAAG,IAAI;IAK1D,oBAAoB,IAAI,IAAI;IAEnC,OAAO,CAAC,2BAA2B;IAS5B,YAAY,CAAC,OAAO,EAAE,UAAU,GAAG,gBAAgB,GAAG,SAAS;IAI/D,yBAAyB,CAAC,OAAO,EAAE,UAAU,GAAG,sBAAsB,GAAG,SAAS;IAIlF,gBAAgB,CAAC,OAAO,EAAE,UAAU,GAAG,cAAc,CAAC,aAAa,GAAG,SAAS;IAI/E,oBAAoB,CAAC,OAAO,EAAE,UAAU,GAAG,iBAAiB,GAAG,SAAS;IAIxE,mBAAmB,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM;IAYvD;;OAEG;IACI,MAAM,IAAI,OAAO;CAqCzB"}

package/lib/esm/BatchedModelGroups.js

@@ -0,0 +1,106 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { ModelGroupDisplayTransforms } from "./ModelGroupDisplayTransforms";
+import { groupModels } from "./ModelGroup";
+import { assert, CompressedId64Set } from "@itwin/core-bentley";
+/** Groups the set of spatial models included in a [[BatchedSpatialTileTreeReferences]] based on their display settings.
+ * This ensures that models are displayed correctly, while using batching to reduce the number of draw calls to a minimum.
+ * The groupings are re-evaluated only when there's a possibility that they may have changed (e.g., if the view's plan projection settings or model clip groups were modified).
+ * Unfortunately, there is currently no way to know when the transforms supplied by a [ModelDisplayTransformProvider]($frontend) may have changed, so
+ * display transforms are re-evaluated every time the Viewport's scene is invalidated. This may (but usually won't) affect the groupings.
+ * The BatchedSpatialTileTreeReferences object allocates new [[BatchedTileTreeReferences]] whenever the groupings change.
+ * @internal
+ */
+export class BatchedModelGroups {
+    constructor(view, script, includedModelIds, metadata) {
+        this._transformsValid = false;
+        this._groupsValid = false;
+        this._scriptValid = false;
+        /** A stringified representation of the current groupings, of the format:
+         * group1_group2_group3_..._groupN
+         * where each group is a [CompressedId64Set]($bentley).
+         * @see [[BatchedTileTreeId.modelGroups]].
+         */
+        this.guid = "";
+        this.groups = [];
+        this._script = script;
+        this._view = view;
+        this._includedModelIds = includedModelIds;
+        this._metadata = metadata;
+        this.modelGroupDisplayTransforms = new ModelGroupDisplayTransforms(includedModelIds, view.modelDisplayTransformProvider);
+        this._view.onModelDisplayTransformProviderChanged.addListener(() => this._transformsValid = false);
+        this._view.details.onModelClipGroupsChanged.addListener(() => this._groupsValid = false);
+        this.listenForDisplayStyleEvents();
+        this.update();
+    }
+    setScript(script) {
+        this._script = script;
+        this._scriptValid = false;
+    }
+    invalidateTransforms() { this._transformsValid = false; }
+    listenForDisplayStyleEvents() {
+        const removeListener = this._view.displayStyle.settings.onPlanProjectionSettingsChanged.addListener(() => this._groupsValid = false);
+        this._view.onDisplayStyleChanged.addListener(() => {
+            this._groupsValid = false;
+            removeListener();
+            this.listenForDisplayStyleEvents();
+        });
+    }
+    getModelClip(modelId) {
+        return this._view.getModelClip(modelId);
+    }
+    getPlanProjectionSettings(modelId) {
+        return this._view.displayStyle.settings.getPlanProjectionSettings(modelId);
+    }
+    getModelTimeline(modelId) {
+        return this._script?.modelTimelines.find((x) => x.modelId === modelId);
+    }
+    getViewFlagOverrides(modelId) {
+        return this._metadata.get(modelId)?.viewFlags;
+    }
+    getDefaultElevation(modelId) {
+        const range = this._metadata.get(modelId)?.extents;
+        if (range) {
+            const low = range.low.z;
+            const high = range.high.z;
+            if (low <= high)
+                return (low + high) / 2;
+        }
+        return 0;
+    }
+    /** Re-evaluate transforms and groupings if they may be out of date.
+     * @returns true if the groupings changed as a result.
+     */
+    update() {
+        if (!this._transformsValid && this.modelGroupDisplayTransforms.update(this._view.modelDisplayTransformProvider)) {
+            this._groupsValid = false;
+        }
+        this._transformsValid = true;
+        if (this._groupsValid && this._scriptValid) {
+            // Update the display transforms on the ModelGroups.
+            const getFirstModelId = (ids) => {
+                for (const id of ids)
+                    return id;
+                return undefined;
+            };
+            for (const group of this.groups) {
+                if (group.displayTransform) {
+                    const modelId = getFirstModelId(group.modelIds);
+                    assert(undefined !== modelId);
+                    group.displayTransform = this.modelGroupDisplayTransforms.getDisplayTransform(modelId);
+                    assert(undefined !== group.displayTransform);
+                }
+            }
+            return false; // the groupings haven't changed.
+        }
+        this.groups = groupModels(this, this._includedModelIds);
+        const newGuid = this.groups.map((x) => CompressedId64Set.compressSet(x.modelIds)).join("_");
+        const updated = newGuid !== this.guid || !this._scriptValid;
+        this.guid = newGuid;
+        this._groupsValid = this._scriptValid = true;
+        return updated;
+    }
+}
+//# sourceMappingURL=BatchedModelGroups.js.map

package/lib/esm/BatchedModelGroups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BatchedModelGroups.js","sourceRoot":"","sources":["../../src/BatchedModelGroups.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAoC,MAAM,cAAc,CAAC;AAE7E,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAuB,MAAM,qBAAqB,CAAC;AAIrF;;;;;;;GAOG;AACH,MAAM,OAAO,kBAAkB;IAiB7B,YAAmB,IAAsB,EAAE,MAAyC,EAAE,gBAAyB,EAAE,QAAwC;QAZjJ,qBAAgB,GAAG,KAAK,CAAC;QACzB,iBAAY,GAAG,KAAK,CAAC;QACrB,iBAAY,GAAG,KAAK,CAAC;QAC7B;;;;WAIG;QACI,SAAI,GAAG,EAAE,CAAC;QACV,WAAM,GAAiB,EAAE,CAAC;QAI/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,2BAA2B,GAAG,IAAI,2BAA2B,CAAC,gBAAgB,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAEzH,IAAI,CAAC,KAAK,CAAC,sCAAsC,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,CAAC;QACnG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,wBAAwB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,CAAC;QACzF,IAAI,CAAC,2BAA2B,EAAE,CAAC;QAEnC,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAEM,SAAS,CAAC,MAAyC;QACxD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAEM,oBAAoB,KAAW,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,CAAC,CAAC;IAE9D,2BAA2B;QACjC,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,+BAA+B,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,CAAC;QACrI,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,WAAW,CAAC,GAAG,EAAE;YAChD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;YAC1B,cAAc,EAAE,CAAC;YACjB,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,YAAY,CAAC,OAAmB;QACrC,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAEM,yBAAyB,CAAC,OAAmB;QAClD,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAC7E,CAAC;IAEM,gBAAgB,CAAC,OAAmB;QACzC,OAAO,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,oBAAoB,CAAC,OAAmB;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;IAChD,CAAC;IAEM,mBAAmB,CAAC,OAAmB;QAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QACnD,IAAI,KAAK,EAAE;YACT,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YACxB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1B,IAAI,GAAG,IAAI,IAAI;gBACb,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;SAC3B;QAED,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;OAEG;IACI,MAAM;QACX,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,EAAE;YAC/G,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;SAC3B;QAED,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,EAAE;YAC1C,oDAAoD;YACpD,MAAM,eAAe,GAAG,CAAC,GAAY,EAAE,EAAE;gBACvC,KAAK,MAAM,EAAE,IAAI,GAAG;oBAClB,OAAO,EAAE,CAAC;gBAEZ,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC;YAEF,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;gBAC/B,IAAI,KAAK,CAAC,gBAAgB,EAAE;oBAC1B,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBAChD,MAAM,CAAC,SAAS,KAAK,OAAO,CAAC,CAAC;oBAC9B,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,2BAA2B,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;oBACvF,MAAM,CAAC,SAAS,KAAK,KAAK,CAAC,gBAAgB,CAAC,CAAC;iBAC9C;aACF;YAED,OAAO,KAAK,CAAC,CAAC,iCAAiC;SAChD;QAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5F,MAAM,OAAO,GAAG,OAAO,KAAK,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;QAE5D,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAE7C,OAAO,OAAO,CAAC;IACjB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { ModelGroupDisplayTransforms } from \"./ModelGroupDisplayTransforms\";\r\nimport { groupModels, ModelGroup, ModelGroupingContext } from \"./ModelGroup\";\r\nimport { RenderClipVolume, SpatialViewState } from \"@itwin/core-frontend\";\r\nimport { assert, CompressedId64Set, Id64Set, Id64String } from \"@itwin/core-bentley\";\r\nimport { PlanProjectionSettings, RenderSchedule, ViewFlagOverrides } from \"@itwin/core-common\";\r\nimport { ModelMetadata } from \"./BatchedTilesetReader\";\r\n\r\n/** Groups the set of spatial models included in a [[BatchedSpatialTileTreeReferences]] based on their display settings.\r\n * This ensures that models are displayed correctly, while using batching to reduce the number of draw calls to a minimum.\r\n * The groupings are re-evaluated only when there's a possibility that they may have changed (e.g., if the view's plan projection settings or model clip groups were modified).\r\n * Unfortunately, there is currently no way to know when the transforms supplied by a [ModelDisplayTransformProvider]($frontend) may have changed, so\r\n * display transforms are re-evaluated every time the Viewport's scene is invalidated. This may (but usually won't) affect the groupings.\r\n * The BatchedSpatialTileTreeReferences object allocates new [[BatchedTileTreeReferences]] whenever the groupings change.\r\n * @internal\r\n */\r\nexport class BatchedModelGroups implements ModelGroupingContext {\r\n  private readonly _view: SpatialViewState;\r\n  private readonly _includedModelIds: Id64Set;\r\n  private readonly _metadata: Map<Id64String, ModelMetadata>;\r\n  private _script?: RenderSchedule.Script;\r\n  private _transformsValid = false;\r\n  private _groupsValid = false;\r\n  private _scriptValid = false;\r\n  /** A stringified representation of the current groupings, of the format:\r\n   * group1_group2_group3_..._groupN\r\n   * where each group is a [CompressedId64Set]($bentley).\r\n   * @see [[BatchedTileTreeId.modelGroups]].\r\n   */\r\n  public guid = \"\";\r\n  public groups: ModelGroup[] = [];\r\n  public modelGroupDisplayTransforms: ModelGroupDisplayTransforms;\r\n\r\n  public constructor(view: SpatialViewState, script: RenderSchedule.Script | undefined, includedModelIds: Id64Set, metadata: Map<Id64String, ModelMetadata>) {\r\n    this._script = script;\r\n    this._view = view;\r\n    this._includedModelIds = includedModelIds;\r\n    this._metadata = metadata;\r\n    this.modelGroupDisplayTransforms = new ModelGroupDisplayTransforms(includedModelIds, view.modelDisplayTransformProvider);\r\n\r\n    this._view.onModelDisplayTransformProviderChanged.addListener(() => this._transformsValid = false);\r\n    this._view.details.onModelClipGroupsChanged.addListener(() => this._groupsValid = false);\r\n    this.listenForDisplayStyleEvents();\r\n\r\n    this.update();\r\n  }\r\n\r\n  public setScript(script: RenderSchedule.Script | undefined): void {\r\n    this._script = script;\r\n    this._scriptValid = false;\r\n  }\r\n\r\n  public invalidateTransforms(): void { this._transformsValid = false; }\r\n\r\n  private listenForDisplayStyleEvents(): void {\r\n    const removeListener = this._view.displayStyle.settings.onPlanProjectionSettingsChanged.addListener(() => this._groupsValid = false);\r\n    this._view.onDisplayStyleChanged.addListener(() => {\r\n      this._groupsValid = false;\r\n      removeListener();\r\n      this.listenForDisplayStyleEvents();\r\n    });\r\n  }\r\n\r\n  public getModelClip(modelId: Id64String): RenderClipVolume | undefined {\r\n    return this._view.getModelClip(modelId);\r\n  }\r\n\r\n  public getPlanProjectionSettings(modelId: Id64String): PlanProjectionSettings | undefined {\r\n    return this._view.displayStyle.settings.getPlanProjectionSettings(modelId);\r\n  }\r\n\r\n  public getModelTimeline(modelId: Id64String): RenderSchedule.ModelTimeline | undefined {\r\n    return this._script?.modelTimelines.find((x) => x.modelId === modelId);\r\n  }\r\n\r\n  public getViewFlagOverrides(modelId: Id64String): ViewFlagOverrides | undefined {\r\n    return this._metadata.get(modelId)?.viewFlags;\r\n  }\r\n\r\n  public getDefaultElevation(modelId: Id64String): number {\r\n    const range = this._metadata.get(modelId)?.extents;\r\n    if (range) {\r\n      const low = range.low.z;\r\n      const high = range.high.z;\r\n      if (low <= high)\r\n        return (low + high) / 2;\r\n    }\r\n\r\n    return 0;\r\n  }\r\n\r\n  /** Re-evaluate transforms and groupings if they may be out of date.\r\n   * @returns true if the groupings changed as a result.\r\n   */\r\n  public update(): boolean {\r\n    if (!this._transformsValid && this.modelGroupDisplayTransforms.update(this._view.modelDisplayTransformProvider)) {\r\n      this._groupsValid = false;\r\n    }\r\n\r\n    this._transformsValid = true;\r\n    if (this._groupsValid && this._scriptValid) {\r\n      // Update the display transforms on the ModelGroups.\r\n      const getFirstModelId = (ids: Id64Set) => {\r\n        for (const id of ids)\r\n          return id;\r\n\r\n        return undefined;\r\n      };\r\n\r\n      for (const group of this.groups) {\r\n        if (group.displayTransform) {\r\n          const modelId = getFirstModelId(group.modelIds);\r\n          assert(undefined !== modelId);\r\n          group.displayTransform = this.modelGroupDisplayTransforms.getDisplayTransform(modelId);\r\n          assert(undefined !== group.displayTransform);\r\n        }\r\n      }\r\n\r\n      return false; // the groupings haven't changed.\r\n    }\r\n\r\n    this.groups = groupModels(this, this._includedModelIds);\r\n    const newGuid = this.groups.map((x) => CompressedId64Set.compressSet(x.modelIds)).join(\"_\");\r\n\r\n    const updated = newGuid !== this.guid || !this._scriptValid;\r\n\r\n    this.guid = newGuid;\r\n    this._groupsValid = this._scriptValid = true;\r\n\r\n    return updated;\r\n  }\r\n}\r\n"]}

package/lib/esm/BatchedModels.d.ts

@@ -1,12 +1,13 @@
 import { Id64String } from "@itwin/core-bentley";
 import { Range3d } from "@itwin/core-geometry";
 import { SpatialViewState } from "@itwin/core-frontend";
+import { ModelMetadata } from "./BatchedTilesetReader";
 export declare class BatchedModels {
     private _viewedModels;
     private readonly _viewedExtents;
     private readonly _viewedModelIdPairs;
-    private readonly _ranges;
-    constructor(view: SpatialViewState, ranges: Map<Id64String, Range3d>);
+    private readonly _metadata;
+    constructor(view: SpatialViewState, metadata: Map<Id64String, ModelMetadata>);
     setViewedModels(models: Set<Id64String>): void;
     views(modelId: Id64String): boolean;
     isViewed(modelIdLo: number, modelIdHi: number): boolean;

package/lib/esm/BatchedModels.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BatchedModels.d.ts","sourceRoot":"","sources":["../../src/BatchedModels.ts"],"names":[],"mappings":"AAKA,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,qBAAa,aAAa;IACxB,OAAO,CAAC,aAAa,CAAmB;IACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAwB;IAC5D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;gBAEhC,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC;IAKpE,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI;IAa9C,KAAK,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO;IAInC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO;IAIvD,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAGxC"}
+{"version":3,"file":"BatchedModels.d.ts","sourceRoot":"","sources":["../../src/BatchedModels.ts"],"names":[],"mappings":"AAKA,OAAO,EAAQ,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBAAa,aAAa;IACxB,OAAO,CAAC,aAAa,CAAmB;IACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAwB;IAC5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiC;gBAExC,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC;IAK5E,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI;IAa9C,KAAK,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO;IAInC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO;IAIvD,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAGxC"}

package/lib/esm/BatchedModels.js

@@ -5,10 +5,10 @@
 import { Id64 } from "@itwin/core-bentley";
 import { Range3d } from "@itwin/core-geometry";
 export class BatchedModels {
-    constructor(view, ranges) {
+    constructor(view, metadata) {
         this._viewedExtents = new Range3d();
         this._viewedModelIdPairs = new Id64.Uint32Set();
-        this._ranges = ranges;
+        this._metadata = metadata;
         this.setViewedModels(view.modelSelector.models);
     }
     setViewedModels(models) {
@@ -17,7 +17,7 @@ export class BatchedModels {
         this._viewedModelIdPairs.addIds(models);
         this._viewedExtents.setNull();
         for (const modelId of models) {
-            const range = this._ranges.get(modelId);
+            const range = this._metadata.get(modelId)?.extents;
             if (range)
                 this._viewedExtents.extendRange(range);
         }

package/lib/esm/BatchedModels.js.map

@@ -1 +1 @@
-{"version":3,"file":"BatchedModels.js","sourceRoot":"","sources":["../../src/BatchedModels.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG/C,MAAM,OAAO,aAAa;IAMxB,YAAmB,IAAsB,EAAE,MAAgC;QAJ1D,mBAAc,GAAG,IAAI,OAAO,EAAE,CAAC;QAC/B,wBAAmB,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QAI1D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAEM,eAAe,CAAC,MAAuB;QAC5C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;QAC5B,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;QACjC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAE9B,KAAK,MAAM,OAAO,IAAI,MAAM,EAAE;YAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,KAAK;gBACP,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;SAC1C;IACH,CAAC;IAEM,KAAK,CAAC,OAAmB;QAC9B,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAEM,QAAQ,CAAC,SAAiB,EAAE,SAAiB;QAClD,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IAEM,UAAU,CAAC,KAAc;QAC9B,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\nimport { SpatialViewState } from \"@itwin/core-frontend\";\r\n\r\nexport class BatchedModels {\r\n  private _viewedModels!: Set<Id64String>;\r\n  private readonly _viewedExtents = new Range3d();\r\n  private readonly _viewedModelIdPairs = new Id64.Uint32Set();\r\n  private readonly _ranges: Map<Id64String, Range3d>;\r\n\r\n  public constructor(view: SpatialViewState, ranges: Map<Id64String, Range3d>) {\r\n    this._ranges = ranges;\r\n    this.setViewedModels(view.modelSelector.models);\r\n  }\r\n\r\n  public setViewedModels(models: Set<Id64String>): void {\r\n    this._viewedModels = models;\r\n    this._viewedModelIdPairs.clear();\r\n    this._viewedModelIdPairs.addIds(models);\r\n    this._viewedExtents.setNull();\r\n\r\n    for (const modelId of models) {\r\n      const range = this._ranges.get(modelId);\r\n      if (range)\r\n        this._viewedExtents.extendRange(range);\r\n    }\r\n  }\r\n\r\n  public views(modelId: Id64String): boolean {\r\n    return this._viewedModels.has(modelId);\r\n  }\r\n\r\n  public isViewed(modelIdLo: number, modelIdHi: number): boolean {\r\n    return this._viewedModelIdPairs.has(modelIdLo, modelIdHi);\r\n  }\r\n\r\n  public unionRange(range: Range3d): void {\r\n    range.extendRange(this._viewedExtents);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BatchedModels.js","sourceRoot":"","sources":["../../src/BatchedModels.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAI/C,MAAM,OAAO,aAAa;IAMxB,YAAmB,IAAsB,EAAE,QAAwC;QAJlE,mBAAc,GAAG,IAAI,OAAO,EAAE,CAAC;QAC/B,wBAAmB,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QAI1D,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAEM,eAAe,CAAC,MAAuB;QAC5C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;QAC5B,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;QACjC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAE9B,KAAK,MAAM,OAAO,IAAI,MAAM,EAAE;YAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;YACnD,IAAI,KAAK;gBACP,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;SAC1C;IACH,CAAC;IAEM,KAAK,CAAC,OAAmB;QAC9B,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAEM,QAAQ,CAAC,SAAiB,EAAE,SAAiB;QAClD,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IAEM,UAAU,CAAC,KAAc;QAC9B,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Range3d } from \"@itwin/core-geometry\";\r\nimport { SpatialViewState } from \"@itwin/core-frontend\";\r\nimport { ModelMetadata } from \"./BatchedTilesetReader\";\r\n\r\nexport class BatchedModels {\r\n  private _viewedModels!: Set<Id64String>;\r\n  private readonly _viewedExtents = new Range3d();\r\n  private readonly _viewedModelIdPairs = new Id64.Uint32Set();\r\n  private readonly _metadata: Map<Id64String, ModelMetadata>;\r\n\r\n  public constructor(view: SpatialViewState, metadata: Map<Id64String, ModelMetadata>) {\r\n    this._metadata = metadata;\r\n    this.setViewedModels(view.modelSelector.models);\r\n  }\r\n\r\n  public setViewedModels(models: Set<Id64String>): void {\r\n    this._viewedModels = models;\r\n    this._viewedModelIdPairs.clear();\r\n    this._viewedModelIdPairs.addIds(models);\r\n    this._viewedExtents.setNull();\r\n\r\n    for (const modelId of models) {\r\n      const range = this._metadata.get(modelId)?.extents;\r\n      if (range)\r\n        this._viewedExtents.extendRange(range);\r\n    }\r\n  }\r\n\r\n  public views(modelId: Id64String): boolean {\r\n    return this._viewedModels.has(modelId);\r\n  }\r\n\r\n  public isViewed(modelIdLo: number, modelIdHi: number): boolean {\r\n    return this._viewedModelIdPairs.has(modelIdLo, modelIdHi);\r\n  }\r\n\r\n  public unionRange(range: Range3d): void {\r\n    range.extendRange(this._viewedExtents);\r\n  }\r\n}\r\n"]}

package/lib/esm/BatchedSpatialTileTreeRefs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BatchedSpatialTileTreeRefs.d.ts","sourceRoot":"","sources":["../../src/BatchedSpatialTileTreeRefs.ts"],"names":[],"mappings":"AAOA,OAAO,EACoE,yBAAyB,EAAE,gBAAgB,EAErH,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAsN/D,gBAAgB;AAChB,wBAAgB,sCAAsC,CAAC,IAAI,EAAE,gBAAgB,EAAE,cAAc,EAAE,4BAA4B,GAAG,yBAAyB,CA0BtJ"}
+{"version":3,"file":"BatchedSpatialTileTreeRefs.d.ts","sourceRoot":"","sources":["../../src/BatchedSpatialTileTreeRefs.ts"],"names":[],"mappings":"AAOA,OAAO,EAEoE,yBAAyB,EAAE,gBAAgB,EAErH,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AA+O/D,gBAAgB;AAChB,wBAAgB,sCAAsC,CAAC,IAAI,EAAE,gBAAgB,EAAE,cAAc,EAAE,4BAA4B,GAAG,yBAAyB,CA0BtJ"}

package/lib/esm/BatchedSpatialTileTreeRefs.js

@@ -2,29 +2,44 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
-import { assert, Logger } from "@itwin/core-bentley";
-import { createSpatialTileTreeReferences, TileTreeLoadStatus, TileTreeReference, } from "@itwin/core-frontend";
-import { AnimatedBatchedTileTreeReference, PrimaryBatchedTileTreeReference } from "./BatchedTileTreeReference";
+import { Logger } from "@itwin/core-bentley";
+import { AnimationNodeId, createSpatialTileTreeReferences, TileTreeLoadStatus, TileTreeReference, } from "@itwin/core-frontend";
+import { BatchedTileTreeReference } from "./BatchedTileTreeReference";
 import { getBatchedTileTreeOwner } from "./BatchedTileTreeSupplier";
 import { BatchedModels } from "./BatchedModels";
 import { BatchedTilesetSpec } from "./BatchedTilesetReader";
 import { loggerCategory } from "./LoggerCategory";
+import { BatchedModelGroups } from "./BatchedModelGroups";
 // Obtains tiles pre-published by mesh export service.
 class BatchedSpatialTileTreeReferences {
     constructor(spec, view) {
-        this._animatedRefs = [];
+        this._refs = [];
         this._view = view;
-        this._models = new BatchedModels(view, spec.includedModels);
+        this._models = new BatchedModels(view, spec.models);
+        this._spec = spec;
         const script = view.displayStyle.scheduleScript;
         this._currentScript = script?.requiresBatching ? script : undefined;
-        this._excludedRefs = createSpatialTileTreeReferences(view, new Set(spec.includedModels.keys()));
-        this.load(spec, view.iModel);
-        assert(undefined !== this._primaryRef);
-    }
-    load(spec, iModel) {
-        const treeOwner = getBatchedTileTreeOwner(iModel, { spec, script: this._currentScript });
-        this._primaryRef = new PrimaryBatchedTileTreeReference(treeOwner, this._models);
-        this.populateAnimatedReferences(treeOwner);
+        const includedModels = new Set(spec.models.keys());
+        this._excludedRefs = createSpatialTileTreeReferences(view, includedModels);
+        this._groups = new BatchedModelGroups(view, this._currentScript, includedModels, spec.models);
+        this._treeOwner = this.getTreeOwner();
+        this.loadRefs();
+        this.listenForScriptChange();
+    }
+    ensureLoaded() {
+        if (!this._groups.update())
+            return;
+        this._treeOwner = this.getTreeOwner();
+        this.loadRefs();
+    }
+    getTreeOwner() {
+        return getBatchedTileTreeOwner(this._view.iModel, {
+            spec: this._spec,
+            script: this._currentScript,
+            modelGroups: this._groups.guid,
+        });
+    }
+    listenForScriptChange() {
         const onScriptChanged = (newScript) => {
             if (!newScript?.requiresBatching)
                 newScript = undefined;
@@ -32,39 +47,40 @@ class BatchedSpatialTileTreeReferences {
             this._currentScript = newScript;
             if (newScript !== currentScript)
                 if (!newScript || !currentScript || !newScript.equals(currentScript))
-                    this.load(spec, iModel);
+                    this._groups.setScript(newScript);
         };
-        let removeScriptChangedListener = this._view.displayStyle.onScheduleScriptChanged.addListener((newScript) => onScriptChanged(newScript));
+        let rmListener = this._view.displayStyle.onScheduleScriptChanged.addListener((newScript) => onScriptChanged(newScript));
         this._view.onDisplayStyleChanged.addListener((newStyle) => {
-            removeScriptChangedListener();
+            rmListener();
             onScriptChanged(newStyle.scheduleScript);
-            removeScriptChangedListener = this._view.displayStyle.onScheduleScriptChanged.addListener((newScript) => onScriptChanged(newScript));
+            rmListener = this._view.displayStyle.onScheduleScriptChanged.addListener((newScript) => onScriptChanged(newScript));
         });
     }
-    *[Symbol.iterator]() {
-        yield this._primaryRef;
-        for (const animatedRef of this._animatedRefs)
-            yield animatedRef;
-        for (const excludedRef of this._excludedRefs)
-            yield excludedRef;
-    }
-    populateAnimatedReferences(treeOwner) {
-        this._animatedRefs.length = 0;
-        const script = this._currentScript;
-        if (!script)
-            return;
-        const getCurrentTimePoint = () => this._view.displayStyle.settings.timePoint ?? script.duration.low;
-        for (const timeline of script.modelTimelines) {
-            const nodeIds = timeline.transformBatchIds;
-            for (const nodeId of nodeIds) {
-                this._animatedRefs.push(new AnimatedBatchedTileTreeReference(treeOwner, {
-                    timeline,
-                    nodeId,
-                    getCurrentTimePoint,
-                }));
+    loadRefs() {
+        this._refs.length = 0;
+        const groups = this._groups.groups;
+        const args = {
+            models: this._models,
+            groups,
+            treeOwner: this._treeOwner,
+            getCurrentTimePoint: () => this._currentScript ? (this._view.displayStyle.settings.timePoint ?? this._currentScript.duration.low) : 0,
+        };
+        for (let i = 0; i < groups.length; i++) {
+            const timeline = groups[i].timeline;
+            this._refs.push(new BatchedTileTreeReference(args, i, timeline ? AnimationNodeId.Untransformed : undefined));
+            if (timeline) {
+                for (const nodeId of timeline.transformBatchIds)
+                    this._refs.push(new BatchedTileTreeReference(args, i, nodeId));
             }
         }
     }
+    *[Symbol.iterator]() {
+        this.ensureLoaded();
+        for (const ref of this._refs)
+            yield ref;
+        for (const ref of this._excludedRefs)
+            yield ref;
+    }
     update() {
         this._excludedRefs.update();
         this._models.setViewedModels(this._view.modelSelector.models);
@@ -74,10 +90,15 @@ class BatchedSpatialTileTreeReferences {
     attachToViewport(args) {
         this._onModelSelectorChanged = () => args.invalidateSymbologyOverrides();
         this._excludedRefs.attachToViewport(args);
+        this._removeSceneInvalidationListener = args.onSceneInvalidated.addListener(() => this._groups.invalidateTransforms());
     }
     detachFromViewport() {
         this._onModelSelectorChanged = undefined;
         this._excludedRefs.detachFromViewport();
+        if (this._removeSceneInvalidationListener) {
+            this._removeSceneInvalidationListener();
+            this._removeSceneInvalidationListener = undefined;
+        }
     }
     setDeactivated() {
         // Used for debugging. Unimplemented here.