@itwin/core-common 4.0.0-dev.8 → 4.0.0-dev.81

package/lib/cjs/GeoCoordinateServices.d.ts

@@ -1,120 +1,124 @@
-/** @packageDocumentation
- * @module iModels
- */
-import { GeoServiceStatus } from "@itwin/core-bentley";
-import { XYZProps } from "@itwin/core-geometry";
-import { GeographicCRSProps } from "./geometry/CoordinateReferenceSystem";
-/** This enumeration lists all possible status as returned from a coordinate conversion to or from a
- * [[GeographicCRS]] and either another [[GeographicCRS]] or a [[GeodeticDatum]].
- * @see the [[PointWithStatus]] included in an [[IModelCoordinatesResponseProps]] or [[GeoCoordinatesResponseProps]].
- * @public
- * @extensions
- */
-export declare enum GeoCoordStatus {
-    /** Indicates successful coordinate conversion. */
-    Success = 0,
-    /** Indicates that the source or target of the conversion is not defined, usually the iModel Geographic Coordinate Reference System.*/
-    NoGCSDefined = 100,
-    /** This value indicates that the conversion was performed outside of the normal use of application of either Geographic Coordinate Reference Systems.
-     *  This return value can often be treated as a warning in specific cases. For example, global imagery extent spans the whole globe and
-     *  may extend far beyond the normal area of the iModel project extents and the extent of normal use of its Geographic Coordinate Reference System.
-     *  In such cases this value can be considered a warning as accuracy and precision is not expected in this specific case and approximate localization
-     *  of global imagery or other low accuracy context data is not essential far from the project.
-     *  If this status is returned for high accuracy data then it indicates that either Geographic Coordinate Reference Systems were inappropriately selected
-     *  for the iModel or other geolocated data. If this is the case the status should be somehow reported so action
-     *  can be performed to verify used geolocation parameters.
-     *  In either case the returned coordinates are to be considered valid though they may be inaccurate or result in some unexpected distortion of graphical
-     *  elements.
-     */
-    OutOfUsefulRange = 1,
-    /** Indicates a hard error where conversions were requested outside of the area of the mathematical capacity of the conversion process for either
-     *  Geographic Coordinate Reference Systems involved. An example could be to attempt a conversion involving a Transverse Mercator more than 60 degrees
-     *  East or West of the projection central meridian.
-     *  The values returned may or may not be valid and should be discarded.
-     */
-    OutOfMathematicalDomain = 2,
-    /** Indicates that datum transformation between the two Geographic Coordinate Reference Systems could not be performed.
-     *  This error is usually the result of a datum transformation path requiring use of latitude/longitude grid shift files that could not be obtained
-     *  or installed. In this case the latitude/longitude transformation is bypassed but the remainder of the conversion process is completed.
-     *  This error can be ignored for low accuracy data but should be somehow reported so actions can be performed to provide the missing files.
-     */
-    NoDatumConverter = 25,
-    /** Indicates that a problem occurred during vertical datum conversion. This may the result of the inability to access the
-     *  Geoid separation data or vertical datum differential data (such as used by NGVD29 to NAVD88 conversion).
-     *  The horizontal coordinates returned are valid but the elevation ordinate will be returned unchanged or partially changed.
-     *  This status should be somehow reported so actions can be performed to provide the missing information.
-     */
-    VerticalDatumConvertError = 26,
-    /** General inner conversion engine error. Coordinates returned are invalid and should be discarded */
-    CSMapError = 4096,
-    /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend
-     *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).
-     *  At the completion of the conversion promise no coordinates should have this status.
-     */
-    Pending = -41556
-}
-/** Maps a GeoCoordStatus to the equivalent GeoServiceStatus.
- * @public
- */
-export declare function mapToGeoServiceStatus(s: GeoCoordStatus): GeoServiceStatus;
-/** Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates
- * @beta
- */
-export interface IModelCoordinatesRequestProps {
-    source: string;
-    geoCoords: XYZProps[];
-}
-/** Information returned from a request to convert an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates
- * @beta
- */
-export interface PointWithStatus {
-    p: XYZProps;
-    s: GeoCoordStatus;
-}
-/** @beta */
-export interface IModelCoordinatesResponseProps {
-    iModelCoords: PointWithStatus[];
-    fromCache: number;
-}
-/** Information required to request conversion of an array of iModel coordinates to Geographic Coordinates (longitude and latitude)
- * @beta
- */
-export interface GeoCoordinatesRequestProps {
-    target: string;
-    iModelCoords: XYZProps[];
-}
-/** Information returned from a request to convert an array of iModel coordinates to Geographic Coordinates (longitude and latitude)
- * @beta
- */
-export interface GeoCoordinatesResponseProps {
-    geoCoords: PointWithStatus[];
-    fromCache: number;
-}
-/** Information required to interpret or complete a Geographic CRS in the specified format.
- *  The only currently supported formats are JSON (for completion) and WKT (OGC Well Known Text)
- * @beta
- */
-export interface GeographicCRSInterpretRequestProps {
-    /** The format of the geographic CRS definition provided in the geographicCRSDef property. */
-    format: "WKT" | "JSON";
-    /** The geographic CRS definition in the format specified in the format property.
-     *  Note that when the WKT is used the WKT fragment provided can start with a COMPD_CS clause
-     *  which should then contain both the horizontal CRS definition as well as the vertical CRS specification.
-     *  WKT fragments starting with PROJCS or GEOGCS are also supported but the vertical CRS will be assigned a
-     *  default value.
-    */
-    geographicCRSDef: string;
-}
-/** Information returned from a request to interpret or complete a Geographic CRS
- * @beta
- */
-export interface GeographicCRSInterpretResponseProps {
-    /** The result status of the interpret operation. A value of zero indicates successful interpretation.
-     *  Any value other than zero is to be considered a hard error and no valid result will
-     *  be returned in the geographicCRS property.
-    */
-    status: number;
-    /** The property that receives the interpreted geographic CRS if the process was successful. */
-    geographicCRS?: GeographicCRSProps;
-}
+/** @packageDocumentation
+ * @module iModels
+ */
+import { GeoServiceStatus } from "@itwin/core-bentley";
+import { XYZProps } from "@itwin/core-geometry";
+import { GeographicCRSProps } from "./geometry/CoordinateReferenceSystem";
+/** This enumeration lists all possible status as returned from a coordinate conversion to or from a
+ * [[GeographicCRS]] and either another [[GeographicCRS]] or a [[GeodeticDatum]].
+ * @see [[GeoConverter]] to perform coordinate conversions.
+ * @see [[PointWithStatus]] for the result of a coordinate conversion, including its status code.
+ * @public
+ * @extensions
+ */
+export declare enum GeoCoordStatus {
+    /** Indicates successful coordinate conversion. */
+    Success = 0,
+    /** Indicates that the source or target of the conversion is not defined, usually the iModel Geographic Coordinate Reference System.*/
+    NoGCSDefined = 100,
+    /** This value indicates that the conversion was performed outside of the normal use of application of either Geographic Coordinate Reference Systems.
+     *  This return value can often be treated as a warning in specific cases. For example, global imagery extent spans the whole globe and
+     *  may extend far beyond the normal area of the iModel project extents and the extent of normal use of its Geographic Coordinate Reference System.
+     *  In such cases this value can be considered a warning as accuracy and precision is not expected in this specific case and approximate localization
+     *  of global imagery or other low accuracy context data is not essential far from the project.
+     *  If this status is returned for high accuracy data then it indicates that either Geographic Coordinate Reference Systems were inappropriately selected
+     *  for the iModel or other geolocated data. If this is the case the status should be somehow reported so action
+     *  can be performed to verify used geolocation parameters.
+     *  In either case the returned coordinates are to be considered valid though they may be inaccurate or result in some unexpected distortion of graphical
+     *  elements.
+     */
+    OutOfUsefulRange = 1,
+    /** Indicates a hard error where conversions were requested outside of the area of the mathematical capacity of the conversion process for either
+     *  Geographic Coordinate Reference Systems involved. An example could be to attempt a conversion involving a Transverse Mercator more than 60 degrees
+     *  East or West of the projection central meridian.
+     *  The values returned may or may not be valid and should be discarded.
+     */
+    OutOfMathematicalDomain = 2,
+    /** Indicates that datum transformation between the two Geographic Coordinate Reference Systems could not be performed.
+     *  This error is usually the result of a datum transformation path requiring use of latitude/longitude grid shift files that could not be obtained
+     *  or installed. In this case the latitude/longitude transformation is bypassed but the remainder of the conversion process is completed.
+     *  This error can be ignored for low accuracy data but should be somehow reported so actions can be performed to provide the missing files.
+     */
+    NoDatumConverter = 25,
+    /** Indicates that a problem occurred during vertical datum conversion. This may the result of the inability to access the
+     *  Geoid separation data or vertical datum differential data (such as used by NGVD29 to NAVD88 conversion).
+     *  The horizontal coordinates returned are valid but the elevation ordinate will be returned unchanged or partially changed.
+     *  This status should be somehow reported so actions can be performed to provide the missing information.
+     */
+    VerticalDatumConvertError = 26,
+    /** General inner conversion engine error. Coordinates returned are invalid and should be discarded */
+    CSMapError = 4096,
+    /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend
+     *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).
+     *  At the completion of the conversion promise no coordinates should have this status.
+     */
+    Pending = -41556
+}
+/** Maps a GeoCoordStatus to the equivalent GeoServiceStatus.
+ * @public
+ */
+export declare function mapToGeoServiceStatus(s: GeoCoordStatus): GeoServiceStatus;
+/** Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates
+ * @beta
+ */
+export interface IModelCoordinatesRequestProps {
+    source: string;
+    geoCoords: XYZProps[];
+}
+/** A point converted to iModel coordinates to geographic coordinates or vice-versa by a [[GeoConverter]].
+ * The status [[s]] indicates the converted point [[p]]'s degree of accuracy.
+ * @public
+ */
+export interface PointWithStatus {
+    /** A JSON representation of the converted point. */
+    p: XYZProps;
+    /** A status code indicating the degree of accuracy with the point [[p]] was converted. */
+    s: GeoCoordStatus;
+}
+/** @beta */
+export interface IModelCoordinatesResponseProps {
+    iModelCoords: PointWithStatus[];
+    fromCache: number;
+}
+/** Information required to request conversion of an array of iModel coordinates to Geographic Coordinates (longitude and latitude)
+ * @beta
+ */
+export interface GeoCoordinatesRequestProps {
+    target: string;
+    iModelCoords: XYZProps[];
+}
+/** Information returned from a request to convert an array of iModel coordinates to Geographic Coordinates (longitude and latitude)
+ * @beta
+ */
+export interface GeoCoordinatesResponseProps {
+    geoCoords: PointWithStatus[];
+    fromCache: number;
+}
+/** Information required to interpret or complete a Geographic CRS in the specified format.
+ *  The only currently supported formats are JSON (for completion) and WKT (OGC Well Known Text)
+ * @beta
+ */
+export interface GeographicCRSInterpretRequestProps {
+    /** The format of the geographic CRS definition provided in the geographicCRSDef property. */
+    format: "WKT" | "JSON";
+    /** The geographic CRS definition in the format specified in the format property.
+     *  Note that when the WKT is used the WKT fragment provided can start with a COMPD_CS clause
+     *  which should then contain both the horizontal CRS definition as well as the vertical CRS specification.
+     *  WKT fragments starting with PROJCS or GEOGCS are also supported but the vertical CRS will be assigned a
+     *  default value.
+    */
+    geographicCRSDef: string;
+}
+/** Information returned from a request to interpret or complete a Geographic CRS
+ * @beta
+ */
+export interface GeographicCRSInterpretResponseProps {
+    /** The result status of the interpret operation. A value of zero indicates successful interpretation.
+     *  Any value other than zero is to be considered a hard error and no valid result will
+     *  be returned in the geographicCRS property.
+    */
+    status: number;
+    /** The property that receives the interpreted geographic CRS if the process was successful. */
+    geographicCRS?: GeographicCRSProps;
+}
 //# sourceMappingURL=GeoCoordinateServices.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"GeoCoordinateServices.d.ts","sourceRoot":"","sources":["../../src/GeoCoordinateServices.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAE1E;;;;;GAKG;AACH,oBAAY,cAAc;IACxB,kDAAkD;IAClD,OAAO,IAAI;IACX,sIAAsI;IACtI,YAAY,MAAM;IAClB;;;;;;;;;;OAUG;IACH,gBAAgB,IAAI;IACpB;;;;OAIG;IACH,uBAAuB,IAAI;IAC3B;;;;OAIG;IACH,gBAAgB,KAAK;IACrB;;;;OAIG;IACH,yBAAyB,KAAK;IAC9B,sGAAsG;IACtG,UAAU,OAAO;IACjB;;;OAGG;IACH,OAAO,SAAS;CACjB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAazE;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,EAAE,QAAQ,CAAC;IACZ,CAAC,EAAE,cAAc,CAAC;CACnB;AAED,YAAY;AACZ,MAAM,WAAW,8BAA8B;IAC7C,YAAY,EAAE,eAAe,EAAE,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,QAAQ,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD,6FAA6F;IAC7F,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC;IACvB;;;;;MAKE;IACF,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;;MAGE;IACF,MAAM,EAAE,MAAM,CAAC;IACf,+FAA+F;IAC/F,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC"}
