@itwin/core-common 4.0.0-dev.51 → 4.0.0-dev.54

package/lib/esm/ChangesetProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChangesetProps.js","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;;GAGG;AAuCH;;;GAGG;AACH,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,mDAAmD;IACnD,uDAAW,CAAA;IACX,+CAA+C;IAC/C,qDAAU,CAAA;AACZ,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB","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/**\r\n * @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\n/** @public */\r\nexport type LocalFileName = string;\r\n/** @public */\r\nexport type LocalDirName = string;\r\n\r\n/** A string that identifies a changeset.\r\n * @note this string is *not* a Guid. It is generated internally based on the content of the changeset.\r\n * @public\r\n * @extensions\r\n */\r\nexport type ChangesetId = string;\r\n\r\n/** The index of a changeset, assigned by iModelHub.\r\n * @note 0 means \"before the first changeset.\" Values less than 0 are invalid.\r\n * @public\r\n * @extensions\r\n */\r\nexport type ChangesetIndex = number;\r\n\r\n/** Both the index and Id of a changeset\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangesetIndexAndId { readonly index: ChangesetIndex, readonly id: ChangesetId }\r\n\r\n/** The Id and optionally the index of a changeset\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangesetIdWithIndex { readonly index?: ChangesetIndex, readonly id: ChangesetId }\r\n\r\n/** either changeset index, id, or both\r\n* @public\r\n * @extensions\r\n*/\r\nexport type ChangesetIndexOrId = ChangesetIndexAndId | { readonly index: ChangesetIndex, readonly id?: never } | { readonly id: ChangesetId, readonly index?: never };\r\n\r\n/** Value to indicate whether a changeset contains schema changes or not\r\n * @public\r\n * @extensions\r\n */\r\nexport enum ChangesetType {\r\n  /** changeset does *not* contain schema changes. */\r\n  Regular = 0,\r\n  /** changeset *does* contain schema changes. */\r\n  Schema = 1,\r\n}\r\n\r\n/** Properties of a changeset\r\n * @beta\r\n */\r\nexport interface ChangesetProps {\r\n  /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */\r\n  index: ChangesetIndex;\r\n  /** the ChangesetId */\r\n  id: ChangesetId;\r\n  /** the ChangeSetId of the parent changeset of this changeset */\r\n  parentId: ChangesetId;\r\n  /** The type of changeset */\r\n  changesType: ChangesetType;\r\n  /** The user-supplied description of the work this changeset holds */\r\n  description: string;\r\n  /** The BriefcaseId of the briefcase that created this changeset */\r\n  briefcaseId: number;\r\n  /** The date this changeset was uploaded to the hub */\r\n  pushDate: string;\r\n  /** The identity of the user that created this changeset */\r\n  userCreated: string;\r\n  /** The size, in bytes, of this changeset */\r\n  size?: number;\r\n}\r\n\r\n/** Properties of a changeset file\r\n * @beta\r\n */\r\nexport interface ChangesetFileProps extends ChangesetProps {\r\n  /** The full pathname of the local file holding this changeset. */\r\n  pathname: LocalFileName;\r\n}\r\n\r\n/**\r\n * A range of changesets\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangesetRange {\r\n  /** index of the first changeset */\r\n  first: ChangesetIndex;\r\n  /** index of last changeset. If undefined, all changesets after first are returned. */\r\n  end?: ChangesetIndex;\r\n}\r\n"]}
+{"version":3,"file":"ChangesetProps.js","sourceRoot":"","sources":["../../src/ChangesetProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;;GAGG;AAuCH;;;GAGG;AACH,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,mDAAmD;IACnD,uDAAW,CAAA;IACX,+CAA+C;IAC/C,qDAAU,CAAA;AACZ,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB","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/**\n * @packageDocumentation\n * @module iModels\n */\n\n/** @public */\nexport type LocalFileName = string;\n/** @public */\nexport type LocalDirName = string;\n\n/** A string that identifies a changeset.\n * @note this string is *not* a Guid. It is generated internally based on the content of the changeset.\n * @public\n * @extensions\n */\nexport type ChangesetId = string;\n\n/** The index of a changeset, assigned by iModelHub.\n * @note 0 means \"before the first changeset.\" Values less than 0 are invalid.\n * @public\n * @extensions\n */\nexport type ChangesetIndex = number;\n\n/** Both the index and Id of a changeset\n * @public\n * @extensions\n */\nexport interface ChangesetIndexAndId { readonly index: ChangesetIndex, readonly id: ChangesetId }\n\n/** The Id and optionally the index of a changeset\n * @public\n * @extensions\n */\nexport interface ChangesetIdWithIndex { readonly index?: ChangesetIndex, readonly id: ChangesetId }\n\n/** either changeset index, id, or both\n* @public\n * @extensions\n*/\nexport type ChangesetIndexOrId = ChangesetIndexAndId | { readonly index: ChangesetIndex, readonly id?: never } | { readonly id: ChangesetId, readonly index?: never };\n\n/** Value to indicate whether a changeset contains schema changes or not\n * @public\n * @extensions\n */\nexport enum ChangesetType {\n  /** changeset does *not* contain schema changes. */\n  Regular = 0,\n  /** changeset *does* contain schema changes. */\n  Schema = 1,\n}\n\n/** Properties of a changeset\n * @beta\n */\nexport interface ChangesetProps {\n  /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */\n  index: ChangesetIndex;\n  /** the ChangesetId */\n  id: ChangesetId;\n  /** the ChangeSetId of the parent changeset of this changeset */\n  parentId: ChangesetId;\n  /** The type of changeset */\n  changesType: ChangesetType;\n  /** The user-supplied description of the work this changeset holds */\n  description: string;\n  /** The BriefcaseId of the briefcase that created this changeset */\n  briefcaseId: number;\n  /** The date this changeset was uploaded to the hub */\n  pushDate: string;\n  /** The identity of the user that created this changeset */\n  userCreated: string;\n  /** The size, in bytes, of this changeset */\n  size?: number;\n}\n\n/** Properties of a changeset file\n * @beta\n */\nexport interface ChangesetFileProps extends ChangesetProps {\n  /** The full pathname of the local file holding this changeset. */\n  pathname: LocalFileName;\n}\n\n/**\n * A range of changesets\n * @public\n * @extensions\n */\nexport interface ChangesetRange {\n  /** index of the first changeset */\n  first: ChangesetIndex;\n  /** index of last changeset. If undefined, all changesets after first are returned. */\n  end?: ChangesetIndex;\n}\n"]}

