@itwin/core-common 3.5.0-dev.26 → 3.5.0-dev.27

package/lib/cjs/ModelGeometryChanges.d.ts

@@ -1,108 +1,108 @@
-/** @packageDocumentation
- * @module Geometry
- */
-import { CompressedId64Set, DbOpcode, GuidString, Id64String } from "@itwin/core-bentley";
-import { Range3d, Range3dProps } from "@itwin/core-geometry";
-/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].
- * All of the elements belong to the same model.
- * The number of [[ids]] and [[ranges]] are guaranteed to be the same.
- * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.
- * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.
- * @public
- * @extensions
- */
-export interface ElementIdsAndRangesProps {
-    /** The Ids of the elements, compressed and sorted in ascending order. */
-    readonly ids: CompressedId64Set;
-    /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */
-    readonly ranges: Range3dProps[];
-}
-/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).
- * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].
- * @see [[ModelGeometryChanges]] for a more useful representation.
- * @public
- * @extensions
- */
-export interface ModelGeometryChangesProps {
-    /** The Id of the model. */
-    readonly id: Id64String;
-    /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */
-    readonly range: Range3dProps;
-    /** The geometry GUID of the model. */
-    readonly guid: GuidString;
-    /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */
-    readonly inserted?: ElementIdsAndRangesProps;
-    /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */
-    readonly updated?: ElementIdsAndRangesProps;
-    /** If defined, the Ids of deleted [GeometricElement]($backend)s. */
-    readonly deleted?: CompressedId64Set;
-}
-/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).
- * @see [[ElementGeometryChange]].
- * @public
- * @extensions
- */
-export interface ExtantElementGeometryChange {
-    /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.
-     * Used as discriminant for [[ElementGeometryChange]] union.
-     */
-    readonly type: DbOpcode.Insert | DbOpcode.Update;
-    /** The element's Id. */
-    readonly id: Id64String;
-    /** The element's range. */
-    readonly range: Range3d;
-}
-/** Represents the deletion of a [GeometricElement]($backend).
- * @see [[ElementGeometryChange]].
- * @public
- * @extensions
- */
-export interface DeletedElementGeometryChange {
-    /** Discriminant for [[ElementGeometryChange]] union. */
-    readonly type: DbOpcode.Delete;
-    /** The element's Id. */
-    readonly id: Id64String;
-}
-/**
- * @public
- * @extensions
- */
-export declare type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;
-/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].
- * @public
- */
-export declare namespace ElementGeometryChange {
-    /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */
-    function iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange>;
-    /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */
-    function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange>;
-}
-/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).
- * @public
- * @extensions
- */
-export interface ModelGeometryChanges {
-    /** The model's Id. */
-    readonly id: Id64String;
-    /** The model's geometry GUID. */
-    readonly geometryGuid: GuidString;
-    /** The model's range. */
-    readonly range: Range3d;
-    /** The individual geometric element changes. */
-    readonly elements: Iterable<ElementGeometryChange>;
-}
-/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).
- * @see [GraphicalEditingScope]($frontend) to monitor these changes.
- * @public
- */
-export declare namespace ModelGeometryChanges {
-    /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */
-    function iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges>;
-    /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */
-    function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges>;
-    /** Instantiate from wire format. */
-    function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges;
-    /** Obtain the ModelGeometryChanges for the specified model Id. */
-    function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined;
-}
+/** @packageDocumentation
+ * @module Geometry
+ */
+import { CompressedId64Set, DbOpcode, GuidString, Id64String } from "@itwin/core-bentley";
+import { Range3d, Range3dProps } from "@itwin/core-geometry";
+/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].
+ * All of the elements belong to the same model.
+ * The number of [[ids]] and [[ranges]] are guaranteed to be the same.
+ * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.
+ * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.
+ * @public
+ * @extensions
+ */
+export interface ElementIdsAndRangesProps {
+    /** The Ids of the elements, compressed and sorted in ascending order. */
+    readonly ids: CompressedId64Set;
+    /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */
+    readonly ranges: Range3dProps[];
+}
+/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).
+ * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].
+ * @see [[ModelGeometryChanges]] for a more useful representation.
+ * @public
+ * @extensions
+ */
+export interface ModelGeometryChangesProps {
+    /** The Id of the model. */
+    readonly id: Id64String;
+    /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */
+    readonly range: Range3dProps;
+    /** The geometry GUID of the model. */
+    readonly guid: GuidString;
+    /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */
+    readonly inserted?: ElementIdsAndRangesProps;
+    /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */
+    readonly updated?: ElementIdsAndRangesProps;
+    /** If defined, the Ids of deleted [GeometricElement]($backend)s. */
+    readonly deleted?: CompressedId64Set;
+}
+/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).
+ * @see [[ElementGeometryChange]].
+ * @public
+ * @extensions
+ */
+export interface ExtantElementGeometryChange {
+    /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.
+     * Used as discriminant for [[ElementGeometryChange]] union.
+     */
+    readonly type: DbOpcode.Insert | DbOpcode.Update;
+    /** The element's Id. */
+    readonly id: Id64String;
+    /** The element's range. */
+    readonly range: Range3d;
+}
+/** Represents the deletion of a [GeometricElement]($backend).
+ * @see [[ElementGeometryChange]].
+ * @public
+ * @extensions
+ */
+export interface DeletedElementGeometryChange {
+    /** Discriminant for [[ElementGeometryChange]] union. */
+    readonly type: DbOpcode.Delete;
+    /** The element's Id. */
+    readonly id: Id64String;
+}
+/**
+ * @public
+ * @extensions
+ */
+export declare type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;
+/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].
+ * @public
+ */
+export declare namespace ElementGeometryChange {
+    /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */
+    function iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange>;
+    /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */
+    function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange>;
+}
+/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).
+ * @public
+ * @extensions
+ */
+export interface ModelGeometryChanges {
+    /** The model's Id. */
+    readonly id: Id64String;
+    /** The model's geometry GUID. */
+    readonly geometryGuid: GuidString;
+    /** The model's range. */
+    readonly range: Range3d;
+    /** The individual geometric element changes. */
+    readonly elements: Iterable<ElementGeometryChange>;
+}
+/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).
+ * @see [GraphicalEditingScope]($frontend) to monitor these changes.
+ * @public
+ */
+export declare namespace ModelGeometryChanges {
+    /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */
+    function iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges>;
+    /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */
+    function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges>;
+    /** Instantiate from wire format. */
+    function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges;
+    /** Obtain the ModelGeometryChanges for the specified model Id. */
+    function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined;
+}
 //# sourceMappingURL=ModelGeometryChanges.d.ts.map

