@itwin/core-common 3.5.0-dev.5 → 3.5.0-dev.51

package/lib/esm/MaterialProps.js

@@ -1,21 +1,21 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Rendering
- */
-/** Describes the units in which a [[TextureMapProps]]' scale is expressed.
- * @public
- * @extensions
- */
-export var TextureMapUnits;
-(function (TextureMapUnits) {
-    /** Indicates the scale has no units. */
-    TextureMapUnits[TextureMapUnits["Relative"] = 0] = "Relative";
-    TextureMapUnits[TextureMapUnits["Meters"] = 3] = "Meters";
-    TextureMapUnits[TextureMapUnits["Millimeters"] = 4] = "Millimeters";
-    TextureMapUnits[TextureMapUnits["Feet"] = 5] = "Feet";
-    TextureMapUnits[TextureMapUnits["Inches"] = 6] = "Inches";
-})(TextureMapUnits || (TextureMapUnits = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+/** Describes the units in which a [[TextureMapProps]]' scale is expressed.
+ * @public
+ * @extensions
+ */
+export var TextureMapUnits;
+(function (TextureMapUnits) {
+    /** Indicates the scale has no units. */
+    TextureMapUnits[TextureMapUnits["Relative"] = 0] = "Relative";
+    TextureMapUnits[TextureMapUnits["Meters"] = 3] = "Meters";
+    TextureMapUnits[TextureMapUnits["Millimeters"] = 4] = "Millimeters";
+    TextureMapUnits[TextureMapUnits["Feet"] = 5] = "Feet";
+    TextureMapUnits[TextureMapUnits["Inches"] = 6] = "Inches";
+})(TextureMapUnits || (TextureMapUnits = {}));
 //# sourceMappingURL=MaterialProps.js.map

package/lib/esm/MaterialProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialProps.js","sourceRoot":"","sources":["../../src/MaterialProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAqBH;;;GAGG;AACH,MAAM,CAAN,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wCAAwC;IACxC,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,qDAAQ,CAAA;IACR,yDAAU,CAAA;AACZ,CAAC,EAPW,eAAe,KAAf,eAAe,QAO1B","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 Rendering\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { DefinitionElementProps } from \"./ElementProps\";\nimport { TextureMapping } from \"./TextureMapping\";\n\n/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,\n * the second to green, and the third to blue.\n * @see usage in [[RenderMaterialAssetProps]].\n * @public\n * @extensions\n */\nexport type RgbFactorProps = number[];\n\n/** A 2d point specified as an array of 2 numbers [x, y].\n * @see usage in [[TextureMapProps]].\n * @public\n * @extensions\n */\nexport type Point2dProps = number[];\n\n/** Describes the units in which a [[TextureMapProps]]' scale is expressed.\n * @public\n * @extensions\n */\nexport enum TextureMapUnits {\n  /** Indicates the scale has no units. */\n  Relative = 0,\n  Meters = 3,\n  Millimeters = 4,\n  Feet = 5,\n  Inches = 6,\n}\n\n/* eslint-disable @typescript-eslint/naming-convention */\n\n/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.\n * @public\n * @extensions\n */\nexport interface TextureMapProps {\n  /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */\n  pattern_angle?: number;\n  /** If true, flip the pattern map in U; if undefined, defaults to false */\n  pattern_u_flip?: boolean;\n  /** If true, flip the pattern map in V; if undefined, defaults to false */\n  pattern_flip?: boolean;\n  /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */\n  pattern_scale?: Point2dProps;\n  /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */\n  pattern_offset?: Point2dProps;\n  /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */\n  pattern_scalemode?: TextureMapUnits;\n  /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */\n  pattern_mapping?: TextureMapping.Mode;\n  /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */\n  pattern_weight?: number;\n  /** The Id of the persistent [Texture]($backend) element defining the texture image. */\n  TextureId: Id64String;\n}\n\n/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].\n * @public\n * @extensions\n */\nexport interface RenderMaterialAssetProps {\n  /** If true, this material has a fill/diffuse color; if undefined, defaults to false */\n  HasBaseColor?: boolean;\n  /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */\n  color?: RgbFactorProps;\n  /** If true, this material has a specular color; if undefined, defaults to false */\n  HasSpecularColor?: boolean;\n  /** Surface color used for specular illumination; if undefined, defaults to black */\n  specular_color?: RgbFactorProps;\n  /** If true, this material has a specular exponent; if undefined, defaults to false */\n  HasFinish?: boolean;\n  /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 15.0 * 0.9 */\n  finish?: number;\n  /** If true, this material has surface transparency; if undefined, defaults to false */\n  HasTransmit?: boolean;\n  /** Surface transparency; if undefined, defaults to 0.0 */\n  transmit?: number;\n  /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */\n  HasDiffuse?: boolean;\n  /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */\n  diffuse?: number;\n  /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */\n  HasSpecular?: boolean;\n  /** Surface specular reflectivity; if undefined, defaults to 0.4 */\n  specular?: number;\n  /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */\n  HasReflect?: boolean;\n  /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */\n  reflect?: number;\n  /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */\n  HasReflectColor?: boolean;\n  /** Surface reflectance color; if undefined, defaults to black */\n  reflect_color?: RgbFactorProps;\n  /** An optional set of texture maps associated with this material.\n   * A large variety of map types may be present (e.g., bump maps, specular maps, fur, etc), but currently only the pattern map is used.\n   */\n  Map?: {\n    /** Optional pattern map. */\n    Pattern?: TextureMapProps;\n  };\n}\n\n/** Properties that define a [RenderMaterialElement]($backend).\n * @see [[RenderMaterial]] for the representation used by the display system.\n * @public\n * @extensions\n */\nexport interface RenderMaterialProps extends DefinitionElementProps {\n  /** The name of a palette that can be used to categorize multiple materials. */\n  paletteName: string;\n  /** An optional description of the material. */\n  description?: string;\n  jsonProperties?: {\n    /** A container for various \"assets\" describing aspects of the material. */\n    materialAssets?: {\n      /** Properties of the material describing how it is displayed. */\n      renderMaterial?: RenderMaterialAssetProps;\n    };\n  };\n}\n"]}
+{"version":3,"file":"MaterialProps.js","sourceRoot":"","sources":["../../src/MaterialProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAqBH;;;GAGG;AACH,MAAM,CAAN,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wCAAwC;IACxC,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,qDAAQ,CAAA;IACR,yDAAU,CAAA;AACZ,CAAC,EAPW,eAAe,KAAf,eAAe,QAO1B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { DefinitionElementProps } from \"./ElementProps\";\r\nimport { TextureMapping } from \"./TextureMapping\";\r\n\r\n/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,\r\n * the second to green, and the third to blue.\r\n * @see usage in [[RenderMaterialAssetProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type RgbFactorProps = number[];\r\n\r\n/** A 2d point specified as an array of 2 numbers [x, y].\r\n * @see usage in [[TextureMapProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type Point2dProps = number[];\r\n\r\n/** Describes the units in which a [[TextureMapProps]]' scale is expressed.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum TextureMapUnits {\r\n  /** Indicates the scale has no units. */\r\n  Relative = 0,\r\n  Meters = 3,\r\n  Millimeters = 4,\r\n  Feet = 5,\r\n  Inches = 6,\r\n}\r\n\r\n/* eslint-disable @typescript-eslint/naming-convention */\r\n\r\n/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface TextureMapProps {\r\n  /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */\r\n  pattern_angle?: number;\r\n  /** If true, flip the pattern map in U; if undefined, defaults to false */\r\n  pattern_u_flip?: boolean;\r\n  /** If true, flip the pattern map in V; if undefined, defaults to false */\r\n  pattern_flip?: boolean;\r\n  /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */\r\n  pattern_scale?: Point2dProps;\r\n  /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */\r\n  pattern_offset?: Point2dProps;\r\n  /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */\r\n  pattern_scalemode?: TextureMapUnits;\r\n  /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */\r\n  pattern_mapping?: TextureMapping.Mode;\r\n  /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */\r\n  pattern_weight?: number;\r\n  /** The Id of the persistent [Texture]($backend) element defining the texture image. */\r\n  TextureId: Id64String;\r\n}\r\n\r\n/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RenderMaterialAssetProps {\r\n  /** If true, this material has a fill/diffuse color; if undefined, defaults to false */\r\n  HasBaseColor?: boolean;\r\n  /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */\r\n  color?: RgbFactorProps;\r\n  /** If true, this material has a specular color; if undefined, defaults to false */\r\n  HasSpecularColor?: boolean;\r\n  /** Surface color used for specular illumination; if undefined, defaults to black */\r\n  specular_color?: RgbFactorProps;\r\n  /** If true, this material has a specular exponent; if undefined, defaults to false */\r\n  HasFinish?: boolean;\r\n  /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 15.0 * 0.9 */\r\n  finish?: number;\r\n  /** If true, this material has surface transparency; if undefined, defaults to false */\r\n  HasTransmit?: boolean;\r\n  /** Surface transparency; if undefined, defaults to 0.0 */\r\n  transmit?: number;\r\n  /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */\r\n  HasDiffuse?: boolean;\r\n  /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */\r\n  diffuse?: number;\r\n  /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */\r\n  HasSpecular?: boolean;\r\n  /** Surface specular reflectivity; if undefined, defaults to 0.4 */\r\n  specular?: number;\r\n  /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */\r\n  HasReflect?: boolean;\r\n  /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */\r\n  reflect?: number;\r\n  /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */\r\n  HasReflectColor?: boolean;\r\n  /** Surface reflectance color; if undefined, defaults to black */\r\n  reflect_color?: RgbFactorProps;\r\n  /** An optional set of texture maps associated with this material.\r\n   * A large variety of map types may be present (e.g., bump maps, specular maps, fur, etc), but currently only the pattern map is used.\r\n   */\r\n  Map?: {\r\n    /** Optional pattern map. */\r\n    Pattern?: TextureMapProps;\r\n  };\r\n}\r\n\r\n/** Properties that define a [RenderMaterialElement]($backend).\r\n * @see [[RenderMaterial]] for the representation used by the display system.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RenderMaterialProps extends DefinitionElementProps {\r\n  /** The name of a palette that can be used to categorize multiple materials. */\r\n  paletteName: string;\r\n  /** An optional description of the material. */\r\n  description?: string;\r\n  jsonProperties?: {\r\n    /** A container for various \"assets\" describing aspects of the material. */\r\n    materialAssets?: {\r\n      /** Properties of the material describing how it is displayed. */\r\n      renderMaterial?: RenderMaterialAssetProps;\r\n    };\r\n  };\r\n}\r\n"]}