package/lib/esm/ClipStyle.d.ts

@@ -1,90 +1,90 @@
-/** @packageDocumentation
- * @module Views
- */
-import { ViewFlagOverrides } from "./ViewFlags";
-import { RgbColor, RgbColorProps } from "./RgbColor";
-import { HiddenLine } from "./HiddenLine";
-import { FeatureAppearance, FeatureAppearanceProps } from "./FeatureSymbology";
-/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).
- * @see [[ClipStyleProps.cutStyle]].
- * @public
- * @extensions
- */
-export interface CutStyleProps {
-    /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */
-    viewflags?: ViewFlagOverrides;
-    /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */
-    hiddenLine?: HiddenLine.SettingsProps;
-    /** If defined, overrides aspects of the cut geometry's symbology. */
-    appearance?: FeatureAppearanceProps;
-}
-/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.
- * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.
- * @public
- */
-export declare class CutStyle {
-    /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */
-    readonly viewflags: Readonly<ViewFlagOverrides>;
-    /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */
-    readonly hiddenLine?: HiddenLine.Settings;
-    /** If defined, overrides aspects of the symbology of the section-cut graphics. */
-    readonly appearance?: FeatureAppearance;
-    /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */
-    static readonly defaults: CutStyle;
-    private constructor();
-    /** Create a CutStyle from its components. */
-    static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle;
-    static fromJSON(props?: CutStyleProps): CutStyle;
-    /** Return JSON representation. The representation is `undefined` if this style matches the default style. */
-    toJSON(): CutStyleProps | undefined;
-    /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */
-    get matchesDefaults(): boolean;
-}
-/** Wire format describing a [[ClipStyle]].
- * @see [[DisplayStyleSettingsProps.clipStyle]].
- * @public
- * @extensions
- */
-export interface ClipStyleProps {
-    /** If `true`, geometry will be produced at the clip planes in a 3d view.
-     * - Solids (closed volumes) will produce facets on the clip planes.
-     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
-     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
-     */
-    produceCutGeometry?: boolean;
-    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
-    cutStyle?: CutStyleProps;
-    /** If defined, geometry inside the clip planes will be drawn in this color. */
-    insideColor?: RgbColorProps;
-    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
-    outsideColor?: RgbColorProps;
-}
-/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].
- * @see [[DisplayStyleSettings.clipStyle]].
- * @public
- */
-export declare class ClipStyle {
-    /** If `true`, geometry will be produced at the clip planes.
-     * - Solids (closed volumes) will produce facets on the clip planes.
-     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
-     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
-     */
-    readonly produceCutGeometry: boolean;
-    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
-    readonly cutStyle: CutStyle;
-    /** If defined, geometry inside the clip planes will be drawn in this color. */
-    readonly insideColor?: RgbColor;
-    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
-    readonly outsideColor?: RgbColor;
-    /** The default style, which overrides none of the view's settings. */
-    static readonly defaults: ClipStyle;
-    private constructor();
-    /** Create a style from its components. */
-    static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle;
-    static fromJSON(props?: ClipStyleProps): ClipStyle;
-    /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */
-    toJSON(): ClipStyleProps | undefined;
-    /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */
-    get matchesDefaults(): boolean;
-}
+/** @packageDocumentation
+ * @module Views
+ */
+import { ViewFlagOverrides } from "./ViewFlags";
+import { RgbColor, RgbColorProps } from "./RgbColor";
+import { HiddenLine } from "./HiddenLine";
+import { FeatureAppearance, FeatureAppearanceProps } from "./FeatureSymbology";
+/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).
+ * @see [[ClipStyleProps.cutStyle]].
+ * @public
+ * @extensions
+ */
+export interface CutStyleProps {
+    /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */
+    viewflags?: ViewFlagOverrides;
+    /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */
+    hiddenLine?: HiddenLine.SettingsProps;
+    /** If defined, overrides aspects of the cut geometry's symbology. */
+    appearance?: FeatureAppearanceProps;
+}
+/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.
+ * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.
+ * @public
+ */
+export declare class CutStyle {
+    /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */
+    readonly viewflags: Readonly<ViewFlagOverrides>;
+    /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */
+    readonly hiddenLine?: HiddenLine.Settings;
+    /** If defined, overrides aspects of the symbology of the section-cut graphics. */
+    readonly appearance?: FeatureAppearance;
+    /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */
+    static readonly defaults: CutStyle;
+    private constructor();
+    /** Create a CutStyle from its components. */
+    static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle;
+    static fromJSON(props?: CutStyleProps): CutStyle;
+    /** Return JSON representation. The representation is `undefined` if this style matches the default style. */
+    toJSON(): CutStyleProps | undefined;
+    /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */
+    get matchesDefaults(): boolean;
+}
+/** Wire format describing a [[ClipStyle]].
+ * @see [[DisplayStyleSettingsProps.clipStyle]].
+ * @public
+ * @extensions
+ */
+export interface ClipStyleProps {
+    /** If `true`, geometry will be produced at the clip planes in a 3d view.
+     * - Solids (closed volumes) will produce facets on the clip planes.
+     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
+     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
+     */
+    produceCutGeometry?: boolean;
+    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
+    cutStyle?: CutStyleProps;
+    /** If defined, geometry inside the clip planes will be drawn in this color. */
+    insideColor?: RgbColorProps;
+    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
+    outsideColor?: RgbColorProps;
+}
+/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].
+ * @see [[DisplayStyleSettings.clipStyle]].
+ * @public
+ */
+export declare class ClipStyle {
+    /** If `true`, geometry will be produced at the clip planes.
+     * - Solids (closed volumes) will produce facets on the clip planes.
+     * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.
+     * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.
+     */
+    readonly produceCutGeometry: boolean;
+    /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */
+    readonly cutStyle: CutStyle;
+    /** If defined, geometry inside the clip planes will be drawn in this color. */
+    readonly insideColor?: RgbColor;
+    /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */
+    readonly outsideColor?: RgbColor;
+    /** The default style, which overrides none of the view's settings. */
+    static readonly defaults: ClipStyle;
+    private constructor();
+    /** Create a style from its components. */
+    static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle;
+    static fromJSON(props?: ClipStyleProps): ClipStyle;
+    /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */
+    toJSON(): ClipStyleProps | undefined;
+    /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */
+    get matchesDefaults(): boolean;
+}
 //# sourceMappingURL=ClipStyle.d.ts.map