+{"version":3,"file":"GeoCoordinateServices.d.ts","sourceRoot":"","sources":["../../src/GeoCoordinateServices.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAE1E;;;;;;GAMG;AACH,oBAAY,cAAc;IACxB,kDAAkD;IAClD,OAAO,IAAI;IACX,sIAAsI;IACtI,YAAY,MAAM;IAClB;;;;;;;;;;OAUG;IACH,gBAAgB,IAAI;IACpB;;;;OAIG;IACH,uBAAuB,IAAI;IAC3B;;;;OAIG;IACH,gBAAgB,KAAK;IACrB;;;;OAIG;IACH,yBAAyB,KAAK;IAC9B,sGAAsG;IACtG,UAAU,OAAO;IACjB;;;OAGG;IACH,OAAO,SAAS;CACjB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAazE;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,oDAAoD;IACpD,CAAC,EAAE,QAAQ,CAAC;IACZ,0FAA0F;IAC1F,CAAC,EAAE,cAAc,CAAC;CACnB;AAED,YAAY;AACZ,MAAM,WAAW,8BAA8B;IAC7C,YAAY,EAAE,eAAe,EAAE,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,QAAQ,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD,6FAA6F;IAC7F,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC;IACvB;;;;;MAKE;IACF,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;;MAGE;IACF,MAAM,EAAE,MAAM,CAAC;IACf,+FAA+F;IAC/F,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC"}

package/lib/cjs/GeoCoordinateServices.js

@@ -1,81 +1,82 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module iModels
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapToGeoServiceStatus = exports.GeoCoordStatus = void 0;
-// cspell:ignore NGVD, NAVD, COMPD_CS, PROJCS, GEOGCS
-const core_bentley_1 = require("@itwin/core-bentley");
-/** This enumeration lists all possible status as returned from a coordinate conversion to or from a
- * [[GeographicCRS]] and either another [[GeographicCRS]] or a [[GeodeticDatum]].
- * @see the [[PointWithStatus]] included in an [[IModelCoordinatesResponseProps]] or [[GeoCoordinatesResponseProps]].
- * @public
- * @extensions
- */
-var GeoCoordStatus;
-(function (GeoCoordStatus) {
-    /** Indicates successful coordinate conversion. */
-    GeoCoordStatus[GeoCoordStatus["Success"] = 0] = "Success";
-    /** Indicates that the source or target of the conversion is not defined, usually the iModel Geographic Coordinate Reference System.*/
-    GeoCoordStatus[GeoCoordStatus["NoGCSDefined"] = 100] = "NoGCSDefined";
-    /** This value indicates that the conversion was performed outside of the normal use of application of either Geographic Coordinate Reference Systems.
-     *  This return value can often be treated as a warning in specific cases. For example, global imagery extent spans the whole globe and
-     *  may extend far beyond the normal area of the iModel project extents and the extent of normal use of its Geographic Coordinate Reference System.
-     *  In such cases this value can be considered a warning as accuracy and precision is not expected in this specific case and approximate localization
-     *  of global imagery or other low accuracy context data is not essential far from the project.
-     *  If this status is returned for high accuracy data then it indicates that either Geographic Coordinate Reference Systems were inappropriately selected
-     *  for the iModel or other geolocated data. If this is the case the status should be somehow reported so action
-     *  can be performed to verify used geolocation parameters.
-     *  In either case the returned coordinates are to be considered valid though they may be inaccurate or result in some unexpected distortion of graphical
-     *  elements.
-     */
-    GeoCoordStatus[GeoCoordStatus["OutOfUsefulRange"] = 1] = "OutOfUsefulRange";
-    /** Indicates a hard error where conversions were requested outside of the area of the mathematical capacity of the conversion process for either
-     *  Geographic Coordinate Reference Systems involved. An example could be to attempt a conversion involving a Transverse Mercator more than 60 degrees
-     *  East or West of the projection central meridian.
-     *  The values returned may or may not be valid and should be discarded.
-     */
-    GeoCoordStatus[GeoCoordStatus["OutOfMathematicalDomain"] = 2] = "OutOfMathematicalDomain";
-    /** Indicates that datum transformation between the two Geographic Coordinate Reference Systems could not be performed.
-     *  This error is usually the result of a datum transformation path requiring use of latitude/longitude grid shift files that could not be obtained
-     *  or installed. In this case the latitude/longitude transformation is bypassed but the remainder of the conversion process is completed.
-     *  This error can be ignored for low accuracy data but should be somehow reported so actions can be performed to provide the missing files.
-     */
-    GeoCoordStatus[GeoCoordStatus["NoDatumConverter"] = 25] = "NoDatumConverter";
-    /** Indicates that a problem occurred during vertical datum conversion. This may the result of the inability to access the
-     *  Geoid separation data or vertical datum differential data (such as used by NGVD29 to NAVD88 conversion).
-     *  The horizontal coordinates returned are valid but the elevation ordinate will be returned unchanged or partially changed.
-     *  This status should be somehow reported so actions can be performed to provide the missing information.
-     */
-    GeoCoordStatus[GeoCoordStatus["VerticalDatumConvertError"] = 26] = "VerticalDatumConvertError";
-    /** General inner conversion engine error. Coordinates returned are invalid and should be discarded */
-    GeoCoordStatus[GeoCoordStatus["CSMapError"] = 4096] = "CSMapError";
-    /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend
-     *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).
-     *  At the completion of the conversion promise no coordinates should have this status.
-     */
-    GeoCoordStatus[GeoCoordStatus["Pending"] = -41556] = "Pending";
-})(GeoCoordStatus = exports.GeoCoordStatus || (exports.GeoCoordStatus = {}));
-/** Maps a GeoCoordStatus to the equivalent GeoServiceStatus.
- * @public
- */
-function mapToGeoServiceStatus(s) {
-    switch (s) {
-        case GeoCoordStatus.Success: return core_bentley_1.GeoServiceStatus.Success;
-        case GeoCoordStatus.NoGCSDefined: return core_bentley_1.GeoServiceStatus.NoGeoLocation;
-        case GeoCoordStatus.OutOfUsefulRange: return core_bentley_1.GeoServiceStatus.OutOfUsefulRange;
-        case GeoCoordStatus.OutOfMathematicalDomain: return core_bentley_1.GeoServiceStatus.OutOfMathematicalDomain;
-        case GeoCoordStatus.NoDatumConverter: return core_bentley_1.GeoServiceStatus.NoDatumConverter;
-        case GeoCoordStatus.VerticalDatumConvertError: return core_bentley_1.GeoServiceStatus.VerticalDatumConvertError;
-        case GeoCoordStatus.CSMapError: return core_bentley_1.GeoServiceStatus.CSMapError;
-        case GeoCoordStatus.Pending: return core_bentley_1.GeoServiceStatus.Pending;
-        default:
-            throw new Error("GeoCoordStatus -> GeoServiceStatus - Missing enum conversion");
-    }
-}
-exports.mapToGeoServiceStatus = mapToGeoServiceStatus;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapToGeoServiceStatus = exports.GeoCoordStatus = void 0;
+// cspell:ignore NGVD, NAVD, COMPD_CS, PROJCS, GEOGCS
+const core_bentley_1 = require("@itwin/core-bentley");
+/** This enumeration lists all possible status as returned from a coordinate conversion to or from a
+ * [[GeographicCRS]] and either another [[GeographicCRS]] or a [[GeodeticDatum]].
+ * @see [[GeoConverter]] to perform coordinate conversions.
+ * @see [[PointWithStatus]] for the result of a coordinate conversion, including its status code.
+ * @public
+ * @extensions
+ */
+var GeoCoordStatus;
+(function (GeoCoordStatus) {
+    /** Indicates successful coordinate conversion. */
+    GeoCoordStatus[GeoCoordStatus["Success"] = 0] = "Success";
+    /** Indicates that the source or target of the conversion is not defined, usually the iModel Geographic Coordinate Reference System.*/
+    GeoCoordStatus[GeoCoordStatus["NoGCSDefined"] = 100] = "NoGCSDefined";
+    /** This value indicates that the conversion was performed outside of the normal use of application of either Geographic Coordinate Reference Systems.
+     *  This return value can often be treated as a warning in specific cases. For example, global imagery extent spans the whole globe and
+     *  may extend far beyond the normal area of the iModel project extents and the extent of normal use of its Geographic Coordinate Reference System.
+     *  In such cases this value can be considered a warning as accuracy and precision is not expected in this specific case and approximate localization
+     *  of global imagery or other low accuracy context data is not essential far from the project.
+     *  If this status is returned for high accuracy data then it indicates that either Geographic Coordinate Reference Systems were inappropriately selected
+     *  for the iModel or other geolocated data. If this is the case the status should be somehow reported so action
+     *  can be performed to verify used geolocation parameters.
+     *  In either case the returned coordinates are to be considered valid though they may be inaccurate or result in some unexpected distortion of graphical
+     *  elements.
+     */
+    GeoCoordStatus[GeoCoordStatus["OutOfUsefulRange"] = 1] = "OutOfUsefulRange";
+    /** Indicates a hard error where conversions were requested outside of the area of the mathematical capacity of the conversion process for either
+     *  Geographic Coordinate Reference Systems involved. An example could be to attempt a conversion involving a Transverse Mercator more than 60 degrees
+     *  East or West of the projection central meridian.
+     *  The values returned may or may not be valid and should be discarded.
+     */
+    GeoCoordStatus[GeoCoordStatus["OutOfMathematicalDomain"] = 2] = "OutOfMathematicalDomain";
+    /** Indicates that datum transformation between the two Geographic Coordinate Reference Systems could not be performed.
+     *  This error is usually the result of a datum transformation path requiring use of latitude/longitude grid shift files that could not be obtained
+     *  or installed. In this case the latitude/longitude transformation is bypassed but the remainder of the conversion process is completed.
+     *  This error can be ignored for low accuracy data but should be somehow reported so actions can be performed to provide the missing files.
+     */
+    GeoCoordStatus[GeoCoordStatus["NoDatumConverter"] = 25] = "NoDatumConverter";
+    /** Indicates that a problem occurred during vertical datum conversion. This may the result of the inability to access the
+     *  Geoid separation data or vertical datum differential data (such as used by NGVD29 to NAVD88 conversion).
+     *  The horizontal coordinates returned are valid but the elevation ordinate will be returned unchanged or partially changed.
+     *  This status should be somehow reported so actions can be performed to provide the missing information.
+     */
+    GeoCoordStatus[GeoCoordStatus["VerticalDatumConvertError"] = 26] = "VerticalDatumConvertError";
+    /** General inner conversion engine error. Coordinates returned are invalid and should be discarded */
+    GeoCoordStatus[GeoCoordStatus["CSMapError"] = 4096] = "CSMapError";
+    /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend
+     *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).
+     *  At the completion of the conversion promise no coordinates should have this status.
+     */
+    GeoCoordStatus[GeoCoordStatus["Pending"] = -41556] = "Pending";
+})(GeoCoordStatus = exports.GeoCoordStatus || (exports.GeoCoordStatus = {}));
+/** Maps a GeoCoordStatus to the equivalent GeoServiceStatus.
+ * @public
+ */
+function mapToGeoServiceStatus(s) {
+    switch (s) {
+        case GeoCoordStatus.Success: return core_bentley_1.GeoServiceStatus.Success;
+        case GeoCoordStatus.NoGCSDefined: return core_bentley_1.GeoServiceStatus.NoGeoLocation;
+        case GeoCoordStatus.OutOfUsefulRange: return core_bentley_1.GeoServiceStatus.OutOfUsefulRange;
+        case GeoCoordStatus.OutOfMathematicalDomain: return core_bentley_1.GeoServiceStatus.OutOfMathematicalDomain;
+        case GeoCoordStatus.NoDatumConverter: return core_bentley_1.GeoServiceStatus.NoDatumConverter;
+        case GeoCoordStatus.VerticalDatumConvertError: return core_bentley_1.GeoServiceStatus.VerticalDatumConvertError;
+        case GeoCoordStatus.CSMapError: return core_bentley_1.GeoServiceStatus.CSMapError;
+        case GeoCoordStatus.Pending: return core_bentley_1.GeoServiceStatus.Pending;
+        default:
+            throw new Error("GeoCoordStatus -> GeoServiceStatus - Missing enum conversion");
+    }
+}
+exports.mapToGeoServiceStatus = mapToGeoServiceStatus;
 //# sourceMappingURL=GeoCoordinateServices.js.map

