@itwin/core-common 3.5.0-dev.8 → 3.5.1

package/lib/cjs/RealityModelDisplaySettings.d.ts

@@ -1,119 +1,184 @@
-/** @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";
+/** Specifies the Eye-Dome Lighting mode used for a point cloud.
+ *  - "off": EDL is not calculated
+ *  - "on": EDL is calculated using a single pass.
+ *  - "full" EDL is calculated with full algorithm including optional filtering
+ * @see [[PointCloudDisplaySettings.edlMode]].
+ * @beta
+ */
+export declare type PointCloudEDLMode = "off" | "on" | "full";
+/** 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;
+    /** See [[PointCloudDisplaySettings.edlMode]]. */
+    edlMode?: PointCloudEDLMode;
+    /** See [[PointCloudDisplaySettings.edlStrength]]. */
+    edlStrength?: number;
+    /** See [[PointCloudDisplaySettings.edlRadius]]. */
+    edlRadius?: number;
+    /** See [[PointCloudDisplaySettings.edlFilter]]. */
+    edlFilter?: number;
+    /** See [[PointCloudDisplaySettings.edlMixWts1]]. */
+    edlMixWts1?: number;
+    /** See [[PointCloudDisplaySettings.edlMixWts2]]. */
+    edlMixWts2?: number;
+    /** See [[PointCloudDisplaySettings.edlMixWts4]]. */
+    edlMixWts4?: number;
+}
+/** 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]].
+ * Eye-Dome Lighting (EDL) is a non-photorealistic, image-based shading technique that was designed to improve depth
+ * perception in scientific visualization. It is particularly useful for visualizing monochrome point cloud data, but
+ * also can be useful for point clouds with color information.
+ * @note EDL mode is ignored (off) if the view is not perspective (camera is off)
+ * @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;
+    /** The mode for the Eye-Dome Lighting (EDL) effect.
+     * Default: "off"
+     * @note EDL mode is ignored (off) if the view is not perspective (camera is off)
+     */
+    readonly edlMode: PointCloudEDLMode;
+    /** A strength value for the Eye Dome Lighting (EDL) effect.
+     * The strength is expected to be a positive floating point number.
+     * Default: 5.0
+     */
+    readonly edlStrength: number;
+    /** A radius value for the Eye Dome Lighting (EDL) effect.
+     * The radius is expected to be a positive floating point number
+     * It is used to deterimine how far away in pixels to sample for depth change
+     * Default: 2.0
+     */
+    readonly edlRadius: number;
+    /** A flag for whether or not to apply filtering pass in the Eye Dome Lighting (EDL) effect.
+     * It only applies if edlMode is "full"
+     * Default: 1.0
+     */
+    readonly edlFilter?: number;
+    /** A weighting value to apply to the full image when combining it with the half and quarter sized ones
+     * It only applies if edlMode is "full"
+     * The strength is expected to be a floating point number between 0 and 1 inclusive.
+     * Default: 1.0
+     */
+    readonly edlMixWts1?: number;
+    /** A weighting value to apply to the half sized image when combining it with the full and quarter sized ones
+     * It only applies if edlMode is "full"
+     * The strength is expected to be a floating point number between 0 and 1 inclusive.
+     * Default: 0.5
+     */
+    readonly edlMixWts2?: number;
+    /** A weighting value to apply to the quarter sized image when combining it with the full and half sized ones
+     * It only applies if edlMode is "full"
+     * The strength is expected to be a floating point number between 0 and 1 inclusive.
+     * Default: 0.25
+     */
+    readonly edlMixWts4?: 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.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RealityModelDisplaySettings.d.ts","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,kBAAkB,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnD;;;;;GAKG;AACH,oBAAY,eAAe,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,kDAAkD;IAClD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,sDAAsD;IACtD,UAAU,CAAC,EAAE,sBAAsB,CAAC;IACpC,8DAA8D;IAC9D,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAE7B;AAED;;;;GAIG;AACH,qBAAa,yBAAyB;IACpC;;OAEG;IACH,SAAgB,KAAK,EAAE,eAAe,CAAC;IACvC;;;;OAIG;IACH,SAAgB,QAAQ,EAAE,kBAAkB,CAAC;IAC7C;;;OAGG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAE1C,wEAAwE;IACxE,OAAc,QAAQ,4BAAmC;IAEzD,OAAO;IAWP,4HAA4H;WAC9G,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,yBAAyB;IAIjF,2DAA2D;IACpD,MAAM,IAAI,sBAAsB,GAAG,SAAS;IA2BnD,mHAAmH;IAC5G,KAAK,CAAC,YAAY,EAAE,sBAAsB,GAAG,yBAAyB;IAO7E,+DAA+D;IACxD,MAAM,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO;CAOzD;AAED;;;;;GAKG;AACH,qBAAa,2BAA2B;IACtC;;;;OAIG;IACH,SAAgB,kBAAkB,EAAE,MAAM,CAAC;IAC3C;;OAEG;IACH,SAAgB,UAAU,EAAE,yBAAyB,CAAC;IAEtD,wEAAwE;IACxE,OAAc,QAAQ,8BAAkF;IAExG,OAAO;IAKP,4HAA4H;WAC9G,QAAQ,CAAC,KAAK,CAAC,EAAE,wBAAwB,GAAG,2BAA2B;IAOrF,uIAAuI;IAChI,MAAM,IAAI,wBAAwB,GAAG,SAAS;IAiBrD,+DAA+D;IACxD,MAAM,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO;IAO1D,mHAAmH;IAC5G,KAAK,CAAC,YAAY,EAAE,wBAAwB,GAAG,2BAA2B;CAKlF"}
+{"version":3,"file":"RealityModelDisplaySettings.d.ts","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,kBAAkB,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnD;;;;;GAKG;AACH,oBAAY,eAAe,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjD;;;;;;GAMG;AACH,oBAAY,iBAAiB,GAAG,KAAK,GAAG,IAAI,GAAG,MAAM,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,kDAAkD;IAClD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,iDAAiD;IACjD,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,sDAAsD;IACtD,UAAU,CAAC,EAAE,sBAAsB,CAAC;IACpC,8DAA8D;IAC9D,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAE7B;AAED;;;;;;;;GAQG;AACH,qBAAa,yBAAyB;IACpC;;OAEG;IACH,SAAgB,KAAK,EAAE,eAAe,CAAC;IACvC;;;;OAIG;IACH,SAAgB,QAAQ,EAAE,kBAAkB,CAAC;IAC7C;;;OAGG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;;OAGG;IACH,SAAgB,OAAO,EAAE,iBAAiB,CAAC;IAC3C;;;OAGG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnC;;;;OAIG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpC,wEAAwE;IACxE,OAAc,QAAQ,4BAAmC;IAEzD,OAAO;IAkBP,4HAA4H;WAC9G,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,yBAAyB;IAIjF,2DAA2D;IACpD,MAAM,IAAI,sBAAsB,GAAG,SAAS;IAgDnD,mHAAmH;IAC5G,KAAK,CAAC,YAAY,EAAE,sBAAsB,GAAG,yBAAyB;IAO7E,+DAA+D;IACxD,MAAM,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO;CAWzD;AAED;;;;;GAKG;AACH,qBAAa,2BAA2B;IACtC;;;;OAIG;IACH,SAAgB,kBAAkB,EAAE,MAAM,CAAC;IAC3C;;OAEG;IACH,SAAgB,UAAU,EAAE,yBAAyB,CAAC;IAEtD,wEAAwE;IACxE,OAAc,QAAQ,8BAAkF;IAExG,OAAO;IAKP,4HAA4H;WAC9G,QAAQ,CAAC,KAAK,CAAC,EAAE,wBAAwB,GAAG,2BAA2B;IAOrF,uIAAuI;IAChI,MAAM,IAAI,wBAAwB,GAAG,SAAS;IAiBrD,+DAA+D;IACxD,MAAM,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO;IAO1D,mHAAmH;IAC5G,KAAK,CAAC,YAAY,EAAE,wBAAwB,GAAG,2BAA2B;CAKlF"}

