@itwin/core-common 4.0.0-dev.46 → 4.0.0-dev.50

package/lib/cjs/FeatureTable.d.ts

@@ -13,8 +13,8 @@ import { GeometryClass } from "./GeometryParams";
  * @public
  */
 export declare class Feature {
-    readonly elementId: string;
-    readonly subCategoryId: string;
+    readonly elementId: Id64String;
+    readonly subCategoryId: Id64String;
     readonly geometryClass: GeometryClass;
     constructor(elementId?: Id64String, subCategoryId?: Id64String, geometryClass?: GeometryClass);
     get isDefined(): boolean;
@@ -27,13 +27,41 @@ export declare class Feature {
      */
     compare(rhs: Feature): number;
 }
+/** A [[Feature]] with a modelId identifying the model containing the feature.
+ * Typically produced from a PackedFeature.
+ * Prior to the introduction of MultiModelPackedFeatureTable, every (Packed)FeatureTable was associated with exactly one model.
+ * Now, each feature in a table may be associated with a different model.
+ * @internal
+ */
+export interface ModelFeature {
+    modelId: Id64String;
+    elementId: Id64String;
+    subCategoryId: Id64String;
+    geometryClass: GeometryClass;
+}
+/** @internal */
+export declare namespace ModelFeature {
+    function create(): ModelFeature;
+    function isDefined(feature: ModelFeature): boolean;
+    function unpack(packed: PackedFeature, result: ModelFeature, unpackedModelId?: Id64String): ModelFeature;
+}
 /** @internal */
 export interface PackedFeature {
+    modelId: Id64.Uint32Pair;
     elementId: Id64.Uint32Pair;
     subCategoryId: Id64.Uint32Pair;
     geometryClass: GeometryClass;
     animationNodeId: number;
 }
+/** @internal */
+export interface PackedFeatureWithIndex extends PackedFeature {
+    index: number;
+}
+/** @internal */
+export declare namespace PackedFeature {
+    function create(): PackedFeature;
+    function createWithIndex(): PackedFeatureWithIndex;
+}
 /** Describes the type of a 'batch' of graphics representing multiple [[Feature]]s.
  * The most commonly-encountered batches are Tiles, which can be of either Primary or
  * Classifier type.
@@ -90,15 +118,44 @@ export declare class FeatureTable extends IndexMap<Feature> {
 }
 /** @alpha */
 export declare type ComputeNodeId = (elementId: Id64.Uint32Pair, featureIndex: number) => number;
+/** Interface common to PackedFeatureTable and MultiModelPackedFeatureTable.
+ * @internal
+ */
+export interface RenderFeatureTable {
+    /** The "model Id" of the tile tree containing the tile from which this feature table originated.
+     * It may be a transient Id if, for example, the tile tree represents a reality model or represents the geometry of multiple
+     * persistent models batched together.
+     */
+    readonly batchModelId: Id64String;
+    /** Split representation of batchModelId, so we're not constantly having to parse the string. */
+    readonly batchModelIdPair: Id64.Uint32Pair;
+    /** The number of features in the table; equivalently, one more than the largest feature index. */
+    readonly numFeatures: number;
+    /** Strictly for reporting memory usage. */
+    readonly byteLength: number;
+    readonly type: BatchType;
+    /** Get the feature at the specified index. Caller is responsible for validating featureIndex less than numFeatures. */
+    getFeature(featureIndex: number, result: ModelFeature): ModelFeature;
+    /** Find the specified feature. Returns undefined if featureIndex >= numFeatures. */
+    findFeature(featureIndex: number, result: ModelFeature): ModelFeature | undefined;
+    /** Find the Id of the element of the specified feature. */
+    findElementId(featureIndex: number): Id64String | undefined;
+    /** Get the Id of the element of the specified feature as a pair of 32-bit integers, asserting that feature index < numFeatures. */
+    getElementIdPair(featureIndex: number, out: Id64.Uint32Pair): Id64.Uint32Pair;
+    /** Get the feature at the specified index. Caller is responsible for validating featureIndex less than numFeatures. */
+    getPackedFeature(featureIndex: number, result: PackedFeature): PackedFeature;
+    /** Get an object that provides iteration over all features, in order. `output` is reused as the current value on each iteration. */
+    iterable(output: PackedFeatureWithIndex): Iterable<PackedFeatureWithIndex>;
+}
 /**
  * An immutable, packed representation of a [[FeatureTable]]. The features are packed into a single array of 32-bit integer values,
  * wherein each feature occupies 3 32-bit integers.
  * @internal
  */
-export declare class PackedFeatureTable {
+export declare class PackedFeatureTable implements RenderFeatureTable {
     private readonly _data;
-    readonly modelId: Id64String;
-    readonly maxFeatures: number;
+    readonly batchModelId: Id64String;
+    readonly batchModelIdPair: Id64.Uint32Pair;
     readonly numFeatures: number;
     readonly anyDefined: boolean;
     readonly type: BatchType;
@@ -109,13 +166,13 @@ export declare class PackedFeatureTable {
      * This is used internally when deserializing Tiles in iMdl format.
      * @internal
      */
-    constructor(data: Uint32Array, modelId: Id64String, numFeatures: number, maxFeatures: number, type: BatchType, animationNodeIds?: Uint8Array | Uint16Array | Uint32Array);
+    constructor(data: Uint32Array, modelId: Id64String, numFeatures: number, type: BatchType, animationNodeIds?: Uint8Array | Uint16Array | Uint32Array);
     /** Create a packed feature table from a [[FeatureTable]]. */
     static pack(featureTable: FeatureTable): PackedFeatureTable;
     /** Retrieve the Feature associated with the specified index. */
-    getFeature(featureIndex: number): Feature;
+    getFeature(featureIndex: number, result: ModelFeature): ModelFeature;
     /** Returns the Feature associated with the specified index, or undefined if the index is out of range. */
-    findFeature(featureIndex: number): Feature | undefined;
+    findFeature(featureIndex: number, result: ModelFeature): ModelFeature | undefined;
     /** @internal */
     getElementIdPair(featureIndex: number, out?: Id64.Uint32Pair): Id64.Uint32Pair;
     /** @internal */
@@ -123,20 +180,70 @@ export declare class PackedFeatureTable {
     /** @internal */
     getAnimationNodeId(featureIndex: number): number;
     /** @internal */
-    getPackedFeature(featureIndex: number): PackedFeature;
+    getPackedFeature(featureIndex: number, result: PackedFeature): PackedFeature;
     /** Returns the element ID of the Feature associated with the specified index, or undefined if the index is out of range. */
     findElementId(featureIndex: number): Id64String | undefined;
     /** Return true if this table contains exactly 1 feature. */
     get isUniform(): boolean;
     /** If this table contains exactly 1 feature, return it. */
-    get uniform(): Feature | undefined;
+    getUniform(result: ModelFeature): ModelFeature | undefined;
     get isVolumeClassifier(): boolean;
     get isPlanarClassifier(): boolean;
     get isClassifier(): boolean;
     /** Unpack the features into a [[FeatureTable]]. */
     unpack(): FeatureTable;
     populateAnimationNodeIds(computeNodeId: ComputeNodeId, maxNodeId: number): void;
+    iterator(output: PackedFeatureWithIndex): Iterator<PackedFeatureWithIndex>;
+    iterable(output: PackedFeatureWithIndex): Iterable<PackedFeatureWithIndex>;
     private get _subCategoriesOffset();
     private readId;
 }
+interface PackedFeatureModelEntry {
+    lastFeatureIndex: number;
+    idLower: number;
+    idUpper: number;
+}
+/** A table of model Ids associated with a [[MultiModelPackedFeatureTable]].
+ * The feature indices in the packed feature table are grouped together by model, such that the first N features belong to model 1, the next M features to model 2, and so on.
+ * The model table itself consists of one entry per model, where each entry looks like:
+ *  indexOfLastFeatureInModel: u32
+ *  modelId: u64
+ * The modelId associated with a feature can therefore be derived by finding the entry in the model table with the highest indexOfLastFeatureInModel no greater than the feature index.
+ * This lookup can be optimized using binary search.
+ * Moreover, while iterating the feature table in sequence, the model table can be iterated in parallel so that no per-feature lookup of model Id is required.
+ * @internal
+ */
+export declare class PackedFeatureModelTable {
+    private readonly _data;
+    constructor(data: Uint32Array);
+    /** The number of models in the table. */
+    get length(): number;
+    get byteLength(): number;
+    private getLastFeatureIndex;
+    getEntry(modelIndex: number, result: PackedFeatureModelEntry): PackedFeatureModelEntry;
+    /** Get the Id of the model associated with the specified feature, or an invalid Id if the feature is not associated with any model. */
+    getModelIdPair(featureIndex: number, result?: Id64.Uint32Pair): Id64.Uint32Pair;
+}
+/** A PackedFeatureTable with a PackedFeatureModelTable appended to it, capable of storing features belonging to more than one model.
+ * @internal
+ */
+export declare class MultiModelPackedFeatureTable implements RenderFeatureTable {
+    private readonly _features;
+    private readonly _models;
+    constructor(features: PackedFeatureTable, models: PackedFeatureModelTable);
+    static create(data: Uint32Array, batchModelId: Id64String, numFeatures: number, type: BatchType, numSubCategories: number): MultiModelPackedFeatureTable;
+    get batchModelId(): string;
+    get batchModelIdPair(): Id64.Uint32Pair;
+    get numFeatures(): number;
+    get type(): BatchType;
+    get byteLength(): number;
+    getPackedFeature(featureIndex: number, result: PackedFeature): PackedFeature;
+    getFeature(featureIndex: number, result: ModelFeature): ModelFeature;
+    findFeature(featureIndex: number, result: ModelFeature): ModelFeature | undefined;
+    getElementIdPair(featureIndex: number, out: Id64.Uint32Pair): Id64.Uint32Pair;
+    findElementId(featureIndex: number): Id64String | undefined;
+    iterator(output: PackedFeatureWithIndex): Iterator<PackedFeatureWithIndex>;
+    iterable(output: PackedFeatureWithIndex): Iterable<PackedFeatureWithIndex>;
+}
+export {};
 //# sourceMappingURL=FeatureTable.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"FeatureTable.d.ts","sourceRoot":"","sources":["../../src/FeatureTable.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAA0C,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;;;;GAQG;AACH,qBAAa,OAAO;IAClB,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,SAAgB,aAAa,EAAE,MAAM,CAAC;IACtC,SAAgB,aAAa,EAAE,aAAa,CAAC;gBAE1B,SAAS,GAAE,UAAyB,EAAE,aAAa,GAAE,UAAyB,EAAE,aAAa,GAAE,aAAqC;IAMvJ,IAAW,SAAS,IAAI,OAAO,CAAmI;IAClK,IAAW,WAAW,IAAI,OAAO,CAA4B;IAE7D,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAEtC;;;OAGG;IACI,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM;CAcrC;AAED,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC;IAC3B,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC;IAC/B,aAAa,EAAE,aAAa,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;;;GAKG;AACH,oBAAY,SAAS;IACnB,4EAA4E;IAC5E,OAAO,IAAA;IACP;;;;OAIG;IACH,gBAAgB,IAAA;IAChB;;;;OAIG;IACH,gBAAgB,IAAA;CACjB;AAED;;;;;;;GAOG;AACH,qBAAa,YAAa,SAAQ,QAAQ,CAAC,OAAO,CAAC;IACjD,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,SAAgB,IAAI,EAAE,SAAS,CAAC;IAEhC,uCAAuC;gBACpB,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,UAAyB,EAAE,IAAI,GAAE,SAA6B;IAM/G,gFAAgF;IAChF,IAAW,WAAW,IAAI,MAAM,CAA8B;IAC9D,gBAAgB;IAChB,IAAW,UAAU,IAAI,OAAO,CAAqF;IACrH,0EAA0E;IAC1E,IAAW,SAAS,IAAI,OAAO,CAA8B;IAC7D,gHAAgH;IAChH,IAAW,OAAO,IAAI,OAAO,GAAG,SAAS,CAAiE;IAC1G,oGAAoG;IACpG,IAAW,kBAAkB,IAAI,OAAO,CAAqD;IAC7F,oGAAoG;IACpG,IAAW,kBAAkB,IAAI,OAAO,CAAqD;IAE7F,0GAA0G;IACnG,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAQtD,gBAAgB;IACT,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAQ7D,gBAAgB;IACT,QAAQ,IAAI,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;CAChD;AAED,aAAa;AACb,oBAAY,aAAa,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,EAAE,MAAM,KAAK,MAAM,CAAC;AAEzF;;;;GAIG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAc;IACpC,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,SAAgB,IAAI,EAAE,SAAS,CAAC;IAChC,OAAO,CAAC,iBAAiB,CAAC,CAAyC;IAEnE,IAAW,UAAU,IAAI,MAAM,CAAkC;IACjE,IAAW,gBAAgB,IAAI,QAAQ,CAAC,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC,GAAG,SAAS,CAAmC;IAE9H;;;OAGG;gBACgB,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,gBAAgB,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,WAAW;IAyB/K,6DAA6D;WAC/C,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,kBAAkB;IAuClE,gEAAgE;IACzD,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IAOhD,0GAA0G;IACnG,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI7D,gBAAgB;IACT,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU;IASrF,gBAAgB;IACT,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC,UAAU;IAQlE,gBAAgB;IACT,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;IAIvD,gBAAgB;IACT,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa;IAiB5D,4HAA4H;IACrH,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAOlE,4DAA4D;IAC5D,IAAW,SAAS,IAAI,OAAO,CAAmC;IAElE,2DAA2D;IAC3D,IAAW,OAAO,IAAI,OAAO,GAAG,SAAS,CAA4D;IAErG,IAAW,kBAAkB,IAAI,OAAO,CAAqD;IAC7F,IAAW,kBAAkB,IAAI,OAAO,CAAqD;IAC7F,IAAW,YAAY,IAAI,OAAO,CAA+D;IAEjG,mDAAmD;IAC5C,MAAM,IAAI,YAAY;IAUtB,wBAAwB,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAsBtF,OAAO,KAAK,oBAAoB,GAA2C;IAE3E,OAAO,CAAC,MAAM;CAGf"}
+{"version":3,"file":"FeatureTable.d.ts","sourceRoot":"","sources":["../../src/FeatureTable.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAA0C,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;;;;GAQG;AACH,qBAAa,OAAO;IAClB,SAAgB,SAAS,EAAE,UAAU,CAAC;IACtC,SAAgB,aAAa,EAAE,UAAU,CAAC;IAC1C,SAAgB,aAAa,EAAE,aAAa,CAAC;gBAE1B,SAAS,GAAE,UAAyB,EAAE,aAAa,GAAE,UAAyB,EAAE,aAAa,GAAE,aAAqC;IAMvJ,IAAW,SAAS,IAAI,OAAO,CAAmI;IAClK,IAAW,WAAW,IAAI,OAAO,CAA4B;IAE7D,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAEtC;;;OAGG;IACI,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM;CAcrC;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,UAAU,CAAC;IACpB,SAAS,EAAE,UAAU,CAAC;IACtB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,gBAAgB;AAChB,yBAAiB,YAAY,CAAC;IAC5B,SAAgB,MAAM,IAAI,YAAY,CAOrC;IAED,SAAgB,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAExD;IAED,SAAgB,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,eAAe,CAAC,EAAE,UAAU,GAAG,YAAY,CAM9G;CACF;AAED,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC;IACzB,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC;IAC3B,aAAa,EAAE,IAAI,CAAC,UAAU,CAAC;IAC/B,aAAa,EAAE,aAAa,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,gBAAgB;AAChB,MAAM,WAAW,sBAAuB,SAAQ,aAAa;IAC3D,KAAK,EAAE,MAAM,CAAC;CACf;AAED,gBAAgB;AAChB,yBAAiB,aAAa,CAAC;IAC7B,SAAgB,MAAM,IAAI,aAAa,CAStC;IAED,SAAgB,eAAe,IAAI,sBAAsB,CAIxD;CACF;AAED;;;;;GAKG;AACH,oBAAY,SAAS;IACnB,4EAA4E;IAC5E,OAAO,IAAA;IACP;;;;OAIG;IACH,gBAAgB,IAAA;IAChB;;;;OAIG;IACH,gBAAgB,IAAA;CACjB;AAED;;;;;;;GAOG;AACH,qBAAa,YAAa,SAAQ,QAAQ,CAAC,OAAO,CAAC;IACjD,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,SAAgB,IAAI,EAAE,SAAS,CAAC;IAEhC,uCAAuC;gBACpB,WAAW,EAAE,MAAM,EAAE,OAAO,GAAE,UAAyB,EAAE,IAAI,GAAE,SAA6B;IAM/G,gFAAgF;IAChF,IAAW,WAAW,IAAI,MAAM,CAA8B;IAC9D,gBAAgB;IAChB,IAAW,UAAU,IAAI,OAAO,CAAqF;IACrH,0EAA0E;IAC1E,IAAW,SAAS,IAAI,OAAO,CAA8B;IAC7D,gHAAgH;IAChH,IAAW,OAAO,IAAI,OAAO,GAAG,SAAS,CAAiE;IAC1G,oGAAoG;IACpG,IAAW,kBAAkB,IAAI,OAAO,CAAqD;IAC7F,oGAAoG;IACpG,IAAW,kBAAkB,IAAI,OAAO,CAAqD;IAE7F,0GAA0G;IACnG,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAQtD,gBAAgB;IACT,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAQ7D,gBAAgB;IACT,QAAQ,IAAI,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;CAChD;AAED,aAAa;AACb,oBAAY,aAAa,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,EAAE,MAAM,KAAK,MAAM,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC;IAClC,gGAAgG;IAChG,QAAQ,CAAC,gBAAgB,EAAE,IAAI,CAAC,UAAU,CAAC;IAC3C,kGAAkG;IAClG,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,2CAA2C;IAC3C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAEzB,uHAAuH;IACvH,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,YAAY,CAAC;IACrE,oFAAoF;IACpF,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS,CAAC;IAClF,2DAA2D;IAC3D,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;IAC5D,mIAAmI;IACnI,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IAC9E,uHAAuH;IACvH,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,aAAa,CAAC;IAC7E,oIAAoI;IACpI,QAAQ,CAAC,MAAM,EAAE,sBAAsB,GAAG,QAAQ,CAAC,sBAAsB,CAAC,CAAC;CAC5E;AAID;;;;GAIG;AACH,qBAAa,kBAAmB,YAAW,kBAAkB;IAC3D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAc;IACpC,SAAgB,YAAY,EAAE,UAAU,CAAC;IACzC,SAAgB,gBAAgB,EAAE,IAAI,CAAC,UAAU,CAAC;IAClD,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,SAAgB,IAAI,EAAE,SAAS,CAAC;IAChC,OAAO,CAAC,iBAAiB,CAAC,CAAyC;IAEnE,IAAW,UAAU,IAAI,MAAM,CAAkC;IACjE,IAAW,gBAAgB,IAAI,QAAQ,CAAC,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC,GAAG,SAAS,CAAmC;IAE9H;;;OAGG;gBACgB,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,gBAAgB,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,WAAW;IAwB1J,6DAA6D;WAC/C,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,kBAAkB;IAuClE,gEAAgE;IACzD,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,YAAY;IAK3E,0GAA0G;IACnG,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS;IAIxF,gBAAgB;IACT,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU;IASrF,gBAAgB;IACT,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC,UAAU;IAQlE,gBAAgB;IACT,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;IAIvD,gBAAgB;IACT,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,aAAa;IAsBnF,4HAA4H;IACrH,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAOlE,4DAA4D;IAC5D,IAAW,SAAS,IAAI,OAAO,CAAmC;IAElE,2DAA2D;IACpD,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS;IAIjE,IAAW,kBAAkB,IAAI,OAAO,CAAqD;IAC7F,IAAW,kBAAkB,IAAI,OAAO,CAAqD;IAC7F,IAAW,YAAY,IAAI,OAAO,CAA+D;IAEjG,mDAAmD;IAC5C,MAAM,IAAI,YAAY;IAUtB,wBAAwB,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAsB7E,QAAQ,CAAC,MAAM,EAAE,sBAAsB,GAAG,QAAQ,CAAC,sBAAsB,CAAC;IAQ5E,QAAQ,CAAC,MAAM,EAAE,sBAAsB,GAAG,QAAQ,CAAC,sBAAsB,CAAC;IAMjF,OAAO,KAAK,oBAAoB,GAA2C;IAE3E,OAAO,CAAC,MAAM;CAGf;AAED,UAAU,uBAAuB;IAC/B,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAID;;;;;;;;;GASG;AACH,qBAAa,uBAAuB;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAc;gBAEjB,IAAI,EAAE,WAAW;IAKpC,yCAAyC;IACzC,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,OAAO,CAAC,mBAAmB;IAIpB,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAG,MAAM,EAAE,uBAAuB,GAAG,uBAAuB;IAc9F,uIAAuI;IAChI,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU;CA4BvF;AAED;;GAEG;AACH,qBAAa,4BAA6B,YAAW,kBAAkB;IACrE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;IAC/C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;gBAE/B,QAAQ,EAAE,kBAAkB,EAAE,MAAM,EAAE,uBAAuB;WAKlE,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,GAAG,4BAA4B;IAW/J,IAAW,YAAY,WAA0C;IACjE,IAAW,gBAAgB,oBAA8C;IACzE,IAAW,WAAW,WAAyC;IAC/D,IAAW,IAAI,cAAkC;IAEjD,IAAW,UAAU,WAEpB;IAEM,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,aAAa;IAM5E,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,YAAY;IAKpE,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS;IAIjF,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU;IAI7E,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIzD,QAAQ,CAAC,MAAM,EAAE,sBAAsB,GAAG,QAAQ,CAAC,sBAAsB,CAAC;IAiB5E,QAAQ,CAAC,MAAM,EAAE,sBAAsB,GAAG,QAAQ,CAAC,sBAAsB,CAAC;CAKlF"}

package/lib/cjs/FeatureTable.js

@@ -7,7 +7,7 @@
  * @module Rendering
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PackedFeatureTable = exports.FeatureTable = exports.BatchType = exports.Feature = void 0;
+exports.MultiModelPackedFeatureTable = exports.PackedFeatureModelTable = exports.PackedFeatureTable = exports.FeatureTable = exports.BatchType = exports.PackedFeature = exports.ModelFeature = exports.Feature = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const GeometryParams_1 = require("./GeometryParams");
 /** Describes a discrete entity within a batched [RenderGraphic]($frontend) that can be
@@ -47,6 +47,52 @@ class Feature {
     }
 }
 exports.Feature = Feature;
+/** @internal */
+var ModelFeature;
+(function (ModelFeature) {
+    function create() {
+        return {
+            modelId: core_bentley_1.Id64.invalid,
+            elementId: core_bentley_1.Id64.invalid,
+            subCategoryId: core_bentley_1.Id64.invalid,
+            geometryClass: GeometryParams_1.GeometryClass.Primary,
+        };
+    }
+    ModelFeature.create = create;
+    function isDefined(feature) {
+        return !core_bentley_1.Id64.isInvalid(feature.modelId) || !core_bentley_1.Id64.isInvalid(feature.elementId) || !core_bentley_1.Id64.isInvalid(feature.subCategoryId) || feature.geometryClass !== GeometryParams_1.GeometryClass.Primary;
+    }
+    ModelFeature.isDefined = isDefined;
+    function unpack(packed, result, unpackedModelId) {
+        result.modelId = unpackedModelId ?? core_bentley_1.Id64.fromUint32PairObject(packed.modelId);
+        result.elementId = core_bentley_1.Id64.fromUint32PairObject(packed.elementId);
+        result.subCategoryId = core_bentley_1.Id64.fromUint32PairObject(packed.subCategoryId);
+        result.geometryClass = packed.geometryClass;
+        return result;
+    }
+    ModelFeature.unpack = unpack;
+})(ModelFeature = exports.ModelFeature || (exports.ModelFeature = {}));
+/** @internal */
+var PackedFeature;
+(function (PackedFeature) {
+    function create() {
+        const pair = { upper: 0, lower: 0 };
+        return {
+            modelId: { ...pair },
+            elementId: { ...pair },
+            subCategoryId: { ...pair },
+            geometryClass: GeometryParams_1.GeometryClass.Primary,
+            animationNodeId: 0,
+        };
+    }
+    PackedFeature.create = create;
+    function createWithIndex() {
+        const result = create();
+        result.index = 0;
+        return result;
+    }
+    PackedFeature.createWithIndex = createWithIndex;
+})(PackedFeature = exports.PackedFeature || (exports.PackedFeature = {}));
 /** Describes the type of a 'batch' of graphics representing multiple [[Feature]]s.
  * The most commonly-encountered batches are Tiles, which can be of either Primary or
  * Classifier type.
@@ -116,6 +162,7 @@ class FeatureTable extends core_bentley_1.IndexMap {
     getArray() { return this._array; }
 }
 exports.FeatureTable = FeatureTable;
+const scratchPackedFeature = PackedFeature.create();
 /**
  * An immutable, packed representation of a [[FeatureTable]]. The features are packed into a single array of 32-bit integer values,
  * wherein each feature occupies 3 32-bit integers.
@@ -126,10 +173,10 @@ class PackedFeatureTable {
      * This is used internally when deserializing Tiles in iMdl format.
      * @internal
      */
-    constructor(data, modelId, numFeatures, maxFeatures, type, animationNodeIds) {
+    constructor(data, modelId, numFeatures, type, animationNodeIds) {
         this._data = data;
-        this.modelId = modelId;
-        this.maxFeatures = maxFeatures;
+        this.batchModelId = modelId;
+        this.batchModelIdPair = core_bentley_1.Id64.getUint32Pair(modelId);
         this.numFeatures = numFeatures;
         this.type = type;
         this._animationNodeIds = animationNodeIds;
@@ -138,14 +185,13 @@ class PackedFeatureTable {
                 this.anyDefined = false;
                 break;
             case 1:
-                this.anyDefined = this.getFeature(0).isDefined;
+                this.anyDefined = ModelFeature.isDefined(this.getFeature(0, ModelFeature.create()));
                 break;
             default:
                 this.anyDefined = true;
                 break;
         }
         (0, core_bentley_1.assert)(this._data.length >= this._subCategoriesOffset);
-        (0, core_bentley_1.assert)(this.maxFeatures >= this.numFeatures);
         (0, core_bentley_1.assert)(undefined === this._animationNodeIds || this._animationNodeIds.length === this.numFeatures);
     }
     get byteLength() { return this._data.byteLength; }
@@ -181,18 +227,16 @@ class PackedFeatureTable {
             uint32s[index32 + 0] = core_bentley_1.Id64.getLowerUint32(id);
             uint32s[index32 + 1] = core_bentley_1.Id64.getUpperUint32(id);
         });
-        return new PackedFeatureTable(uint32s, featureTable.modelId, featureTable.length, featureTable.maxFeatures, featureTable.type);
+        return new PackedFeatureTable(uint32s, featureTable.modelId, featureTable.length, featureTable.type);
     }
     /** Retrieve the Feature associated with the specified index. */
-    getFeature(featureIndex) {
-        const packed = this.getPackedFeature(featureIndex);
-        const elemId = core_bentley_1.Id64.fromUint32Pair(packed.elementId.lower, packed.elementId.upper);
-        const subcatId = core_bentley_1.Id64.fromUint32Pair(packed.subCategoryId.lower, packed.subCategoryId.upper);
-        return new Feature(elemId, subcatId, packed.geometryClass);
+    getFeature(featureIndex, result) {
+        const packed = this.getPackedFeature(featureIndex, scratchPackedFeature);
+        return ModelFeature.unpack(packed, result, this.batchModelId);
     }
     /** Returns the Feature associated with the specified index, or undefined if the index is out of range. */
-    findFeature(featureIndex) {
-        return featureIndex < this.numFeatures ? this.getFeature(featureIndex) : undefined;
+    findFeature(featureIndex, result) {
+        return featureIndex < this.numFeatures ? this.getFeature(featureIndex, result) : undefined;
     }
     /** @internal */
     getElementIdPair(featureIndex, out) {
@@ -216,17 +260,21 @@ class PackedFeatureTable {
         return undefined !== this._animationNodeIds && featureIndex < this.numFeatures ? this._animationNodeIds[featureIndex] : 0;
     }
     /** @internal */
-    getPackedFeature(featureIndex) {
+    getPackedFeature(featureIndex, result) {
         (0, core_bentley_1.assert)(featureIndex < this.numFeatures);
         const index32 = 3 * featureIndex;
-        const elementId = { lower: this._data[index32], upper: this._data[index32 + 1] };
+        result.elementId.lower = this._data[index32];
+        result.elementId.upper = this._data[index32 + 1];
         const subCatIndexAndClass = this._data[index32 + 2];
-        const geometryClass = (subCatIndexAndClass >>> 24) & 0xff;
+        result.geometryClass = (subCatIndexAndClass >>> 24) & 0xff;
         let subCatIndex = (subCatIndexAndClass & 0x00ffffff) >>> 0;
         subCatIndex = subCatIndex * 2 + this._subCategoriesOffset;
-        const subCategoryId = { lower: this._data[subCatIndex], upper: this._data[subCatIndex + 1] };
-        const animationNodeId = this.getAnimationNodeId(featureIndex);
-        return { elementId, subCategoryId, geometryClass, animationNodeId };
+        result.subCategoryId.lower = this._data[subCatIndex];
+        result.subCategoryId.upper = this._data[subCatIndex + 1];
+        result.animationNodeId = this.getAnimationNodeId(featureIndex);
+        result.modelId.lower = this.batchModelIdPair.lower;
+        result.modelId.upper = this.batchModelIdPair.upper;
+        return result;
     }
     /** Returns the element ID of the Feature associated with the specified index, or undefined if the index is out of range. */
     findElementId(featureIndex) {
@@ -238,16 +286,19 @@ class PackedFeatureTable {
     /** Return true if this table contains exactly 1 feature. */
     get isUniform() { return 1 === this.numFeatures; }
     /** If this table contains exactly 1 feature, return it. */
-    get uniform() { return this.isUniform ? this.getFeature(0) : undefined; }
+    getUniform(result) {
+        return this.isUniform ? this.getFeature(0, result) : undefined;
+    }
     get isVolumeClassifier() { return BatchType.VolumeClassifier === this.type; }
     get isPlanarClassifier() { return BatchType.VolumeClassifier === this.type; }
     get isClassifier() { return this.isVolumeClassifier || this.isPlanarClassifier; }
     /** Unpack the features into a [[FeatureTable]]. */
     unpack() {
-        const table = new FeatureTable(this.maxFeatures, this.modelId);
+        const table = new FeatureTable(this.numFeatures, this.batchModelId);
+        const feature = ModelFeature.create();
         for (let i = 0; i < this.numFeatures; i++) {
-            const feature = this.getFeature(i);
-            table.insertWithIndex(feature, i);
+            this.getFeature(i, feature);
+            table.insertWithIndex(new Feature(feature.elementId, feature.subCategoryId, feature.geometryClass), i);
         }
         return table;
     }
@@ -270,10 +321,151 @@ class PackedFeatureTable {
         if (haveNodes)
             this._animationNodeIds = nodeIds;
     }
+    *iterator(output) {
+        for (let i = 0; i < this.numFeatures; i++) {
+            this.getPackedFeature(i, output);
+            output.index = i;
+            yield output;
+        }
+    }
+    iterable(output) {
+        return {
+            [Symbol.iterator]: () => this.iterator(output),
+        };
+    }
     get _subCategoriesOffset() { return this.numFeatures * 3; }
     readId(offset32) {
         return core_bentley_1.Id64.fromUint32Pair(this._data[offset32], this._data[offset32 + 1]);
     }
 }
 exports.PackedFeatureTable = PackedFeatureTable;
+const scratchPackedFeatureModelEntry = { lastFeatureIndex: -1, idLower: -1, idUpper: -1 };
+/** A table of model Ids associated with a [[MultiModelPackedFeatureTable]].
+ * The feature indices in the packed feature table are grouped together by model, such that the first N features belong to model 1, the next M features to model 2, and so on.
+ * The model table itself consists of one entry per model, where each entry looks like:
+ *  indexOfLastFeatureInModel: u32
+ *  modelId: u64
+ * The modelId associated with a feature can therefore be derived by finding the entry in the model table with the highest indexOfLastFeatureInModel no greater than the feature index.
+ * This lookup can be optimized using binary search.
+ * Moreover, while iterating the feature table in sequence, the model table can be iterated in parallel so that no per-feature lookup of model Id is required.
+ * @internal
+ */
+class PackedFeatureModelTable {
+    constructor(data) {
+        this._data = data;
+        (0, core_bentley_1.assert)(this._data.length % 3 === 0);
+    }
+    /** The number of models in the table. */
+    get length() {
+        return this._data.length / 3;
+    }
+    get byteLength() {
+        return this._data.byteLength;
+    }
+    getLastFeatureIndex(modelIndex) {
+        return this._data[modelIndex * 3];
+    }
+    getEntry(modelIndex, result) {
+        if (modelIndex >= this.length) {
+            result.idLower = result.idUpper = 0;
+            result.lastFeatureIndex = Number.MAX_SAFE_INTEGER;
+            return result;
+        }
+        const index = modelIndex * 3;
+        result.lastFeatureIndex = this._data[index + 0];
+        result.idLower = this._data[index + 1];
+        result.idUpper = this._data[index + 2];
+        return result;
+    }
+    /** Get the Id of the model associated with the specified feature, or an invalid Id if the feature is not associated with any model. */
+    getModelIdPair(featureIndex, result) {
+        if (!result)
+            result = { lower: 0, upper: 0 };
+        else
+            result.lower = result.upper = 0;
+        let first = 0;
+        const last = this.length;
+        let count = last;
+        while (count > 0) {
+            const step = Math.floor(count / 2);
+            const mid = first + step;
+            const lastFeatureIndex = this.getLastFeatureIndex(mid);
+            if (featureIndex > lastFeatureIndex) {
+                first = mid + 1;
+                count -= step + 1;
+            }
+            else {
+                count = step;
+            }
+        }
+        if (first < last) {
+            result.lower = this._data[first * 3 + 1];
+            result.upper = this._data[first * 3 + 2];
+        }
+        return result;
+    }
+}
+exports.PackedFeatureModelTable = PackedFeatureModelTable;
+/** A PackedFeatureTable with a PackedFeatureModelTable appended to it, capable of storing features belonging to more than one model.
+ * @internal
+ */
+class MultiModelPackedFeatureTable {
+    constructor(features, models) {
+        this._features = features;
+        this._models = models;
+    }
+    static create(data, batchModelId, numFeatures, type, numSubCategories) {
+        const modelTableOffset = 3 * numFeatures + 2 * numSubCategories;
+        const featureData = data.subarray(0, modelTableOffset);
+        const features = new PackedFeatureTable(featureData, batchModelId, numFeatures, type);
+        const modelData = data.subarray(modelTableOffset);
+        const models = new PackedFeatureModelTable(modelData);
+        return new MultiModelPackedFeatureTable(features, models);
+    }
+    get batchModelId() { return this._features.batchModelId; }
+    get batchModelIdPair() { return this._features.batchModelIdPair; }
+    get numFeatures() { return this._features.numFeatures; }
+    get type() { return this._features.type; }
+    get byteLength() {
+        return this._features.byteLength + this._models.byteLength;
+    }
+    getPackedFeature(featureIndex, result) {
+        this._features.getPackedFeature(featureIndex, result);
+        this._models.getModelIdPair(featureIndex, result.modelId);
+        return result;
+    }
+    getFeature(featureIndex, result) {
+        const packed = this.getPackedFeature(featureIndex, scratchPackedFeature);
+        return ModelFeature.unpack(packed, result);
+    }
+    findFeature(featureIndex, result) {
+        return featureIndex < this.numFeatures ? this.getFeature(featureIndex, result) : undefined;
+    }
+    getElementIdPair(featureIndex, out) {
+        return this._features.getElementIdPair(featureIndex, out);
+    }
+    findElementId(featureIndex) {
+        return this._features.findElementId(featureIndex);
+    }
+    *iterator(output) {
+        // Rather than perform a binary search on the model table to find each feature's model Id, traverse the model table in parallel with the feature table.
+        let modelIndex = 0;
+        const modelEntry = this._models.getEntry(modelIndex, scratchPackedFeatureModelEntry);
+        for (let featureIndex = 0; featureIndex < this.numFeatures; featureIndex++) {
+            if (featureIndex > modelEntry.lastFeatureIndex)
+                this._models.getEntry(++modelIndex, modelEntry);
+            this._features.getPackedFeature(featureIndex, output);
+            output.modelId.lower = modelEntry.idLower;
+            output.modelId.upper = modelEntry.idUpper;
+            output.index = featureIndex;
+            yield output;
+        }
+    }
+    iterable(output) {
+        return {
+            [Symbol.iterator]: () => this.iterator(output),
+        };
+    }
+}
+exports.MultiModelPackedFeatureTable = MultiModelPackedFeatureTable;
 //# sourceMappingURL=FeatureTable.js.map