package/lib/cjs/GeoCoordinateServices.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeoCoordinateServices.js","sourceRoot":"","sources":["../../src/GeoCoordinateServices.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qDAAqD;AAErD,sDAAuD;AAIvD;;;;;GAKG;AACH,IAAY,cA0CX;AA1CD,WAAY,cAAc;IACxB,kDAAkD;IAClD,yDAAW,CAAA;IACX,sIAAsI;IACtI,qEAAkB,CAAA;IAClB;;;;;;;;;;OAUG;IACH,2EAAoB,CAAA;IACpB;;;;OAIG;IACH,yFAA2B,CAAA;IAC3B;;;;OAIG;IACH,4EAAqB,CAAA;IACrB;;;;OAIG;IACH,8FAA8B,CAAA;IAC9B,sGAAsG;IACtG,kEAAiB,CAAA;IACjB;;;OAGG;IACH,8DAAgB,CAAA;AAClB,CAAC,EA1CW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QA0CzB;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,CAAiB;IACrD,QAAQ,CAAC,EAAE;QACT,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,+BAAgB,CAAC,OAAO,CAAC;QAC7D,KAAK,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,+BAAgB,CAAC,aAAa,CAAC;QACxE,KAAK,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,+BAAgB,CAAC,gBAAgB,CAAC;QAC/E,KAAK,cAAc,CAAC,uBAAuB,CAAC,CAAC,OAAO,+BAAgB,CAAC,uBAAuB,CAAC;QAC7F,KAAK,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,+BAAgB,CAAC,gBAAgB,CAAC;QAC/E,KAAK,cAAc,CAAC,yBAAyB,CAAC,CAAC,OAAO,+BAAgB,CAAC,yBAAyB,CAAC;QACjG,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,OAAO,+BAAgB,CAAC,UAAU,CAAC;QACnE,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,+BAAgB,CAAC,OAAO,CAAC;QAC7D;YACE,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;KACnF;AACH,CAAC;AAbD,sDAaC","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\n// cspell:ignore NGVD, NAVD, COMPD_CS, PROJCS, GEOGCS\r\n\r\nimport { GeoServiceStatus } from \"@itwin/core-bentley\";\r\nimport { XYZProps } from \"@itwin/core-geometry\";\r\nimport { GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\r\n\r\n/** This enumeration lists all possible status as returned from a coordinate conversion to or from a\r\n * [[GeographicCRS]] and either another [[GeographicCRS]] or a [[GeodeticDatum]].\r\n * @see the [[PointWithStatus]] included in an [[IModelCoordinatesResponseProps]] or [[GeoCoordinatesResponseProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum GeoCoordStatus {\r\n  /** Indicates successful coordinate conversion. */\r\n  Success = 0,\r\n  /** Indicates that the source or target of the conversion is not defined, usually the iModel Geographic Coordinate Reference System.*/\r\n  NoGCSDefined = 100,\r\n  /** This value indicates that the conversion was performed outside of the normal use of application of either Geographic Coordinate Reference Systems.\r\n   *  This return value can often be treated as a warning in specific cases. For example, global imagery extent spans the whole globe and\r\n   *  may extend far beyond the normal area of the iModel project extents and the extent of normal use of its Geographic Coordinate Reference System.\r\n   *  In such cases this value can be considered a warning as accuracy and precision is not expected in this specific case and approximate localization\r\n   *  of global imagery or other low accuracy context data is not essential far from the project.\r\n   *  If this status is returned for high accuracy data then it indicates that either Geographic Coordinate Reference Systems were inappropriately selected\r\n   *  for the iModel or other geolocated data. If this is the case the status should be somehow reported so action\r\n   *  can be performed to verify used geolocation parameters.\r\n   *  In either case the returned coordinates are to be considered valid though they may be inaccurate or result in some unexpected distortion of graphical\r\n   *  elements.\r\n   */\r\n  OutOfUsefulRange = 1,\r\n  /** Indicates a hard error where conversions were requested outside of the area of the mathematical capacity of the conversion process for either\r\n   *  Geographic Coordinate Reference Systems involved. An example could be to attempt a conversion involving a Transverse Mercator more than 60 degrees\r\n   *  East or West of the projection central meridian.\r\n   *  The values returned may or may not be valid and should be discarded.\r\n   */\r\n  OutOfMathematicalDomain = 2,\r\n  /** Indicates that datum transformation between the two Geographic Coordinate Reference Systems could not be performed.\r\n   *  This error is usually the result of a datum transformation path requiring use of latitude/longitude grid shift files that could not be obtained\r\n   *  or installed. In this case the latitude/longitude transformation is bypassed but the remainder of the conversion process is completed.\r\n   *  This error can be ignored for low accuracy data but should be somehow reported so actions can be performed to provide the missing files.\r\n   */\r\n  NoDatumConverter = 25,\r\n  /** Indicates that a problem occurred during vertical datum conversion. This may the result of the inability to access the\r\n   *  Geoid separation data or vertical datum differential data (such as used by NGVD29 to NAVD88 conversion).\r\n   *  The horizontal coordinates returned are valid but the elevation ordinate will be returned unchanged or partially changed.\r\n   *  This status should be somehow reported so actions can be performed to provide the missing information.\r\n   */\r\n  VerticalDatumConvertError = 26,\r\n  /** General inner conversion engine error. Coordinates returned are invalid and should be discarded */\r\n  CSMapError = 4096,\r\n  /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend\r\n   *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).\r\n   *  At the completion of the conversion promise no coordinates should have this status.\r\n   */\r\n  Pending = -41556,\r\n}\r\n\r\n/** Maps a GeoCoordStatus to the equivalent GeoServiceStatus.\r\n * @public\r\n */\r\nexport function mapToGeoServiceStatus(s: GeoCoordStatus): GeoServiceStatus {\r\n  switch (s) {\r\n    case GeoCoordStatus.Success: return GeoServiceStatus.Success;\r\n    case GeoCoordStatus.NoGCSDefined: return GeoServiceStatus.NoGeoLocation;\r\n    case GeoCoordStatus.OutOfUsefulRange: return GeoServiceStatus.OutOfUsefulRange;\r\n    case GeoCoordStatus.OutOfMathematicalDomain: return GeoServiceStatus.OutOfMathematicalDomain;\r\n    case GeoCoordStatus.NoDatumConverter: return GeoServiceStatus.NoDatumConverter;\r\n    case GeoCoordStatus.VerticalDatumConvertError: return GeoServiceStatus.VerticalDatumConvertError;\r\n    case GeoCoordStatus.CSMapError: return GeoServiceStatus.CSMapError;\r\n    case GeoCoordStatus.Pending: return GeoServiceStatus.Pending;\r\n    default:\r\n      throw new Error(\"GeoCoordStatus -> GeoServiceStatus - Missing enum conversion\");\r\n  }\r\n}\r\n\r\n/** Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates\r\n * @beta\r\n */\r\nexport interface IModelCoordinatesRequestProps {\r\n  source: string;\r\n  geoCoords: XYZProps[];\r\n}\r\n\r\n/** Information returned from a request to convert an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates\r\n * @beta\r\n */\r\nexport interface PointWithStatus {\r\n  p: XYZProps;\r\n  s: GeoCoordStatus;\r\n}\r\n\r\n/** @beta */\r\nexport interface IModelCoordinatesResponseProps {\r\n  iModelCoords: PointWithStatus[];\r\n  fromCache: number;    // the number that were read from the cache rather than calculated.\r\n}\r\n\r\n/** Information required to request conversion of an array of iModel coordinates to Geographic Coordinates (longitude and latitude)\r\n * @beta\r\n */\r\nexport interface GeoCoordinatesRequestProps {\r\n  target: string;\r\n  iModelCoords: XYZProps[];\r\n}\r\n\r\n/** Information returned from a request to convert an array of iModel coordinates to Geographic Coordinates (longitude and latitude)\r\n * @beta\r\n */\r\nexport interface GeoCoordinatesResponseProps {\r\n  geoCoords: PointWithStatus[];\r\n  fromCache: number;    // the number that were read from the cache rather than calculated.\r\n}\r\n\r\n/** Information required to interpret or complete a Geographic CRS in the specified format.\r\n *  The only currently supported formats are JSON (for completion) and WKT (OGC Well Known Text)\r\n * @beta\r\n */\r\nexport interface GeographicCRSInterpretRequestProps {\r\n  /** The format of the geographic CRS definition provided in the geographicCRSDef property. */\r\n  format: \"WKT\" | \"JSON\";\r\n  /** The geographic CRS definition in the format specified in the format property.\r\n   *  Note that when the WKT is used the WKT fragment provided can start with a COMPD_CS clause\r\n   *  which should then contain both the horizontal CRS definition as well as the vertical CRS specification.\r\n   *  WKT fragments starting with PROJCS or GEOGCS are also supported but the vertical CRS will be assigned a\r\n   *  default value.\r\n  */\r\n  geographicCRSDef: string;\r\n}\r\n\r\n/** Information returned from a request to interpret or complete a Geographic CRS\r\n * @beta\r\n */\r\nexport interface GeographicCRSInterpretResponseProps {\r\n  /** The result status of the interpret operation. A value of zero indicates successful interpretation.\r\n   *  Any value other than zero is to be considered a hard error and no valid result will\r\n   *  be returned in the geographicCRS property.\r\n  */\r\n  status: number;\r\n  /** The property that receives the interpreted geographic CRS if the process was successful. */\r\n  geographicCRS?: GeographicCRSProps;\r\n}\r\n"]}
+{"version":3,"file":"GeoCoordinateServices.js","sourceRoot":"","sources":["../../src/GeoCoordinateServices.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qDAAqD;AAErD,sDAAuD;AAIvD;;;;;;GAMG;AACH,IAAY,cA0CX;AA1CD,WAAY,cAAc;IACxB,kDAAkD;IAClD,yDAAW,CAAA;IACX,sIAAsI;IACtI,qEAAkB,CAAA;IAClB;;;;;;;;;;OAUG;IACH,2EAAoB,CAAA;IACpB;;;;OAIG;IACH,yFAA2B,CAAA;IAC3B;;;;OAIG;IACH,4EAAqB,CAAA;IACrB;;;;OAIG;IACH,8FAA8B,CAAA;IAC9B,sGAAsG;IACtG,kEAAiB,CAAA;IACjB;;;OAGG;IACH,8DAAgB,CAAA;AAClB,CAAC,EA1CW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QA0CzB;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,CAAiB;IACrD,QAAQ,CAAC,EAAE;QACT,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,+BAAgB,CAAC,OAAO,CAAC;QAC7D,KAAK,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,+BAAgB,CAAC,aAAa,CAAC;QACxE,KAAK,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,+BAAgB,CAAC,gBAAgB,CAAC;QAC/E,KAAK,cAAc,CAAC,uBAAuB,CAAC,CAAC,OAAO,+BAAgB,CAAC,uBAAuB,CAAC;QAC7F,KAAK,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,+BAAgB,CAAC,gBAAgB,CAAC;QAC/E,KAAK,cAAc,CAAC,yBAAyB,CAAC,CAAC,OAAO,+BAAgB,CAAC,yBAAyB,CAAC;QACjG,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,OAAO,+BAAgB,CAAC,UAAU,CAAC;QACnE,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,+BAAgB,CAAC,OAAO,CAAC;QAC7D;YACE,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;KACnF;AACH,CAAC;AAbD,sDAaC","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\n// cspell:ignore NGVD, NAVD, COMPD_CS, PROJCS, GEOGCS\r\n\r\nimport { GeoServiceStatus } from \"@itwin/core-bentley\";\r\nimport { XYZProps } from \"@itwin/core-geometry\";\r\nimport { GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\r\n\r\n/** This enumeration lists all possible status as returned from a coordinate conversion to or from a\r\n * [[GeographicCRS]] and either another [[GeographicCRS]] or a [[GeodeticDatum]].\r\n * @see [[GeoConverter]] to perform coordinate conversions.\r\n * @see [[PointWithStatus]] for the result of a coordinate conversion, including its status code.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum GeoCoordStatus {\r\n  /** Indicates successful coordinate conversion. */\r\n  Success = 0,\r\n  /** Indicates that the source or target of the conversion is not defined, usually the iModel Geographic Coordinate Reference System.*/\r\n  NoGCSDefined = 100,\r\n  /** This value indicates that the conversion was performed outside of the normal use of application of either Geographic Coordinate Reference Systems.\r\n   *  This return value can often be treated as a warning in specific cases. For example, global imagery extent spans the whole globe and\r\n   *  may extend far beyond the normal area of the iModel project extents and the extent of normal use of its Geographic Coordinate Reference System.\r\n   *  In such cases this value can be considered a warning as accuracy and precision is not expected in this specific case and approximate localization\r\n   *  of global imagery or other low accuracy context data is not essential far from the project.\r\n   *  If this status is returned for high accuracy data then it indicates that either Geographic Coordinate Reference Systems were inappropriately selected\r\n   *  for the iModel or other geolocated data. If this is the case the status should be somehow reported so action\r\n   *  can be performed to verify used geolocation parameters.\r\n   *  In either case the returned coordinates are to be considered valid though they may be inaccurate or result in some unexpected distortion of graphical\r\n   *  elements.\r\n   */\r\n  OutOfUsefulRange = 1,\r\n  /** Indicates a hard error where conversions were requested outside of the area of the mathematical capacity of the conversion process for either\r\n   *  Geographic Coordinate Reference Systems involved. An example could be to attempt a conversion involving a Transverse Mercator more than 60 degrees\r\n   *  East or West of the projection central meridian.\r\n   *  The values returned may or may not be valid and should be discarded.\r\n   */\r\n  OutOfMathematicalDomain = 2,\r\n  /** Indicates that datum transformation between the two Geographic Coordinate Reference Systems could not be performed.\r\n   *  This error is usually the result of a datum transformation path requiring use of latitude/longitude grid shift files that could not be obtained\r\n   *  or installed. In this case the latitude/longitude transformation is bypassed but the remainder of the conversion process is completed.\r\n   *  This error can be ignored for low accuracy data but should be somehow reported so actions can be performed to provide the missing files.\r\n   */\r\n  NoDatumConverter = 25,\r\n  /** Indicates that a problem occurred during vertical datum conversion. This may the result of the inability to access the\r\n   *  Geoid separation data or vertical datum differential data (such as used by NGVD29 to NAVD88 conversion).\r\n   *  The horizontal coordinates returned are valid but the elevation ordinate will be returned unchanged or partially changed.\r\n   *  This status should be somehow reported so actions can be performed to provide the missing information.\r\n   */\r\n  VerticalDatumConvertError = 26,\r\n  /** General inner conversion engine error. Coordinates returned are invalid and should be discarded */\r\n  CSMapError = 4096,\r\n  /** This temporary status is used to mark coordinates for which the conversion has not yet been processed by the backend\r\n   *  as opposed to other coordinate conversions that may have been resolved otherwise (typically a cache).\r\n   *  At the completion of the conversion promise no coordinates should have this status.\r\n   */\r\n  Pending = -41556,\r\n}\r\n\r\n/** Maps a GeoCoordStatus to the equivalent GeoServiceStatus.\r\n * @public\r\n */\r\nexport function mapToGeoServiceStatus(s: GeoCoordStatus): GeoServiceStatus {\r\n  switch (s) {\r\n    case GeoCoordStatus.Success: return GeoServiceStatus.Success;\r\n    case GeoCoordStatus.NoGCSDefined: return GeoServiceStatus.NoGeoLocation;\r\n    case GeoCoordStatus.OutOfUsefulRange: return GeoServiceStatus.OutOfUsefulRange;\r\n    case GeoCoordStatus.OutOfMathematicalDomain: return GeoServiceStatus.OutOfMathematicalDomain;\r\n    case GeoCoordStatus.NoDatumConverter: return GeoServiceStatus.NoDatumConverter;\r\n    case GeoCoordStatus.VerticalDatumConvertError: return GeoServiceStatus.VerticalDatumConvertError;\r\n    case GeoCoordStatus.CSMapError: return GeoServiceStatus.CSMapError;\r\n    case GeoCoordStatus.Pending: return GeoServiceStatus.Pending;\r\n    default:\r\n      throw new Error(\"GeoCoordStatus -> GeoServiceStatus - Missing enum conversion\");\r\n  }\r\n}\r\n\r\n/** Information required to request conversion of an array of Geographic coordinates (Longitude/Latitude) to iModel coordinates\r\n * @beta\r\n */\r\nexport interface IModelCoordinatesRequestProps {\r\n  source: string;\r\n  geoCoords: XYZProps[];\r\n}\r\n\r\n/** A point converted to iModel coordinates to geographic coordinates or vice-versa by a [[GeoConverter]].\r\n * The status [[s]] indicates the converted point [[p]]'s degree of accuracy.\r\n * @public\r\n */\r\nexport interface PointWithStatus {\r\n  /** A JSON representation of the converted point. */\r\n  p: XYZProps;\r\n  /** A status code indicating the degree of accuracy with the point [[p]] was converted. */\r\n  s: GeoCoordStatus;\r\n}\r\n\r\n/** @beta */\r\nexport interface IModelCoordinatesResponseProps {\r\n  iModelCoords: PointWithStatus[];\r\n  fromCache: number;    // the number that were read from the cache rather than calculated.\r\n}\r\n\r\n/** Information required to request conversion of an array of iModel coordinates to Geographic Coordinates (longitude and latitude)\r\n * @beta\r\n */\r\nexport interface GeoCoordinatesRequestProps {\r\n  target: string;\r\n  iModelCoords: XYZProps[];\r\n}\r\n\r\n/** Information returned from a request to convert an array of iModel coordinates to Geographic Coordinates (longitude and latitude)\r\n * @beta\r\n */\r\nexport interface GeoCoordinatesResponseProps {\r\n  geoCoords: PointWithStatus[];\r\n  fromCache: number;    // the number that were read from the cache rather than calculated.\r\n}\r\n\r\n/** Information required to interpret or complete a Geographic CRS in the specified format.\r\n *  The only currently supported formats are JSON (for completion) and WKT (OGC Well Known Text)\r\n * @beta\r\n */\r\nexport interface GeographicCRSInterpretRequestProps {\r\n  /** The format of the geographic CRS definition provided in the geographicCRSDef property. */\r\n  format: \"WKT\" | \"JSON\";\r\n  /** The geographic CRS definition in the format specified in the format property.\r\n   *  Note that when the WKT is used the WKT fragment provided can start with a COMPD_CS clause\r\n   *  which should then contain both the horizontal CRS definition as well as the vertical CRS specification.\r\n   *  WKT fragments starting with PROJCS or GEOGCS are also supported but the vertical CRS will be assigned a\r\n   *  default value.\r\n  */\r\n  geographicCRSDef: string;\r\n}\r\n\r\n/** Information returned from a request to interpret or complete a Geographic CRS\r\n * @beta\r\n */\r\nexport interface GeographicCRSInterpretResponseProps {\r\n  /** The result status of the interpret operation. A value of zero indicates successful interpretation.\r\n   *  Any value other than zero is to be considered a hard error and no valid result will\r\n   *  be returned in the geographicCRS property.\r\n  */\r\n  status: number;\r\n  /** The property that receives the interpreted geographic CRS if the process was successful. */\r\n  geographicCRS?: GeographicCRSProps;\r\n}\r\n"]}

