@itwin/core-common 3.5.0-dev.4 → 3.5.0-dev.7

package/lib/esm/PlanProjectionSettings.d.ts

@@ -1,48 +1,48 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-/** Wire format describing [[PlanProjectionSettings]].
- * @public
- * @extensions
- */
-export interface PlanProjectionSettingsProps {
-    /** If defined, the absolute height in meters at which to display the model. */
-    elevation?: number;
-    /** If defined, specifies a uniform transparency applied to all of the geometry in the model, in the range 0.0 (fully opaque) to 1.0 (fully transparent). */
-    transparency?: number;
-    /** If defined and true, the model is displayed as an overlay in the view (without depth testing) so that it is always visible behind other geometry. */
-    overlay?: boolean;
-    /** If defined and true, subcategory display priority is used to specify the draw order of portions of the model. Geometry belonging to a subcategory with a higher priority
-     * value is drawn on top of coincident geometry belonging to a subcategory with a lower priority value. The priorities can be modified at display time using
-     * [FeatureSymbology.Overrides]($frontend). Note that subcategory "layers" cross model boundaries; that is, geometry belonging to the same subcategory in different models
-     * are drawn as part of the same layer.
-     */
-    enforceDisplayPriority?: boolean;
-}
-/** Describes how to draw a plan projection model. A plan projection model is a [GeometricModel3d]($backend) whose geometry all lies in
- * a single XY plane, wherein the Z coordinate of the plane may be arbitrary or flexible. Multiple plan projection models can be combined into one view
- * and drawn as "layers" with relative priorities.
- * @see [[DisplayStyle3dSettings.setPlanProjectionSettings]] to define plan projection settings for a [DisplayStyle3dState]($frontend).
- * @see [GeometricModel3d.isPlanProjection]($backend).
- * @public
- */
-export declare class PlanProjectionSettings {
-    /** See [[PlanProjectionSettingsProps.elevation]] */
-    readonly elevation?: number;
-    /** See [[PlanProjectionSettingsProps.transparency]] */
-    readonly transparency?: number;
-    /** See [[PlanProjectionSettingsProps.overlay]] */
-    readonly overlay: boolean;
-    /** See [[PlanProjectionSettingsProps.enforceDisplayPriority]] */
-    readonly enforceDisplayPriority?: boolean;
-    toJSON(): PlanProjectionSettingsProps;
-    static fromJSON(props: PlanProjectionSettingsProps | undefined): PlanProjectionSettings | undefined;
-    /** @internal */
-    constructor(props: PlanProjectionSettingsProps);
-    /** Create a copy of this PlanProjectionSettings, optionally modifying some of its properties.
-     * @param changedProps JSON representation of the properties to change.
-     * @returns A PlanProjectionSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
-     */
-    clone(changedProps?: PlanProjectionSettingsProps): PlanProjectionSettings;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+/** Wire format describing [[PlanProjectionSettings]].
+ * @public
+ * @extensions
+ */
+export interface PlanProjectionSettingsProps {
+    /** If defined, the absolute height in meters at which to display the model. */
+    elevation?: number;
+    /** If defined, specifies a uniform transparency applied to all of the geometry in the model, in the range 0.0 (fully opaque) to 1.0 (fully transparent). */
+    transparency?: number;
+    /** If defined and true, the model is displayed as an overlay in the view (without depth testing) so that it is always visible behind other geometry. */
+    overlay?: boolean;
+    /** If defined and true, subcategory display priority is used to specify the draw order of portions of the model. Geometry belonging to a subcategory with a higher priority
+     * value is drawn on top of coincident geometry belonging to a subcategory with a lower priority value. The priorities can be modified at display time using
+     * [FeatureSymbology.Overrides]($frontend). Note that subcategory "layers" cross model boundaries; that is, geometry belonging to the same subcategory in different models
+     * are drawn as part of the same layer.
+     */
+    enforceDisplayPriority?: boolean;
+}
+/** Describes how to draw a plan projection model. A plan projection model is a [GeometricModel3d]($backend) whose geometry all lies in
+ * a single XY plane, wherein the Z coordinate of the plane may be arbitrary or flexible. Multiple plan projection models can be combined into one view
+ * and drawn as "layers" with relative priorities.
+ * @see [[DisplayStyle3dSettings.setPlanProjectionSettings]] to define plan projection settings for a [DisplayStyle3dState]($frontend).
+ * @see [GeometricModel3d.isPlanProjection]($backend).
+ * @public
+ */
+export declare class PlanProjectionSettings {
+    /** See [[PlanProjectionSettingsProps.elevation]] */
+    readonly elevation?: number;
+    /** See [[PlanProjectionSettingsProps.transparency]] */
+    readonly transparency?: number;
+    /** See [[PlanProjectionSettingsProps.overlay]] */
+    readonly overlay: boolean;
+    /** See [[PlanProjectionSettingsProps.enforceDisplayPriority]] */
+    readonly enforceDisplayPriority?: boolean;
+    toJSON(): PlanProjectionSettingsProps;
+    static fromJSON(props: PlanProjectionSettingsProps | undefined): PlanProjectionSettings | undefined;
+    /** @internal */
+    constructor(props: PlanProjectionSettingsProps);
+    /** Create a copy of this PlanProjectionSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A PlanProjectionSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps?: PlanProjectionSettingsProps): PlanProjectionSettings;
+}
 //# sourceMappingURL=PlanProjectionSettings.d.ts.map

package/lib/esm/PlanProjectionSettings.js

@@ -1,60 +1,60 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module DisplayStyles
- */
-/** Describes how to draw a plan projection model. A plan projection model is a [GeometricModel3d]($backend) whose geometry all lies in
- * a single XY plane, wherein the Z coordinate of the plane may be arbitrary or flexible. Multiple plan projection models can be combined into one view
- * and drawn as "layers" with relative priorities.
- * @see [[DisplayStyle3dSettings.setPlanProjectionSettings]] to define plan projection settings for a [DisplayStyle3dState]($frontend).
- * @see [GeometricModel3d.isPlanProjection]($backend).
- * @public
- */
-export class PlanProjectionSettings {
-    /** @internal */
-    constructor(props) {
-        this.elevation = props.elevation;
-        this.overlay = true === props.overlay;
-        this.enforceDisplayPriority = true === props.enforceDisplayPriority;
-        let transparency = props.transparency;
-        if (undefined !== transparency)
-            transparency = Math.max(0, Math.min(1, transparency));
-        this.transparency = transparency;
-    }
-    toJSON() {
-        return {
-            elevation: this.elevation,
-            transparency: this.transparency,
-            overlay: true === this.overlay ? true : undefined,
-            enforceDisplayPriority: true === this.enforceDisplayPriority ? true : undefined,
-        };
-    }
-    static fromJSON(props) {
-        if (undefined === props)
-            return undefined;
-        if (undefined === props.elevation && undefined === props.transparency && undefined === props.overlay && undefined === props.enforceDisplayPriority)
-            return undefined;
-        return new PlanProjectionSettings(props);
-    }
-    /** Create a copy of this PlanProjectionSettings, optionally modifying some of its properties.
-     * @param changedProps JSON representation of the properties to change.
-     * @returns A PlanProjectionSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
-     */
-    clone(changedProps) {
-        if (undefined === changedProps)
-            return this;
-        const props = this.toJSON();
-        if (undefined !== changedProps.elevation)
-            props.elevation = changedProps.elevation;
-        if (undefined !== changedProps.transparency)
-            props.transparency = changedProps.transparency;
-        if (undefined !== changedProps.overlay)
-            props.overlay = changedProps.overlay;
-        if (undefined !== changedProps.enforceDisplayPriority)
-            props.enforceDisplayPriority = changedProps.enforceDisplayPriority;
-        return new PlanProjectionSettings(props);
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+/** Describes how to draw a plan projection model. A plan projection model is a [GeometricModel3d]($backend) whose geometry all lies in
+ * a single XY plane, wherein the Z coordinate of the plane may be arbitrary or flexible. Multiple plan projection models can be combined into one view
+ * and drawn as "layers" with relative priorities.
+ * @see [[DisplayStyle3dSettings.setPlanProjectionSettings]] to define plan projection settings for a [DisplayStyle3dState]($frontend).
+ * @see [GeometricModel3d.isPlanProjection]($backend).
+ * @public
+ */
+export class PlanProjectionSettings {
+    /** @internal */
+    constructor(props) {
+        this.elevation = props.elevation;
+        this.overlay = true === props.overlay;
+        this.enforceDisplayPriority = true === props.enforceDisplayPriority;
+        let transparency = props.transparency;
+        if (undefined !== transparency)
+            transparency = Math.max(0, Math.min(1, transparency));
+        this.transparency = transparency;
+    }
+    toJSON() {
+        return {
+            elevation: this.elevation,
+            transparency: this.transparency,
+            overlay: true === this.overlay ? true : undefined,
+            enforceDisplayPriority: true === this.enforceDisplayPriority ? true : undefined,
+        };
+    }
+    static fromJSON(props) {
+        if (undefined === props)
+            return undefined;
+        if (undefined === props.elevation && undefined === props.transparency && undefined === props.overlay && undefined === props.enforceDisplayPriority)
+            return undefined;
+        return new PlanProjectionSettings(props);
+    }
+    /** Create a copy of this PlanProjectionSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A PlanProjectionSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps) {
+        if (undefined === changedProps)
+            return this;
+        const props = this.toJSON();
+        if (undefined !== changedProps.elevation)
+            props.elevation = changedProps.elevation;
+        if (undefined !== changedProps.transparency)
+            props.transparency = changedProps.transparency;
+        if (undefined !== changedProps.overlay)
+            props.overlay = changedProps.overlay;
+        if (undefined !== changedProps.enforceDisplayPriority)
+            props.enforceDisplayPriority = changedProps.enforceDisplayPriority;
+        return new PlanProjectionSettings(props);
+    }
+}
 //# sourceMappingURL=PlanProjectionSettings.js.map

package/lib/esm/PlanProjectionSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlanProjectionSettings.js","sourceRoot":"","sources":["../../src/PlanProjectionSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAqBH;;;;;;GAMG;AACH,MAAM,OAAO,sBAAsB;IA6BjC,gBAAgB;IAChB,YAAmB,KAAkC;QACnD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,CAAC;QACtC,IAAI,CAAC,sBAAsB,GAAG,IAAI,KAAK,KAAK,CAAC,sBAAsB,CAAC;QAEpE,IAAI,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACtC,IAAI,SAAS,KAAK,YAAY;YAC5B,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IA9BM,MAAM;QACX,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,OAAO,EAAE,IAAI,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YACjD,sBAAsB,EAAE,IAAI,KAAK,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAChF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAA8C;QACnE,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,SAAS,KAAK,KAAK,CAAC,YAAY,IAAI,SAAS,KAAK,KAAK,CAAC,OAAO,IAAI,SAAS,KAAK,KAAK,CAAC,sBAAsB;YAChJ,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAeD;;;OAGG;IACI,KAAK,CAAC,YAA0C;QACrD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAgC,IAAI,CAAC,MAAM,EAAE,CAAC;QACzD,IAAI,SAAS,KAAK,YAAY,CAAC,SAAS;YACtC,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;QAE3C,IAAI,SAAS,KAAK,YAAY,CAAC,YAAY;YACzC,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;QAEjD,IAAI,SAAS,KAAK,YAAY,CAAC,OAAO;YACpC,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;QAEvC,IAAI,SAAS,KAAK,YAAY,CAAC,sBAAsB;YACnD,KAAK,CAAC,sBAAsB,GAAG,YAAY,CAAC,sBAAsB,CAAC;QAErE,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,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 DisplayStyles\n */\n\n/** Wire format describing [[PlanProjectionSettings]].\n * @public\n * @extensions\n */\nexport interface PlanProjectionSettingsProps {\n  /** If defined, the absolute height in meters at which to display the model. */\n  elevation?: number;\n  /** If defined, specifies a uniform transparency applied to all of the geometry in the model, in the range 0.0 (fully opaque) to 1.0 (fully transparent). */\n  transparency?: number;\n  /** If defined and true, the model is displayed as an overlay in the view (without depth testing) so that it is always visible behind other geometry. */\n  overlay?: boolean;\n  /** If defined and true, subcategory display priority is used to specify the draw order of portions of the model. Geometry belonging to a subcategory with a higher priority\n   * value is drawn on top of coincident geometry belonging to a subcategory with a lower priority value. The priorities can be modified at display time using\n   * [FeatureSymbology.Overrides]($frontend). Note that subcategory \"layers\" cross model boundaries; that is, geometry belonging to the same subcategory in different models\n   * are drawn as part of the same layer.\n   */\n  enforceDisplayPriority?: boolean;\n}\n\n/** Describes how to draw a plan projection model. A plan projection model is a [GeometricModel3d]($backend) whose geometry all lies in\n * a single XY plane, wherein the Z coordinate of the plane may be arbitrary or flexible. Multiple plan projection models can be combined into one view\n * and drawn as \"layers\" with relative priorities.\n * @see [[DisplayStyle3dSettings.setPlanProjectionSettings]] to define plan projection settings for a [DisplayStyle3dState]($frontend).\n * @see [GeometricModel3d.isPlanProjection]($backend).\n * @public\n */\nexport class PlanProjectionSettings {\n  /** See [[PlanProjectionSettingsProps.elevation]] */\n  public readonly elevation?: number;\n  /** See [[PlanProjectionSettingsProps.transparency]] */\n  public readonly transparency?: number;\n  /** See [[PlanProjectionSettingsProps.overlay]] */\n  public readonly overlay: boolean;\n  /** See [[PlanProjectionSettingsProps.enforceDisplayPriority]] */\n  public readonly enforceDisplayPriority?: boolean;\n\n  public toJSON(): PlanProjectionSettingsProps {\n    return {\n      elevation: this.elevation,\n      transparency: this.transparency,\n      overlay: true === this.overlay ? true : undefined,\n      enforceDisplayPriority: true === this.enforceDisplayPriority ? true : undefined,\n    };\n  }\n\n  public static fromJSON(props: PlanProjectionSettingsProps | undefined): PlanProjectionSettings | undefined {\n    if (undefined === props)\n      return undefined;\n\n    if (undefined === props.elevation && undefined === props.transparency && undefined === props.overlay && undefined === props.enforceDisplayPriority)\n      return undefined;\n\n    return new PlanProjectionSettings(props);\n  }\n\n  /** @internal */\n  public constructor(props: PlanProjectionSettingsProps) {\n    this.elevation = props.elevation;\n    this.overlay = true === props.overlay;\n    this.enforceDisplayPriority = true === props.enforceDisplayPriority;\n\n    let transparency = props.transparency;\n    if (undefined !== transparency)\n      transparency = Math.max(0, Math.min(1, transparency));\n\n    this.transparency = transparency;\n  }\n\n  /** Create a copy of this PlanProjectionSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A PlanProjectionSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: PlanProjectionSettingsProps): PlanProjectionSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props: PlanProjectionSettingsProps = this.toJSON();\n    if (undefined !== changedProps.elevation)\n      props.elevation = changedProps.elevation;\n\n    if (undefined !== changedProps.transparency)\n      props.transparency = changedProps.transparency;\n\n    if (undefined !== changedProps.overlay)\n      props.overlay = changedProps.overlay;\n\n    if (undefined !== changedProps.enforceDisplayPriority)\n      props.enforceDisplayPriority = changedProps.enforceDisplayPriority;\n\n    return new PlanProjectionSettings(props);\n  }\n}\n"]}
+{"version":3,"file":"PlanProjectionSettings.js","sourceRoot":"","sources":["../../src/PlanProjectionSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAqBH;;;;;;GAMG;AACH,MAAM,OAAO,sBAAsB;IA6BjC,gBAAgB;IAChB,YAAmB,KAAkC;QACnD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,CAAC;QACtC,IAAI,CAAC,sBAAsB,GAAG,IAAI,KAAK,KAAK,CAAC,sBAAsB,CAAC;QAEpE,IAAI,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACtC,IAAI,SAAS,KAAK,YAAY;YAC5B,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IA9BM,MAAM;QACX,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,OAAO,EAAE,IAAI,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YACjD,sBAAsB,EAAE,IAAI,KAAK,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAChF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAA8C;QACnE,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,SAAS,KAAK,KAAK,CAAC,YAAY,IAAI,SAAS,KAAK,KAAK,CAAC,OAAO,IAAI,SAAS,KAAK,KAAK,CAAC,sBAAsB;YAChJ,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAeD;;;OAGG;IACI,KAAK,CAAC,YAA0C;QACrD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAgC,IAAI,CAAC,MAAM,EAAE,CAAC;QACzD,IAAI,SAAS,KAAK,YAAY,CAAC,SAAS;YACtC,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;QAE3C,IAAI,SAAS,KAAK,YAAY,CAAC,YAAY;YACzC,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;QAEjD,IAAI,SAAS,KAAK,YAAY,CAAC,OAAO;YACpC,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;QAEvC,IAAI,SAAS,KAAK,YAAY,CAAC,sBAAsB;YACnD,KAAK,CAAC,sBAAsB,GAAG,YAAY,CAAC,sBAAsB,CAAC;QAErE,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,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 DisplayStyles\r\n */\r\n\r\n/** Wire format describing [[PlanProjectionSettings]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface PlanProjectionSettingsProps {\r\n  /** If defined, the absolute height in meters at which to display the model. */\r\n  elevation?: number;\r\n  /** If defined, specifies a uniform transparency applied to all of the geometry in the model, in the range 0.0 (fully opaque) to 1.0 (fully transparent). */\r\n  transparency?: number;\r\n  /** If defined and true, the model is displayed as an overlay in the view (without depth testing) so that it is always visible behind other geometry. */\r\n  overlay?: boolean;\r\n  /** If defined and true, subcategory display priority is used to specify the draw order of portions of the model. Geometry belonging to a subcategory with a higher priority\r\n   * value is drawn on top of coincident geometry belonging to a subcategory with a lower priority value. The priorities can be modified at display time using\r\n   * [FeatureSymbology.Overrides]($frontend). Note that subcategory \"layers\" cross model boundaries; that is, geometry belonging to the same subcategory in different models\r\n   * are drawn as part of the same layer.\r\n   */\r\n  enforceDisplayPriority?: boolean;\r\n}\r\n\r\n/** Describes how to draw a plan projection model. A plan projection model is a [GeometricModel3d]($backend) whose geometry all lies in\r\n * a single XY plane, wherein the Z coordinate of the plane may be arbitrary or flexible. Multiple plan projection models can be combined into one view\r\n * and drawn as \"layers\" with relative priorities.\r\n * @see [[DisplayStyle3dSettings.setPlanProjectionSettings]] to define plan projection settings for a [DisplayStyle3dState]($frontend).\r\n * @see [GeometricModel3d.isPlanProjection]($backend).\r\n * @public\r\n */\r\nexport class PlanProjectionSettings {\r\n  /** See [[PlanProjectionSettingsProps.elevation]] */\r\n  public readonly elevation?: number;\r\n  /** See [[PlanProjectionSettingsProps.transparency]] */\r\n  public readonly transparency?: number;\r\n  /** See [[PlanProjectionSettingsProps.overlay]] */\r\n  public readonly overlay: boolean;\r\n  /** See [[PlanProjectionSettingsProps.enforceDisplayPriority]] */\r\n  public readonly enforceDisplayPriority?: boolean;\r\n\r\n  public toJSON(): PlanProjectionSettingsProps {\r\n    return {\r\n      elevation: this.elevation,\r\n      transparency: this.transparency,\r\n      overlay: true === this.overlay ? true : undefined,\r\n      enforceDisplayPriority: true === this.enforceDisplayPriority ? true : undefined,\r\n    };\r\n  }\r\n\r\n  public static fromJSON(props: PlanProjectionSettingsProps | undefined): PlanProjectionSettings | undefined {\r\n    if (undefined === props)\r\n      return undefined;\r\n\r\n    if (undefined === props.elevation && undefined === props.transparency && undefined === props.overlay && undefined === props.enforceDisplayPriority)\r\n      return undefined;\r\n\r\n    return new PlanProjectionSettings(props);\r\n  }\r\n\r\n  /** @internal */\r\n  public constructor(props: PlanProjectionSettingsProps) {\r\n    this.elevation = props.elevation;\r\n    this.overlay = true === props.overlay;\r\n    this.enforceDisplayPriority = true === props.enforceDisplayPriority;\r\n\r\n    let transparency = props.transparency;\r\n    if (undefined !== transparency)\r\n      transparency = Math.max(0, Math.min(1, transparency));\r\n\r\n    this.transparency = transparency;\r\n  }\r\n\r\n  /** Create a copy of this PlanProjectionSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A PlanProjectionSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: PlanProjectionSettingsProps): PlanProjectionSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props: PlanProjectionSettingsProps = this.toJSON();\r\n    if (undefined !== changedProps.elevation)\r\n      props.elevation = changedProps.elevation;\r\n\r\n    if (undefined !== changedProps.transparency)\r\n      props.transparency = changedProps.transparency;\r\n\r\n    if (undefined !== changedProps.overlay)\r\n      props.overlay = changedProps.overlay;\r\n\r\n    if (undefined !== changedProps.enforceDisplayPriority)\r\n      props.enforceDisplayPriority = changedProps.enforceDisplayPriority;\r\n\r\n    return new PlanProjectionSettings(props);\r\n  }\r\n}\r\n"]}

package/lib/esm/PlanarClipMask.d.ts

@@ -1,178 +1,178 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { CompressedId64Set, Id64String, OrderedId64Iterable } from "@itwin/core-bentley";
-/** The different modes by which a [[PlanarClipMaskSettings]] collects the geometry used to mask a model.
- * @public
- * @extensions
- */
-export declare enum PlanarClipMaskMode {
-    /** No masking. */
-    None = 0,
-    /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].
-     * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.
-     * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.
-     */
-    Priority = 1,
-    /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s. */
-    Models = 2,
-    /** Indicates that masks should be produced from geometry belonging to a set of subcategories. */
-    IncludeSubCategories = 3,
-    /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s. */
-    IncludeElements = 4,
-    /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements. */
-    ExcludeElements = 5
-}
-/** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.
- * The default can be overridden by [[PlanarClipMaskSettings.priority]].
- *  @public
- * @extensions
- */
-export declare enum PlanarClipMaskPriority {
-    /** Background map. */
-    BackgroundMap = -2048,
-    /** A reality model that spans the globe - e.g., OpenStreetMaps Buildings. */
-    GlobalRealityModel = -1024,
-    /** A reality model with a bounded range. */
-    RealityModel = 0,
-    /** A design model stored in the [IModelDb]($backend). */
-    DesignModel = 2048
-}
-/** JSON representation of a [[PlanarClipMaskSettings]].
- * @see [[DisplayStyleSettingsProps.planarClipOvr]] and [[ContextRealityModelProps.planarClipMask]].
- * @public
- * @extensions
- */
-export interface PlanarClipMaskProps {
-    /** Controls how the mask geometry is collected */
-    mode: PlanarClipMaskMode;
-    /** See [[PlanarClipMaskSettings.modelIds]]. */
-    modelIds?: CompressedId64Set;
-    /** See [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */
-    subCategoryOrElementIds?: CompressedId64Set;
-    /** See [[PlanarClipMaskSettings.priority]]. */
-    priority?: number;
-    /** See [[PlanarClipMaskSettings.transparency]]. */
-    transparency?: number;
-    /** See PlanarClipMaskSettings.invert */
-    invert?: boolean;
-}
-/** Basic arguments supplied to [[PlanarClipMaskSettings.create]].
- * @public
- */
-export interface BasicPlanarClipMaskArgs {
-    /** See [[PlanarClipMaskSettings.transparency]]. */
-    transparency?: number;
-    /** See [[PlanarClipMaskSettings.invert]]. */
-    invert?: boolean;
-}
-/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Models]].
- * @public
- */
-export interface ModelPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
-    /** See [[PlanarClipMaskSettings.modelIds]]. */
-    modelIds?: Iterable<Id64String>;
-    /** @internal */
-    exclude?: never;
-    /** @internal */
-    elementIds?: never;
-    /** @internal */
-    subCategoryIds?: never;
-    /** @internal */
-    priority?: never;
-}
-/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludeElements]].
- * @public
- */
-export interface ElementPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
-    /** See [[PlanarClipMaskSettings.modelIds]]. */
-    modelIds?: Iterable<Id64String>;
-    /** The elements used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */
-    elementIds: Iterable<Id64String>;
-    /** If true, creates a mask of [[PlanarClipMaskMode.ExcludeElements]]; otherwise, [[PlanarClipMaskMode.IncludeElements]]. */
-    exclude?: boolean;
-    /** @internal */
-    subCategoryIds?: never;
-    /** @internal */
-    priority?: never;
-}
-/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeSubCategories]].
- * @public
- */
-export interface SubCategoryPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
-    /** See [[PlanarClipMaskSettings.modelIds]]. */
-    modelIds?: Iterable<Id64String>;
-    /** The subcategories used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */
-    subCategoryIds: Iterable<Id64String>;
-    /** @internal */
-    exclude?: never;
-    /** @internal */
-    elementIds?: never;
-    /** @internal */
-    priority?: never;
-}
-/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Priority]].
- * @public
- */
-export interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
-    /** See [[PlanarClipMaskSettings.priority]]. */
-    priority: number;
-    /** @internal */
-    exclude?: never;
-    /** @internal */
-    elementIds?: never;
-    /** @internal */
-    modelIds?: never;
-}
-/** Describes how to mask the geometry of one [GeometricModel]($backend) for display. The mask is produced by projecting geometry from any number of other models -
- * optionally filtered by [SubCategory]($backend) or by a set of specific [GeometricElement]($backend)s - onto a plane. Regions of the masked model that intersect the
- * mask are rendered partially or completely transparent. This is useful for, e.g., making subsurface geometry visible below the background map, or clipping out portions
- * of a reality model that intersect a design model.
- * @note Currently reality models (including background maps and terrain) can be masked, but design models can only produce masks.
- * @see [[DisplayStyleSettings.planarClipMasks]] to define clip masks for a [DisplayStyle]($backend).
- * @see [[ContextRealityModel.planarClipMaskSettings]] to apply a clip mask to a context reality model.
- * @public
- */
-export declare class PlanarClipMaskSettings {
-    /** Specifies how the mask geometry is produced. */
-    readonly mode: PlanarClipMaskMode;
-    /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask.
-     * If `undefined`, the set of all models in the view's [ModelSelector]($backend) is used.
-     * The mask geometry can be filtered by [[subCategoryOrElementIds]].
-     */
-    readonly modelIds?: OrderedId64Iterable;
-    /** For [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludedElements]], the Ids of the [GeometricElement]($backend)s to include or exclude from masking;
-     * for [[PlanarClipMaskMode.IncludeSubCategories]], the Ids of the subcategories whose geometry contributes to the mask.
-     */
-    readonly subCategoryOrElementIds?: OrderedId64Iterable;
-    /** For [[PlanarClipMaskMode.Priority]], the priority value. */
-    readonly priority?: number;
-    /** A value between 0 and 1 indicating an override for mask transparency. A transparency of 0 indicates complete masking. 1 is completely transparent (no masking).
-     If no transparency is defined then the transparencies of the mask elements are used.
-     */
-    readonly transparency?: number;
-    /** A value of true indicates that the mask should be inverted and only content within the mask should be displayed, in other words the area inside the mask is displayed rather than outside. */
-    readonly invert: boolean;
-    private readonly _modelIds?;
-    private readonly _subCategoryOrElementIds?;
-    /** The compressed representation of [[modelIds]]. */
-    get compressedModelIds(): CompressedId64Set | undefined;
-    /** Create a new [[PlanarClipMaskSettings]] object from its JSON representation. */
-    static fromJSON(json?: PlanarClipMaskProps): PlanarClipMaskSettings;
-    /** Create a new PlanarClipMaskSettings. */
-    static create(args: ModelPlanarClipMaskArgs | ElementPlanarClipMaskArgs | SubCategoryPlanarClipMaskArgs | PriorityPlanarClipMaskArgs): PlanarClipMaskSettings;
-    /** Create JSON object representing this [[PlanarClipMaskSettings]] */
-    toJSON(): PlanarClipMaskProps;
-    /** Returns true if masking is enabled. */
-    get isValid(): boolean;
-    equals(other: PlanarClipMaskSettings): boolean;
-    /** Create a copy of this TerrainSettings, optionally modifying some of its properties.
-     * @param changedProps JSON representation of the properties to change.
-     * @returns A PlanarClipMaskSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.
-     */
-    clone(changedProps?: PlanarClipMaskProps): PlanarClipMaskSettings;
-    private constructor();
-    /** A default PlanarClipMask which masks nothing. */
-    static defaults: PlanarClipMaskSettings;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { CompressedId64Set, Id64String, OrderedId64Iterable } from "@itwin/core-bentley";
+/** The different modes by which a [[PlanarClipMaskSettings]] collects the geometry used to mask a model.
+ * @public
+ * @extensions
+ */
+export declare enum PlanarClipMaskMode {
+    /** No masking. */
+    None = 0,
+    /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].
+     * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.
+     * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.
+     */
+    Priority = 1,
+    /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s. */
+    Models = 2,
+    /** Indicates that masks should be produced from geometry belonging to a set of subcategories. */
+    IncludeSubCategories = 3,
+    /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s. */
+    IncludeElements = 4,
+    /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements. */
+    ExcludeElements = 5
+}
+/** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.
+ * The default can be overridden by [[PlanarClipMaskSettings.priority]].
+ *  @public
+ * @extensions
+ */
+export declare enum PlanarClipMaskPriority {
+    /** Background map. */
+    BackgroundMap = -2048,
+    /** A reality model that spans the globe - e.g., OpenStreetMaps Buildings. */
+    GlobalRealityModel = -1024,
+    /** A reality model with a bounded range. */
+    RealityModel = 0,
+    /** A design model stored in the [IModelDb]($backend). */
+    DesignModel = 2048
+}
+/** JSON representation of a [[PlanarClipMaskSettings]].
+ * @see [[DisplayStyleSettingsProps.planarClipOvr]] and [[ContextRealityModelProps.planarClipMask]].
+ * @public
+ * @extensions
+ */
+export interface PlanarClipMaskProps {
+    /** Controls how the mask geometry is collected */
+    mode: PlanarClipMaskMode;
+    /** See [[PlanarClipMaskSettings.modelIds]]. */
+    modelIds?: CompressedId64Set;
+    /** See [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */
+    subCategoryOrElementIds?: CompressedId64Set;
+    /** See [[PlanarClipMaskSettings.priority]]. */
+    priority?: number;
+    /** See [[PlanarClipMaskSettings.transparency]]. */
+    transparency?: number;
+    /** See PlanarClipMaskSettings.invert */
+    invert?: boolean;
+}
+/** Basic arguments supplied to [[PlanarClipMaskSettings.create]].
+ * @public
+ */
+export interface BasicPlanarClipMaskArgs {
+    /** See [[PlanarClipMaskSettings.transparency]]. */
+    transparency?: number;
+    /** See [[PlanarClipMaskSettings.invert]]. */
+    invert?: boolean;
+}
+/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Models]].
+ * @public
+ */
+export interface ModelPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
+    /** See [[PlanarClipMaskSettings.modelIds]]. */
+    modelIds?: Iterable<Id64String>;
+    /** @internal */
+    exclude?: never;
+    /** @internal */
+    elementIds?: never;
+    /** @internal */
+    subCategoryIds?: never;
+    /** @internal */
+    priority?: never;
+}
+/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludeElements]].
+ * @public
+ */
+export interface ElementPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
+    /** See [[PlanarClipMaskSettings.modelIds]]. */
+    modelIds?: Iterable<Id64String>;
+    /** The elements used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */
+    elementIds: Iterable<Id64String>;
+    /** If true, creates a mask of [[PlanarClipMaskMode.ExcludeElements]]; otherwise, [[PlanarClipMaskMode.IncludeElements]]. */
+    exclude?: boolean;
+    /** @internal */
+    subCategoryIds?: never;
+    /** @internal */
+    priority?: never;
+}
+/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeSubCategories]].
+ * @public
+ */
+export interface SubCategoryPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
+    /** See [[PlanarClipMaskSettings.modelIds]]. */
+    modelIds?: Iterable<Id64String>;
+    /** The subcategories used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */
+    subCategoryIds: Iterable<Id64String>;
+    /** @internal */
+    exclude?: never;
+    /** @internal */
+    elementIds?: never;
+    /** @internal */
+    priority?: never;
+}
+/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Priority]].
+ * @public
+ */
+export interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {
+    /** See [[PlanarClipMaskSettings.priority]]. */
+    priority: number;
+    /** @internal */
+    exclude?: never;
+    /** @internal */
+    elementIds?: never;
+    /** @internal */
+    modelIds?: never;
+}
+/** Describes how to mask the geometry of one [GeometricModel]($backend) for display. The mask is produced by projecting geometry from any number of other models -
+ * optionally filtered by [SubCategory]($backend) or by a set of specific [GeometricElement]($backend)s - onto a plane. Regions of the masked model that intersect the
+ * mask are rendered partially or completely transparent. This is useful for, e.g., making subsurface geometry visible below the background map, or clipping out portions
+ * of a reality model that intersect a design model.
+ * @note Currently reality models (including background maps and terrain) can be masked, but design models can only produce masks.
+ * @see [[DisplayStyleSettings.planarClipMasks]] to define clip masks for a [DisplayStyle]($backend).
+ * @see [[ContextRealityModel.planarClipMaskSettings]] to apply a clip mask to a context reality model.
+ * @public
+ */
+export declare class PlanarClipMaskSettings {
+    /** Specifies how the mask geometry is produced. */
+    readonly mode: PlanarClipMaskMode;
+    /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask.
+     * If `undefined`, the set of all models in the view's [ModelSelector]($backend) is used.
+     * The mask geometry can be filtered by [[subCategoryOrElementIds]].
+     */
+    readonly modelIds?: OrderedId64Iterable;
+    /** For [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludedElements]], the Ids of the [GeometricElement]($backend)s to include or exclude from masking;
+     * for [[PlanarClipMaskMode.IncludeSubCategories]], the Ids of the subcategories whose geometry contributes to the mask.
+     */
+    readonly subCategoryOrElementIds?: OrderedId64Iterable;
+    /** For [[PlanarClipMaskMode.Priority]], the priority value. */
+    readonly priority?: number;
+    /** A value between 0 and 1 indicating an override for mask transparency. A transparency of 0 indicates complete masking. 1 is completely transparent (no masking).
+     If no transparency is defined then the transparencies of the mask elements are used.
+     */
+    readonly transparency?: number;
+    /** A value of true indicates that the mask should be inverted and only content within the mask should be displayed, in other words the area inside the mask is displayed rather than outside. */
+    readonly invert: boolean;
+    private readonly _modelIds?;
+    private readonly _subCategoryOrElementIds?;
+    /** The compressed representation of [[modelIds]]. */
+    get compressedModelIds(): CompressedId64Set | undefined;
+    /** Create a new [[PlanarClipMaskSettings]] object from its JSON representation. */
+    static fromJSON(json?: PlanarClipMaskProps): PlanarClipMaskSettings;
+    /** Create a new PlanarClipMaskSettings. */
+    static create(args: ModelPlanarClipMaskArgs | ElementPlanarClipMaskArgs | SubCategoryPlanarClipMaskArgs | PriorityPlanarClipMaskArgs): PlanarClipMaskSettings;
+    /** Create JSON object representing this [[PlanarClipMaskSettings]] */
+    toJSON(): PlanarClipMaskProps;
+    /** Returns true if masking is enabled. */
+    get isValid(): boolean;
+    equals(other: PlanarClipMaskSettings): boolean;
+    /** Create a copy of this TerrainSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A PlanarClipMaskSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps?: PlanarClipMaskProps): PlanarClipMaskSettings;
+    private constructor();
+    /** A default PlanarClipMask which masks nothing. */
+    static defaults: PlanarClipMaskSettings;
+}
 //# sourceMappingURL=PlanarClipMask.d.ts.map