@itwin/core-common 4.0.0-dev.10 → 4.0.0-dev.101

package/lib/cjs/ViewProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"ViewProps.js","sourceRoot":"","sources":["../../src/ViewProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Views\r\n */\r\n\r\nimport { CompressedId64Set, Id64Array, Id64String } from \"@itwin/core-bentley\";\r\nimport { AngleProps, Range3dProps, TransformProps, XYProps, XYZProps, YawPitchRollProps } from \"@itwin/core-geometry\";\r\nimport { CameraProps } from \"./Camera\";\r\nimport { DisplayStyleProps } from \"./DisplayStyleSettings\";\r\nimport { DefinitionElementProps, DisplayStyleLoadProps, ElementProps, SheetProps, ViewAttachmentProps } from \"./ElementProps\";\r\nimport { EntityQueryParams } from \"./EntityProps\";\r\nimport { ModelProps } from \"./ModelProps\";\r\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\r\nimport { ViewDetails3dProps, ViewDetailsProps } from \"./ViewDetails\";\r\n\r\n/** As part of a [[ViewStateProps]], describes the [[SpatialViewDefinition]] from which a [SectionDrawing]($backend) was generated.\r\n * @see [[SectionDrawingProps]]\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SectionDrawingViewProps {\r\n  /** The Id of the spatial view from which the SectionDrawing was generated. */\r\n  spatialView: Id64String;\r\n  /** If true, the spatial view should be displayed in the context of the drawing view. */\r\n  displaySpatialView: boolean;\r\n  /** Transform from drawing coordinates to spatial coordinates. If undefined, use identity transform. */\r\n  drawingToSpatialTransform?: TransformProps;\r\n}\r\n\r\n/** The response props from the getCustomViewState3dData RPC endpoint\r\n * @internal\r\n */\r\nexport interface CustomViewState3dProps {\r\n  modelIds: CompressedId64Set;\r\n  modelExtents: Range3dProps;\r\n  categoryIds: CompressedId64Set;\r\n}\r\n\r\n/**\r\n * The options passed to the getCustomViewState3dData RPC endpoint.\r\n * @internal\r\n */\r\nexport interface CustomViewState3dCreatorOptions {\r\n  modelIds?: CompressedId64Set;\r\n}\r\n\r\n/**\r\n * A result row from querying for subcategories\r\n * @internal\r\n */\r\nexport interface SubCategoryResultRow {\r\n  parentId: Id64String;\r\n  id: Id64String;\r\n  appearance: SubCategoryAppearance.Props;\r\n}\r\n\r\n/**\r\n * Request props for the hydrateViewState RPC endpoint.\r\n * @internal\r\n */\r\nexport interface HydrateViewStateRequestProps {\r\n  acsId?: string;\r\n  notLoadedModelSelectorStateModels?: CompressedId64Set;\r\n  /** @deprecated in 3.x. If loading categoryIds is necessary, see [IModelConnection.SubCategoriesCache.load]($frontend)*/\r\n  notLoadedCategoryIds?: CompressedId64Set;\r\n  sheetViewAttachmentIds?: CompressedId64Set;\r\n  viewStateLoadProps?: ViewStateLoadProps;\r\n  baseModelId?: Id64String;\r\n  spatialViewId?: Id64String;\r\n}\r\n\r\n/** Response props from the hydrateViewState RPC endpoint.\r\n * @internal\r\n */\r\nexport interface HydrateViewStateResponseProps {\r\n  acsElementProps?: ElementProps;\r\n  modelSelectorStateModels?: ModelProps[];\r\n  // cast this to viewattachmentInfo[] on the frontend.\r\n  sheetViewAttachmentProps?: ViewAttachmentProps[];\r\n  sheetViewViews?: (ViewStateProps | undefined)[];\r\n  baseModelProps?: ModelProps;\r\n  spatialViewProps?: ViewStateProps;\r\n  /** @deprecated in 3.x. If loading categoryIds is necessary, see [IModelConnection.SubCategoriesCache.load]($frontend)*/\r\n  categoryIdsResult?: SubCategoryResultRow[];\r\n}\r\n\r\n/** Returned from [IModelDb.Views.getViewStateData]($backend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewStateProps {\r\n  viewDefinitionProps: ViewDefinitionProps;\r\n  categorySelectorProps: CategorySelectorProps;\r\n  modelSelectorProps?: ModelSelectorProps;\r\n  displayStyleProps: DisplayStyleProps;\r\n  /** Sheet-specific properties, if this is a view of a [SheetModel]($backend). */\r\n  sheetProps?: SheetProps;\r\n  /** The Ids of the [ViewAttachment]($backend)s contained within the [SheetModel]($backend), if this is a sheet view. */\r\n  sheetAttachments?: Id64Array;\r\n  /** For a [DrawingViewState]($frontend), the extents of the [DrawingModel]($backend), used for determining the upper limits of the view's extents. */\r\n  modelExtents?: Range3dProps;\r\n  /** Information about the [SectionDrawing]($backend) relevant to displaying a drawing view. */\r\n  sectionDrawing?: SectionDrawingViewProps;\r\n}\r\n\r\n/** Options for loading a [[ViewStateProps]] via [IModelConnection.Views.load]($frontend) or [IModelDb.Views.getViewStateData]($backend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewStateLoadProps {\r\n  /** Options for loading the view's [[DisplayStyleProps]]. */\r\n  displayStyle?: DisplayStyleLoadProps;\r\n}\r\n\r\n/** Properties that define a ModelSelector\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelSelectorProps extends DefinitionElementProps {\r\n  models: Id64Array;\r\n}\r\n\r\n/** Properties that define a CategorySelector\r\n * @public\r\n * @extensions\r\n */\r\nexport interface CategorySelectorProps extends DefinitionElementProps {\r\n  categories: Id64Array;\r\n}\r\n\r\n/** Parameters for performing a query on [ViewDefinition]($backend) classes.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewQueryParams extends EntityQueryParams {\r\n  wantPrivate?: boolean;\r\n}\r\n\r\n/** Parameters used to construct a ViewDefinition\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewDefinitionProps extends DefinitionElementProps {\r\n  categorySelectorId: Id64String;\r\n  displayStyleId: Id64String;\r\n  description?: string;\r\n  jsonProperties?: {\r\n    /** Additional properties of the view. */\r\n    viewDetails?: ViewDetailsProps;\r\n  };\r\n}\r\n\r\n/** Parameters to construct a ViewDefinition3d\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewDefinition3dProps extends ViewDefinitionProps {\r\n  /** if true, camera is valid. */\r\n  cameraOn: boolean;\r\n  /** The lower left back corner of the view frustum. */\r\n  origin: XYZProps;\r\n  /** The extent of the view frustum. */\r\n  extents: XYZProps;\r\n  /** Rotation of the view frustum (could be undefined if going Matrix3d -> YawPitchRoll). */\r\n  angles?: YawPitchRollProps;\r\n  /** The camera used for this view. */\r\n  camera: CameraProps;\r\n  jsonProperties?: {\r\n    /** Additional properties of the view. */\r\n    viewDetails?: ViewDetails3dProps;\r\n  };\r\n}\r\n\r\n/** Parameters to construct a SpatialViewDefinition\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SpatialViewDefinitionProps extends ViewDefinition3dProps {\r\n  modelSelectorId: Id64String;\r\n}\r\n\r\n/** Parameters used to construct a ViewDefinition2d\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewDefinition2dProps extends ViewDefinitionProps {\r\n  baseModelId: Id64String;\r\n  origin: XYProps;\r\n  delta: XYProps;\r\n  angle: AngleProps;\r\n}\r\n\r\n/**\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AuxCoordSystemProps extends ElementProps {\r\n  type?: number;\r\n  description?: string;\r\n}\r\n\r\n/**  Properties of AuxCoordSystem2d\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AuxCoordSystem2dProps extends AuxCoordSystemProps {\r\n  /** Origin of the AuxCoordSystem2d */\r\n  origin?: XYProps;\r\n  /** Rotation angle */\r\n  angle?: AngleProps;\r\n}\r\n\r\n/** Properties of AuxCoordSystem3d\r\n * @public\r\n * @extensions\r\n */\r\nexport interface AuxCoordSystem3dProps extends AuxCoordSystemProps {\r\n  /** Origin of the AuxCoordSystem3d */\r\n  origin?: XYZProps;\r\n  /** Yaw angle */\r\n  yaw?: AngleProps;\r\n  /** Pitch angle */\r\n  pitch?: AngleProps;\r\n  /** Roll angle */\r\n  roll?: AngleProps;\r\n}\r\n"]}
+{"version":3,"file":"ViewProps.js","sourceRoot":"","sources":["../../src/ViewProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Views\n */\n\nimport { CompressedId64Set, Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport { AngleProps, Range3dProps, TransformProps, XYProps, XYZProps, YawPitchRollProps } from \"@itwin/core-geometry\";\nimport { CameraProps } from \"./Camera\";\nimport { DisplayStyleProps } from \"./DisplayStyleSettings\";\nimport { DefinitionElementProps, DisplayStyleLoadProps, ElementProps, SheetProps, ViewAttachmentProps } from \"./ElementProps\";\nimport { EntityQueryParams } from \"./EntityProps\";\nimport { ModelProps } from \"./ModelProps\";\nimport { SubCategoryAppearance } from \"./SubCategoryAppearance\";\nimport { ViewDetails3dProps, ViewDetailsProps } from \"./ViewDetails\";\n\n/** As part of a [[ViewStateProps]], describes the [[SpatialViewDefinition]] from which a [SectionDrawing]($backend) was generated.\n * @see [[SectionDrawingProps]]\n * @public\n * @extensions\n */\nexport interface SectionDrawingViewProps {\n  /** The Id of the spatial view from which the SectionDrawing was generated. */\n  spatialView: Id64String;\n  /** If true, the spatial view should be displayed in the context of the drawing view. */\n  displaySpatialView: boolean;\n  /** Transform from drawing coordinates to spatial coordinates. If undefined, use identity transform. */\n  drawingToSpatialTransform?: TransformProps;\n}\n\n/** The response props from the getCustomViewState3dData RPC endpoint\n * @internal\n */\nexport interface CustomViewState3dProps {\n  modelIds: CompressedId64Set;\n  modelExtents: Range3dProps;\n  categoryIds: CompressedId64Set;\n}\n\n/**\n * The options passed to the getCustomViewState3dData RPC endpoint.\n * @internal\n */\nexport interface CustomViewState3dCreatorOptions {\n  modelIds?: CompressedId64Set;\n}\n\n/**\n * A result row from querying for subcategories\n * @internal\n */\nexport interface SubCategoryResultRow {\n  parentId: Id64String;\n  id: Id64String;\n  appearance: SubCategoryAppearance.Props;\n}\n\n/**\n * Request props for the hydrateViewState RPC endpoint.\n * @internal\n */\nexport interface HydrateViewStateRequestProps {\n  acsId?: string;\n  notLoadedModelSelectorStateModels?: CompressedId64Set;\n  /** @deprecated in 3.x. If loading categoryIds is necessary, see [IModelConnection.SubCategoriesCache.load]($frontend)*/\n  notLoadedCategoryIds?: CompressedId64Set;\n  sheetViewAttachmentIds?: CompressedId64Set;\n  viewStateLoadProps?: ViewStateLoadProps;\n  baseModelId?: Id64String;\n  spatialViewId?: Id64String;\n}\n\n/** Response props from the hydrateViewState RPC endpoint.\n * @internal\n */\nexport interface HydrateViewStateResponseProps {\n  acsElementProps?: ElementProps;\n  modelSelectorStateModels?: ModelProps[];\n  // cast this to viewattachmentInfo[] on the frontend.\n  sheetViewAttachmentProps?: ViewAttachmentProps[];\n  sheetViewViews?: (ViewStateProps | undefined)[];\n  baseModelProps?: ModelProps;\n  spatialViewProps?: ViewStateProps;\n  /** @deprecated in 3.x. If loading categoryIds is necessary, see [IModelConnection.SubCategoriesCache.load]($frontend)*/\n  categoryIdsResult?: SubCategoryResultRow[];\n}\n\n/** Returned from [IModelDb.Views.getViewStateData]($backend).\n * @public\n * @extensions\n */\nexport interface ViewStateProps {\n  viewDefinitionProps: ViewDefinitionProps;\n  categorySelectorProps: CategorySelectorProps;\n  modelSelectorProps?: ModelSelectorProps;\n  displayStyleProps: DisplayStyleProps;\n  /** Sheet-specific properties, if this is a view of a [SheetModel]($backend). */\n  sheetProps?: SheetProps;\n  /** The Ids of the [ViewAttachment]($backend)s contained within the [SheetModel]($backend), if this is a sheet view. */\n  sheetAttachments?: Id64Array;\n  /** For a [DrawingViewState]($frontend), the extents of the [DrawingModel]($backend), used for determining the upper limits of the view's extents. */\n  modelExtents?: Range3dProps;\n  /** Information about the [SectionDrawing]($backend) relevant to displaying a drawing view. */\n  sectionDrawing?: SectionDrawingViewProps;\n}\n\n/** Options for loading a [[ViewStateProps]] via [IModelConnection.Views.load]($frontend) or [IModelDb.Views.getViewStateData]($backend).\n * @public\n * @extensions\n */\nexport interface ViewStateLoadProps {\n  /** Options for loading the view's [[DisplayStyleProps]]. */\n  displayStyle?: DisplayStyleLoadProps;\n}\n\n/** Properties that define a ModelSelector\n * @public\n * @extensions\n */\nexport interface ModelSelectorProps extends DefinitionElementProps {\n  models: Id64Array;\n}\n\n/** Properties that define a CategorySelector\n * @public\n * @extensions\n */\nexport interface CategorySelectorProps extends DefinitionElementProps {\n  categories: Id64Array;\n}\n\n/** Parameters for performing a query on [ViewDefinition]($backend) classes.\n * @public\n * @extensions\n */\nexport interface ViewQueryParams extends EntityQueryParams {\n  wantPrivate?: boolean;\n}\n\n/** Parameters used to construct a ViewDefinition\n * @public\n * @extensions\n */\nexport interface ViewDefinitionProps extends DefinitionElementProps {\n  categorySelectorId: Id64String;\n  displayStyleId: Id64String;\n  description?: string;\n  jsonProperties?: {\n    /** Additional properties of the view. */\n    viewDetails?: ViewDetailsProps;\n  };\n}\n\n/** Parameters to construct a ViewDefinition3d\n * @public\n * @extensions\n */\nexport interface ViewDefinition3dProps extends ViewDefinitionProps {\n  /** if true, camera is valid. */\n  cameraOn: boolean;\n  /** The lower left back corner of the view frustum. */\n  origin: XYZProps;\n  /** The extent of the view frustum. */\n  extents: XYZProps;\n  /** Rotation of the view frustum (could be undefined if going Matrix3d -> YawPitchRoll). */\n  angles?: YawPitchRollProps;\n  /** The camera used for this view. */\n  camera: CameraProps;\n  jsonProperties?: {\n    /** Additional properties of the view. */\n    viewDetails?: ViewDetails3dProps;\n  };\n}\n\n/** Parameters to construct a SpatialViewDefinition\n * @public\n * @extensions\n */\nexport interface SpatialViewDefinitionProps extends ViewDefinition3dProps {\n  modelSelectorId: Id64String;\n}\n\n/** Parameters used to construct a ViewDefinition2d\n * @public\n * @extensions\n */\nexport interface ViewDefinition2dProps extends ViewDefinitionProps {\n  baseModelId: Id64String;\n  origin: XYProps;\n  delta: XYProps;\n  angle: AngleProps;\n}\n\n/**\n * @public\n * @extensions\n */\nexport interface AuxCoordSystemProps extends ElementProps {\n  type?: number;\n  description?: string;\n}\n\n/**  Properties of AuxCoordSystem2d\n * @public\n * @extensions\n */\nexport interface AuxCoordSystem2dProps extends AuxCoordSystemProps {\n  /** Origin of the AuxCoordSystem2d */\n  origin?: XYProps;\n  /** Rotation angle */\n  angle?: AngleProps;\n}\n\n/** Properties of AuxCoordSystem3d\n * @public\n * @extensions\n */\nexport interface AuxCoordSystem3dProps extends AuxCoordSystemProps {\n  /** Origin of the AuxCoordSystem3d */\n  origin?: XYZProps;\n  /** Yaw angle */\n  yaw?: AngleProps;\n  /** Pitch angle */\n  pitch?: AngleProps;\n  /** Roll angle */\n  roll?: AngleProps;\n}\n"]}

