@itwin/core-common 3.4.0-dev.9 → 3.5.0-dev.4

package/lib/cjs/TerrainSettings.js

@@ -1,102 +1,103 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module DisplayStyles
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TerrainSettings = exports.TerrainHeightOriginMode = void 0;
-/** Correction modes for terrain height
- * @see [[TerrainProps]]
- * @public
- * @extensions
- */
-var TerrainHeightOriginMode;
-(function (TerrainHeightOriginMode) {
-    /** Height value indicates the geodetic height of the IModel origin (also referred to as ellipsoidal or GPS height) */
-    TerrainHeightOriginMode[TerrainHeightOriginMode["Geodetic"] = 0] = "Geodetic";
-    /** Height value indicates the geoidal height of the IModel origin (commonly referred to as sea level). */
-    TerrainHeightOriginMode[TerrainHeightOriginMode["Geoid"] = 1] = "Geoid";
-    /** Height value indicates the height of the IModel origin relative to ground level at project center. */
-    TerrainHeightOriginMode[TerrainHeightOriginMode["Ground"] = 2] = "Ground";
-})(TerrainHeightOriginMode = exports.TerrainHeightOriginMode || (exports.TerrainHeightOriginMode = {}));
-/** Normalized version of [[TerrainProps]] for which provider has been validated and default values of all members are used.
- * @public
- */
-class TerrainSettings {
-    constructor(providerName = "CesiumWorldTerrain", exaggeration = 1.0, applyLighting = false, heightOrigin = 0.0, heightOriginMode = TerrainHeightOriginMode.Geodetic) {
-        this.providerName = providerName;
-        this.exaggeration = Math.min(100, Math.max(0.1, exaggeration));
-        this.applyLighting = applyLighting;
-        this.heightOrigin = heightOrigin;
-        switch (heightOriginMode) {
-            case TerrainHeightOriginMode.Ground:
-            case TerrainHeightOriginMode.Geoid:
-                this.heightOriginMode = heightOriginMode;
-                break;
-            default:
-                this.heightOriginMode = TerrainHeightOriginMode.Geodetic;
-                break;
-        }
-    }
-    /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.
-     * @see [[TerrainProps.nonLocatable]].
-     * @internal
-     */
-    get nonLocatable() {
-        return this._nonLocatable;
-    }
-    static fromJSON(json) {
-        if (undefined === json)
-            return new TerrainSettings();
-        const providerName = "CesiumWorldTerrain"; // This is only terrain provider currently supported.
-        const settings = new TerrainSettings(providerName, json.exaggeration, json.applyLighting, json.heightOrigin, json.heightOriginMode);
-        if (true === json.nonLocatable)
-            settings._nonLocatable = true;
-        return settings;
-    }
-    toJSON() {
-        const props = { heightOriginMode: this.heightOriginMode };
-        if ("CesiumWorldTerrain" !== this.providerName)
-            props.providerName = this.providerName;
-        if (1 !== this.exaggeration)
-            props.exaggeration = this.exaggeration;
-        if (this.nonLocatable)
-            props.nonLocatable = true;
-        if (this.applyLighting)
-            props.applyLighting = true;
-        if (0 !== this.heightOrigin)
-            props.heightOrigin = this.heightOrigin;
-        return props;
-    }
-    equals(other) {
-        return this.providerName === other.providerName && this.exaggeration === other.exaggeration && this.applyLighting === other.applyLighting
-            && this.heightOrigin === other.heightOrigin && this.heightOriginMode === other.heightOriginMode && this.nonLocatable === other.nonLocatable;
-    }
-    /** Returns true if these settings are equivalent to the supplied JSON settings. */
-    equalsJSON(json) {
-        return this.equals(TerrainSettings.fromJSON(json));
-    }
-    /** Create a copy of this TerrainSettings, optionally modifying some of its properties.
-     * @param changedProps JSON representation of the properties to change.
-     * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.
-     */
-    clone(changedProps) {
-        var _a, _b, _c, _d, _e, _f;
-        if (undefined === changedProps)
-            return this;
-        const props = {
-            providerName: (_a = changedProps.providerName) !== null && _a !== void 0 ? _a : this.providerName,
-            exaggeration: (_b = changedProps.exaggeration) !== null && _b !== void 0 ? _b : this.exaggeration,
-            nonLocatable: (_c = changedProps.nonLocatable) !== null && _c !== void 0 ? _c : this.nonLocatable,
-            applyLighting: (_d = changedProps.applyLighting) !== null && _d !== void 0 ? _d : this.applyLighting,
-            heightOrigin: (_e = changedProps.heightOrigin) !== null && _e !== void 0 ? _e : this.heightOrigin,
-            heightOriginMode: (_f = changedProps.heightOriginMode) !== null && _f !== void 0 ? _f : this.heightOriginMode,
-        };
-        return TerrainSettings.fromJSON(props);
-    }
-}
-exports.TerrainSettings = TerrainSettings;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TerrainSettings = exports.TerrainHeightOriginMode = void 0;
+/** Correction modes for terrain height
+ * @see [[TerrainProps]]
+ * @public
+ * @extensions
+ */
+var TerrainHeightOriginMode;
+(function (TerrainHeightOriginMode) {
+    /** Height value indicates the geodetic height of the IModel origin (also referred to as ellipsoidal or GPS height) */
+    TerrainHeightOriginMode[TerrainHeightOriginMode["Geodetic"] = 0] = "Geodetic";
+    /** Height value indicates the geoidal height of the IModel origin (commonly referred to as sea level). */
+    TerrainHeightOriginMode[TerrainHeightOriginMode["Geoid"] = 1] = "Geoid";
+    /** Height value indicates the height of the IModel origin relative to ground level at project center. */
+    TerrainHeightOriginMode[TerrainHeightOriginMode["Ground"] = 2] = "Ground";
+})(TerrainHeightOriginMode = exports.TerrainHeightOriginMode || (exports.TerrainHeightOriginMode = {}));
+/** Normalized version of [[TerrainProps]] for which provider has been validated and default values of all members are used.
+ * @public
+ */
+class TerrainSettings {
+    constructor(providerName = "CesiumWorldTerrain", exaggeration = 1.0, applyLighting = false, heightOrigin = 0.0, heightOriginMode = TerrainHeightOriginMode.Geodetic) {
+        this.providerName = providerName;
+        this.exaggeration = Math.min(100, Math.max(0.1, exaggeration));
+        this.applyLighting = applyLighting;
+        this.heightOrigin = heightOrigin;
+        switch (heightOriginMode) {
+            case TerrainHeightOriginMode.Ground:
+            case TerrainHeightOriginMode.Geoid:
+                this.heightOriginMode = heightOriginMode;
+                break;
+            default:
+                this.heightOriginMode = TerrainHeightOriginMode.Geodetic;
+                break;
+        }
+    }
+    /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.
+     * @see [[TerrainProps.nonLocatable]].
+     * @internal
+     */
+    get nonLocatable() {
+        return this._nonLocatable;
+    }
+    static fromJSON(json) {
+        var _a;
+        if (undefined === json)
+            return new TerrainSettings();
+        const providerName = (_a = json === null || json === void 0 ? void 0 : json.providerName) !== null && _a !== void 0 ? _a : "CesiumWorldTerrain";
+        const settings = new TerrainSettings(providerName, json.exaggeration, json.applyLighting, json.heightOrigin, json.heightOriginMode);
+        if (true === json.nonLocatable)
+            settings._nonLocatable = true;
+        return settings;
+    }
+    toJSON() {
+        const props = { heightOriginMode: this.heightOriginMode };
+        if ("CesiumWorldTerrain" !== this.providerName)
+            props.providerName = this.providerName;
+        if (1 !== this.exaggeration)
+            props.exaggeration = this.exaggeration;
+        if (this.nonLocatable)
+            props.nonLocatable = true;
+        if (this.applyLighting)
+            props.applyLighting = true;
+        if (0 !== this.heightOrigin)
+            props.heightOrigin = this.heightOrigin;
+        return props;
+    }
+    equals(other) {
+        return this.providerName === other.providerName && this.exaggeration === other.exaggeration && this.applyLighting === other.applyLighting
+            && this.heightOrigin === other.heightOrigin && this.heightOriginMode === other.heightOriginMode && this.nonLocatable === other.nonLocatable;
+    }
+    /** Returns true if these settings are equivalent to the supplied JSON settings. */
+    equalsJSON(json) {
+        return this.equals(TerrainSettings.fromJSON(json));
+    }
+    /** Create a copy of this TerrainSettings, optionally modifying some of its properties.
+     * @param changedProps JSON representation of the properties to change.
+     * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.
+     */
+    clone(changedProps) {
+        var _a, _b, _c, _d, _e, _f;
+        if (undefined === changedProps)
+            return this;
+        const props = {
+            providerName: (_a = changedProps.providerName) !== null && _a !== void 0 ? _a : this.providerName,
+            exaggeration: (_b = changedProps.exaggeration) !== null && _b !== void 0 ? _b : this.exaggeration,
+            nonLocatable: (_c = changedProps.nonLocatable) !== null && _c !== void 0 ? _c : this.nonLocatable,
+            applyLighting: (_d = changedProps.applyLighting) !== null && _d !== void 0 ? _d : this.applyLighting,
+            heightOrigin: (_e = changedProps.heightOrigin) !== null && _e !== void 0 ? _e : this.heightOrigin,
+            heightOriginMode: (_f = changedProps.heightOriginMode) !== null && _f !== void 0 ? _f : this.heightOriginMode,
+        };
+        return TerrainSettings.fromJSON(props);
+    }
+}
+exports.TerrainSettings = TerrainSettings;
 //# sourceMappingURL=TerrainSettings.js.map