package/lib/cjs/ModelGeometryChanges.js

@@ -1,84 +1,84 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Geometry
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelGeometryChanges = exports.ElementGeometryChange = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_geometry_1 = require("@itwin/core-geometry");
-/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].
- * @public
- */
-var ElementGeometryChange;
-(function (ElementGeometryChange) {
-    function* extantIterator(props, type) {
-        let index = 0;
-        const ids = core_bentley_1.CompressedId64Set.iterable(props.ids);
-        for (const id of ids) {
-            (0, core_bentley_1.assert)(undefined !== props.ranges[index]);
-            const range = core_geometry_1.Range3d.fromJSON(props.ranges[index]);
-            index++;
-            yield { type, id, range };
-        }
-    }
-    function extantIterable(props, type) {
-        return { [Symbol.iterator]: () => extantIterator(props, type) };
-    }
-    /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */
-    function* iterator(modelChanges) {
-        if (modelChanges.inserted)
-            yield* extantIterable(modelChanges.inserted, core_bentley_1.DbOpcode.Insert);
-        if (modelChanges.updated)
-            yield* extantIterable(modelChanges.updated, core_bentley_1.DbOpcode.Update);
-        if (modelChanges.deleted)
-            for (const id of core_bentley_1.CompressedId64Set.iterable(modelChanges.deleted))
-                yield { type: core_bentley_1.DbOpcode.Delete, id };
-    }
-    ElementGeometryChange.iterator = iterator;
-    /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */
-    function iterable(modelChanges) {
-        return { [Symbol.iterator]: () => iterator(modelChanges) };
-    }
-    ElementGeometryChange.iterable = iterable;
-})(ElementGeometryChange = exports.ElementGeometryChange || (exports.ElementGeometryChange = {}));
-/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).
- * @see [GraphicalEditingScope]($frontend) to monitor these changes.
- * @public
- */
-var ModelGeometryChanges;
-(function (ModelGeometryChanges) {
-    /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */
-    function* iterator(modelChanges) {
-        for (const props of modelChanges)
-            yield fromJSON(props);
-    }
-    ModelGeometryChanges.iterator = iterator;
-    /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */
-    function iterable(modelChanges) {
-        return { [Symbol.iterator]: () => iterator(modelChanges) };
-    }
-    ModelGeometryChanges.iterable = iterable;
-    /** Instantiate from wire format. */
-    function fromJSON(props) {
-        return {
-            id: props.id,
-            geometryGuid: props.guid,
-            range: core_geometry_1.Range3d.fromJSON(props.range),
-            elements: ElementGeometryChange.iterable(props),
-        };
-    }
-    ModelGeometryChanges.fromJSON = fromJSON;
-    /** Obtain the ModelGeometryChanges for the specified model Id. */
-    function findByModelId(changes, modelId) {
-        for (const change of changes)
-            if (change.id === modelId)
-                return change;
-        return undefined;
-    }
-    ModelGeometryChanges.findByModelId = findByModelId;
-})(ModelGeometryChanges = exports.ModelGeometryChanges || (exports.ModelGeometryChanges = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Geometry
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelGeometryChanges = exports.ElementGeometryChange = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_geometry_1 = require("@itwin/core-geometry");
+/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].
+ * @public
+ */
+var ElementGeometryChange;
+(function (ElementGeometryChange) {
+    function* extantIterator(props, type) {
+        let index = 0;
+        const ids = core_bentley_1.CompressedId64Set.iterable(props.ids);
+        for (const id of ids) {
+            (0, core_bentley_1.assert)(undefined !== props.ranges[index]);
+            const range = core_geometry_1.Range3d.fromJSON(props.ranges[index]);
+            index++;
+            yield { type, id, range };
+        }
+    }
+    function extantIterable(props, type) {
+        return { [Symbol.iterator]: () => extantIterator(props, type) };
+    }
+    /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */
+    function* iterator(modelChanges) {
+        if (modelChanges.inserted)
+            yield* extantIterable(modelChanges.inserted, core_bentley_1.DbOpcode.Insert);
+        if (modelChanges.updated)
+            yield* extantIterable(modelChanges.updated, core_bentley_1.DbOpcode.Update);
+        if (modelChanges.deleted)
+            for (const id of core_bentley_1.CompressedId64Set.iterable(modelChanges.deleted))
+                yield { type: core_bentley_1.DbOpcode.Delete, id };
+    }
+    ElementGeometryChange.iterator = iterator;
+    /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */
+    function iterable(modelChanges) {
+        return { [Symbol.iterator]: () => iterator(modelChanges) };
+    }
+    ElementGeometryChange.iterable = iterable;
+})(ElementGeometryChange = exports.ElementGeometryChange || (exports.ElementGeometryChange = {}));
+/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).
+ * @see [GraphicalEditingScope]($frontend) to monitor these changes.
+ * @public
+ */
+var ModelGeometryChanges;
+(function (ModelGeometryChanges) {
+    /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */
+    function* iterator(modelChanges) {
+        for (const props of modelChanges)
+            yield fromJSON(props);
+    }
+    ModelGeometryChanges.iterator = iterator;
+    /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */
+    function iterable(modelChanges) {
+        return { [Symbol.iterator]: () => iterator(modelChanges) };
+    }
+    ModelGeometryChanges.iterable = iterable;
+    /** Instantiate from wire format. */
+    function fromJSON(props) {
+        return {
+            id: props.id,
+            geometryGuid: props.guid,
+            range: core_geometry_1.Range3d.fromJSON(props.range),
+            elements: ElementGeometryChange.iterable(props),
+        };
+    }
+    ModelGeometryChanges.fromJSON = fromJSON;
+    /** Obtain the ModelGeometryChanges for the specified model Id. */
+    function findByModelId(changes, modelId) {
+        for (const change of changes)
+            if (change.id === modelId)
+                return change;
+        return undefined;
+    }
+    ModelGeometryChanges.findByModelId = findByModelId;
+})(ModelGeometryChanges = exports.ModelGeometryChanges || (exports.ModelGeometryChanges = {}));
 //# sourceMappingURL=ModelGeometryChanges.js.map

