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

package/lib/cjs/RealityModelDisplaySettings.d.ts

@@ -1,119 +1,119 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-/** Specifies how the sizes of the individual points within a point cloud are computed.
- *  - "pixel": Each point is an exact number of pixels in diameter, as specified by [[PointCloudDisplaySettings.pixelSize]].
- *  - "voxel": Each point is the size of a "voxel" in meters, as specified by the [Tile]($frontend) to which the point belongs.
- * @see [[PointCloudDisplaySettings.sizeMode]].
- * @beta
- */
-export declare type PointCloudSizeMode = "voxel" | "pixel";
-/** Specifies the shape drawn for each individual point within a point cloud.
- *  - "round": Each point is drawn as a circle.
- *  - "square": Each point is drawn as a square.
- * @see [[PointCloudDisplaySettings.shape]].
- * @beta
- */
-export declare type PointCloudShape = "square" | "round";
-/** The JSON representation of [[PointCloudDisplaySettings]].
- * @beta
- */
-export interface PointCloudDisplayProps {
-    /** See [[PointCloudDisplaySettings.sizeMode]]. */
-    sizeMode?: PointCloudSizeMode;
-    /** See [[PointCloudDisplaySettings.voxelScale]]. */
-    voxelScale?: number;
-    /** See [[PointCloudDisplaySettings.minPixelsPerVoxel]]. */
-    minPixelsPerVoxel?: number;
-    /** See [[PointCloudDisplaySettings.maxPixelsPerVoxel]]. */
-    maxPixelsPerVoxel?: number;
-    /** See [[PointCloudDisplaySettings.pixelSize]]. */
-    pixelSize?: number;
-    /** See [[PointCloudDisplaySettings.shape]]. */
-    shape?: PointCloudShape;
-}
-/** The JSON representation of [[RealityModelDisplaySettings]].
- * @beta
- */
-export interface RealityModelDisplayProps {
-    /** See [[RealityModelDisplaySettings.pointCloud]]. */
-    pointCloud?: PointCloudDisplayProps;
-    /** See [[RealityModelDisplaySettings.overrideColorRatio]]. */
-    overrideColorRatio?: number;
-}
-/** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).
- * @note This is an immutable type - to modify its properties, use [[clone]].
- * @see [[RealityModelDisplaySettings.pointCloud]].
- * @beta
- */
-export declare class PointCloudDisplaySettings {
-    /** The shape drawn for each point in the cloud.
-     * Default: "round".
-     */
-    readonly shape: PointCloudShape;
-    /** The method by which the size of each individual point is computed.
-     * Default: "voxel".
-     * @see [[pixelSize]] to configure the size for "pixel" mode.
-     * @see [[voxelScale]], [[minPixelsPerVoxel]], and [[maxPixelsPerVoxel]] to configure the size for "voxel" mode.
-     */
-    readonly sizeMode: PointCloudSizeMode;
-    /** The radius of each point in pixels, when [[sizeMode]] is "pixel".
-     * The size is expected to be a positive integer. The maximum size will vary based on the graphics hardware in use, but typically is limited to 32 or 64 pixels.
-     * Default: 1
-     */
-    readonly pixelSize: number;
-    /** A scale factor applied to the size of each point, when [[sizeMode]] is "voxel".
-     * The scale is expected to be a positive floating point number.
-     * Default: 1.0
-     */
-    readonly voxelScale: number;
-    /** If [[sizeMode]] is "voxel", the minimum radius of each point in pixels. It is expected to be a positive integer no greater than [[maxPixelsPerVoxel]].
-     * Default: 2
-     */
-    readonly minPixelsPerVoxel: number;
-    /** If [[sizeMode]] is "voxel", the maximum radius of each point in pixels. It is expected to be a positive integer no less than [[minPixelsPerVoxel]].
-     * Default: 20.
-     */
-    readonly maxPixelsPerVoxel: number;
-    /** Settings with all properties initialized to their default values. */
-    static defaults: PointCloudDisplaySettings;
-    private constructor();
-    /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */
-    static fromJSON(props?: PointCloudDisplayProps): PointCloudDisplaySettings;
-    /** Convert these settings to their JSON representation. */
-    toJSON(): PointCloudDisplayProps | undefined;
-    /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */
-    clone(changedProps: PointCloudDisplayProps): PointCloudDisplaySettings;
-    /** Returns true if these settings are identical to `other`. */
-    equals(other: PointCloudDisplaySettings): boolean;
-}
-/** Settings that control how a reality model - whether a [[ContextRealityModel]] or a persistent reality [Model]($backend) - is displayed within a [Viewport]($frontend).
- * @see [[ContextRealityModel.displaySettings]] to apply these settings to a context reality model.
- * @see [[DisplayStyleSettings.setRealityModelDisplaySettings]] to apply these settings to a persistent reality model.
- * @note This is an immutable type - to modify its properties, use [[clone]].
- * @beta
- */
-export declare class RealityModelDisplaySettings {
-    /** If the reality model's color is overridden with another color, a ratio in [0..1] with which to mix the two colors together.
-     * A ratio of 0 uses only the reality model's color, a ratio of 1 uses only the override color, and a ratio of 0.5 mixes the two colors equally.
-     * The color may be overridden using [[FeatureOverrides]] such as those supplied by a [FeatureOverrideProvider]($frontend), or by applying a [[SpatialClassifier]].
-     * Default: 0.5
-     */
-    readonly overrideColorRatio: number;
-    /** Settings that apply specifically to point cloud reality models.
-     * Default: [[PointCloudDisplaySettings.defaults]].
-     */
-    readonly pointCloud: PointCloudDisplaySettings;
-    /** Settings with all properties initialized to their default values. */
-    static defaults: RealityModelDisplaySettings;
-    private constructor();
-    /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */
-    static fromJSON(props?: RealityModelDisplayProps): RealityModelDisplaySettings;
-    /** Convert these settings to their JSON representation, which is `undefined` if all of their properties match the default settings. */
-    toJSON(): RealityModelDisplayProps | undefined;
-    /** Returns true if these settings are identical to `other`. */
-    equals(other: RealityModelDisplaySettings): boolean;
-    /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */
-    clone(changedProps: RealityModelDisplayProps): RealityModelDisplaySettings;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+/** Specifies how the sizes of the individual points within a point cloud are computed.
+ *  - "pixel": Each point is an exact number of pixels in diameter, as specified by [[PointCloudDisplaySettings.pixelSize]].
+ *  - "voxel": Each point is the size of a "voxel" in meters, as specified by the [Tile]($frontend) to which the point belongs.
+ * @see [[PointCloudDisplaySettings.sizeMode]].
+ * @beta
+ */
+export declare type PointCloudSizeMode = "voxel" | "pixel";
+/** Specifies the shape drawn for each individual point within a point cloud.
+ *  - "round": Each point is drawn as a circle.
+ *  - "square": Each point is drawn as a square.
+ * @see [[PointCloudDisplaySettings.shape]].
+ * @beta
+ */
+export declare type PointCloudShape = "square" | "round";
+/** The JSON representation of [[PointCloudDisplaySettings]].
+ * @beta
+ */
+export interface PointCloudDisplayProps {
+    /** See [[PointCloudDisplaySettings.sizeMode]]. */
+    sizeMode?: PointCloudSizeMode;
+    /** See [[PointCloudDisplaySettings.voxelScale]]. */
+    voxelScale?: number;
+    /** See [[PointCloudDisplaySettings.minPixelsPerVoxel]]. */
+    minPixelsPerVoxel?: number;
+    /** See [[PointCloudDisplaySettings.maxPixelsPerVoxel]]. */
+    maxPixelsPerVoxel?: number;
+    /** See [[PointCloudDisplaySettings.pixelSize]]. */
+    pixelSize?: number;
+    /** See [[PointCloudDisplaySettings.shape]]. */
+    shape?: PointCloudShape;
+}
+/** The JSON representation of [[RealityModelDisplaySettings]].
+ * @beta
+ */
+export interface RealityModelDisplayProps {
+    /** See [[RealityModelDisplaySettings.pointCloud]]. */
+    pointCloud?: PointCloudDisplayProps;
+    /** See [[RealityModelDisplaySettings.overrideColorRatio]]. */
+    overrideColorRatio?: number;
+}
+/** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).
+ * @note This is an immutable type - to modify its properties, use [[clone]].
+ * @see [[RealityModelDisplaySettings.pointCloud]].
+ * @beta
+ */
+export declare class PointCloudDisplaySettings {
+    /** The shape drawn for each point in the cloud.
+     * Default: "round".
+     */
+    readonly shape: PointCloudShape;
+    /** The method by which the size of each individual point is computed.
+     * Default: "voxel".
+     * @see [[pixelSize]] to configure the size for "pixel" mode.
+     * @see [[voxelScale]], [[minPixelsPerVoxel]], and [[maxPixelsPerVoxel]] to configure the size for "voxel" mode.
+     */
+    readonly sizeMode: PointCloudSizeMode;
+    /** The radius of each point in pixels, when [[sizeMode]] is "pixel".
+     * The size is expected to be a positive integer. The maximum size will vary based on the graphics hardware in use, but typically is limited to 32 or 64 pixels.
+     * Default: 1
+     */
+    readonly pixelSize: number;
+    /** A scale factor applied to the size of each point, when [[sizeMode]] is "voxel".
+     * The scale is expected to be a positive floating point number.
+     * Default: 1.0
+     */
+    readonly voxelScale: number;
+    /** If [[sizeMode]] is "voxel", the minimum radius of each point in pixels. It is expected to be a positive integer no greater than [[maxPixelsPerVoxel]].
+     * Default: 2
+     */
+    readonly minPixelsPerVoxel: number;
+    /** If [[sizeMode]] is "voxel", the maximum radius of each point in pixels. It is expected to be a positive integer no less than [[minPixelsPerVoxel]].
+     * Default: 20.
+     */
+    readonly maxPixelsPerVoxel: number;
+    /** Settings with all properties initialized to their default values. */
+    static defaults: PointCloudDisplaySettings;
+    private constructor();
+    /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */
+    static fromJSON(props?: PointCloudDisplayProps): PointCloudDisplaySettings;
+    /** Convert these settings to their JSON representation. */
+    toJSON(): PointCloudDisplayProps | undefined;
+    /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */
+    clone(changedProps: PointCloudDisplayProps): PointCloudDisplaySettings;
+    /** Returns true if these settings are identical to `other`. */
+    equals(other: PointCloudDisplaySettings): boolean;
+}
+/** Settings that control how a reality model - whether a [[ContextRealityModel]] or a persistent reality [Model]($backend) - is displayed within a [Viewport]($frontend).
+ * @see [[ContextRealityModel.displaySettings]] to apply these settings to a context reality model.
+ * @see [[DisplayStyleSettings.setRealityModelDisplaySettings]] to apply these settings to a persistent reality model.
+ * @note This is an immutable type - to modify its properties, use [[clone]].
+ * @beta
+ */
+export declare class RealityModelDisplaySettings {
+    /** If the reality model's color is overridden with another color, a ratio in [0..1] with which to mix the two colors together.
+     * A ratio of 0 uses only the reality model's color, a ratio of 1 uses only the override color, and a ratio of 0.5 mixes the two colors equally.
+     * The color may be overridden using [[FeatureOverrides]] such as those supplied by a [FeatureOverrideProvider]($frontend), or by applying a [[SpatialClassifier]].
+     * Default: 0.5
+     */
+    readonly overrideColorRatio: number;
+    /** Settings that apply specifically to point cloud reality models.
+     * Default: [[PointCloudDisplaySettings.defaults]].
+     */
+    readonly pointCloud: PointCloudDisplaySettings;
+    /** Settings with all properties initialized to their default values. */
+    static defaults: RealityModelDisplaySettings;
+    private constructor();
+    /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */
+    static fromJSON(props?: RealityModelDisplayProps): RealityModelDisplaySettings;
+    /** Convert these settings to their JSON representation, which is `undefined` if all of their properties match the default settings. */
+    toJSON(): RealityModelDisplayProps | undefined;
+    /** Returns true if these settings are identical to `other`. */
+    equals(other: RealityModelDisplaySettings): boolean;
+    /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */
+    clone(changedProps: RealityModelDisplayProps): RealityModelDisplaySettings;
+}
 //# sourceMappingURL=RealityModelDisplaySettings.d.ts.map

package/lib/cjs/RealityModelDisplaySettings.js

@@ -1,115 +1,115 @@
-"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.RealityModelDisplaySettings = exports.PointCloudDisplaySettings = void 0;
-/** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).
- * @note This is an immutable type - to modify its properties, use [[clone]].
- * @see [[RealityModelDisplaySettings.pointCloud]].
- * @beta
- */
-class PointCloudDisplaySettings {
-    constructor(props) {
-        var _a, _b, _c, _d, _e, _f;
-        this.shape = (_a = props === null || props === void 0 ? void 0 : props.shape) !== null && _a !== void 0 ? _a : "round";
-        this.sizeMode = (_b = props === null || props === void 0 ? void 0 : props.sizeMode) !== null && _b !== void 0 ? _b : "voxel";
-        // No sanity checks here - e.g., min < max, pixelSize and voxelScale > 0, etc.
-        this.pixelSize = (_c = props === null || props === void 0 ? void 0 : props.pixelSize) !== null && _c !== void 0 ? _c : 1;
-        this.voxelScale = (_d = props === null || props === void 0 ? void 0 : props.voxelScale) !== null && _d !== void 0 ? _d : 1;
-        this.minPixelsPerVoxel = (_e = props === null || props === void 0 ? void 0 : props.minPixelsPerVoxel) !== null && _e !== void 0 ? _e : 2;
-        this.maxPixelsPerVoxel = (_f = props === null || props === void 0 ? void 0 : props.maxPixelsPerVoxel) !== null && _f !== void 0 ? _f : 20;
-    }
-    /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */
-    static fromJSON(props) {
-        return props ? new PointCloudDisplaySettings(props) : this.defaults;
-    }
-    /** Convert these settings to their JSON representation. */
-    toJSON() {
-        const defs = PointCloudDisplaySettings.defaults;
-        if (this.equals(defs))
-            return undefined;
-        const props = {};
-        if (this.shape !== defs.shape)
-            props.shape = this.shape;
-        if (this.sizeMode !== defs.sizeMode)
-            props.sizeMode = this.sizeMode;
-        if (this.pixelSize !== defs.pixelSize)
-            props.pixelSize = this.pixelSize;
-        if (this.voxelScale !== defs.voxelScale)
-            props.voxelScale = this.voxelScale;
-        if (this.minPixelsPerVoxel !== defs.minPixelsPerVoxel)
-            props.minPixelsPerVoxel = this.minPixelsPerVoxel;
-        if (this.maxPixelsPerVoxel !== defs.maxPixelsPerVoxel)
-            props.maxPixelsPerVoxel = this.maxPixelsPerVoxel;
-        return props;
-    }
-    /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */
-    clone(changedProps) {
-        return PointCloudDisplaySettings.fromJSON({
-            ...this.toJSON(),
-            ...changedProps,
-        });
-    }
-    /** Returns true if these settings are identical to `other`. */
-    equals(other) {
-        if (this === other)
-            return true;
-        return this.shape === other.shape && this.sizeMode === other.sizeMode && this.pixelSize === other.pixelSize
-            && this.voxelScale === other.voxelScale && this.minPixelsPerVoxel === other.minPixelsPerVoxel && this.maxPixelsPerVoxel === other.maxPixelsPerVoxel;
-    }
-}
-exports.PointCloudDisplaySettings = PointCloudDisplaySettings;
-/** Settings with all properties initialized to their default values. */
-PointCloudDisplaySettings.defaults = new PointCloudDisplaySettings();
-/** Settings that control how a reality model - whether a [[ContextRealityModel]] or a persistent reality [Model]($backend) - is displayed within a [Viewport]($frontend).
- * @see [[ContextRealityModel.displaySettings]] to apply these settings to a context reality model.
- * @see [[DisplayStyleSettings.setRealityModelDisplaySettings]] to apply these settings to a persistent reality model.
- * @note This is an immutable type - to modify its properties, use [[clone]].
- * @beta
- */
-class RealityModelDisplaySettings {
-    constructor(overrideColorRatio, pointCloud) {
-        this.overrideColorRatio = overrideColorRatio !== null && overrideColorRatio !== void 0 ? overrideColorRatio : 0.5;
-        this.pointCloud = pointCloud;
-    }
-    /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */
-    static fromJSON(props) {
-        if (!props)
-            return this.defaults;
-        return new RealityModelDisplaySettings(props.overrideColorRatio, PointCloudDisplaySettings.fromJSON(props.pointCloud));
-    }
-    /** Convert these settings to their JSON representation, which is `undefined` if all of their properties match the default settings. */
-    toJSON() {
-        const pointCloud = this.pointCloud.toJSON();
-        const overrideColorRatio = this.overrideColorRatio === RealityModelDisplaySettings.defaults.overrideColorRatio ? undefined : this.overrideColorRatio;
-        if (undefined === pointCloud && undefined === overrideColorRatio)
-            return undefined;
-        const props = {};
-        if (undefined !== pointCloud)
-            props.pointCloud = pointCloud;
-        if (undefined !== overrideColorRatio)
-            props.overrideColorRatio = overrideColorRatio;
-        return props;
-    }
-    /** Returns true if these settings are identical to `other`. */
-    equals(other) {
-        if (this === other)
-            return true;
-        return this.overrideColorRatio === other.overrideColorRatio && this.pointCloud.equals(other.pointCloud);
-    }
-    /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */
-    clone(changedProps) {
-        const pointCloud = changedProps.pointCloud ? this.pointCloud.clone(changedProps.pointCloud) : this.pointCloud;
-        const colorRatio = changedProps.hasOwnProperty("overrideColorRatio") ? changedProps.overrideColorRatio : this.overrideColorRatio;
-        return new RealityModelDisplaySettings(colorRatio, pointCloud);
-    }
-}
-exports.RealityModelDisplaySettings = RealityModelDisplaySettings;
-/** Settings with all properties initialized to their default values. */
-RealityModelDisplaySettings.defaults = new RealityModelDisplaySettings(undefined, PointCloudDisplaySettings.defaults);
+"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.RealityModelDisplaySettings = exports.PointCloudDisplaySettings = void 0;
+/** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).
+ * @note This is an immutable type - to modify its properties, use [[clone]].
+ * @see [[RealityModelDisplaySettings.pointCloud]].
+ * @beta
+ */
+class PointCloudDisplaySettings {
+    constructor(props) {
+        var _a, _b, _c, _d, _e, _f;
+        this.shape = (_a = props === null || props === void 0 ? void 0 : props.shape) !== null && _a !== void 0 ? _a : "round";
+        this.sizeMode = (_b = props === null || props === void 0 ? void 0 : props.sizeMode) !== null && _b !== void 0 ? _b : "voxel";
+        // No sanity checks here - e.g., min < max, pixelSize and voxelScale > 0, etc.
+        this.pixelSize = (_c = props === null || props === void 0 ? void 0 : props.pixelSize) !== null && _c !== void 0 ? _c : 1;
+        this.voxelScale = (_d = props === null || props === void 0 ? void 0 : props.voxelScale) !== null && _d !== void 0 ? _d : 1;
+        this.minPixelsPerVoxel = (_e = props === null || props === void 0 ? void 0 : props.minPixelsPerVoxel) !== null && _e !== void 0 ? _e : 2;
+        this.maxPixelsPerVoxel = (_f = props === null || props === void 0 ? void 0 : props.maxPixelsPerVoxel) !== null && _f !== void 0 ? _f : 20;
+    }
+    /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */
+    static fromJSON(props) {
+        return props ? new PointCloudDisplaySettings(props) : this.defaults;
+    }
+    /** Convert these settings to their JSON representation. */
+    toJSON() {
+        const defs = PointCloudDisplaySettings.defaults;
+        if (this.equals(defs))
+            return undefined;
+        const props = {};
+        if (this.shape !== defs.shape)
+            props.shape = this.shape;
+        if (this.sizeMode !== defs.sizeMode)
+            props.sizeMode = this.sizeMode;
+        if (this.pixelSize !== defs.pixelSize)
+            props.pixelSize = this.pixelSize;
+        if (this.voxelScale !== defs.voxelScale)
+            props.voxelScale = this.voxelScale;
+        if (this.minPixelsPerVoxel !== defs.minPixelsPerVoxel)
+            props.minPixelsPerVoxel = this.minPixelsPerVoxel;
+        if (this.maxPixelsPerVoxel !== defs.maxPixelsPerVoxel)
+            props.maxPixelsPerVoxel = this.maxPixelsPerVoxel;
+        return props;
+    }
+    /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */
+    clone(changedProps) {
+        return PointCloudDisplaySettings.fromJSON({
+            ...this.toJSON(),
+            ...changedProps,
+        });
+    }
+    /** Returns true if these settings are identical to `other`. */
+    equals(other) {
+        if (this === other)
+            return true;
+        return this.shape === other.shape && this.sizeMode === other.sizeMode && this.pixelSize === other.pixelSize
+            && this.voxelScale === other.voxelScale && this.minPixelsPerVoxel === other.minPixelsPerVoxel && this.maxPixelsPerVoxel === other.maxPixelsPerVoxel;
+    }
+}
+exports.PointCloudDisplaySettings = PointCloudDisplaySettings;
+/** Settings with all properties initialized to their default values. */
+PointCloudDisplaySettings.defaults = new PointCloudDisplaySettings();
+/** Settings that control how a reality model - whether a [[ContextRealityModel]] or a persistent reality [Model]($backend) - is displayed within a [Viewport]($frontend).
+ * @see [[ContextRealityModel.displaySettings]] to apply these settings to a context reality model.
+ * @see [[DisplayStyleSettings.setRealityModelDisplaySettings]] to apply these settings to a persistent reality model.
+ * @note This is an immutable type - to modify its properties, use [[clone]].
+ * @beta
+ */
+class RealityModelDisplaySettings {
+    constructor(overrideColorRatio, pointCloud) {
+        this.overrideColorRatio = overrideColorRatio !== null && overrideColorRatio !== void 0 ? overrideColorRatio : 0.5;
+        this.pointCloud = pointCloud;
+    }
+    /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */
+    static fromJSON(props) {
+        if (!props)
+            return this.defaults;
+        return new RealityModelDisplaySettings(props.overrideColorRatio, PointCloudDisplaySettings.fromJSON(props.pointCloud));
+    }
+    /** Convert these settings to their JSON representation, which is `undefined` if all of their properties match the default settings. */
+    toJSON() {
+        const pointCloud = this.pointCloud.toJSON();
+        const overrideColorRatio = this.overrideColorRatio === RealityModelDisplaySettings.defaults.overrideColorRatio ? undefined : this.overrideColorRatio;
+        if (undefined === pointCloud && undefined === overrideColorRatio)
+            return undefined;
+        const props = {};
+        if (undefined !== pointCloud)
+            props.pointCloud = pointCloud;
+        if (undefined !== overrideColorRatio)
+            props.overrideColorRatio = overrideColorRatio;
+        return props;
+    }
+    /** Returns true if these settings are identical to `other`. */
+    equals(other) {
+        if (this === other)
+            return true;
+        return this.overrideColorRatio === other.overrideColorRatio && this.pointCloud.equals(other.pointCloud);
+    }
+    /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */
+    clone(changedProps) {
+        const pointCloud = changedProps.pointCloud ? this.pointCloud.clone(changedProps.pointCloud) : this.pointCloud;
+        const colorRatio = changedProps.hasOwnProperty("overrideColorRatio") ? changedProps.overrideColorRatio : this.overrideColorRatio;
+        return new RealityModelDisplaySettings(colorRatio, pointCloud);
+    }
+}
+exports.RealityModelDisplaySettings = RealityModelDisplaySettings;
+/** Settings with all properties initialized to their default values. */
+RealityModelDisplaySettings.defaults = new RealityModelDisplaySettings(undefined, PointCloudDisplaySettings.defaults);
 //# sourceMappingURL=RealityModelDisplaySettings.js.map

package/lib/cjs/RealityModelDisplaySettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"RealityModelDisplaySettings.js","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA+CH;;;;GAIG;AACH,MAAa,yBAAyB;IAiCpC,YAAoB,KAA8B;;QAChD,IAAI,CAAC,KAAK,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,mCAAI,OAAO,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,mCAAI,OAAO,CAAC;QAE3C,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,mCAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,CAAC,CAAC;QACzC,IAAI,CAAC,iBAAiB,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,mCAAI,CAAC,CAAC;QACvD,IAAI,CAAC,iBAAiB,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,mCAAI,EAAE,CAAC;IAC1D,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACtE,CAAC;IAED,2DAA2D;IACpD,MAAM;QACX,MAAM,IAAI,GAAG,yBAAyB,CAAC,QAAQ,CAAC;QAChD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACnB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAA2B,EAAG,CAAC;QAC1C,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK;YAC3B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACnC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACnD,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACnD,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mHAAmH;IAC5G,KAAK,CAAC,YAAoC;QAC/C,OAAO,yBAAyB,CAAC,QAAQ,CAAC;YACxC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,+DAA+D;IACxD,MAAM,CAAC,KAAgC;QAC5C,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eACtG,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,CAAC;IACxJ,CAAC;;AA5FH,8DA6FC;AA/DC,wEAAwE;AAC1D,kCAAQ,GAAG,IAAI,yBAAyB,EAAE,CAAC;AAgE3D;;;;;GAKG;AACH,MAAa,2BAA2B;IAetC,YAAoB,kBAAsC,EAAE,UAAqC;QAC/F,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,GAAG,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,QAAQ,CAAC,KAAgC;QACrD,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,2BAA2B,CAAC,KAAK,CAAC,kBAAkB,EAAE,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACzH,CAAC;IAED,uIAAuI;IAChI,MAAM;QACX,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC5C,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,KAAK,2BAA2B,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAErJ,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,KAAK,kBAAkB;YAC9D,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAA6B,EAAG,CAAC;QAC5C,IAAI,SAAS,KAAK,UAAU;YAC1B,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;QAEhC,IAAI,SAAS,KAAK,kBAAkB;YAClC,KAAK,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAEhD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+DAA+D;IACxD,MAAM,CAAC,KAAkC;QAC9C,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,kBAAkB,KAAK,KAAK,CAAC,kBAAkB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC1G,CAAC;IAED,mHAAmH;IAC5G,KAAK,CAAC,YAAsC;QACjD,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QAC9G,MAAM,UAAU,GAAG,YAAY,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACjI,OAAO,IAAI,2BAA2B,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;;AA3DH,kEA4DC;AAhDC,wEAAwE;AAC1D,oCAAQ,GAAG,IAAI,2BAA2B,CAAC,SAAS,EAAE,yBAAyB,CAAC,QAAQ,CAAC,CAAC","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/** Specifies how the sizes of the individual points within a point cloud are computed.\n *  - \"pixel\": Each point is an exact number of pixels in diameter, as specified by [[PointCloudDisplaySettings.pixelSize]].\n *  - \"voxel\": Each point is the size of a \"voxel\" in meters, as specified by the [Tile]($frontend) to which the point belongs.\n * @see [[PointCloudDisplaySettings.sizeMode]].\n * @beta\n */\nexport type PointCloudSizeMode = \"voxel\" | \"pixel\";\n\n/** Specifies the shape drawn for each individual point within a point cloud.\n *  - \"round\": Each point is drawn as a circle.\n *  - \"square\": Each point is drawn as a square.\n * @see [[PointCloudDisplaySettings.shape]].\n * @beta\n */\nexport type PointCloudShape = \"square\" | \"round\";\n\n/** The JSON representation of [[PointCloudDisplaySettings]].\n * @beta\n */\nexport interface PointCloudDisplayProps {\n  /** See [[PointCloudDisplaySettings.sizeMode]]. */\n  sizeMode?: PointCloudSizeMode;\n  /** See [[PointCloudDisplaySettings.voxelScale]]. */\n  voxelScale?: number;\n  /** See [[PointCloudDisplaySettings.minPixelsPerVoxel]]. */\n  minPixelsPerVoxel?: number;\n  /** See [[PointCloudDisplaySettings.maxPixelsPerVoxel]]. */\n  maxPixelsPerVoxel?: number;\n  /** See [[PointCloudDisplaySettings.pixelSize]]. */\n  pixelSize?: number;\n  /** See [[PointCloudDisplaySettings.shape]]. */\n  shape?: PointCloudShape;\n}\n\n/** The JSON representation of [[RealityModelDisplaySettings]].\n * @beta\n */\nexport interface RealityModelDisplayProps {\n  /** See [[RealityModelDisplaySettings.pointCloud]]. */\n  pointCloud?: PointCloudDisplayProps;\n  /** See [[RealityModelDisplaySettings.overrideColorRatio]]. */\n  overrideColorRatio?: number;\n  // ###TODO when we need it: mesh?: RealityMeshDisplayProps;\n}\n\n/** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).\n * @note This is an immutable type - to modify its properties, use [[clone]].\n * @see [[RealityModelDisplaySettings.pointCloud]].\n * @beta\n */\nexport class PointCloudDisplaySettings {\n  /** The shape drawn for each point in the cloud.\n   * Default: \"round\".\n   */\n  public readonly shape: PointCloudShape;\n  /** The method by which the size of each individual point is computed.\n   * Default: \"voxel\".\n   * @see [[pixelSize]] to configure the size for \"pixel\" mode.\n   * @see [[voxelScale]], [[minPixelsPerVoxel]], and [[maxPixelsPerVoxel]] to configure the size for \"voxel\" mode.\n   */\n  public readonly sizeMode: PointCloudSizeMode;\n  /** The radius of each point in pixels, when [[sizeMode]] is \"pixel\".\n   * The size is expected to be a positive integer. The maximum size will vary based on the graphics hardware in use, but typically is limited to 32 or 64 pixels.\n   * Default: 1\n   */\n  public readonly pixelSize: number;\n  /** A scale factor applied to the size of each point, when [[sizeMode]] is \"voxel\".\n   * The scale is expected to be a positive floating point number.\n   * Default: 1.0\n   */\n  public readonly voxelScale: number;\n  /** If [[sizeMode]] is \"voxel\", the minimum radius of each point in pixels. It is expected to be a positive integer no greater than [[maxPixelsPerVoxel]].\n   * Default: 2\n   */\n  public readonly minPixelsPerVoxel: number;\n  /** If [[sizeMode]] is \"voxel\", the maximum radius of each point in pixels. It is expected to be a positive integer no less than [[minPixelsPerVoxel]].\n   * Default: 20.\n   */\n  public readonly maxPixelsPerVoxel: number;\n\n  /** Settings with all properties initialized to their default values. */\n  public static defaults = new PointCloudDisplaySettings();\n\n  private constructor(props?: PointCloudDisplayProps) {\n    this.shape = props?.shape ?? \"round\";\n    this.sizeMode = props?.sizeMode ?? \"voxel\";\n\n    // No sanity checks here - e.g., min < max, pixelSize and voxelScale > 0, etc.\n    this.pixelSize = props?.pixelSize ?? 1;\n    this.voxelScale = props?.voxelScale ?? 1;\n    this.minPixelsPerVoxel = props?.minPixelsPerVoxel ?? 2;\n    this.maxPixelsPerVoxel = props?.maxPixelsPerVoxel ?? 20;\n  }\n\n  /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */\n  public static fromJSON(props?: PointCloudDisplayProps): PointCloudDisplaySettings {\n    return props ? new PointCloudDisplaySettings(props) : this.defaults;\n  }\n\n  /** Convert these settings to their JSON representation. */\n  public toJSON(): PointCloudDisplayProps | undefined {\n    const defs = PointCloudDisplaySettings.defaults;\n    if (this.equals(defs))\n      return undefined;\n\n    const props: PointCloudDisplayProps = { };\n    if (this.shape !== defs.shape)\n      props.shape = this.shape;\n\n    if (this.sizeMode !== defs.sizeMode)\n      props.sizeMode = this.sizeMode;\n\n    if (this.pixelSize !== defs.pixelSize)\n      props.pixelSize = this.pixelSize;\n\n    if (this.voxelScale !== defs.voxelScale)\n      props.voxelScale = this.voxelScale;\n\n    if (this.minPixelsPerVoxel !== defs.minPixelsPerVoxel)\n      props.minPixelsPerVoxel = this.minPixelsPerVoxel;\n\n    if (this.maxPixelsPerVoxel !== defs.maxPixelsPerVoxel)\n      props.maxPixelsPerVoxel = this.maxPixelsPerVoxel;\n\n    return props;\n  }\n\n  /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */\n  public clone(changedProps: PointCloudDisplayProps): PointCloudDisplaySettings {\n    return PointCloudDisplaySettings.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n\n  /** Returns true if these settings are identical to `other`. */\n  public equals(other: PointCloudDisplaySettings): boolean {\n    if (this === other)\n      return true;\n\n    return this.shape === other.shape && this.sizeMode === other.sizeMode && this.pixelSize === other.pixelSize\n      && this.voxelScale === other.voxelScale && this.minPixelsPerVoxel === other.minPixelsPerVoxel && this.maxPixelsPerVoxel === other.maxPixelsPerVoxel;\n  }\n}\n\n/** Settings that control how a reality model - whether a [[ContextRealityModel]] or a persistent reality [Model]($backend) - is displayed within a [Viewport]($frontend).\n * @see [[ContextRealityModel.displaySettings]] to apply these settings to a context reality model.\n * @see [[DisplayStyleSettings.setRealityModelDisplaySettings]] to apply these settings to a persistent reality model.\n * @note This is an immutable type - to modify its properties, use [[clone]].\n * @beta\n */\nexport class RealityModelDisplaySettings {\n  /** If the reality model's color is overridden with another color, a ratio in [0..1] with which to mix the two colors together.\n   * A ratio of 0 uses only the reality model's color, a ratio of 1 uses only the override color, and a ratio of 0.5 mixes the two colors equally.\n   * The color may be overridden using [[FeatureOverrides]] such as those supplied by a [FeatureOverrideProvider]($frontend), or by applying a [[SpatialClassifier]].\n   * Default: 0.5\n   */\n  public readonly overrideColorRatio: number;\n  /** Settings that apply specifically to point cloud reality models.\n   * Default: [[PointCloudDisplaySettings.defaults]].\n   */\n  public readonly pointCloud: PointCloudDisplaySettings;\n\n  /** Settings with all properties initialized to their default values. */\n  public static defaults = new RealityModelDisplaySettings(undefined, PointCloudDisplaySettings.defaults);\n\n  private constructor(overrideColorRatio: number | undefined, pointCloud: PointCloudDisplaySettings) {\n    this.overrideColorRatio = overrideColorRatio ?? 0.5;\n    this.pointCloud = pointCloud;\n  }\n\n  /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */\n  public static fromJSON(props?: RealityModelDisplayProps): RealityModelDisplaySettings {\n    if (!props)\n      return this.defaults;\n\n    return new RealityModelDisplaySettings(props.overrideColorRatio, PointCloudDisplaySettings.fromJSON(props.pointCloud));\n  }\n\n  /** Convert these settings to their JSON representation, which is `undefined` if all of their properties match the default settings. */\n  public toJSON(): RealityModelDisplayProps | undefined {\n    const pointCloud = this.pointCloud.toJSON();\n    const overrideColorRatio = this.overrideColorRatio === RealityModelDisplaySettings.defaults.overrideColorRatio ? undefined : this.overrideColorRatio;\n\n    if (undefined === pointCloud && undefined === overrideColorRatio)\n      return undefined;\n\n    const props: RealityModelDisplayProps = { };\n    if (undefined !== pointCloud)\n      props.pointCloud = pointCloud;\n\n    if (undefined !== overrideColorRatio)\n      props.overrideColorRatio = overrideColorRatio;\n\n    return props;\n  }\n\n  /** Returns true if these settings are identical to `other`. */\n  public equals(other: RealityModelDisplaySettings): boolean {\n    if (this === other)\n      return true;\n\n    return this.overrideColorRatio === other.overrideColorRatio && this.pointCloud.equals(other.pointCloud);\n  }\n\n  /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */\n  public clone(changedProps: RealityModelDisplayProps): RealityModelDisplaySettings {\n    const pointCloud = changedProps.pointCloud ? this.pointCloud.clone(changedProps.pointCloud) : this.pointCloud;\n    const colorRatio = changedProps.hasOwnProperty(\"overrideColorRatio\") ? changedProps.overrideColorRatio : this.overrideColorRatio;\n    return new RealityModelDisplaySettings(colorRatio, pointCloud);\n  }\n}\n"]}
+{"version":3,"file":"RealityModelDisplaySettings.js","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA+CH;;;;GAIG;AACH,MAAa,yBAAyB;IAiCpC,YAAoB,KAA8B;;QAChD,IAAI,CAAC,KAAK,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,mCAAI,OAAO,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,mCAAI,OAAO,CAAC;QAE3C,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,mCAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,CAAC,CAAC;QACzC,IAAI,CAAC,iBAAiB,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,mCAAI,CAAC,CAAC;QACvD,IAAI,CAAC,iBAAiB,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,mCAAI,EAAE,CAAC;IAC1D,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACtE,CAAC;IAED,2DAA2D;IACpD,MAAM;QACX,MAAM,IAAI,GAAG,yBAAyB,CAAC,QAAQ,CAAC;QAChD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACnB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAA2B,EAAG,CAAC;QAC1C,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK;YAC3B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACnC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACnD,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACnD,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mHAAmH;IAC5G,KAAK,CAAC,YAAoC;QAC/C,OAAO,yBAAyB,CAAC,QAAQ,CAAC;YACxC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,+DAA+D;IACxD,MAAM,CAAC,KAAgC;QAC5C,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eACtG,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,CAAC;IACxJ,CAAC;;AA5FH,8DA6FC;AA/DC,wEAAwE;AAC1D,kCAAQ,GAAG,IAAI,yBAAyB,EAAE,CAAC;AAgE3D;;;;;GAKG;AACH,MAAa,2BAA2B;IAetC,YAAoB,kBAAsC,EAAE,UAAqC;QAC/F,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,GAAG,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,QAAQ,CAAC,KAAgC;QACrD,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,2BAA2B,CAAC,KAAK,CAAC,kBAAkB,EAAE,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACzH,CAAC;IAED,uIAAuI;IAChI,MAAM;QACX,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC5C,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,KAAK,2BAA2B,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAErJ,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,KAAK,kBAAkB;YAC9D,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAA6B,EAAG,CAAC;QAC5C,IAAI,SAAS,KAAK,UAAU;YAC1B,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;QAEhC,IAAI,SAAS,KAAK,kBAAkB;YAClC,KAAK,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAEhD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+DAA+D;IACxD,MAAM,CAAC,KAAkC;QAC9C,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,kBAAkB,KAAK,KAAK,CAAC,kBAAkB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC1G,CAAC;IAED,mHAAmH;IAC5G,KAAK,CAAC,YAAsC;QACjD,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QAC9G,MAAM,UAAU,GAAG,YAAY,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACjI,OAAO,IAAI,2BAA2B,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;;AA3DH,kEA4DC;AAhDC,wEAAwE;AAC1D,oCAAQ,GAAG,IAAI,2BAA2B,CAAC,SAAS,EAAE,yBAAyB,CAAC,QAAQ,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/** Specifies how the sizes of the individual points within a point cloud are computed.\r\n *  - \"pixel\": Each point is an exact number of pixels in diameter, as specified by [[PointCloudDisplaySettings.pixelSize]].\r\n *  - \"voxel\": Each point is the size of a \"voxel\" in meters, as specified by the [Tile]($frontend) to which the point belongs.\r\n * @see [[PointCloudDisplaySettings.sizeMode]].\r\n * @beta\r\n */\r\nexport type PointCloudSizeMode = \"voxel\" | \"pixel\";\r\n\r\n/** Specifies the shape drawn for each individual point within a point cloud.\r\n *  - \"round\": Each point is drawn as a circle.\r\n *  - \"square\": Each point is drawn as a square.\r\n * @see [[PointCloudDisplaySettings.shape]].\r\n * @beta\r\n */\r\nexport type PointCloudShape = \"square\" | \"round\";\r\n\r\n/** The JSON representation of [[PointCloudDisplaySettings]].\r\n * @beta\r\n */\r\nexport interface PointCloudDisplayProps {\r\n  /** See [[PointCloudDisplaySettings.sizeMode]]. */\r\n  sizeMode?: PointCloudSizeMode;\r\n  /** See [[PointCloudDisplaySettings.voxelScale]]. */\r\n  voxelScale?: number;\r\n  /** See [[PointCloudDisplaySettings.minPixelsPerVoxel]]. */\r\n  minPixelsPerVoxel?: number;\r\n  /** See [[PointCloudDisplaySettings.maxPixelsPerVoxel]]. */\r\n  maxPixelsPerVoxel?: number;\r\n  /** See [[PointCloudDisplaySettings.pixelSize]]. */\r\n  pixelSize?: number;\r\n  /** See [[PointCloudDisplaySettings.shape]]. */\r\n  shape?: PointCloudShape;\r\n}\r\n\r\n/** The JSON representation of [[RealityModelDisplaySettings]].\r\n * @beta\r\n */\r\nexport interface RealityModelDisplayProps {\r\n  /** See [[RealityModelDisplaySettings.pointCloud]]. */\r\n  pointCloud?: PointCloudDisplayProps;\r\n  /** See [[RealityModelDisplaySettings.overrideColorRatio]]. */\r\n  overrideColorRatio?: number;\r\n  // ###TODO when we need it: mesh?: RealityMeshDisplayProps;\r\n}\r\n\r\n/** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).\r\n * @note This is an immutable type - to modify its properties, use [[clone]].\r\n * @see [[RealityModelDisplaySettings.pointCloud]].\r\n * @beta\r\n */\r\nexport class PointCloudDisplaySettings {\r\n  /** The shape drawn for each point in the cloud.\r\n   * Default: \"round\".\r\n   */\r\n  public readonly shape: PointCloudShape;\r\n  /** The method by which the size of each individual point is computed.\r\n   * Default: \"voxel\".\r\n   * @see [[pixelSize]] to configure the size for \"pixel\" mode.\r\n   * @see [[voxelScale]], [[minPixelsPerVoxel]], and [[maxPixelsPerVoxel]] to configure the size for \"voxel\" mode.\r\n   */\r\n  public readonly sizeMode: PointCloudSizeMode;\r\n  /** The radius of each point in pixels, when [[sizeMode]] is \"pixel\".\r\n   * The size is expected to be a positive integer. The maximum size will vary based on the graphics hardware in use, but typically is limited to 32 or 64 pixels.\r\n   * Default: 1\r\n   */\r\n  public readonly pixelSize: number;\r\n  /** A scale factor applied to the size of each point, when [[sizeMode]] is \"voxel\".\r\n   * The scale is expected to be a positive floating point number.\r\n   * Default: 1.0\r\n   */\r\n  public readonly voxelScale: number;\r\n  /** If [[sizeMode]] is \"voxel\", the minimum radius of each point in pixels. It is expected to be a positive integer no greater than [[maxPixelsPerVoxel]].\r\n   * Default: 2\r\n   */\r\n  public readonly minPixelsPerVoxel: number;\r\n  /** If [[sizeMode]] is \"voxel\", the maximum radius of each point in pixels. It is expected to be a positive integer no less than [[minPixelsPerVoxel]].\r\n   * Default: 20.\r\n   */\r\n  public readonly maxPixelsPerVoxel: number;\r\n\r\n  /** Settings with all properties initialized to their default values. */\r\n  public static defaults = new PointCloudDisplaySettings();\r\n\r\n  private constructor(props?: PointCloudDisplayProps) {\r\n    this.shape = props?.shape ?? \"round\";\r\n    this.sizeMode = props?.sizeMode ?? \"voxel\";\r\n\r\n    // No sanity checks here - e.g., min < max, pixelSize and voxelScale > 0, etc.\r\n    this.pixelSize = props?.pixelSize ?? 1;\r\n    this.voxelScale = props?.voxelScale ?? 1;\r\n    this.minPixelsPerVoxel = props?.minPixelsPerVoxel ?? 2;\r\n    this.maxPixelsPerVoxel = props?.maxPixelsPerVoxel ?? 20;\r\n  }\r\n\r\n  /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */\r\n  public static fromJSON(props?: PointCloudDisplayProps): PointCloudDisplaySettings {\r\n    return props ? new PointCloudDisplaySettings(props) : this.defaults;\r\n  }\r\n\r\n  /** Convert these settings to their JSON representation. */\r\n  public toJSON(): PointCloudDisplayProps | undefined {\r\n    const defs = PointCloudDisplaySettings.defaults;\r\n    if (this.equals(defs))\r\n      return undefined;\r\n\r\n    const props: PointCloudDisplayProps = { };\r\n    if (this.shape !== defs.shape)\r\n      props.shape = this.shape;\r\n\r\n    if (this.sizeMode !== defs.sizeMode)\r\n      props.sizeMode = this.sizeMode;\r\n\r\n    if (this.pixelSize !== defs.pixelSize)\r\n      props.pixelSize = this.pixelSize;\r\n\r\n    if (this.voxelScale !== defs.voxelScale)\r\n      props.voxelScale = this.voxelScale;\r\n\r\n    if (this.minPixelsPerVoxel !== defs.minPixelsPerVoxel)\r\n      props.minPixelsPerVoxel = this.minPixelsPerVoxel;\r\n\r\n    if (this.maxPixelsPerVoxel !== defs.maxPixelsPerVoxel)\r\n      props.maxPixelsPerVoxel = this.maxPixelsPerVoxel;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */\r\n  public clone(changedProps: PointCloudDisplayProps): PointCloudDisplaySettings {\r\n    return PointCloudDisplaySettings.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n\r\n  /** Returns true if these settings are identical to `other`. */\r\n  public equals(other: PointCloudDisplaySettings): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.shape === other.shape && this.sizeMode === other.sizeMode && this.pixelSize === other.pixelSize\r\n      && this.voxelScale === other.voxelScale && this.minPixelsPerVoxel === other.minPixelsPerVoxel && this.maxPixelsPerVoxel === other.maxPixelsPerVoxel;\r\n  }\r\n}\r\n\r\n/** Settings that control how a reality model - whether a [[ContextRealityModel]] or a persistent reality [Model]($backend) - is displayed within a [Viewport]($frontend).\r\n * @see [[ContextRealityModel.displaySettings]] to apply these settings to a context reality model.\r\n * @see [[DisplayStyleSettings.setRealityModelDisplaySettings]] to apply these settings to a persistent reality model.\r\n * @note This is an immutable type - to modify its properties, use [[clone]].\r\n * @beta\r\n */\r\nexport class RealityModelDisplaySettings {\r\n  /** If the reality model's color is overridden with another color, a ratio in [0..1] with which to mix the two colors together.\r\n   * A ratio of 0 uses only the reality model's color, a ratio of 1 uses only the override color, and a ratio of 0.5 mixes the two colors equally.\r\n   * The color may be overridden using [[FeatureOverrides]] such as those supplied by a [FeatureOverrideProvider]($frontend), or by applying a [[SpatialClassifier]].\r\n   * Default: 0.5\r\n   */\r\n  public readonly overrideColorRatio: number;\r\n  /** Settings that apply specifically to point cloud reality models.\r\n   * Default: [[PointCloudDisplaySettings.defaults]].\r\n   */\r\n  public readonly pointCloud: PointCloudDisplaySettings;\r\n\r\n  /** Settings with all properties initialized to their default values. */\r\n  public static defaults = new RealityModelDisplaySettings(undefined, PointCloudDisplaySettings.defaults);\r\n\r\n  private constructor(overrideColorRatio: number | undefined, pointCloud: PointCloudDisplaySettings) {\r\n    this.overrideColorRatio = overrideColorRatio ?? 0.5;\r\n    this.pointCloud = pointCloud;\r\n  }\r\n\r\n  /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */\r\n  public static fromJSON(props?: RealityModelDisplayProps): RealityModelDisplaySettings {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new RealityModelDisplaySettings(props.overrideColorRatio, PointCloudDisplaySettings.fromJSON(props.pointCloud));\r\n  }\r\n\r\n  /** Convert these settings to their JSON representation, which is `undefined` if all of their properties match the default settings. */\r\n  public toJSON(): RealityModelDisplayProps | undefined {\r\n    const pointCloud = this.pointCloud.toJSON();\r\n    const overrideColorRatio = this.overrideColorRatio === RealityModelDisplaySettings.defaults.overrideColorRatio ? undefined : this.overrideColorRatio;\r\n\r\n    if (undefined === pointCloud && undefined === overrideColorRatio)\r\n      return undefined;\r\n\r\n    const props: RealityModelDisplayProps = { };\r\n    if (undefined !== pointCloud)\r\n      props.pointCloud = pointCloud;\r\n\r\n    if (undefined !== overrideColorRatio)\r\n      props.overrideColorRatio = overrideColorRatio;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if these settings are identical to `other`. */\r\n  public equals(other: RealityModelDisplaySettings): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.overrideColorRatio === other.overrideColorRatio && this.pointCloud.equals(other.pointCloud);\r\n  }\r\n\r\n  /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */\r\n  public clone(changedProps: RealityModelDisplayProps): RealityModelDisplaySettings {\r\n    const pointCloud = changedProps.pointCloud ? this.pointCloud.clone(changedProps.pointCloud) : this.pointCloud;\r\n    const colorRatio = changedProps.hasOwnProperty(\"overrideColorRatio\") ? changedProps.overrideColorRatio : this.overrideColorRatio;\r\n    return new RealityModelDisplaySettings(colorRatio, pointCloud);\r\n  }\r\n}\r\n"]}