@itwin/core-common 3.0.0-dev.140 → 3.0.0-dev.145

package/lib/cjs/ContextRealityModel.d.ts

@@ -16,7 +16,7 @@ export interface OrbitGtBlobProps {
     accountName: string;
 }
 /** Identify the Reality Data service provider
- * @alpha
+ * @beta
  */
 export declare enum RealityDataProvider {
     /**
@@ -30,7 +30,7 @@ export declare enum RealityDataProvider {
      * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.OrbitGtBlob property.
      * It was use to support OrbitPointCloud (OPC) from other server than ContextShare
      * You should use other mode when possible
-     * @see [[RealityDataSource.createRealityDataSourceKeyFromUrl]] that will try to detect provider from an URL
+     * @see [[RealityDataSource.createKeyFromOrbitGtBlobProps]] that will try to detect provider from an URL
      */
     OrbitGtBlob = "OrbitGtBlob",
     /**
@@ -45,7 +45,7 @@ export declare enum RealityDataProvider {
     CesiumIonAsset = "CesiumIonAsset"
 }
 /** Identify the Reality Data storage format
- * @alpha
+ * @beta
  */
 export declare enum RealityDataFormat {
     /**
@@ -57,10 +57,21 @@ export declare enum RealityDataFormat {
     */
     OPC = "OPC"
 }
+/** Utility function for RealityDataFormat
+ * @beta
+ */
+export declare namespace RealityDataFormat {
+    /**
+     * Try to extract the RealityDataFormat from the url
+     * @param tilesetUrl the reality data attachment url
+     * @returns the extracted RealityDataFormat or ThreeDTile by default if not found
+     */
+    function fromUrl(tilesetUrl: string): RealityDataFormat;
+}
 /**
  * Key used by RealityDataSource to identify provider and reality data format
  * This key identify one and only one reality data source on the provider
- * @alpha
+ * @beta
  */
 export interface RealityDataSourceKey {
     /**
@@ -78,9 +89,18 @@ export interface RealityDataSourceKey {
     /** The context id that was used when reality data was attached - if none provided, current session iTwinId will be used */
     iTwinId?: string;
 }
+/**
+ * RealityDataSourceKey utility functions
+ * @beta */
+export declare namespace RealityDataSourceKey {
+    /** Utility function to convert a RealityDataSourceKey into its string representation */
+    function toString(rdSourceKey: RealityDataSourceKey): string;
+    /** Utility function to compare two RealityDataSourceKey, we consider it equal even if itwinId is different */
+    function isEqual(key1: RealityDataSourceKey, key2: RealityDataSourceKey): boolean;
+}
 /** JSON representation of the reality data reference attachment properties.
- * @alpha
- */
+ * @beta
+*/
 export interface RealityDataSourceProps {
     /** The source key that identify a reality data for the provider. */
     sourceKey: RealityDataSourceKey;
@@ -89,10 +109,8 @@ export interface RealityDataSourceProps {
  * @public
  */
 export interface ContextRealityModelProps {
-    /**
-     * The reality data source key identify the reality data provider and storage format.
-     * It takes precedence over tilesetUrl and orbitGtBlob when present and can be use to actually replace these properties.
-     * @alpha
+    /** @see [[ContextRealityModel.rdSourceKey]].
+     * @beta
      */
     rdSourceKey?: RealityDataSourceKey;
     /** The URL that supplies the 3d tiles for displaying the reality model. */
@@ -126,10 +144,12 @@ export declare namespace ContextRealityModelProps {
  * @public
  */
 export declare class ContextRealityModel {
+    /** @internal */
     protected readonly _props: ContextRealityModelProps;
     /**
      * The reality data source key identify the reality data provider and storage format.
-     * @alpha
+     * It takes precedence over tilesetUrl and orbitGtBlob when present and can be use to actually replace these properties.
+     * @beta
      */
     readonly rdSourceKey?: RealityDataSourceKey;
     /** A name suitable for display in a user interface. By default, an empty string. */

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

@@ -1 +1 @@
-{"version":3,"file":"ContextRealityModel.d.ts","sourceRoot":"","sources":["../../src/ContextRealityModel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC/E,OAAO,EAAsB,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AACnG,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,oBAAY,mBAAmB;IAC7B;;;;;OAKG;IACH,UAAU,eAAe;IACzB;;;;;OAKG;IACH,WAAW,gBAAgB;IAC3B;;;;OAIG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B;;SAEK;IACL,UAAU,eAAe;IACzB;;MAEE;IACF,GAAG,QAAQ;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;MAGE;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB;;;MAGE;IACF,MAAM,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,EAAE,EAAE,MAAM,CAAC;IACX,2HAA2H;IAC3H,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,oEAAoE;IACpE,SAAS,EAAE,oBAAoB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,2EAA2E;IAC3E,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sGAAsG;IACtG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4GAA4G;IAC5G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,WAAW,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACvC,mDAAmD;IACnD,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC,wDAAwD;IACxD,mBAAmB,CAAC,EAAE,sBAAsB,CAAC;CAC9C;AAED,cAAc;AACd,yBAAiB,wBAAwB,CAAC;IACxC,sCAAsC;IACtC,SAAgB,KAAK,CAAC,KAAK,EAAE,wBAAwB,4BAiCpD;CACF;AAED;;;;;GAKG;AACH,qBAAa,mBAAmB;IAC9B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAC;IACpD;;;OAGG;IACH,SAAiB,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACpD,oFAAoF;IACpF,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,2EAA2E;IAC3E,SAAgB,GAAG,EAAE,MAAM,CAAC;IAC5B,wGAAwG;IACxG,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,2GAA2G;IAC3G,SAAgB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvC,iHAAiH;IACjH,SAAgB,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjD,aAAa;IACb,SAAgB,WAAW,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IACzD,SAAS,CAAC,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;IACnD,SAAS,CAAC,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACnD,6EAA6E;IAC7E,SAAgB,uBAAuB,wBAA6B,sBAAsB,GAAG,SAAS,SAAS,mBAAmB,KAAK,IAAI,EAAI;IAC/I,0EAA0E;IAC1E,SAAgB,4BAA4B,yBAA8B,iBAAiB,GAAG,SAAS,SAAS,mBAAmB,KAAK,IAAI,EAAI;IAEhJ;;OAEG;gBACgB,KAAK,EAAE,wBAAwB;IAgBlD,gGAAgG;IAChG,IAAW,sBAAsB,IAAI,sBAAsB,GAAG,SAAS,CAEtE;IACD,IAAW,sBAAsB,CAAC,QAAQ,EAAE,sBAAsB,GAAG,SAAS,EAQ7E;IAED,2KAA2K;IAC3K,IAAW,mBAAmB,IAAI,iBAAiB,GAAG,SAAS,CAE9D;IACD,IAAW,mBAAmB,CAAC,SAAS,EAAE,iBAAiB,GAAG,SAAS,EAQtE;IAED,qDAAqD;IAC9C,MAAM,IAAI,wBAAwB;IAIzC,6EAA6E;IACtE,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;CAG7D;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,kCAAkC;IAClC,oBAAoB,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACnD;AAED;;;;;GAKG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgC;IAC3D,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA2D;IACxF,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6B;IACrD,6HAA6H;IAC7H,SAAgB,uBAAuB,kBAAuB,mBAAmB,eAAe,sBAAsB,GAAG,SAAS,KAAK,IAAI,EAAI;IAC/I,0HAA0H;IAC1H,SAAgB,4BAA4B,kBAAuB,mBAAmB,gBAAgB,iBAAiB,GAAG,SAAS,KAAK,IAAI,EAAI;IAChJ,6FAA6F;IAC7F,SAAgB,SAAS,0BAA+B,mBAAmB,GAAG,SAAS,YAAY,mBAAmB,GAAG,SAAS,KAAK,IAAI,EAAI;IAE/I;;;;;OAKG;gBACgB,SAAS,EAAE,6BAA6B,EAAE,yBAAyB,CAAC,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,mBAAmB;IAUjJ,4CAA4C;IAC5C,IAAW,MAAM,IAAI,aAAa,CAAC,mBAAmB,CAAC,CAEtD;IAED;;;OAGG;IACI,GAAG,CAAC,KAAK,EAAE,wBAAwB,GAAG,mBAAmB;IAehE;;;OAGG;IACI,MAAM,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAoBlD,+CAA+C;IACxC,KAAK,IAAI,IAAI;IAUpB;;;;;;OAMG;IACI,OAAO,CAAC,SAAS,EAAE,mBAAmB,EAAE,WAAW,EAAE,wBAAwB,GAAG,mBAAmB;IAoB1G;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,EAAE,mBAAmB,EAAE,WAAW,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,mBAAmB;IAajH,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,2BAA2B;IAInC,OAAO,CAAC,gCAAgC;CAGzC"}
+{"version":3,"file":"ContextRealityModel.d.ts","sourceRoot":"","sources":["../../src/ContextRealityModel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC/E,OAAO,EAAsB,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AACnG,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,oBAAY,mBAAmB;IAC7B;;;;;OAKG;IACH,UAAU,eAAe;IACzB;;;;;OAKG;IACH,WAAW,gBAAgB;IAC3B;;;;OAIG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B;;SAEK;IACL,UAAU,eAAe;IACzB;;MAEE;IACF,GAAG,QAAQ;CACZ;AAED;;GAEG;AACH,yBAAiB,iBAAiB,CAAE;IAClC;;;;OAIG;IACH,SAAgB,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,iBAAiB,CAK7D;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;MAGE;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB;;;MAGE;IACF,MAAM,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,EAAE,EAAE,MAAM,CAAC;IACX,2HAA2H;IAC3H,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AACD;;WAEW;AACX,yBAAiB,oBAAoB,CAAC;IACpC,wFAAwF;IACxF,SAAgB,QAAQ,CAAC,WAAW,EAAE,oBAAoB,GAAG,MAAM,CAElE;IACD,8GAA8G;IAC9G,SAAgB,OAAO,CAAC,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAQvF;CACF;AAED;;EAEE;AACF,MAAM,WAAW,sBAAsB;IACrC,oEAAoE;IACpE,SAAS,EAAE,oBAAoB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,2EAA2E;IAC3E,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sGAAsG;IACtG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4GAA4G;IAC5G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,WAAW,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACvC,mDAAmD;IACnD,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC,wDAAwD;IACxD,mBAAmB,CAAC,EAAE,sBAAsB,CAAC;CAC9C;AAED,cAAc;AACd,yBAAiB,wBAAwB,CAAC;IACxC,sCAAsC;IACtC,SAAgB,KAAK,CAAC,KAAK,EAAE,wBAAwB,4BAiCpD;CACF;AAED;;;;;GAKG;AACH,qBAAa,mBAAmB;IAC9B,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAC;IACpD;;;;OAIG;IACH,SAAiB,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACpD,oFAAoF;IACpF,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,2EAA2E;IAC3E,SAAgB,GAAG,EAAE,MAAM,CAAC;IAC5B,wGAAwG;IACxG,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,2GAA2G;IAC3G,SAAgB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvC,iHAAiH;IACjH,SAAgB,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjD,aAAa;IACb,SAAgB,WAAW,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IACzD,SAAS,CAAC,oBAAoB,CAAC,EAAE,iBAAiB,CAAC;IACnD,SAAS,CAAC,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACnD,6EAA6E;IAC7E,SAAgB,uBAAuB,wBAA6B,sBAAsB,GAAG,SAAS,SAAS,mBAAmB,KAAK,IAAI,EAAI;IAC/I,0EAA0E;IAC1E,SAAgB,4BAA4B,yBAA8B,iBAAiB,GAAG,SAAS,SAAS,mBAAmB,KAAK,IAAI,EAAI;IAEhJ;;OAEG;gBACgB,KAAK,EAAE,wBAAwB;IAgBlD,gGAAgG;IAChG,IAAW,sBAAsB,IAAI,sBAAsB,GAAG,SAAS,CAEtE;IACD,IAAW,sBAAsB,CAAC,QAAQ,EAAE,sBAAsB,GAAG,SAAS,EAQ7E;IAED,2KAA2K;IAC3K,IAAW,mBAAmB,IAAI,iBAAiB,GAAG,SAAS,CAE9D;IACD,IAAW,mBAAmB,CAAC,SAAS,EAAE,iBAAiB,GAAG,SAAS,EAQtE;IAED,qDAAqD;IAC9C,MAAM,IAAI,wBAAwB;IAIzC,6EAA6E;IACtE,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;CAG7D;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,kCAAkC;IAClC,oBAAoB,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACnD;AAED;;;;;GAKG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgC;IAC3D,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA2D;IACxF,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6B;IACrD,6HAA6H;IAC7H,SAAgB,uBAAuB,kBAAuB,mBAAmB,eAAe,sBAAsB,GAAG,SAAS,KAAK,IAAI,EAAI;IAC/I,0HAA0H;IAC1H,SAAgB,4BAA4B,kBAAuB,mBAAmB,gBAAgB,iBAAiB,GAAG,SAAS,KAAK,IAAI,EAAI;IAChJ,6FAA6F;IAC7F,SAAgB,SAAS,0BAA+B,mBAAmB,GAAG,SAAS,YAAY,mBAAmB,GAAG,SAAS,KAAK,IAAI,EAAI;IAE/I;;;;;OAKG;gBACgB,SAAS,EAAE,6BAA6B,EAAE,yBAAyB,CAAC,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,mBAAmB;IAUjJ,4CAA4C;IAC5C,IAAW,MAAM,IAAI,aAAa,CAAC,mBAAmB,CAAC,CAEtD;IAED;;;OAGG;IACI,GAAG,CAAC,KAAK,EAAE,wBAAwB,GAAG,mBAAmB;IAehE;;;OAGG;IACI,MAAM,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAoBlD,+CAA+C;IACxC,KAAK,IAAI,IAAI;IAUpB;;;;;;OAMG;IACI,OAAO,CAAC,SAAS,EAAE,mBAAmB,EAAE,WAAW,EAAE,wBAAwB,GAAG,mBAAmB;IAoB1G;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,EAAE,mBAAmB,EAAE,WAAW,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,mBAAmB;IAajH,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,2BAA2B;IAInC,OAAO,CAAC,gCAAgC;CAGzC"}

package/lib/cjs/ContextRealityModel.js

@@ -7,13 +7,13 @@
  * @module DisplayStyles
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContextRealityModels = exports.ContextRealityModel = exports.ContextRealityModelProps = exports.RealityDataFormat = exports.RealityDataProvider = void 0;
+exports.ContextRealityModels = exports.ContextRealityModel = exports.ContextRealityModelProps = exports.RealityDataSourceKey = exports.RealityDataFormat = exports.RealityDataProvider = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const FeatureSymbology_1 = require("./FeatureSymbology");
 const PlanarClipMask_1 = require("./PlanarClipMask");
 const SpatialClassification_1 = require("./SpatialClassification");
 /** Identify the Reality Data service provider
- * @alpha
+ * @beta
  */
 var RealityDataProvider;
 (function (RealityDataProvider) {
@@ -28,7 +28,7 @@ var RealityDataProvider;
      * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.OrbitGtBlob property.
      * It was use to support OrbitPointCloud (OPC) from other server than ContextShare
      * You should use other mode when possible
-     * @see [[RealityDataSource.createRealityDataSourceKeyFromUrl]] that will try to detect provider from an URL
+     * @see [[RealityDataSource.createKeyFromOrbitGtBlobProps]] that will try to detect provider from an URL
      */
     RealityDataProvider["OrbitGtBlob"] = "OrbitGtBlob";
     /**
@@ -43,7 +43,7 @@ var RealityDataProvider;
     RealityDataProvider["CesiumIonAsset"] = "CesiumIonAsset";
 })(RealityDataProvider = exports.RealityDataProvider || (exports.RealityDataProvider = {}));
 /** Identify the Reality Data storage format
- * @alpha
+ * @beta
  */
 var RealityDataFormat;
 (function (RealityDataFormat) {
@@ -56,6 +56,45 @@ var RealityDataFormat;
     */
     RealityDataFormat["OPC"] = "OPC";
 })(RealityDataFormat = exports.RealityDataFormat || (exports.RealityDataFormat = {}));
+/** Utility function for RealityDataFormat
+ * @beta
+ */
+(function (RealityDataFormat) {
+    /**
+     * Try to extract the RealityDataFormat from the url
+     * @param tilesetUrl the reality data attachment url
+     * @returns the extracted RealityDataFormat or ThreeDTile by default if not found
+     */
+    function fromUrl(tilesetUrl) {
+        let format = RealityDataFormat.ThreeDTile;
+        if (tilesetUrl.includes(".opc"))
+            format = RealityDataFormat.OPC;
+        return format;
+    }
+    RealityDataFormat.fromUrl = fromUrl;
+})(RealityDataFormat = exports.RealityDataFormat || (exports.RealityDataFormat = {}));
+/**
+ * RealityDataSourceKey utility functions
+ * @beta */
+var RealityDataSourceKey;
+(function (RealityDataSourceKey) {
+    /** Utility function to convert a RealityDataSourceKey into its string representation */
+    function toString(rdSourceKey) {
+        return `${rdSourceKey.provider}:${rdSourceKey.format}:${rdSourceKey.id}:${rdSourceKey === null || rdSourceKey === void 0 ? void 0 : rdSourceKey.iTwinId}`;
+    }
+    RealityDataSourceKey.toString = toString;
+    /** Utility function to compare two RealityDataSourceKey, we consider it equal even if itwinId is different */
+    function isEqual(key1, key2) {
+        if ((key1.provider === RealityDataProvider.CesiumIonAsset) && key2.provider === RealityDataProvider.CesiumIonAsset)
+            return true; // ignore other properties for CesiumIonAsset, id is hidden
+        if ((key1.provider === key2.provider) && (key1.format === key2.format) && (key1.id === key2.id)) {
+            // && (key1?.iTwinId === key2?.iTwinId)) -> ignore iTwinId, consider it is the same reality data
+            return true;
+        }
+        return false;
+    }
+    RealityDataSourceKey.isEqual = isEqual;
+})(RealityDataSourceKey = exports.RealityDataSourceKey || (exports.RealityDataSourceKey = {}));
 /** @public */
 var ContextRealityModelProps;
 (function (ContextRealityModelProps) {

package/lib/cjs/ContextRealityModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContextRealityModel.js","sourceRoot":"","sources":["../../src/ContextRealityModel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAsD;AACtD,yDAA+E;AAC/E,qDAAmG;AACnG,mEAAqF;AAarF;;GAEG;AACH,IAAY,mBAyBX;AAzBD,WAAY,mBAAmB;IAC7B;;;;;OAKG;IACH,gDAAyB,CAAA;IACzB;;;;;OAKG;IACH,kDAA2B,CAAA;IAC3B;;;;OAIG;IACH,oDAA6B,CAAA;IAC7B;;OAEG;IACH,wDAAiC,CAAA;AACnC,CAAC,EAzBW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAyB9B;AAED;;GAEG;AACH,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B;;SAEK;IACL,8CAAyB,CAAA;IACzB;;MAEE;IACF,gCAAW,CAAA;AACb,CAAC,EATW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAS5B;AA8DD,cAAc;AACd,IAAiB,wBAAwB,CAoCxC;AApCD,WAAiB,wBAAwB;IACvC,sCAAsC;IACtC,SAAgB,KAAK,CAAC,KAA+B;;QACnD,qFAAqF;QACrF,kHAAkH;QAClH,MAAM,MAAM,GAA6B,EAAE,UAAU,EAAE,MAAA,KAAK,CAAC,UAAU,mCAAI,EAAE,EAAE,CAAC;QAEhF,IAAI,KAAK,CAAC,WAAW;YACnB,MAAM,CAAC,WAAW,GAAG,EAAE,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAEhD,IAAI,KAAK,CAAC,IAAI;YACZ,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAE3B,IAAI,KAAK,CAAC,aAAa;YACrB,MAAM,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAE7C,IAAI,KAAK,CAAC,WAAW;YACnB,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAEzC,IAAI,KAAK,CAAC,WAAW;YACnB,MAAM,CAAC,WAAW,GAAG,EAAE,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAEhD,IAAI,KAAK,CAAC,mBAAmB,EAAE;YAC7B,MAAM,CAAC,mBAAmB,GAAG,EAAE,GAAG,KAAK,CAAC,mBAAmB,EAAE,CAAC;YAC9D,IAAI,KAAK,CAAC,mBAAmB,CAAC,GAAG;gBAC/B,MAAM,CAAC,mBAAmB,CAAC,GAAG,GAAG,EAAE,GAAG,KAAK,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC;SACzE;QAED,IAAI,KAAK,CAAC,cAAc;YACtB,MAAM,CAAC,cAAc,GAAG,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;QAEtD,IAAI,KAAK,CAAC,WAAW;YACnB,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjG,OAAO,MAAM,CAAC;IAChB,CAAC;IAjCe,8BAAK,QAiCpB,CAAA;AACH,CAAC,EApCgB,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAoCxC;AAED;;;;;GAKG;AACH,MAAa,mBAAmB;IA0B9B;;OAEG;IACH,YAAmB,KAA+B;;QARlD,6EAA6E;QAC7D,4BAAuB,GAAG,IAAI,sBAAO,EAAyF,CAAC;QAC/I,0EAA0E;QAC1D,iCAA4B,GAAG,IAAI,sBAAO,EAAqF,CAAC;QAM9I,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,MAAA,KAAK,CAAC,IAAI,mCAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,MAAA,KAAK,CAAC,UAAU,mCAAI,EAAE,CAAC;QAClC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,MAAA,KAAK,CAAC,WAAW,mCAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,oCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1H,IAAI,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,KAAK,mCAAkB,CAAC,IAAI;YAC/E,IAAI,CAAC,eAAe,GAAG,uCAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAE/E,IAAI,KAAK,CAAC,WAAW;YACnB,IAAI,CAAC,WAAW,GAAG,IAAI,0CAAkB,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,gGAAgG;IAChG,IAAW,sBAAsB;QAC/B,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IACD,IAAW,sBAAsB,CAAC,QAA4C;QAC5E,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ;YACX,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;;YAElC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;QAEjD,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC;IAClC,CAAC;IAED,2KAA2K;IAC3K,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IACD,IAAW,mBAAmB,CAAC,SAAwC;QACrE,IAAI,CAAC,4BAA4B,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS;YACZ,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC;;YAEvC,IAAI,CAAC,MAAM,CAAC,mBAAmB,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QAEvD,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC;IACxC,CAAC;IAED,qDAAqD;IAC9C,MAAM;QACX,OAAO,wBAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,6EAA6E;IACtE,iBAAiB,CAAC,IAAY,EAAE,GAAW;QAChD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC;IAChD,CAAC;CACF;AAlFD,kDAkFC;AAYD;;;;;GAKG;AACH,MAAa,oBAAoB;IAW/B;;;;;OAKG;IACH,YAAmB,SAAwC,EAAE,yBAAoF;QAdhI,YAAO,GAA0B,EAAE,CAAC;QACrD,6HAA6H;QAC7G,4BAAuB,GAAG,IAAI,sBAAO,EAAyF,CAAC;QAC/I,0HAA0H;QAC1G,iCAA4B,GAAG,IAAI,sBAAO,EAAqF,CAAC;QAChJ,6FAA6F;QAC7E,cAAS,GAAG,IAAI,sBAAO,EAAuG,CAAC;QAS7I,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,yBAAyB,aAAzB,yBAAyB,cAAzB,yBAAyB,GAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;QAE7F,MAAM,MAAM,GAAG,SAAS,CAAC,oBAAoB,CAAC;QAC9C,IAAI,MAAM;YACR,KAAK,MAAM,KAAK,IAAI,MAAM;gBACxB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,GAAG,CAAC,KAA+B;QACxC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,oBAAoB;YACvC,IAAI,CAAC,UAAU,CAAC,oBAAoB,GAAG,EAAE,CAAC;QAE5C,KAAK,GAAG,wBAAwB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAEtC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAE5C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEjD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAA0B;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,CAAC,KAAK,KAAK;YACd,OAAO,KAAK,CAAC;QAEf,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QAC3D,IAAA,qBAAM,EAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE5D,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAE5C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;YAC1B,IAAI,CAAC,UAAU,CAAC,oBAAoB,GAAG,SAAS,CAAC;;YAEjD,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAExD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+CAA+C;IACxC,KAAK;QACV,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YAC/B,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;SAC7C;QAED,IAAI,CAAC,UAAU,CAAC,oBAAoB,GAAG,SAAS,CAAC;QACjD,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,SAA8B,EAAE,WAAqC;QAClF,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC,CAAC,KAAK,KAAK;YACd,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAE9D,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QAC3D,IAAA,qBAAM,EAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE5D,WAAW,GAAG,wBAAwB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAE5C,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAEnC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;QAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC;QAE1D,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAA6B,EAAE,WAA8C;QACzF,MAAM,KAAK,GAAG;YACZ,GAAG,QAAQ,CAAC,MAAM,EAAE;YACpB,GAAG,WAAW;SACf,CAAC;QAEF,uGAAuG;QACvG,IAAI,SAAS,KAAK,KAAK,CAAC,UAAU;YAChC,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC;QAElC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAEO,WAAW,CAAC,KAA+B;QACjD,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACvC,6DAA6D;QAC7D,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,IAAI,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;QAClF,6DAA6D;QAC7D,KAAK,CAAC,4BAA4B,CAAC,WAAW,CAAC,IAAI,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;QAC5F,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,kBAAkB,CAAC,KAA0B;QACnD,6DAA6D;QAC7D,KAAK,CAAC,uBAAuB,CAAC,cAAc,CAAC,IAAI,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;QACrF,6DAA6D;QAC7D,KAAK,CAAC,4BAA4B,CAAC,cAAc,CAAC,IAAI,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;IACjG,CAAC;IAEO,2BAA2B,CAAC,IAAwC,EAAE,KAA0B;QACtG,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAEO,gCAAgC,CAAC,GAAkC,EAAE,KAA0B;QACrG,IAAI,CAAC,4BAA4B,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;CACF;AA3JD,oDA2JC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { assert, BeEvent } from \"@itwin/core-bentley\";\r\nimport { FeatureAppearance, FeatureAppearanceProps } from \"./FeatureSymbology\";\r\nimport { PlanarClipMaskMode, PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\r\nimport { SpatialClassifierProps, SpatialClassifiers } from \"./SpatialClassification\";\r\n\r\n/** JSON representation of the blob properties for an OrbitGt property cloud.\r\n * @alpha\r\n */\r\nexport interface OrbitGtBlobProps {\r\n  rdsUrl?: string;\r\n  containerName: string;\r\n  blobFileName: string;\r\n  sasToken: string;\r\n  accountName: string;\r\n}\r\n\r\n/** Identify the Reality Data service provider\r\n * @alpha\r\n */\r\nexport enum RealityDataProvider {\r\n  /**\r\n   * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.tilesetUrl property.\r\n   * It was use to support RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles\r\n   * You should use other mode when possible\r\n   * @see [[RealityDataSource.createKeyFromUrl]] that will try to detect provider from an URL\r\n   */\r\n  TilesetUrl = \"TilesetUrl\",\r\n  /**\r\n   * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.OrbitGtBlob property.\r\n   * It was use to support OrbitPointCloud (OPC) from other server than ContextShare\r\n   * You should use other mode when possible\r\n   * @see [[RealityDataSource.createRealityDataSourceKeyFromUrl]] that will try to detect provider from an URL\r\n   */\r\n  OrbitGtBlob = \"OrbitGtBlob\",\r\n  /**\r\n   * Will provide access url from realityDataId and iTwinId on contextShare for 3dTile storage format or  OPC storage format\r\n   * This provider support all type of 3dTile storage fomat and OrbitPointCloud: RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles, OPC\r\n   * @see [[RealityDataFormat]].\r\n   */\r\n  ContextShare = \"ContextShare\",\r\n  /**\r\n   * Will provide Open Street Map Building (OSM) from Cesium Ion (in 3dTile format)\r\n   */\r\n  CesiumIonAsset = \"CesiumIonAsset\",\r\n}\r\n\r\n/** Identify the Reality Data storage format\r\n * @alpha\r\n */\r\nexport enum RealityDataFormat {\r\n  /**\r\n   * 3dTile supported formats; RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles\r\n   * */\r\n  ThreeDTile = \"ThreeDTile\",\r\n  /**\r\n   * Orbit Point Cloud (OPC) storage format (RealityDataType.OPC)\r\n  */\r\n  OPC = \"OPC\",\r\n}\r\n\r\n/**\r\n * Key used by RealityDataSource to identify provider and reality data format\r\n * This key identify one and only one reality data source on the provider\r\n * @alpha\r\n */\r\nexport interface RealityDataSourceKey {\r\n  /**\r\n   * The provider that supplies the access to reality data source for displaying the reality model\r\n   * @see [[RealityDataProvider]] for default supported value;\r\n  */\r\n  provider: string;\r\n  /**\r\n   * The format used by the provider to store the reality data\r\n   * @see [[RealityDataFormat]] for default supported value;\r\n  */\r\n  format: string;\r\n  /** The reality data id that identify a reality data for the provider */\r\n  id: string;\r\n  /** The context id that was used when reality data was attached - if none provided, current session iTwinId will be used */\r\n  iTwinId?: string;\r\n}\r\n\r\n/** JSON representation of the reality data reference attachment properties.\r\n * @alpha\r\n */\r\nexport interface RealityDataSourceProps {\r\n  /** The source key that identify a reality data for the provider. */\r\n  sourceKey: RealityDataSourceKey;\r\n}\r\n\r\n/** JSON representation of a [[ContextRealityModel]].\r\n * @public\r\n */\r\nexport interface ContextRealityModelProps {\r\n  /**\r\n   * The reality data source key identify the reality data provider and storage format.\r\n   * It takes precedence over tilesetUrl and orbitGtBlob when present and can be use to actually replace these properties.\r\n   * @alpha\r\n   */\r\n  rdSourceKey?: RealityDataSourceKey;\r\n  /** The URL that supplies the 3d tiles for displaying the reality model. */\r\n  tilesetUrl: string;\r\n  /** @see [[ContextRealityModel.orbitGtBlob]].\r\n   * @alpha\r\n   */\r\n  orbitGtBlob?: OrbitGtBlobProps;\r\n  /** @see [[ContextRealityModel.realityDataId]]. */\r\n  realityDataId?: string;\r\n  /** An optional, user-friendly name for the reality model suitable for display in a user interface. */\r\n  name?: string;\r\n  /** An optional, user-friendly description of the reality model suitable for display in a user interface. */\r\n  description?: string;\r\n  /** @see [[ContextRealityModel.classifiers]]. */\r\n  classifiers?: SpatialClassifierProps[];\r\n  /** @see [[ContextRealityModel.planarClipMask]]. */\r\n  planarClipMask?: PlanarClipMaskProps;\r\n  /** @see [[ContextRealityModel.appearanceOverrides]]. */\r\n  appearanceOverrides?: FeatureAppearanceProps;\r\n}\r\n\r\n/** @public */\r\nexport namespace ContextRealityModelProps {\r\n  /** Produce a deep copy of `input`. */\r\n  export function clone(input: ContextRealityModelProps) {\r\n    // Spread operator is shallow, and includes `undefined` properties and empty strings.\r\n    // We want to make deep copies, omit undefined properties and empty strings, and require tilesetUrl to be defined.\r\n    const output: ContextRealityModelProps = { tilesetUrl: input.tilesetUrl ?? \"\" };\r\n\r\n    if (input.rdSourceKey)\r\n      output.rdSourceKey = { ...input.rdSourceKey };\r\n\r\n    if (input.name)\r\n      output.name = input.name;\r\n\r\n    if (input.realityDataId)\r\n      output.realityDataId = input.realityDataId;\r\n\r\n    if (input.description)\r\n      output.description = input.description;\r\n\r\n    if (input.orbitGtBlob)\r\n      output.orbitGtBlob = { ...input.orbitGtBlob };\r\n\r\n    if (input.appearanceOverrides) {\r\n      output.appearanceOverrides = { ...input.appearanceOverrides };\r\n      if (input.appearanceOverrides.rgb)\r\n        output.appearanceOverrides.rgb = { ...input.appearanceOverrides.rgb };\r\n    }\r\n\r\n    if (input.planarClipMask)\r\n      output.planarClipMask = { ...input.planarClipMask };\r\n\r\n    if (input.classifiers)\r\n      output.classifiers = input.classifiers.map((x) => { return { ...x, flags: { ...x.flags } }; });\r\n\r\n    return output;\r\n  }\r\n}\r\n\r\n/** A reality model not associated with a [GeometricModel]($backend) but instead defined in a [DisplayStyle]($backend) or [DisplayStyleState]($frontend).\r\n * Such reality models are displayed to provide context to the view and can be freely attached and detached at display time.\r\n * @see [this interactive example](https://www.itwinjs.org/sample-showcase/?group=Viewer&sample=reality-data-sample)\r\n * @see [[DisplayStyleSettings.contextRealityModels]] to define context reality models for a display style.\r\n * @public\r\n */\r\nexport class ContextRealityModel {\r\n  protected readonly _props: ContextRealityModelProps;\r\n  /**\r\n   * The reality data source key identify the reality data provider and storage format.\r\n   * @alpha\r\n   */\r\n  public readonly  rdSourceKey?: RealityDataSourceKey;\r\n  /** A name suitable for display in a user interface. By default, an empty string. */\r\n  public readonly name: string;\r\n  /** The URL that supplies the 3d tiles for displaying the reality model. */\r\n  public readonly url: string;\r\n  /** A description of the model suitable for display in a user interface. By default, an empty string. */\r\n  public readonly description: string;\r\n  /** An optional identifier that, if present, can be used to elide a request to the reality data service. */\r\n  public readonly realityDataId?: string;\r\n  /** A set of [[SpatialClassifier]]s, of which one at any given time can be used to classify the reality model. */\r\n  public readonly classifiers?: SpatialClassifiers;\r\n  /** @alpha */\r\n  public readonly orbitGtBlob?: Readonly<OrbitGtBlobProps>;\r\n  protected _appearanceOverrides?: FeatureAppearance;\r\n  protected _planarClipMask?: PlanarClipMaskSettings;\r\n  /** Event dispatched just before assignment to [[planarClipMaskSettings]]. */\r\n  public readonly onPlanarClipMaskChanged = new BeEvent<(newSettings: PlanarClipMaskSettings | undefined, model: ContextRealityModel) => void>();\r\n  /** Event dispatched just before assignment to [[appearanceOverrides]]. */\r\n  public readonly onAppearanceOverridesChanged = new BeEvent<(newOverrides: FeatureAppearance | undefined, model: ContextRealityModel) => void>();\r\n\r\n  /** Construct a new context reality model.\r\n   * @param props JSON representation of the reality model, which will be kept in sync with changes made via the ContextRealityModel's methods.\r\n   */\r\n  public constructor(props: ContextRealityModelProps) {\r\n    this._props = props;\r\n    this.rdSourceKey = props.rdSourceKey;\r\n    this.name = props.name ?? \"\";\r\n    this.url = props.tilesetUrl ?? \"\";\r\n    this.orbitGtBlob = props.orbitGtBlob;\r\n    this.realityDataId = props.realityDataId;\r\n    this.description = props.description ?? \"\";\r\n    this._appearanceOverrides = props.appearanceOverrides ? FeatureAppearance.fromJSON(props.appearanceOverrides) : undefined;\r\n    if (props.planarClipMask && props.planarClipMask.mode !== PlanarClipMaskMode.None)\r\n      this._planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\r\n\r\n    if (props.classifiers)\r\n      this.classifiers = new SpatialClassifiers(props);\r\n  }\r\n\r\n  /** Optionally describes how the geometry of the reality model can be masked by other models. */\r\n  public get planarClipMaskSettings(): PlanarClipMaskSettings | undefined {\r\n    return this._planarClipMask;\r\n  }\r\n  public set planarClipMaskSettings(settings: PlanarClipMaskSettings | undefined) {\r\n    this.onPlanarClipMaskChanged.raiseEvent(settings, this);\r\n    if (!settings)\r\n      delete this._props.planarClipMask;\r\n    else\r\n      this._props.planarClipMask = settings.toJSON();\r\n\r\n    this._planarClipMask = settings;\r\n  }\r\n\r\n  /** Overrides applied to the appearance of the reality model. Only the rgb, transparency, nonLocatable, and emphasized properties are applicable - the rest are ignored. */\r\n  public get appearanceOverrides(): FeatureAppearance | undefined {\r\n    return this._appearanceOverrides;\r\n  }\r\n  public set appearanceOverrides(overrides: FeatureAppearance | undefined) {\r\n    this.onAppearanceOverridesChanged.raiseEvent(overrides, this);\r\n    if (!overrides)\r\n      delete this._props.appearanceOverrides;\r\n    else\r\n      this._props.appearanceOverrides = overrides.toJSON();\r\n\r\n    this._appearanceOverrides = overrides;\r\n  }\r\n\r\n  /** Convert this model to its JSON representation. */\r\n  public toJSON(): ContextRealityModelProps {\r\n    return ContextRealityModelProps.clone(this._props);\r\n  }\r\n\r\n  /** Returns true if [[name]] and [[url]] match the specified name and url. */\r\n  public matchesNameAndUrl(name: string, url: string): boolean {\r\n    return this.name === name && this.url === url;\r\n  }\r\n}\r\n\r\n/** An object that can store the JSON representation of a list of [[ContextRealityModel]]s.\r\n * @see [[ContextRealityModels]].\r\n * @see [[DisplayStyleSettingsProps.contextRealityModels]].\r\n * @public\r\n */\r\nexport interface ContextRealityModelsContainer {\r\n  /** The list of reality models. */\r\n  contextRealityModels?: ContextRealityModelProps[];\r\n}\r\n\r\n/** A list of [[ContextRealityModel]]s attached to a [[DisplayStyleSettings]]. The list may be presented to the user with the name and description of each model.\r\n * The list is automatically synchronized with the underlying JSON representation provided by the input [[ContextRealityModelsContainer]].\r\n * @see [this interactive example](https://www.itwinjs.org/sample-showcase/?group=Viewer&sample=reality-data-sample)\r\n * @see [[DisplayStyleSettings.contextRealityModels]].\r\n * @public\r\n */\r\nexport class ContextRealityModels {\r\n  private readonly _container: ContextRealityModelsContainer;\r\n  private readonly _createModel: (props: ContextRealityModelProps) => ContextRealityModel;\r\n  private readonly _models: ContextRealityModel[] = [];\r\n  /** Event dispatched just before [[ContextRealityModel.planarClipMaskSettings]] is modified for one of the reality models. */\r\n  public readonly onPlanarClipMaskChanged = new BeEvent<(model: ContextRealityModel, newSettings: PlanarClipMaskSettings | undefined) => void>();\r\n  /** Event dispatched just before [[ContextRealityModel.appearanceOverrides]] is modified for one of the reality models. */\r\n  public readonly onAppearanceOverridesChanged = new BeEvent<(model: ContextRealityModel, newOverrides: FeatureAppearance | undefined) => void>();\r\n  /** Event dispatched when a model is [[add]]ed, [[delete]]d, [[replace]]d, or [[update]]d. */\r\n  public readonly onChanged = new BeEvent<(previousModel: ContextRealityModel | undefined, newModel: ContextRealityModel | undefined) => void>();\r\n\r\n  /** Construct a new list of reality models from its JSON representation. THe list will be initialized from `container.classifiers` and that JSON representation\r\n   * will be kept in sync with changes made to the list. The caller should not directly modify `container.classifiers` or its contents as that will cause the list\r\n   * to become out of sync with the JSON representation.\r\n   * @param container The object that holds the JSON representation of the list.\r\n   * @param createContextRealityModel Optional function used to instantiate ContextRealityModels added to the list.\r\n   */\r\n  public constructor(container: ContextRealityModelsContainer, createContextRealityModel?: (props: ContextRealityModelProps) => ContextRealityModel) {\r\n    this._container = container;\r\n    this._createModel = createContextRealityModel ?? ((props) => new ContextRealityModel(props));\r\n\r\n    const models = container.contextRealityModels;\r\n    if (models)\r\n      for (const model of models)\r\n        this._models.push(this.createModel(model));\r\n  }\r\n\r\n  /** The read-only list of reality models. */\r\n  public get models(): ReadonlyArray<ContextRealityModel> {\r\n    return this._models;\r\n  }\r\n\r\n  /** Append a new reality model to the list.\r\n   * @param The JSON representation of the reality model.\r\n   * @returns the newly-added reality model.\r\n   */\r\n  public add(props: ContextRealityModelProps): ContextRealityModel {\r\n    if (!this._container.contextRealityModels)\r\n      this._container.contextRealityModels = [];\r\n\r\n    props = ContextRealityModelProps.clone(props);\r\n    const model = this.createModel(props);\r\n\r\n    this.onChanged.raiseEvent(undefined, model);\r\n\r\n    this._models.push(model);\r\n    this._container.contextRealityModels.push(props);\r\n\r\n    return model;\r\n  }\r\n\r\n  /** Remove the specified reality model from the list.\r\n   * @param model The reality model to remove.\r\n   * @returns true if the model was removed, or false if the model was not present in the list.\r\n   */\r\n  public delete(model: ContextRealityModel): boolean {\r\n    const index = this._models.indexOf(model);\r\n    if (-1 === index)\r\n      return false;\r\n\r\n    assert(undefined !== this._container.contextRealityModels);\r\n    assert(index < this._container.contextRealityModels.length);\r\n\r\n    this.dropEventListeners(model);\r\n    this.onChanged.raiseEvent(model, undefined);\r\n\r\n    this._models.splice(index, 1);\r\n    if (this.models.length === 0)\r\n      this._container.contextRealityModels = undefined;\r\n    else\r\n      this._container.contextRealityModels.splice(index, 1);\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Remove all reality models from the list. */\r\n  public clear(): void {\r\n    for (const model of this.models) {\r\n      this.dropEventListeners(model);\r\n      this.onChanged.raiseEvent(model, undefined);\r\n    }\r\n\r\n    this._container.contextRealityModels = undefined;\r\n    this._models.length = 0;\r\n  }\r\n\r\n  /** Replace a reality model in the list.\r\n   * @param toReplace The reality model to be replaced.\r\n   * @param replaceWith The JSON representation of the replacement reality model.\r\n   * @returns the newly-created reality model that replaced `toReplace`.\r\n   * @throws Error if `toReplace` is not present in the list\r\n   * @note The replacement occupies the same index in the list as `toReplace` did.\r\n   */\r\n  public replace(toReplace: ContextRealityModel, replaceWith: ContextRealityModelProps): ContextRealityModel {\r\n    const index = this._models.indexOf(toReplace);\r\n    if (-1 === index)\r\n      throw new Error(\"ContextRealityModel not present in list.\");\r\n\r\n    assert(undefined !== this._container.contextRealityModels);\r\n    assert(index < this._container.contextRealityModels.length);\r\n\r\n    replaceWith = ContextRealityModelProps.clone(replaceWith);\r\n    const model = this.createModel(replaceWith);\r\n\r\n    this.onChanged.raiseEvent(toReplace, model);\r\n    this.dropEventListeners(toReplace);\r\n\r\n    this._models[index] = model;\r\n    this._container.contextRealityModels[index] = replaceWith;\r\n\r\n    return model;\r\n  }\r\n\r\n  /** Change selected properties of a reality model.\r\n   * @param toUpdate The reality model whose properties are to be modified.\r\n   * @param updateProps The properties to change.\r\n   * @returns The updated reality model, identical to `toUpdate` except for properties explicitly supplied by `updateProps`.\r\n   * @throws Error if `toUpdate` is not present in the list.\r\n   */\r\n  public update(toUpdate: ContextRealityModel, updateProps: Partial<ContextRealityModelProps>): ContextRealityModel {\r\n    const props = {\r\n      ...toUpdate.toJSON(),\r\n      ...updateProps,\r\n    };\r\n\r\n    // Partial<> makes it possible to pass `undefined` for tilesetUrl...preserve previous URL in that case.\r\n    if (undefined === props.tilesetUrl)\r\n      props.tilesetUrl = toUpdate.url;\r\n\r\n    return this.replace(toUpdate, props);\r\n  }\r\n\r\n  private createModel(props: ContextRealityModelProps): ContextRealityModel {\r\n    const model = this._createModel(props);\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    model.onPlanarClipMaskChanged.addListener(this.handlePlanarClipMaskChanged, this);\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    model.onAppearanceOverridesChanged.addListener(this.handleAppearanceOverridesChanged, this);\r\n    return model;\r\n  }\r\n\r\n  private dropEventListeners(model: ContextRealityModel): void {\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    model.onPlanarClipMaskChanged.removeListener(this.handlePlanarClipMaskChanged, this);\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    model.onAppearanceOverridesChanged.removeListener(this.handleAppearanceOverridesChanged, this);\r\n  }\r\n\r\n  private handlePlanarClipMaskChanged(mask: PlanarClipMaskSettings | undefined, model: ContextRealityModel): void {\r\n    this.onPlanarClipMaskChanged.raiseEvent(model, mask);\r\n  }\r\n\r\n  private handleAppearanceOverridesChanged(app: FeatureAppearance | undefined, model: ContextRealityModel): void {\r\n    this.onAppearanceOverridesChanged.raiseEvent(model, app);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ContextRealityModel.js","sourceRoot":"","sources":["../../src/ContextRealityModel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAsD;AACtD,yDAA+E;AAC/E,qDAAmG;AACnG,mEAAqF;AAarF;;GAEG;AACH,IAAY,mBAyBX;AAzBD,WAAY,mBAAmB;IAC7B;;;;;OAKG;IACH,gDAAyB,CAAA;IACzB;;;;;OAKG;IACH,kDAA2B,CAAA;IAC3B;;;;OAIG;IACH,oDAA6B,CAAA;IAC7B;;OAEG;IACH,wDAAiC,CAAA;AACnC,CAAC,EAzBW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAyB9B;AAED;;GAEG;AACH,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B;;SAEK;IACL,8CAAyB,CAAA;IACzB;;MAEE;IACF,gCAAW,CAAA;AACb,CAAC,EATW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAS5B;AAED;;GAEG;AACH,WAAiB,iBAAiB;IAChC;;;;OAIG;IACH,SAAgB,OAAO,CAAC,UAAkB;QACxC,IAAI,MAAM,GAAG,iBAAiB,CAAC,UAAU,CAAC;QAC1C,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC7B,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC;QACjC,OAAO,MAAM,CAAC;IAChB,CAAC;IALe,yBAAO,UAKtB,CAAA;AACH,CAAC,EAZgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAYjC;AAuBD;;WAEW;AACX,IAAiB,oBAAoB,CAepC;AAfD,WAAiB,oBAAoB;IACnC,wFAAwF;IACxF,SAAgB,QAAQ,CAAC,WAAiC;QACxD,OAAO,GAAG,WAAW,CAAC,QAAQ,IAAI,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,EAAE,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,EAAE,CAAC;IACnG,CAAC;IAFe,6BAAQ,WAEvB,CAAA;IACD,8GAA8G;IAC9G,SAAgB,OAAO,CAAC,IAA0B,EAAE,IAA0B;QAC5E,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,mBAAmB,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,mBAAmB,CAAC,cAAc;YAChH,OAAO,IAAI,CAAC,CAAC,2DAA2D;QAC1E,IAAI,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,EAAG;YAChG,gGAAgG;YAChG,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IARe,4BAAO,UAQtB,CAAA;AACH,CAAC,EAfgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAepC;AAsCD,cAAc;AACd,IAAiB,wBAAwB,CAoCxC;AApCD,WAAiB,wBAAwB;IACvC,sCAAsC;IACtC,SAAgB,KAAK,CAAC,KAA+B;;QACnD,qFAAqF;QACrF,kHAAkH;QAClH,MAAM,MAAM,GAA6B,EAAE,UAAU,EAAE,MAAA,KAAK,CAAC,UAAU,mCAAI,EAAE,EAAE,CAAC;QAEhF,IAAI,KAAK,CAAC,WAAW;YACnB,MAAM,CAAC,WAAW,GAAG,EAAE,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAEhD,IAAI,KAAK,CAAC,IAAI;YACZ,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAE3B,IAAI,KAAK,CAAC,aAAa;YACrB,MAAM,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAE7C,IAAI,KAAK,CAAC,WAAW;YACnB,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAEzC,IAAI,KAAK,CAAC,WAAW;YACnB,MAAM,CAAC,WAAW,GAAG,EAAE,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAEhD,IAAI,KAAK,CAAC,mBAAmB,EAAE;YAC7B,MAAM,CAAC,mBAAmB,GAAG,EAAE,GAAG,KAAK,CAAC,mBAAmB,EAAE,CAAC;YAC9D,IAAI,KAAK,CAAC,mBAAmB,CAAC,GAAG;gBAC/B,MAAM,CAAC,mBAAmB,CAAC,GAAG,GAAG,EAAE,GAAG,KAAK,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC;SACzE;QAED,IAAI,KAAK,CAAC,cAAc;YACtB,MAAM,CAAC,cAAc,GAAG,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;QAEtD,IAAI,KAAK,CAAC,WAAW;YACnB,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjG,OAAO,MAAM,CAAC;IAChB,CAAC;IAjCe,8BAAK,QAiCpB,CAAA;AACH,CAAC,EApCgB,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAoCxC;AAED;;;;;GAKG;AACH,MAAa,mBAAmB;IA4B9B;;OAEG;IACH,YAAmB,KAA+B;;QARlD,6EAA6E;QAC7D,4BAAuB,GAAG,IAAI,sBAAO,EAAyF,CAAC;QAC/I,0EAA0E;QAC1D,iCAA4B,GAAG,IAAI,sBAAO,EAAqF,CAAC;QAM9I,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,MAAA,KAAK,CAAC,IAAI,mCAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,MAAA,KAAK,CAAC,UAAU,mCAAI,EAAE,CAAC;QAClC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,MAAA,KAAK,CAAC,WAAW,mCAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,oCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1H,IAAI,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,KAAK,mCAAkB,CAAC,IAAI;YAC/E,IAAI,CAAC,eAAe,GAAG,uCAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAE/E,IAAI,KAAK,CAAC,WAAW;YACnB,IAAI,CAAC,WAAW,GAAG,IAAI,0CAAkB,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,gGAAgG;IAChG,IAAW,sBAAsB;QAC/B,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IACD,IAAW,sBAAsB,CAAC,QAA4C;QAC5E,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ;YACX,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;;YAElC,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;QAEjD,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC;IAClC,CAAC;IAED,2KAA2K;IAC3K,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IACD,IAAW,mBAAmB,CAAC,SAAwC;QACrE,IAAI,CAAC,4BAA4B,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS;YACZ,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC;;YAEvC,IAAI,CAAC,MAAM,CAAC,mBAAmB,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QAEvD,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC;IACxC,CAAC;IAED,qDAAqD;IAC9C,MAAM;QACX,OAAO,wBAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,6EAA6E;IACtE,iBAAiB,CAAC,IAAY,EAAE,GAAW;QAChD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC;IAChD,CAAC;CACF;AApFD,kDAoFC;AAYD;;;;;GAKG;AACH,MAAa,oBAAoB;IAW/B;;;;;OAKG;IACH,YAAmB,SAAwC,EAAE,yBAAoF;QAdhI,YAAO,GAA0B,EAAE,CAAC;QACrD,6HAA6H;QAC7G,4BAAuB,GAAG,IAAI,sBAAO,EAAyF,CAAC;QAC/I,0HAA0H;QAC1G,iCAA4B,GAAG,IAAI,sBAAO,EAAqF,CAAC;QAChJ,6FAA6F;QAC7E,cAAS,GAAG,IAAI,sBAAO,EAAuG,CAAC;QAS7I,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,yBAAyB,aAAzB,yBAAyB,cAAzB,yBAAyB,GAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;QAE7F,MAAM,MAAM,GAAG,SAAS,CAAC,oBAAoB,CAAC;QAC9C,IAAI,MAAM;YACR,KAAK,MAAM,KAAK,IAAI,MAAM;gBACxB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,GAAG,CAAC,KAA+B;QACxC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,oBAAoB;YACvC,IAAI,CAAC,UAAU,CAAC,oBAAoB,GAAG,EAAE,CAAC;QAE5C,KAAK,GAAG,wBAAwB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAEtC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAE5C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEjD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAA0B;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,CAAC,KAAK,KAAK;YACd,OAAO,KAAK,CAAC;QAEf,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QAC3D,IAAA,qBAAM,EAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE5D,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAE5C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;YAC1B,IAAI,CAAC,UAAU,CAAC,oBAAoB,GAAG,SAAS,CAAC;;YAEjD,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAExD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+CAA+C;IACxC,KAAK;QACV,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YAC/B,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;SAC7C;QAED,IAAI,CAAC,UAAU,CAAC,oBAAoB,GAAG,SAAS,CAAC;QACjD,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,OAAO,CAAC,SAA8B,EAAE,WAAqC;QAClF,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC,CAAC,KAAK,KAAK;YACd,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAE9D,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QAC3D,IAAA,qBAAM,EAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE5D,WAAW,GAAG,wBAAwB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAE5C,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAEnC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;QAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC;QAE1D,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAA6B,EAAE,WAA8C;QACzF,MAAM,KAAK,GAAG;YACZ,GAAG,QAAQ,CAAC,MAAM,EAAE;YACpB,GAAG,WAAW;SACf,CAAC;QAEF,uGAAuG;QACvG,IAAI,SAAS,KAAK,KAAK,CAAC,UAAU;YAChC,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC;QAElC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAEO,WAAW,CAAC,KAA+B;QACjD,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACvC,6DAA6D;QAC7D,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,IAAI,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;QAClF,6DAA6D;QAC7D,KAAK,CAAC,4BAA4B,CAAC,WAAW,CAAC,IAAI,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;QAC5F,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,kBAAkB,CAAC,KAA0B;QACnD,6DAA6D;QAC7D,KAAK,CAAC,uBAAuB,CAAC,cAAc,CAAC,IAAI,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;QACrF,6DAA6D;QAC7D,KAAK,CAAC,4BAA4B,CAAC,cAAc,CAAC,IAAI,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;IACjG,CAAC;IAEO,2BAA2B,CAAC,IAAwC,EAAE,KAA0B;QACtG,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAEO,gCAAgC,CAAC,GAAkC,EAAE,KAA0B;QACrG,IAAI,CAAC,4BAA4B,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;CACF;AA3JD,oDA2JC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { assert, BeEvent } from \"@itwin/core-bentley\";\r\nimport { FeatureAppearance, FeatureAppearanceProps } from \"./FeatureSymbology\";\r\nimport { PlanarClipMaskMode, PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\r\nimport { SpatialClassifierProps, SpatialClassifiers } from \"./SpatialClassification\";\r\n\r\n/** JSON representation of the blob properties for an OrbitGt property cloud.\r\n * @alpha\r\n */\r\nexport interface OrbitGtBlobProps {\r\n  rdsUrl?: string;\r\n  containerName: string;\r\n  blobFileName: string;\r\n  sasToken: string;\r\n  accountName: string;\r\n}\r\n\r\n/** Identify the Reality Data service provider\r\n * @beta\r\n */\r\nexport enum RealityDataProvider {\r\n  /**\r\n   * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.tilesetUrl property.\r\n   * It was use to support RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles\r\n   * You should use other mode when possible\r\n   * @see [[RealityDataSource.createKeyFromUrl]] that will try to detect provider from an URL\r\n   */\r\n  TilesetUrl = \"TilesetUrl\",\r\n  /**\r\n   * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.OrbitGtBlob property.\r\n   * It was use to support OrbitPointCloud (OPC) from other server than ContextShare\r\n   * You should use other mode when possible\r\n   * @see [[RealityDataSource.createKeyFromOrbitGtBlobProps]] that will try to detect provider from an URL\r\n   */\r\n  OrbitGtBlob = \"OrbitGtBlob\",\r\n  /**\r\n   * Will provide access url from realityDataId and iTwinId on contextShare for 3dTile storage format or  OPC storage format\r\n   * This provider support all type of 3dTile storage fomat and OrbitPointCloud: RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles, OPC\r\n   * @see [[RealityDataFormat]].\r\n   */\r\n  ContextShare = \"ContextShare\",\r\n  /**\r\n   * Will provide Open Street Map Building (OSM) from Cesium Ion (in 3dTile format)\r\n   */\r\n  CesiumIonAsset = \"CesiumIonAsset\",\r\n}\r\n\r\n/** Identify the Reality Data storage format\r\n * @beta\r\n */\r\nexport enum RealityDataFormat {\r\n  /**\r\n   * 3dTile supported formats; RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles\r\n   * */\r\n  ThreeDTile = \"ThreeDTile\",\r\n  /**\r\n   * Orbit Point Cloud (OPC) storage format (RealityDataType.OPC)\r\n  */\r\n  OPC = \"OPC\",\r\n}\r\n\r\n/** Utility function for RealityDataFormat\r\n * @beta\r\n */\r\nexport namespace RealityDataFormat  {\r\n  /**\r\n   * Try to extract the RealityDataFormat from the url\r\n   * @param tilesetUrl the reality data attachment url\r\n   * @returns the extracted RealityDataFormat or ThreeDTile by default if not found\r\n   */\r\n  export function fromUrl(tilesetUrl: string): RealityDataFormat {\r\n    let format = RealityDataFormat.ThreeDTile;\r\n    if (tilesetUrl.includes(\".opc\"))\r\n      format = RealityDataFormat.OPC;\r\n    return format;\r\n  }\r\n}\r\n\r\n/**\r\n * Key used by RealityDataSource to identify provider and reality data format\r\n * This key identify one and only one reality data source on the provider\r\n * @beta\r\n */\r\nexport interface RealityDataSourceKey {\r\n  /**\r\n   * The provider that supplies the access to reality data source for displaying the reality model\r\n   * @see [[RealityDataProvider]] for default supported value;\r\n  */\r\n  provider: string;\r\n  /**\r\n   * The format used by the provider to store the reality data\r\n   * @see [[RealityDataFormat]] for default supported value;\r\n  */\r\n  format: string;\r\n  /** The reality data id that identify a reality data for the provider */\r\n  id: string;\r\n  /** The context id that was used when reality data was attached - if none provided, current session iTwinId will be used */\r\n  iTwinId?: string;\r\n}\r\n/**\r\n * RealityDataSourceKey utility functions\r\n * @beta */\r\nexport namespace RealityDataSourceKey {\r\n  /** Utility function to convert a RealityDataSourceKey into its string representation */\r\n  export function toString(rdSourceKey: RealityDataSourceKey): string {\r\n    return `${rdSourceKey.provider}:${rdSourceKey.format}:${rdSourceKey.id}:${rdSourceKey?.iTwinId}`;\r\n  }\r\n  /** Utility function to compare two RealityDataSourceKey, we consider it equal even if itwinId is different */\r\n  export function isEqual(key1: RealityDataSourceKey, key2: RealityDataSourceKey): boolean {\r\n    if ((key1.provider === RealityDataProvider.CesiumIonAsset) && key2.provider === RealityDataProvider.CesiumIonAsset)\r\n      return true; // ignore other properties for CesiumIonAsset, id is hidden\r\n    if ((key1.provider === key2.provider) && (key1.format === key2.format) && (key1.id === key2.id) ) {\r\n      // && (key1?.iTwinId === key2?.iTwinId)) -> ignore iTwinId, consider it is the same reality data\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n}\r\n\r\n/** JSON representation of the reality data reference attachment properties.\r\n * @beta\r\n*/\r\nexport interface RealityDataSourceProps {\r\n  /** The source key that identify a reality data for the provider. */\r\n  sourceKey: RealityDataSourceKey;\r\n}\r\n\r\n/** JSON representation of a [[ContextRealityModel]].\r\n * @public\r\n */\r\nexport interface ContextRealityModelProps {\r\n  /** @see [[ContextRealityModel.rdSourceKey]].\r\n   * @beta\r\n   */\r\n  rdSourceKey?: RealityDataSourceKey;\r\n  /** The URL that supplies the 3d tiles for displaying the reality model. */\r\n  tilesetUrl: string;\r\n  /** @see [[ContextRealityModel.orbitGtBlob]].\r\n   * @alpha\r\n   */\r\n  orbitGtBlob?: OrbitGtBlobProps;\r\n  /** @see [[ContextRealityModel.realityDataId]]. */\r\n  realityDataId?: string;\r\n  /** An optional, user-friendly name for the reality model suitable for display in a user interface. */\r\n  name?: string;\r\n  /** An optional, user-friendly description of the reality model suitable for display in a user interface. */\r\n  description?: string;\r\n  /** @see [[ContextRealityModel.classifiers]]. */\r\n  classifiers?: SpatialClassifierProps[];\r\n  /** @see [[ContextRealityModel.planarClipMask]]. */\r\n  planarClipMask?: PlanarClipMaskProps;\r\n  /** @see [[ContextRealityModel.appearanceOverrides]]. */\r\n  appearanceOverrides?: FeatureAppearanceProps;\r\n}\r\n\r\n/** @public */\r\nexport namespace ContextRealityModelProps {\r\n  /** Produce a deep copy of `input`. */\r\n  export function clone(input: ContextRealityModelProps) {\r\n    // Spread operator is shallow, and includes `undefined` properties and empty strings.\r\n    // We want to make deep copies, omit undefined properties and empty strings, and require tilesetUrl to be defined.\r\n    const output: ContextRealityModelProps = { tilesetUrl: input.tilesetUrl ?? \"\" };\r\n\r\n    if (input.rdSourceKey)\r\n      output.rdSourceKey = { ...input.rdSourceKey };\r\n\r\n    if (input.name)\r\n      output.name = input.name;\r\n\r\n    if (input.realityDataId)\r\n      output.realityDataId = input.realityDataId;\r\n\r\n    if (input.description)\r\n      output.description = input.description;\r\n\r\n    if (input.orbitGtBlob)\r\n      output.orbitGtBlob = { ...input.orbitGtBlob };\r\n\r\n    if (input.appearanceOverrides) {\r\n      output.appearanceOverrides = { ...input.appearanceOverrides };\r\n      if (input.appearanceOverrides.rgb)\r\n        output.appearanceOverrides.rgb = { ...input.appearanceOverrides.rgb };\r\n    }\r\n\r\n    if (input.planarClipMask)\r\n      output.planarClipMask = { ...input.planarClipMask };\r\n\r\n    if (input.classifiers)\r\n      output.classifiers = input.classifiers.map((x) => { return { ...x, flags: { ...x.flags } }; });\r\n\r\n    return output;\r\n  }\r\n}\r\n\r\n/** A reality model not associated with a [GeometricModel]($backend) but instead defined in a [DisplayStyle]($backend) or [DisplayStyleState]($frontend).\r\n * Such reality models are displayed to provide context to the view and can be freely attached and detached at display time.\r\n * @see [this interactive example](https://www.itwinjs.org/sample-showcase/?group=Viewer&sample=reality-data-sample)\r\n * @see [[DisplayStyleSettings.contextRealityModels]] to define context reality models for a display style.\r\n * @public\r\n */\r\nexport class ContextRealityModel {\r\n  /** @internal */\r\n  protected readonly _props: ContextRealityModelProps;\r\n  /**\r\n   * The reality data source key identify the reality data provider and storage format.\r\n   * It takes precedence over tilesetUrl and orbitGtBlob when present and can be use to actually replace these properties.\r\n   * @beta\r\n   */\r\n  public readonly  rdSourceKey?: RealityDataSourceKey;\r\n  /** A name suitable for display in a user interface. By default, an empty string. */\r\n  public readonly name: string;\r\n  /** The URL that supplies the 3d tiles for displaying the reality model. */\r\n  public readonly url: string;\r\n  /** A description of the model suitable for display in a user interface. By default, an empty string. */\r\n  public readonly description: string;\r\n  /** An optional identifier that, if present, can be used to elide a request to the reality data service. */\r\n  public readonly realityDataId?: string;\r\n  /** A set of [[SpatialClassifier]]s, of which one at any given time can be used to classify the reality model. */\r\n  public readonly classifiers?: SpatialClassifiers;\r\n  /** @alpha */\r\n  public readonly orbitGtBlob?: Readonly<OrbitGtBlobProps>;\r\n  protected _appearanceOverrides?: FeatureAppearance;\r\n  protected _planarClipMask?: PlanarClipMaskSettings;\r\n  /** Event dispatched just before assignment to [[planarClipMaskSettings]]. */\r\n  public readonly onPlanarClipMaskChanged = new BeEvent<(newSettings: PlanarClipMaskSettings | undefined, model: ContextRealityModel) => void>();\r\n  /** Event dispatched just before assignment to [[appearanceOverrides]]. */\r\n  public readonly onAppearanceOverridesChanged = new BeEvent<(newOverrides: FeatureAppearance | undefined, model: ContextRealityModel) => void>();\r\n\r\n  /** Construct a new context reality model.\r\n   * @param props JSON representation of the reality model, which will be kept in sync with changes made via the ContextRealityModel's methods.\r\n   */\r\n  public constructor(props: ContextRealityModelProps) {\r\n    this._props = props;\r\n    this.rdSourceKey = props.rdSourceKey;\r\n    this.name = props.name ?? \"\";\r\n    this.url = props.tilesetUrl ?? \"\";\r\n    this.orbitGtBlob = props.orbitGtBlob;\r\n    this.realityDataId = props.realityDataId;\r\n    this.description = props.description ?? \"\";\r\n    this._appearanceOverrides = props.appearanceOverrides ? FeatureAppearance.fromJSON(props.appearanceOverrides) : undefined;\r\n    if (props.planarClipMask && props.planarClipMask.mode !== PlanarClipMaskMode.None)\r\n      this._planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\r\n\r\n    if (props.classifiers)\r\n      this.classifiers = new SpatialClassifiers(props);\r\n  }\r\n\r\n  /** Optionally describes how the geometry of the reality model can be masked by other models. */\r\n  public get planarClipMaskSettings(): PlanarClipMaskSettings | undefined {\r\n    return this._planarClipMask;\r\n  }\r\n  public set planarClipMaskSettings(settings: PlanarClipMaskSettings | undefined) {\r\n    this.onPlanarClipMaskChanged.raiseEvent(settings, this);\r\n    if (!settings)\r\n      delete this._props.planarClipMask;\r\n    else\r\n      this._props.planarClipMask = settings.toJSON();\r\n\r\n    this._planarClipMask = settings;\r\n  }\r\n\r\n  /** Overrides applied to the appearance of the reality model. Only the rgb, transparency, nonLocatable, and emphasized properties are applicable - the rest are ignored. */\r\n  public get appearanceOverrides(): FeatureAppearance | undefined {\r\n    return this._appearanceOverrides;\r\n  }\r\n  public set appearanceOverrides(overrides: FeatureAppearance | undefined) {\r\n    this.onAppearanceOverridesChanged.raiseEvent(overrides, this);\r\n    if (!overrides)\r\n      delete this._props.appearanceOverrides;\r\n    else\r\n      this._props.appearanceOverrides = overrides.toJSON();\r\n\r\n    this._appearanceOverrides = overrides;\r\n  }\r\n\r\n  /** Convert this model to its JSON representation. */\r\n  public toJSON(): ContextRealityModelProps {\r\n    return ContextRealityModelProps.clone(this._props);\r\n  }\r\n\r\n  /** Returns true if [[name]] and [[url]] match the specified name and url. */\r\n  public matchesNameAndUrl(name: string, url: string): boolean {\r\n    return this.name === name && this.url === url;\r\n  }\r\n}\r\n\r\n/** An object that can store the JSON representation of a list of [[ContextRealityModel]]s.\r\n * @see [[ContextRealityModels]].\r\n * @see [[DisplayStyleSettingsProps.contextRealityModels]].\r\n * @public\r\n */\r\nexport interface ContextRealityModelsContainer {\r\n  /** The list of reality models. */\r\n  contextRealityModels?: ContextRealityModelProps[];\r\n}\r\n\r\n/** A list of [[ContextRealityModel]]s attached to a [[DisplayStyleSettings]]. The list may be presented to the user with the name and description of each model.\r\n * The list is automatically synchronized with the underlying JSON representation provided by the input [[ContextRealityModelsContainer]].\r\n * @see [this interactive example](https://www.itwinjs.org/sample-showcase/?group=Viewer&sample=reality-data-sample)\r\n * @see [[DisplayStyleSettings.contextRealityModels]].\r\n * @public\r\n */\r\nexport class ContextRealityModels {\r\n  private readonly _container: ContextRealityModelsContainer;\r\n  private readonly _createModel: (props: ContextRealityModelProps) => ContextRealityModel;\r\n  private readonly _models: ContextRealityModel[] = [];\r\n  /** Event dispatched just before [[ContextRealityModel.planarClipMaskSettings]] is modified for one of the reality models. */\r\n  public readonly onPlanarClipMaskChanged = new BeEvent<(model: ContextRealityModel, newSettings: PlanarClipMaskSettings | undefined) => void>();\r\n  /** Event dispatched just before [[ContextRealityModel.appearanceOverrides]] is modified for one of the reality models. */\r\n  public readonly onAppearanceOverridesChanged = new BeEvent<(model: ContextRealityModel, newOverrides: FeatureAppearance | undefined) => void>();\r\n  /** Event dispatched when a model is [[add]]ed, [[delete]]d, [[replace]]d, or [[update]]d. */\r\n  public readonly onChanged = new BeEvent<(previousModel: ContextRealityModel | undefined, newModel: ContextRealityModel | undefined) => void>();\r\n\r\n  /** Construct a new list of reality models from its JSON representation. THe list will be initialized from `container.classifiers` and that JSON representation\r\n   * will be kept in sync with changes made to the list. The caller should not directly modify `container.classifiers` or its contents as that will cause the list\r\n   * to become out of sync with the JSON representation.\r\n   * @param container The object that holds the JSON representation of the list.\r\n   * @param createContextRealityModel Optional function used to instantiate ContextRealityModels added to the list.\r\n   */\r\n  public constructor(container: ContextRealityModelsContainer, createContextRealityModel?: (props: ContextRealityModelProps) => ContextRealityModel) {\r\n    this._container = container;\r\n    this._createModel = createContextRealityModel ?? ((props) => new ContextRealityModel(props));\r\n\r\n    const models = container.contextRealityModels;\r\n    if (models)\r\n      for (const model of models)\r\n        this._models.push(this.createModel(model));\r\n  }\r\n\r\n  /** The read-only list of reality models. */\r\n  public get models(): ReadonlyArray<ContextRealityModel> {\r\n    return this._models;\r\n  }\r\n\r\n  /** Append a new reality model to the list.\r\n   * @param The JSON representation of the reality model.\r\n   * @returns the newly-added reality model.\r\n   */\r\n  public add(props: ContextRealityModelProps): ContextRealityModel {\r\n    if (!this._container.contextRealityModels)\r\n      this._container.contextRealityModels = [];\r\n\r\n    props = ContextRealityModelProps.clone(props);\r\n    const model = this.createModel(props);\r\n\r\n    this.onChanged.raiseEvent(undefined, model);\r\n\r\n    this._models.push(model);\r\n    this._container.contextRealityModels.push(props);\r\n\r\n    return model;\r\n  }\r\n\r\n  /** Remove the specified reality model from the list.\r\n   * @param model The reality model to remove.\r\n   * @returns true if the model was removed, or false if the model was not present in the list.\r\n   */\r\n  public delete(model: ContextRealityModel): boolean {\r\n    const index = this._models.indexOf(model);\r\n    if (-1 === index)\r\n      return false;\r\n\r\n    assert(undefined !== this._container.contextRealityModels);\r\n    assert(index < this._container.contextRealityModels.length);\r\n\r\n    this.dropEventListeners(model);\r\n    this.onChanged.raiseEvent(model, undefined);\r\n\r\n    this._models.splice(index, 1);\r\n    if (this.models.length === 0)\r\n      this._container.contextRealityModels = undefined;\r\n    else\r\n      this._container.contextRealityModels.splice(index, 1);\r\n\r\n    return true;\r\n  }\r\n\r\n  /** Remove all reality models from the list. */\r\n  public clear(): void {\r\n    for (const model of this.models) {\r\n      this.dropEventListeners(model);\r\n      this.onChanged.raiseEvent(model, undefined);\r\n    }\r\n\r\n    this._container.contextRealityModels = undefined;\r\n    this._models.length = 0;\r\n  }\r\n\r\n  /** Replace a reality model in the list.\r\n   * @param toReplace The reality model to be replaced.\r\n   * @param replaceWith The JSON representation of the replacement reality model.\r\n   * @returns the newly-created reality model that replaced `toReplace`.\r\n   * @throws Error if `toReplace` is not present in the list\r\n   * @note The replacement occupies the same index in the list as `toReplace` did.\r\n   */\r\n  public replace(toReplace: ContextRealityModel, replaceWith: ContextRealityModelProps): ContextRealityModel {\r\n    const index = this._models.indexOf(toReplace);\r\n    if (-1 === index)\r\n      throw new Error(\"ContextRealityModel not present in list.\");\r\n\r\n    assert(undefined !== this._container.contextRealityModels);\r\n    assert(index < this._container.contextRealityModels.length);\r\n\r\n    replaceWith = ContextRealityModelProps.clone(replaceWith);\r\n    const model = this.createModel(replaceWith);\r\n\r\n    this.onChanged.raiseEvent(toReplace, model);\r\n    this.dropEventListeners(toReplace);\r\n\r\n    this._models[index] = model;\r\n    this._container.contextRealityModels[index] = replaceWith;\r\n\r\n    return model;\r\n  }\r\n\r\n  /** Change selected properties of a reality model.\r\n   * @param toUpdate The reality model whose properties are to be modified.\r\n   * @param updateProps The properties to change.\r\n   * @returns The updated reality model, identical to `toUpdate` except for properties explicitly supplied by `updateProps`.\r\n   * @throws Error if `toUpdate` is not present in the list.\r\n   */\r\n  public update(toUpdate: ContextRealityModel, updateProps: Partial<ContextRealityModelProps>): ContextRealityModel {\r\n    const props = {\r\n      ...toUpdate.toJSON(),\r\n      ...updateProps,\r\n    };\r\n\r\n    // Partial<> makes it possible to pass `undefined` for tilesetUrl...preserve previous URL in that case.\r\n    if (undefined === props.tilesetUrl)\r\n      props.tilesetUrl = toUpdate.url;\r\n\r\n    return this.replace(toUpdate, props);\r\n  }\r\n\r\n  private createModel(props: ContextRealityModelProps): ContextRealityModel {\r\n    const model = this._createModel(props);\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    model.onPlanarClipMaskChanged.addListener(this.handlePlanarClipMaskChanged, this);\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    model.onAppearanceOverridesChanged.addListener(this.handleAppearanceOverridesChanged, this);\r\n    return model;\r\n  }\r\n\r\n  private dropEventListeners(model: ContextRealityModel): void {\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    model.onPlanarClipMaskChanged.removeListener(this.handlePlanarClipMaskChanged, this);\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    model.onAppearanceOverridesChanged.removeListener(this.handleAppearanceOverridesChanged, this);\r\n  }\r\n\r\n  private handlePlanarClipMaskChanged(mask: PlanarClipMaskSettings | undefined, model: ContextRealityModel): void {\r\n    this.onPlanarClipMaskChanged.raiseEvent(model, mask);\r\n  }\r\n\r\n  private handleAppearanceOverridesChanged(app: FeatureAppearance | undefined, model: ContextRealityModel): void {\r\n    this.onAppearanceOverridesChanged.raiseEvent(model, app);\r\n  }\r\n}\r\n"]}

package/lib/cjs/GeoCoordinateServices.d.ts

@@ -3,6 +3,7 @@
  */
 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]].
@@ -88,4 +89,31 @@ 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;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD;;;;GAIG;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"}
+{"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;;;;GAIG;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"}

package/lib/cjs/GeoCoordinateServices.js

@@ -8,6 +8,7 @@
  */
 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]].

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,sDAAuD;AAGvD;;;;GAIG;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\nimport { GeoServiceStatus } from \"@itwin/core-bentley\";\r\nimport { XYZProps } from \"@itwin/core-geometry\";\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 */\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"]}
+{"version":3,"file":"GeoCoordinateServices.js","sourceRoot":"","sources":["../../src/GeoCoordinateServices.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qDAAqD;AAErD,sDAAuD;AAIvD;;;;GAIG;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 */\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"]}

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

@@ -1 +1 @@
-{"version":3,"file":"Gradient.d.ts","sourceRoot":"","sources":["../../src/Gradient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,WAAW,EAAqB,MAAM,SAAS,CAAC;AACzD,OAAO,EAAqD,wBAAwB,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAE/I;;;;GAIG;AACH,yBAAiB,QAAQ,CAAC;IACxB,4CAA4C;IAC5C,KAAY,KAAK;QACf,gBAAgB;QAChB,IAAI,IAAI;QACR,8CAA8C;QAC9C,MAAM,IAAI;QACV,2EAA2E;QAC3E,OAAO,IAAI;KACZ;IAED,+FAA+F;IAC/F,KAAY,IAAI;QACd,IAAI,IAAI;QACR,MAAM,IAAI;QACV,MAAM,IAAI;QACV,WAAW,IAAI;QACf,SAAS,IAAI;QACb,aAAa,IAAI;QACjB,4DAA4D;QAC5D,QAAQ,IAAI;KACb;IAED,mDAAmD;IACnD,UAAiB,aAAa;QAC5B,iEAAiE;QACjE,KAAK,EAAE,MAAM,CAAC;QACd,qCAAqC;QACrC,KAAK,EAAE,aAAa,CAAC;KACtB;IAED;;OAEG;IACH,MAAa,QAAQ;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,QAAQ,CAAC;oBACJ,IAAI,EAAE,aAAa;KAIvC;IAED,wEAAwE;IACxE,SAAgB,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAEhE;IAED,+EAA+E;IAC/E,UAAiB,SAAS;QACxB,gGAAgG;QAChG,IAAI,EAAE,IAAI,CAAC;QACX,mGAAmG;QACnG,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,gDAAgD;QAChD,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB,iHAAiH;QACjH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,6DAA6D;QAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,0FAA0F;QAC1F,IAAI,EAAE,aAAa,EAAE,CAAC;QACtB,kDAAkD;QAClD,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;KAClD;IAED;;;OAGG;IACH,MAAa,IAAI;QACR,IAAI,OAAa;QACjB,KAAK,EAAE,KAAK,CAAc;QAC1B,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAK;QAClB,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;QAC5C,IAAI,EAAE,QAAQ,EAAE,CAAM;QAE7B,gDAAgD;eAClC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS;QAevC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAO7B;QACF,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAwC;QAEvE,sCAAsC;eACxB,cAAc,CAAC,QAAQ,EAAE,wBAAwB;QAoBxD,MAAM,IAAI,SAAS;QAQnB,KAAK,IAAI,IAAI;QAIpB,2EAA2E;QACpE,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO;QAInC;;;;WAIG;eACW,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,IAAI,GAAG,MAAM;QA4CzE;;WAEG;QACI,OAAO,CAAC,KAAK,EAAE,IAAI,GAAG,MAAM;QAInC;;;WAGG;QACH,OAAO,CAAC,WAAW;QAInB,6FAA6F;QACtF,QAAQ,CAAC,KAAK,EAAE,MAAM;QAqC7B,IAAW,eAAe,IAAI,OAAO,CAOpC;QAED,kEAAkE;QAClE,IAAW,UAAU,IAAI,OAAO,CAA+C;QAE/E;;;;WAIG;QACI,2BAA2B,CAAC,YAAY,EAAE,MAAM,GAAG,WAAW;QAyDrE,kEAAkE;QAC3D,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,WAAW;KAsK5D;CACF"}
+{"version":3,"file":"Gradient.d.ts","sourceRoot":"","sources":["../../src/Gradient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,WAAW,EAAqB,MAAM,SAAS,CAAC;AACzD,OAAO,EAAqD,wBAAwB,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAE/I;;;;GAIG;AACH,yBAAiB,QAAQ,CAAC;IACxB,4CAA4C;IAC5C,KAAY,KAAK;QACf,gBAAgB;QAChB,IAAI,IAAI;QACR,8CAA8C;QAC9C,MAAM,IAAI;QACV,2EAA2E;QAC3E,OAAO,IAAI;KACZ;IAED,+FAA+F;IAC/F,KAAY,IAAI;QACd,IAAI,IAAI;QACR,MAAM,IAAI;QACV,MAAM,IAAI;QACV,WAAW,IAAI;QACf,SAAS,IAAI;QACb,aAAa,IAAI;QACjB,4DAA4D;QAC5D,QAAQ,IAAI;KACb;IAED,mDAAmD;IACnD,UAAiB,aAAa;QAC5B,iEAAiE;QACjE,KAAK,EAAE,MAAM,CAAC;QACd,qCAAqC;QACrC,KAAK,EAAE,aAAa,CAAC;KACtB;IAED;;OAEG;IACH,MAAa,QAAQ;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,QAAQ,CAAC;oBACJ,IAAI,EAAE,aAAa;KAIvC;IAED,wEAAwE;IACxE,SAAgB,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,CAEhE;IAED,+EAA+E;IAC/E,UAAiB,SAAS;QACxB,gGAAgG;QAChG,IAAI,EAAE,IAAI,CAAC;QACX,mGAAmG;QACnG,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,gDAAgD;QAChD,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB,iHAAiH;QACjH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,6DAA6D;QAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,0FAA0F;QAC1F,IAAI,EAAE,aAAa,EAAE,CAAC;QACtB,kDAAkD;QAClD,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;KAClD;IAED;;;OAGG;IACH,MAAa,IAAI;QACR,IAAI,OAAa;QACjB,KAAK,EAAE,KAAK,CAAc;QAC1B,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAK;QAClB,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;QAC5C,IAAI,EAAE,QAAQ,EAAE,CAAM;QAE7B,gDAAgD;eAClC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS;QAevC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAO7B;QACF,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAwC;QAEvE,sCAAsC;eACxB,cAAc,CAAC,QAAQ,EAAE,wBAAwB;QAoBxD,MAAM,IAAI,SAAS;QAQnB,KAAK,IAAI,IAAI;QAIpB,2EAA2E;QACpE,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO;QAInC;;;;WAIG;eACW,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,IAAI,GAAG,MAAM;QAsDzE;;WAEG;QACI,OAAO,CAAC,KAAK,EAAE,IAAI,GAAG,MAAM;QAInC;;;WAGG;QACH,OAAO,CAAC,WAAW;QAInB,6FAA6F;QACtF,QAAQ,CAAC,KAAK,EAAE,MAAM;QAqC7B,IAAW,eAAe,IAAI,OAAO,CAOpC;QAED,kEAAkE;QAClE,IAAW,UAAU,IAAI,OAAO,CAA+C;QAE/E;;;;WAIG;QACI,2BAA2B,CAAC,YAAY,EAAE,MAAM,GAAG,WAAW;QAyDrE,kEAAkE;QAC3D,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,WAAW;KAsK5D;CACF"}

package/lib/cjs/Gradient.js

@@ -164,6 +164,16 @@ var Gradient;
                 if (!lhs.keys[i].color.equals(rhs.keys[i].color))
                     return lhs.keys[i].color.tbgr - rhs.keys[i].color.tbgr;
             }
+            if (lhs.thematicSettings !== rhs.thematicSettings)
+                if (undefined === lhs.thematicSettings)
+                    return -1;
+                else if (undefined === rhs.thematicSettings)
+                    return 1;
+                else {
+                    const thematicCompareResult = ThematicDisplay_1.ThematicGradientSettings.compare(lhs.thematicSettings, rhs.thematicSettings);
+                    if (0 !== thematicCompareResult)
+                        return thematicCompareResult;
+                }
             return 0;
         }
         /** Compare this symbology to another.