package/lib/cjs/ModelGeometryChanges.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelGeometryChanges.js","sourceRoot":"","sources":["../../src/ModelGeometryChanges.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkG;AAClG,wDAA6D;AAwE7D;;GAEG;AACH,IAAiB,qBAAqB,CAiCrC;AAjCD,WAAiB,qBAAqB;IACpC,QAAQ,CAAC,CAAC,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC/F,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,GAAG,GAAG,gCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACpB,IAAA,qBAAM,EAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;SAC3B;IACH,CAAC;IAED,SAAS,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC9F,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IAClE,CAAC;IAED,sIAAsI;IACtI,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAuC;QAC/D,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAEhE,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAE/D,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,MAAM,EAAE,IAAI,gCAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC;gBAC/D,MAAM,EAAE,IAAI,EAAE,uBAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;IAC1C,CAAC;IAVgB,8BAAQ,WAUxB,CAAA;IAED,sIAAsI;IACtI,SAAgB,QAAQ,CAAC,YAAuC;QAC9D,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,8BAAQ,WAEvB,CAAA;AACH,CAAC,EAjCgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAiCrC;AAiBD;;;GAGG;AACH,IAAiB,oBAAoB,CA8BpC;AA9BD,WAAiB,oBAAoB;IACnC,gHAAgH;IAChH,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAyC;QACjE,KAAK,MAAM,KAAK,IAAI,YAAY;YAC9B,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAHgB,6BAAQ,WAGxB,CAAA;IAED,gHAAgH;IAChH,SAAgB,QAAQ,CAAC,YAAyC;QAChE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,6BAAQ,WAEvB,CAAA;IAED,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,KAAgC;QACvD,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,YAAY,EAAE,KAAK,CAAC,IAAI;YACxB,KAAK,EAAE,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;YACpC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC;SAChD,CAAC;IACJ,CAAC;IAPe,6BAAQ,WAOvB,CAAA;IAED,kEAAkE;IAClE,SAAgB,aAAa,CAAC,OAAuC,EAAE,OAAmB;QACxF,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,IAAI,MAAM,CAAC,EAAE,KAAK,OAAO;gBACvB,OAAO,MAAM,CAAC;QAElB,OAAO,SAAS,CAAC;IACnB,CAAC;IANe,kCAAa,gBAM5B,CAAA;AACH,CAAC,EA9BgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA8BpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Geometry\r\n */\r\n\r\nimport { assert, CompressedId64Set, DbOpcode, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { Range3d, Range3dProps } from \"@itwin/core-geometry\";\r\n\r\n/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].\r\n * All of the elements belong to the same model.\r\n * The number of [[ids]] and [[ranges]] are guaranteed to be the same.\r\n * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.\r\n * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ElementIdsAndRangesProps {\r\n  /** The Ids of the elements, compressed and sorted in ascending order. */\r\n  readonly ids: CompressedId64Set;\r\n  /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */\r\n  readonly ranges: Range3dProps[];\r\n}\r\n\r\n/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).\r\n * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].\r\n * @see [[ModelGeometryChanges]] for a more useful representation.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChangesProps {\r\n  /** The Id of the model. */\r\n  readonly id: Id64String;\r\n  /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */\r\n  readonly range: Range3dProps;\r\n  /** The geometry GUID of the model. */\r\n  readonly guid: GuidString;\r\n  /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */\r\n  readonly inserted?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */\r\n  readonly updated?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids of deleted [GeometricElement]($backend)s. */\r\n  readonly deleted?: CompressedId64Set;\r\n}\r\n\r\n/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ExtantElementGeometryChange {\r\n  /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.\r\n   * Used as discriminant for [[ElementGeometryChange]] union.\r\n   */\r\n  readonly type: DbOpcode.Insert | DbOpcode.Update;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n  /** The element's range. */\r\n  readonly range: Range3d;\r\n}\r\n\r\n/** Represents the deletion of a [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface DeletedElementGeometryChange {\r\n  /** Discriminant for [[ElementGeometryChange]] union. */\r\n  readonly type: DbOpcode.Delete;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n}\r\n\r\n/**\r\n * @public\r\n * @extensions\r\n */\r\nexport type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;\r\n\r\n/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].\r\n * @public\r\n */\r\nexport namespace ElementGeometryChange { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  function* extantIterator(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterator<ElementGeometryChange> {\r\n    let index = 0;\r\n    const ids = CompressedId64Set.iterable(props.ids);\r\n    for (const id of ids) {\r\n      assert(undefined !== props.ranges[index]);\r\n      const range = Range3d.fromJSON(props.ranges[index]);\r\n      index++;\r\n      yield { type, id, range };\r\n    }\r\n  }\r\n\r\n  function extantIterable(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => extantIterator(props, type) };\r\n  }\r\n\r\n  /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange> {\r\n    if (modelChanges.inserted)\r\n      yield* extantIterable(modelChanges.inserted, DbOpcode.Insert);\r\n\r\n    if (modelChanges.updated)\r\n      yield* extantIterable(modelChanges.updated, DbOpcode.Update);\r\n\r\n    if (modelChanges.deleted)\r\n      for (const id of CompressedId64Set.iterable(modelChanges.deleted))\r\n        yield { type: DbOpcode.Delete, id };\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChanges {\r\n  /** The model's Id. */\r\n  readonly id: Id64String;\r\n  /** The model's geometry GUID. */\r\n  readonly geometryGuid: GuidString;\r\n  /** The model's range. */\r\n  readonly range: Range3d;\r\n  /** The individual geometric element changes. */\r\n  readonly elements: Iterable<ElementGeometryChange>;\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @see [GraphicalEditingScope]($frontend) to monitor these changes.\r\n * @public\r\n */\r\nexport namespace ModelGeometryChanges {\r\n  /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges> {\r\n    for (const props of modelChanges)\r\n      yield fromJSON(props);\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n\r\n  /** Instantiate from wire format. */\r\n  export function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges {\r\n    return {\r\n      id: props.id,\r\n      geometryGuid: props.guid,\r\n      range: Range3d.fromJSON(props.range),\r\n      elements: ElementGeometryChange.iterable(props),\r\n    };\r\n  }\r\n\r\n  /** Obtain the ModelGeometryChanges for the specified model Id. */\r\n  export function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined {\r\n    for (const change of changes)\r\n      if (change.id === modelId)\r\n        return change;\r\n\r\n    return undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ModelGeometryChanges.js","sourceRoot":"","sources":["../../src/ModelGeometryChanges.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkG;AAClG,wDAA6D;AAwE7D;;GAEG;AACH,IAAiB,qBAAqB,CAiCrC;AAjCD,WAAiB,qBAAqB;IACpC,QAAQ,CAAC,CAAC,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC/F,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,GAAG,GAAG,gCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACpB,IAAA,qBAAM,EAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;SAC3B;IACH,CAAC;IAED,SAAS,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC9F,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IAClE,CAAC;IAED,sIAAsI;IACtI,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAuC;QAC/D,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAEhE,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAE/D,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,MAAM,EAAE,IAAI,gCAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC;gBAC/D,MAAM,EAAE,IAAI,EAAE,uBAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;IAC1C,CAAC;IAVgB,8BAAQ,WAUxB,CAAA;IAED,sIAAsI;IACtI,SAAgB,QAAQ,CAAC,YAAuC;QAC9D,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,8BAAQ,WAEvB,CAAA;AACH,CAAC,EAjCgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAiCrC;AAiBD;;;GAGG;AACH,IAAiB,oBAAoB,CA8BpC;AA9BD,WAAiB,oBAAoB;IACnC,gHAAgH;IAChH,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAyC;QACjE,KAAK,MAAM,KAAK,IAAI,YAAY;YAC9B,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAHgB,6BAAQ,WAGxB,CAAA;IAED,gHAAgH;IAChH,SAAgB,QAAQ,CAAC,YAAyC;QAChE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,6BAAQ,WAEvB,CAAA;IAED,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,KAAgC;QACvD,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,YAAY,EAAE,KAAK,CAAC,IAAI;YACxB,KAAK,EAAE,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;YACpC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC;SAChD,CAAC;IACJ,CAAC;IAPe,6BAAQ,WAOvB,CAAA;IAED,kEAAkE;IAClE,SAAgB,aAAa,CAAC,OAAuC,EAAE,OAAmB;QACxF,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,IAAI,MAAM,CAAC,EAAE,KAAK,OAAO;gBACvB,OAAO,MAAM,CAAC;QAElB,OAAO,SAAS,CAAC;IACnB,CAAC;IANe,kCAAa,gBAM5B,CAAA;AACH,CAAC,EA9BgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA8BpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Geometry\n */\n\nimport { assert, CompressedId64Set, DbOpcode, GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { Range3d, Range3dProps } from \"@itwin/core-geometry\";\n\n/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].\n * All of the elements belong to the same model.\n * The number of [[ids]] and [[ranges]] are guaranteed to be the same.\n * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.\n * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.\n * @public\n * @extensions\n */\nexport interface ElementIdsAndRangesProps {\n  /** The Ids of the elements, compressed and sorted in ascending order. */\n  readonly ids: CompressedId64Set;\n  /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */\n  readonly ranges: Range3dProps[];\n}\n\n/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).\n * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].\n * @see [[ModelGeometryChanges]] for a more useful representation.\n * @public\n * @extensions\n */\nexport interface ModelGeometryChangesProps {\n  /** The Id of the model. */\n  readonly id: Id64String;\n  /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */\n  readonly range: Range3dProps;\n  /** The geometry GUID of the model. */\n  readonly guid: GuidString;\n  /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */\n  readonly inserted?: ElementIdsAndRangesProps;\n  /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */\n  readonly updated?: ElementIdsAndRangesProps;\n  /** If defined, the Ids of deleted [GeometricElement]($backend)s. */\n  readonly deleted?: CompressedId64Set;\n}\n\n/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).\n * @see [[ElementGeometryChange]].\n * @public\n * @extensions\n */\nexport interface ExtantElementGeometryChange {\n  /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.\n   * Used as discriminant for [[ElementGeometryChange]] union.\n   */\n  readonly type: DbOpcode.Insert | DbOpcode.Update;\n  /** The element's Id. */\n  readonly id: Id64String;\n  /** The element's range. */\n  readonly range: Range3d;\n}\n\n/** Represents the deletion of a [GeometricElement]($backend).\n * @see [[ElementGeometryChange]].\n * @public\n * @extensions\n */\nexport interface DeletedElementGeometryChange {\n  /** Discriminant for [[ElementGeometryChange]] union. */\n  readonly type: DbOpcode.Delete;\n  /** The element's Id. */\n  readonly id: Id64String;\n}\n\n/**\n * @public\n * @extensions\n */\nexport type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;\n\n/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].\n * @public\n */\nexport namespace ElementGeometryChange { // eslint-disable-line @typescript-eslint/no-redeclare\n  function* extantIterator(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterator<ElementGeometryChange> {\n    let index = 0;\n    const ids = CompressedId64Set.iterable(props.ids);\n    for (const id of ids) {\n      assert(undefined !== props.ranges[index]);\n      const range = Range3d.fromJSON(props.ranges[index]);\n      index++;\n      yield { type, id, range };\n    }\n  }\n\n  function extantIterable(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterable<ElementGeometryChange> {\n    return { [Symbol.iterator]: () => extantIterator(props, type) };\n  }\n\n  /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\n  export function* iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange> {\n    if (modelChanges.inserted)\n      yield* extantIterable(modelChanges.inserted, DbOpcode.Insert);\n\n    if (modelChanges.updated)\n      yield* extantIterable(modelChanges.updated, DbOpcode.Update);\n\n    if (modelChanges.deleted)\n      for (const id of CompressedId64Set.iterable(modelChanges.deleted))\n        yield { type: DbOpcode.Delete, id };\n  }\n\n  /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\n  export function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange> {\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\n  }\n}\n\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\n * @public\n * @extensions\n */\nexport interface ModelGeometryChanges {\n  /** The model's Id. */\n  readonly id: Id64String;\n  /** The model's geometry GUID. */\n  readonly geometryGuid: GuidString;\n  /** The model's range. */\n  readonly range: Range3d;\n  /** The individual geometric element changes. */\n  readonly elements: Iterable<ElementGeometryChange>;\n}\n\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\n * @see [GraphicalEditingScope]($frontend) to monitor these changes.\n * @public\n */\nexport namespace ModelGeometryChanges {\n  /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */\n  export function* iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges> {\n    for (const props of modelChanges)\n      yield fromJSON(props);\n  }\n\n  /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */\n  export function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges> {\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\n  }\n\n  /** Instantiate from wire format. */\n  export function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges {\n    return {\n      id: props.id,\n      geometryGuid: props.guid,\n      range: Range3d.fromJSON(props.range),\n      elements: ElementGeometryChange.iterable(props),\n    };\n  }\n\n  /** Obtain the ModelGeometryChanges for the specified model Id. */\n  export function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined {\n    for (const change of changes)\n      if (change.id === modelId)\n        return change;\n\n    return undefined;\n  }\n}\n"]}

