@itwin/core-common 3.0.0-extension.0 → 3.1.0-dev.5

package/lib/esm/IModel.d.ts

@@ -29,6 +29,18 @@ export interface IModelRpcProps extends IModelRpcOpenProps {
     readonly key: string;
 }
 /** Properties that position an iModel on the earth via [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates
+ * The origin is specified as an ECEF coordinate. The cartographicOrigin property contains the latitude, longitude and elevation above the WGS84 ellipsoid
+ * of the origin property. This cartographicOrigin is offered as a convenient pre-calculated value representing the location of the ECEF origin.
+ * The 3D coordinate system this class represents is positioned at specified origin and the axis positioned according to
+ * the other properties.
+ * If the xVector and yVector properties are defined then they take precedence over the YawPitchRoll orientation property. The xVector and yVector
+ * represent the direction and scale of the X and Y axes. The Z axis is always perpendicular (according to the right hand rule) to these X-Y axes.
+ * The scaling in the Z direction is always unity. The scale of the X and Y axes is represented by the size of the vector length.
+ * If the xVector and yVector are not present then the YawPitchRoll properties indicates the angles for all tree axes. Scaling in that case
+ * is unity in all three directions.
+ * Note that the present class is intended to represent geolocated 3D coordinate systems that are normally tangent to the WGS84 ellipsoid
+ * possibly offset in altitude by the terrain elevation above the ellipsoid but other general 3D coordinate systems
+ * can be defined.
  * @public
  */
 export interface EcefLocationProps {
@@ -162,6 +174,7 @@ export interface FilePropertyProps {
     subId?: number | string;
 }
 /** The position and orientation of an iModel on the earth in [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates
+ * @note This is an immutable type - all of its properties are frozen.
  * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)
  * @public
  */
@@ -176,7 +189,7 @@ export declare class EcefLocation implements EcefLocationProps {
     readonly xVector?: Vector3d;
     /** Optional Y column vector used with [[xVector]] to calculate potentially non-rigid transform if a projection is present. */
     readonly yVector?: Vector3d;
-    private _transform;
+    private readonly _transform;
     /** Get the transform from iModel Spatial coordinates to ECEF from this EcefLocation */
     getTransform(): Transform;
     /** Construct a new EcefLocation. Once constructed, it is frozen and cannot be modified. */
@@ -199,7 +212,6 @@ export declare abstract class IModel implements IModelProps {
     private _rootSubject?;
     private _globalOrigin?;
     private _ecefLocation?;
-    private _ecefTrans?;
     private _geographicCoordinateSystem?;
     private _iModelId?;
     /** The Id of the repository model. */
@@ -240,7 +252,17 @@ export declare abstract class IModel implements IModelProps {
     /** An offset to be applied to all spatial coordinates. */
     get globalOrigin(): Point3d;
     set globalOrigin(org: Point3d);
-    /** The [EcefLocation]($docs/learning/glossary#ecefLocation) of the iModel in Earth Centered Earth Fixed coordinates. */
+    /** The [EcefLocation]($docs/learning/glossary#ecefLocation) of the iModel in Earth Centered Earth Fixed coordinates.
+     * If the iModel property geographicCoordinateSystem is not defined then the ecefLocation provides a geolocation by defining a
+     * 3D coordinate system relative to the Earth model WGS84. Refer to additional documentation for details. If the geographicCoordinateSystem
+     * property is defined then the ecefLocation must be used with care. When the geographicCoordinateSystem is defined it indicates the
+     * iModel cartesian space is the result of a cartographic projection. This implies a flattening of the Earth surface process that
+     * results in scale, angular or area distortion. The ecefLocation is then an approximation calculated at the center of the project extent.
+     * If the project is more than 2 kilometer in size, the ecefLocation may represent a poor approximation of the effective
+     * cartographic projection used and a linear transformation should then be calculated at the exact origin of the data
+     * it must position.
+     * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)
+    */
     get ecefLocation(): EcefLocation | undefined;
     set ecefLocation(ecefLocation: EcefLocation | undefined);
     /** Set the [EcefLocation]($docs/learning/glossary#ecefLocation) for this iModel. */
@@ -271,8 +293,15 @@ export declare abstract class IModel implements IModelProps {
     protected _openMode: OpenMode;
     /** The [[OpenMode]] used for this IModel. */
     get openMode(): OpenMode;
-    /** Return a token for RPC operations. */
+    /** Return a token for RPC operations.
+     * @throws IModelError if the iModel is not open.
+     */
     getRpcProps(): IModelRpcProps;
+    /** Returns the iModel's RPC properties.
+     * @note It is an error to attempt to use these properties as a token for RPC operations if the iModel is not open.
+     * @internal
+     */
+    protected _getRpcProps(): IModelRpcProps;
     /** @internal */
     protected constructor(tokenProps?: IModelRpcProps);
     /** @internal */

package/lib/esm/IModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IModel.d.ts","sourceRoot":"","sources":["../../src/IModel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAAoB,UAAU,EAAQ,UAAU,EAAyB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACvI,OAAO,EACL,KAAK,EAAsD,OAAO,EAAW,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAChI,kBAAkB,EAAE,iBAAiB,EACtC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kHAAkH;IAClH,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,0BAA0B;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,sFAAsF;IACtF,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,+DAA+D;IAC/D,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC1B,mHAAmH;IACnH,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IACxC,6EAA6E;IAC7E,QAAQ,CAAC,kBAAkB,CAAC,EAAE,iBAAiB,CAAC;IAChD,8HAA8H;IAC9H,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAC5B,8HAA8H;IAC9H,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,kEAAkE;IAClE,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACvC,+DAA+D;IAC/D,QAAQ,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC;IACvC,yLAAyL;IACzL,QAAQ,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC;IACjC,2GAA2G;IAC3G,QAAQ,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC;IAC1C,2FAA2F;IAC3F,QAAQ,CAAC,0BAA0B,CAAC,EAAE,kBAAkB,CAAC;IACzD,8BAA8B;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,oBAAY,qBAAqB,GAAG,WAAW,GAAG,cAAc,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,wEAAwE;IACxE,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB,EAAE,SAAS;IAC3E,gBAAgB;IAChB,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,gBAAgB;IAChB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;GAGG;AACH,oBAAY,qBAAqB,GAAG,SAAS,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACtE;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;GAGG;AACH,oBAAY,8BAA8B,GAAG,iBAAiB,GAAG,yBAAyB,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,yFAAyF;IACzF,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,oBAAY,gCAAgC,GAAG,iBAAiB,GAAG,2BAA2B,CAAC;AAE/F,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,qBAAa,YAAa,YAAW,iBAAiB;IACpD,wCAAwC;IACxC,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,4CAA4C;IAC5C,SAAgB,WAAW,EAAE,kBAAkB,CAAC;IAChD,wFAAwF;IACxF,SAAgB,kBAAkB,CAAC,EAAE,YAAY,CAAC;IAClD,8HAA8H;IAC9H,SAAgB,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnC,8HAA8H;IAC9H,SAAgB,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnC,OAAO,CAAC,UAAU,CAAY;IAE9B,uFAAuF;IAChF,YAAY,IAAI,SAAS;IAEhC,2FAA2F;gBAC/E,KAAK,EAAE,iBAAiB;IAqBpC,8FAA8F;WAChF,4BAA4B,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAsB/F,4EAA4E;IAC5E,IAAW,WAAW,IAAI,OAAO,CAGhC;IAED,+FAA+F;IACxF,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO;IAqB3C,MAAM,IAAI,iBAAiB;CAiBnC;AAED;;;GAGG;AACH,8BAAsB,MAAO,YAAW,WAAW;IACjD,OAAO,CAAC,eAAe,CAAC,CAAmB;IAC3C,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB,OAAO,CAAC,YAAY,CAAC,CAAmB;IACxC,OAAO,CAAC,aAAa,CAAC,CAAU;IAChC,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,2BAA2B,CAAC,CAAgB;IACpD,OAAO,CAAC,SAAS,CAAC,CAAa;IAE/B,sCAAsC;IACtC,gBAAuB,iBAAiB,EAAE,UAAU,CAAS;IAC7D,0CAA0C;IAC1C,gBAAuB,aAAa,EAAE,UAAU,CAAS;IACzD,sCAAsC;IACtC,gBAAuB,YAAY,EAAE,UAAU,CAAU;IAEzD,2CAA2C;IAC3C,SAAgB,aAAa,yBAA8B,MAAM,KAAK,IAAI,EAAI;IAC9E,kDAAkD;IAClD,SAAgB,oBAAoB,4BAAiC,gBAAgB,KAAK,IAAI,EAAI;IAClG,qDAAqD;IACrD,SAAgB,uBAAuB,4BAAiC,gBAAgB,KAAK,IAAI,EAAI;IACrG,mDAAmD;IACnD,SAAgB,qBAAqB,2BAAgC,OAAO,KAAK,IAAI,EAAI;IACzF,mDAAmD;IACnD,SAAgB,qBAAqB,6BAAkC,YAAY,GAAG,SAAS,KAAK,IAAI,EAAI;IAC5G,iEAAiE;IACjE,SAAgB,mCAAmC,wBAA6B,aAAa,GAAG,SAAS,KAAK,IAAI,EAAI;IAEtH,yBAAyB;IACzB,IAAW,IAAI,IAAI,MAAM,CAGxB;IACD,IAAW,IAAI,CAAC,IAAI,EAAE,MAAM,EAO3B;IAED,kEAAkE;IAClE,IAAW,WAAW,IAAI,gBAAgB,CAGzC;IACD,IAAW,WAAW,CAAC,OAAO,EAAE,gBAAgB,EAO/C;IAED,mDAAmD;IACnD,aAAoB,UAAU,IAAI,OAAO,CAAC;IAC1C,mGAAmG;IACnG,aAAoB,WAAW,IAAI,OAAO,CAAC;IAE3C,aAAoB,MAAM,IAAI,OAAO,CAAC;IAEtC;;;OAGG;IACH,IAAW,cAAc,IAIU,gBAAgB,CADlD;IACD,IAAW,cAAc,CAAC,OAAO,EAAE,gBAAgB,EAWlD;IAED,0DAA0D;IAC1D,IAAW,YAAY,IAAI,OAAO,CAGjC;IACD,IAAW,YAAY,CAAC,GAAG,EAAE,OAAO,EAQnC;IAED,wHAAwH;IACxH,IAAW,YAAY,IAAI,YAAY,GAAG,SAAS,CAElD;IACD,IAAW,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,SAAS,EAS7D;IAED,oFAAoF;IAC7E,eAAe,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI;IAIrD,gEAAgE;IAChE,IAAW,0BAA0B,IAAI,aAAa,GAAG,SAAS,CAEjE;IACD,IAAW,0BAA0B,CAAC,MAAM,EAAE,aAAa,GAAG,SAAS,EAStE;IAED,+EAA+E;IACxE,6BAA6B,CAAC,MAAM,EAAE,kBAAkB;IAI/D,gBAAgB;IACT,kBAAkB,IAAI,qBAAqB;IAYlD,gBAAgB;IACT,MAAM,IAAI,qBAAqB;IAItC;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC3B,4GAA4G;IAC5G,IAAW,GAAG,IAAI,MAAM,CAA0B;IAElD,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;IAChC,gEAAgE;IAChE,IAAW,OAAO,IAAI,UAAU,GAAG,SAAS,CAA0B;IAEtE,4CAA4C;IAC5C,IAAW,QAAQ,IAAI,UAAU,GAAG,SAAS,CAA2B;IAExE,cAAc;IACP,SAAS,EAAE,oBAAoB,CAAC;IAEvC,SAAS,CAAC,SAAS,WAAqB;IACxC,6CAA6C;IAC7C,IAAW,QAAQ,IAAI,QAAQ,CAA2B;IAE1D,yCAAyC;IAClC,WAAW,IAAI,cAAc;IAYpC,gBAAgB;IAChB,SAAS,aAAa,UAAU,CAAC,EAAE,cAAc;IAYjD,gBAAgB;IAChB,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW;IASrD,gEAAgE;WAClD,uBAAuB,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU;IAIzE,uFAAuF;IACvF,IAAW,YAAY,YAA+C;IAEtE;;OAEG;IACI,gBAAgB,IAAI,SAAS;IAYpC;;;;;OAKG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAEhE;;;;;;OAMG;IACI,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAE7D;;;;;OAKG;IACI,6BAA6B,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY;IAE1F;;;;;;OAMG;IACI,6BAA6B,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,OAAO;CAClF"}
+{"version":3,"file":"IModel.d.ts","sourceRoot":"","sources":["../../src/IModel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAAoB,UAAU,EAAQ,UAAU,EAAyB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACvI,OAAO,EACL,KAAK,EAAsD,OAAO,EAAW,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAChI,kBAAkB,EAAE,iBAAiB,EACtC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kHAAkH;IAClH,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,0BAA0B;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,sFAAsF;IACtF,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,iBAAiB;IAChC,+DAA+D;IAC/D,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC1B,mHAAmH;IACnH,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IACxC,6EAA6E;IAC7E,QAAQ,CAAC,kBAAkB,CAAC,EAAE,iBAAiB,CAAC;IAChD,8HAA8H;IAC9H,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAC5B,8HAA8H;IAC9H,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,kEAAkE;IAClE,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACvC,+DAA+D;IAC/D,QAAQ,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC;IACvC,yLAAyL;IACzL,QAAQ,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC;IACjC,2GAA2G;IAC3G,QAAQ,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC;IAC1C,2FAA2F;IAC3F,QAAQ,CAAC,0BAA0B,CAAC,EAAE,kBAAkB,CAAC;IACzD,8BAA8B;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,oBAAY,qBAAqB,GAAG,WAAW,GAAG,cAAc,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,wEAAwE;IACxE,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB,EAAE,SAAS;IAC3E,gBAAgB;IAChB,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,gBAAgB;IAChB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;GAGG;AACH,oBAAY,qBAAqB,GAAG,SAAS,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACtE;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;GAGG;AACH,oBAAY,8BAA8B,GAAG,iBAAiB,GAAG,yBAAyB,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,yFAAyF;IACzF,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,oBAAY,gCAAgC,GAAG,iBAAiB,GAAG,2BAA2B,CAAC;AAE/F,cAAc;AACd,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,qBAAa,YAAa,YAAW,iBAAiB;IACpD,wCAAwC;IACxC,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,4CAA4C;IAC5C,SAAgB,WAAW,EAAE,kBAAkB,CAAC;IAChD,wFAAwF;IACxF,SAAgB,kBAAkB,CAAC,EAAE,YAAY,CAAC;IAClD,8HAA8H;IAC9H,SAAgB,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnC,8HAA8H;IAC9H,SAAgB,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IAEvC,uFAAuF;IAChF,YAAY,IAAI,SAAS;IAEhC,2FAA2F;gBAC/E,KAAK,EAAE,iBAAiB;IAsBpC,8FAA8F;WAChF,4BAA4B,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAsB/F,4EAA4E;IAC5E,IAAW,WAAW,IAAI,OAAO,CAGhC;IAED,+FAA+F;IACxF,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO;IAqB3C,MAAM,IAAI,iBAAiB;CAiBnC;AAED;;;GAGG;AACH,8BAAsB,MAAO,YAAW,WAAW;IACjD,OAAO,CAAC,eAAe,CAAC,CAAmB;IAC3C,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB,OAAO,CAAC,YAAY,CAAC,CAAmB;IACxC,OAAO,CAAC,aAAa,CAAC,CAAU;IAChC,OAAO,CAAC,aAAa,CAAC,CAAe;IACrC,OAAO,CAAC,2BAA2B,CAAC,CAAgB;IACpD,OAAO,CAAC,SAAS,CAAC,CAAa;IAE/B,sCAAsC;IACtC,gBAAuB,iBAAiB,EAAE,UAAU,CAAS;IAC7D,0CAA0C;IAC1C,gBAAuB,aAAa,EAAE,UAAU,CAAS;IACzD,sCAAsC;IACtC,gBAAuB,YAAY,EAAE,UAAU,CAAU;IAEzD,2CAA2C;IAC3C,SAAgB,aAAa,yBAA8B,MAAM,KAAK,IAAI,EAAI;IAC9E,kDAAkD;IAClD,SAAgB,oBAAoB,4BAAiC,gBAAgB,KAAK,IAAI,EAAI;IAClG,qDAAqD;IACrD,SAAgB,uBAAuB,4BAAiC,gBAAgB,KAAK,IAAI,EAAI;IACrG,mDAAmD;IACnD,SAAgB,qBAAqB,2BAAgC,OAAO,KAAK,IAAI,EAAI;IACzF,mDAAmD;IACnD,SAAgB,qBAAqB,6BAAkC,YAAY,GAAG,SAAS,KAAK,IAAI,EAAI;IAC5G,iEAAiE;IACjE,SAAgB,mCAAmC,wBAA6B,aAAa,GAAG,SAAS,KAAK,IAAI,EAAI;IAEtH,yBAAyB;IACzB,IAAW,IAAI,IAAI,MAAM,CAGxB;IACD,IAAW,IAAI,CAAC,IAAI,EAAE,MAAM,EAO3B;IAED,kEAAkE;IAClE,IAAW,WAAW,IAAI,gBAAgB,CAGzC;IACD,IAAW,WAAW,CAAC,OAAO,EAAE,gBAAgB,EAO/C;IAED,mDAAmD;IACnD,aAAoB,UAAU,IAAI,OAAO,CAAC;IAC1C,mGAAmG;IACnG,aAAoB,WAAW,IAAI,OAAO,CAAC;IAE3C,aAAoB,MAAM,IAAI,OAAO,CAAC;IAEtC;;;OAGG;IACH,IAAW,cAAc,IAIU,gBAAgB,CADlD;IACD,IAAW,cAAc,CAAC,OAAO,EAAE,gBAAgB,EAWlD;IAED,0DAA0D;IAC1D,IAAW,YAAY,IAAI,OAAO,CAGjC;IACD,IAAW,YAAY,CAAC,GAAG,EAAE,OAAO,EAQnC;IAED;;;;;;;;;;MAUE;IACF,IAAW,YAAY,IAAI,YAAY,GAAG,SAAS,CAElD;IACD,IAAW,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,SAAS,EAS7D;IAED,oFAAoF;IAC7E,eAAe,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI;IAIrD,gEAAgE;IAChE,IAAW,0BAA0B,IAAI,aAAa,GAAG,SAAS,CAEjE;IACD,IAAW,0BAA0B,CAAC,MAAM,EAAE,aAAa,GAAG,SAAS,EAStE;IAED,+EAA+E;IACxE,6BAA6B,CAAC,MAAM,EAAE,kBAAkB;IAI/D,gBAAgB;IACT,kBAAkB,IAAI,qBAAqB;IAYlD,gBAAgB;IACT,MAAM,IAAI,qBAAqB;IAItC;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC3B,4GAA4G;IAC5G,IAAW,GAAG,IAAI,MAAM,CAA0B;IAElD,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;IAChC,gEAAgE;IAChE,IAAW,OAAO,IAAI,UAAU,GAAG,SAAS,CAA0B;IAEtE,4CAA4C;IAC5C,IAAW,QAAQ,IAAI,UAAU,GAAG,SAAS,CAA2B;IAExE,cAAc;IACP,SAAS,EAAE,oBAAoB,CAAC;IAEvC,SAAS,CAAC,SAAS,WAAqB;IACxC,6CAA6C;IAC7C,IAAW,QAAQ,IAAI,QAAQ,CAA2B;IAE1D;;OAEG;IACI,WAAW,IAAI,cAAc;IAOpC;;;OAGG;IACH,SAAS,CAAC,YAAY,IAAI,cAAc;IASxC,gBAAgB;IAChB,SAAS,aAAa,UAAU,CAAC,EAAE,cAAc;IAYjD,gBAAgB;IAChB,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW;IASrD,gEAAgE;WAClD,uBAAuB,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU;IAIzE,uFAAuF;IACvF,IAAW,YAAY,YAA+C;IAEtE;;OAEG;IACI,gBAAgB,IAAI,SAAS;IAMpC;;;;;OAKG;IACI,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAEhE;;;;;;OAMG;IACI,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAE7D;;;;;OAKG;IACI,6BAA6B,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY;IAE1F;;;;;;OAMG;IACI,6BAA6B,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,OAAO;CAClF"}

package/lib/esm/IModel.js

@@ -11,6 +11,7 @@ import { Cartographic } from "./geometry/Cartographic";
 import { GeographicCRS } from "./geometry/CoordinateReferenceSystem";
 import { IModelError } from "./IModelError";
 /** The position and orientation of an iModel on the earth in [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates
+ * @note This is an immutable type - all of its properties are frozen.
  * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)
  * @public
  */
@@ -22,8 +23,8 @@ export class EcefLocation {
         if (props.cartographicOrigin)
             this.cartographicOrigin = Cartographic.fromRadians({ longitude: props.cartographicOrigin.longitude, latitude: props.cartographicOrigin.latitude, height: props.cartographicOrigin.height }).freeze();
         if (props.xVector && props.yVector) {
-            this.xVector = Vector3d.fromJSON(props.xVector);
-            this.yVector = Vector3d.fromJSON(props.yVector);
+            this.xVector = Vector3d.fromJSON(props.xVector).freeze();
+            this.yVector = Vector3d.fromJSON(props.yVector).freeze();
         }
         let matrix;
         if (this.xVector && this.yVector) {
@@ -34,6 +35,7 @@ export class EcefLocation {
         if (!matrix)
             matrix = this.orientation.toMatrix3d();
         this._transform = Transform.createOriginAndMatrix(this.origin, matrix);
+        this._transform.freeze();
     }
     /** Get the transform from iModel Spatial coordinates to ECEF from this EcefLocation */
     getTransform() { return this._transform; }
@@ -183,7 +185,17 @@ export class IModel {
                 this.onGlobalOriginChanged.raiseEvent(old);
         }
     }
-    /** The [EcefLocation]($docs/learning/glossary#ecefLocation) of the iModel in Earth Centered Earth Fixed coordinates. */
+    /** The [EcefLocation]($docs/learning/glossary#ecefLocation) of the iModel in Earth Centered Earth Fixed coordinates.
+     * If the iModel property geographicCoordinateSystem is not defined then the ecefLocation provides a geolocation by defining a
+     * 3D coordinate system relative to the Earth model WGS84. Refer to additional documentation for details. If the geographicCoordinateSystem
+     * property is defined then the ecefLocation must be used with care. When the geographicCoordinateSystem is defined it indicates the
+     * iModel cartesian space is the result of a cartographic projection. This implies a flattening of the Earth surface process that
+     * results in scale, angular or area distortion. The ecefLocation is then an approximation calculated at the center of the project extent.
+     * If the project is more than 2 kilometer in size, the ecefLocation may represent a poor approximation of the effective
+     * cartographic projection used and a linear transformation should then be calculated at the exact origin of the data
+     * it must position.
+     * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)
+    */
     get ecefLocation() {
         return this._ecefLocation;
     }
@@ -226,7 +238,7 @@ export class IModel {
             globalOrigin: this.globalOrigin.toJSON(),
             ecefLocation: this.ecefLocation,
             geographicCoordinateSystem: this.geographicCoordinateSystem,
-            ...this.getRpcProps(),
+            ...this._getRpcProps(),
         };
     }
     /** @internal */
@@ -241,10 +253,19 @@ export class IModel {
     get iModelId() { return this._iModelId; }
     /** The [[OpenMode]] used for this IModel. */
     get openMode() { return this._openMode; }
-    /** Return a token for RPC operations. */
+    /** Return a token for RPC operations.
+     * @throws IModelError if the iModel is not open.
+     */
     getRpcProps() {
         if (!this.isOpen)
             throw new IModelError(IModelStatus.BadRequest, "IModel is not open for rpc");
+        return this._getRpcProps();
+    }
+    /** Returns the iModel's RPC properties.
+     * @note It is an error to attempt to use these properties as a token for RPC operations if the iModel is not open.
+     * @internal
+     */
+    _getRpcProps() {
         return {
             key: this._fileKey,
             iTwinId: this.iTwinId,
@@ -273,11 +294,7 @@ export class IModel {
     getEcefTransform() {
         if (undefined === this._ecefLocation)
             throw new IModelError(GeoServiceStatus.NoGeoLocation, "iModel is not GeoLocated");
-        if (this._ecefTrans === undefined) {
-            this._ecefTrans = this._ecefLocation.getTransform();
-            this._ecefTrans.freeze();
-        }
-        return this._ecefTrans;
+        return this._ecefLocation.getTransform();
     }
     /** Convert a point in this iModel's Spatial coordinates to an ECEF point using its [[IModel.ecefLocation]].
      * @param spatial A point in the iModel's spatial coordinates

package/lib/esm/IModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModel.js","sourceRoot":"","sources":["../../src/IModel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAc,IAAI,EAAc,YAAY,EAAW,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACvI,OAAO,EACE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAgB,SAAS,EAAE,QAAQ,EAC9G,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,YAAY,EAAqB,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAsB,MAAM,sCAAsC,CAAC;AAEzF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AA6K5C;;;GAGG;AACH,MAAM,OAAO,YAAY;IAiBvB,2FAA2F;IAC3F,YAAY,KAAwB;QAClC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3E,IAAI,KAAK,CAAC,kBAAkB;YAC1B,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QACvM,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE;YAClC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChD,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SACjD;QACD,IAAI,MAAM,CAAC;QACX,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE;YAChC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxD,IAAI,OAAO,CAAC,gBAAgB,EAAE;gBAC5B,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACxE;QACD,IAAI,CAAC,MAAM;YACT,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAEzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;IAvBD,uFAAuF;IAChF,YAAY,KAAgB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAwB5D,8FAA8F;IACvF,MAAM,CAAC,4BAA4B,CAAC,MAAoB,EAAE,KAAe,EAAE,KAAa;QAC7F,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,YAAY,GAAG,EAAE,GAAG,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAC1D,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9I,MAAM,SAAS,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7I,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,SAAS,EAAE,CAAC;QAC1E,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;QAC3E,MAAM,MAAM,GAAG,QAAQ,CAAC,sBAAsB,CAAC,OAAQ,EAAE,OAAQ,EAAE,SAAS,CAAC,GAAG,CAAE,CAAC;QACnF,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,KAAK,GAAG,QAAQ,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACzE,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;SAC5C;QACD,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACnF,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,OAAO,IAAI,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,MAAM,CAAE,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3I,CAAC;IAED,4EAA4E;IAC5E,IAAW,WAAW;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC7C,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAED,+FAA+F;IACxF,aAAa,CAAC,KAAmB;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC;YAChG,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC;YAClI,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;YACzG,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;YACzG,OAAO,KAAK,CAAC;QAEf,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,kBAAkB,CAAC;QAC5C,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU;YACrD,OAAO,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU,CAAC;QAE7D,OAAO,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAA+B;YACxC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAC5B,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;SACvC,CAAC;QAEF,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;QAE9D,IAAI,IAAI,CAAC,OAAO;YACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAExC,IAAI,IAAI,CAAC,OAAO;YACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAExC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,MAAM;IAkM1B,gBAAgB;IAChB,YAAsB,UAA2B;QAlLjD,2CAA2C;QAC3B,kBAAa,GAAG,IAAI,OAAO,EAAkC,CAAC;QAC9E,kDAAkD;QAClC,yBAAoB,GAAG,IAAI,OAAO,EAA+C,CAAC;QAClG,qDAAqD;QACrC,4BAAuB,GAAG,IAAI,OAAO,EAA+C,CAAC;QACrG,mDAAmD;QACnC,0BAAqB,GAAG,IAAI,OAAO,EAAqC,CAAC;QACzF,mDAAmD;QACnC,0BAAqB,GAAG,IAAI,OAAO,EAAwD,CAAC;QAC5G,iEAAiE;QACjD,wCAAmC,GAAG,IAAI,OAAO,EAAoD,CAAC;QAqJ5G,cAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAmBtC,IAAI,CAAC,SAAS,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,UAAU,EAAE;YACd,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC;YACnC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC;YACrC,IAAI,UAAU,CAAC,SAAS;gBACtB,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;SACzC;IACH,CAAC;IA/KD,yBAAyB;IACzB,IAAW,IAAI;QACb,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IACD,IAAW,IAAI,CAAC,IAAY;QAC1B,IAAI,IAAI,KAAK,IAAI,CAAC,KAAK,EAAE;YACvB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,SAAS,KAAK,GAAG;gBACnB,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SACtC;IACH,CAAC;IAED,kEAAkE;IAClE,IAAW,WAAW;QACpB,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IACD,IAAW,WAAW,CAAC,OAAyB;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE;YACvI,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC;YAC9B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;YAC5B,IAAI,GAAG;gBACL,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC7C;IACH,CAAC;IASD;;;OAGG;IACH,IAAW,cAAc;QACvB,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IACD,IAAW,cAAc,CAAC,OAAyB;QACjD,uEAAuE;QACvE,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QACvC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE;YAChF,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC;YACjC,cAAc,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;YACtC,IAAI,GAAG;gBACL,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAChD;IACH,CAAC;IAED,0DAA0D;IAC1D,IAAW,YAAY;QACrB,MAAM,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,IAAW,YAAY,CAAC,GAAY;QAClC,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;YACjE,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;YAC/B,GAAG,CAAC,MAAM,EAAE,CAAC;YACb,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;YACzB,IAAI,GAAG;gBACL,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC9C;IACH,CAAC;IAED,wHAAwH;IACxH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,IAAW,YAAY,CAAC,YAAsC;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/B,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY;YACvB,OAAO;aACJ,IAAI,GAAG,IAAI,YAAY,IAAI,GAAG,CAAC,aAAa,CAAC,YAAY,CAAC;YAC7D,OAAO;QAET,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,oFAAoF;IAC7E,eAAe,CAAC,IAAuB;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,gEAAgE;IAChE,IAAW,0BAA0B;QACnC,OAAO,IAAI,CAAC,2BAA2B,CAAC;IAC1C,CAAC;IACD,IAAW,0BAA0B,CAAC,MAAiC;QACrE,MAAM,GAAG,GAAG,IAAI,CAAC,2BAA2B,CAAC;QAC7C,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;YACjB,OAAO;aACJ,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;YAC1C,OAAO;QAET,IAAI,CAAC,2BAA2B,GAAG,MAAM,CAAC;QAC1C,IAAI,CAAC,mCAAmC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC3D,CAAC;IAED,+EAA+E;IACxE,6BAA6B,CAAC,MAA0B;QAC7D,IAAI,CAAC,0BAA0B,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,gBAAgB;IACT,kBAAkB;QACvB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5C,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,GAAI,IAAI,CAAC,WAAW,EAAE;SACvB,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,MAAM;QACX,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACnC,CAAC;IAMD,4GAA4G;IAC5G,IAAW,GAAG,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAIlD,gEAAgE;IAChE,IAAW,OAAO,KAA6B,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtE,4CAA4C;IAC5C,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAMxE,6CAA6C;IAC7C,IAAW,QAAQ,KAAe,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1D,yCAAyC;IAClC,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,4BAA4B,CAAC,CAAC;QAE/E,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAeD,gBAAgB;IACN,UAAU,CAAC,IAAY,EAAE,KAAkB;QACnD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC7D,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACzD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1F,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvI,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,uBAAuB,CAAC,UAAsB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnJ,CAAC;IAED,uFAAuF;IACvF,IAAW,YAAY,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAEtE;;OAEG;IACI,gBAAgB;QACrB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa;YAClC,MAAM,IAAI,WAAW,CAAC,gBAAgB,CAAC,aAAa,EAAE,0BAA0B,CAAC,CAAC;QAEpF,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;YACpD,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;SAC1B;QAED,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAe,EAAE,MAAgB,IAAa,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAEtI;;;;;;OAMG;IACI,aAAa,CAAC,IAAY,EAAE,MAAgB,IAAa,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAEvI;;;;;OAKG;IACI,6BAA6B,CAAC,OAAe,EAAE,MAAqB,IAAkB,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAElK;;;;;;OAMG;IACI,6BAA6B,CAAC,YAA0B,EAAE,MAAgB,IAAI,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;;AAtQtJ,sCAAsC;AACf,wBAAiB,GAAe,KAAK,CAAC;AAC7D,0CAA0C;AACnB,oBAAa,GAAe,KAAK,CAAC;AACzD,sCAAsC;AACf,mBAAY,GAAe,MAAM,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 iModels\r\n */\r\n\r\nimport { assert, BeEvent, GeoServiceStatus, GuidString, Id64, Id64String, IModelStatus, Mutable, OpenMode } from \"@itwin/core-bentley\";\r\nimport {\r\n  Angle, AxisIndex, AxisOrder, Constant, Geometry, Matrix3d, Point3d, Range3d, Range3dProps, Transform, Vector3d, XYAndZ, XYZProps,\r\n  YawPitchRollAngles, YawPitchRollProps,\r\n} from \"@itwin/core-geometry\";\r\nimport { ChangesetIdWithIndex } from \"./ChangesetProps\";\r\nimport { Cartographic, CartographicProps } from \"./geometry/Cartographic\";\r\nimport { GeographicCRS, GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\r\nimport { AxisAlignedBox3d } from \"./geometry/Placement\";\r\nimport { IModelError } from \"./IModelError\";\r\nimport { ThumbnailProps } from \"./Thumbnail\";\r\n\r\n/** The properties to open a connection to an iModel for RPC operations.\r\n * @public\r\n */\r\nexport interface IModelRpcOpenProps {\r\n  /** The iTwin in which the iModel exists - must be defined for briefcases that are synchronized with iModelHub. */\r\n  readonly iTwinId?: GuidString;\r\n  /** Guid of the iModel. */\r\n  readonly iModelId?: GuidString;\r\n\r\n  /** Id of the last Changeset that was applied to the iModel - must be defined for briefcases that are synchronized with iModelHub.\r\n   * @note Changeset Ids are string hash values based on the content and parent.\r\n   */\r\n  readonly changeset?: ChangesetIdWithIndex;\r\n}\r\n\r\n/** The properties that identify an opened iModel for RPC operations.\r\n * @public\r\n */\r\nexport interface IModelRpcProps extends IModelRpcOpenProps {\r\n  /** Unique key used for identifying the iModel between the frontend and the backend */\r\n  readonly key: string;\r\n}\r\n\r\n/** Properties that position an iModel on the earth via [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates\r\n * @public\r\n */\r\nexport interface EcefLocationProps {\r\n  /** The Origin of an iModel on the earth in ECEF coordinates */\r\n  readonly origin: XYZProps;\r\n  /** The [orientation](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion) of an iModel on the earth. */\r\n  readonly orientation: YawPitchRollProps;\r\n  /** Optional position on the earth used to establish the ECEF coordinates. */\r\n  readonly cartographicOrigin?: CartographicProps;\r\n  /** Optional X column vector used with [[yVector]] to calculate potentially non-rigid transform if a projection is present. */\r\n  readonly xVector?: XYZProps;\r\n  /** Optional Y column vector used with [[xVector]] to calculate potentially non-rigid transform if a projection is present. */\r\n  readonly yVector?: XYZProps;\r\n}\r\n\r\n/** Properties of the [Root Subject]($docs/bis/intro/glossary#subject-root).\r\n * @public\r\n */\r\nexport interface RootSubjectProps {\r\n  /** The name of the root subject. */\r\n  readonly name: string;\r\n  /** Description of the root subject (optional). */\r\n  readonly description?: string;\r\n}\r\n\r\n/** Properties of an iModel that are always held in memory whenever one is opened, both on the frontend and on the backend .\r\n * @public\r\n */\r\nexport interface IModelProps {\r\n  /** The name and description of the root subject of this iModel */\r\n  readonly rootSubject: RootSubjectProps;\r\n  /** The volume of the entire project, in spatial coordinates */\r\n  readonly projectExtents?: Range3dProps;\r\n  /** An offset to be applied to all spatial coordinates. This is normally used to transform spatial coordinates into the Cartesian coordinate system of a Geographic Coordinate System. */\r\n  readonly globalOrigin?: XYZProps;\r\n  /** The location of the iModel in Earth Centered Earth Fixed coordinates. iModel units are always meters */\r\n  readonly ecefLocation?: EcefLocationProps;\r\n  /** The Geographic Coordinate Reference System indicating the projection and datum used. */\r\n  readonly geographicCoordinateSystem?: GeographicCRSProps;\r\n  /** The name of the iModel. */\r\n  readonly name?: string;\r\n}\r\n\r\n/** The properties returned by the backend when creating a new [[IModelConnection]] from the frontend, either with Rpc or with Ipc.\r\n * These properties describe the iModel held on the backend for thew newly formed connection and are used to construct a new\r\n * [[IModelConnection]] instance on the frontend to access it.\r\n * @public\r\n */\r\nexport type IModelConnectionProps = IModelProps & IModelRpcProps;\r\n\r\n/** The properties that can be supplied when creating a *new* iModel.\r\n * @public\r\n */\r\nexport interface CreateIModelProps extends IModelProps {\r\n  /** The GUID of new iModel. If not present, a GUID will be generated. */\r\n  readonly guid?: GuidString;\r\n  /** Client name for new iModel */\r\n  readonly client?: string;\r\n  /** Thumbnail for new iModel\r\n   * @alpha\r\n   */\r\n  readonly thumbnail?: ThumbnailProps;\r\n}\r\n\r\n/** Encryption-related properties that can be supplied when creating or opening snapshot iModels.\r\n * @public\r\n */\r\nexport interface IModelEncryptionProps {\r\n  /** The password used to encrypt/decrypt the snapshot iModel. */\r\n  readonly password?: string;\r\n}\r\n\r\n/**\r\n * A key used to identify an opened [IModelDb]($backend) between the frontend and backend for Rpc and Ipc communications.\r\n * Keys must be unique - that is there can never be two IModelDbs opened with the same key at any given time.\r\n * If no key is supplied in a call to open an IModelDb, one is generated and returned.\r\n * It is only necessary to supply a key if you have some reason to assign a specific value to identify an IModelDb.\r\n * If you don't supply the key, you must use the returned value for Rpc and Ipc communications.\r\n * @public\r\n */\r\nexport interface OpenDbKey {\r\n  readonly key?: string;\r\n}\r\n\r\n/** Options to open a [SnapshotDb]($backend).\r\n * @public\r\n */\r\nexport interface SnapshotOpenOptions extends IModelEncryptionProps, OpenDbKey {\r\n  /** @internal */\r\n  readonly lazyBlockCache?: boolean;\r\n  /** @internal */\r\n  readonly autoUploadBlocks?: boolean;\r\n  /**\r\n   * The \"base\" name that can be used for creating temporary files related to this Db.\r\n   * The string should be a name related to the current Db filename using some known pattern so that all files named \"baseName*\" can be deleted externally during cleanup.\r\n   * It must be the name of a file (that may or may not exist) in a writable directory.\r\n   * If not present, the baseName will default to the database's file name (including the path).\r\n   * @internal\r\n   */\r\n  readonly tempFileBase?: string;\r\n}\r\n\r\n/** Options to open a [StandaloneDb]($backend) via [StandaloneDb.openFile]($backend) from the backend,\r\n * or [BriefcaseConnection.openStandalone]($frontend) from the frontend.\r\n * @public\r\n */\r\nexport type StandaloneOpenOptions = OpenDbKey;\r\n\r\n/** Options that can be supplied when creating snapshot iModels.\r\n * @public\r\n */\r\nexport interface CreateSnapshotIModelProps extends IModelEncryptionProps {\r\n  /** If true, then create SQLite views for Model, Element, ElementAspect, and Relationship classes.\r\n   * These database views can often be useful for interoperability workflows.\r\n   */\r\n  readonly createClassViews?: boolean;\r\n}\r\n\r\n/** The options that can be specified when creating an *empty* snapshot iModel.\r\n * @see [SnapshotDb.createEmpty]($backend)\r\n * @public\r\n */\r\nexport type CreateEmptySnapshotIModelProps = CreateIModelProps & CreateSnapshotIModelProps;\r\n\r\n/** Options that can be supplied when creating standalone iModels.\r\n * @internal\r\n */\r\nexport interface CreateStandaloneIModelProps extends IModelEncryptionProps {\r\n  /** If present, file will allow local editing, but cannot be used to create changesets */\r\n  readonly allowEdit?: string;\r\n}\r\n\r\n/** The options that can be specified when creating an *empty* standalone iModel.\r\n * @see [standalone.createEmpty]($backend)\r\n * @internal\r\n */\r\nexport type CreateEmptyStandaloneIModelProps = CreateIModelProps & CreateStandaloneIModelProps;\r\n\r\n/** @public */\r\nexport interface FilePropertyProps {\r\n  readonly namespace: string;\r\n  readonly name: string;\r\n  id?: number | string;\r\n  subId?: number | string;\r\n}\r\n\r\n/** The position and orientation of an iModel on the earth in [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates\r\n * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\r\n * @public\r\n */\r\nexport class EcefLocation implements EcefLocationProps {\r\n  /** The origin of the ECEF transform. */\r\n  public readonly origin: Point3d;\r\n  /** The orientation of the ECEF transform */\r\n  public readonly orientation: YawPitchRollAngles;\r\n  /** Optional position on the earth used to establish the ECEF origin and orientation. */\r\n  public readonly cartographicOrigin?: Cartographic;\r\n  /** Optional X column vector used with [[yVector]] to calculate potentially non-rigid transform if a projection is present. */\r\n  public readonly xVector?: Vector3d;\r\n  /** Optional Y column vector used with [[xVector]] to calculate potentially non-rigid transform if a projection is present. */\r\n  public readonly yVector?: Vector3d;\r\n\r\n  private _transform: Transform;\r\n\r\n  /** Get the transform from iModel Spatial coordinates to ECEF from this EcefLocation */\r\n  public getTransform(): Transform { return this._transform; }\r\n\r\n  /** Construct a new EcefLocation. Once constructed, it is frozen and cannot be modified. */\r\n  constructor(props: EcefLocationProps) {\r\n    this.origin = Point3d.fromJSON(props.origin).freeze();\r\n    this.orientation = YawPitchRollAngles.fromJSON(props.orientation).freeze();\r\n    if (props.cartographicOrigin)\r\n      this.cartographicOrigin = Cartographic.fromRadians({ longitude: props.cartographicOrigin.longitude, latitude: props.cartographicOrigin.latitude, height: props.cartographicOrigin.height }).freeze();\r\n    if (props.xVector && props.yVector) {\r\n      this.xVector = Vector3d.fromJSON(props.xVector);\r\n      this.yVector = Vector3d.fromJSON(props.yVector);\r\n    }\r\n    let matrix;\r\n    if (this.xVector && this.yVector) {\r\n      const zVector = this.xVector.crossProduct(this.yVector);\r\n      if (zVector.normalizeInPlace())\r\n        matrix = Matrix3d.createColumns(this.xVector, this.yVector, zVector);\r\n    }\r\n    if (!matrix)\r\n      matrix = this.orientation.toMatrix3d();\r\n\r\n    this._transform = Transform.createOriginAndMatrix(this.origin, matrix);\r\n  }\r\n\r\n  /** Construct ECEF Location from cartographic origin with optional known point and angle.   */\r\n  public static createFromCartographicOrigin(origin: Cartographic, point?: Point3d, angle?: Angle) {\r\n    const ecefOrigin = origin.toEcef();\r\n    const deltaRadians = 10 / Constant.earthRadiusWGS84.polar;\r\n    const northCarto = Cartographic.fromRadians({ longitude: origin.longitude, latitude: origin.latitude + deltaRadians, height: origin.height });\r\n    const eastCarto = Cartographic.fromRadians({ longitude: origin.longitude + deltaRadians, latitude: origin.latitude, height: origin.height });\r\n    const ecefNorth = northCarto.toEcef();\r\n    const ecefEast = eastCarto.toEcef();\r\n    const xVector = Vector3d.createStartEnd(ecefOrigin, ecefEast).normalize();\r\n    const yVector = Vector3d.createStartEnd(ecefOrigin, ecefNorth).normalize();\r\n    const matrix = Matrix3d.createRigidFromColumns(xVector!, yVector!, AxisOrder.XYZ)!;\r\n    if (angle !== undefined) {\r\n      const north = Matrix3d.createRotationAroundAxisIndex(AxisIndex.Z, angle);\r\n      matrix.multiplyMatrixMatrix(north, matrix);\r\n    }\r\n    if (point !== undefined) {\r\n      const delta = matrix.multiplyVector(Vector3d.create(-point.x, -point.y, -point.z));\r\n      ecefOrigin.addInPlace(delta);\r\n    }\r\n\r\n    return new EcefLocation({ origin: ecefOrigin, orientation: YawPitchRollAngles.createFromMatrix3d(matrix)!, cartographicOrigin: origin });\r\n  }\r\n\r\n  /** Get the location center of the earth in the iModel coordinate system. */\r\n  public get earthCenter(): Point3d {\r\n    const matrix = this.orientation.toMatrix3d();\r\n    return Point3d.createFrom(matrix.multiplyTransposeXYZ(-this.origin.x, -this.origin.y, -this.origin.z));\r\n  }\r\n\r\n  /** Return true if this location is equivalent to another location within a small tolerance. */\r\n  public isAlmostEqual(other: EcefLocation): boolean {\r\n    if (!this.origin.isAlmostEqual(other.origin) || !this.orientation.isAlmostEqual(other.orientation))\r\n      return false;\r\n\r\n    if ((this.xVector === undefined) !== (other.xVector === undefined) || (this.yVector === undefined) !== (other.yVector === undefined))\r\n      return false;\r\n\r\n    if (this.xVector !== undefined && other.xVector !== undefined && !this.xVector.isAlmostEqual(other.xVector))\r\n      return false;\r\n\r\n    if (this.yVector !== undefined && other.yVector !== undefined && !this.yVector.isAlmostEqual(other.yVector))\r\n      return false;\r\n\r\n    const thisCarto = this.cartographicOrigin;\r\n    const otherCarto = other.cartographicOrigin;\r\n    if (undefined === thisCarto || undefined === otherCarto)\r\n      return undefined === thisCarto && undefined === otherCarto;\r\n\r\n    return thisCarto.equalsEpsilon(otherCarto, Geometry.smallMetricDistance);\r\n  }\r\n\r\n  public toJSON(): EcefLocationProps {\r\n    const props: Mutable<EcefLocationProps> = {\r\n      origin: this.origin.toJSON(),\r\n      orientation: this.orientation.toJSON(),\r\n    };\r\n\r\n    if (this.cartographicOrigin)\r\n      props.cartographicOrigin = this.cartographicOrigin.toJSON();\r\n\r\n    if (this.xVector)\r\n      props.xVector = this.xVector.toJSON();\r\n\r\n    if (this.yVector)\r\n      props.yVector = this.yVector.toJSON();\r\n\r\n    return props;\r\n  }\r\n}\r\n\r\n/** Represents an iModel in JavaScript.\r\n * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\r\n * @public\r\n */\r\nexport abstract class IModel implements IModelProps {\r\n  private _projectExtents?: AxisAlignedBox3d;\r\n  private _name?: string;\r\n  private _rootSubject?: RootSubjectProps;\r\n  private _globalOrigin?: Point3d;\r\n  private _ecefLocation?: EcefLocation;\r\n  private _ecefTrans?: Transform;\r\n  private _geographicCoordinateSystem?: GeographicCRS;\r\n  private _iModelId?: GuidString;\r\n\r\n  /** The Id of the repository model. */\r\n  public static readonly repositoryModelId: Id64String = \"0x1\";\r\n  /** The Id of the root subject element. */\r\n  public static readonly rootSubjectId: Id64String = \"0x1\";\r\n  /** The Id of the dictionary model. */\r\n  public static readonly dictionaryId: Id64String = \"0x10\";\r\n\r\n  /** Event raised after [[name]] changes. */\r\n  public readonly onNameChanged = new BeEvent<(previousName: string) => void>();\r\n  /** Event raised after [[rootSubject]] changes. */\r\n  public readonly onRootSubjectChanged = new BeEvent<(previousSubject: RootSubjectProps) => void>();\r\n  /** Event raised after [[projectExtents]] changes. */\r\n  public readonly onProjectExtentsChanged = new BeEvent<(previousExtents: AxisAlignedBox3d) => void>();\r\n  /** Event raised after [[globalOrigin]] changes. */\r\n  public readonly onGlobalOriginChanged = new BeEvent<(previousOrigin: Point3d) => void>();\r\n  /** Event raised after [[ecefLocation]] changes. */\r\n  public readonly onEcefLocationChanged = new BeEvent<(previousLocation: EcefLocation | undefined) => void>();\r\n  /** Event raised after [[geographicCoordinateSystem]] changes. */\r\n  public readonly onGeographicCoordinateSystemChanged = new BeEvent<(previousGCS: GeographicCRS | undefined) => void>();\r\n\r\n  /** Name of the iModel */\r\n  public get name(): string {\r\n    assert(this._name !== undefined);\r\n    return this._name;\r\n  }\r\n  public set name(name: string) {\r\n    if (name !== this._name) {\r\n      const old = this._name;\r\n      this._name = name;\r\n      if (undefined !== old)\r\n        this.onNameChanged.raiseEvent(old);\r\n    }\r\n  }\r\n\r\n  /** The name and description of the root subject of this iModel */\r\n  public get rootSubject(): RootSubjectProps {\r\n    assert(this._rootSubject !== undefined);\r\n    return this._rootSubject;\r\n  }\r\n  public set rootSubject(subject: RootSubjectProps) {\r\n    if (undefined === this._rootSubject || this._rootSubject.name !== subject.name || this._rootSubject.description !== subject.description) {\r\n      const old = this._rootSubject;\r\n      this._rootSubject = subject;\r\n      if (old)\r\n        this.onRootSubjectChanged.raiseEvent(old);\r\n    }\r\n  }\r\n\r\n  /** Returns `true` if this is a snapshot iModel. */\r\n  public abstract get isSnapshot(): boolean;\r\n  /** Returns `true` if this is a briefcase copy of an iModel that is synchronized with iModelHub. */\r\n  public abstract get isBriefcase(): boolean;\r\n\r\n  public abstract get isOpen(): boolean;\r\n\r\n  /**\r\n   * The volume, in spatial coordinates, inside which the entire project is contained.\r\n   * @note The object returned from this method is frozen. You *must* make a copy before you do anything that might attempt to modify it.\r\n   */\r\n  public get projectExtents() {\r\n    assert(undefined !== this._projectExtents);\r\n    return this._projectExtents;\r\n  }\r\n  public set projectExtents(extents: AxisAlignedBox3d) {\r\n    // Don't allow any axis of the project extents to be less than 1 meter.\r\n    const projectExtents = extents.clone();\r\n    projectExtents.ensureMinLengths(1.0);\r\n    if (!this._projectExtents || !this._projectExtents.isAlmostEqual(projectExtents)) {\r\n      const old = this._projectExtents;\r\n      projectExtents.freeze();\r\n      this._projectExtents = projectExtents;\r\n      if (old)\r\n        this.onProjectExtentsChanged.raiseEvent(old);\r\n    }\r\n  }\r\n\r\n  /** An offset to be applied to all spatial coordinates. */\r\n  public get globalOrigin(): Point3d {\r\n    assert(this._globalOrigin !== undefined);\r\n    return this._globalOrigin;\r\n  }\r\n  public set globalOrigin(org: Point3d) {\r\n    if (!this._globalOrigin || !this._globalOrigin.isAlmostEqual(org)) {\r\n      const old = this._globalOrigin;\r\n      org.freeze();\r\n      this._globalOrigin = org;\r\n      if (old)\r\n        this.onGlobalOriginChanged.raiseEvent(old);\r\n    }\r\n  }\r\n\r\n  /** The [EcefLocation]($docs/learning/glossary#ecefLocation) of the iModel in Earth Centered Earth Fixed coordinates. */\r\n  public get ecefLocation(): EcefLocation | undefined {\r\n    return this._ecefLocation;\r\n  }\r\n  public set ecefLocation(ecefLocation: EcefLocation | undefined) {\r\n    const old = this._ecefLocation;\r\n    if (!old && !ecefLocation)\r\n      return;\r\n    else if (old && ecefLocation && old.isAlmostEqual(ecefLocation))\r\n      return;\r\n\r\n    this._ecefLocation = ecefLocation;\r\n    this.onEcefLocationChanged.raiseEvent(old);\r\n  }\r\n\r\n  /** Set the [EcefLocation]($docs/learning/glossary#ecefLocation) for this iModel. */\r\n  public setEcefLocation(ecef: EcefLocationProps): void {\r\n    this.ecefLocation = new EcefLocation(ecef);\r\n  }\r\n\r\n  /** The geographic coordinate reference system of the iModel. */\r\n  public get geographicCoordinateSystem(): GeographicCRS | undefined {\r\n    return this._geographicCoordinateSystem;\r\n  }\r\n  public set geographicCoordinateSystem(geoCRS: GeographicCRS | undefined) {\r\n    const old = this._geographicCoordinateSystem;\r\n    if (!old && !geoCRS)\r\n      return;\r\n    else if (old && geoCRS && old.equals(geoCRS))\r\n      return;\r\n\r\n    this._geographicCoordinateSystem = geoCRS;\r\n    this.onGeographicCoordinateSystemChanged.raiseEvent(old);\r\n  }\r\n\r\n  /** Sets the geographic coordinate reference system from GeographicCRSProps. */\r\n  public setGeographicCoordinateSystem(geoCRS: GeographicCRSProps) {\r\n    this.geographicCoordinateSystem = new GeographicCRS(geoCRS);\r\n  }\r\n\r\n  /** @internal */\r\n  public getConnectionProps(): IModelConnectionProps {\r\n    return {\r\n      name: this.name,\r\n      rootSubject: this.rootSubject,\r\n      projectExtents: this.projectExtents.toJSON(),\r\n      globalOrigin: this.globalOrigin.toJSON(),\r\n      ecefLocation: this.ecefLocation,\r\n      geographicCoordinateSystem: this.geographicCoordinateSystem,\r\n      ... this.getRpcProps(),\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public toJSON(): IModelConnectionProps {\r\n    return this.getConnectionProps();\r\n  }\r\n\r\n  /** A key used to identify this iModel in RPC calls from frontend to backend.\r\n   * @internal\r\n   */\r\n  protected _fileKey: string;\r\n  /** Get the key that was used to open this iModel. This is the value used for Rpc and Ipc communications. */\r\n  public get key(): string { return this._fileKey; }\r\n\r\n  /** @internal */\r\n  protected _iTwinId?: GuidString;\r\n  /** The Guid that identifies the iTwin that owns this iModel. */\r\n  public get iTwinId(): GuidString | undefined { return this._iTwinId; }\r\n\r\n  /** The Guid that identifies this iModel. */\r\n  public get iModelId(): GuidString | undefined { return this._iModelId; }\r\n\r\n  /** @public */\r\n  public changeset: ChangesetIdWithIndex;\r\n\r\n  protected _openMode = OpenMode.Readonly;\r\n  /** The [[OpenMode]] used for this IModel. */\r\n  public get openMode(): OpenMode { return this._openMode; }\r\n\r\n  /** Return a token for RPC operations. */\r\n  public getRpcProps(): IModelRpcProps {\r\n    if (!this.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"IModel is not open for rpc\");\r\n\r\n    return {\r\n      key: this._fileKey,\r\n      iTwinId: this.iTwinId,\r\n      iModelId: this.iModelId,\r\n      changeset: this.changeset,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  protected constructor(tokenProps?: IModelRpcProps) {\r\n    this.changeset = { id: \"\", index: 0 };\r\n    this._fileKey = \"\";\r\n    if (tokenProps) {\r\n      this._fileKey = tokenProps.key;\r\n      this._iTwinId = tokenProps.iTwinId;\r\n      this._iModelId = tokenProps.iModelId;\r\n      if (tokenProps.changeset)\r\n        this.changeset = tokenProps.changeset;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  protected initialize(name: string, props: IModelProps) {\r\n    this.name = name;\r\n    this.rootSubject = props.rootSubject;\r\n    this.projectExtents = Range3d.fromJSON(props.projectExtents);\r\n    this.globalOrigin = Point3d.fromJSON(props.globalOrigin);\r\n    this.ecefLocation = props.ecefLocation ? new EcefLocation(props.ecefLocation) : undefined;\r\n    this.geographicCoordinateSystem = props.geographicCoordinateSystem ? new GeographicCRS(props.geographicCoordinateSystem) : undefined;\r\n  }\r\n\r\n  /** Get the default subCategoryId for the supplied categoryId */\r\n  public static getDefaultSubCategoryId(categoryId: Id64String): Id64String {\r\n    return Id64.isValid(categoryId) ? Id64.fromLocalAndBriefcaseIds(Id64.getLocalId(categoryId) + 1, Id64.getBriefcaseId(categoryId)) : Id64.invalid;\r\n  }\r\n\r\n  /** True if this iModel has an [EcefLocation]($docs/learning/glossary#ecefLocation). */\r\n  public get isGeoLocated() { return undefined !== this._ecefLocation; }\r\n\r\n  /** Get the Transform from this iModel's Spatial coordinates to ECEF coordinates using its [[IModel.ecefLocation]].\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   */\r\n  public getEcefTransform(): Transform {\r\n    if (undefined === this._ecefLocation)\r\n      throw new IModelError(GeoServiceStatus.NoGeoLocation, \"iModel is not GeoLocated\");\r\n\r\n    if (this._ecefTrans === undefined) {\r\n      this._ecefTrans = this._ecefLocation.getTransform();\r\n      this._ecefTrans.freeze();\r\n    }\r\n\r\n    return this._ecefTrans;\r\n  }\r\n\r\n  /** Convert a point in this iModel's Spatial coordinates to an ECEF point using its [[IModel.ecefLocation]].\r\n   * @param spatial A point in the iModel's spatial coordinates\r\n   * @param result If defined, use this for output\r\n   * @returns A Point3d in ECEF coordinates\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   */\r\n  public spatialToEcef(spatial: XYAndZ, result?: Point3d): Point3d { return this.getEcefTransform().multiplyPoint3d(spatial, result)!; }\r\n\r\n  /** Convert a point in ECEF coordinates to a point in this iModel's Spatial coordinates using its [[ecefLocation]].\r\n   * @param ecef A point in ECEF coordinates\r\n   * @param result If defined, use this for output\r\n   * @returns A Point3d in this iModel's spatial coordinates\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   * @note The resultant point will only be meaningful if the ECEF coordinate is close on the earth to the iModel.\r\n   */\r\n  public ecefToSpatial(ecef: XYAndZ, result?: Point3d): Point3d { return this.getEcefTransform().multiplyInversePoint3d(ecef, result)!; }\r\n\r\n  /** Convert a point in this iModel's Spatial coordinates to a [[Cartographic]] using its [[IModel.ecefLocation]].\r\n   * @param spatial A point in the iModel's spatial coordinates\r\n   * @param result If defined, use this for output\r\n   * @returns A Cartographic location\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   */\r\n  public spatialToCartographicFromEcef(spatial: XYAndZ, result?: Cartographic): Cartographic { return Cartographic.fromEcef(this.spatialToEcef(spatial), result)!; }\r\n\r\n  /** Convert a [[Cartographic]] to a point in this iModel's Spatial coordinates using its [[IModel.ecefLocation]].\r\n   * @param cartographic A cartographic location\r\n   * @param result If defined, use this for output\r\n   * @returns A point in this iModel's spatial coordinates\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   * @note The resultant point will only be meaningful if the ECEF coordinate is close on the earth to the iModel.\r\n   */\r\n  public cartographicToSpatialFromEcef(cartographic: Cartographic, result?: Point3d) { return this.ecefToSpatial(cartographic.toEcef(result), result); }\r\n}\r\n"]}
+{"version":3,"file":"IModel.js","sourceRoot":"","sources":["../../src/IModel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAc,IAAI,EAAc,YAAY,EAAW,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACvI,OAAO,EACE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAgB,SAAS,EAAE,QAAQ,EAC9G,kBAAkB,GACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,YAAY,EAAqB,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAsB,MAAM,sCAAsC,CAAC;AAEzF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAyL5C;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAiBvB,2FAA2F;IAC3F,YAAY,KAAwB;QAClC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,CAAC;QAC3E,IAAI,KAAK,CAAC,kBAAkB;YAC1B,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QACvM,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE;YAClC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;YACzD,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;SAC1D;QACD,IAAI,MAAM,CAAC;QACX,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE;YAChC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxD,IAAI,OAAO,CAAC,gBAAgB,EAAE;gBAC5B,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACxE;QACD,IAAI,CAAC,MAAM;YACT,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAEzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACvE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;IAC3B,CAAC;IAxBD,uFAAuF;IAChF,YAAY,KAAgB,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAyB5D,8FAA8F;IACvF,MAAM,CAAC,4BAA4B,CAAC,MAAoB,EAAE,KAAe,EAAE,KAAa;QAC7F,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,YAAY,GAAG,EAAE,GAAG,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAC1D,MAAM,UAAU,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9I,MAAM,SAAS,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7I,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,SAAS,EAAE,CAAC;QAC1E,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;QAC3E,MAAM,MAAM,GAAG,QAAQ,CAAC,sBAAsB,CAAC,OAAQ,EAAE,OAAQ,EAAE,SAAS,CAAC,GAAG,CAAE,CAAC;QACnF,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,KAAK,GAAG,QAAQ,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACzE,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;SAC5C;QACD,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACnF,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,OAAO,IAAI,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,MAAM,CAAE,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3I,CAAC;IAED,4EAA4E;IAC5E,IAAW,WAAW;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC7C,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAED,+FAA+F;IACxF,aAAa,CAAC,KAAmB;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC;YAChG,OAAO,KAAK,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,CAAC;YAClI,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;YACzG,OAAO,KAAK,CAAC;QAEf,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC;YACzG,OAAO,KAAK,CAAC;QAEf,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,kBAAkB,CAAC;QAC5C,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU;YACrD,OAAO,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,UAAU,CAAC;QAE7D,OAAO,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC3E,CAAC;IAEM,MAAM;QACX,MAAM,KAAK,GAA+B;YACxC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAC5B,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;SACvC,CAAC;QAEF,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;QAE9D,IAAI,IAAI,CAAC,OAAO;YACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAExC,IAAI,IAAI,CAAC,OAAO;YACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAExC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,MAAM;IAqN1B,gBAAgB;IAChB,YAAsB,UAA2B;QAtMjD,2CAA2C;QAC3B,kBAAa,GAAG,IAAI,OAAO,EAAkC,CAAC;QAC9E,kDAAkD;QAClC,yBAAoB,GAAG,IAAI,OAAO,EAA+C,CAAC;QAClG,qDAAqD;QACrC,4BAAuB,GAAG,IAAI,OAAO,EAA+C,CAAC;QACrG,mDAAmD;QACnC,0BAAqB,GAAG,IAAI,OAAO,EAAqC,CAAC;QACzF,mDAAmD;QACnC,0BAAqB,GAAG,IAAI,OAAO,EAAwD,CAAC;QAC5G,iEAAiE;QACjD,wCAAmC,GAAG,IAAI,OAAO,EAAoD,CAAC;QA+J5G,cAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC;QA6BtC,IAAI,CAAC,SAAS,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,UAAU,EAAE;YACd,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC;YACnC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC;YACrC,IAAI,UAAU,CAAC,SAAS;gBACtB,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;SACzC;IACH,CAAC;IAnMD,yBAAyB;IACzB,IAAW,IAAI;QACb,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IACD,IAAW,IAAI,CAAC,IAAY;QAC1B,IAAI,IAAI,KAAK,IAAI,CAAC,KAAK,EAAE;YACvB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC;YACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,SAAS,KAAK,GAAG;gBACnB,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SACtC;IACH,CAAC;IAED,kEAAkE;IAClE,IAAW,WAAW;QACpB,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IACD,IAAW,WAAW,CAAC,OAAyB;QAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,KAAK,OAAO,CAAC,WAAW,EAAE;YACvI,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC;YAC9B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;YAC5B,IAAI,GAAG;gBACL,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC7C;IACH,CAAC;IASD;;;OAGG;IACH,IAAW,cAAc;QACvB,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IACD,IAAW,cAAc,CAAC,OAAyB;QACjD,uEAAuE;QACvE,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QACvC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE;YAChF,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC;YACjC,cAAc,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;YACtC,IAAI,GAAG;gBACL,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAChD;IACH,CAAC;IAED,0DAA0D;IAC1D,IAAW,YAAY;QACrB,MAAM,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,IAAW,YAAY,CAAC,GAAY;QAClC,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;YACjE,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;YAC/B,GAAG,CAAC,MAAM,EAAE,CAAC;YACb,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC;YACzB,IAAI,GAAG;gBACL,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAC9C;IACH,CAAC;IAED;;;;;;;;;;MAUE;IACF,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,IAAW,YAAY,CAAC,YAAsC;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/B,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY;YACvB,OAAO;aACJ,IAAI,GAAG,IAAI,YAAY,IAAI,GAAG,CAAC,aAAa,CAAC,YAAY,CAAC;YAC7D,OAAO;QAET,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,oFAAoF;IAC7E,eAAe,CAAC,IAAuB;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,gEAAgE;IAChE,IAAW,0BAA0B;QACnC,OAAO,IAAI,CAAC,2BAA2B,CAAC;IAC1C,CAAC;IACD,IAAW,0BAA0B,CAAC,MAAiC;QACrE,MAAM,GAAG,GAAG,IAAI,CAAC,2BAA2B,CAAC;QAC7C,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;YACjB,OAAO;aACJ,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;YAC1C,OAAO;QAET,IAAI,CAAC,2BAA2B,GAAG,MAAM,CAAC;QAC1C,IAAI,CAAC,mCAAmC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC3D,CAAC;IAED,+EAA+E;IACxE,6BAA6B,CAAC,MAA0B;QAC7D,IAAI,CAAC,0BAA0B,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,gBAAgB;IACT,kBAAkB;QACvB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5C,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YACxC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,0BAA0B,EAAE,IAAI,CAAC,0BAA0B;YAC3D,GAAI,IAAI,CAAC,YAAY,EAAE;SACxB,CAAC;IACJ,CAAC;IAED,gBAAgB;IACT,MAAM;QACX,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC;IACnC,CAAC;IAMD,4GAA4G;IAC5G,IAAW,GAAG,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAIlD,gEAAgE;IAChE,IAAW,OAAO,KAA6B,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEtE,4CAA4C;IAC5C,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAMxE,6CAA6C;IAC7C,IAAW,QAAQ,KAAe,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1D;;OAEG;IACI,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,4BAA4B,CAAC,CAAC;QAE/E,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACO,YAAY;QACpB,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAeD,gBAAgB;IACN,UAAU,CAAC,IAAY,EAAE,KAAkB;QACnD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC7D,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACzD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1F,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvI,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,uBAAuB,CAAC,UAAsB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnJ,CAAC;IAED,uFAAuF;IACvF,IAAW,YAAY,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAEtE;;OAEG;IACI,gBAAgB;QACrB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa;YAClC,MAAM,IAAI,WAAW,CAAC,gBAAgB,CAAC,aAAa,EAAE,0BAA0B,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAe,EAAE,MAAgB,IAAa,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAEtI;;;;;;OAMG;IACI,aAAa,CAAC,IAAY,EAAE,MAAgB,IAAa,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAEvI;;;;;OAKG;IACI,6BAA6B,CAAC,OAAe,EAAE,MAAqB,IAAkB,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,MAAM,CAAE,CAAC,CAAC,CAAC;IAElK;;;;;;OAMG;IACI,6BAA6B,CAAC,YAA0B,EAAE,MAAgB,IAAI,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;;AApRtJ,sCAAsC;AACf,wBAAiB,GAAe,KAAK,CAAC;AAC7D,0CAA0C;AACnB,oBAAa,GAAe,KAAK,CAAC;AACzD,sCAAsC;AACf,mBAAY,GAAe,MAAM,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 iModels\r\n */\r\n\r\nimport { assert, BeEvent, GeoServiceStatus, GuidString, Id64, Id64String, IModelStatus, Mutable, OpenMode } from \"@itwin/core-bentley\";\r\nimport {\r\n  Angle, AxisIndex, AxisOrder, Constant, Geometry, Matrix3d, Point3d, Range3d, Range3dProps, Transform, Vector3d, XYAndZ, XYZProps,\r\n  YawPitchRollAngles, YawPitchRollProps,\r\n} from \"@itwin/core-geometry\";\r\nimport { ChangesetIdWithIndex } from \"./ChangesetProps\";\r\nimport { Cartographic, CartographicProps } from \"./geometry/Cartographic\";\r\nimport { GeographicCRS, GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\r\nimport { AxisAlignedBox3d } from \"./geometry/Placement\";\r\nimport { IModelError } from \"./IModelError\";\r\nimport { ThumbnailProps } from \"./Thumbnail\";\r\n\r\n/** The properties to open a connection to an iModel for RPC operations.\r\n * @public\r\n */\r\nexport interface IModelRpcOpenProps {\r\n  /** The iTwin in which the iModel exists - must be defined for briefcases that are synchronized with iModelHub. */\r\n  readonly iTwinId?: GuidString;\r\n  /** Guid of the iModel. */\r\n  readonly iModelId?: GuidString;\r\n\r\n  /** Id of the last Changeset that was applied to the iModel - must be defined for briefcases that are synchronized with iModelHub.\r\n   * @note Changeset Ids are string hash values based on the content and parent.\r\n   */\r\n  readonly changeset?: ChangesetIdWithIndex;\r\n}\r\n\r\n/** The properties that identify an opened iModel for RPC operations.\r\n * @public\r\n */\r\nexport interface IModelRpcProps extends IModelRpcOpenProps {\r\n  /** Unique key used for identifying the iModel between the frontend and the backend */\r\n  readonly key: string;\r\n}\r\n\r\n/** Properties that position an iModel on the earth via [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates\r\n * The origin is specified as an ECEF coordinate. The cartographicOrigin property contains the latitude, longitude and elevation above the WGS84 ellipsoid\r\n * of the origin property. This cartographicOrigin is offered as a convenient pre-calculated value representing the location of the ECEF origin.\r\n * The 3D coordinate system this class represents is positioned at specified origin and the axis positioned according to\r\n * the other properties.\r\n * If the xVector and yVector properties are defined then they take precedence over the YawPitchRoll orientation property. The xVector and yVector\r\n * represent the direction and scale of the X and Y axes. The Z axis is always perpendicular (according to the right hand rule) to these X-Y axes.\r\n * The scaling in the Z direction is always unity. The scale of the X and Y axes is represented by the size of the vector length.\r\n * If the xVector and yVector are not present then the YawPitchRoll properties indicates the angles for all tree axes. Scaling in that case\r\n * is unity in all three directions.\r\n * Note that the present class is intended to represent geolocated 3D coordinate systems that are normally tangent to the WGS84 ellipsoid\r\n * possibly offset in altitude by the terrain elevation above the ellipsoid but other general 3D coordinate systems\r\n * can be defined.\r\n * @public\r\n */\r\nexport interface EcefLocationProps {\r\n  /** The Origin of an iModel on the earth in ECEF coordinates */\r\n  readonly origin: XYZProps;\r\n  /** The [orientation](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion) of an iModel on the earth. */\r\n  readonly orientation: YawPitchRollProps;\r\n  /** Optional position on the earth used to establish the ECEF coordinates. */\r\n  readonly cartographicOrigin?: CartographicProps;\r\n  /** Optional X column vector used with [[yVector]] to calculate potentially non-rigid transform if a projection is present. */\r\n  readonly xVector?: XYZProps;\r\n  /** Optional Y column vector used with [[xVector]] to calculate potentially non-rigid transform if a projection is present. */\r\n  readonly yVector?: XYZProps;\r\n}\r\n\r\n/** Properties of the [Root Subject]($docs/bis/intro/glossary#subject-root).\r\n * @public\r\n */\r\nexport interface RootSubjectProps {\r\n  /** The name of the root subject. */\r\n  readonly name: string;\r\n  /** Description of the root subject (optional). */\r\n  readonly description?: string;\r\n}\r\n\r\n/** Properties of an iModel that are always held in memory whenever one is opened, both on the frontend and on the backend .\r\n * @public\r\n */\r\nexport interface IModelProps {\r\n  /** The name and description of the root subject of this iModel */\r\n  readonly rootSubject: RootSubjectProps;\r\n  /** The volume of the entire project, in spatial coordinates */\r\n  readonly projectExtents?: Range3dProps;\r\n  /** An offset to be applied to all spatial coordinates. This is normally used to transform spatial coordinates into the Cartesian coordinate system of a Geographic Coordinate System. */\r\n  readonly globalOrigin?: XYZProps;\r\n  /** The location of the iModel in Earth Centered Earth Fixed coordinates. iModel units are always meters */\r\n  readonly ecefLocation?: EcefLocationProps;\r\n  /** The Geographic Coordinate Reference System indicating the projection and datum used. */\r\n  readonly geographicCoordinateSystem?: GeographicCRSProps;\r\n  /** The name of the iModel. */\r\n  readonly name?: string;\r\n}\r\n\r\n/** The properties returned by the backend when creating a new [[IModelConnection]] from the frontend, either with Rpc or with Ipc.\r\n * These properties describe the iModel held on the backend for thew newly formed connection and are used to construct a new\r\n * [[IModelConnection]] instance on the frontend to access it.\r\n * @public\r\n */\r\nexport type IModelConnectionProps = IModelProps & IModelRpcProps;\r\n\r\n/** The properties that can be supplied when creating a *new* iModel.\r\n * @public\r\n */\r\nexport interface CreateIModelProps extends IModelProps {\r\n  /** The GUID of new iModel. If not present, a GUID will be generated. */\r\n  readonly guid?: GuidString;\r\n  /** Client name for new iModel */\r\n  readonly client?: string;\r\n  /** Thumbnail for new iModel\r\n   * @alpha\r\n   */\r\n  readonly thumbnail?: ThumbnailProps;\r\n}\r\n\r\n/** Encryption-related properties that can be supplied when creating or opening snapshot iModels.\r\n * @public\r\n */\r\nexport interface IModelEncryptionProps {\r\n  /** The password used to encrypt/decrypt the snapshot iModel. */\r\n  readonly password?: string;\r\n}\r\n\r\n/**\r\n * A key used to identify an opened [IModelDb]($backend) between the frontend and backend for Rpc and Ipc communications.\r\n * Keys must be unique - that is there can never be two IModelDbs opened with the same key at any given time.\r\n * If no key is supplied in a call to open an IModelDb, one is generated and returned.\r\n * It is only necessary to supply a key if you have some reason to assign a specific value to identify an IModelDb.\r\n * If you don't supply the key, you must use the returned value for Rpc and Ipc communications.\r\n * @public\r\n */\r\nexport interface OpenDbKey {\r\n  readonly key?: string;\r\n}\r\n\r\n/** Options to open a [SnapshotDb]($backend).\r\n * @public\r\n */\r\nexport interface SnapshotOpenOptions extends IModelEncryptionProps, OpenDbKey {\r\n  /** @internal */\r\n  readonly lazyBlockCache?: boolean;\r\n  /** @internal */\r\n  readonly autoUploadBlocks?: boolean;\r\n  /**\r\n   * The \"base\" name that can be used for creating temporary files related to this Db.\r\n   * The string should be a name related to the current Db filename using some known pattern so that all files named \"baseName*\" can be deleted externally during cleanup.\r\n   * It must be the name of a file (that may or may not exist) in a writable directory.\r\n   * If not present, the baseName will default to the database's file name (including the path).\r\n   * @internal\r\n   */\r\n  readonly tempFileBase?: string;\r\n}\r\n\r\n/** Options to open a [StandaloneDb]($backend) via [StandaloneDb.openFile]($backend) from the backend,\r\n * or [BriefcaseConnection.openStandalone]($frontend) from the frontend.\r\n * @public\r\n */\r\nexport type StandaloneOpenOptions = OpenDbKey;\r\n\r\n/** Options that can be supplied when creating snapshot iModels.\r\n * @public\r\n */\r\nexport interface CreateSnapshotIModelProps extends IModelEncryptionProps {\r\n  /** If true, then create SQLite views for Model, Element, ElementAspect, and Relationship classes.\r\n   * These database views can often be useful for interoperability workflows.\r\n   */\r\n  readonly createClassViews?: boolean;\r\n}\r\n\r\n/** The options that can be specified when creating an *empty* snapshot iModel.\r\n * @see [SnapshotDb.createEmpty]($backend)\r\n * @public\r\n */\r\nexport type CreateEmptySnapshotIModelProps = CreateIModelProps & CreateSnapshotIModelProps;\r\n\r\n/** Options that can be supplied when creating standalone iModels.\r\n * @internal\r\n */\r\nexport interface CreateStandaloneIModelProps extends IModelEncryptionProps {\r\n  /** If present, file will allow local editing, but cannot be used to create changesets */\r\n  readonly allowEdit?: string;\r\n}\r\n\r\n/** The options that can be specified when creating an *empty* standalone iModel.\r\n * @see [standalone.createEmpty]($backend)\r\n * @internal\r\n */\r\nexport type CreateEmptyStandaloneIModelProps = CreateIModelProps & CreateStandaloneIModelProps;\r\n\r\n/** @public */\r\nexport interface FilePropertyProps {\r\n  readonly namespace: string;\r\n  readonly name: string;\r\n  id?: number | string;\r\n  subId?: number | string;\r\n}\r\n\r\n/** The position and orientation of an iModel on the earth in [ECEF](https://en.wikipedia.org/wiki/ECEF) (Earth Centered Earth Fixed) coordinates\r\n * @note This is an immutable type - all of its properties are frozen.\r\n * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\r\n * @public\r\n */\r\nexport class EcefLocation implements EcefLocationProps {\r\n  /** The origin of the ECEF transform. */\r\n  public readonly origin: Point3d;\r\n  /** The orientation of the ECEF transform */\r\n  public readonly orientation: YawPitchRollAngles;\r\n  /** Optional position on the earth used to establish the ECEF origin and orientation. */\r\n  public readonly cartographicOrigin?: Cartographic;\r\n  /** Optional X column vector used with [[yVector]] to calculate potentially non-rigid transform if a projection is present. */\r\n  public readonly xVector?: Vector3d;\r\n  /** Optional Y column vector used with [[xVector]] to calculate potentially non-rigid transform if a projection is present. */\r\n  public readonly yVector?: Vector3d;\r\n\r\n  private readonly _transform: Transform;\r\n\r\n  /** Get the transform from iModel Spatial coordinates to ECEF from this EcefLocation */\r\n  public getTransform(): Transform { return this._transform; }\r\n\r\n  /** Construct a new EcefLocation. Once constructed, it is frozen and cannot be modified. */\r\n  constructor(props: EcefLocationProps) {\r\n    this.origin = Point3d.fromJSON(props.origin).freeze();\r\n    this.orientation = YawPitchRollAngles.fromJSON(props.orientation).freeze();\r\n    if (props.cartographicOrigin)\r\n      this.cartographicOrigin = Cartographic.fromRadians({ longitude: props.cartographicOrigin.longitude, latitude: props.cartographicOrigin.latitude, height: props.cartographicOrigin.height }).freeze();\r\n    if (props.xVector && props.yVector) {\r\n      this.xVector = Vector3d.fromJSON(props.xVector).freeze();\r\n      this.yVector = Vector3d.fromJSON(props.yVector).freeze();\r\n    }\r\n    let matrix;\r\n    if (this.xVector && this.yVector) {\r\n      const zVector = this.xVector.crossProduct(this.yVector);\r\n      if (zVector.normalizeInPlace())\r\n        matrix = Matrix3d.createColumns(this.xVector, this.yVector, zVector);\r\n    }\r\n    if (!matrix)\r\n      matrix = this.orientation.toMatrix3d();\r\n\r\n    this._transform = Transform.createOriginAndMatrix(this.origin, matrix);\r\n    this._transform.freeze();\r\n  }\r\n\r\n  /** Construct ECEF Location from cartographic origin with optional known point and angle.   */\r\n  public static createFromCartographicOrigin(origin: Cartographic, point?: Point3d, angle?: Angle) {\r\n    const ecefOrigin = origin.toEcef();\r\n    const deltaRadians = 10 / Constant.earthRadiusWGS84.polar;\r\n    const northCarto = Cartographic.fromRadians({ longitude: origin.longitude, latitude: origin.latitude + deltaRadians, height: origin.height });\r\n    const eastCarto = Cartographic.fromRadians({ longitude: origin.longitude + deltaRadians, latitude: origin.latitude, height: origin.height });\r\n    const ecefNorth = northCarto.toEcef();\r\n    const ecefEast = eastCarto.toEcef();\r\n    const xVector = Vector3d.createStartEnd(ecefOrigin, ecefEast).normalize();\r\n    const yVector = Vector3d.createStartEnd(ecefOrigin, ecefNorth).normalize();\r\n    const matrix = Matrix3d.createRigidFromColumns(xVector!, yVector!, AxisOrder.XYZ)!;\r\n    if (angle !== undefined) {\r\n      const north = Matrix3d.createRotationAroundAxisIndex(AxisIndex.Z, angle);\r\n      matrix.multiplyMatrixMatrix(north, matrix);\r\n    }\r\n    if (point !== undefined) {\r\n      const delta = matrix.multiplyVector(Vector3d.create(-point.x, -point.y, -point.z));\r\n      ecefOrigin.addInPlace(delta);\r\n    }\r\n\r\n    return new EcefLocation({ origin: ecefOrigin, orientation: YawPitchRollAngles.createFromMatrix3d(matrix)!, cartographicOrigin: origin });\r\n  }\r\n\r\n  /** Get the location center of the earth in the iModel coordinate system. */\r\n  public get earthCenter(): Point3d {\r\n    const matrix = this.orientation.toMatrix3d();\r\n    return Point3d.createFrom(matrix.multiplyTransposeXYZ(-this.origin.x, -this.origin.y, -this.origin.z));\r\n  }\r\n\r\n  /** Return true if this location is equivalent to another location within a small tolerance. */\r\n  public isAlmostEqual(other: EcefLocation): boolean {\r\n    if (!this.origin.isAlmostEqual(other.origin) || !this.orientation.isAlmostEqual(other.orientation))\r\n      return false;\r\n\r\n    if ((this.xVector === undefined) !== (other.xVector === undefined) || (this.yVector === undefined) !== (other.yVector === undefined))\r\n      return false;\r\n\r\n    if (this.xVector !== undefined && other.xVector !== undefined && !this.xVector.isAlmostEqual(other.xVector))\r\n      return false;\r\n\r\n    if (this.yVector !== undefined && other.yVector !== undefined && !this.yVector.isAlmostEqual(other.yVector))\r\n      return false;\r\n\r\n    const thisCarto = this.cartographicOrigin;\r\n    const otherCarto = other.cartographicOrigin;\r\n    if (undefined === thisCarto || undefined === otherCarto)\r\n      return undefined === thisCarto && undefined === otherCarto;\r\n\r\n    return thisCarto.equalsEpsilon(otherCarto, Geometry.smallMetricDistance);\r\n  }\r\n\r\n  public toJSON(): EcefLocationProps {\r\n    const props: Mutable<EcefLocationProps> = {\r\n      origin: this.origin.toJSON(),\r\n      orientation: this.orientation.toJSON(),\r\n    };\r\n\r\n    if (this.cartographicOrigin)\r\n      props.cartographicOrigin = this.cartographicOrigin.toJSON();\r\n\r\n    if (this.xVector)\r\n      props.xVector = this.xVector.toJSON();\r\n\r\n    if (this.yVector)\r\n      props.yVector = this.yVector.toJSON();\r\n\r\n    return props;\r\n  }\r\n}\r\n\r\n/** Represents an iModel in JavaScript.\r\n * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\r\n * @public\r\n */\r\nexport abstract class IModel implements IModelProps {\r\n  private _projectExtents?: AxisAlignedBox3d;\r\n  private _name?: string;\r\n  private _rootSubject?: RootSubjectProps;\r\n  private _globalOrigin?: Point3d;\r\n  private _ecefLocation?: EcefLocation;\r\n  private _geographicCoordinateSystem?: GeographicCRS;\r\n  private _iModelId?: GuidString;\r\n\r\n  /** The Id of the repository model. */\r\n  public static readonly repositoryModelId: Id64String = \"0x1\";\r\n  /** The Id of the root subject element. */\r\n  public static readonly rootSubjectId: Id64String = \"0x1\";\r\n  /** The Id of the dictionary model. */\r\n  public static readonly dictionaryId: Id64String = \"0x10\";\r\n\r\n  /** Event raised after [[name]] changes. */\r\n  public readonly onNameChanged = new BeEvent<(previousName: string) => void>();\r\n  /** Event raised after [[rootSubject]] changes. */\r\n  public readonly onRootSubjectChanged = new BeEvent<(previousSubject: RootSubjectProps) => void>();\r\n  /** Event raised after [[projectExtents]] changes. */\r\n  public readonly onProjectExtentsChanged = new BeEvent<(previousExtents: AxisAlignedBox3d) => void>();\r\n  /** Event raised after [[globalOrigin]] changes. */\r\n  public readonly onGlobalOriginChanged = new BeEvent<(previousOrigin: Point3d) => void>();\r\n  /** Event raised after [[ecefLocation]] changes. */\r\n  public readonly onEcefLocationChanged = new BeEvent<(previousLocation: EcefLocation | undefined) => void>();\r\n  /** Event raised after [[geographicCoordinateSystem]] changes. */\r\n  public readonly onGeographicCoordinateSystemChanged = new BeEvent<(previousGCS: GeographicCRS | undefined) => void>();\r\n\r\n  /** Name of the iModel */\r\n  public get name(): string {\r\n    assert(this._name !== undefined);\r\n    return this._name;\r\n  }\r\n  public set name(name: string) {\r\n    if (name !== this._name) {\r\n      const old = this._name;\r\n      this._name = name;\r\n      if (undefined !== old)\r\n        this.onNameChanged.raiseEvent(old);\r\n    }\r\n  }\r\n\r\n  /** The name and description of the root subject of this iModel */\r\n  public get rootSubject(): RootSubjectProps {\r\n    assert(this._rootSubject !== undefined);\r\n    return this._rootSubject;\r\n  }\r\n  public set rootSubject(subject: RootSubjectProps) {\r\n    if (undefined === this._rootSubject || this._rootSubject.name !== subject.name || this._rootSubject.description !== subject.description) {\r\n      const old = this._rootSubject;\r\n      this._rootSubject = subject;\r\n      if (old)\r\n        this.onRootSubjectChanged.raiseEvent(old);\r\n    }\r\n  }\r\n\r\n  /** Returns `true` if this is a snapshot iModel. */\r\n  public abstract get isSnapshot(): boolean;\r\n  /** Returns `true` if this is a briefcase copy of an iModel that is synchronized with iModelHub. */\r\n  public abstract get isBriefcase(): boolean;\r\n\r\n  public abstract get isOpen(): boolean;\r\n\r\n  /**\r\n   * The volume, in spatial coordinates, inside which the entire project is contained.\r\n   * @note The object returned from this method is frozen. You *must* make a copy before you do anything that might attempt to modify it.\r\n   */\r\n  public get projectExtents() {\r\n    assert(undefined !== this._projectExtents);\r\n    return this._projectExtents;\r\n  }\r\n  public set projectExtents(extents: AxisAlignedBox3d) {\r\n    // Don't allow any axis of the project extents to be less than 1 meter.\r\n    const projectExtents = extents.clone();\r\n    projectExtents.ensureMinLengths(1.0);\r\n    if (!this._projectExtents || !this._projectExtents.isAlmostEqual(projectExtents)) {\r\n      const old = this._projectExtents;\r\n      projectExtents.freeze();\r\n      this._projectExtents = projectExtents;\r\n      if (old)\r\n        this.onProjectExtentsChanged.raiseEvent(old);\r\n    }\r\n  }\r\n\r\n  /** An offset to be applied to all spatial coordinates. */\r\n  public get globalOrigin(): Point3d {\r\n    assert(this._globalOrigin !== undefined);\r\n    return this._globalOrigin;\r\n  }\r\n  public set globalOrigin(org: Point3d) {\r\n    if (!this._globalOrigin || !this._globalOrigin.isAlmostEqual(org)) {\r\n      const old = this._globalOrigin;\r\n      org.freeze();\r\n      this._globalOrigin = org;\r\n      if (old)\r\n        this.onGlobalOriginChanged.raiseEvent(old);\r\n    }\r\n  }\r\n\r\n  /** The [EcefLocation]($docs/learning/glossary#ecefLocation) of the iModel in Earth Centered Earth Fixed coordinates.\r\n   * If the iModel property geographicCoordinateSystem is not defined then the ecefLocation provides a geolocation by defining a\r\n   * 3D coordinate system relative to the Earth model WGS84. Refer to additional documentation for details. If the geographicCoordinateSystem\r\n   * property is defined then the ecefLocation must be used with care. When the geographicCoordinateSystem is defined it indicates the\r\n   * iModel cartesian space is the result of a cartographic projection. This implies a flattening of the Earth surface process that\r\n   * results in scale, angular or area distortion. The ecefLocation is then an approximation calculated at the center of the project extent.\r\n   * If the project is more than 2 kilometer in size, the ecefLocation may represent a poor approximation of the effective\r\n   * cartographic projection used and a linear transformation should then be calculated at the exact origin of the data\r\n   * it must position.\r\n   * @see [GeoLocation of iModels]($docs/learning/GeoLocation.md)\r\n  */\r\n  public get ecefLocation(): EcefLocation | undefined {\r\n    return this._ecefLocation;\r\n  }\r\n  public set ecefLocation(ecefLocation: EcefLocation | undefined) {\r\n    const old = this._ecefLocation;\r\n    if (!old && !ecefLocation)\r\n      return;\r\n    else if (old && ecefLocation && old.isAlmostEqual(ecefLocation))\r\n      return;\r\n\r\n    this._ecefLocation = ecefLocation;\r\n    this.onEcefLocationChanged.raiseEvent(old);\r\n  }\r\n\r\n  /** Set the [EcefLocation]($docs/learning/glossary#ecefLocation) for this iModel. */\r\n  public setEcefLocation(ecef: EcefLocationProps): void {\r\n    this.ecefLocation = new EcefLocation(ecef);\r\n  }\r\n\r\n  /** The geographic coordinate reference system of the iModel. */\r\n  public get geographicCoordinateSystem(): GeographicCRS | undefined {\r\n    return this._geographicCoordinateSystem;\r\n  }\r\n  public set geographicCoordinateSystem(geoCRS: GeographicCRS | undefined) {\r\n    const old = this._geographicCoordinateSystem;\r\n    if (!old && !geoCRS)\r\n      return;\r\n    else if (old && geoCRS && old.equals(geoCRS))\r\n      return;\r\n\r\n    this._geographicCoordinateSystem = geoCRS;\r\n    this.onGeographicCoordinateSystemChanged.raiseEvent(old);\r\n  }\r\n\r\n  /** Sets the geographic coordinate reference system from GeographicCRSProps. */\r\n  public setGeographicCoordinateSystem(geoCRS: GeographicCRSProps) {\r\n    this.geographicCoordinateSystem = new GeographicCRS(geoCRS);\r\n  }\r\n\r\n  /** @internal */\r\n  public getConnectionProps(): IModelConnectionProps {\r\n    return {\r\n      name: this.name,\r\n      rootSubject: this.rootSubject,\r\n      projectExtents: this.projectExtents.toJSON(),\r\n      globalOrigin: this.globalOrigin.toJSON(),\r\n      ecefLocation: this.ecefLocation,\r\n      geographicCoordinateSystem: this.geographicCoordinateSystem,\r\n      ... this._getRpcProps(),\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public toJSON(): IModelConnectionProps {\r\n    return this.getConnectionProps();\r\n  }\r\n\r\n  /** A key used to identify this iModel in RPC calls from frontend to backend.\r\n   * @internal\r\n   */\r\n  protected _fileKey: string;\r\n  /** Get the key that was used to open this iModel. This is the value used for Rpc and Ipc communications. */\r\n  public get key(): string { return this._fileKey; }\r\n\r\n  /** @internal */\r\n  protected _iTwinId?: GuidString;\r\n  /** The Guid that identifies the iTwin that owns this iModel. */\r\n  public get iTwinId(): GuidString | undefined { return this._iTwinId; }\r\n\r\n  /** The Guid that identifies this iModel. */\r\n  public get iModelId(): GuidString | undefined { return this._iModelId; }\r\n\r\n  /** @public */\r\n  public changeset: ChangesetIdWithIndex;\r\n\r\n  protected _openMode = OpenMode.Readonly;\r\n  /** The [[OpenMode]] used for this IModel. */\r\n  public get openMode(): OpenMode { return this._openMode; }\r\n\r\n  /** Return a token for RPC operations.\r\n   * @throws IModelError if the iModel is not open.\r\n   */\r\n  public getRpcProps(): IModelRpcProps {\r\n    if (!this.isOpen)\r\n      throw new IModelError(IModelStatus.BadRequest, \"IModel is not open for rpc\");\r\n\r\n    return this._getRpcProps();\r\n  }\r\n\r\n  /** Returns the iModel's RPC properties.\r\n   * @note It is an error to attempt to use these properties as a token for RPC operations if the iModel is not open.\r\n   * @internal\r\n   */\r\n  protected _getRpcProps(): IModelRpcProps {\r\n    return {\r\n      key: this._fileKey,\r\n      iTwinId: this.iTwinId,\r\n      iModelId: this.iModelId,\r\n      changeset: this.changeset,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  protected constructor(tokenProps?: IModelRpcProps) {\r\n    this.changeset = { id: \"\", index: 0 };\r\n    this._fileKey = \"\";\r\n    if (tokenProps) {\r\n      this._fileKey = tokenProps.key;\r\n      this._iTwinId = tokenProps.iTwinId;\r\n      this._iModelId = tokenProps.iModelId;\r\n      if (tokenProps.changeset)\r\n        this.changeset = tokenProps.changeset;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  protected initialize(name: string, props: IModelProps) {\r\n    this.name = name;\r\n    this.rootSubject = props.rootSubject;\r\n    this.projectExtents = Range3d.fromJSON(props.projectExtents);\r\n    this.globalOrigin = Point3d.fromJSON(props.globalOrigin);\r\n    this.ecefLocation = props.ecefLocation ? new EcefLocation(props.ecefLocation) : undefined;\r\n    this.geographicCoordinateSystem = props.geographicCoordinateSystem ? new GeographicCRS(props.geographicCoordinateSystem) : undefined;\r\n  }\r\n\r\n  /** Get the default subCategoryId for the supplied categoryId */\r\n  public static getDefaultSubCategoryId(categoryId: Id64String): Id64String {\r\n    return Id64.isValid(categoryId) ? Id64.fromLocalAndBriefcaseIds(Id64.getLocalId(categoryId) + 1, Id64.getBriefcaseId(categoryId)) : Id64.invalid;\r\n  }\r\n\r\n  /** True if this iModel has an [EcefLocation]($docs/learning/glossary#ecefLocation). */\r\n  public get isGeoLocated() { return undefined !== this._ecefLocation; }\r\n\r\n  /** Get the Transform from this iModel's Spatial coordinates to ECEF coordinates using its [[IModel.ecefLocation]].\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   */\r\n  public getEcefTransform(): Transform {\r\n    if (undefined === this._ecefLocation)\r\n      throw new IModelError(GeoServiceStatus.NoGeoLocation, \"iModel is not GeoLocated\");\r\n    return this._ecefLocation.getTransform();\r\n  }\r\n\r\n  /** Convert a point in this iModel's Spatial coordinates to an ECEF point using its [[IModel.ecefLocation]].\r\n   * @param spatial A point in the iModel's spatial coordinates\r\n   * @param result If defined, use this for output\r\n   * @returns A Point3d in ECEF coordinates\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   */\r\n  public spatialToEcef(spatial: XYAndZ, result?: Point3d): Point3d { return this.getEcefTransform().multiplyPoint3d(spatial, result)!; }\r\n\r\n  /** Convert a point in ECEF coordinates to a point in this iModel's Spatial coordinates using its [[ecefLocation]].\r\n   * @param ecef A point in ECEF coordinates\r\n   * @param result If defined, use this for output\r\n   * @returns A Point3d in this iModel's spatial coordinates\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   * @note The resultant point will only be meaningful if the ECEF coordinate is close on the earth to the iModel.\r\n   */\r\n  public ecefToSpatial(ecef: XYAndZ, result?: Point3d): Point3d { return this.getEcefTransform().multiplyInversePoint3d(ecef, result)!; }\r\n\r\n  /** Convert a point in this iModel's Spatial coordinates to a [[Cartographic]] using its [[IModel.ecefLocation]].\r\n   * @param spatial A point in the iModel's spatial coordinates\r\n   * @param result If defined, use this for output\r\n   * @returns A Cartographic location\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   */\r\n  public spatialToCartographicFromEcef(spatial: XYAndZ, result?: Cartographic): Cartographic { return Cartographic.fromEcef(this.spatialToEcef(spatial), result)!; }\r\n\r\n  /** Convert a [[Cartographic]] to a point in this iModel's Spatial coordinates using its [[IModel.ecefLocation]].\r\n   * @param cartographic A cartographic location\r\n   * @param result If defined, use this for output\r\n   * @returns A point in this iModel's spatial coordinates\r\n   * @throws IModelError if [[isGeoLocated]] is false.\r\n   * @note The resultant point will only be meaningful if the ECEF coordinate is close on the earth to the iModel.\r\n   */\r\n  public cartographicToSpatialFromEcef(cartographic: Cartographic, result?: Point3d) { return this.ecefToSpatial(cartographic.toEcef(result), result); }\r\n}\r\n"]}

package/lib/esm/LightSettings.d.ts

@@ -102,6 +102,58 @@ export declare class HemisphereLights {
     clone(changed?: HemisphereLightsProps): HemisphereLights;
     equals(rhs: HemisphereLights): boolean;
 }
+/** JSON representation of a [[FresnelSettings]].
+ * @public
+ */
+export interface FresnelSettingsProps {
+    /** @see [[FresnelSettings.intensity]].
+     * Default value: 0
+     */
+    intensity?: number;
+    /** @see [[FresnelSettings.invert]].
+     * Default value: false
+     */
+    invert?: boolean;
+}
+/** As part of a [[LightSettings]], describes how to apply a Fresnel effect to the contents of the view.
+ * The "Fresnel effect" is based on the observation that the reflectivity of a surface varies based on the angle between the surface and
+ * the viewer's line of sight. For example, a flat surface will appear more reflective when viewed at a glancing angle than it will when
+ * viewed from above; and a sphere will appear more reflective around its edges than at its center.
+ *
+ * This principle can be used to improve photorealism, but the implementation provided here is intended to produce non-realistic but
+ * aesthetically-pleasing results.
+ * @see [[LightSettings.fresnel]].
+ * @public
+ */
+export declare class FresnelSettings {
+    /** The strength of the effect in terms of how much brighter the surface becomes. The intensity at a given point on the surface is determined by
+     * the angle between the viewer's line of sight and the vector from the viewer to that point. Maximum intensity is produced when those vectors are
+     * perpendicular, and zero intensity is produced when those vectors are parallel (unless [[invert]] is `true`).
+     *
+     * A value of zero turns off the effect. Values less than zero are clamped to zero. Typical values range between 0 and 1.
+     */
+    readonly intensity: number;
+    /** If true, inverts the effect's [[intensity]] such that maximum intensity is produced when the viewer's line of sight is parallel to the vector between
+     * the viewer and the point on the surface, and zero intensity is produced when the viewer's line of sight is perpendicular to that vector.
+     */
+    readonly invert: boolean;
+    private constructor();
+    private static readonly _defaults;
+    /** Create from JSON representation, using default values for any unspecified or `undefined` properties. */
+    static fromJSON(props?: FresnelSettingsProps): FresnelSettings;
+    /** Create a new FresnelSettings.
+     * @note Intensity values less than zero will be set to zero.
+     */
+    static create(intensity?: number, invert?: boolean): FresnelSettings;
+    /** Convert to JSON representation.
+     * @note If all settings match the default values, `undefined` will be returned.
+     */
+    toJSON(): FresnelSettingsProps | undefined;
+    /** Create a copy of these settings, modified to match any properties explicitly specified by `changedProps`. */
+    clone(changedProps?: FresnelSettingsProps): FresnelSettings;
+    /** Return true if these settings are equivalent to `rhs`. */
+    equals(rhs: FresnelSettings): boolean;
+}
 /** Wire format for a [[LightSettings]] describing lighting for a 3d scene.
  * 3d lighting provides the following lights, all of which are optional:
  *  - A "portrait" light affixed to the camera and pointing directly forward into the scene. Color: white.
@@ -135,6 +187,10 @@ export interface LightSettingsProps {
      * Default: 0
      */
     numCels?: number;
+    /** Fresnel settings.
+     * @see [[FresnelSettings]].
+     */
+    fresnel?: FresnelSettingsProps;
 }
 /** Describes the lighting for a 3d scene, associated with a [[DisplayStyle3dSettings]] in turn associated with a [DisplayStyle3d]($backend) or [DisplayStyle3dState]($frontend).
  * @see [[LightSettingsProps]]
@@ -144,9 +200,12 @@ export declare class LightSettings {
     readonly solar: SolarLight;
     readonly ambient: AmbientLight;
     readonly hemisphere: HemisphereLights;
+    /** @see [[LightSettingsProps.portrait]]. */
     readonly portraitIntensity: number;
     readonly specularIntensity: number;
+    /** @see [[LightSettingsProps.numCels]]. */
     readonly numCels: number;
+    readonly fresnel: FresnelSettings;
     private constructor();
     static fromJSON(props?: LightSettingsProps): LightSettings;
     toJSON(): LightSettingsProps | undefined;

package/lib/esm/LightSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LightSettings.d.ts","sourceRoot":"","sources":["../../src/LightSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAOrD;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,sFAAsF;IACtF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gJAAgJ;IAChJ,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAID;;;GAGG;AACH,qBAAa,UAAU;IACrB,gJAAgJ;IAChJ,SAAgB,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC9C,sFAAsF;IACtF,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC;;OAEG;IACH,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEhB,IAAI,CAAC,EAAE,eAAe;IAclC,MAAM,IAAI,eAAe,GAAG,SAAS;IAyB5C;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,eAAe,GAAG,UAAU;IA4BjD,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO;CAGxC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,kIAAkI;IAClI,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,YAAY;IACvB,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC,SAAgB,SAAS,EAAE,MAAM,CAAC;gBAEf,IAAI,CAAC,EAAE,iBAAiB;IAMpC,MAAM,IAAI,iBAAiB,GAAG,SAAS;IAgB9C,0GAA0G;IACnG,KAAK,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,YAAY;IAchD,MAAM,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO;CAG1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,wEAAwE;IACxE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,sEAAsE;IACtE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAKD;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,SAAgB,UAAU,EAAE,QAAQ,CAAC;IACrC,SAAgB,UAAU,EAAE,QAAQ,CAAC;IACrC,SAAgB,SAAS,EAAE,MAAM,CAAC;gBAEf,IAAI,CAAC,EAAE,qBAAqB;IAOxC,MAAM,IAAI,qBAAqB,GAAG,SAAS;IAqBlD,4GAA4G;IACrG,KAAK,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,gBAAgB;IAiBxD,MAAM,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO;CAG9C;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kBAAkB;IACjC,iGAAiG;IACjG,QAAQ,CAAC,EAAE;QACT,+DAA+D;QAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,4BAA4B;IAC5B,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,iCAAiC;IACjC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,8BAA8B;IAC9B,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,gDAAgD;IAChD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,qBAAa,aAAa;IACxB,SAAgB,KAAK,EAAE,UAAU,CAAC;IAClC,SAAgB,OAAO,EAAE,YAAY,CAAC;IACtC,SAAgB,UAAU,EAAE,gBAAgB,CAAC;IAC7C,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC,OAAO;WASO,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,GAAG,aAAa;IAW1D,MAAM,IAAI,kBAAkB,GAAG,SAAS;IAiC/C;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,aAAa;IAclD,MAAM,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;CAO3C"}
+{"version":3,"file":"LightSettings.d.ts","sourceRoot":"","sources":["../../src/LightSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAOrD;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,sFAAsF;IACtF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gJAAgJ;IAChJ,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAID;;;GAGG;AACH,qBAAa,UAAU;IACrB,gJAAgJ;IAChJ,SAAgB,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC9C,sFAAsF;IACtF,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC;;OAEG;IACH,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEhB,IAAI,CAAC,EAAE,eAAe;IAclC,MAAM,IAAI,eAAe,GAAG,SAAS;IAyB5C;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,eAAe,GAAG,UAAU;IA4BjD,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO;CAGxC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,kIAAkI;IAClI,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,YAAY;IACvB,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC,SAAgB,SAAS,EAAE,MAAM,CAAC;gBAEf,IAAI,CAAC,EAAE,iBAAiB;IAMpC,MAAM,IAAI,iBAAiB,GAAG,SAAS;IAgB9C,0GAA0G;IACnG,KAAK,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,YAAY;IAchD,MAAM,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO;CAG1C;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,wEAAwE;IACxE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,sEAAsE;IACtE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAKD;;;GAGG;AACH,qBAAa,gBAAgB;IAC3B,SAAgB,UAAU,EAAE,QAAQ,CAAC;IACrC,SAAgB,UAAU,EAAE,QAAQ,CAAC;IACrC,SAAgB,SAAS,EAAE,MAAM,CAAC;gBAEf,IAAI,CAAC,EAAE,qBAAqB;IAOxC,MAAM,IAAI,qBAAqB,GAAG,SAAS;IAqBlD,4GAA4G;IACrG,KAAK,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,gBAAgB;IAiBxD,MAAM,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAMD;;;;;;;;;GASG;AACH,qBAAa,eAAe;IAC1B;;;;;OAKG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC;;OAEG;IACH,SAAgB,MAAM,EAAE,OAAO,CAAC;IAEhC,OAAO;IAMP,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAiC;IAElE,2GAA2G;WAC7F,QAAQ,CAAC,KAAK,CAAC,EAAE,oBAAoB,GAAG,eAAe;IASrE;;OAEG;WACW,MAAM,CAAC,SAAS,SAAE,EAAE,MAAM,UAAM,GAAG,eAAe;IAIhE;;OAEG;IACI,MAAM,IAAI,oBAAoB,GAAG,SAAS;IAcjD,gHAAgH;IACzG,KAAK,CAAC,YAAY,CAAC,EAAE,oBAAoB,GAAG,eAAe;IAUlE,6DAA6D;IACtD,MAAM,CAAC,GAAG,EAAE,eAAe,GAAG,OAAO;CAG7C;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kBAAkB;IACjC,iGAAiG;IACjG,QAAQ,CAAC,EAAE;QACT,+DAA+D;QAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,4BAA4B;IAC5B,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,iCAAiC;IACjC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,8BAA8B;IAC9B,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,gDAAgD;IAChD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED;;;GAGG;AACH,qBAAa,aAAa;IACxB,SAAgB,KAAK,EAAE,UAAU,CAAC;IAClC,SAAgB,OAAO,EAAE,YAAY,CAAC;IACtC,SAAgB,UAAU,EAAE,gBAAgB,CAAC;IAC7C,4CAA4C;IAC5C,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,2CAA2C;IAC3C,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,OAAO,EAAE,eAAe,CAAC;IAEzC,OAAO;WAWO,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,GAAG,aAAa;IAY1D,MAAM,IAAI,kBAAkB,GAAG,SAAS;IAqC/C;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,aAAa;IAelD,MAAM,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;CAO3C"}

package/lib/esm/LightSettings.js

@@ -5,7 +5,7 @@
 /** @packageDocumentation
  * @module DisplayStyles
  */
-import { JsonUtils } from "@itwin/core-bentley";
+import { assert, JsonUtils } from "@itwin/core-bentley";
 import { Vector3d } from "@itwin/core-geometry";
 import { RgbColor } from "./RgbColor";
 function extractIntensity(value, defaultValue) {
@@ -160,18 +160,81 @@ export class HemisphereLights {
         return this.intensity === rhs.intensity && this.upperColor.equals(rhs.upperColor) && this.lowerColor.equals(rhs.lowerColor);
     }
 }
+function clampIntensity(intensity = 0) {
+    return Math.max(intensity, 0);
+}
+/** As part of a [[LightSettings]], describes how to apply a Fresnel effect to the contents of the view.
+ * The "Fresnel effect" is based on the observation that the reflectivity of a surface varies based on the angle between the surface and
+ * the viewer's line of sight. For example, a flat surface will appear more reflective when viewed at a glancing angle than it will when
+ * viewed from above; and a sphere will appear more reflective around its edges than at its center.
+ *
+ * This principle can be used to improve photorealism, but the implementation provided here is intended to produce non-realistic but
+ * aesthetically-pleasing results.
+ * @see [[LightSettings.fresnel]].
+ * @public
+ */
+export class FresnelSettings {
+    constructor(intensity, invert) {
+        assert(intensity >= 0);
+        this.intensity = intensity;
+        this.invert = invert;
+    }
+    /** Create from JSON representation, using default values for any unspecified or `undefined` properties. */
+    static fromJSON(props) {
+        const intensity = clampIntensity(JsonUtils.asDouble(props === null || props === void 0 ? void 0 : props.intensity));
+        const invert = JsonUtils.asBool(props === null || props === void 0 ? void 0 : props.invert);
+        if (0 === intensity && !invert)
+            return this._defaults;
+        return new this(intensity, invert);
+    }
+    /** Create a new FresnelSettings.
+     * @note Intensity values less than zero will be set to zero.
+     */
+    static create(intensity = 0, invert = false) {
+        return this.fromJSON({ intensity, invert });
+    }
+    /** Convert to JSON representation.
+     * @note If all settings match the default values, `undefined` will be returned.
+     */
+    toJSON() {
+        if (0 === this.intensity && !this.invert)
+            return undefined;
+        const props = {};
+        if (0 !== this.intensity)
+            props.intensity = this.intensity;
+        if (this.invert)
+            props.invert = true;
+        return props;
+    }
+    /** Create a copy of these settings, modified to match any properties explicitly specified by `changedProps`. */
+    clone(changedProps) {
+        var _a, _b;
+        if ((undefined === (changedProps === null || changedProps === void 0 ? void 0 : changedProps.intensity) || changedProps.intensity === this.intensity)
+            && (undefined === (changedProps === null || changedProps === void 0 ? void 0 : changedProps.invert) || changedProps.invert === this.invert))
+            return this;
+        const intensity = (_a = changedProps === null || changedProps === void 0 ? void 0 : changedProps.intensity) !== null && _a !== void 0 ? _a : this.intensity;
+        const invert = (_b = changedProps === null || changedProps === void 0 ? void 0 : changedProps.invert) !== null && _b !== void 0 ? _b : this.invert;
+        return FresnelSettings.fromJSON({ intensity, invert });
+    }
+    /** Return true if these settings are equivalent to `rhs`. */
+    equals(rhs) {
+        return this === rhs || (this.intensity === rhs.intensity && this.invert === rhs.invert);
+    }
+}
+FresnelSettings._defaults = new FresnelSettings(0, false);
 /** Describes the lighting for a 3d scene, associated with a [[DisplayStyle3dSettings]] in turn associated with a [DisplayStyle3d]($backend) or [DisplayStyle3dState]($frontend).
  * @see [[LightSettingsProps]]
  * @public
  */
 export class LightSettings {
-    constructor(solar, ambient, hemisphere, portraitIntensity, specularIntensity, numCels) {
+    constructor(solar, ambient, hemisphere, portraitIntensity, specularIntensity, numCels, fresnel) {
         this.solar = solar;
         this.ambient = ambient;
         this.hemisphere = hemisphere;
         this.portraitIntensity = portraitIntensity;
         this.specularIntensity = specularIntensity;
         this.numCels = numCels;
+        this.fresnel = fresnel;
     }
     static fromJSON(props) {
         var _a;
@@ -181,7 +244,8 @@ export class LightSettings {
         const portraitIntensity = extractIntensity((_a = props === null || props === void 0 ? void 0 : props.portrait) === null || _a === void 0 ? void 0 : _a.intensity, 0.3);
         const specularIntensity = extractIntensity(props === null || props === void 0 ? void 0 : props.specularIntensity, 1.0);
         const numCels = JsonUtils.asInt(props === null || props === void 0 ? void 0 : props.numCels, 0);
-        return new LightSettings(solar, ambient, hemisphere, portraitIntensity, specularIntensity, numCels);
+        const fresnel = FresnelSettings.fromJSON(props === null || props === void 0 ? void 0 : props.fresnel);
+        return new LightSettings(solar, ambient, hemisphere, portraitIntensity, specularIntensity, numCels, fresnel);
     }
     toJSON() {
         const solar = this.solar.toJSON();
@@ -190,7 +254,8 @@ export class LightSettings {
         const portrait = 0.3 !== this.portraitIntensity ? { intensity: this.portraitIntensity } : undefined;
         const specularIntensity = 1 !== this.specularIntensity ? this.specularIntensity : undefined;
         const numCels = 0 !== this.numCels ? this.numCels : undefined;
-        if (!solar && !ambient && !hemisphere && !portrait && undefined === specularIntensity && undefined === numCels)
+        const fresnel = this.fresnel.toJSON();
+        if (!solar && !ambient && !hemisphere && !portrait && undefined === specularIntensity && undefined === numCels && undefined === fresnel)
             return undefined;
         const json = {};
         if (solar)
@@ -205,6 +270,8 @@ export class LightSettings {
             json.specularIntensity = specularIntensity;
         if (undefined !== numCels)
             json.numCels = numCels;
+        if (fresnel)
+            json.fresnel = fresnel;
         return json;
     }
     /** Create a copy of these light settings, identical except for any properties explicitly specified by `changed`.
@@ -222,13 +289,14 @@ export class LightSettings {
         const portrait = (_b = (_a = changed.portrait) === null || _a === void 0 ? void 0 : _a.intensity) !== null && _b !== void 0 ? _b : this.portraitIntensity;
         const specular = (_c = changed.specularIntensity) !== null && _c !== void 0 ? _c : this.specularIntensity;
         const numCels = (_d = changed.numCels) !== null && _d !== void 0 ? _d : this.numCels;
-        return new LightSettings(solar, ambient, hemisphere, portrait, specular, numCels);
+        const fresnel = this.fresnel.clone(changed.fresnel);
+        return new LightSettings(solar, ambient, hemisphere, portrait, specular, numCels, fresnel);
     }
     equals(rhs) {
         if (this === rhs)
             return true;
         return this.portraitIntensity === rhs.portraitIntensity && this.specularIntensity === rhs.specularIntensity && this.numCels === rhs.numCels
-            && this.ambient.equals(rhs.ambient) && this.solar.equals(rhs.solar) && this.hemisphere.equals(rhs.hemisphere);
+            && this.ambient.equals(rhs.ambient) && this.solar.equals(rhs.solar) && this.hemisphere.equals(rhs.hemisphere) && this.fresnel.equals(rhs.fresnel);
     }
 }
 //# sourceMappingURL=LightSettings.js.map