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

package/lib/esm/RealityModelDisplaySettings.js

@@ -0,0 +1,110 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** 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 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;
+    }
+}
+/** 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
+ */
+export 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);
+    }
+}
+/** Settings with all properties initialized to their default values. */
+RealityModelDisplaySettings.defaults = new RealityModelDisplaySettings(undefined, PointCloudDisplaySettings.defaults);
+//# sourceMappingURL=RealityModelDisplaySettings.js.map

package/lib/esm/RealityModelDisplaySettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RealityModelDisplaySettings.js","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA+CH;;;;GAIG;AACH,MAAM,OAAO,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;;AA9DD,wEAAwE;AAC1D,kCAAQ,GAAG,IAAI,yBAAyB,EAAE,CAAC;AAgE3D;;;;;GAKG;AACH,MAAM,OAAO,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;;AA/CD,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"]}

package/lib/esm/Render.d.ts

@@ -1,90 +1,90 @@
-/** @packageDocumentation
- * @module Rendering
- */
-import { OctEncodedNormalPair } from "./OctEncodedNormal";
-/** @internal */
-export declare enum PolylineTypeFlags {
-    Normal = 0,
-    Edge = 1,
-    Outline = 2
-}
-/** Flags describing a polyline. A polyline may represent a continuous line string, or a set of discrete points.
- * @internal
- */
-export declare class PolylineFlags {
-    isDisjoint: boolean;
-    isPlanar: boolean;
-    is2d: boolean;
-    type: PolylineTypeFlags;
-    constructor(is2d?: boolean, isPlanar?: boolean, isDisjoint?: boolean, type?: PolylineTypeFlags);
-    clone(): PolylineFlags;
-    /** Create a PolylineFlags from a serialized numeric representation. */
-    static unpack(value: number): PolylineFlags;
-    initDefaults(): void;
-    get isOutlineEdge(): boolean;
-    get isNormalEdge(): boolean;
-    get isAnyEdge(): boolean;
-    setIsNormalEdge(): void;
-    setIsOutlineEdge(): void;
-    /** Convert these flags to a numeric representation for serialization. */
-    pack(): number;
-    equals(other: PolylineFlags): boolean;
-}
-/** @internal */
-export declare class PolylineData {
-    vertIndices: number[];
-    numIndices: number;
-    constructor(vertIndices?: number[], numIndices?: number);
-    get isValid(): boolean;
-    reset(): void;
-    init(polyline: MeshPolyline): boolean;
-}
-/** @internal */
-export declare class MeshPolyline {
-    readonly indices: number[];
-    constructor(indices?: number[]);
-    addIndex(index: number): void;
-    clear(): void;
-}
-/** @internal */
-export declare class MeshPolylineList extends Array<MeshPolyline> {
-    constructor(...args: MeshPolyline[]);
-}
-/** @internal */
-export declare class MeshEdge {
-    indices: number[];
-    constructor(index0?: number, index1?: number);
-    compareTo(other: MeshEdge): number;
-}
-/** @internal */
-export declare class MeshEdges {
-    visible: MeshEdge[];
-    silhouette: MeshEdge[];
-    polylines: MeshPolylineList;
-    silhouetteNormals: OctEncodedNormalPair[];
-    constructor();
-}
-/** @internal */
-export declare class EdgeArgs {
-    edges?: MeshEdge[];
-    init(meshEdges?: MeshEdges): boolean;
-    clear(): void;
-    get isValid(): boolean;
-    get numEdges(): number;
-}
-/** @internal */
-export declare class SilhouetteEdgeArgs extends EdgeArgs {
-    normals?: OctEncodedNormalPair[];
-    init(meshEdges?: MeshEdges): boolean;
-    clear(): void;
-}
-/** @internal */
-export declare class PolylineEdgeArgs {
-    lines?: PolylineData[];
-    constructor(lines?: PolylineData[]);
-    init(lines?: PolylineData[]): boolean;
-    get numLines(): number;
-    get isValid(): boolean;
-    clear(): void;
-}
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { OctEncodedNormalPair } from "./OctEncodedNormal";
+/** @internal */
+export declare enum PolylineTypeFlags {
+    Normal = 0,
+    Edge = 1,
+    Outline = 2
+}
+/** Flags describing a polyline. A polyline may represent a continuous line string, or a set of discrete points.
+ * @internal
+ */
+export declare class PolylineFlags {
+    isDisjoint: boolean;
+    isPlanar: boolean;
+    is2d: boolean;
+    type: PolylineTypeFlags;
+    constructor(is2d?: boolean, isPlanar?: boolean, isDisjoint?: boolean, type?: PolylineTypeFlags);
+    clone(): PolylineFlags;
+    /** Create a PolylineFlags from a serialized numeric representation. */
+    static unpack(value: number): PolylineFlags;
+    initDefaults(): void;
+    get isOutlineEdge(): boolean;
+    get isNormalEdge(): boolean;
+    get isAnyEdge(): boolean;
+    setIsNormalEdge(): void;
+    setIsOutlineEdge(): void;
+    /** Convert these flags to a numeric representation for serialization. */
+    pack(): number;
+    equals(other: PolylineFlags): boolean;
+}
+/** @internal */
+export declare class PolylineData {
+    vertIndices: number[];
+    numIndices: number;
+    constructor(vertIndices?: number[], numIndices?: number);
+    get isValid(): boolean;
+    reset(): void;
+    init(polyline: MeshPolyline): boolean;
+}
+/** @internal */
+export declare class MeshPolyline {
+    readonly indices: number[];
+    constructor(indices?: number[]);
+    addIndex(index: number): void;
+    clear(): void;
+}
+/** @internal */
+export declare class MeshPolylineList extends Array<MeshPolyline> {
+    constructor(...args: MeshPolyline[]);
+}
+/** @internal */
+export declare class MeshEdge {
+    indices: number[];
+    constructor(index0?: number, index1?: number);
+    compareTo(other: MeshEdge): number;
+}
+/** @internal */
+export declare class MeshEdges {
+    visible: MeshEdge[];
+    silhouette: MeshEdge[];
+    polylines: MeshPolylineList;
+    silhouetteNormals: OctEncodedNormalPair[];
+    constructor();
+}
+/** @internal */
+export declare class EdgeArgs {
+    edges?: MeshEdge[];
+    init(meshEdges?: MeshEdges): boolean;
+    clear(): void;
+    get isValid(): boolean;
+    get numEdges(): number;
+}
+/** @internal */
+export declare class SilhouetteEdgeArgs extends EdgeArgs {
+    normals?: OctEncodedNormalPair[];
+    init(meshEdges?: MeshEdges): boolean;
+    clear(): void;
+}
+/** @internal */
+export declare class PolylineEdgeArgs {
+    lines?: PolylineData[];
+    constructor(lines?: PolylineData[]);
+    init(lines?: PolylineData[]): boolean;
+    get numLines(): number;
+    get isValid(): boolean;
+    clear(): void;
+}
 //# sourceMappingURL=Render.d.ts.map