package/lib/esm/ClipStyle.js

@@ -1,117 +1,119 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { assert, JsonUtils } from "@itwin/core-bentley";
-import { RgbColor } from "./RgbColor";
-import { HiddenLine } from "./HiddenLine";
-import { FeatureAppearance } from "./FeatureSymbology";
-/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.
- * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.
- * @public
- */
-export class CutStyle {
-    constructor(viewflags, hiddenLine, appearance) {
-        this.viewflags = viewflags ?? {};
-        if (hiddenLine && !hiddenLine.matchesDefaults)
-            this.hiddenLine = hiddenLine;
-        if (appearance && !appearance.matchesDefaults)
-            this.appearance = appearance;
-    }
-    /** Create a CutStyle from its components. */
-    static create(viewflags, hiddenLine, appearance) {
-        if ((viewflags && JsonUtils.isNonEmptyObject(viewflags)) || (hiddenLine && !hiddenLine.matchesDefaults) || (appearance && !appearance.matchesDefaults))
-            return new CutStyle(viewflags, hiddenLine, appearance);
-        return this.defaults;
-    }
-    static fromJSON(props) {
-        if (JsonUtils.isNonEmptyObject(props)) {
-            const viewflags = { ...props?.viewflags };
-            const hiddenLine = props?.hiddenLine ? HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;
-            const appearance = props?.appearance ? FeatureAppearance.fromJSON(props.appearance) : undefined;
-            return this.create(viewflags, hiddenLine, appearance);
-        }
-        else {
-            return this.defaults;
-        }
-    }
-    /** Return JSON representation. The representation is `undefined` if this style matches the default style. */
-    toJSON() {
-        if (this.matchesDefaults)
-            return undefined;
-        const props = {};
-        if (JsonUtils.isNonEmptyObject(this.viewflags))
-            props.viewflags = this.viewflags;
-        if (this.hiddenLine && !this.hiddenLine.matchesDefaults)
-            props.hiddenLine = this.hiddenLine?.toJSON();
-        if (this.appearance && !this.appearance.matchesDefaults)
-            props.appearance = this.appearance.toJSON();
-        return props;
-    }
-    /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */
-    get matchesDefaults() {
-        if (this === CutStyle.defaults)
-            return true;
-        return !JsonUtils.isNonEmptyObject(this.viewflags) && (!this.hiddenLine || this.hiddenLine.matchesDefaults) && (!this.appearance || this.appearance.matchesDefaults);
-    }
-}
-/** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */
-CutStyle.defaults = new CutStyle();
-/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].
- * @see [[DisplayStyleSettings.clipStyle]].
- * @public
- */
-export class ClipStyle {
-    constructor(produceCutGeometry, cutStyle, inside, outside) {
-        this.produceCutGeometry = produceCutGeometry;
-        this.cutStyle = cutStyle;
-        this.insideColor = inside;
-        this.outsideColor = outside;
-    }
-    /** Create a style from its components. */
-    static create(produceCutGeometry, cutStyle, insideColor, outsideColor) {
-        if (!produceCutGeometry && cutStyle.matchesDefaults && !insideColor && !outsideColor)
-            return this.defaults;
-        return new ClipStyle(produceCutGeometry, cutStyle, insideColor, outsideColor);
-    }
-    static fromJSON(props) {
-        if (JsonUtils.isNonEmptyObject(props)) {
-            const produceCutGeometry = props.produceCutGeometry ?? false;
-            const cutStyle = CutStyle.fromJSON(props.cutStyle);
-            const inside = props.insideColor ? RgbColor.fromJSON(props.insideColor) : undefined;
-            const outside = props.outsideColor ? RgbColor.fromJSON(props.outsideColor) : undefined;
-            return this.create(produceCutGeometry, cutStyle, inside, outside);
-        }
-        return this.defaults;
-    }
-    /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */
-    toJSON() {
-        if (this.matchesDefaults)
-            return undefined;
-        const props = {};
-        if (this.produceCutGeometry)
-            props.produceCutGeometry = true;
-        const cutStyle = this.cutStyle.toJSON();
-        if (cutStyle) {
-            assert(!this.cutStyle.matchesDefaults);
-            props.cutStyle = cutStyle;
-        }
-        if (this.insideColor)
-            props.insideColor = this.insideColor.toJSON();
-        if (this.outsideColor)
-            props.outsideColor = this.outsideColor.toJSON();
-        return props;
-    }
-    /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */
-    get matchesDefaults() {
-        if (this === ClipStyle.defaults)
-            return true;
-        return !this.produceCutGeometry && !this.insideColor && !this.outsideColor && this.cutStyle.matchesDefaults;
-    }
-}
-/** The default style, which overrides none of the view's settings. */
-ClipStyle.defaults = new ClipStyle(false, CutStyle.defaults, undefined, undefined);
+/*---------------------------------------------------------------------------------------------
+* 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 { assert, JsonUtils } from "@itwin/core-bentley";
+import { RgbColor } from "./RgbColor";
+import { HiddenLine } from "./HiddenLine";
+import { FeatureAppearance } from "./FeatureSymbology";
+/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.
+ * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.
+ * @public
+ */
+class CutStyle {
+    constructor(viewflags, hiddenLine, appearance) {
+        this.viewflags = viewflags ?? {};
+        if (hiddenLine && !hiddenLine.matchesDefaults)
+            this.hiddenLine = hiddenLine;
+        if (appearance && !appearance.matchesDefaults)
+            this.appearance = appearance;
+    }
+    /** Create a CutStyle from its components. */
+    static create(viewflags, hiddenLine, appearance) {
+        if ((viewflags && JsonUtils.isNonEmptyObject(viewflags)) || (hiddenLine && !hiddenLine.matchesDefaults) || (appearance && !appearance.matchesDefaults))
+            return new CutStyle(viewflags, hiddenLine, appearance);
+        return this.defaults;
+    }
+    static fromJSON(props) {
+        if (JsonUtils.isNonEmptyObject(props)) {
+            const viewflags = { ...props?.viewflags };
+            const hiddenLine = props?.hiddenLine ? HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;
+            const appearance = props?.appearance ? FeatureAppearance.fromJSON(props.appearance) : undefined;
+            return this.create(viewflags, hiddenLine, appearance);
+        }
+        else {
+            return this.defaults;
+        }
+    }
+    /** Return JSON representation. The representation is `undefined` if this style matches the default style. */
+    toJSON() {
+        if (this.matchesDefaults)
+            return undefined;
+        const props = {};
+        if (JsonUtils.isNonEmptyObject(this.viewflags))
+            props.viewflags = this.viewflags;
+        if (this.hiddenLine && !this.hiddenLine.matchesDefaults)
+            props.hiddenLine = this.hiddenLine?.toJSON();
+        if (this.appearance && !this.appearance.matchesDefaults)
+            props.appearance = this.appearance.toJSON();
+        return props;
+    }
+    /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */
+    get matchesDefaults() {
+        if (this === CutStyle.defaults)
+            return true;
+        return !JsonUtils.isNonEmptyObject(this.viewflags) && (!this.hiddenLine || this.hiddenLine.matchesDefaults) && (!this.appearance || this.appearance.matchesDefaults);
+    }
+}
+/** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */
+CutStyle.defaults = new CutStyle();
+export { CutStyle };
+/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].
+ * @see [[DisplayStyleSettings.clipStyle]].
+ * @public
+ */
+class ClipStyle {
+    constructor(produceCutGeometry, cutStyle, inside, outside) {
+        this.produceCutGeometry = produceCutGeometry;
+        this.cutStyle = cutStyle;
+        this.insideColor = inside;
+        this.outsideColor = outside;
+    }
+    /** Create a style from its components. */
+    static create(produceCutGeometry, cutStyle, insideColor, outsideColor) {
+        if (!produceCutGeometry && cutStyle.matchesDefaults && !insideColor && !outsideColor)
+            return this.defaults;
+        return new ClipStyle(produceCutGeometry, cutStyle, insideColor, outsideColor);
+    }
+    static fromJSON(props) {
+        if (JsonUtils.isNonEmptyObject(props)) {
+            const produceCutGeometry = props.produceCutGeometry ?? false;
+            const cutStyle = CutStyle.fromJSON(props.cutStyle);
+            const inside = props.insideColor ? RgbColor.fromJSON(props.insideColor) : undefined;
+            const outside = props.outsideColor ? RgbColor.fromJSON(props.outsideColor) : undefined;
+            return this.create(produceCutGeometry, cutStyle, inside, outside);
+        }
+        return this.defaults;
+    }
+    /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */
+    toJSON() {
+        if (this.matchesDefaults)
+            return undefined;
+        const props = {};
+        if (this.produceCutGeometry)
+            props.produceCutGeometry = true;
+        const cutStyle = this.cutStyle.toJSON();
+        if (cutStyle) {
+            assert(!this.cutStyle.matchesDefaults);
+            props.cutStyle = cutStyle;
+        }
+        if (this.insideColor)
+            props.insideColor = this.insideColor.toJSON();
+        if (this.outsideColor)
+            props.outsideColor = this.outsideColor.toJSON();
+        return props;
+    }
+    /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */
+    get matchesDefaults() {
+        if (this === ClipStyle.defaults)
+            return true;
+        return !this.produceCutGeometry && !this.insideColor && !this.outsideColor && this.cutStyle.matchesDefaults;
+    }
+}
+/** The default style, which overrides none of the view's settings. */
+ClipStyle.defaults = new ClipStyle(false, CutStyle.defaults, undefined, undefined);
+export { ClipStyle };
 //# sourceMappingURL=ClipStyle.js.map

