@itwin/core-common 4.1.0-dev.7 → 4.1.0-dev.71

package/lib/cjs/Render.js

@@ -7,80 +7,17 @@
  * @module Rendering
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PolylineEdgeArgs = exports.SilhouetteEdgeArgs = exports.EdgeArgs = exports.MeshEdges = exports.MeshEdge = exports.MeshPolylineList = exports.MeshPolyline = exports.PolylineData = exports.PolylineFlags = exports.PolylineTypeFlags = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
+exports.PolylineEdgeArgs = exports.SilhouetteEdgeArgs = exports.EdgeArgs = exports.MeshEdges = exports.MeshEdge = exports.MeshPolylineList = exports.MeshPolyline = exports.PolylineTypeFlags = void 0;
 // cSpell:ignore vals
-/** @internal */
+/** Describes the semantics of a [PolylineArgs]($frontend).
+ * @alpha
+ */
 var PolylineTypeFlags;
 (function (PolylineTypeFlags) {
     PolylineTypeFlags[PolylineTypeFlags["Normal"] = 0] = "Normal";
     PolylineTypeFlags[PolylineTypeFlags["Edge"] = 1] = "Edge";
     PolylineTypeFlags[PolylineTypeFlags["Outline"] = 2] = "Outline";
 })(PolylineTypeFlags = exports.PolylineTypeFlags || (exports.PolylineTypeFlags = {}));