package/lib/esm/ModelClipGroup.d.ts

@@ -1,68 +1,68 @@
-/** @packageDocumentation
- * @module Views
- */
-import { Id64Array, Id64String } from "@itwin/core-bentley";
-import { ClipVector, ClipVectorProps } from "@itwin/core-geometry";
-/** JSON representation of a [[ModelClipGroup]].
- * @public
- * @extensions
- */
-export interface ModelClipGroupProps {
-    /** The Ids of the models in the group. */
-    models?: Id64Array;
-    /** JSON representation of the [ClipVector]($core-geometry) applied to the group. */
-    clip?: ClipVectorProps;
-}
-/** 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 declare class ModelClipGroup {
-    /** The Ids of the models to be clipped, or undefined if the group includes all models. */
-    readonly models?: Id64Array;
-    /** The clip to apply to the group of models. `undefined` indicates the models are exempt from clipping. */
-    readonly clip?: ClipVector;
-    private constructor();
-    /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */
-    static create(clip: ClipVector | undefined, models?: Id64Array): ModelClipGroup;
-    /** Create a deep copy of this group. */
-    clone(): ModelClipGroup;
-    /** Returns whether the specified model Id belongs to this group. */
-    includesModel(modelId: Id64String): boolean;
-    /** Create from JSON representation. */
-    static fromJSON(props: ModelClipGroupProps): ModelClipGroup;
-    /** Convert to JSON representation. */
-    toJSON(): ModelClipGroupProps;
-}
-/** 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 declare class ModelClipGroups {
-    /** The groups of models and their associated clips. */
-    readonly groups: ModelClipGroup[];
-    /** Create a new ModelClipGroups.
-     * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.
-     */
-    constructor(groups?: ModelClipGroup[]);
-    /** Create a deep copy of this ModelClipGroups. */
-    clone(): ModelClipGroups;
-    /** Find the first group to which the specified model Id belongs, if any. */
-    findGroup(modelId: Id64String): ModelClipGroup | undefined;
-    /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */
-    findGroupIndex(modelId: Id64String): number;
-    /** 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: Id64String): ClipVector | undefined;
-    /** Create from JSON representation. */
-    static fromJSON(props: ModelClipGroupProps[] | undefined): ModelClipGroups;
-    /** Convert to JSON representation. */
-    toJSON(): ModelClipGroupProps[];
-}
+/** @packageDocumentation
+ * @module Views
+ */
+import { Id64Array, Id64String } from "@itwin/core-bentley";
+import { ClipVector, ClipVectorProps } from "@itwin/core-geometry";
+/** JSON representation of a [[ModelClipGroup]].
+ * @public
+ * @extensions
+ */
+export interface ModelClipGroupProps {
+    /** The Ids of the models in the group. */
+    models?: Id64Array;
+    /** JSON representation of the [ClipVector]($core-geometry) applied to the group. */
+    clip?: ClipVectorProps;
+}
+/** 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 declare class ModelClipGroup {
+    /** The Ids of the models to be clipped, or undefined if the group includes all models. */
+    readonly models?: Id64Array;
+    /** The clip to apply to the group of models. `undefined` indicates the models are exempt from clipping. */
+    readonly clip?: ClipVector;
+    private constructor();
+    /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */
+    static create(clip: ClipVector | undefined, models?: Id64Array): ModelClipGroup;
+    /** Create a deep copy of this group. */
+    clone(): ModelClipGroup;
+    /** Returns whether the specified model Id belongs to this group. */
+    includesModel(modelId: Id64String): boolean;
+    /** Create from JSON representation. */
+    static fromJSON(props: ModelClipGroupProps): ModelClipGroup;
+    /** Convert to JSON representation. */
+    toJSON(): ModelClipGroupProps;
+}
+/** 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 declare class ModelClipGroups {
+    /** The groups of models and their associated clips. */
+    readonly groups: ModelClipGroup[];
+    /** Create a new ModelClipGroups.
+     * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.
+     */
+    constructor(groups?: ModelClipGroup[]);
+    /** Create a deep copy of this ModelClipGroups. */
+    clone(): ModelClipGroups;
+    /** Find the first group to which the specified model Id belongs, if any. */
+    findGroup(modelId: Id64String): ModelClipGroup | undefined;
+    /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */
+    findGroupIndex(modelId: Id64String): number;
+    /** 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: Id64String): ClipVector | undefined;
+    /** Create from JSON representation. */
+    static fromJSON(props: ModelClipGroupProps[] | undefined): ModelClipGroups;
+    /** Convert to JSON representation. */
+    toJSON(): ModelClipGroupProps[];
+}
 //# sourceMappingURL=ModelClipGroup.d.ts.map