package/lib/cjs/TerrainSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"TerrainSettings.js","sourceRoot":"","sources":["../../src/TerrainSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAkCH;;;;GAIG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,sHAAsH;IACtH,6EAAY,CAAA;IACZ,0GAA0G;IAC1G,uEAAS,CAAA;IACT,yGAAyG;IACzG,yEAAU,CAAA;AACZ,CAAC,EAPW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAOlC;AAED;;GAEG;AACH,MAAa,eAAe;IAoB1B,YAAY,eAAoC,oBAAoB,EAAE,eAAuB,GAAG,EAAE,aAAa,GAAG,KAAK,EAAE,YAAY,GAAG,GAAG,EAAE,gBAAgB,GAAG,uBAAuB,CAAC,QAAQ;QAC9L,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;QAC/D,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,QAAQ,gBAAgB,EAAE;YACxB,KAAK,uBAAuB,CAAC,MAAM,CAAC;YACpC,KAAK,uBAAuB,CAAC,KAAK;gBAChC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;gBACzC,MAAM;YACR;gBACE,IAAI,CAAC,gBAAgB,GAAG,uBAAuB,CAAC,QAAQ,CAAC;gBACzD,MAAM;SACT;IACH,CAAC;IAtBD;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAkBM,MAAM,CAAC,QAAQ,CAAC,IAAmB;QACxC,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO,IAAI,eAAe,EAAE,CAAC;QAE/B,MAAM,YAAY,GAAG,oBAAoB,CAAC,CAAI,qDAAqD;QACnG,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpI,IAAI,IAAI,KAAK,IAAI,CAAC,YAAY;YAC5B,QAAQ,CAAC,aAAa,GAAG,IAAI,CAAC;QAEhC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAiB,EAAE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxE,IAAI,oBAAoB,KAAK,IAAI,CAAC,YAAY;YAC5C,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,IAAI,CAAC,aAAa;YACpB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,KAAsB;QAClC,OAAO,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;eACpI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC;IAChJ,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAA2B;;QACtC,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,aAAa,EAAE,MAAA,YAAY,CAAC,aAAa,mCAAI,IAAI,CAAC,aAAa;YAC/D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,gBAAgB,EAAE,MAAA,YAAY,CAAC,gBAAgB,mCAAI,IAAI,CAAC,gBAAgB;SACzE,CAAC;QAEF,OAAO,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CACF;AA7FD,0CA6FC","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 { BackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** The current set of supported terrain providers. Currently only CesiumWorldTerrain.\r\n * @see [[TerrainProps]]\r\n * @public\r\n * @extensions\r\n */\r\nexport type TerrainProviderName = \"CesiumWorldTerrain\";\r\n\r\n/**  JSON representation of the settings of the terrain applied to background map display by a [[DisplayStyle]].\r\n * @see [[DisplayStyleSettingsProps]]\r\n * @see [[BackgroundMapProps]]\r\n * @public\r\n * @extensions\r\n */\r\nexport interface TerrainProps {\r\n  /** Identifies the provider currently only CesiumWorldTerrain is supported. */\r\n  providerName?: string;\r\n  /** A value greater than one will cause terrain height to be exaggerated/scaled.false (or 1.0) indicate no exaggeration. Default value: 1.0 */\r\n  exaggeration?: number;\r\n  /**  Applying lighting can help to visualize subtle terrain variation.  Default value: true */\r\n  applyLighting?: boolean;\r\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value: 0.0 */\r\n  heightOrigin?: number;\r\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\r\n  heightOriginMode?: TerrainHeightOriginMode;\r\n  /** If true, the terrain will not be locatable. Otherwise, [[BackgroundMapProps.nonLocatable]] will determine whether terrain is locatable.\r\n   * @internal use [[BackgroundMapProps.nonLocatable]]. Retained for backwards compatibility only.\r\n   */\r\n  nonLocatable?: boolean;\r\n}\r\n\r\n/** Correction modes for terrain height\r\n * @see [[TerrainProps]]\r\n * @public\r\n * @extensions\r\n */\r\nexport enum TerrainHeightOriginMode {\r\n  /** Height value indicates the geodetic height of the IModel origin (also referred to as ellipsoidal or GPS height) */\r\n  Geodetic = 0,\r\n  /** Height value indicates the geoidal height of the IModel origin (commonly referred to as sea level). */\r\n  Geoid = 1,\r\n  /** Height value indicates the height of the IModel origin relative to ground level at project center. */\r\n  Ground = 2,\r\n}\r\n\r\n/** Normalized version of [[TerrainProps]] for which provider has been validated and default values of all members are used.\r\n * @public\r\n */\r\nexport class TerrainSettings {\r\n  private _nonLocatable: true | undefined;\r\n  /** Identifies the provider currently only CesiumWorldTerrain supported. */\r\n  public readonly providerName: TerrainProviderName;\r\n  /** A value greater than one will cause terrain height to be exaggerated/scaled. 1.0 indicates no exaggeration. Default value: 1.0 */\r\n  public readonly exaggeration: number;\r\n  /**  Applying lighting can help to visualize subtle terrain variations. Default value: false */\r\n  public readonly applyLighting: boolean;\r\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value 0.0 */\r\n  public readonly heightOrigin: number;\r\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\r\n  public readonly heightOriginMode: TerrainHeightOriginMode;\r\n  /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.\r\n   * @see [[TerrainProps.nonLocatable]].\r\n   * @internal\r\n   */\r\n  public get nonLocatable(): true | undefined {\r\n    return this._nonLocatable;\r\n  }\r\n\r\n  constructor(providerName: TerrainProviderName = \"CesiumWorldTerrain\", exaggeration: number = 1.0, applyLighting = false, heightOrigin = 0.0, heightOriginMode = TerrainHeightOriginMode.Geodetic) {\r\n    this.providerName = providerName;\r\n    this.exaggeration = Math.min(100, Math.max(0.1, exaggeration));\r\n    this.applyLighting = applyLighting;\r\n    this.heightOrigin = heightOrigin;\r\n    switch (heightOriginMode) {\r\n      case TerrainHeightOriginMode.Ground:\r\n      case TerrainHeightOriginMode.Geoid:\r\n        this.heightOriginMode = heightOriginMode;\r\n        break;\r\n      default:\r\n        this.heightOriginMode = TerrainHeightOriginMode.Geodetic;\r\n        break;\r\n    }\r\n  }\r\n\r\n  public static fromJSON(json?: TerrainProps) {\r\n    if (undefined === json)\r\n      return new TerrainSettings();\r\n\r\n    const providerName = \"CesiumWorldTerrain\";    // This is only terrain provider currently supported.\r\n    const settings = new TerrainSettings(providerName, json.exaggeration, json.applyLighting, json.heightOrigin, json.heightOriginMode);\r\n    if (true === json.nonLocatable)\r\n      settings._nonLocatable = true;\r\n\r\n    return settings;\r\n  }\r\n\r\n  public toJSON(): TerrainProps {\r\n    const props: TerrainProps = { heightOriginMode: this.heightOriginMode };\r\n    if (\"CesiumWorldTerrain\" !== this.providerName)\r\n      props.providerName = this.providerName;\r\n    if (1 !== this.exaggeration)\r\n      props.exaggeration = this.exaggeration;\r\n    if (this.nonLocatable)\r\n      props.nonLocatable = true;\r\n    if (this.applyLighting)\r\n      props.applyLighting = true;\r\n    if (0 !== this.heightOrigin)\r\n      props.heightOrigin = this.heightOrigin;\r\n\r\n    return props;\r\n  }\r\n\r\n  public equals(other: TerrainSettings): boolean {\r\n    return this.providerName === other.providerName && this.exaggeration === other.exaggeration && this.applyLighting === other.applyLighting\r\n      && this.heightOrigin === other.heightOrigin && this.heightOriginMode === other.heightOriginMode && this.nonLocatable === other.nonLocatable;\r\n  }\r\n\r\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\r\n  public equalsJSON(json?: BackgroundMapProps): boolean {\r\n    return this.equals(TerrainSettings.fromJSON(json));\r\n  }\r\n\r\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: TerrainProps): TerrainSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      providerName: changedProps.providerName ?? this.providerName,\r\n      exaggeration: changedProps.exaggeration ?? this.exaggeration,\r\n      nonLocatable: changedProps.nonLocatable ?? this.nonLocatable,\r\n      applyLighting: changedProps.applyLighting ?? this.applyLighting,\r\n      heightOrigin: changedProps.heightOrigin ?? this.heightOrigin,\r\n      heightOriginMode: changedProps.heightOriginMode ?? this.heightOriginMode,\r\n    };\r\n\r\n    return TerrainSettings.fromJSON(props);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TerrainSettings.js","sourceRoot":"","sources":["../../src/TerrainSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqCH;;;;GAIG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,sHAAsH;IACtH,6EAAY,CAAA;IACZ,0GAA0G;IAC1G,uEAAS,CAAA;IACT,yGAAyG;IACzG,yEAAU,CAAA;AACZ,CAAC,EAPW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAOlC;AAED;;GAEG;AACH,MAAa,eAAe;IAsB1B,YAAY,eAAuB,oBAAoB,EAAE,eAAuB,GAAG,EAAE,aAAa,GAAG,KAAK,EAAE,YAAY,GAAG,GAAG,EAAE,gBAAgB,GAAG,uBAAuB,CAAC,QAAQ;QACjL,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;QAC/D,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,QAAQ,gBAAgB,EAAE;YACxB,KAAK,uBAAuB,CAAC,MAAM,CAAC;YACpC,KAAK,uBAAuB,CAAC,KAAK;gBAChC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;gBACzC,MAAM;YACR;gBACE,IAAI,CAAC,gBAAgB,GAAG,uBAAuB,CAAC,QAAQ,CAAC;gBACzD,MAAM;SACT;IACH,CAAC;IAtBD;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAkBM,MAAM,CAAC,QAAQ,CAAC,IAAmB;;QACxC,IAAI,SAAS,KAAK,IAAI;YACpB,OAAO,IAAI,eAAe,EAAE,CAAC;QAE/B,MAAM,YAAY,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY,mCAAI,oBAAoB,CAAC;QAChE,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpI,IAAI,IAAI,KAAK,IAAI,CAAC,YAAY;YAC5B,QAAQ,CAAC,aAAa,GAAG,IAAI,CAAC;QAEhC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAAiB,EAAE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxE,IAAI,oBAAoB,KAAK,IAAI,CAAC,YAAY;YAC5C,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,IAAI,CAAC,aAAa;YACpB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,KAAK,IAAI,CAAC,YAAY;YACzB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,KAAsB;QAClC,OAAO,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;eACpI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC;IAChJ,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAA2B;;QACtC,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,aAAa,EAAE,MAAA,YAAY,CAAC,aAAa,mCAAI,IAAI,CAAC,aAAa;YAC/D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,gBAAgB,EAAE,MAAA,YAAY,CAAC,gBAAgB,mCAAI,IAAI,CAAC,gBAAgB;SACzE,CAAC;QAEF,OAAO,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CACF;AA/FD,0CA+FC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Identifies a [TerrainProvider]($frontend).\n * @see [[TerrainSettings.providerName]] and [[TerrainProps.providerName]].\n * @public\n * @extensions\n * @deprecated Use string instead.\n */\nexport type TerrainProviderName = string;\n\n/**  JSON representation of the settings of the terrain applied to background map display by a [[DisplayStyle]].\n * @see [[DisplayStyleSettingsProps]]\n * @see [[BackgroundMapProps]]\n * @public\n * @extensions\n */\nexport interface TerrainProps {\n  /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.\n   * If omitted, it defaults to \"CesiumWorldTerrain\".\n   */\n  providerName?: string;\n  /** A value greater than one will cause terrain height to be exaggerated/scaled.false (or 1.0) indicate no exaggeration. Default value: 1.0 */\n  exaggeration?: number;\n  /**  Applying lighting can help to visualize subtle terrain variation.  Default value: true */\n  applyLighting?: boolean;\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value: 0.0 */\n  heightOrigin?: number;\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\n  heightOriginMode?: TerrainHeightOriginMode;\n  /** If true, the terrain will not be locatable. Otherwise, [[BackgroundMapProps.nonLocatable]] will determine whether terrain is locatable.\n   * @internal use [[BackgroundMapProps.nonLocatable]]. Retained for backwards compatibility only.\n   */\n  nonLocatable?: boolean;\n}\n\n/** Correction modes for terrain height\n * @see [[TerrainProps]]\n * @public\n * @extensions\n */\nexport enum TerrainHeightOriginMode {\n  /** Height value indicates the geodetic height of the IModel origin (also referred to as ellipsoidal or GPS height) */\n  Geodetic = 0,\n  /** Height value indicates the geoidal height of the IModel origin (commonly referred to as sea level). */\n  Geoid = 1,\n  /** Height value indicates the height of the IModel origin relative to ground level at project center. */\n  Ground = 2,\n}\n\n/** Normalized version of [[TerrainProps]] for which provider has been validated and default values of all members are used.\n * @public\n */\nexport class TerrainSettings {\n  private _nonLocatable: true | undefined;\n  /** Identifies the [TerrainProvider]($frontend) that will supply terrain meshes.\n   * Defaults to \"CesiumWorldTerrain\".\n   */\n  public readonly providerName: string;\n  /** A value greater than one will cause terrain height to be exaggerated/scaled. 1.0 indicates no exaggeration. Default value: 1.0 */\n  public readonly exaggeration: number;\n  /**  Applying lighting can help to visualize subtle terrain variations. Default value: false */\n  public readonly applyLighting: boolean;\n  /** Origin value - height of the IModel origin at the project center as defined by heightOriginMode. Default value 0.0 */\n  public readonly heightOrigin: number;\n  /** Determines how/if the heightOrigin is applied to the terrain height. Default value: Geodetic */\n  public readonly heightOriginMode: TerrainHeightOriginMode;\n  /** Optionally overrides [[BackgroundMapSettings.locatable]]. For backwards compatibility only.\n   * @see [[TerrainProps.nonLocatable]].\n   * @internal\n   */\n  public get nonLocatable(): true | undefined {\n    return this._nonLocatable;\n  }\n\n  constructor(providerName: string = \"CesiumWorldTerrain\", exaggeration: number = 1.0, applyLighting = false, heightOrigin = 0.0, heightOriginMode = TerrainHeightOriginMode.Geodetic) {\n    this.providerName = providerName;\n    this.exaggeration = Math.min(100, Math.max(0.1, exaggeration));\n    this.applyLighting = applyLighting;\n    this.heightOrigin = heightOrigin;\n    switch (heightOriginMode) {\n      case TerrainHeightOriginMode.Ground:\n      case TerrainHeightOriginMode.Geoid:\n        this.heightOriginMode = heightOriginMode;\n        break;\n      default:\n        this.heightOriginMode = TerrainHeightOriginMode.Geodetic;\n        break;\n    }\n  }\n\n  public static fromJSON(json?: TerrainProps) {\n    if (undefined === json)\n      return new TerrainSettings();\n\n    const providerName = json?.providerName ?? \"CesiumWorldTerrain\";\n    const settings = new TerrainSettings(providerName, json.exaggeration, json.applyLighting, json.heightOrigin, json.heightOriginMode);\n    if (true === json.nonLocatable)\n      settings._nonLocatable = true;\n\n    return settings;\n  }\n\n  public toJSON(): TerrainProps {\n    const props: TerrainProps = { heightOriginMode: this.heightOriginMode };\n    if (\"CesiumWorldTerrain\" !== this.providerName)\n      props.providerName = this.providerName;\n    if (1 !== this.exaggeration)\n      props.exaggeration = this.exaggeration;\n    if (this.nonLocatable)\n      props.nonLocatable = true;\n    if (this.applyLighting)\n      props.applyLighting = true;\n    if (0 !== this.heightOrigin)\n      props.heightOrigin = this.heightOrigin;\n\n    return props;\n  }\n\n  public equals(other: TerrainSettings): boolean {\n    return this.providerName === other.providerName && this.exaggeration === other.exaggeration && this.applyLighting === other.applyLighting\n      && this.heightOrigin === other.heightOrigin && this.heightOriginMode === other.heightOriginMode && this.nonLocatable === other.nonLocatable;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(TerrainSettings.fromJSON(json));\n  }\n\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A TerrainSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: TerrainProps): TerrainSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      providerName: changedProps.providerName ?? this.providerName,\n      exaggeration: changedProps.exaggeration ?? this.exaggeration,\n      nonLocatable: changedProps.nonLocatable ?? this.nonLocatable,\n      applyLighting: changedProps.applyLighting ?? this.applyLighting,\n      heightOrigin: changedProps.heightOrigin ?? this.heightOrigin,\n      heightOriginMode: changedProps.heightOriginMode ?? this.heightOriginMode,\n    };\n\n    return TerrainSettings.fromJSON(props);\n  }\n}\n"]}