-/** Flags describing a polyline. A polyline may represent a continuous line string, or a set of discrete points.
- * @internal
- */
-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);
-        (0, core_bentley_1.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;
-    }
-}
-exports.PolylineFlags = PolylineFlags;
-/** @internal */
-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;
-    }
-}
-exports.PolylineData = PolylineData;
 /** @internal */
 class MeshPolyline {
     constructor(indices = []) {

package/lib/cjs/Render.js.map

@@ -1 +1 @@
-{"version":3,"file":"Render.js","sourceRoot":"","sources":["../../src/Render.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAG7C,qBAAqB;AAErB,gBAAgB;AAChB,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,yDAAa,CAAA;IACb,+DAAgB,CAAA;AAClB,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAED;;GAEG;AACH,MAAa,aAAa;IAMxB,YAAmB,IAAI,GAAG,KAAK,EAAE,QAAQ,GAAG,KAAK,EAAE,UAAU,GAAG,KAAK,EAAE,IAAI,GAAG,iBAAiB,CAAC,MAAM;QACpG,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAEM,KAAK,KAAoB,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjH,uEAAuE;IAChE,MAAM,CAAC,MAAM,CAAC,KAAa;QAChC,MAAM,UAAU,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC/B,MAAM,IAAI,GAAsB,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QAC7C,IAAA,qBAAM,EAAC,IAAI,KAAK,iBAAiB,CAAC,MAAM,IAAI,IAAI,KAAK,iBAAiB,CAAC,IAAI,IAAI,IAAI,KAAK,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAEnH,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAEM,YAAY;QACjB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC;IACvC,CAAC;IAED,IAAW,aAAa,KAAc,OAAO,iBAAiB,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACvF,IAAW,YAAY,KAAc,OAAO,iBAAiB,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnF,IAAW,SAAS,KAAc,OAAO,iBAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,eAAe,KAAW,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/D,gBAAgB,KAAW,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAE1E,yEAAyE;IAClE,IAAI;QACT,IAAI,GAAG,GAAW,CAAC,CAAC;QACpB,IAAI,IAAI,CAAC,UAAU;YACjB,GAAG,IAAI,CAAC,CAAC;QACX,IAAI,IAAI,CAAC,QAAQ;YACf,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,IAAI,IAAI,CAAC,IAAI;YACX,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,GAAG,IAAK,IAAI,CAAC,IAAe,IAAI,CAAC,CAAC;QAClC,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,KAAoB;QAChC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,CAAC;IAC1I,CAAC;CACF;AArDD,sCAqDC;AAED,gBAAgB;AAChB,MAAa,YAAY;IAGvB,YAAmB,cAAwB,EAAE,EAAE,UAAU,GAAG,CAAC;QAC3D,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IACD,IAAW,OAAO,KAAc,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACtD,KAAK;QACV,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAEM,IAAI,CAAC,QAAsB;QAChC,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAlBD,oCAkBC;AAED,gBAAgB;AAChB,MAAa,YAAY;IAEvB,YAAmB,UAAoB,EAAE;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IACM,QAAQ,CAAC,KAAa;QAC3B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK;YAC/D,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IACM,KAAK,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;CAC5C;AAXD,oCAWC;AAED,gBAAgB;AAChB,MAAa,gBAAiB,SAAQ,KAAmB;IACvD,YAAY,GAAG,IAAoB;QACjC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACjB,CAAC;CACF;AAJD,4CAIC;AAED,gBAAgB;AAChB,MAAa,QAAQ;IAGnB,YAAmB,MAAe,EAAE,MAAe;QAF5C,YAAO,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAGtB,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,MAAM;YAC9C,OAAO;QACT,IAAI,MAAM,GAAG,MAAM,EAAE;YACnB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;SAC1B;IACH,CAAC;IAEM,SAAS,CAAC,KAAe;QAC9B,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,IAAI;YACZ,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtBD,4BAsBC;AAED,gBAAgB;AAChB,MAAa,SAAS;IAKpB;QAJO,YAAO,GAAe,EAAE,CAAC;QACzB,eAAU,GAAe,EAAE,CAAC;QAC5B,cAAS,GAAqB,IAAI,gBAAgB,EAAE,CAAC;QACrD,sBAAiB,GAA2B,EAAE,CAAC;IAC/B,CAAC;CACzB;AAND,8BAMC;AAED,gBAAgB;AAChB,MAAa,QAAQ;IAGZ,IAAI,CAAC,SAAqB;QAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM;YACzD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC;QAEjC,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,KAAK,KAAW,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC;IAChD,IAAW,OAAO,KAAc,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3D,IAAW,QAAQ,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACnF;AAdD,4BAcC;AAED,gBAAgB;AAChB,MAAa,kBAAmB,SAAQ,QAAQ;IAG9B,IAAI,CAAC,SAAqB;QACxC,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE;YAC9D,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,iBAAiB,CAAC;SAC5C;QAED,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEe,KAAK;QACnB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;CACF;AAjBD,gDAiBC;AAED,gBAAgB;AAChB,MAAa,gBAAgB;IAG3B,YAAmB,KAAsB,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEzD,IAAI,CAAC,KAAsB;QAChC,IAAI,CAAC,KAAK,GAAG,SAAS,KAAK,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAW,QAAQ,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClF,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;IAC3C,KAAK,KAAK,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC;CAC3C;AAbD,4CAaC","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 Rendering\r\n */\r\n\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { OctEncodedNormalPair } from \"./OctEncodedNormal\";\r\n\r\n// cSpell:ignore vals\r\n\r\n/** @internal */\r\nexport enum PolylineTypeFlags {\r\n  Normal = 0,      // Just an ordinary polyline\r\n  Edge = 1 << 0, // A polyline used to define the edges of a planar region.\r\n  Outline = 1 << 1, // Like Edge, but the edges are only displayed in wireframe mode when surface fill is undisplayed.\r\n}\r\n\r\n/** Flags describing a polyline. A polyline may represent a continuous line string, or a set of discrete points.\r\n * @internal\r\n */\r\nexport class PolylineFlags {\r\n  public isDisjoint: boolean;\r\n  public isPlanar: boolean;\r\n  public is2d: boolean;\r\n  public type: PolylineTypeFlags;\r\n\r\n  public constructor(is2d = false, isPlanar = false, isDisjoint = false, type = PolylineTypeFlags.Normal) {\r\n    this.isDisjoint = isDisjoint;\r\n    this.isPlanar = isPlanar;\r\n    this.is2d = is2d;\r\n    this.type = type;\r\n  }\r\n\r\n  public clone(): PolylineFlags { return new PolylineFlags(this.is2d, this.isPlanar, this.isDisjoint, this.type); }\r\n\r\n  /** Create a PolylineFlags from a serialized numeric representation. */\r\n  public static unpack(value: number): PolylineFlags {\r\n    const isDisjoint = 0 !== (value & 1);\r\n    const isPlanar = 0 !== (value & 2);\r\n    const is2d = 0 !== (value & 4);\r\n    const type: PolylineTypeFlags = (value >> 3);\r\n    assert(type === PolylineTypeFlags.Normal || type === PolylineTypeFlags.Edge || type === PolylineTypeFlags.Outline);\r\n\r\n    return new PolylineFlags(is2d, isPlanar, isDisjoint, type);\r\n  }\r\n\r\n  public initDefaults() {\r\n    this.isDisjoint = this.isPlanar = this.is2d = false;\r\n    this.type = PolylineTypeFlags.Normal;\r\n  }\r\n\r\n  public get isOutlineEdge(): boolean { return PolylineTypeFlags.Outline === this.type; }\r\n  public get isNormalEdge(): boolean { return PolylineTypeFlags.Edge === this.type; }\r\n  public get isAnyEdge(): boolean { return PolylineTypeFlags.Normal !== this.type; }\r\n  public setIsNormalEdge(): void { this.type = PolylineTypeFlags.Edge; }\r\n  public setIsOutlineEdge(): void { this.type = PolylineTypeFlags.Outline; }\r\n\r\n  /** Convert these flags to a numeric representation for serialization. */\r\n  public pack(): number {\r\n    let val: number = 0;\r\n    if (this.isDisjoint)\r\n      val += 1;\r\n    if (this.isPlanar)\r\n      val += 1 << 1;\r\n    if (this.is2d)\r\n      val += 1 << 2;\r\n    val += (this.type as number) << 3;\r\n    return val;\r\n  }\r\n\r\n  public equals(other: PolylineFlags) {\r\n    return this.type === other.type && this.is2d === other.is2d && this.isPlanar === other.isPlanar && this.isDisjoint === other.isDisjoint;\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class PolylineData {\r\n  public vertIndices: number[];\r\n  public numIndices: number;\r\n  public constructor(vertIndices: number[] = [], numIndices = 0) {\r\n    this.vertIndices = vertIndices;\r\n    this.numIndices = numIndices;\r\n  }\r\n  public get isValid(): boolean { return 0 < this.numIndices; }\r\n  public reset(): void {\r\n    this.numIndices = 0;\r\n    this.vertIndices = [];\r\n  }\r\n\r\n  public init(polyline: MeshPolyline) {\r\n    this.numIndices = polyline.indices.length;\r\n    this.vertIndices = 0 < this.numIndices ? polyline.indices : [];\r\n    return this.isValid;\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class MeshPolyline {\r\n  public readonly indices: number[];\r\n  public constructor(indices: number[] = []) {\r\n    this.indices = indices.slice();\r\n  }\r\n  public addIndex(index: number) {\r\n    const { indices } = this;\r\n    if (indices.length === 0 || indices[indices.length - 1] !== index)\r\n      indices.push(index);\r\n  }\r\n  public clear() { this.indices.length = 0; }\r\n}\r\n\r\n/** @internal */\r\nexport class MeshPolylineList extends Array<MeshPolyline> {\r\n  constructor(...args: MeshPolyline[]) {\r\n    super(...args);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class MeshEdge {\r\n  public indices = [0, 0];\r\n\r\n  public constructor(index0?: number, index1?: number) {\r\n    if (undefined === index0 || undefined === index1)\r\n      return;\r\n    if (index0 < index1) {\r\n      this.indices[0] = index0;\r\n      this.indices[1] = index1;\r\n    } else {\r\n      this.indices[0] = index1;\r\n      this.indices[1] = index0;\r\n    }\r\n  }\r\n\r\n  public compareTo(other: MeshEdge): number {\r\n    let diff = this.indices[0] - other.indices[0];\r\n    if (0 === diff)\r\n      diff = this.indices[1] - other.indices[1];\r\n\r\n    return diff;\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class MeshEdges {\r\n  public visible: MeshEdge[] = [];\r\n  public silhouette: MeshEdge[] = [];\r\n  public polylines: MeshPolylineList = new MeshPolylineList();\r\n  public silhouetteNormals: OctEncodedNormalPair[] = [];\r\n  public constructor() { }\r\n}\r\n\r\n/** @internal */\r\nexport class EdgeArgs {\r\n  public edges?: MeshEdge[];\r\n\r\n  public init(meshEdges?: MeshEdges): boolean {\r\n    this.clear();\r\n    if (undefined !== meshEdges && 0 < meshEdges.visible.length)\r\n      this.edges = meshEdges.visible;\r\n\r\n    return this.isValid;\r\n  }\r\n\r\n  public clear(): void { this.edges = undefined; }\r\n  public get isValid(): boolean { return 0 < this.numEdges; }\r\n  public get numEdges() { return undefined !== this.edges ? this.edges.length : 0; }\r\n}\r\n\r\n/** @internal */\r\nexport class SilhouetteEdgeArgs extends EdgeArgs {\r\n  public normals?: OctEncodedNormalPair[];\r\n\r\n  public override init(meshEdges?: MeshEdges) {\r\n    this.clear();\r\n    if (undefined !== meshEdges && 0 < meshEdges.silhouette.length) {\r\n      this.edges = meshEdges.silhouette;\r\n      this.normals = meshEdges.silhouetteNormals;\r\n    }\r\n\r\n    return this.isValid;\r\n  }\r\n\r\n  public override clear() {\r\n    this.normals = undefined;\r\n    super.clear();\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class PolylineEdgeArgs {\r\n  public lines?: PolylineData[];\r\n\r\n  public constructor(lines?: PolylineData[]) { this.init(lines); }\r\n\r\n  public init(lines?: PolylineData[]): boolean {\r\n    this.lines = undefined !== lines && 0 < lines.length ? lines : undefined;\r\n    return this.isValid;\r\n  }\r\n\r\n  public get numLines() { return undefined !== this.lines ? this.lines.length : 0; }\r\n  public get isValid() { return this.numLines > 0; }\r\n  public clear() { this.lines = undefined; }\r\n}\r\n"]}
+{"version":3,"file":"Render.js","sourceRoot":"","sources":["../../src/Render.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH,qBAAqB;AAErB;;GAEG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,yDAAa,CAAA;IACb,+DAAgB,CAAA;AAClB,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAyBD,gBAAgB;AAChB,MAAa,YAAY;IAGvB,YAAmB,UAA2B,EAAE;QAC9C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC3B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK;YAC/D,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAEM,KAAK,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;CAC5C;AAdD,oCAcC;AAED,gBAAgB;AAChB,MAAa,gBAAiB,SAAQ,KAAmB;IACvD,YAAY,GAAG,IAAoB;QACjC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACjB,CAAC;CACF;AAJD,4CAIC;AAED,gBAAgB;AAChB,MAAa,QAAQ;IAGnB,YAAmB,MAAe,EAAE,MAAe;QAF5C,YAAO,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAGtB,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,MAAM;YAC9C,OAAO;QACT,IAAI,MAAM,GAAG,MAAM,EAAE;YACnB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;SAC1B;IACH,CAAC;IAEM,SAAS,CAAC,KAAe;QAC9B,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,IAAI;YACZ,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtBD,4BAsBC;AAED,gBAAgB;AAChB,MAAa,SAAS;IAKpB;QAJO,YAAO,GAAe,EAAE,CAAC;QACzB,eAAU,GAAe,EAAE,CAAC;QAC5B,cAAS,GAAqB,IAAI,gBAAgB,EAAE,CAAC;QACrD,sBAAiB,GAA2B,EAAE,CAAC;IAC/B,CAAC;CACzB;AAND,8BAMC;AAED,gBAAgB;AAChB,MAAa,QAAQ;IAGZ,IAAI,CAAC,SAAqB;QAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM;YACzD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC;QAEjC,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,KAAK,KAAW,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC;IAChD,IAAW,OAAO,KAAc,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3D,IAAW,QAAQ,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACnF;AAdD,4BAcC;AAED,gBAAgB;AAChB,MAAa,kBAAmB,SAAQ,QAAQ;IAG9B,IAAI,CAAC,SAAqB;QACxC,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE;YAC9D,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,iBAAiB,CAAC;SAC5C;QAED,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEe,KAAK;QACnB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;CACF;AAjBD,gDAiBC;AAED,gBAAgB;AAChB,MAAa,gBAAgB;IAG3B,YAAmB,KAAyB,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAE5D,IAAI,CAAC,KAAyB;QACnC,IAAI,CAAC,KAAK,GAAG,SAAS,KAAK,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAW,QAAQ,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClF,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;IAC3C,KAAK,KAAK,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC;CAC3C;AAbD,4CAaC","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 Rendering\r\n */\r\n\r\nimport { OctEncodedNormalPair } from \"./OctEncodedNormal\";\r\n\r\n// cSpell:ignore vals\r\n\r\n/** Describes the semantics of a [PolylineArgs]($frontend).\r\n * @alpha\r\n */\r\nexport enum PolylineTypeFlags {\r\n  Normal = 0,      // Just an ordinary polyline\r\n  Edge = 1 << 0, // A polyline used to define the edges of a planar region.\r\n  Outline = 1 << 1, // Like Edge, but the edges are only displayed in wireframe mode when surface fill is undisplayed.\r\n}\r\n\r\n/** Flags describing a [PolylineArgs]($frontend).\r\n * @public\r\n */\r\nexport interface PolylineFlags {\r\n  /** If `true`, the polylines are to be drawn as individual disconnected point strings instead of as connected line strings. */\r\n  isDisjoint?: boolean;\r\n  /** If `true`, the polylines' positions are all coplanar. */\r\n  isPlanar?: boolean;\r\n  /** If `true`, the polylines' positions all have the same z coordinate. */\r\n  is2d?: boolean;\r\n  /** Default: Normal.\r\n   * @alpha\r\n   */\r\n  type?: PolylineTypeFlags;\r\n}\r\n\r\n/** Describes the vertex indices of a single line within a [PolylineArgs]($frontend).\r\n * The indices represent either a line string as a connected series of points, or a point string as a set of disconnected points, depending\r\n * on the [[PolylineFlags.isDisjoint]] value of [PolylineArgs.flags]($frontend).\r\n * @public\r\n */\r\nexport type PolylineIndices = number[];\r\n\r\n/** @internal */\r\nexport class MeshPolyline {\r\n  public readonly indices: PolylineIndices;\r\n\r\n  public constructor(indices: PolylineIndices = []) {\r\n    this.indices = indices.slice();\r\n  }\r\n\r\n  public addIndex(index: number) {\r\n    const { indices } = this;\r\n    if (indices.length === 0 || indices[indices.length - 1] !== index)\r\n      indices.push(index);\r\n  }\r\n\r\n  public clear() { this.indices.length = 0; }\r\n}\r\n\r\n/** @internal */\r\nexport class MeshPolylineList extends Array<MeshPolyline> {\r\n  constructor(...args: MeshPolyline[]) {\r\n    super(...args);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class MeshEdge {\r\n  public indices = [0, 0];\r\n\r\n  public constructor(index0?: number, index1?: number) {\r\n    if (undefined === index0 || undefined === index1)\r\n      return;\r\n    if (index0 < index1) {\r\n      this.indices[0] = index0;\r\n      this.indices[1] = index1;\r\n    } else {\r\n      this.indices[0] = index1;\r\n      this.indices[1] = index0;\r\n    }\r\n  }\r\n\r\n  public compareTo(other: MeshEdge): number {\r\n    let diff = this.indices[0] - other.indices[0];\r\n    if (0 === diff)\r\n      diff = this.indices[1] - other.indices[1];\r\n\r\n    return diff;\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class MeshEdges {\r\n  public visible: MeshEdge[] = [];\r\n  public silhouette: MeshEdge[] = [];\r\n  public polylines: MeshPolylineList = new MeshPolylineList();\r\n  public silhouetteNormals: OctEncodedNormalPair[] = [];\r\n  public constructor() { }\r\n}\r\n\r\n/** @internal */\r\nexport class EdgeArgs {\r\n  public edges?: MeshEdge[];\r\n\r\n  public init(meshEdges?: MeshEdges): boolean {\r\n    this.clear();\r\n    if (undefined !== meshEdges && 0 < meshEdges.visible.length)\r\n      this.edges = meshEdges.visible;\r\n\r\n    return this.isValid;\r\n  }\r\n\r\n  public clear(): void { this.edges = undefined; }\r\n  public get isValid(): boolean { return 0 < this.numEdges; }\r\n  public get numEdges() { return undefined !== this.edges ? this.edges.length : 0; }\r\n}\r\n\r\n/** @internal */\r\nexport class SilhouetteEdgeArgs extends EdgeArgs {\r\n  public normals?: OctEncodedNormalPair[];\r\n\r\n  public override init(meshEdges?: MeshEdges) {\r\n    this.clear();\r\n    if (undefined !== meshEdges && 0 < meshEdges.silhouette.length) {\r\n      this.edges = meshEdges.silhouette;\r\n      this.normals = meshEdges.silhouetteNormals;\r\n    }\r\n\r\n    return this.isValid;\r\n  }\r\n\r\n  public override clear() {\r\n    this.normals = undefined;\r\n    super.clear();\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class PolylineEdgeArgs {\r\n  public lines?: PolylineIndices[];\r\n\r\n  public constructor(lines?: PolylineIndices[]) { this.init(lines); }\r\n\r\n  public init(lines?: PolylineIndices[]): boolean {\r\n    this.lines = undefined !== lines && 0 < lines.length ? lines : undefined;\r\n    return this.isValid;\r\n  }\r\n\r\n  public get numLines() { return undefined !== this.lines ? this.lines.length : 0; }\r\n  public get isValid() { return this.numLines > 0; }\r\n  public clear() { this.lines = undefined; }\r\n}\r\n"]}

package/lib/cjs/RpcInterface.d.ts

@@ -33,7 +33,7 @@ export declare abstract class RpcInterface {
     readonly configuration: RpcConfiguration;
     /** @internal */
     readonly routing: RpcRoutingToken;
-    /** @internal */
+    /** @beta */
     constructor(routing?: RpcRoutingToken);
     /** Obtains the implementation result for an RPC operation. */
     forward<T = any>(parameters: IArguments): Promise<T>;

package/lib/cjs/RpcInterface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RpcInterface.d.ts","sourceRoot":"","sources":["../../src/RpcInterface.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAGzF,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAW7D;;;;GAIG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY;IAAI,SAAS,EAAE,CAAC,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAA;CAAE;AAEhJ;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI,UAAU,CAAC,CAAC;AAS5F;;;GAGG;AACH,8BAAsB,YAAY;IAEhC,OAAO,CAAC,MAAM,CAAC,QAAQ;IAIvB,OAAO,CAAC,MAAM,CAAC,QAAQ;IAYvB,8JAA8J;WAChJ,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAmB7E;;OAEG;IACH,SAAgB,aAAa,EAAE,gBAAgB,CAAC;IAEhD,gBAAgB;IAChB,SAAgB,OAAO,EAAE,eAAe,CAAC;IAEzC,gBAAgB;gBACG,OAAO,GAAE,eAAyC;IAKrE,8DAA8D;IACjD,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC;IAgBjE,gBAAgB;IACT,qBAAqB,EAAE,wBAAwB,GAAG,SAAS,CAAC;CACpE"}
+{"version":3,"file":"RpcInterface.d.ts","sourceRoot":"","sources":["../../src/RpcInterface.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAGzF,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAW7D;;;;GAIG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY;IAAI,SAAS,EAAE,CAAC,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAA;CAAE;AAEhJ;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI,UAAU,CAAC,CAAC;AAS5F;;;GAGG;AACH,8BAAsB,YAAY;IAEhC,OAAO,CAAC,MAAM,CAAC,QAAQ;IAQvB,OAAO,CAAC,MAAM,CAAC,QAAQ;IAYvB,8JAA8J;WAChJ,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAwB7E;;OAEG;IACH,SAAgB,aAAa,EAAE,gBAAgB,CAAC;IAEhD,gBAAgB;IAChB,SAAgB,OAAO,EAAE,eAAe,CAAC;IAEzC,YAAY;gBACO,OAAO,GAAE,eAAyC;IAKrE,8DAA8D;IACjD,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC;IAgBjE,gBAAgB;IACT,qBAAqB,EAAE,wBAAwB,GAAG,SAAS,CAAC;CACpE"}

package/lib/cjs/RpcInterface.js

@@ -22,41 +22,42 @@ const core_bentley_1 = require("@itwin/core-bentley");
  */
 class RpcInterface {
     static findDiff(backend, frontend) {
-        return backend.major !== frontend.major ? "major" : backend.minor !== frontend.minor ? "minor" : backend.patch !== frontend.patch ? "patch" : backend.prerelease !== frontend.prerelease ? "prerelease" : "same";
+        return backend.major !== frontend.major ? "major" :
+            backend.minor !== frontend.minor ? "minor" :
+                backend.patch !== frontend.patch ? "patch" :
+                    backend.prerelease !== frontend.prerelease ? "prerelease" :
+                        "same";
     }
     static parseVer(version) {
-        // Split the version string into major.minor.path and prerelease tag
-        const split = version.split(/[:-]/);
-        // Split the major.minor.path into seperate components
-        const prefix = split[0].split(".");
-        if (split.length === 1) {
-            return { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]) };
-        }
-        else {
-            return { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]), prerelease: split[1] };
-        }
+        // separate the version from the prerelease tag
+        const parts = version.split(/[:-]/);
+        // Split the major.minor.path into separate components
+        const prefix = parts[0].split(".");
+        const ver = { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]) };
+        if (parts.length > 1)
+            ver.prerelease = parts[1];
+        return ver;
     }
     /** Determines whether the backend version of an RPC interface is compatible (according to semantic versioning) with the frontend version of the interface. */
     static isVersionCompatible(backend, frontend) {
+        if (backend === frontend)
+            return true; // most common case, versions are identical
         const backendSemver = this.parseVer(backend);
         const frontendSemver = this.parseVer(frontend);
+        // if either has a prerelease tag, they are not compatible unless version strings are identical
+        if (backendSemver.prerelease || frontendSemver.prerelease)
+            return false;
         const difference = this.findDiff(backendSemver, frontendSemver);
         // If the major versions are different, the versions are not compatible
-        // In the case of prerelease tags, they are compatible if the whole version string matches, otherwise it fails
-        if ((backendSemver.prerelease !== undefined || frontendSemver.prerelease !== undefined) || difference === "major") {
-            return difference === "same";
-        }
-        else if (backendSemver.major === 0 || frontendSemver.major === 0) {
-            // If the major and minor versions match and major versions are 0, compatible as long as backend patch version is greater
-            return difference === "same" || (difference === "patch" && frontendSemver.patch < backendSemver.patch);
-        }
-        else {
-            // If the strings match exactly, major and minor match but patch differs, versions are compatible
-            // If minor versions differ, compatible as long as backend patch versionn is greater
-            return difference === "same" || difference === "patch" || (difference === "minor" && frontendSemver.minor < backendSemver.minor);
-        }
+        if (difference === "major")
+            return false;
+        // special case for major version 0. If patch difference, backend patch must be greater than frontend patch
+        if (backendSemver.major === 0)
+            return (difference === "patch" && frontendSemver.patch < backendSemver.patch);
+        // patch difference is fine. If minor versions differ, compatible as long as backend minor version is greater
+        return difference === "patch" || (difference === "minor" && frontendSemver.minor < backendSemver.minor);
     }
