@itwin/core-common 4.0.0-dev.44 → 4.0.0-dev.48

package/lib/esm/RealityModelDisplaySettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"RealityModelDisplaySettings.js","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAsEH;;;;;;;;GAQG;AACH,MAAM,OAAO,yBAAyB;IAwEpC,YAAoB,KAA8B;QAChD,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,OAAO,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,OAAO,CAAC;QAE3C,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,iBAAiB,GAAG,KAAK,EAAE,iBAAiB,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,iBAAiB,GAAG,KAAK,EAAE,iBAAiB,IAAI,EAAE,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,KAAK,EAAE,WAAW,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,GAAG,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,GAAG,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,IAAI,CAAC;IAC9C,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,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO;YAC/B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE/B,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,WAAW;YACvC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACnC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,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,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,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;eAChJ,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAC9G,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAClC,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,CACxH;IACH,CAAC;;AA9FD,wEAAwE;AAC1D,kCAAQ,GAAG,IAAI,yBAAyB,EAAE,CAAC;AAgG3D;;;;;GAKG;AACH,MAAM,OAAO,2BAA2B;IAetC,YAAoB,kBAAsC,EAAE,UAAqC;QAC/F,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,IAAI,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/** Specifies the Eye-Dome Lighting mode used for a point cloud.\r\n *  - \"off\": EDL is not calculated\r\n *  - \"on\": EDL is calculated using a single pass.\r\n *  - \"full\" EDL is calculated with full algorithm including optional filtering\r\n * @see [[PointCloudDisplaySettings.edlMode]].\r\n * @beta\r\n */\r\nexport type PointCloudEDLMode = \"off\" | \"on\" | \"full\";\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  /** See [[PointCloudDisplaySettings.edlMode]]. */\r\n  edlMode?: PointCloudEDLMode;\r\n  /** See [[PointCloudDisplaySettings.edlStrength]]. */\r\n  edlStrength?: number;\r\n  /** See [[PointCloudDisplaySettings.edlRadius]]. */\r\n  edlRadius?: number;\r\n  /** See [[PointCloudDisplaySettings.edlFilter]]. */\r\n  edlFilter?: number;\r\n  /** See [[PointCloudDisplaySettings.edlMixWts1]]. */\r\n  edlMixWts1?: number;\r\n  /** See [[PointCloudDisplaySettings.edlMixWts2]]. */\r\n  edlMixWts2?: number;\r\n  /** See [[PointCloudDisplaySettings.edlMixWts4]]. */\r\n  edlMixWts4?: number;\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 * Eye-Dome Lighting (EDL) is a non-photorealistic, image-based shading technique that was designed to improve depth\r\n * perception in scientific visualization. It is particularly useful for visualizing monochrome point cloud data, but\r\n * also can be useful for point clouds with color information.\r\n * @note EDL mode is ignored (off) if the view is not perspective (camera is off)\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  /** The mode for the Eye-Dome Lighting (EDL) effect.\r\n   * Default: \"off\"\r\n   * @note EDL mode is ignored (off) if the view is not perspective (camera is off)\r\n   */\r\n  public readonly edlMode: PointCloudEDLMode;\r\n  /** A strength value for the Eye Dome Lighting (EDL) effect.\r\n   * The strength is expected to be a positive floating point number.\r\n   * Default: 5.0\r\n   */\r\n  public readonly edlStrength: number;\r\n  /** A radius value for the Eye Dome Lighting (EDL) effect.\r\n   * The radius is expected to be a positive floating point number\r\n   * It is used to deterimine how far away in pixels to sample for depth change\r\n   * Default: 2.0\r\n   */\r\n  public readonly edlRadius: number;\r\n  /** A flag for whether or not to apply filtering pass in the Eye Dome Lighting (EDL) effect.\r\n   * It only applies if edlMode is \"full\"\r\n   * Default: 1.0\r\n   */\r\n  public readonly edlFilter?: number;\r\n  /** A weighting value to apply to the full image when combining it with the half and quarter sized ones\r\n   * It only applies if edlMode is \"full\"\r\n   * The strength is expected to be a floating point number between 0 and 1 inclusive.\r\n   * Default: 1.0\r\n   */\r\n  public readonly edlMixWts1?: number;\r\n  /** A weighting value to apply to the half sized image when combining it with the full and quarter sized ones\r\n   * It only applies if edlMode is \"full\"\r\n   * The strength is expected to be a floating point number between 0 and 1 inclusive.\r\n   * Default: 0.5\r\n   */\r\n  public readonly edlMixWts2?: number;\r\n  /** A weighting value to apply to the quarter sized image when combining it with the full and half sized ones\r\n   * It only applies if edlMode is \"full\"\r\n   * The strength is expected to be a floating point number between 0 and 1 inclusive.\r\n   * Default: 0.25\r\n   */\r\n  public readonly edlMixWts4?: 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    this.edlMode = props?.edlMode ?? \"off\";\r\n    this.edlStrength = props?.edlStrength ?? 5;\r\n    this.edlRadius = props?.edlRadius ?? 2;\r\n    this.edlFilter = props?.edlFilter ?? 1;\r\n    this.edlMixWts1 = props?.edlMixWts1 ?? 1.0;\r\n    this.edlMixWts2 = props?.edlMixWts2 ?? 0.5;\r\n    this.edlMixWts4 = props?.edlMixWts4 ?? 0.25;\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    if (this.edlMode !== defs.edlMode)\r\n      props.edlMode = this.edlMode;\r\n\r\n    if (this.edlStrength !== defs.edlStrength)\r\n      props.edlStrength = this.edlStrength;\r\n\r\n    if (this.edlRadius !== defs.edlRadius)\r\n      props.edlRadius = this.edlRadius;\r\n\r\n    if (this.edlFilter !== defs.edlFilter)\r\n      props.edlFilter = this.edlFilter;\r\n\r\n    if (this.edlMixWts1 !== defs.edlMixWts1)\r\n      props.edlMixWts1 = this.edlMixWts1;\r\n\r\n    if (this.edlMixWts2 !== defs.edlMixWts2)\r\n      props.edlMixWts2 = this.edlMixWts2;\r\n\r\n    if (this.edlMixWts4 !== defs.edlMixWts4)\r\n      props.edlMixWts4 = this.edlMixWts4;\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      && this.edlMode === other.edlMode && this.edlStrength === other.edlStrength && this.edlRadius === other.edlRadius\r\n      && this.edlFilter === other.edlFilter\r\n      && this.edlMixWts1 === other.edlMixWts1 && this.edlMixWts2 === other.edlMixWts2 && this.edlMixWts4 === other.edlMixWts4\r\n    ;\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"]}
+{"version":3,"file":"RealityModelDisplaySettings.js","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAsEH;;;;;;;;GAQG;AACH,MAAM,OAAO,yBAAyB;IAwEpC,YAAoB,KAA8B;QAChD,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,OAAO,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,OAAO,CAAC;QAE3C,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,iBAAiB,GAAG,KAAK,EAAE,iBAAiB,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,iBAAiB,GAAG,KAAK,EAAE,iBAAiB,IAAI,EAAE,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,KAAK,EAAE,WAAW,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,GAAG,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,GAAG,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,IAAI,CAAC;IAC9C,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,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO;YAC/B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE/B,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,WAAW;YACvC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACnC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,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,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,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;eAChJ,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAC9G,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAClC,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,CACxH;IACH,CAAC;;AA9FD,wEAAwE;AAC1D,kCAAQ,GAAG,IAAI,yBAAyB,EAAE,CAAC;AAgG3D;;;;;GAKG;AACH,MAAM,OAAO,2BAA2B;IAetC,YAAoB,kBAAsC,EAAE,UAAqC;QAC/F,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,IAAI,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":["/*---------------------------------------------------------------------------------------------\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/** Specifies the Eye-Dome Lighting mode used for a point cloud.\n *  - \"off\": EDL is not calculated\n *  - \"on\": EDL is calculated using a single pass.\n *  - \"full\" EDL is calculated with full algorithm including optional filtering\n * @see [[PointCloudDisplaySettings.edlMode]].\n * @beta\n */\nexport type PointCloudEDLMode = \"off\" | \"on\" | \"full\";\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  /** See [[PointCloudDisplaySettings.edlMode]]. */\n  edlMode?: PointCloudEDLMode;\n  /** See [[PointCloudDisplaySettings.edlStrength]]. */\n  edlStrength?: number;\n  /** See [[PointCloudDisplaySettings.edlRadius]]. */\n  edlRadius?: number;\n  /** See [[PointCloudDisplaySettings.edlFilter]]. */\n  edlFilter?: number;\n  /** See [[PointCloudDisplaySettings.edlMixWts1]]. */\n  edlMixWts1?: number;\n  /** See [[PointCloudDisplaySettings.edlMixWts2]]. */\n  edlMixWts2?: number;\n  /** See [[PointCloudDisplaySettings.edlMixWts4]]. */\n  edlMixWts4?: number;\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 * Eye-Dome Lighting (EDL) is a non-photorealistic, image-based shading technique that was designed to improve depth\n * perception in scientific visualization. It is particularly useful for visualizing monochrome point cloud data, but\n * also can be useful for point clouds with color information.\n * @note EDL mode is ignored (off) if the view is not perspective (camera is off)\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  /** The mode for the Eye-Dome Lighting (EDL) effect.\n   * Default: \"off\"\n   * @note EDL mode is ignored (off) if the view is not perspective (camera is off)\n   */\n  public readonly edlMode: PointCloudEDLMode;\n  /** A strength value for the Eye Dome Lighting (EDL) effect.\n   * The strength is expected to be a positive floating point number.\n   * Default: 5.0\n   */\n  public readonly edlStrength: number;\n  /** A radius value for the Eye Dome Lighting (EDL) effect.\n   * The radius is expected to be a positive floating point number\n   * It is used to deterimine how far away in pixels to sample for depth change\n   * Default: 2.0\n   */\n  public readonly edlRadius: number;\n  /** A flag for whether or not to apply filtering pass in the Eye Dome Lighting (EDL) effect.\n   * It only applies if edlMode is \"full\"\n   * Default: 1.0\n   */\n  public readonly edlFilter?: number;\n  /** A weighting value to apply to the full image when combining it with the half and quarter sized ones\n   * It only applies if edlMode is \"full\"\n   * The strength is expected to be a floating point number between 0 and 1 inclusive.\n   * Default: 1.0\n   */\n  public readonly edlMixWts1?: number;\n  /** A weighting value to apply to the half sized image when combining it with the full and quarter sized ones\n   * It only applies if edlMode is \"full\"\n   * The strength is expected to be a floating point number between 0 and 1 inclusive.\n   * Default: 0.5\n   */\n  public readonly edlMixWts2?: number;\n  /** A weighting value to apply to the quarter sized image when combining it with the full and half sized ones\n   * It only applies if edlMode is \"full\"\n   * The strength is expected to be a floating point number between 0 and 1 inclusive.\n   * Default: 0.25\n   */\n  public readonly edlMixWts4?: 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    this.edlMode = props?.edlMode ?? \"off\";\n    this.edlStrength = props?.edlStrength ?? 5;\n    this.edlRadius = props?.edlRadius ?? 2;\n    this.edlFilter = props?.edlFilter ?? 1;\n    this.edlMixWts1 = props?.edlMixWts1 ?? 1.0;\n    this.edlMixWts2 = props?.edlMixWts2 ?? 0.5;\n    this.edlMixWts4 = props?.edlMixWts4 ?? 0.25;\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    if (this.edlMode !== defs.edlMode)\n      props.edlMode = this.edlMode;\n\n    if (this.edlStrength !== defs.edlStrength)\n      props.edlStrength = this.edlStrength;\n\n    if (this.edlRadius !== defs.edlRadius)\n      props.edlRadius = this.edlRadius;\n\n    if (this.edlFilter !== defs.edlFilter)\n      props.edlFilter = this.edlFilter;\n\n    if (this.edlMixWts1 !== defs.edlMixWts1)\n      props.edlMixWts1 = this.edlMixWts1;\n\n    if (this.edlMixWts2 !== defs.edlMixWts2)\n      props.edlMixWts2 = this.edlMixWts2;\n\n    if (this.edlMixWts4 !== defs.edlMixWts4)\n      props.edlMixWts4 = this.edlMixWts4;\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      && this.edlMode === other.edlMode && this.edlStrength === other.edlStrength && this.edlRadius === other.edlRadius\n      && this.edlFilter === other.edlFilter\n      && this.edlMixWts1 === other.edlMixWts1 && this.edlMixWts2 === other.edlMixWts2 && this.edlMixWts4 === other.edlMixWts4\n    ;\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"]}

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