package/lib/cjs/TextureMapping.d.ts

@@ -1,102 +1,102 @@
-/** @packageDocumentation
- * @module Rendering
- */
-import { IndexedPolyfaceVisitor, Point2d, PolyfaceVisitor, Transform } from "@itwin/core-geometry";
-import { RenderTexture } from "./RenderTexture";
-/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].
- * @public
- */
-export declare class TextureMapping {
-    /** The texture to be mapped to the surface. */
-    readonly texture: RenderTexture;
-    /** The parameters describing how the texture image is mapped to the surface. */
-    readonly params: TextureMapping.Params;
-    constructor(tx: RenderTexture, params: TextureMapping.Params);
-    /** @internal */
-    computeUVParams(visitor: PolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined;
-}
-/** @public */
-export declare namespace TextureMapping {
-    /** Enumerates the possible texture mapping modes. */
-    enum Mode {
-        None = -1,
-        Parametric = 0,
-        ElevationDrape = 1,
-        Planar = 2,
-        /** @internal */
-        DirectionalDrape = 3,
-        /** @internal */
-        Cubic = 4,
-        /** @internal */
-        Spherical = 5,
-        /** @internal */
-        Cylindrical = 6,
-        /** @internal */
-        Solid = 7,
-        /** @internal Only valid for lights */
-        FrontProject = 8
-    }
-    /** A 2x3 matrix for mapping a texture image to a surface. */
-    class Trans2x3 {
-        /** The 3x4 transform produced from the 2x3 matrix. */
-        readonly transform: Transform;
-        /** Construct from the two rows of the matrix:
-         * ```
-         *  | m00 m01 originX |
-         *  | m10 m11 originY |
-         * ```
-         * Producing the [Transform]($core-geometry):
-         * ```
-         *  | m00 m01 0 originX |
-         *  | m10 m11 0 originY |
-         *  | 0   0   1 0       |
-         * ```
-         */
-        constructor(m00?: number, m01?: number, originX?: number, m10?: number, m11?: number, originY?: number);
-        /** An immutable 2x3 identity matrix. */
-        static readonly identity: Trans2x3;
-    }
-    /** Properties used to construct a [[TextureMapping.Params]]. */
-    interface ParamProps {
-        /** The matrix used to map the image to a surface. */
-        textureMat2x3?: TextureMapping.Trans2x3;
-        /** The ratio in [0, 1] with which to mix the color sampled from the texture with the surface's color.
-         * A value of 0.0 uses only the surface color. A value of 1.0 uses only the texture color. A value of 0.5 uses an even mix of both.
-         * @note This affects only the red, green, and blue components of the color. The alpha sampled from the texture is always multiplied by the surface color's alpha.
-         * @note Defaults to 1.0
-         */
-        textureWeight?: number;
-        /** The mode by which to map the image to a surface.
-         * @note Defaults to [[TextureMapping.Mode.Parametric]].
-         */
-        mapMode?: TextureMapping.Mode;
-        /** @internal */
-        worldMapping?: boolean;
-    }
-    /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */
-    class Params {
-        /** The matrix used to map the image to a surface. */
-        textureMatrix: TextureMapping.Trans2x3;
-        /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.
-         * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.
-         */
-        weight: number;
-        /** The mode by which to map the image to a surface. */
-        mode: TextureMapping.Mode;
-        /** @internal */
-        worldMapping: boolean;
-        constructor(props?: TextureMapping.ParamProps);
-        /**
-         * Generates UV parameters for textured surfaces. Returns undefined on failure.
-         * @internal
-         */
-        computeUVParams(visitor: IndexedPolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined;
-        /** Computes UV parameters given a texture mapping mode of parametric. */
-        private computeParametricUVParams;
-        /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */
-        private computePlanarUVParams;
-        /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */
-        private computeElevationDrapeUVParams;
-    }
-}
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { IndexedPolyfaceVisitor, Point2d, PolyfaceVisitor, Transform } from "@itwin/core-geometry";
+import { RenderTexture } from "./RenderTexture";
+/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].
+ * @public
+ */
+export declare class TextureMapping {
+    /** The texture to be mapped to the surface. */
+    readonly texture: RenderTexture;
+    /** The parameters describing how the texture image is mapped to the surface. */
+    readonly params: TextureMapping.Params;
+    constructor(tx: RenderTexture, params: TextureMapping.Params);
+    /** @internal */
+    computeUVParams(visitor: PolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined;
+}
+/** @public */
+export declare namespace TextureMapping {
+    /** Enumerates the possible texture mapping modes. */
+    enum Mode {
+        None = -1,
+        Parametric = 0,
+        ElevationDrape = 1,
+        Planar = 2,
+        /** @internal */
+        DirectionalDrape = 3,
+        /** @internal */
+        Cubic = 4,
+        /** @internal */
+        Spherical = 5,
+        /** @internal */
+        Cylindrical = 6,
+        /** @internal */
+        Solid = 7,
+        /** @internal Only valid for lights */
+        FrontProject = 8
+    }
+    /** A 2x3 matrix for mapping a texture image to a surface. */
+    class Trans2x3 {
+        /** The 3x4 transform produced from the 2x3 matrix. */
+        readonly transform: Transform;
+        /** Construct from the two rows of the matrix:
+         * ```
+         *  | m00 m01 originX |
+         *  | m10 m11 originY |
+         * ```
+         * Producing the [Transform]($core-geometry):
+         * ```
+         *  | m00 m01 0 originX |
+         *  | m10 m11 0 originY |
+         *  | 0   0   1 0       |
+         * ```
+         */
+        constructor(m00?: number, m01?: number, originX?: number, m10?: number, m11?: number, originY?: number);
+        /** An immutable 2x3 identity matrix. */
+        static readonly identity: Trans2x3;
+    }
+    /** Properties used to construct a [[TextureMapping.Params]]. */
+    interface ParamProps {
+        /** The matrix used to map the image to a surface. */
+        textureMat2x3?: TextureMapping.Trans2x3;
+        /** The ratio in [0, 1] with which to mix the color sampled from the texture with the surface's color.
+         * A value of 0.0 uses only the surface color. A value of 1.0 uses only the texture color. A value of 0.5 uses an even mix of both.
+         * @note This affects only the red, green, and blue components of the color. The alpha sampled from the texture is always multiplied by the surface color's alpha.
+         * @note Defaults to 1.0
+         */
+        textureWeight?: number;
+        /** The mode by which to map the image to a surface.
+         * @note Defaults to [[TextureMapping.Mode.Parametric]].
+         */
+        mapMode?: TextureMapping.Mode;
+        /** @internal */
+        worldMapping?: boolean;
+    }
+    /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */
+    class Params {
+        /** The matrix used to map the image to a surface. */
+        textureMatrix: TextureMapping.Trans2x3;
+        /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.
+         * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.
+         */
+        weight: number;
+        /** The mode by which to map the image to a surface. */
+        mode: TextureMapping.Mode;
+        /** @internal */
+        worldMapping: boolean;
+        constructor(props?: TextureMapping.ParamProps);
+        /**
+         * Generates UV parameters for textured surfaces. Returns undefined on failure.
+         * @internal
+         */
+        computeUVParams(visitor: IndexedPolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined;
+        /** Computes UV parameters given a texture mapping mode of parametric. */
+        private computeParametricUVParams;
+        /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */
+        private computePlanarUVParams;
+        /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */
+        private computeElevationDrapeUVParams;
+    }
+}
 //# sourceMappingURL=TextureMapping.d.ts.map