package/lib/cjs/RealityModelDisplaySettings.js

@@ -1,115 +1,143 @@
-"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]].
+ * Eye-Dome Lighting (EDL) is a non-photorealistic, image-based shading technique that was designed to improve depth
+ * perception in scientific visualization. It is particularly useful for visualizing monochrome point cloud data, but
+ * also can be useful for point clouds with color information.
+ * @note EDL mode is ignored (off) if the view is not perspective (camera is off)
+ * @see [[RealityModelDisplaySettings.pointCloud]].
+ * @beta
+ */
+class PointCloudDisplaySettings {
+    constructor(props) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        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;
+        this.edlMode = (_g = props === null || props === void 0 ? void 0 : props.edlMode) !== null && _g !== void 0 ? _g : "off";
+        this.edlStrength = (_h = props === null || props === void 0 ? void 0 : props.edlStrength) !== null && _h !== void 0 ? _h : 5;
+        this.edlRadius = (_j = props === null || props === void 0 ? void 0 : props.edlRadius) !== null && _j !== void 0 ? _j : 2;
+        this.edlFilter = (_k = props === null || props === void 0 ? void 0 : props.edlFilter) !== null && _k !== void 0 ? _k : 1;
+        this.edlMixWts1 = (_l = props === null || props === void 0 ? void 0 : props.edlMixWts1) !== null && _l !== void 0 ? _l : 1.0;
+        this.edlMixWts2 = (_m = props === null || props === void 0 ? void 0 : props.edlMixWts2) !== null && _m !== void 0 ? _m : 0.5;
+        this.edlMixWts4 = (_o = props === null || props === void 0 ? void 0 : props.edlMixWts4) !== null && _o !== void 0 ? _o : 0.25;
+    }
+    /** 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;
+        if (this.edlMode !== defs.edlMode)
+            props.edlMode = this.edlMode;
+        if (this.edlStrength !== defs.edlStrength)
+            props.edlStrength = this.edlStrength;
+        if (this.edlRadius !== defs.edlRadius)
+            props.edlRadius = this.edlRadius;
+        if (this.edlFilter !== defs.edlFilter)
+            props.edlFilter = this.edlFilter;
+        if (this.edlMixWts1 !== defs.edlMixWts1)
+            props.edlMixWts1 = this.edlMixWts1;
+        if (this.edlMixWts2 !== defs.edlMixWts2)
+            props.edlMixWts2 = this.edlMixWts2;
+        if (this.edlMixWts4 !== defs.edlMixWts4)
+            props.edlMixWts4 = this.edlMixWts4;
+        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
+            && this.edlMode === other.edlMode && this.edlStrength === other.edlStrength && this.edlRadius === other.edlRadius
+            && this.edlFilter === other.edlFilter
+            && this.edlMixWts1 === other.edlMixWts1 && this.edlMixWts2 === other.edlMixWts2 && this.edlMixWts4 === other.edlMixWts4;
+    }
+}
+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