package/lib/cjs/ModelProps.d.ts

@@ -1,68 +1,68 @@
-/** @packageDocumentation
- * @module Entities
- */
-import { GuidString, Id64String } from "@itwin/core-bentley";
-import { XYProps } from "@itwin/core-geometry";
-import { CodeProps } from "./Code";
-import { RelatedElementProps } from "./ElementProps";
-import { EntityProps, EntityQueryParams } from "./EntityProps";
-/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)
- * @public
- * @extensions
- */
-export interface ModelProps extends EntityProps {
-    modeledElement: RelatedElementProps;
-    name?: string;
-    /** @note must always match the model of the [[ModelProps.modeledElement]] */
-    parentModel?: Id64String;
-    isPrivate?: boolean;
-    isTemplate?: boolean;
-    jsonProperties?: any;
-}
-/** Properties that specify what model should be loaded.
- * @public
- * @extensions
- */
-export interface ModelLoadProps {
-    id?: Id64String;
-    code?: CodeProps;
-}
-/** Parameters for performing a query on [Model]($backend) classes.
- * @public
- * @extensions
- */
-export interface ModelQueryParams extends EntityQueryParams {
-    wantTemplate?: boolean;
-    wantPrivate?: boolean;
-}
-/** Properties that describe a [GeometricModel]($backend)
- * @public
- * @extensions
- */
-export interface GeometricModelProps extends ModelProps {
-    /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model
-     * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can
-     * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)
-     * If undefined, the state of the geometry is unknown.
-     */
-    geometryGuid?: GuidString;
-}
-/** Properties that define a [GeometricModel2d]($backend)
- * @public
- * @extensions
- */
-export interface GeometricModel2dProps extends GeometricModelProps {
-    /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */
-    globalOrigin?: XYProps;
-}
-/** Properties that define a [GeometricModel3d]($backend)
- * @public
- * @extensions
- */
-export interface GeometricModel3dProps extends GeometricModelProps {
-    /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */
-    isNotSpatiallyLocated?: boolean;
-    /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */
-    isPlanProjection?: boolean;
-}
+/** @packageDocumentation
+ * @module Entities
+ */
+import { GuidString, Id64String } from "@itwin/core-bentley";
+import { XYProps } from "@itwin/core-geometry";
+import { CodeProps } from "./Code";
+import { RelatedElementProps } from "./ElementProps";
+import { EntityProps, EntityQueryParams } from "./EntityProps";
+/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)
+ * @public
+ * @extensions
+ */
+export interface ModelProps extends EntityProps {
+    modeledElement: RelatedElementProps;
+    name?: string;
+    /** @note must always match the model of the [[ModelProps.modeledElement]] */
+    parentModel?: Id64String;
+    isPrivate?: boolean;
+    isTemplate?: boolean;
+    jsonProperties?: any;
+}
+/** Properties that specify what model should be loaded.
+ * @public
+ * @extensions
+ */
+export interface ModelLoadProps {
+    id?: Id64String;
+    code?: CodeProps;
+}
+/** Parameters for performing a query on [Model]($backend) classes.
+ * @public
+ * @extensions
+ */
+export interface ModelQueryParams extends EntityQueryParams {
+    wantTemplate?: boolean;
+    wantPrivate?: boolean;
+}
+/** Properties that describe a [GeometricModel]($backend)
+ * @public
+ * @extensions
+ */
+export interface GeometricModelProps extends ModelProps {
+    /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model
+     * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can
+     * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)
+     * If undefined, the state of the geometry is unknown.
+     */
+    geometryGuid?: GuidString;
+}
+/** Properties that define a [GeometricModel2d]($backend)
+ * @public
+ * @extensions
+ */
+export interface GeometricModel2dProps extends GeometricModelProps {
+    /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */
+    globalOrigin?: XYProps;
+}
+/** Properties that define a [GeometricModel3d]($backend)
+ * @public
+ * @extensions
+ */
+export interface GeometricModel3dProps extends GeometricModelProps {
+    /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */
+    isNotSpatiallyLocated?: boolean;
+    /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */
+    isPlanProjection?: boolean;
+}
 //# sourceMappingURL=ModelProps.d.ts.map