package/lib/cjs/WhiteOnWhiteReversalSettings.d.ts

@@ -1,37 +1,37 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-/** JSON representation of a [[WhiteOnWhiteReversalSettings]].
- * @public
- * @extensions
- */
-export interface WhiteOnWhiteReversalProps {
-    /** Default: false.
-     * @see [[WhiteOnWhiteReversalSettings.ignoreBackgroundColor]].
-     */
-    ignoreBackgroundColor?: boolean;
-}
-/** As part of a [[DisplayStyleSettings]], controls how white-on-white reversal is applied to make white geometry more
- * visible in the view.
- * By default, pure white geometry is displayed as black instead if the [[DisplayStyleSettings.backgroundColor]] is also pure white.
- * These settings are only applied if the display style's [[ViewFlags.whiteOnWhiteReversal]] flag is enabled.
- * @see [[DisplayStyleSettings.whiteOnWhiteReversal]] to change these settings for a display style.
- * @public
- */
-export declare class WhiteOnWhiteReversalSettings {
-    /** If true, white-on-white reversal ignores the display style's background color; otherwise, white-on-white reversal applies only
-     * if the background color is pure white.
-     * @see [[DisplayStyleSettings.backgroundColor]] to change the background color.
-     */
-    readonly ignoreBackgroundColor: boolean;
-    private constructor();
-    private static _noIgnore;
-    private static _ignore;
-    /** Create from JSON representation. */
-    static fromJSON(props?: WhiteOnWhiteReversalProps): WhiteOnWhiteReversalSettings;
-    /** Convert to JSON representation. The JSON representation is `undefined` if these settings match the defaults. */
-    toJSON(): WhiteOnWhiteReversalProps | undefined;
-    /** Returns true if `this` is equivalent to `other`. */
-    equals(other: WhiteOnWhiteReversalSettings): boolean;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+/** JSON representation of a [[WhiteOnWhiteReversalSettings]].
+ * @public
+ * @extensions
+ */
+export interface WhiteOnWhiteReversalProps {
+    /** Default: false.
+     * @see [[WhiteOnWhiteReversalSettings.ignoreBackgroundColor]].
+     */
+    ignoreBackgroundColor?: boolean;
+}
+/** As part of a [[DisplayStyleSettings]], controls how white-on-white reversal is applied to make white geometry more
+ * visible in the view.
+ * By default, pure white geometry is displayed as black instead if the [[DisplayStyleSettings.backgroundColor]] is also pure white.
+ * These settings are only applied if the display style's [[ViewFlags.whiteOnWhiteReversal]] flag is enabled.
+ * @see [[DisplayStyleSettings.whiteOnWhiteReversal]] to change these settings for a display style.
+ * @public
+ */
+export declare class WhiteOnWhiteReversalSettings {
+    /** If true, white-on-white reversal ignores the display style's background color; otherwise, white-on-white reversal applies only
+     * if the background color is pure white.
+     * @see [[DisplayStyleSettings.backgroundColor]] to change the background color.
+     */
+    readonly ignoreBackgroundColor: boolean;
+    private constructor();
+    private static _noIgnore;
+    private static _ignore;
+    /** Create from JSON representation. */
+    static fromJSON(props?: WhiteOnWhiteReversalProps): WhiteOnWhiteReversalSettings;
+    /** Convert to JSON representation. The JSON representation is `undefined` if these settings match the defaults. */
+    toJSON(): WhiteOnWhiteReversalProps | undefined;
+    /** Returns true if `this` is equivalent to `other`. */
+    equals(other: WhiteOnWhiteReversalSettings): boolean;
+}
 //# sourceMappingURL=WhiteOnWhiteReversalSettings.d.ts.map

package/lib/cjs/WhiteOnWhiteReversalSettings.js

@@ -1,38 +1,38 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module DisplayStyles
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WhiteOnWhiteReversalSettings = void 0;
-/** As part of a [[DisplayStyleSettings]], controls how white-on-white reversal is applied to make white geometry more
- * visible in the view.
- * By default, pure white geometry is displayed as black instead if the [[DisplayStyleSettings.backgroundColor]] is also pure white.
- * These settings are only applied if the display style's [[ViewFlags.whiteOnWhiteReversal]] flag is enabled.
- * @see [[DisplayStyleSettings.whiteOnWhiteReversal]] to change these settings for a display style.
- * @public
- */
-class WhiteOnWhiteReversalSettings {
-    constructor(ignoreBackground) {
-        this.ignoreBackgroundColor = ignoreBackground;
-    }
-    /** Create from JSON representation. */
-    static fromJSON(props) {
-        return (props === null || props === void 0 ? void 0 : props.ignoreBackgroundColor) ? this._noIgnore : this._ignore;
-    }
-    /** Convert to JSON representation. The JSON representation is `undefined` if these settings match the defaults. */
-    toJSON() {
-        return this.ignoreBackgroundColor ? { ignoreBackgroundColor: true } : undefined;
-    }
-    /** Returns true if `this` is equivalent to `other`. */
-    equals(other) {
-        return this === other;
-    }
-}
-exports.WhiteOnWhiteReversalSettings = WhiteOnWhiteReversalSettings;
-WhiteOnWhiteReversalSettings._noIgnore = new WhiteOnWhiteReversalSettings(true);
-WhiteOnWhiteReversalSettings._ignore = new WhiteOnWhiteReversalSettings(false);
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhiteOnWhiteReversalSettings = void 0;
+/** As part of a [[DisplayStyleSettings]], controls how white-on-white reversal is applied to make white geometry more
+ * visible in the view.
+ * By default, pure white geometry is displayed as black instead if the [[DisplayStyleSettings.backgroundColor]] is also pure white.
+ * These settings are only applied if the display style's [[ViewFlags.whiteOnWhiteReversal]] flag is enabled.
+ * @see [[DisplayStyleSettings.whiteOnWhiteReversal]] to change these settings for a display style.
+ * @public
+ */
+class WhiteOnWhiteReversalSettings {
+    constructor(ignoreBackground) {
+        this.ignoreBackgroundColor = ignoreBackground;
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        return props?.ignoreBackgroundColor ? this._noIgnore : this._ignore;
+    }
+    /** Convert to JSON representation. The JSON representation is `undefined` if these settings match the defaults. */
+    toJSON() {
+        return this.ignoreBackgroundColor ? { ignoreBackgroundColor: true } : undefined;
+    }
+    /** Returns true if `this` is equivalent to `other`. */
+    equals(other) {
+        return this === other;
+    }
+}
+WhiteOnWhiteReversalSettings._noIgnore = new WhiteOnWhiteReversalSettings(true);
+WhiteOnWhiteReversalSettings._ignore = new WhiteOnWhiteReversalSettings(false);
+exports.WhiteOnWhiteReversalSettings = WhiteOnWhiteReversalSettings;
 //# sourceMappingURL=WhiteOnWhiteReversalSettings.js.map

package/lib/cjs/WhiteOnWhiteReversalSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"WhiteOnWhiteReversalSettings.js","sourceRoot":"","sources":["../../src/WhiteOnWhiteReversalSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAaH;;;;;;GAMG;AACH,MAAa,4BAA4B;IAOvC,YAAoB,gBAAyB;QAC3C,IAAI,CAAC,qBAAqB,GAAG,gBAAgB,CAAC;IAChD,CAAC;IAKD,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,OAAO,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,qBAAqB,EAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACtE,CAAC;IAED,mHAAmH;IAC5G,MAAM;QACX,OAAO,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAClF,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,KAAmC;QAC/C,OAAO,IAAI,KAAK,KAAK,CAAC;IACxB,CAAC;;AA3BH,oEA4BC;AAjBgB,sCAAS,GAAG,IAAI,4BAA4B,CAAC,IAAI,CAAC,CAAC;AACnD,oCAAO,GAAG,IAAI,4BAA4B,CAAC,KAAK,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 DisplayStyles\r\n */\r\n\r\n/** JSON representation of a [[WhiteOnWhiteReversalSettings]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface WhiteOnWhiteReversalProps {\r\n  /** Default: false.\r\n   * @see [[WhiteOnWhiteReversalSettings.ignoreBackgroundColor]].\r\n   */\r\n  ignoreBackgroundColor?: boolean;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], controls how white-on-white reversal is applied to make white geometry more\r\n * visible in the view.\r\n * By default, pure white geometry is displayed as black instead if the [[DisplayStyleSettings.backgroundColor]] is also pure white.\r\n * These settings are only applied if the display style's [[ViewFlags.whiteOnWhiteReversal]] flag is enabled.\r\n * @see [[DisplayStyleSettings.whiteOnWhiteReversal]] to change these settings for a display style.\r\n * @public\r\n */\r\nexport class WhiteOnWhiteReversalSettings {\r\n  /** If true, white-on-white reversal ignores the display style's background color; otherwise, white-on-white reversal applies only\r\n   * if the background color is pure white.\r\n   * @see [[DisplayStyleSettings.backgroundColor]] to change the background color.\r\n   */\r\n  public readonly ignoreBackgroundColor: boolean;\r\n\r\n  private constructor(ignoreBackground: boolean) {\r\n    this.ignoreBackgroundColor = ignoreBackground;\r\n  }\r\n\r\n  private static _noIgnore = new WhiteOnWhiteReversalSettings(true);\r\n  private static _ignore = new WhiteOnWhiteReversalSettings(false);\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: WhiteOnWhiteReversalProps): WhiteOnWhiteReversalSettings {\r\n    return props?.ignoreBackgroundColor ? this._noIgnore : this._ignore;\r\n  }\r\n\r\n  /** Convert to JSON representation. The JSON representation is `undefined` if these settings match the defaults. */\r\n  public toJSON(): WhiteOnWhiteReversalProps | undefined {\r\n    return this.ignoreBackgroundColor ? { ignoreBackgroundColor: true } : undefined;\r\n  }\r\n\r\n  /** Returns true if `this` is equivalent to `other`. */\r\n  public equals(other: WhiteOnWhiteReversalSettings): boolean {\r\n    return this === other;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"WhiteOnWhiteReversalSettings.js","sourceRoot":"","sources":["../../src/WhiteOnWhiteReversalSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAaH;;;;;;GAMG;AACH,MAAa,4BAA4B;IAOvC,YAAoB,gBAAyB;QAC3C,IAAI,CAAC,qBAAqB,GAAG,gBAAgB,CAAC;IAChD,CAAC;IAKD,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,OAAO,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACtE,CAAC;IAED,mHAAmH;IAC5G,MAAM;QACX,OAAO,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAClF,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,KAAmC;QAC/C,OAAO,IAAI,KAAK,KAAK,CAAC;IACxB,CAAC;;AAhBc,sCAAS,GAAG,IAAI,4BAA4B,CAAC,IAAI,CAAC,CAAC;AACnD,oCAAO,GAAG,IAAI,4BAA4B,CAAC,KAAK,CAAC,CAAC;AAZtD,oEAA4B","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/** JSON representation of a [[WhiteOnWhiteReversalSettings]].\n * @public\n * @extensions\n */\nexport interface WhiteOnWhiteReversalProps {\n  /** Default: false.\n   * @see [[WhiteOnWhiteReversalSettings.ignoreBackgroundColor]].\n   */\n  ignoreBackgroundColor?: boolean;\n}\n\n/** As part of a [[DisplayStyleSettings]], controls how white-on-white reversal is applied to make white geometry more\n * visible in the view.\n * By default, pure white geometry is displayed as black instead if the [[DisplayStyleSettings.backgroundColor]] is also pure white.\n * These settings are only applied if the display style's [[ViewFlags.whiteOnWhiteReversal]] flag is enabled.\n * @see [[DisplayStyleSettings.whiteOnWhiteReversal]] to change these settings for a display style.\n * @public\n */\nexport class WhiteOnWhiteReversalSettings {\n  /** If true, white-on-white reversal ignores the display style's background color; otherwise, white-on-white reversal applies only\n   * if the background color is pure white.\n   * @see [[DisplayStyleSettings.backgroundColor]] to change the background color.\n   */\n  public readonly ignoreBackgroundColor: boolean;\n\n  private constructor(ignoreBackground: boolean) {\n    this.ignoreBackgroundColor = ignoreBackground;\n  }\n\n  private static _noIgnore = new WhiteOnWhiteReversalSettings(true);\n  private static _ignore = new WhiteOnWhiteReversalSettings(false);\n\n  /** Create from JSON representation. */\n  public static fromJSON(props?: WhiteOnWhiteReversalProps): WhiteOnWhiteReversalSettings {\n    return props?.ignoreBackgroundColor ? this._noIgnore : this._ignore;\n  }\n\n  /** Convert to JSON representation. The JSON representation is `undefined` if these settings match the defaults. */\n  public toJSON(): WhiteOnWhiteReversalProps | undefined {\n    return this.ignoreBackgroundColor ? { ignoreBackgroundColor: true } : undefined;\n  }\n\n  /** Returns true if `this` is equivalent to `other`. */\n  public equals(other: WhiteOnWhiteReversalSettings): boolean {\n    return this === other;\n  }\n}\n"]}