package/lib/esm/Render.js

@@ -1,166 +1,166 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Rendering
- */
-import { assert } from "@itwin/core-bentley";
-// cSpell:ignore vals
-/** @internal */
-export var PolylineTypeFlags;
-(function (PolylineTypeFlags) {
-    PolylineTypeFlags[PolylineTypeFlags["Normal"] = 0] = "Normal";
-    PolylineTypeFlags[PolylineTypeFlags["Edge"] = 1] = "Edge";
-    PolylineTypeFlags[PolylineTypeFlags["Outline"] = 2] = "Outline";
-})(PolylineTypeFlags || (PolylineTypeFlags = {}));
-/** Flags describing a polyline. A polyline may represent a continuous line string, or a set of discrete points.
- * @internal
- */
-export class PolylineFlags {
-    constructor(is2d = false, isPlanar = false, isDisjoint = false, type = PolylineTypeFlags.Normal) {
-        this.isDisjoint = isDisjoint;
-        this.isPlanar = isPlanar;
-        this.is2d = is2d;
-        this.type = type;
-    }
-    clone() { return new PolylineFlags(this.is2d, this.isPlanar, this.isDisjoint, this.type); }
-    /** Create a PolylineFlags from a serialized numeric representation. */
-    static unpack(value) {
-        const isDisjoint = 0 !== (value & 1);
-        const isPlanar = 0 !== (value & 2);
-        const is2d = 0 !== (value & 4);
-        const type = (value >> 3);
-        assert(type === PolylineTypeFlags.Normal || type === PolylineTypeFlags.Edge || type === PolylineTypeFlags.Outline);
-        return new PolylineFlags(is2d, isPlanar, isDisjoint, type);
-    }
-    initDefaults() {
-        this.isDisjoint = this.isPlanar = this.is2d = false;
-        this.type = PolylineTypeFlags.Normal;
-    }
-    get isOutlineEdge() { return PolylineTypeFlags.Outline === this.type; }
-    get isNormalEdge() { return PolylineTypeFlags.Edge === this.type; }
-    get isAnyEdge() { return PolylineTypeFlags.Normal !== this.type; }
-    setIsNormalEdge() { this.type = PolylineTypeFlags.Edge; }
-    setIsOutlineEdge() { this.type = PolylineTypeFlags.Outline; }
-    /** Convert these flags to a numeric representation for serialization. */
-    pack() {
-        let val = 0;
-        if (this.isDisjoint)
-            val += 1;
-        if (this.isPlanar)
-            val += 1 << 1;
-        if (this.is2d)
-            val += 1 << 2;
-        val += this.type << 3;
-        return val;
-    }
-    equals(other) {
-        return this.type === other.type && this.is2d === other.is2d && this.isPlanar === other.isPlanar && this.isDisjoint === other.isDisjoint;
-    }
-}
-/** @internal */
-export class PolylineData {
-    constructor(vertIndices = [], numIndices = 0) {
-        this.vertIndices = vertIndices;
-        this.numIndices = numIndices;
-    }
-    get isValid() { return 0 < this.numIndices; }
-    reset() {
-        this.numIndices = 0;
-        this.vertIndices = [];
-    }
-    init(polyline) {
-        this.numIndices = polyline.indices.length;
-        this.vertIndices = 0 < this.numIndices ? polyline.indices : [];
-        return this.isValid;
-    }
-}
-/** @internal */
-export class MeshPolyline {
-    constructor(indices = []) {
-        this.indices = indices.slice();
-    }
-    addIndex(index) {
-        const { indices } = this;
-        if (indices.length === 0 || indices[indices.length - 1] !== index)
-            indices.push(index);
-    }
-    clear() { this.indices.length = 0; }
-}
-/** @internal */
-export class MeshPolylineList extends Array {
-    constructor(...args) {
-        super(...args);
-    }
-}
-/** @internal */
-export class MeshEdge {
-    constructor(index0, index1) {
-        this.indices = [0, 0];
-        if (undefined === index0 || undefined === index1)
-            return;
-        if (index0 < index1) {
-            this.indices[0] = index0;
-            this.indices[1] = index1;
-        }
-        else {
-            this.indices[0] = index1;
-            this.indices[1] = index0;
-        }
-    }
-    compareTo(other) {
-        let diff = this.indices[0] - other.indices[0];
-        if (0 === diff)
-            diff = this.indices[1] - other.indices[1];
-        return diff;
-    }
-}
-/** @internal */
-export class MeshEdges {
-    constructor() {
-        this.visible = [];
-        this.silhouette = [];
-        this.polylines = new MeshPolylineList();
-        this.silhouetteNormals = [];
-    }
-}
-/** @internal */
-export class EdgeArgs {
-    init(meshEdges) {
-        this.clear();
-        if (undefined !== meshEdges && 0 < meshEdges.visible.length)
-            this.edges = meshEdges.visible;
-        return this.isValid;
-    }
-    clear() { this.edges = undefined; }
-    get isValid() { return 0 < this.numEdges; }
-    get numEdges() { return undefined !== this.edges ? this.edges.length : 0; }
-}
-/** @internal */
-export class SilhouetteEdgeArgs extends EdgeArgs {
-    init(meshEdges) {
-        this.clear();
-        if (undefined !== meshEdges && 0 < meshEdges.silhouette.length) {
-            this.edges = meshEdges.silhouette;
-            this.normals = meshEdges.silhouetteNormals;
-        }
-        return this.isValid;
-    }
-    clear() {
-        this.normals = undefined;
-        super.clear();
-    }
-}
-/** @internal */
-export class PolylineEdgeArgs {
-    constructor(lines) { this.init(lines); }
-    init(lines) {
-        this.lines = undefined !== lines && 0 < lines.length ? lines : undefined;
-        return this.isValid;
-    }
-    get numLines() { return undefined !== this.lines ? this.lines.length : 0; }
-    get isValid() { return this.numLines > 0; }
-    clear() { this.lines = undefined; }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { assert } from "@itwin/core-bentley";
+// cSpell:ignore vals
+/** @internal */
+export var PolylineTypeFlags;
+(function (PolylineTypeFlags) {
+    PolylineTypeFlags[PolylineTypeFlags["Normal"] = 0] = "Normal";
+    PolylineTypeFlags[PolylineTypeFlags["Edge"] = 1] = "Edge";
+    PolylineTypeFlags[PolylineTypeFlags["Outline"] = 2] = "Outline";
+})(PolylineTypeFlags || (PolylineTypeFlags = {}));
+/** Flags describing a polyline. A polyline may represent a continuous line string, or a set of discrete points.
+ * @internal
+ */
+export class PolylineFlags {
+    constructor(is2d = false, isPlanar = false, isDisjoint = false, type = PolylineTypeFlags.Normal) {
+        this.isDisjoint = isDisjoint;
+        this.isPlanar = isPlanar;
+        this.is2d = is2d;
+        this.type = type;
+    }
+    clone() { return new PolylineFlags(this.is2d, this.isPlanar, this.isDisjoint, this.type); }
+    /** Create a PolylineFlags from a serialized numeric representation. */
+    static unpack(value) {
+        const isDisjoint = 0 !== (value & 1);
+        const isPlanar = 0 !== (value & 2);
+        const is2d = 0 !== (value & 4);
+        const type = (value >> 3);
+        assert(type === PolylineTypeFlags.Normal || type === PolylineTypeFlags.Edge || type === PolylineTypeFlags.Outline);
+        return new PolylineFlags(is2d, isPlanar, isDisjoint, type);
+    }
+    initDefaults() {
+        this.isDisjoint = this.isPlanar = this.is2d = false;
+        this.type = PolylineTypeFlags.Normal;
+    }
+    get isOutlineEdge() { return PolylineTypeFlags.Outline === this.type; }
+    get isNormalEdge() { return PolylineTypeFlags.Edge === this.type; }
+    get isAnyEdge() { return PolylineTypeFlags.Normal !== this.type; }
+    setIsNormalEdge() { this.type = PolylineTypeFlags.Edge; }
+    setIsOutlineEdge() { this.type = PolylineTypeFlags.Outline; }
+    /** Convert these flags to a numeric representation for serialization. */
+    pack() {
+        let val = 0;
+        if (this.isDisjoint)
+            val += 1;
+        if (this.isPlanar)
+            val += 1 << 1;
+        if (this.is2d)
+            val += 1 << 2;
+        val += this.type << 3;
+        return val;
+    }
+    equals(other) {
+        return this.type === other.type && this.is2d === other.is2d && this.isPlanar === other.isPlanar && this.isDisjoint === other.isDisjoint;
+    }
+}
+/** @internal */
+export class PolylineData {
+    constructor(vertIndices = [], numIndices = 0) {
+        this.vertIndices = vertIndices;
+        this.numIndices = numIndices;
+    }
+    get isValid() { return 0 < this.numIndices; }
+    reset() {
+        this.numIndices = 0;
+        this.vertIndices = [];
+    }
+    init(polyline) {
+        this.numIndices = polyline.indices.length;
+        this.vertIndices = 0 < this.numIndices ? polyline.indices : [];
+        return this.isValid;
+    }
+}
+/** @internal */
+export class MeshPolyline {
+    constructor(indices = []) {
+        this.indices = indices.slice();
+    }
+    addIndex(index) {
+        const { indices } = this;
+        if (indices.length === 0 || indices[indices.length - 1] !== index)
+            indices.push(index);
+    }
+    clear() { this.indices.length = 0; }
+}
+/** @internal */
+export class MeshPolylineList extends Array {
+    constructor(...args) {
+        super(...args);
+    }
+}
+/** @internal */
+export class MeshEdge {
+    constructor(index0, index1) {
+        this.indices = [0, 0];
+        if (undefined === index0 || undefined === index1)
+            return;
+        if (index0 < index1) {
+            this.indices[0] = index0;
+            this.indices[1] = index1;
+        }
+        else {
+            this.indices[0] = index1;
+            this.indices[1] = index0;
+        }
+    }
+    compareTo(other) {
+        let diff = this.indices[0] - other.indices[0];
+        if (0 === diff)
+            diff = this.indices[1] - other.indices[1];
+        return diff;
+    }
+}
+/** @internal */
+export class MeshEdges {
+    constructor() {
+        this.visible = [];
+        this.silhouette = [];
+        this.polylines = new MeshPolylineList();
+        this.silhouetteNormals = [];
+    }
+}
+/** @internal */
+export class EdgeArgs {
+    init(meshEdges) {
+        this.clear();
+        if (undefined !== meshEdges && 0 < meshEdges.visible.length)
+            this.edges = meshEdges.visible;
+        return this.isValid;
+    }
+    clear() { this.edges = undefined; }
+    get isValid() { return 0 < this.numEdges; }
+    get numEdges() { return undefined !== this.edges ? this.edges.length : 0; }
+}
+/** @internal */
+export class SilhouetteEdgeArgs extends EdgeArgs {
+    init(meshEdges) {
+        this.clear();
+        if (undefined !== meshEdges && 0 < meshEdges.silhouette.length) {
+            this.edges = meshEdges.silhouette;
+            this.normals = meshEdges.silhouetteNormals;
+        }
+        return this.isValid;
+    }
+    clear() {
+        this.normals = undefined;
+        super.clear();
+    }
+}
+/** @internal */
+export class PolylineEdgeArgs {
+    constructor(lines) { this.init(lines); }
+    init(lines) {
+        this.lines = undefined !== lines && 0 < lines.length ? lines : undefined;
+        return this.isValid;
+    }
+    get numLines() { return undefined !== this.lines ? this.lines.length : 0; }
+    get isValid() { return this.numLines > 0; }
+    clear() { this.lines = undefined; }
+}
 //# sourceMappingURL=Render.js.map