package/lib/cjs/ModelProps.js

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

package/lib/cjs/ModelProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelProps.js","sourceRoot":"","sources":["../../src/ModelProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Entities\r\n */\r\n\r\nimport { GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { XYProps } from \"@itwin/core-geometry\";\r\nimport { CodeProps } from \"./Code\";\r\nimport { RelatedElementProps } from \"./ElementProps\";\r\nimport { EntityProps, EntityQueryParams } from \"./EntityProps\";\r\n\r\n/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelProps extends EntityProps {\r\n  modeledElement: RelatedElementProps;\r\n  name?: string;\r\n  /** @note must always match the model of the [[ModelProps.modeledElement]] */\r\n  parentModel?: Id64String;\r\n  isPrivate?: boolean;\r\n  isTemplate?: boolean;\r\n  jsonProperties?: any;\r\n}\r\n\r\n/** Properties that specify what model should be loaded.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelLoadProps {\r\n  id?: Id64String;\r\n  code?: CodeProps;\r\n}\r\n\r\n/** Parameters for performing a query on [Model]($backend) classes.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelQueryParams extends EntityQueryParams {\r\n  wantTemplate?: boolean;\r\n  wantPrivate?: boolean;\r\n}\r\n\r\n/** Properties that describe a [GeometricModel]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometricModelProps extends ModelProps {\r\n  /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model\r\n   * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can\r\n   * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)\r\n   * If undefined, the state of the geometry is unknown.\r\n   */\r\n  geometryGuid?: GuidString;\r\n}\r\n\r\n/** Properties that define a [GeometricModel2d]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometricModel2dProps extends GeometricModelProps {\r\n  /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */\r\n  globalOrigin?: XYProps;\r\n}\r\n\r\n/** Properties that define a [GeometricModel3d]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometricModel3dProps extends GeometricModelProps {\r\n  /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */\r\n  isNotSpatiallyLocated?: boolean;\r\n  /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */\r\n  isPlanProjection?: boolean;\r\n}\r\n"]}
+{"version":3,"file":"ModelProps.js","sourceRoot":"","sources":["../../src/ModelProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Entities\n */\n\nimport { GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { XYProps } from \"@itwin/core-geometry\";\nimport { CodeProps } from \"./Code\";\nimport { RelatedElementProps } from \"./ElementProps\";\nimport { EntityProps, EntityQueryParams } from \"./EntityProps\";\n\n/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)\n * @public\n * @extensions\n */\nexport interface ModelProps extends EntityProps {\n  modeledElement: RelatedElementProps;\n  name?: string;\n  /** @note must always match the model of the [[ModelProps.modeledElement]] */\n  parentModel?: Id64String;\n  isPrivate?: boolean;\n  isTemplate?: boolean;\n  jsonProperties?: any;\n}\n\n/** Properties that specify what model should be loaded.\n * @public\n * @extensions\n */\nexport interface ModelLoadProps {\n  id?: Id64String;\n  code?: CodeProps;\n}\n\n/** Parameters for performing a query on [Model]($backend) classes.\n * @public\n * @extensions\n */\nexport interface ModelQueryParams extends EntityQueryParams {\n  wantTemplate?: boolean;\n  wantPrivate?: boolean;\n}\n\n/** Properties that describe a [GeometricModel]($backend)\n * @public\n * @extensions\n */\nexport interface GeometricModelProps extends ModelProps {\n  /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model\n   * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can\n   * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)\n   * If undefined, the state of the geometry is unknown.\n   */\n  geometryGuid?: GuidString;\n}\n\n/** Properties that define a [GeometricModel2d]($backend)\n * @public\n * @extensions\n */\nexport interface GeometricModel2dProps extends GeometricModelProps {\n  /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */\n  globalOrigin?: XYProps;\n}\n\n/** Properties that define a [GeometricModel3d]($backend)\n * @public\n * @extensions\n */\nexport interface GeometricModel3dProps extends GeometricModelProps {\n  /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */\n  isNotSpatiallyLocated?: boolean;\n  /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */\n  isPlanProjection?: boolean;\n}\n"]}