package/lib/esm/ModelClipGroup.js

@@ -1,94 +1,94 @@
-/*---------------------------------------------------------------------------------------------
-* 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() {
-        var _a;
-        const models = this.models ? [...this.models] : undefined;
-        return new ModelClipGroup(models, (_a = this.clip) === null || _a === void 0 ? void 0 : _a.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) {
-        var _a;
-        return (_a = this.findGroup(modelId)) === null || _a === void 0 ? void 0 : _a.clip;
-    }
-    /** Create from JSON representation. */
-    static fromJSON(props) {
-        const groups = props === null || props === void 0 ? void 0 : 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() {
+        var _a;
+        const models = this.models ? [...this.models] : undefined;
+        return new ModelClipGroup(models, (_a = this.clip) === null || _a === void 0 ? void 0 : _a.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) {
+        var _a;
+        return (_a = this.findGroup(modelId)) === null || _a === void 0 ? void 0 : _a.clip;
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        const groups = props === null || props === void 0 ? void 0 : 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,MAAA,IAAI,CAAC,IAAI,0CAAE,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,MAAA,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,0CAAE,IAAI,CAAC;IACvC,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwC;QAC7D,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,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"]}
+{"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,MAAA,IAAI,CAAC,IAAI,0CAAE,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,MAAA,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,0CAAE,IAAI,CAAC;IACvC,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwC;QAC7D,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,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"]}