-    /** @internal */
+    /** @beta */
     constructor(routing = RpcRoutingToken_1.RpcRoutingToken.default) {
         this.routing = routing;
         this.configuration = RpcConfiguration_1.RpcConfiguration.supply(this);

package/lib/cjs/RpcInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcInterface.js","sourceRoot":"","sources":["../../src/RpcInterface.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,kEAAyF;AACzF,wDAAyD;AACzD,sDAAkE;AAClE,gEAA6D;AAC7D,iDAAqE;AAGrE,+CAA2E;AAC3E,0DAA4E;AAC5E,sDAAiD;AAyBjD;;;GAGG;AACH,MAAsB,YAAY;IAExB,MAAM,CAAC,QAAQ,CAAC,OAAmB,EAAE,QAAoB;QAC/D,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC;IACnN,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,OAAe;QACrC,oEAAoE;QACpE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,sDAAsD;QACtD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACtB,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACzF;aAAM;YACL,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;SAC/G;IACH,CAAC;IAED,8JAA8J;IACvJ,MAAM,CAAC,mBAAmB,CAAC,OAAe,EAAE,QAAgB;QACjE,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAEhE,uEAAuE;QACvE,8GAA8G;QAC9G,IAAI,CAAC,aAAa,CAAC,UAAU,KAAK,SAAS,IAAI,cAAc,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,UAAU,KAAK,OAAO,EAAE;YACjH,OAAO,UAAU,KAAK,MAAM,CAAC;SAC9B;aAAM,IAAI,aAAa,CAAC,KAAK,KAAK,CAAC,IAAI,cAAc,CAAC,KAAK,KAAK,CAAC,EAAE;YAClE,yHAAyH;YACzH,OAAO,UAAU,KAAK,MAAM,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,cAAc,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;SACxG;aAAM;YACL,iGAAiG;YACjG,oFAAoF;YACpF,OAAO,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,OAAO,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,cAAc,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;SAClI;IACH,CAAC;IAUD,gBAAgB;IAChB,YAAmB,UAA2B,iCAAe,CAAC,OAAO;QACnE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,mCAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,8DAA8D;IACvD,KAAK,CAAC,OAAO,CAAU,UAAsB;QAClD,MAAM,gBAAgB,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/G,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC1H,MAAM,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;QAE5C,MAAM,OAAO,GAAG,uBAAU,CAAC,MAAM,CAAC;QAClC,IAAI,OAAO,EAAE;YACX,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;SACjE;aAAM;YACL,MAAM,OAAO,GAAG,IAAK,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,WAAmB,CAAC,IAAI,EAAE,aAAa,EAAE,eAAe,CAAe,CAAC;YACzH,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,8DAA8D;YAC/E,IAAY,CAAC,6BAAe,CAAC,GAAG,OAAO,CAAC;YACzC,OAAO,OAAO,CAAC,QAAQ,CAAC;SACzB;IACH,CAAC;CAIF;AAvED,oCAuEC;AAED,YAAY,CAAC,SAAS,CAAC,qBAAqB,GAAG,SAAS,CAAC;AAEzD,MAAM,kBAAmB,SAAQ,uBAAU;IACtB,KAAK,CAAC,IAAI,KAAkC,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IAChE,KAAK,CAAC,IAAI,KAAsB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IACpD,SAAS,CAAC,KAAa,EAAE,MAAc,IAAU,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;CACzF;AAED,KAAK,UAAU,SAAS,CAAC,OAAmB,EAAE,MAAoB,EAAE,SAAiB,EAAE,UAAiB;IACtG,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAC7D,MAAc,CAAC,6BAAe,CAAC,GAAG,OAAO,CAAC;IAE3C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACvE,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;IAEhC,MAAM,IAAI,GAA0B;QAClC,UAAU,EAAE;YACV,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,mBAAmB;YACpD,gBAAgB,EAAE,OAAO,CAAC,SAAS,CAAC,gBAAgB;SACrD;QACD,SAAS;QACT,UAAU;QACV,OAAO,EAAE;YACP,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;YAC9C,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,eAAe,EAAE,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC3D;KACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC1B,0BAAa,CAAC,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAE/C,0BAAa,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAElD,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,QAAQ,IAAI,QAAQ,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;YACjI,MAAM,MAAM,GAAqB,QAAQ,CAAC;YAE1C,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtC,OAAO,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;aACjD;iBAAM,IAAI,MAAM,CAAC,aAAa,KAAK,UAAU,EAAE;gBAC9C,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;aAClD;iBAAM,IAAI,MAAM,CAAC,aAAa,KAAK,WAAW,EAAE;gBAC/C,OAAO,eAAe,EAAE,CAAC;aAC1B;SACF;aAAM;YACL,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC,CAAC;IAEF,OAAO,QAAQ,EAAE,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,OAA2B,EAAE,MAAwB,EAAE,QAA4B;IAC9G,OAAO,CAAC,OAAO,GAAG,+BAAgB,CAAC,OAAO,CAAC;IAC3C,OAAO,CAAC,eAAe,GAAI,MAAM,CAAC,aAAqC,CAAC,OAAO,CAAC;IAChF,uBAAU,CAAC,MAAM,CAAC,UAAU,CAAC,8BAAe,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAE7E,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAEnF,MAAM,yBAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,OAAO,QAAQ,EAAE,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,OAA2B,EAAE,MAAwB,EAAE,QAA4B;IAC/G,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,uBAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,aAAoC,EAAE,KAAK,IAAI,EAAE;YACtG,IAAI,WAAW,EAAE;gBACf,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,yCAAyC,CAAC,CAAC;aACvF;YAED,WAAW,GAAG,IAAI,CAAC;YAEnB,IAAI;gBACF,MAAM,QAAQ,GAAG,MAAM,QAAQ,EAAE,CAAC;gBAClC,OAAO,CAAC,QAAQ,CAAC,CAAC;aACnB;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,GAAG,CAAC,CAAC;aACb;QACH,CAAC,EAAE,MAAM,CAAC,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,eAAe;IAC5B,MAAM,IAAI,4BAAc,EAAE,CAAC;AAC7B,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 RpcInterface\r\n */\r\nimport { RpcConfiguration, RpcConfigurationSupplier } from \"./rpc/core/RpcConfiguration\";\r\nimport { CURRENT_REQUEST } from \"./rpc/core/RpcRegistry\";\r\nimport { aggregateLoad, RpcRequest } from \"./rpc/core/RpcRequest\";\r\nimport { RpcRoutingToken } from \"./rpc/core/RpcRoutingToken\";\r\nimport { InterceptedRpcRequest, IpcSession } from \"./ipc/IpcSession\";\r\nimport { RpcSerializedValue } from \"./rpc/core/RpcMarshaling\";\r\nimport { RpcManagedStatus } from \"./rpc/core/RpcProtocol\";\r\nimport { BentleyStatus, IModelError, NoContentError } from \"./IModelError\";\r\nimport { RpcRequestEvent, RpcRequestStatus } from \"./rpc/core/RpcConstants\";\r\nimport { BeDuration } from \"@itwin/core-bentley\";\r\nimport { RpcNotFoundResponse } from \"./rpc/core/RpcControl\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/**\r\n * Specifies the required static properties of an RpcInterface class.\r\n * These properties are used to identify RPC requests and responses.\r\n * @beta\r\n */\r\nexport interface RpcInterfaceDefinition<T extends RpcInterface = RpcInterface> { prototype: T, interfaceName: string, interfaceVersion: string }\r\n\r\n/**\r\n * A class that implements the operations of an RPC interface.\r\n * @beta\r\n */\r\nexport type RpcInterfaceImplementation<T extends RpcInterface = RpcInterface> = new () => T;\r\n\r\ninterface SemverType {\r\n  major: number;\r\n  minor: number;\r\n  patch: number;\r\n  prerelease?: string;\r\n}\r\n\r\n/** An RPC interface is a set of operations exposed by a service that a client can call, using configurable protocols,\r\n * in a platform-independent way. TheRpcInterface class is the base class for RPC interface definitions and implementations.\r\n * @public\r\n */\r\nexport abstract class RpcInterface {\r\n\r\n  private static findDiff(backend: SemverType, frontend: SemverType) {\r\n    return backend.major !== frontend.major ? \"major\" : backend.minor !== frontend.minor ? \"minor\" : backend.patch !== frontend.patch ? \"patch\" : backend.prerelease !== frontend.prerelease ? \"prerelease\" : \"same\";\r\n  }\r\n\r\n  private static parseVer(version: string): SemverType {\r\n    // Split the version string into major.minor.path and prerelease tag\r\n    const split = version.split(/[:-]/);\r\n    // Split the major.minor.path into seperate components\r\n    const prefix = split[0].split(\".\");\r\n    if (split.length === 1) {\r\n      return { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]) };\r\n    } else {\r\n      return { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]), prerelease: split[1] };\r\n    }\r\n  }\r\n\r\n  /** Determines whether the backend version of an RPC interface is compatible (according to semantic versioning) with the frontend version of the interface. */\r\n  public static isVersionCompatible(backend: string, frontend: string): boolean {\r\n    const backendSemver = this.parseVer(backend);\r\n    const frontendSemver = this.parseVer(frontend);\r\n    const difference = this.findDiff(backendSemver, frontendSemver);\r\n\r\n    // If the major versions are different, the versions are not compatible\r\n    // In the case of prerelease tags, they are compatible if the whole version string matches, otherwise it fails\r\n    if ((backendSemver.prerelease !== undefined || frontendSemver.prerelease !== undefined) || difference === \"major\") {\r\n      return difference === \"same\";\r\n    } else if (backendSemver.major === 0 || frontendSemver.major === 0) {\r\n      // If the major and minor versions match and major versions are 0, compatible as long as backend patch version is greater\r\n      return difference === \"same\" || (difference === \"patch\" && frontendSemver.patch < backendSemver.patch);\r\n    } else {\r\n      // If the strings match exactly, major and minor match but patch differs, versions are compatible\r\n      // If minor versions differ, compatible as long as backend patch versionn is greater\r\n      return difference === \"same\" || difference === \"patch\" || (difference === \"minor\" && frontendSemver.minor < backendSemver.minor);\r\n    }\r\n  }\r\n\r\n  /** The configuration for the RPC interface.\r\n   * @internal\r\n   */\r\n  public readonly configuration: RpcConfiguration;\r\n\r\n  /** @internal */\r\n  public readonly routing: RpcRoutingToken;\r\n\r\n  /** @internal */\r\n  public constructor(routing: RpcRoutingToken = RpcRoutingToken.default) {\r\n    this.routing = routing;\r\n    this.configuration = RpcConfiguration.supply(this);\r\n  }\r\n\r\n  /** Obtains the implementation result for an RPC operation. */\r\n  public async forward<T = any>(parameters: IArguments): Promise<T> {\r\n    const parametersCompat = (arguments.length === 1 && typeof (parameters) === \"object\") ? parameters : arguments;\r\n    const parametersArray = Array.isArray(parametersCompat) ? parametersCompat : Array.prototype.slice.call(parametersCompat);\r\n    const operationName = parametersArray.pop();\r\n\r\n    const session = IpcSession.active;\r\n    if (session) {\r\n      return intercept(session, this, operationName, parametersArray);\r\n    } else {\r\n      const request = new (this.configuration.protocol.requestType as any)(this, operationName, parametersArray) as RpcRequest;\r\n      request.submit(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      (this as any)[CURRENT_REQUEST] = request;\r\n      return request.response;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public configurationSupplier: RpcConfigurationSupplier | undefined;\r\n}\r\n\r\nRpcInterface.prototype.configurationSupplier = undefined;\r\n\r\nclass InterceptedRequest extends RpcRequest {\r\n  protected override async load(): Promise<RpcSerializedValue> { throw new Error(); }\r\n  protected override async send(): Promise<number> { throw new Error(); }\r\n  protected override setHeader(_name: string, _value: string): void { throw new Error(); }\r\n}\r\n\r\nasync function intercept(session: IpcSession, client: RpcInterface, operation: string, parameters: any[]) {\r\n  const request = new InterceptedRequest(client, operation, []);\r\n  (client as any)[CURRENT_REQUEST] = request;\r\n\r\n  const context = await client.configuration.protocol.serialize(request);\r\n  request.parameters = parameters;\r\n\r\n  const info: InterceptedRpcRequest = {\r\n    definition: {\r\n      interfaceName: context.operation.interfaceDefinition,\r\n      interfaceVersion: context.operation.interfaceVersion,\r\n    },\r\n    operation,\r\n    parameters,\r\n    context: {\r\n      applicationId: context.applicationId,\r\n      applicationVersion: context.applicationVersion,\r\n      id: context.id,\r\n      sessionId: context.sessionId,\r\n      protocolVersion: (context.protocolVersion || 0).toString(),\r\n    },\r\n  };\r\n\r\n  const dispatch = async () => {\r\n    aggregateLoad.lastRequest = new Date().getTime();\r\n\r\n    const response = await session.handleRpc(info);\r\n\r\n    aggregateLoad.lastResponse = new Date().getTime();\r\n\r\n    if (typeof (response) === \"object\" && response.hasOwnProperty(\"iTwinRpcCoreResponse\") && response.hasOwnProperty(\"managedStatus\")) {\r\n      const status: RpcManagedStatus = response;\r\n\r\n      if (status.managedStatus === \"pending\") {\r\n        return handlePending(request, status, dispatch);\r\n      } else if (status.managedStatus === \"notFound\") {\r\n        return handleNotFound(request, status, dispatch);\r\n      } else if (status.managedStatus === \"noContent\") {\r\n        return handleNoContent();\r\n      }\r\n    } else {\r\n      return response;\r\n    }\r\n  };\r\n\r\n  return dispatch();\r\n}\r\n\r\nasync function handlePending(request: InterceptedRequest, status: RpcManagedStatus, dispatch: () => Promise<any>) {\r\n  request._status = RpcRequestStatus.Pending;\r\n  request._extendedStatus = (status.responseValue as { message: string }).message;\r\n  RpcRequest.events.raiseEvent(RpcRequestEvent.PendingUpdateReceived, request);\r\n\r\n  const delay = request.operation.policy.retryInterval(request.client.configuration);\r\n\r\n  await BeDuration.wait(delay);\r\n  return dispatch();\r\n}\r\n\r\nasync function handleNotFound(request: InterceptedRequest, status: RpcManagedStatus, dispatch: () => Promise<any>) {\r\n  return new Promise((resolve, reject) => {\r\n    let resubmitted = false;\r\n\r\n    RpcRequest.notFoundHandlers.raiseEvent(request, status.responseValue as RpcNotFoundResponse, async () => {\r\n      if (resubmitted) {\r\n        throw new IModelError(BentleyStatus.ERROR, `Already resubmitted using this handler.`);\r\n      }\r\n\r\n      resubmitted = true;\r\n\r\n      try {\r\n        const response = await dispatch();\r\n        resolve(response);\r\n      } catch (err) {\r\n        reject(err);\r\n      }\r\n    }, reject);\r\n  });\r\n}\r\n\r\nasync function handleNoContent() {\r\n  throw new NoContentError();\r\n}\r\n"]}
+{"version":3,"file":"RpcInterface.js","sourceRoot":"","sources":["../../src/RpcInterface.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,kEAAyF;AACzF,wDAAyD;AACzD,sDAAkE;AAClE,gEAA6D;AAC7D,iDAAqE;AAGrE,+CAA2E;AAC3E,0DAA4E;AAC5E,sDAAiD;AAyBjD;;;GAGG;AACH,MAAsB,YAAY;IAExB,MAAM,CAAC,QAAQ,CAAC,OAAmB,EAAE,QAAoB;QAC/D,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACjD,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBAC1C,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;oBAC1C,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;wBACzD,MAAM,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,OAAe;QACrC,+CAA+C;QAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,sDAAsD;QACtD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEnC,MAAM,GAAG,GAAe,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzG,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAClB,GAAG,CAAC,UAAU,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,8JAA8J;IACvJ,MAAM,CAAC,mBAAmB,CAAC,OAAe,EAAE,QAAgB;QACjE,IAAI,OAAO,KAAK,QAAQ;YACtB,OAAO,IAAI,CAAC,CAAC,2CAA2C;QAE1D,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE/C,+FAA+F;QAC/F,IAAI,aAAa,CAAC,UAAU,IAAI,cAAc,CAAC,UAAU;YACvD,OAAO,KAAK,CAAC;QAEf,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAChE,uEAAuE;QACvE,IAAI,UAAU,KAAK,OAAO;YACxB,OAAO,KAAK,CAAC;QAEf,2GAA2G;QAC3G,IAAI,aAAa,CAAC,KAAK,KAAK,CAAC;YAC3B,OAAO,CAAC,UAAU,KAAK,OAAO,IAAI,cAAc,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAEhF,6GAA6G;QAC7G,OAAO,UAAU,KAAK,OAAO,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,cAAc,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IAC1G,CAAC;IAUD,YAAY;IACZ,YAAmB,UAA2B,iCAAe,CAAC,OAAO;QACnE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,mCAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,8DAA8D;IACvD,KAAK,CAAC,OAAO,CAAU,UAAsB;QAClD,MAAM,gBAAgB,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/G,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC1H,MAAM,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;QAE5C,MAAM,OAAO,GAAG,uBAAU,CAAC,MAAM,CAAC;QAClC,IAAI,OAAO,EAAE;YACX,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;SACjE;aAAM;YACL,MAAM,OAAO,GAAG,IAAK,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,WAAmB,CAAC,IAAI,EAAE,aAAa,EAAE,eAAe,CAAe,CAAC;YACzH,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,8DAA8D;YAC/E,IAAY,CAAC,6BAAe,CAAC,GAAG,OAAO,CAAC;YACzC,OAAO,OAAO,CAAC,QAAQ,CAAC;SACzB;IACH,CAAC;CAIF;AAhFD,oCAgFC;AAED,YAAY,CAAC,SAAS,CAAC,qBAAqB,GAAG,SAAS,CAAC;AAEzD,MAAM,kBAAmB,SAAQ,uBAAU;IACtB,KAAK,CAAC,IAAI,KAAkC,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IAChE,KAAK,CAAC,IAAI,KAAsB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IACpD,SAAS,CAAC,KAAa,EAAE,MAAc,IAAU,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;CACzF;AAED,KAAK,UAAU,SAAS,CAAC,OAAmB,EAAE,MAAoB,EAAE,SAAiB,EAAE,UAAiB;IACtG,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAC7D,MAAc,CAAC,6BAAe,CAAC,GAAG,OAAO,CAAC;IAE3C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACvE,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;IAEhC,MAAM,IAAI,GAA0B;QAClC,UAAU,EAAE;YACV,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,mBAAmB;YACpD,gBAAgB,EAAE,OAAO,CAAC,SAAS,CAAC,gBAAgB;SACrD;QACD,SAAS;QACT,UAAU;QACV,OAAO,EAAE;YACP,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;YAC9C,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,eAAe,EAAE,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC3D;KACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC1B,0BAAa,CAAC,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAE/C,0BAAa,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAElD,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,QAAQ,IAAI,QAAQ,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;YACjI,MAAM,MAAM,GAAqB,QAAQ,CAAC;YAE1C,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtC,OAAO,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;aACjD;iBAAM,IAAI,MAAM,CAAC,aAAa,KAAK,UAAU,EAAE;gBAC9C,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;aAClD;iBAAM,IAAI,MAAM,CAAC,aAAa,KAAK,WAAW,EAAE;gBAC/C,OAAO,eAAe,EAAE,CAAC;aAC1B;SACF;aAAM;YACL,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC,CAAC;IAEF,OAAO,QAAQ,EAAE,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,OAA2B,EAAE,MAAwB,EAAE,QAA4B;IAC9G,OAAO,CAAC,OAAO,GAAG,+BAAgB,CAAC,OAAO,CAAC;IAC3C,OAAO,CAAC,eAAe,GAAI,MAAM,CAAC,aAAqC,CAAC,OAAO,CAAC;IAChF,uBAAU,CAAC,MAAM,CAAC,UAAU,CAAC,8BAAe,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAE7E,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAEnF,MAAM,yBAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,OAAO,QAAQ,EAAE,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,OAA2B,EAAE,MAAwB,EAAE,QAA4B;IAC/G,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,uBAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,aAAoC,EAAE,KAAK,IAAI,EAAE;YACtG,IAAI,WAAW,EAAE;gBACf,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,yCAAyC,CAAC,CAAC;aACvF;YAED,WAAW,GAAG,IAAI,CAAC;YAEnB,IAAI;gBACF,MAAM,QAAQ,GAAG,MAAM,QAAQ,EAAE,CAAC;gBAClC,OAAO,CAAC,QAAQ,CAAC,CAAC;aACnB;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,GAAG,CAAC,CAAC;aACb;QACH,CAAC,EAAE,MAAM,CAAC,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,eAAe;IAC5B,MAAM,IAAI,4BAAc,EAAE,CAAC;AAC7B,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 RpcInterface\r\n */\r\nimport { RpcConfiguration, RpcConfigurationSupplier } from \"./rpc/core/RpcConfiguration\";\r\nimport { CURRENT_REQUEST } from \"./rpc/core/RpcRegistry\";\r\nimport { aggregateLoad, RpcRequest } from \"./rpc/core/RpcRequest\";\r\nimport { RpcRoutingToken } from \"./rpc/core/RpcRoutingToken\";\r\nimport { InterceptedRpcRequest, IpcSession } from \"./ipc/IpcSession\";\r\nimport { RpcSerializedValue } from \"./rpc/core/RpcMarshaling\";\r\nimport { RpcManagedStatus } from \"./rpc/core/RpcProtocol\";\r\nimport { BentleyStatus, IModelError, NoContentError } from \"./IModelError\";\r\nimport { RpcRequestEvent, RpcRequestStatus } from \"./rpc/core/RpcConstants\";\r\nimport { BeDuration } from \"@itwin/core-bentley\";\r\nimport { RpcNotFoundResponse } from \"./rpc/core/RpcControl\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/**\r\n * Specifies the required static properties of an RpcInterface class.\r\n * These properties are used to identify RPC requests and responses.\r\n * @beta\r\n */\r\nexport interface RpcInterfaceDefinition<T extends RpcInterface = RpcInterface> { prototype: T, interfaceName: string, interfaceVersion: string }\r\n\r\n/**\r\n * A class that implements the operations of an RPC interface.\r\n * @beta\r\n */\r\nexport type RpcInterfaceImplementation<T extends RpcInterface = RpcInterface> = new () => T;\r\n\r\ninterface SemverType {\r\n  major: number;\r\n  minor: number;\r\n  patch: number;\r\n  prerelease?: string;\r\n}\r\n\r\n/** An RPC interface is a set of operations exposed by a service that a client can call, using configurable protocols,\r\n * in a platform-independent way. TheRpcInterface class is the base class for RPC interface definitions and implementations.\r\n * @public\r\n */\r\nexport abstract class RpcInterface {\r\n\r\n  private static findDiff(backend: SemverType, frontend: SemverType) {\r\n    return backend.major !== frontend.major ? \"major\" :\r\n      backend.minor !== frontend.minor ? \"minor\" :\r\n        backend.patch !== frontend.patch ? \"patch\" :\r\n          backend.prerelease !== frontend.prerelease ? \"prerelease\" :\r\n            \"same\";\r\n  }\r\n\r\n  private static parseVer(version: string): SemverType {\r\n    // separate the version from the prerelease tag\r\n    const parts = version.split(/[:-]/);\r\n    // Split the major.minor.path into separate components\r\n    const prefix = parts[0].split(\".\");\r\n\r\n    const ver: SemverType = { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]) };\r\n    if (parts.length > 1)\r\n      ver.prerelease = parts[1];\r\n    return ver;\r\n  }\r\n\r\n  /** Determines whether the backend version of an RPC interface is compatible (according to semantic versioning) with the frontend version of the interface. */\r\n  public static isVersionCompatible(backend: string, frontend: string): boolean {\r\n    if (backend === frontend)\r\n      return true; // most common case, versions are identical\r\n\r\n    const backendSemver = this.parseVer(backend);\r\n    const frontendSemver = this.parseVer(frontend);\r\n\r\n    // if either has a prerelease tag, they are not compatible unless version strings are identical\r\n    if (backendSemver.prerelease || frontendSemver.prerelease)\r\n      return false;\r\n\r\n    const difference = this.findDiff(backendSemver, frontendSemver);\r\n    // If the major versions are different, the versions are not compatible\r\n    if (difference === \"major\")\r\n      return false;\r\n\r\n    // special case for major version 0. If patch difference, backend patch must be greater than frontend patch\r\n    if (backendSemver.major === 0)\r\n      return (difference === \"patch\" && frontendSemver.patch < backendSemver.patch);\r\n\r\n    // patch difference is fine. If minor versions differ, compatible as long as backend minor version is greater\r\n    return difference === \"patch\" || (difference === \"minor\" && frontendSemver.minor < backendSemver.minor);\r\n  }\r\n\r\n  /** The configuration for the RPC interface.\r\n   * @internal\r\n   */\r\n  public readonly configuration: RpcConfiguration;\r\n\r\n  /** @internal */\r\n  public readonly routing: RpcRoutingToken;\r\n\r\n  /** @beta */\r\n  public constructor(routing: RpcRoutingToken = RpcRoutingToken.default) {\r\n    this.routing = routing;\r\n    this.configuration = RpcConfiguration.supply(this);\r\n  }\r\n\r\n  /** Obtains the implementation result for an RPC operation. */\r\n  public async forward<T = any>(parameters: IArguments): Promise<T> {\r\n    const parametersCompat = (arguments.length === 1 && typeof (parameters) === \"object\") ? parameters : arguments;\r\n    const parametersArray = Array.isArray(parametersCompat) ? parametersCompat : Array.prototype.slice.call(parametersCompat);\r\n    const operationName = parametersArray.pop();\r\n\r\n    const session = IpcSession.active;\r\n    if (session) {\r\n      return intercept(session, this, operationName, parametersArray);\r\n    } else {\r\n      const request = new (this.configuration.protocol.requestType as any)(this, operationName, parametersArray) as RpcRequest;\r\n      request.submit(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      (this as any)[CURRENT_REQUEST] = request;\r\n      return request.response;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public configurationSupplier: RpcConfigurationSupplier | undefined;\r\n}\r\n\r\nRpcInterface.prototype.configurationSupplier = undefined;\r\n\r\nclass InterceptedRequest extends RpcRequest {\r\n  protected override async load(): Promise<RpcSerializedValue> { throw new Error(); }\r\n  protected override async send(): Promise<number> { throw new Error(); }\r\n  protected override setHeader(_name: string, _value: string): void { throw new Error(); }\r\n}\r\n\r\nasync function intercept(session: IpcSession, client: RpcInterface, operation: string, parameters: any[]) {\r\n  const request = new InterceptedRequest(client, operation, []);\r\n  (client as any)[CURRENT_REQUEST] = request;\r\n\r\n  const context = await client.configuration.protocol.serialize(request);\r\n  request.parameters = parameters;\r\n\r\n  const info: InterceptedRpcRequest = {\r\n    definition: {\r\n      interfaceName: context.operation.interfaceDefinition,\r\n      interfaceVersion: context.operation.interfaceVersion,\r\n    },\r\n    operation,\r\n    parameters,\r\n    context: {\r\n      applicationId: context.applicationId,\r\n      applicationVersion: context.applicationVersion,\r\n      id: context.id,\r\n      sessionId: context.sessionId,\r\n      protocolVersion: (context.protocolVersion || 0).toString(),\r\n    },\r\n  };\r\n\r\n  const dispatch = async () => {\r\n    aggregateLoad.lastRequest = new Date().getTime();\r\n\r\n    const response = await session.handleRpc(info);\r\n\r\n    aggregateLoad.lastResponse = new Date().getTime();\r\n\r\n    if (typeof (response) === \"object\" && response.hasOwnProperty(\"iTwinRpcCoreResponse\") && response.hasOwnProperty(\"managedStatus\")) {\r\n      const status: RpcManagedStatus = response;\r\n\r\n      if (status.managedStatus === \"pending\") {\r\n        return handlePending(request, status, dispatch);\r\n      } else if (status.managedStatus === \"notFound\") {\r\n        return handleNotFound(request, status, dispatch);\r\n      } else if (status.managedStatus === \"noContent\") {\r\n        return handleNoContent();\r\n      }\r\n    } else {\r\n      return response;\r\n    }\r\n  };\r\n\r\n  return dispatch();\r\n}\r\n\r\nasync function handlePending(request: InterceptedRequest, status: RpcManagedStatus, dispatch: () => Promise<any>) {\r\n  request._status = RpcRequestStatus.Pending;\r\n  request._extendedStatus = (status.responseValue as { message: string }).message;\r\n  RpcRequest.events.raiseEvent(RpcRequestEvent.PendingUpdateReceived, request);\r\n\r\n  const delay = request.operation.policy.retryInterval(request.client.configuration);\r\n\r\n  await BeDuration.wait(delay);\r\n  return dispatch();\r\n}\r\n\r\nasync function handleNotFound(request: InterceptedRequest, status: RpcManagedStatus, dispatch: () => Promise<any>) {\r\n  return new Promise((resolve, reject) => {\r\n    let resubmitted = false;\r\n\r\n    RpcRequest.notFoundHandlers.raiseEvent(request, status.responseValue as RpcNotFoundResponse, async () => {\r\n      if (resubmitted) {\r\n        throw new IModelError(BentleyStatus.ERROR, `Already resubmitted using this handler.`);\r\n      }\r\n\r\n      resubmitted = true;\r\n\r\n      try {\r\n        const response = await dispatch();\r\n        resolve(response);\r\n      } catch (err) {\r\n        reject(err);\r\n      }\r\n    }, reject);\r\n  });\r\n}\r\n\r\nasync function handleNoContent() {\r\n  throw new NoContentError();\r\n}\r\n"]}