package/lib/cjs/GeometryContainment.d.ts

@@ -1,29 +1,29 @@
-/** @packageDocumentation
- * @module Geometry
- */
-import { BentleyStatus, Id64Array } from "@itwin/core-bentley";
-import { ViewFlagProps } from "./ViewFlags";
-import { ClipPlaneContainment, ClipVectorProps } from "@itwin/core-geometry";
-/** Information required to request clip containment status for elements from the front end to the back end.
- * @public
- * @extensions
- */
-export interface GeometryContainmentRequestProps {
-    candidates: Id64Array;
-    clip: ClipVectorProps;
-    allowOverlaps?: boolean;
-    viewFlags?: ViewFlagProps;
-    offSubCategories?: Id64Array;
-}
-/** Information returned from the back end to the front end holding the result of the geometry containment query.
- * @public
- * @extensions
- */
-export interface GeometryContainmentResponseProps {
-    status: BentleyStatus;
-    candidatesContainment?: ClipPlaneContainment[];
-    numInside?: number;
-    numOutside?: number;
-    numOverlap?: number;
-}
+/** @packageDocumentation
+ * @module Geometry
+ */
+import { BentleyStatus, Id64Array } from "@itwin/core-bentley";
+import { ViewFlagProps } from "./ViewFlags";
+import { ClipPlaneContainment, ClipVectorProps } from "@itwin/core-geometry";
+/** Information required to request clip containment status for elements from the front end to the back end.
+ * @public
+ * @extensions
+ */
+export interface GeometryContainmentRequestProps {
+    candidates: Id64Array;
+    clip: ClipVectorProps;
+    allowOverlaps?: boolean;
+    viewFlags?: ViewFlagProps;
+    offSubCategories?: Id64Array;
+}
+/** Information returned from the back end to the front end holding the result of the geometry containment query.
+ * @public
+ * @extensions
+ */
+export interface GeometryContainmentResponseProps {
+    status: BentleyStatus;
+    candidatesContainment?: ClipPlaneContainment[];
+    numInside?: number;
+    numOutside?: number;
+    numOverlap?: number;
+}
 //# sourceMappingURL=GeometryContainment.d.ts.map

package/lib/cjs/GeometryContainment.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Geometry
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Geometry
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=GeometryContainment.js.map