@itwin/core-common 4.0.0-dev.44 → 4.0.0-dev.48

package/lib/esm/ModelClipGroup.js

@@ -1,92 +1,92 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Views
- */
-import { ClipVector } from "@itwin/core-geometry";
-/** Describes how to clip a group of models in the context of a [ViewDefinition3d]($backend) by applying a single [ClipVector]($core-geometry] to each model in the group.
- * @see [[ModelClipGroups]] to define multiple groups of models with different clip vectors.
- * @public
- */
-export class ModelClipGroup {
-    constructor(models, clip) {
-        this.models = models;
-        this.clip = clip;
-    }
-    /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */
-    static create(clip, models) {
-        return new ModelClipGroup(models, clip);
-    }
-    /** Create a deep copy of this group. */
-    clone() {
-        const models = this.models ? [...this.models] : undefined;
-        return new ModelClipGroup(models, this.clip?.clone());
-    }
-    /** Returns whether the specified model Id belongs to this group. */
-    includesModel(modelId) {
-        return undefined === this.models || this.models.includes(modelId);
-    }
-    /** Create from JSON representation. */
-    static fromJSON(props) {
-        const models = props.models ? [...props.models] : undefined;
-        const clip = props.clip ? ClipVector.fromJSON(props.clip) : undefined;
-        return new ModelClipGroup(models, undefined !== clip && clip.isValid ? clip : undefined);
-    }
-    /** Convert to JSON representation. */
-    toJSON() {
-        const props = {};
-        if (this.models)
-            props.models = [...this.models];
-        if (this.clip)
-            props.clip = this.clip.toJSON();
-        return props;
-    }
-}
-/** Describes how to clip groups of models in the context of a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).
- * Each group will be clipped by the [ClipVector]($core-geometry) associated with the group to which it belongs.
- * A model belongs to the first group in the list for which `ModelClipGroup.includesModel()` returns `true`.
- * A catch-all group can be defined by a ModelClipGroup with an `undefined` array of model Ids; any model whose Id does not appear in any group's list would belong to this group. If a catch-all group exists, it should appear last in the list.
- * A group of models can be exempted from clipping by a ModelClipGroup with an `undefined` ClipVector.
- * @note A ModelClipGroups obtained from a [[ViewDetails3d]] should **not** be modified directly. Clone it instead and modify the clone.
- * @see [[ViewDetails3d.modelClipGroups]] to define the clip groups for a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).
- * @public
- */
-export class ModelClipGroups {
-    /** Create a new ModelClipGroups.
-     * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.
-     */
-    constructor(groups = []) {
-        this.groups = groups;
-    }
-    /** Create a deep copy of this ModelClipGroups. */
-    clone() {
-        const groups = this.groups.map((group) => group.clone());
-        return new ModelClipGroups(groups);
-    }
-    /** Find the first group to which the specified model Id belongs, if any. */
-    findGroup(modelId) {
-        return this.groups.find((group) => group.includesModel(modelId));
-    }
-    /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */
-    findGroupIndex(modelId) {
-        return this.groups.findIndex((group) => group.includesModel(modelId));
-    }
-    /** Find the clip that should be applied to the specified model.
-     * @note This may return `undefined` if the model belongs to no group, **or** it belongs to a group that should not be clipped.
-     */
-    getClipForModel(modelId) {
-        return this.findGroup(modelId)?.clip;
-    }
-    /** Create from JSON representation. */
-    static fromJSON(props) {
-        const groups = props?.map((prop) => ModelClipGroup.fromJSON(prop));
-        return new ModelClipGroups(groups);
-    }
-    /** Convert to JSON representation. */
-    toJSON() {
-        return this.groups.map((group) => group.toJSON());
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Views
+ */
+import { ClipVector } from "@itwin/core-geometry";
+/** Describes how to clip a group of models in the context of a [ViewDefinition3d]($backend) by applying a single [ClipVector]($core-geometry] to each model in the group.
+ * @see [[ModelClipGroups]] to define multiple groups of models with different clip vectors.
+ * @public
+ */
+export class ModelClipGroup {
+    constructor(models, clip) {
+        this.models = models;
+        this.clip = clip;
+    }
+    /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */
+    static create(clip, models) {
+        return new ModelClipGroup(models, clip);
+    }
+    /** Create a deep copy of this group. */
+    clone() {
+        const models = this.models ? [...this.models] : undefined;
+        return new ModelClipGroup(models, this.clip?.clone());
+    }
+    /** Returns whether the specified model Id belongs to this group. */
+    includesModel(modelId) {
+        return undefined === this.models || this.models.includes(modelId);
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        const models = props.models ? [...props.models] : undefined;
+        const clip = props.clip ? ClipVector.fromJSON(props.clip) : undefined;
+        return new ModelClipGroup(models, undefined !== clip && clip.isValid ? clip : undefined);
+    }
+    /** Convert to JSON representation. */
+    toJSON() {
+        const props = {};
+        if (this.models)
+            props.models = [...this.models];
+        if (this.clip)
+            props.clip = this.clip.toJSON();
+        return props;
+    }
+}
+/** Describes how to clip groups of models in the context of a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).
+ * Each group will be clipped by the [ClipVector]($core-geometry) associated with the group to which it belongs.
+ * A model belongs to the first group in the list for which `ModelClipGroup.includesModel()` returns `true`.
+ * A catch-all group can be defined by a ModelClipGroup with an `undefined` array of model Ids; any model whose Id does not appear in any group's list would belong to this group. If a catch-all group exists, it should appear last in the list.
+ * A group of models can be exempted from clipping by a ModelClipGroup with an `undefined` ClipVector.
+ * @note A ModelClipGroups obtained from a [[ViewDetails3d]] should **not** be modified directly. Clone it instead and modify the clone.
+ * @see [[ViewDetails3d.modelClipGroups]] to define the clip groups for a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).
+ * @public
+ */
+export class ModelClipGroups {
+    /** Create a new ModelClipGroups.
+     * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.
+     */
+    constructor(groups = []) {
+        this.groups = groups;
+    }
+    /** Create a deep copy of this ModelClipGroups. */
+    clone() {
+        const groups = this.groups.map((group) => group.clone());
+        return new ModelClipGroups(groups);
+    }
+    /** Find the first group to which the specified model Id belongs, if any. */
+    findGroup(modelId) {
+        return this.groups.find((group) => group.includesModel(modelId));
+    }
+    /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */
+    findGroupIndex(modelId) {
+        return this.groups.findIndex((group) => group.includesModel(modelId));
+    }
+    /** Find the clip that should be applied to the specified model.
+     * @note This may return `undefined` if the model belongs to no group, **or** it belongs to a group that should not be clipped.
+     */
+    getClipForModel(modelId) {
+        return this.findGroup(modelId)?.clip;
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        const groups = props?.map((prop) => ModelClipGroup.fromJSON(prop));
+        return new ModelClipGroups(groups);
+    }
+    /** Convert to JSON representation. */
+    toJSON() {
+        return this.groups.map((group) => group.toJSON());
+    }
+}
 //# sourceMappingURL=ModelClipGroup.js.map

package/lib/esm/ModelClipGroup.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelClipGroup.js","sourceRoot":"","sources":["../../src/ModelClipGroup.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAmB,MAAM,sBAAsB,CAAC;AAanE;;;GAGG;AACH,MAAM,OAAO,cAAc;IAMzB,YAAoB,MAA6B,EAAE,IAA4B;QAC7E,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,2HAA2H;IACpH,MAAM,CAAC,MAAM,CAAC,IAA4B,EAAE,MAAkB;QACnE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,wCAAwC;IACjC,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1D,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,oEAAoE;IAC7D,aAAa,CAAC,OAAmB;QACtC,OAAO,SAAS,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACpE,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3F,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QACtC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI;YACX,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAElC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,eAAe;IAI1B;;OAEG;IACH,YAAmB,SAA2B,EAAE;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,kDAAkD;IAC3C,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QACzD,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,4EAA4E;IACrE,SAAS,CAAC,OAAmB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,yHAAyH;IAClH,cAAc,CAAC,OAAmB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,OAAmB;QACxC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;IACvC,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwC;QAC7D,MAAM,MAAM,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACpD,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/** @packageDocumentation\r\n * @module Views\r\n */\r\n\r\nimport { Id64Array, Id64String } from \"@itwin/core-bentley\";\r\nimport { ClipVector, ClipVectorProps } from \"@itwin/core-geometry\";\r\n\r\n/** JSON representation of a [[ModelClipGroup]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelClipGroupProps {\r\n  /** The Ids of the models in the group. */\r\n  models?: Id64Array;\r\n  /** JSON representation of the [ClipVector]($core-geometry) applied to the group. */\r\n  clip?: ClipVectorProps;\r\n}\r\n\r\n/** Describes how to clip a group of models in the context of a [ViewDefinition3d]($backend) by applying a single [ClipVector]($core-geometry] to each model in the group.\r\n * @see [[ModelClipGroups]] to define multiple groups of models with different clip vectors.\r\n * @public\r\n */\r\nexport class ModelClipGroup {\r\n  /** The Ids of the models to be clipped, or undefined if the group includes all models. */\r\n  public readonly models?: Id64Array;\r\n  /** The clip to apply to the group of models. `undefined` indicates the models are exempt from clipping. */\r\n  public readonly clip?: ClipVector;\r\n\r\n  private constructor(models: Id64Array | undefined, clip: ClipVector | undefined) {\r\n    this.models = models;\r\n    this.clip = clip;\r\n  }\r\n\r\n  /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */\r\n  public static create(clip: ClipVector | undefined, models?: Id64Array): ModelClipGroup {\r\n    return new ModelClipGroup(models, clip);\r\n  }\r\n\r\n  /** Create a deep copy of this group. */\r\n  public clone(): ModelClipGroup {\r\n    const models = this.models ? [...this.models] : undefined;\r\n    return new ModelClipGroup(models, this.clip?.clone());\r\n  }\r\n\r\n  /** Returns whether the specified model Id belongs to this group. */\r\n  public includesModel(modelId: Id64String): boolean {\r\n    return undefined === this.models || this.models.includes(modelId);\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: ModelClipGroupProps): ModelClipGroup {\r\n    const models = props.models ? [...props.models] : undefined;\r\n    const clip = props.clip ? ClipVector.fromJSON(props.clip) : undefined;\r\n    return new ModelClipGroup(models, undefined !== clip && clip.isValid ? clip : undefined);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): ModelClipGroupProps {\r\n    const props: ModelClipGroupProps = {};\r\n    if (this.models)\r\n      props.models = [...this.models];\r\n\r\n    if (this.clip)\r\n      props.clip = this.clip.toJSON();\r\n\r\n    return props;\r\n  }\r\n}\r\n\r\n/** Describes how to clip groups of models in the context of a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).\r\n * Each group will be clipped by the [ClipVector]($core-geometry) associated with the group to which it belongs.\r\n * A model belongs to the first group in the list for which `ModelClipGroup.includesModel()` returns `true`.\r\n * A catch-all group can be defined by a ModelClipGroup with an `undefined` array of model Ids; any model whose Id does not appear in any group's list would belong to this group. If a catch-all group exists, it should appear last in the list.\r\n * A group of models can be exempted from clipping by a ModelClipGroup with an `undefined` ClipVector.\r\n * @note A ModelClipGroups obtained from a [[ViewDetails3d]] should **not** be modified directly. Clone it instead and modify the clone.\r\n * @see [[ViewDetails3d.modelClipGroups]] to define the clip groups for a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).\r\n * @public\r\n */\r\nexport class ModelClipGroups {\r\n  /** The groups of models and their associated clips. */\r\n  public readonly groups: ModelClipGroup[];\r\n\r\n  /** Create a new ModelClipGroups.\r\n   * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.\r\n   */\r\n  public constructor(groups: ModelClipGroup[] = []) {\r\n    this.groups = groups;\r\n  }\r\n\r\n  /** Create a deep copy of this ModelClipGroups. */\r\n  public clone(): ModelClipGroups {\r\n    const groups = this.groups.map((group) => group.clone());\r\n    return new ModelClipGroups(groups);\r\n  }\r\n\r\n  /** Find the first group to which the specified model Id belongs, if any. */\r\n  public findGroup(modelId: Id64String): ModelClipGroup | undefined {\r\n    return this.groups.find((group) => group.includesModel(modelId));\r\n  }\r\n\r\n  /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */\r\n  public findGroupIndex(modelId: Id64String): number {\r\n    return this.groups.findIndex((group) => group.includesModel(modelId));\r\n  }\r\n\r\n  /** Find the clip that should be applied to the specified model.\r\n   * @note This may return `undefined` if the model belongs to no group, **or** it belongs to a group that should not be clipped.\r\n   */\r\n  public getClipForModel(modelId: Id64String): ClipVector | undefined {\r\n    return this.findGroup(modelId)?.clip;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: ModelClipGroupProps[] | undefined): ModelClipGroups {\r\n    const groups = props?.map((prop) => ModelClipGroup.fromJSON(prop));\r\n    return new ModelClipGroups(groups);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): ModelClipGroupProps[] {\r\n    return this.groups.map((group) => group.toJSON());\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ModelClipGroup.js","sourceRoot":"","sources":["../../src/ModelClipGroup.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAmB,MAAM,sBAAsB,CAAC;AAanE;;;GAGG;AACH,MAAM,OAAO,cAAc;IAMzB,YAAoB,MAA6B,EAAE,IAA4B;QAC7E,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,2HAA2H;IACpH,MAAM,CAAC,MAAM,CAAC,IAA4B,EAAE,MAAkB;QACnE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,wCAAwC;IACjC,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1D,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,oEAAoE;IAC7D,aAAa,CAAC,OAAmB;QACtC,OAAO,SAAS,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACpE,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3F,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QACtC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI;YACX,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAElC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,eAAe;IAI1B;;OAEG;IACH,YAAmB,SAA2B,EAAE;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,kDAAkD;IAC3C,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QACzD,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,4EAA4E;IACrE,SAAS,CAAC,OAAmB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,yHAAyH;IAClH,cAAc,CAAC,OAAmB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,OAAmB;QACxC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;IACvC,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwC;QAC7D,MAAM,MAAM,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACpD,CAAC;CACF","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 Views\n */\n\nimport { Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport { ClipVector, ClipVectorProps } from \"@itwin/core-geometry\";\n\n/** JSON representation of a [[ModelClipGroup]].\n * @public\n * @extensions\n */\nexport interface ModelClipGroupProps {\n  /** The Ids of the models in the group. */\n  models?: Id64Array;\n  /** JSON representation of the [ClipVector]($core-geometry) applied to the group. */\n  clip?: ClipVectorProps;\n}\n\n/** Describes how to clip a group of models in the context of a [ViewDefinition3d]($backend) by applying a single [ClipVector]($core-geometry] to each model in the group.\n * @see [[ModelClipGroups]] to define multiple groups of models with different clip vectors.\n * @public\n */\nexport class ModelClipGroup {\n  /** The Ids of the models to be clipped, or undefined if the group includes all models. */\n  public readonly models?: Id64Array;\n  /** The clip to apply to the group of models. `undefined` indicates the models are exempt from clipping. */\n  public readonly clip?: ClipVector;\n\n  private constructor(models: Id64Array | undefined, clip: ClipVector | undefined) {\n    this.models = models;\n    this.clip = clip;\n  }\n\n  /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */\n  public static create(clip: ClipVector | undefined, models?: Id64Array): ModelClipGroup {\n    return new ModelClipGroup(models, clip);\n  }\n\n  /** Create a deep copy of this group. */\n  public clone(): ModelClipGroup {\n    const models = this.models ? [...this.models] : undefined;\n    return new ModelClipGroup(models, this.clip?.clone());\n  }\n\n  /** Returns whether the specified model Id belongs to this group. */\n  public includesModel(modelId: Id64String): boolean {\n    return undefined === this.models || this.models.includes(modelId);\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: ModelClipGroupProps): ModelClipGroup {\n    const models = props.models ? [...props.models] : undefined;\n    const clip = props.clip ? ClipVector.fromJSON(props.clip) : undefined;\n    return new ModelClipGroup(models, undefined !== clip && clip.isValid ? clip : undefined);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): ModelClipGroupProps {\n    const props: ModelClipGroupProps = {};\n    if (this.models)\n      props.models = [...this.models];\n\n    if (this.clip)\n      props.clip = this.clip.toJSON();\n\n    return props;\n  }\n}\n\n/** Describes how to clip groups of models in the context of a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).\n * Each group will be clipped by the [ClipVector]($core-geometry) associated with the group to which it belongs.\n * A model belongs to the first group in the list for which `ModelClipGroup.includesModel()` returns `true`.\n * A catch-all group can be defined by a ModelClipGroup with an `undefined` array of model Ids; any model whose Id does not appear in any group's list would belong to this group. If a catch-all group exists, it should appear last in the list.\n * A group of models can be exempted from clipping by a ModelClipGroup with an `undefined` ClipVector.\n * @note A ModelClipGroups obtained from a [[ViewDetails3d]] should **not** be modified directly. Clone it instead and modify the clone.\n * @see [[ViewDetails3d.modelClipGroups]] to define the clip groups for a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).\n * @public\n */\nexport class ModelClipGroups {\n  /** The groups of models and their associated clips. */\n  public readonly groups: ModelClipGroup[];\n\n  /** Create a new ModelClipGroups.\n   * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.\n   */\n  public constructor(groups: ModelClipGroup[] = []) {\n    this.groups = groups;\n  }\n\n  /** Create a deep copy of this ModelClipGroups. */\n  public clone(): ModelClipGroups {\n    const groups = this.groups.map((group) => group.clone());\n    return new ModelClipGroups(groups);\n  }\n\n  /** Find the first group to which the specified model Id belongs, if any. */\n  public findGroup(modelId: Id64String): ModelClipGroup | undefined {\n    return this.groups.find((group) => group.includesModel(modelId));\n  }\n\n  /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */\n  public findGroupIndex(modelId: Id64String): number {\n    return this.groups.findIndex((group) => group.includesModel(modelId));\n  }\n\n  /** Find the clip that should be applied to the specified model.\n   * @note This may return `undefined` if the model belongs to no group, **or** it belongs to a group that should not be clipped.\n   */\n  public getClipForModel(modelId: Id64String): ClipVector | undefined {\n    return this.findGroup(modelId)?.clip;\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: ModelClipGroupProps[] | undefined): ModelClipGroups {\n    const groups = props?.map((prop) => ModelClipGroup.fromJSON(prop));\n    return new ModelClipGroups(groups);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): ModelClipGroupProps[] {\n    return this.groups.map((group) => group.toJSON());\n  }\n}\n"]}

package/lib/esm/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/esm/ModelGeometryChanges.js

@@ -1,81 +1,81 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { assert, CompressedId64Set, DbOpcode } from "@itwin/core-bentley";
-import { Range3d } from "@itwin/core-geometry";
-/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].
- * @public
- */
-export var ElementGeometryChange;
-(function (ElementGeometryChange) {
-    function* extantIterator(props, type) {
-        let index = 0;
-        const ids = CompressedId64Set.iterable(props.ids);
-        for (const id of ids) {
-            assert(undefined !== props.ranges[index]);
-            const range = 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, DbOpcode.Insert);
-        if (modelChanges.updated)
-            yield* extantIterable(modelChanges.updated, DbOpcode.Update);
-        if (modelChanges.deleted)
-            for (const id of CompressedId64Set.iterable(modelChanges.deleted))
-                yield { type: 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 || (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 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: 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 || (ModelGeometryChanges = {}));
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { assert, CompressedId64Set, DbOpcode } from "@itwin/core-bentley";
+import { Range3d } from "@itwin/core-geometry";
+/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].
+ * @public
+ */
+export var ElementGeometryChange;
+(function (ElementGeometryChange) {
+    function* extantIterator(props, type) {
+        let index = 0;
+        const ids = CompressedId64Set.iterable(props.ids);
+        for (const id of ids) {
+            assert(undefined !== props.ranges[index]);
+            const range = 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, DbOpcode.Insert);
+        if (modelChanges.updated)
+            yield* extantIterable(modelChanges.updated, DbOpcode.Update);
+        if (modelChanges.deleted)
+            for (const id of CompressedId64Set.iterable(modelChanges.deleted))
+                yield { type: 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 || (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 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: 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 || (ModelGeometryChanges = {}));
 //# sourceMappingURL=ModelGeometryChanges.js.map