package/lib/cjs/SkyBox.d.ts

@@ -193,7 +193,7 @@ export declare class SkySphere extends SkyBox {
      * @param gradient Optionally overrides the default gradient settings used if the image cannot be obtained.
      */
     constructor(image: TextureImageSpec, gradient?: SkyGradient);
-    /** @internal override */
+    /** See [[SkyBox.toJSON]]. */
     toJSON(display?: boolean): SkyBoxProps;
     /** @internal */
     get textureIds(): Iterable<Id64String>;
@@ -207,10 +207,10 @@ export declare class SkyCube extends SkyBox {
     readonly images: SkyCubeProps;
     /** Create a new sky cube using the specified images.
      * @param images The images to map to each face of the cube.
-     * @param Optionally overrides  the default gradient settings used if the images cannot be obtained.
+     * @param gradient Optionally overrides  the default gradient settings used if the images cannot be obtained.
      */
     constructor(images: SkyCubeProps, gradient?: SkyGradient);
-    /** @internal override */
+    /** See [[SkyBox.toJSON]]. */
     toJSON(display?: boolean): SkyBoxProps;
     /** @internal */
     get textureIds(): Iterable<Id64String>;

package/lib/cjs/SkyBox.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SkyBox.d.ts","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;;GAIG;AACH,oBAAY,eAAe;IACzB,kEAAkE;IAClE,IAAI,IAAI;IACR;;OAEG;IACH,SAAS,IAAI;IACb,kCAAkC;IAClC,WAAW,IAAI;IACf;;OAEG;IACH,IAAI,IAAI;CACT;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;IACvB,GAAG,EAAE,gBAAgB,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC;IAChC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;IAC3B,QAAQ,EAAE,YAAY,CAAC;IACvB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG;IAAE,IAAI,CAAC,EAAE,eAAe,CAAC;IAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEvI;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B;AAYD;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,qBAAa,WAAW;IACtB,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,UAAU,EAAE,QAAQ,CAAC;IACrC,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,cAAc,EAAE,MAAM,CAAC;IAEvC,OAAO;IAUP,kDAAkD;IAClD,gBAAuB,QAAQ,cAAuB;IAEtD,8GAA8G;WAChG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;IAIzE,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,WAAW;IAexD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,qBAAqB,GAAG,WAAW;IAI9D,sCAAsC;IAC/B,MAAM,IAAI,WAAW;IAoB5B,4EAA4E;IACrE,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;CAO3C;AAED;;;GAGG;AACH,qBAAa,MAAM;IACjB,+GAA+G;IAC/G,SAAgB,QAAQ,EAAE,WAAW,CAAC;IAEtC,SAAS,aAAa,QAAQ,EAAE,WAAW;IAI3C,kDAAkD;IAClD,gBAAuB,QAAQ,SAAoC;IAEnE,yGAAyG;WAC3F,cAAc,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,MAAM;IAI5D,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM;IAuBnD;;OAEG;IACI,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAQ7C,gBAAgB;IAChB,IAAW,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAE5C;CACF;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,MAAM;IACnC,sDAAsD;IACtD,SAAgB,KAAK,EAAE,gBAAgB,CAAC;IAExC;;;OAGG;gBACgB,KAAK,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,WAAW;IAKlE,yBAAyB;IACT,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAErD;CACF;AAED;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,MAAM;IACjC,kDAAkD;IAClD,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;;OAGG;gBACgB,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,WAAW;IAK/D,yBAAyB;IACT,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAGrD;CACF"}
+{"version":3,"file":"SkyBox.d.ts","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;;GAIG;AACH,oBAAY,eAAe;IACzB,kEAAkE;IAClE,IAAI,IAAI;IACR;;OAEG;IACH,SAAS,IAAI;IACb,kCAAkC;IAClC,WAAW,IAAI;IACf;;OAEG;IACH,IAAI,IAAI;CACT;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;IACvB,GAAG,EAAE,gBAAgB,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC;IAChC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;IAC3B,QAAQ,EAAE,YAAY,CAAC;IACvB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG;IAAE,IAAI,CAAC,EAAE,eAAe,CAAC;IAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEvI;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B;AAYD;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,qBAAa,WAAW;IACtB,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,UAAU,EAAE,QAAQ,CAAC;IACrC,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,cAAc,EAAE,MAAM,CAAC;IAEvC,OAAO;IAUP,kDAAkD;IAClD,gBAAuB,QAAQ,cAAuB;IAEtD,8GAA8G;WAChG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;IAIzE,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,WAAW;IAexD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,qBAAqB,GAAG,WAAW;IAI9D,sCAAsC;IAC/B,MAAM,IAAI,WAAW;IAoB5B,4EAA4E;IACrE,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;CAO3C;AAED;;;GAGG;AACH,qBAAa,MAAM;IACjB,+GAA+G;IAC/G,SAAgB,QAAQ,EAAE,WAAW,CAAC;IAEtC,SAAS,aAAa,QAAQ,EAAE,WAAW;IAI3C,kDAAkD;IAClD,gBAAuB,QAAQ,SAAoC;IAEnE,yGAAyG;WAC3F,cAAc,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,MAAM;IAI5D,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM;IAuBnD;;OAEG;IACI,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAQ7C,gBAAgB;IAChB,IAAW,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAE5C;CACF;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,MAAM;IACnC,sDAAsD;IACtD,SAAgB,KAAK,EAAE,gBAAgB,CAAC;IAExC;;;OAGG;gBACgB,KAAK,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,WAAW;IAKlE,6BAA6B;IACb,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAErD;CACF;AAED;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,MAAM;IACjC,kDAAkD;IAClD,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;;OAGG;gBACgB,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,WAAW;IAK/D,6BAA6B;IACb,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAGrD;CACF"}

package/lib/cjs/SkyBox.js

@@ -163,7 +163,7 @@ class SkySphere extends SkyBox {
         super(gradient ?? SkyGradient.defaults);
         this.image = image;
     }
-    /** @internal override */
+    /** See [[SkyBox.toJSON]]. */
     toJSON(display) {
         const props = super.toJSON(display);
         props.image = {
@@ -185,13 +185,13 @@ exports.SkySphere = SkySphere;
 class SkyCube extends SkyBox {
     /** Create a new sky cube using the specified images.
      * @param images The images to map to each face of the cube.
-     * @param Optionally overrides  the default gradient settings used if the images cannot be obtained.
+     * @param gradient Optionally overrides  the default gradient settings used if the images cannot be obtained.
      */
     constructor(images, gradient) {
         super(gradient ?? SkyGradient.defaults);
         this.images = { ...images };
     }
-    /** @internal override */
+    /** See [[SkyBox.toJSON]]. */
     toJSON(display) {
         const props = super.toJSON(display);
         props.image = {

package/lib/cjs/SkyBox.js.map

@@ -1 +1 @@
-{"version":3,"file":"SkyBox.js","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgF;AAChF,yCAAqD;AAGrD;;;;GAIG;AACH,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,kEAAkE;IAClE,qDAAQ,CAAA;IACR;;OAEG;IACH,+DAAa,CAAA;IACb,kCAAkC;IAClC,mEAAe,CAAA;IACf;;OAEG;IACH,qDAAQ,CAAA;AACV,CAAC,EAbW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAa1B;AA4GD,MAAM,kBAAkB,GAAG,mBAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,kBAAkB,GAAG,mBAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACvD,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AACpD,MAAM,eAAe,GAAG,mBAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACrD,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,OAAO,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACpE,CAAC;AAQD;;;GAGG;AACH,MAAa,WAAW;IAStB,YAAoB,IAAoC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,eAAe,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,iBAAiB,CAAC;QACvD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,eAAe,CAAC;QACvD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,eAAe,CAAC;IAC/D,CAAC;IAKD,8GAA8G;IACvG,MAAM,CAAC,MAAM,CAAC,KAAsC;QACzD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC1C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;YAChD,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC;YAC9C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;SACjD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAmC;QAC9C,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAgB;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAChC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACtC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACpC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;SACvC,CAAC;QAEF,IAAI,IAAI,CAAC,cAAc,KAAK,eAAe;YACzC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE7C,IAAI,IAAI,CAAC,WAAW,KAAK,eAAe;YACtC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAkB;QAC9B,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;YAC3H,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3F,CAAC;;AA3DD,kDAAkD;AAC3B,oBAAQ,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;AApB3C,kCAAW;AAiFxB;;;GAGG;AACH,MAAa,MAAM;IAIjB,YAAsB,QAAqB;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAKD,yGAAyG;IAClG,MAAM,CAAC,cAAc,CAAC,QAAsB;QACjD,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACvD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI,KAAK,EAAE,KAAK,EAAE;YAChB,QAAQ,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;gBACxB,KAAK,eAAe,CAAC,SAAS;oBAC5B,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC,OAAO;wBACnC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAEtD,MAAM;gBACR,KAAK,eAAe,CAAC,IAAI,CAAC,CAAC;oBACzB,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;oBAChC,IAAI,EAAE,IAAI,SAAS,KAAK,EAAE,CAAC,GAAG,IAAI,SAAS,KAAK,EAAE,CAAC,MAAM,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI;wBAC7J,OAAO,IAAI,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;oBAEnC,MAAM;iBACP;aACF;SACF;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAiB;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO;YACvB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAE1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAW,UAAU;QACnB,OAAO,EAAE,CAAC;IACZ,CAAC;;AA9CD,kDAAkD;AAC3B,eAAQ,GAAG,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;AATxD,wBAAM;AAyDnB;;GAEG;AACH,MAAa,SAAU,SAAQ,MAAM;IAInC;;;OAGG;IACH,YAAmB,KAAuB,EAAE,QAAsB;QAChE,KAAK,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,yBAAyB;IACT,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,SAAS;YAC/B,OAAO,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,OAAO,mBAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,CAAC;CACF;AA5BD,8BA4BC;AAED;;;GAGG;AACH,MAAa,OAAQ,SAAQ,MAAM;IAIjC;;;OAGG;IACH,YAAmB,MAAoB,EAAE,QAAsB;QAC7D,KAAK,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED,yBAAyB;IACT,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE;SAC7B,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAClH,CAAC;CACF;AA7BD,0BA6BC","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\nimport { Id64, Id64String, NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { TextureImageSpec } from \"./RenderTexture\";\r\n\r\n/** Supported types of [[SkyBox]] images.\r\n * @see [[SkyBoxImageProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum SkyBoxImageType {\r\n  /** No image, indicating a [[SkyGradient]] should be displayed. */\r\n  None = 0,\r\n  /** A single image mapped to the surface of a sphere.\r\n   * @see [[SkySphere]].\r\n   */\r\n  Spherical = 1,\r\n  /** @internal not yet supported */\r\n  Cylindrical = 2,\r\n  /** Six images mapped to the faces of a cube.\r\n   * @see [[SkyCube]].\r\n   */\r\n  Cube = 3,\r\n}\r\n\r\n/** JSON representation of the six images used by a [[SkyCube]].\r\n * Each property specifies the image for a face of the cube as either an image URL, or the Id of a [Texture]($backend) element.\r\n * Each image must be square and have the same dimensions as all the other images.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SkyCubeProps {\r\n  front: TextureImageSpec;\r\n  back: TextureImageSpec;\r\n  top: TextureImageSpec;\r\n  bottom: TextureImageSpec;\r\n  right: TextureImageSpec;\r\n  left: TextureImageSpec;\r\n}\r\n\r\n/** JSON representation of the image used for a [[SkySphere]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkySphereImageProps {\r\n  type: SkyBoxImageType.Spherical;\r\n  texture: TextureImageSpec;\r\n  /** @internal */\r\n  textures?: never;\r\n}\r\n\r\n/** JSON representation of the images used for a [[SkyCube]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkyCubeImageProps {\r\n  type: SkyBoxImageType.Cube;\r\n  textures: SkyCubeProps;\r\n  /** @internal */\r\n  texture?: never;\r\n}\r\n\r\n/** JSON representation of the image(s) to be mapped to the surfaces of a [[SkyBox]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type SkyBoxImageProps = SkySphereImageProps | SkyCubeImageProps | { type?: SkyBoxImageType, texture?: never, textures?: never };\r\n\r\n/** JSON representation of a [[SkyBox]] that can be drawn as the background of a [ViewState3d]($frontend).\r\n * An object of this type can describe one of several types of sky box:\r\n *  - A cube with a texture image mapped to each face; or\r\n *  - A sphere with a single texture image mapped to its surface; or\r\n *  - A sphere with a two- or four-color vertical [[Gradient]] mapped to its surface.\r\n *\r\n * Whether cuboid or spherical, the skybox is drawn as if the viewer and the contents of the view are contained within its interior.\r\n *\r\n * For a two-color gradient, the gradient transitions smoothly from the nadir color at the bottom of the sphere to the zenith color at the top of the sphere.\r\n * The sky and ground colors are unused, as are the sky and ground exponents.\r\n *\r\n * For a four-color gradient, a \"horizon\" is produced on the equator of the sphere, where the ground color and sky color meet. The lower half of the sphere transitions\r\n * smoothly from the ground color at the equator to the nadir color at the bottom, and the upper half transitions from the sky color at the equator to the zenith color at\r\n * the top of the sphere.\r\n *\r\n * The color and exponent properties are unused if one or more texture images are supplied.\r\n *\r\n * The skybox is ignored entirely when an atmosphere is displayed.\r\n *\r\n * @see [[DisplayStyle3dSettings.environment]] to define the skybox for a display style.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SkyBoxProps {\r\n  /** Whether or not the skybox should be displayed.\r\n   * Default: false.\r\n   */\r\n  display?: boolean;\r\n  /** For a [[SkyGradient]], if true, a 2-color gradient skybox is used instead of a 4-color.\r\n   * Default: false.\r\n   */\r\n  twoColor?: boolean;\r\n  /** The color of the sky at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (143, 205, 255).\r\n   */\r\n  skyColor?: ColorDefProps;\r\n  /** The color of the ground at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (120, 143, 125).\r\n   */\r\n  groundColor?: ColorDefProps;\r\n  /** The color of the top of the sphere.\r\n   * Default: (54, 117, 255).\r\n   */\r\n  zenithColor?: ColorDefProps;\r\n  /** The color of the bottom of the sphere.\r\n   * Default: (40, 15, 0).\r\n   */\r\n  nadirColor?: ColorDefProps;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from sky color to zenith color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  skyExponent?: number;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from ground color to nadir color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  groundExponent?: number;\r\n  /** The image(s), if any, to be mapped to the surfaces of the sphere or cube. If undefined, the skybox will be displayed as a gradient instead.\r\n   * Default: undefined.\r\n   */\r\n  image?: SkyBoxImageProps;\r\n}\r\n\r\nconst defaultGroundColor = ColorDef.from(143, 205, 125);\r\nconst defaultZenithColor = ColorDef.from(54, 117, 255);\r\nconst defaultNadirColor = ColorDef.from(40, 125, 0);\r\nconst defaultSkyColor = ColorDef.from(142, 205, 255);\r\nconst defaultExponent = 4.0;\r\n\r\nfunction colorDefFromJson(props?: ColorDefProps): ColorDef | undefined {\r\n  return undefined !== props ? ColorDef.fromJSON(props) : undefined;\r\n}\r\n\r\n/** A type containing all of the properties and none of the methods of [[SkyGradient]] with `readonly` modifiers removed.\r\n * @see [[SkyGradient.create]] and [[SkyGradient.clone]].\r\n * @public\r\n */\r\nexport type SkyGradientProperties = NonFunctionPropertiesOf<SkyGradient>;\r\n\r\n/** Describes how to map a two- or four-color [[Gradient]] to the interior of a sphere to produce a [[SkyBox]].\r\n * @see [[SkyBox.gradient]].\r\n * @public\r\n */\r\nexport class SkyGradient {\r\n  public readonly twoColor: boolean;\r\n  public readonly skyColor: ColorDef;\r\n  public readonly groundColor: ColorDef;\r\n  public readonly zenithColor: ColorDef;\r\n  public readonly nadirColor: ColorDef;\r\n  public readonly skyExponent: number;\r\n  public readonly groundExponent: number;\r\n\r\n  private constructor(args: Partial<SkyGradientProperties>) {\r\n    this.twoColor = args.twoColor ?? false;\r\n    this.skyColor = args.skyColor ?? defaultSkyColor;\r\n    this.groundColor = args.groundColor ?? defaultGroundColor;\r\n    this.nadirColor = args.nadirColor ?? defaultNadirColor;\r\n    this.zenithColor = args.zenithColor ?? defaultZenithColor;\r\n    this.skyExponent = args.skyExponent ?? defaultExponent;\r\n    this.groundExponent = args.groundExponent ?? defaultExponent;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyGradient({});\r\n\r\n  /** Create a new gradient. Any properties not specified by `props` are initialized to their default values. */\r\n  public static create(props?: Partial<SkyGradientProperties>): SkyGradient {\r\n    return props ? new this(props) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyGradient {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new this({\r\n      twoColor: props.twoColor,\r\n      skyExponent: props.skyExponent,\r\n      groundExponent: props.groundExponent,\r\n      skyColor: colorDefFromJson(props.skyColor),\r\n      groundColor: colorDefFromJson(props.groundColor),\r\n      nadirColor: colorDefFromJson(props.nadirColor),\r\n      zenithColor: colorDefFromJson(props.zenithColor),\r\n    });\r\n  }\r\n\r\n  /** Create ea copy of this gradient, identical except for any properties explicitly specified by `changedProps`.\r\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: SkyGradientProperties): SkyGradient {\r\n    return new SkyGradient({ ...this, ...changedProps });\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): SkyBoxProps {\r\n    const props: SkyBoxProps = {\r\n      skyColor: this.skyColor.toJSON(),\r\n      groundColor: this.groundColor.toJSON(),\r\n      nadirColor: this.nadirColor.toJSON(),\r\n      zenithColor: this.zenithColor.toJSON(),\r\n    };\r\n\r\n    if (this.groundExponent !== defaultExponent)\r\n      props.groundExponent = this.groundExponent;\r\n\r\n    if (this.skyExponent !== defaultExponent)\r\n      props.skyExponent = this.skyExponent;\r\n\r\n    if (this.twoColor)\r\n      props.twoColor = this.twoColor;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this gradient is equivalent to the supplied gradient. */\r\n  public equals(other: SkyGradient): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.twoColor === other.twoColor && this.skyColor.equals(other.skyColor) && this.groundColor.equals(other.groundColor) &&\r\n      this.zenithColor.equals(other.zenithColor) && this.nadirColor.equals(other.nadirColor);\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky, as part of an [[Environment]].\r\n * @see [[SkyBoxProps]].\r\n * @public\r\n */\r\nexport class SkyBox {\r\n  /** The gradient settings, used if no cube or sphere images are supplied, or if the images cannot be loaded. */\r\n  public readonly gradient: SkyGradient;\r\n\r\n  protected constructor(gradient: SkyGradient) {\r\n    this.gradient = gradient;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyBox(SkyGradient.defaults);\r\n\r\n  /** Create a skybox that displays the specified gradient, or the default gradient if none is supplied. */\r\n  public static createGradient(gradient?: SkyGradient): SkyBox {\r\n    return gradient ? new this(gradient) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyBox {\r\n    const gradient = SkyGradient.fromJSON(props);\r\n\r\n    if (props?.image) {\r\n      switch (props.image.type) {\r\n        case SkyBoxImageType.Spherical:\r\n          if (undefined !== props.image.texture)\r\n            return new SkySphere(props.image.texture, gradient);\r\n\r\n          break;\r\n        case SkyBoxImageType.Cube: {\r\n          const tx = props.image.textures;\r\n          if (tx && undefined !== tx.top && undefined !== tx.bottom && undefined !== tx.right && undefined !== tx.left && undefined !== tx.front && undefined !== tx.back)\r\n            return new SkyCube(tx, gradient);\r\n\r\n          break;\r\n        }\r\n      }\r\n    }\r\n\r\n    return this.createGradient(gradient);\r\n  }\r\n\r\n  /** Convert to JSON representation.\r\n   * @param display If defined, the value to use for [[SkyBoxProps.display]]; otherwise, that property will be left undefined.\r\n   */\r\n  public toJSON(display?: boolean): SkyBoxProps {\r\n    const props = this.gradient.toJSON();\r\n    if (undefined !== display)\r\n      props.display = display;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public get textureIds(): Iterable<Id64String> {\r\n    return [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping a single image to the interior of a sphere.\r\n * @public\r\n */\r\nexport class SkySphere extends SkyBox {\r\n  /** The image to map to the interior of the sphere. */\r\n  public readonly image: TextureImageSpec;\r\n\r\n  /** Create a new sky sphere using the specified image.\r\n   * @param image The image to map to the interior of the sphere.\r\n   * @param gradient Optionally overrides the default gradient settings used if the image cannot be obtained.\r\n   */\r\n  public constructor(image: TextureImageSpec, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.image = image;\r\n  }\r\n\r\n  /** @internal override */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Spherical,\r\n      texture: this.image,\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    return Id64.isValidId64(this.image) ? [this.image] : [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping images to the interior faces of a cube.\r\n * The images are required to be *square*, and each image must have the same dimensions as the other images.\r\n * @public\r\n */\r\nexport class SkyCube extends SkyBox {\r\n  /** The images to map to each face of the cube. */\r\n  public readonly images: SkyCubeProps;\r\n\r\n  /** Create a new sky cube using the specified images.\r\n   * @param images The images to map to each face of the cube.\r\n   * @param Optionally overrides  the default gradient settings used if the images cannot be obtained.\r\n   */\r\n  public constructor(images: SkyCubeProps, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.images = { ...images };\r\n  }\r\n\r\n  /** @internal override */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Cube,\r\n      textures: { ...this.images },\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    const imgs = this.images;\r\n    return [imgs.front, imgs.back, imgs.top, imgs.bottom, imgs.left, imgs.right].filter((x) => Id64.isValidId64(x));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SkyBox.js","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgF;AAChF,yCAAqD;AAGrD;;;;GAIG;AACH,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,kEAAkE;IAClE,qDAAQ,CAAA;IACR;;OAEG;IACH,+DAAa,CAAA;IACb,kCAAkC;IAClC,mEAAe,CAAA;IACf;;OAEG;IACH,qDAAQ,CAAA;AACV,CAAC,EAbW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAa1B;AA4GD,MAAM,kBAAkB,GAAG,mBAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,kBAAkB,GAAG,mBAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACvD,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AACpD,MAAM,eAAe,GAAG,mBAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACrD,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,OAAO,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACpE,CAAC;AAQD;;;GAGG;AACH,MAAa,WAAW;IAStB,YAAoB,IAAoC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,eAAe,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,iBAAiB,CAAC;QACvD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,eAAe,CAAC;QACvD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,eAAe,CAAC;IAC/D,CAAC;IAKD,8GAA8G;IACvG,MAAM,CAAC,MAAM,CAAC,KAAsC;QACzD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC1C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;YAChD,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC;YAC9C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;SACjD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAmC;QAC9C,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAgB;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAChC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACtC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACpC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;SACvC,CAAC;QAEF,IAAI,IAAI,CAAC,cAAc,KAAK,eAAe;YACzC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE7C,IAAI,IAAI,CAAC,WAAW,KAAK,eAAe;YACtC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAkB;QAC9B,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;YAC3H,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3F,CAAC;;AA3DD,kDAAkD;AAC3B,oBAAQ,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;AApB3C,kCAAW;AAiFxB;;;GAGG;AACH,MAAa,MAAM;IAIjB,YAAsB,QAAqB;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAKD,yGAAyG;IAClG,MAAM,CAAC,cAAc,CAAC,QAAsB;QACjD,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACvD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI,KAAK,EAAE,KAAK,EAAE;YAChB,QAAQ,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;gBACxB,KAAK,eAAe,CAAC,SAAS;oBAC5B,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC,OAAO;wBACnC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAEtD,MAAM;gBACR,KAAK,eAAe,CAAC,IAAI,CAAC,CAAC;oBACzB,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;oBAChC,IAAI,EAAE,IAAI,SAAS,KAAK,EAAE,CAAC,GAAG,IAAI,SAAS,KAAK,EAAE,CAAC,MAAM,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI;wBAC7J,OAAO,IAAI,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;oBAEnC,MAAM;iBACP;aACF;SACF;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAiB;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO;YACvB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAE1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAW,UAAU;QACnB,OAAO,EAAE,CAAC;IACZ,CAAC;;AA9CD,kDAAkD;AAC3B,eAAQ,GAAG,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;AATxD,wBAAM;AAyDnB;;GAEG;AACH,MAAa,SAAU,SAAQ,MAAM;IAInC;;;OAGG;IACH,YAAmB,KAAuB,EAAE,QAAsB;QAChE,KAAK,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,6BAA6B;IACb,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,SAAS;YAC/B,OAAO,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,OAAO,mBAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,CAAC;CACF;AA5BD,8BA4BC;AAED;;;GAGG;AACH,MAAa,OAAQ,SAAQ,MAAM;IAIjC;;;OAGG;IACH,YAAmB,MAAoB,EAAE,QAAsB;QAC7D,KAAK,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED,6BAA6B;IACb,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE;SAC7B,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAClH,CAAC;CACF;AA7BD,0BA6BC","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\nimport { Id64, Id64String, NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { TextureImageSpec } from \"./RenderTexture\";\r\n\r\n/** Supported types of [[SkyBox]] images.\r\n * @see [[SkyBoxImageProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum SkyBoxImageType {\r\n  /** No image, indicating a [[SkyGradient]] should be displayed. */\r\n  None = 0,\r\n  /** A single image mapped to the surface of a sphere.\r\n   * @see [[SkySphere]].\r\n   */\r\n  Spherical = 1,\r\n  /** @internal not yet supported */\r\n  Cylindrical = 2,\r\n  /** Six images mapped to the faces of a cube.\r\n   * @see [[SkyCube]].\r\n   */\r\n  Cube = 3,\r\n}\r\n\r\n/** JSON representation of the six images used by a [[SkyCube]].\r\n * Each property specifies the image for a face of the cube as either an image URL, or the Id of a [Texture]($backend) element.\r\n * Each image must be square and have the same dimensions as all the other images.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SkyCubeProps {\r\n  front: TextureImageSpec;\r\n  back: TextureImageSpec;\r\n  top: TextureImageSpec;\r\n  bottom: TextureImageSpec;\r\n  right: TextureImageSpec;\r\n  left: TextureImageSpec;\r\n}\r\n\r\n/** JSON representation of the image used for a [[SkySphere]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkySphereImageProps {\r\n  type: SkyBoxImageType.Spherical;\r\n  texture: TextureImageSpec;\r\n  /** @internal */\r\n  textures?: never;\r\n}\r\n\r\n/** JSON representation of the images used for a [[SkyCube]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkyCubeImageProps {\r\n  type: SkyBoxImageType.Cube;\r\n  textures: SkyCubeProps;\r\n  /** @internal */\r\n  texture?: never;\r\n}\r\n\r\n/** JSON representation of the image(s) to be mapped to the surfaces of a [[SkyBox]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type SkyBoxImageProps = SkySphereImageProps | SkyCubeImageProps | { type?: SkyBoxImageType, texture?: never, textures?: never };\r\n\r\n/** JSON representation of a [[SkyBox]] that can be drawn as the background of a [ViewState3d]($frontend).\r\n * An object of this type can describe one of several types of sky box:\r\n *  - A cube with a texture image mapped to each face; or\r\n *  - A sphere with a single texture image mapped to its surface; or\r\n *  - A sphere with a two- or four-color vertical [[Gradient]] mapped to its surface.\r\n *\r\n * Whether cuboid or spherical, the skybox is drawn as if the viewer and the contents of the view are contained within its interior.\r\n *\r\n * For a two-color gradient, the gradient transitions smoothly from the nadir color at the bottom of the sphere to the zenith color at the top of the sphere.\r\n * The sky and ground colors are unused, as are the sky and ground exponents.\r\n *\r\n * For a four-color gradient, a \"horizon\" is produced on the equator of the sphere, where the ground color and sky color meet. The lower half of the sphere transitions\r\n * smoothly from the ground color at the equator to the nadir color at the bottom, and the upper half transitions from the sky color at the equator to the zenith color at\r\n * the top of the sphere.\r\n *\r\n * The color and exponent properties are unused if one or more texture images are supplied.\r\n *\r\n * The skybox is ignored entirely when an atmosphere is displayed.\r\n *\r\n * @see [[DisplayStyle3dSettings.environment]] to define the skybox for a display style.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SkyBoxProps {\r\n  /** Whether or not the skybox should be displayed.\r\n   * Default: false.\r\n   */\r\n  display?: boolean;\r\n  /** For a [[SkyGradient]], if true, a 2-color gradient skybox is used instead of a 4-color.\r\n   * Default: false.\r\n   */\r\n  twoColor?: boolean;\r\n  /** The color of the sky at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (143, 205, 255).\r\n   */\r\n  skyColor?: ColorDefProps;\r\n  /** The color of the ground at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (120, 143, 125).\r\n   */\r\n  groundColor?: ColorDefProps;\r\n  /** The color of the top of the sphere.\r\n   * Default: (54, 117, 255).\r\n   */\r\n  zenithColor?: ColorDefProps;\r\n  /** The color of the bottom of the sphere.\r\n   * Default: (40, 15, 0).\r\n   */\r\n  nadirColor?: ColorDefProps;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from sky color to zenith color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  skyExponent?: number;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from ground color to nadir color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  groundExponent?: number;\r\n  /** The image(s), if any, to be mapped to the surfaces of the sphere or cube. If undefined, the skybox will be displayed as a gradient instead.\r\n   * Default: undefined.\r\n   */\r\n  image?: SkyBoxImageProps;\r\n}\r\n\r\nconst defaultGroundColor = ColorDef.from(143, 205, 125);\r\nconst defaultZenithColor = ColorDef.from(54, 117, 255);\r\nconst defaultNadirColor = ColorDef.from(40, 125, 0);\r\nconst defaultSkyColor = ColorDef.from(142, 205, 255);\r\nconst defaultExponent = 4.0;\r\n\r\nfunction colorDefFromJson(props?: ColorDefProps): ColorDef | undefined {\r\n  return undefined !== props ? ColorDef.fromJSON(props) : undefined;\r\n}\r\n\r\n/** A type containing all of the properties and none of the methods of [[SkyGradient]] with `readonly` modifiers removed.\r\n * @see [[SkyGradient.create]] and [[SkyGradient.clone]].\r\n * @public\r\n */\r\nexport type SkyGradientProperties = NonFunctionPropertiesOf<SkyGradient>;\r\n\r\n/** Describes how to map a two- or four-color [[Gradient]] to the interior of a sphere to produce a [[SkyBox]].\r\n * @see [[SkyBox.gradient]].\r\n * @public\r\n */\r\nexport class SkyGradient {\r\n  public readonly twoColor: boolean;\r\n  public readonly skyColor: ColorDef;\r\n  public readonly groundColor: ColorDef;\r\n  public readonly zenithColor: ColorDef;\r\n  public readonly nadirColor: ColorDef;\r\n  public readonly skyExponent: number;\r\n  public readonly groundExponent: number;\r\n\r\n  private constructor(args: Partial<SkyGradientProperties>) {\r\n    this.twoColor = args.twoColor ?? false;\r\n    this.skyColor = args.skyColor ?? defaultSkyColor;\r\n    this.groundColor = args.groundColor ?? defaultGroundColor;\r\n    this.nadirColor = args.nadirColor ?? defaultNadirColor;\r\n    this.zenithColor = args.zenithColor ?? defaultZenithColor;\r\n    this.skyExponent = args.skyExponent ?? defaultExponent;\r\n    this.groundExponent = args.groundExponent ?? defaultExponent;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyGradient({});\r\n\r\n  /** Create a new gradient. Any properties not specified by `props` are initialized to their default values. */\r\n  public static create(props?: Partial<SkyGradientProperties>): SkyGradient {\r\n    return props ? new this(props) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyGradient {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new this({\r\n      twoColor: props.twoColor,\r\n      skyExponent: props.skyExponent,\r\n      groundExponent: props.groundExponent,\r\n      skyColor: colorDefFromJson(props.skyColor),\r\n      groundColor: colorDefFromJson(props.groundColor),\r\n      nadirColor: colorDefFromJson(props.nadirColor),\r\n      zenithColor: colorDefFromJson(props.zenithColor),\r\n    });\r\n  }\r\n\r\n  /** Create ea copy of this gradient, identical except for any properties explicitly specified by `changedProps`.\r\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: SkyGradientProperties): SkyGradient {\r\n    return new SkyGradient({ ...this, ...changedProps });\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): SkyBoxProps {\r\n    const props: SkyBoxProps = {\r\n      skyColor: this.skyColor.toJSON(),\r\n      groundColor: this.groundColor.toJSON(),\r\n      nadirColor: this.nadirColor.toJSON(),\r\n      zenithColor: this.zenithColor.toJSON(),\r\n    };\r\n\r\n    if (this.groundExponent !== defaultExponent)\r\n      props.groundExponent = this.groundExponent;\r\n\r\n    if (this.skyExponent !== defaultExponent)\r\n      props.skyExponent = this.skyExponent;\r\n\r\n    if (this.twoColor)\r\n      props.twoColor = this.twoColor;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this gradient is equivalent to the supplied gradient. */\r\n  public equals(other: SkyGradient): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.twoColor === other.twoColor && this.skyColor.equals(other.skyColor) && this.groundColor.equals(other.groundColor) &&\r\n      this.zenithColor.equals(other.zenithColor) && this.nadirColor.equals(other.nadirColor);\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky, as part of an [[Environment]].\r\n * @see [[SkyBoxProps]].\r\n * @public\r\n */\r\nexport class SkyBox {\r\n  /** The gradient settings, used if no cube or sphere images are supplied, or if the images cannot be loaded. */\r\n  public readonly gradient: SkyGradient;\r\n\r\n  protected constructor(gradient: SkyGradient) {\r\n    this.gradient = gradient;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyBox(SkyGradient.defaults);\r\n\r\n  /** Create a skybox that displays the specified gradient, or the default gradient if none is supplied. */\r\n  public static createGradient(gradient?: SkyGradient): SkyBox {\r\n    return gradient ? new this(gradient) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyBox {\r\n    const gradient = SkyGradient.fromJSON(props);\r\n\r\n    if (props?.image) {\r\n      switch (props.image.type) {\r\n        case SkyBoxImageType.Spherical:\r\n          if (undefined !== props.image.texture)\r\n            return new SkySphere(props.image.texture, gradient);\r\n\r\n          break;\r\n        case SkyBoxImageType.Cube: {\r\n          const tx = props.image.textures;\r\n          if (tx && undefined !== tx.top && undefined !== tx.bottom && undefined !== tx.right && undefined !== tx.left && undefined !== tx.front && undefined !== tx.back)\r\n            return new SkyCube(tx, gradient);\r\n\r\n          break;\r\n        }\r\n      }\r\n    }\r\n\r\n    return this.createGradient(gradient);\r\n  }\r\n\r\n  /** Convert to JSON representation.\r\n   * @param display If defined, the value to use for [[SkyBoxProps.display]]; otherwise, that property will be left undefined.\r\n   */\r\n  public toJSON(display?: boolean): SkyBoxProps {\r\n    const props = this.gradient.toJSON();\r\n    if (undefined !== display)\r\n      props.display = display;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public get textureIds(): Iterable<Id64String> {\r\n    return [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping a single image to the interior of a sphere.\r\n * @public\r\n */\r\nexport class SkySphere extends SkyBox {\r\n  /** The image to map to the interior of the sphere. */\r\n  public readonly image: TextureImageSpec;\r\n\r\n  /** Create a new sky sphere using the specified image.\r\n   * @param image The image to map to the interior of the sphere.\r\n   * @param gradient Optionally overrides the default gradient settings used if the image cannot be obtained.\r\n   */\r\n  public constructor(image: TextureImageSpec, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.image = image;\r\n  }\r\n\r\n  /** See [[SkyBox.toJSON]]. */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Spherical,\r\n      texture: this.image,\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    return Id64.isValidId64(this.image) ? [this.image] : [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping images to the interior faces of a cube.\r\n * The images are required to be *square*, and each image must have the same dimensions as the other images.\r\n * @public\r\n */\r\nexport class SkyCube extends SkyBox {\r\n  /** The images to map to each face of the cube. */\r\n  public readonly images: SkyCubeProps;\r\n\r\n  /** Create a new sky cube using the specified images.\r\n   * @param images The images to map to each face of the cube.\r\n   * @param gradient Optionally overrides  the default gradient settings used if the images cannot be obtained.\r\n   */\r\n  public constructor(images: SkyCubeProps, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.images = { ...images };\r\n  }\r\n\r\n  /** See [[SkyBox.toJSON]]. */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Cube,\r\n      textures: { ...this.images },\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    const imgs = this.images;\r\n    return [imgs.front, imgs.back, imgs.top, imgs.bottom, imgs.left, imgs.right].filter((x) => Id64.isValidId64(x));\r\n  }\r\n}\r\n"]}

package/lib/cjs/ViewFlags.d.ts

@@ -249,11 +249,11 @@ export declare class ViewFlags {
     hiddenEdgesVisible(): boolean;
     /** Returns true if the edges of surfaces should be displayed, based on [[RenderMode]] and the [[visibleEdges]] flag. */
     edgesRequired(): boolean;
-    /** Convert to JSON representation. */
-    toJSON(): ViewFlagProps;
-    /** Like [[toJSON]], but no properties are omitted.
-     * @internal
+    /** Convert to JSON representation.
+     * Properties are omitted if they match the default values.
      */
+    toJSON(): ViewFlagProps;
+    /** Like [[toJSON]], but no properties are omitted. */
     toFullyDefinedJSON(): Required<ViewFlagProps>;
     /** A ViewFlags object with all properties initialized to their default values. */
     static readonly defaults: ViewFlags;

package/lib/cjs/ViewFlags.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewFlags.d.ts","sourceRoot":"","sources":["../../src/ViewFlags.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAa,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAElF;;;;GAIG;AACH,oBAAY,UAAU;IACpB;;;;OAIG;IACH,SAAS,IAAI;IACb;;;;OAIG;IACH,WAAW,IAAI;IACf;;;;;OAKG;IACH,SAAS,IAAI;IACb;;;OAGG;IACH,UAAU,IAAI;CACf;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uFAAuF;IACvF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,6EAA6E;IAC7E,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,2DAA2D;IAC3D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yEAAyE;IACzE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yEAAyE;IACzE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yEAAyE;IACzE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iHAAiH;IACjH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oJAAoJ;IACpJ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,gCAAgC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAMD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IACpB;;;OAGG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,uFAAuF;IACvF,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,qFAAqF;IACrF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iGAAiG;IACjG,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,sIAAsI;IACtI,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,qIAAqI;IACrI,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,qGAAqG;IACrG,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,sGAAsG;IACtG,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,8GAA8G;IAC9G,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iDAAiD;IACjD,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;;;OAIG;IACH,SAAgB,WAAW,EAAE,OAAO,CAAC;IACrC;;OAEG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,4FAA4F;IAC5F,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C,4DAA4D;IAC5D,SAAgB,eAAe,EAAE,OAAO,CAAC;IACzC,6EAA6E;IAC7E,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,SAAgB,mBAAmB,EAAE,OAAO,CAAC;IAC7C;;;;OAIG;IACH,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAE9C;;;OAGG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAElC;;OAEG;gBACgB,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC;IA2BvD;;;;;OAKG;IACI,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIlE;;;;OAIG;IACI,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IA4BnE;;;;;;OAMG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;IAS3F;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS;IAIxD;;OAEG;IACI,SAAS,IAAI,SAAS;IAoB7B,gBAAgB;IACT,kBAAkB,IAAI,OAAO;IAWpC,wHAAwH;IACjH,aAAa,IAAI,OAAO;IAI/B,sCAAsC;IAC/B,MAAM,IAAI,aAAa;IAqD9B;;OAEG;IACI,kBAAkB,IAAI,QAAQ,CAAC,aAAa,CAAC;IA+BpD,kFAAkF;IAClF,gBAAuB,QAAQ,YAAmB;IAElD;;OAEG;WACW,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIrE;;;;;;;OAOG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS;IA0CvD,yDAAyD;IAClD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,mBAAmB,CAAC,GAAG,OAAO;CA6B7D;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC"}
+{"version":3,"file":"ViewFlags.d.ts","sourceRoot":"","sources":["../../src/ViewFlags.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAa,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAElF;;;;GAIG;AACH,oBAAY,UAAU;IACpB;;;;OAIG;IACH,SAAS,IAAI;IACb;;;;OAIG;IACH,WAAW,IAAI;IACf;;;;;OAKG;IACH,SAAS,IAAI;IACb;;;OAGG;IACH,UAAU,IAAI;CACf;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uFAAuF;IACvF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,6EAA6E;IAC7E,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,2DAA2D;IAC3D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yEAAyE;IACzE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yEAAyE;IACzE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yEAAyE;IACzE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iHAAiH;IACjH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oJAAoJ;IACpJ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,gCAAgC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAMD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IACpB;;;OAGG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,uFAAuF;IACvF,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,qFAAqF;IACrF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iGAAiG;IACjG,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,sIAAsI;IACtI,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,qIAAqI;IACrI,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,qGAAqG;IACrG,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,sGAAsG;IACtG,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,8GAA8G;IAC9G,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iDAAiD;IACjD,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;;;OAIG;IACH,SAAgB,WAAW,EAAE,OAAO,CAAC;IACrC;;OAEG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,4FAA4F;IAC5F,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C,4DAA4D;IAC5D,SAAgB,eAAe,EAAE,OAAO,CAAC;IACzC,6EAA6E;IAC7E,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,SAAgB,mBAAmB,EAAE,OAAO,CAAC;IAC7C;;;;OAIG;IACH,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAE9C;;;OAGG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAElC;;OAEG;gBACgB,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC;IA2BvD;;;;;OAKG;IACI,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIlE;;;;OAIG;IACI,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IA4BnE;;;;;;OAMG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;IAS3F;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS;IAIxD;;OAEG;IACI,SAAS,IAAI,SAAS;IAoB7B,gBAAgB;IACT,kBAAkB,IAAI,OAAO;IAWpC,wHAAwH;IACjH,aAAa,IAAI,OAAO;IAI/B;;OAEG;IACI,MAAM,IAAI,aAAa;IAqD9B,sDAAsD;IAC/C,kBAAkB,IAAI,QAAQ,CAAC,aAAa,CAAC;IA+BpD,kFAAkF;IAClF,gBAAuB,QAAQ,YAAmB;IAElD;;OAEG;WACW,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIrE;;;;;;;OAOG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS;IA0CvD,yDAAyD;IAClD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,mBAAmB,CAAC,GAAG,OAAO;CA6B7D;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC"}

package/lib/cjs/ViewFlags.js

@@ -194,7 +194,9 @@ class ViewFlags {
     edgesRequired() {
         return edgesRequired(this.renderMode, this.visibleEdges);
     }
-    /** Convert to JSON representation. */
+    /** Convert to JSON representation.
+     * Properties are omitted if they match the default values.
+     */
     toJSON() {
         const out = {};
         if (!this.constructions)
@@ -246,9 +248,7 @@ class ViewFlags {
         out.renderMode = this.renderMode;
         return out;
     }
-    /** Like [[toJSON]], but no properties are omitted.
-     * @internal
-     */
+    /** Like [[toJSON]], but no properties are omitted. */
     toFullyDefinedJSON() {
         return {
             renderMode: this.renderMode,