package/lib/esm/ClipStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClipStyle.js","sourceRoot":"","sources":["../../src/ClipStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAA0B,MAAM,oBAAoB,CAAC;AAgB/E;;;GAGG;AACH,MAAM,OAAO,QAAQ;IAWnB,YAAoB,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC3H,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,EAAE,CAAC;QACjC,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE/B,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,MAAM,CAAC,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC5H,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACpJ,OAAO,IAAI,QAAQ,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAEzD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAqB;QAC1C,IAAI,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAClG,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEhG,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;SACvD;aAAM;YACL,OAAO,IAAI,CAAC,QAAQ,CAAC;SACtB;IACH,CAAC;IAED,6GAA6G;IACtG,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,IAAI,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC;YAC5C,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gHAAgH;IAChH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,QAAQ,CAAC,QAAQ;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACvK,CAAC;;AAxDD,sHAAsH;AAC/F,iBAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;AA8EnD;;;GAGG;AACH,MAAM,OAAO,SAAS;IAiBpB,YAAoB,kBAA2B,EAAE,QAAkB,EAAE,MAA4B,EAAE,OAA6B;QAC9H,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;IAC9B,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,MAAM,CAAC,kBAA2B,EAAE,QAAkB,EAAE,WAAsB,EAAE,YAAuB;QACnH,IAAI,CAAC,kBAAkB,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,WAAW,IAAI,CAAC,YAAY;YAClF,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,SAAS,CAAC,kBAAkB,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IAChF,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAsB;QAC3C,IAAI,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC;YAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEvF,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;SACnE;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,mGAAmG;IAC5F,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAmB,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAElC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxC,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YACvC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC3B;QAED,IAAI,IAAI,CAAC,WAAW;YAClB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAEhD,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uHAAuH;IACvH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,SAAS,CAAC,QAAQ;YAC7B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC9G,CAAC;;AA7DD,sEAAsE;AAC/C,kBAAQ,GAAG,IAAI,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC","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 { assert, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { ViewFlagOverrides } from \"./ViewFlags\";\r\nimport { RgbColor, RgbColorProps } from \"./RgbColor\";\r\nimport { HiddenLine } from \"./HiddenLine\";\r\nimport { FeatureAppearance, FeatureAppearanceProps } from \"./FeatureSymbology\";\r\n\r\n/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).\r\n * @see [[ClipStyleProps.cutStyle]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface CutStyleProps {\r\n  /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */\r\n  viewflags?: ViewFlagOverrides;\r\n  /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */\r\n  hiddenLine?: HiddenLine.SettingsProps;\r\n  /** If defined, overrides aspects of the cut geometry's symbology. */\r\n  appearance?: FeatureAppearanceProps;\r\n}\r\n\r\n/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.\r\n * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.\r\n * @public\r\n */\r\nexport class CutStyle {\r\n  /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */\r\n  public readonly viewflags: Readonly<ViewFlagOverrides>;\r\n  /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */\r\n  public readonly hiddenLine?: HiddenLine.Settings;\r\n  /** If defined, overrides aspects of the symbology of the section-cut graphics. */\r\n  public readonly appearance?: FeatureAppearance;\r\n\r\n  /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */\r\n  public static readonly defaults = new CutStyle();\r\n\r\n  private constructor(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance) {\r\n    this.viewflags = viewflags ?? {};\r\n    if (hiddenLine && !hiddenLine.matchesDefaults)\r\n      this.hiddenLine = hiddenLine;\r\n\r\n    if (appearance && !appearance.matchesDefaults)\r\n      this.appearance = appearance;\r\n  }\r\n\r\n  /** Create a CutStyle from its components. */\r\n  public static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle {\r\n    if ((viewflags && JsonUtils.isNonEmptyObject(viewflags)) || (hiddenLine && !hiddenLine.matchesDefaults) || (appearance && !appearance.matchesDefaults))\r\n      return new CutStyle(viewflags, hiddenLine, appearance);\r\n\r\n    return this.defaults;\r\n  }\r\n\r\n  public static fromJSON(props?: CutStyleProps): CutStyle {\r\n    if (JsonUtils.isNonEmptyObject(props)) {\r\n      const viewflags = { ...props?.viewflags };\r\n      const hiddenLine = props?.hiddenLine ? HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;\r\n      const appearance = props?.appearance ? FeatureAppearance.fromJSON(props.appearance) : undefined;\r\n\r\n      return this.create(viewflags, hiddenLine, appearance);\r\n    } else {\r\n      return this.defaults;\r\n    }\r\n  }\r\n\r\n  /** Return JSON representation. The representation is `undefined` if this style matches the default style. */\r\n  public toJSON(): CutStyleProps | undefined {\r\n    if (this.matchesDefaults)\r\n      return undefined;\r\n\r\n    const props: CutStyleProps = {};\r\n    if (JsonUtils.isNonEmptyObject(this.viewflags))\r\n      props.viewflags = this.viewflags;\r\n\r\n    if (this.hiddenLine && !this.hiddenLine.matchesDefaults)\r\n      props.hiddenLine = this.hiddenLine?.toJSON();\r\n\r\n    if (this.appearance && !this.appearance.matchesDefaults)\r\n      props.appearance = this.appearance.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */\r\n  public get matchesDefaults(): boolean {\r\n    if (this === CutStyle.defaults)\r\n      return true;\r\n\r\n    return !JsonUtils.isNonEmptyObject(this.viewflags) && (!this.hiddenLine || this.hiddenLine.matchesDefaults) && (!this.appearance || this.appearance.matchesDefaults);\r\n  }\r\n}\r\n\r\n/** Wire format describing a [[ClipStyle]].\r\n * @see [[DisplayStyleSettingsProps.clipStyle]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ClipStyleProps {\r\n  /** If `true`, geometry will be produced at the clip planes in a 3d view.\r\n   * - Solids (closed volumes) will produce facets on the clip planes.\r\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\r\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\r\n   */\r\n  produceCutGeometry?: boolean;\r\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\r\n  cutStyle?: CutStyleProps;\r\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\r\n  insideColor?: RgbColorProps;\r\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\r\n  outsideColor?: RgbColorProps;\r\n}\r\n\r\n/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].\r\n * @see [[DisplayStyleSettings.clipStyle]].\r\n * @public\r\n */\r\nexport class ClipStyle {\r\n  /** If `true`, geometry will be produced at the clip planes.\r\n   * - Solids (closed volumes) will produce facets on the clip planes.\r\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\r\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\r\n   */\r\n  public readonly produceCutGeometry: boolean;\r\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\r\n  public readonly cutStyle: CutStyle;\r\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\r\n  public readonly insideColor?: RgbColor;\r\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\r\n  public readonly outsideColor?: RgbColor;\r\n\r\n  /** The default style, which overrides none of the view's settings. */\r\n  public static readonly defaults = new ClipStyle(false, CutStyle.defaults, undefined, undefined);\r\n\r\n  private constructor(produceCutGeometry: boolean, cutStyle: CutStyle, inside: RgbColor | undefined, outside: RgbColor | undefined) {\r\n    this.produceCutGeometry = produceCutGeometry;\r\n    this.cutStyle = cutStyle;\r\n    this.insideColor = inside;\r\n    this.outsideColor = outside;\r\n  }\r\n\r\n  /** Create a style from its components. */\r\n  public static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle {\r\n    if (!produceCutGeometry && cutStyle.matchesDefaults && !insideColor && !outsideColor)\r\n      return this.defaults;\r\n\r\n    return new ClipStyle(produceCutGeometry, cutStyle, insideColor, outsideColor);\r\n  }\r\n\r\n  public static fromJSON(props?: ClipStyleProps): ClipStyle {\r\n    if (JsonUtils.isNonEmptyObject(props)) {\r\n      const produceCutGeometry = props.produceCutGeometry ?? false;\r\n      const cutStyle = CutStyle.fromJSON(props.cutStyle);\r\n      const inside = props.insideColor ? RgbColor.fromJSON(props.insideColor) : undefined;\r\n      const outside = props.outsideColor ? RgbColor.fromJSON(props.outsideColor) : undefined;\r\n\r\n      return this.create(produceCutGeometry, cutStyle, inside, outside);\r\n    }\r\n\r\n    return this.defaults;\r\n  }\r\n\r\n  /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */\r\n  public toJSON(): ClipStyleProps | undefined {\r\n    if (this.matchesDefaults)\r\n      return undefined;\r\n\r\n    const props: ClipStyleProps = {};\r\n    if (this.produceCutGeometry)\r\n      props.produceCutGeometry = true;\r\n\r\n    const cutStyle = this.cutStyle.toJSON();\r\n    if (cutStyle) {\r\n      assert(!this.cutStyle.matchesDefaults);\r\n      props.cutStyle = cutStyle;\r\n    }\r\n\r\n    if (this.insideColor)\r\n      props.insideColor = this.insideColor.toJSON();\r\n\r\n    if (this.outsideColor)\r\n      props.outsideColor = this.outsideColor.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */\r\n  public get matchesDefaults(): boolean {\r\n    if (this === ClipStyle.defaults)\r\n      return true;\r\n\r\n    return !this.produceCutGeometry && !this.insideColor && !this.outsideColor && this.cutStyle.matchesDefaults;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ClipStyle.js","sourceRoot":"","sources":["../../src/ClipStyle.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAA0B,MAAM,oBAAoB,CAAC;AAgB/E;;;GAGG;AACH,MAAa,QAAQ;IAWnB,YAAoB,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC3H,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,EAAE,CAAC;QACjC,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE/B,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,MAAM,CAAC,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC5H,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACpJ,OAAO,IAAI,QAAQ,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAEzD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAqB;QAC1C,IAAI,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAClG,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEhG,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;SACvD;aAAM;YACL,OAAO,IAAI,CAAC,QAAQ,CAAC;SACtB;IACH,CAAC;IAED,6GAA6G;IACtG,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,IAAI,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC;YAC5C,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gHAAgH;IAChH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,QAAQ,CAAC,QAAQ;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACvK,CAAC;;AAxDD,sHAAsH;AAC/F,iBAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;SATtC,QAAQ;AAuFrB;;;GAGG;AACH,MAAa,SAAS;IAiBpB,YAAoB,kBAA2B,EAAE,QAAkB,EAAE,MAA4B,EAAE,OAA6B;QAC9H,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;IAC9B,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,MAAM,CAAC,kBAA2B,EAAE,QAAkB,EAAE,WAAsB,EAAE,YAAuB;QACnH,IAAI,CAAC,kBAAkB,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,WAAW,IAAI,CAAC,YAAY;YAClF,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,SAAS,CAAC,kBAAkB,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IAChF,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAsB;QAC3C,IAAI,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC;YAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEvF,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;SACnE;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,mGAAmG;IAC5F,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAmB,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAElC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxC,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YACvC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC3B;QAED,IAAI,IAAI,CAAC,WAAW;YAClB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAEhD,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uHAAuH;IACvH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,SAAS,CAAC,QAAQ;YAC7B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC9G,CAAC;;AA7DD,sEAAsE;AAC/C,kBAAQ,GAAG,IAAI,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;SAfrF,SAAS","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 { assert, JsonUtils } from \"@itwin/core-bentley\";\nimport { ViewFlagOverrides } from \"./ViewFlags\";\nimport { RgbColor, RgbColorProps } from \"./RgbColor\";\nimport { HiddenLine } from \"./HiddenLine\";\nimport { FeatureAppearance, FeatureAppearanceProps } from \"./FeatureSymbology\";\n\n/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).\n * @see [[ClipStyleProps.cutStyle]].\n * @public\n * @extensions\n */\nexport interface CutStyleProps {\n  /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */\n  viewflags?: ViewFlagOverrides;\n  /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */\n  hiddenLine?: HiddenLine.SettingsProps;\n  /** If defined, overrides aspects of the cut geometry's symbology. */\n  appearance?: FeatureAppearanceProps;\n}\n\n/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.\n * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.\n * @public\n */\nexport class CutStyle {\n  /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */\n  public readonly viewflags: Readonly<ViewFlagOverrides>;\n  /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */\n  public readonly hiddenLine?: HiddenLine.Settings;\n  /** If defined, overrides aspects of the symbology of the section-cut graphics. */\n  public readonly appearance?: FeatureAppearance;\n\n  /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */\n  public static readonly defaults = new CutStyle();\n\n  private constructor(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance) {\n    this.viewflags = viewflags ?? {};\n    if (hiddenLine && !hiddenLine.matchesDefaults)\n      this.hiddenLine = hiddenLine;\n\n    if (appearance && !appearance.matchesDefaults)\n      this.appearance = appearance;\n  }\n\n  /** Create a CutStyle from its components. */\n  public static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle {\n    if ((viewflags && JsonUtils.isNonEmptyObject(viewflags)) || (hiddenLine && !hiddenLine.matchesDefaults) || (appearance && !appearance.matchesDefaults))\n      return new CutStyle(viewflags, hiddenLine, appearance);\n\n    return this.defaults;\n  }\n\n  public static fromJSON(props?: CutStyleProps): CutStyle {\n    if (JsonUtils.isNonEmptyObject(props)) {\n      const viewflags = { ...props?.viewflags };\n      const hiddenLine = props?.hiddenLine ? HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;\n      const appearance = props?.appearance ? FeatureAppearance.fromJSON(props.appearance) : undefined;\n\n      return this.create(viewflags, hiddenLine, appearance);\n    } else {\n      return this.defaults;\n    }\n  }\n\n  /** Return JSON representation. The representation is `undefined` if this style matches the default style. */\n  public toJSON(): CutStyleProps | undefined {\n    if (this.matchesDefaults)\n      return undefined;\n\n    const props: CutStyleProps = {};\n    if (JsonUtils.isNonEmptyObject(this.viewflags))\n      props.viewflags = this.viewflags;\n\n    if (this.hiddenLine && !this.hiddenLine.matchesDefaults)\n      props.hiddenLine = this.hiddenLine?.toJSON();\n\n    if (this.appearance && !this.appearance.matchesDefaults)\n      props.appearance = this.appearance.toJSON();\n\n    return props;\n  }\n\n  /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */\n  public get matchesDefaults(): boolean {\n    if (this === CutStyle.defaults)\n      return true;\n\n    return !JsonUtils.isNonEmptyObject(this.viewflags) && (!this.hiddenLine || this.hiddenLine.matchesDefaults) && (!this.appearance || this.appearance.matchesDefaults);\n  }\n}\n\n/** Wire format describing a [[ClipStyle]].\n * @see [[DisplayStyleSettingsProps.clipStyle]].\n * @public\n * @extensions\n */\nexport interface ClipStyleProps {\n  /** If `true`, geometry will be produced at the clip planes in a 3d view.\n   * - Solids (closed volumes) will produce facets on the clip planes.\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\n   */\n  produceCutGeometry?: boolean;\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\n  cutStyle?: CutStyleProps;\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\n  insideColor?: RgbColorProps;\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\n  outsideColor?: RgbColorProps;\n}\n\n/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].\n * @see [[DisplayStyleSettings.clipStyle]].\n * @public\n */\nexport class ClipStyle {\n  /** If `true`, geometry will be produced at the clip planes.\n   * - Solids (closed volumes) will produce facets on the clip planes.\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\n   */\n  public readonly produceCutGeometry: boolean;\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\n  public readonly cutStyle: CutStyle;\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\n  public readonly insideColor?: RgbColor;\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\n  public readonly outsideColor?: RgbColor;\n\n  /** The default style, which overrides none of the view's settings. */\n  public static readonly defaults = new ClipStyle(false, CutStyle.defaults, undefined, undefined);\n\n  private constructor(produceCutGeometry: boolean, cutStyle: CutStyle, inside: RgbColor | undefined, outside: RgbColor | undefined) {\n    this.produceCutGeometry = produceCutGeometry;\n    this.cutStyle = cutStyle;\n    this.insideColor = inside;\n    this.outsideColor = outside;\n  }\n\n  /** Create a style from its components. */\n  public static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle {\n    if (!produceCutGeometry && cutStyle.matchesDefaults && !insideColor && !outsideColor)\n      return this.defaults;\n\n    return new ClipStyle(produceCutGeometry, cutStyle, insideColor, outsideColor);\n  }\n\n  public static fromJSON(props?: ClipStyleProps): ClipStyle {\n    if (JsonUtils.isNonEmptyObject(props)) {\n      const produceCutGeometry = props.produceCutGeometry ?? false;\n      const cutStyle = CutStyle.fromJSON(props.cutStyle);\n      const inside = props.insideColor ? RgbColor.fromJSON(props.insideColor) : undefined;\n      const outside = props.outsideColor ? RgbColor.fromJSON(props.outsideColor) : undefined;\n\n      return this.create(produceCutGeometry, cutStyle, inside, outside);\n    }\n\n    return this.defaults;\n  }\n\n  /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */\n  public toJSON(): ClipStyleProps | undefined {\n    if (this.matchesDefaults)\n      return undefined;\n\n    const props: ClipStyleProps = {};\n    if (this.produceCutGeometry)\n      props.produceCutGeometry = true;\n\n    const cutStyle = this.cutStyle.toJSON();\n    if (cutStyle) {\n      assert(!this.cutStyle.matchesDefaults);\n      props.cutStyle = cutStyle;\n    }\n\n    if (this.insideColor)\n      props.insideColor = this.insideColor.toJSON();\n\n    if (this.outsideColor)\n      props.outsideColor = this.outsideColor.toJSON();\n\n    return props;\n  }\n\n  /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */\n  public get matchesDefaults(): boolean {\n    if (this === ClipStyle.defaults)\n      return true;\n\n    return !this.produceCutGeometry && !this.insideColor && !this.outsideColor && this.cutStyle.matchesDefaults;\n  }\n}\n"]}