@itwin/core-common 3.5.0-dev.4 → 3.5.0-dev.7

package/lib/esm/ContextRealityModel.d.ts

@@ -1,256 +1,277 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { FeatureAppearance, FeatureAppearanceProps } from "./FeatureSymbology";
-import { PlanarClipMaskProps, PlanarClipMaskSettings } from "./PlanarClipMask";
-import { SpatialClassifierProps, SpatialClassifiers } from "./SpatialClassification";
-/** JSON representation of the blob properties for an OrbitGt property cloud.
- * @alpha
- */
-export interface OrbitGtBlobProps {
-    rdsUrl?: string;
-    containerName: string;
-    blobFileName: string;
-    sasToken: string;
-    accountName: string;
-}
-/** Identify the Reality Data service provider
- * @beta
- */
-export declare enum RealityDataProvider {
-    /**
-     * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.tilesetUrl property.
-     * It was use to support RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles
-     * You should use other mode when possible
-     * @see [[RealityDataSource.createKeyFromUrl]] that will try to detect provider from an URL
-     */
-    TilesetUrl = "TilesetUrl",
-    /**
-     * 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.createKeyFromOrbitGtBlobProps]] that will try to detect provider from an URL
-     */
-    OrbitGtBlob = "OrbitGtBlob",
-    /**
-     * Will provide access url from realityDataId and iTwinId on contextShare for 3dTile storage format or  OPC storage format
-     * This provider support all type of 3dTile storage fomat and OrbitPointCloud: RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles, OPC
-     * @see [[RealityDataFormat]].
-     */
-    ContextShare = "ContextShare",
-    /**
-     * Will provide Open Street Map Building (OSM) from Cesium Ion (in 3dTile format)
-     */
-    CesiumIonAsset = "CesiumIonAsset"
-}
-/** Identify the Reality Data storage format
- * @beta
- */
-export declare enum RealityDataFormat {
-    /**
-     * 3dTile supported formats; RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles
-     * */
-    ThreeDTile = "ThreeDTile",
-    /**
-     * Orbit Point Cloud (OPC) storage format (RealityDataType.OPC)
-    */
-    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
- * @beta
- */
-export interface RealityDataSourceKey {
-    /**
-     * The provider that supplies the access to reality data source for displaying the reality model
-     * @see [[RealityDataProvider]] for default supported value;
-    */
-    provider: string;
-    /**
-     * The format used by the provider to store the reality data
-     * @see [[RealityDataFormat]] for default supported value;
-    */
-    format: string;
-    /** The reality data id that identify a reality data for the provider */
-    id: string;
-    /** 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 convertToString(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.
- * @beta
-*/
-export interface RealityDataSourceProps {
-    /** The source key that identify a reality data for the provider. */
-    sourceKey: RealityDataSourceKey;
-}
-/** JSON representation of a [[ContextRealityModel]].
- * @public
- * @extensions
- */
-export interface ContextRealityModelProps {
-    /** See [[ContextRealityModel.rdSourceKey]].
-     * @beta
-     */
-    rdSourceKey?: RealityDataSourceKey;
-    /** The URL that supplies the 3d tiles for displaying the reality model. */
-    tilesetUrl: string;
-    /** See [[ContextRealityModel.orbitGtBlob]].
-     * @alpha
-     */
-    orbitGtBlob?: OrbitGtBlobProps;
-    /** See [[ContextRealityModel.realityDataId]]. */
-    realityDataId?: string;
-    /** An optional, user-friendly name for the reality model suitable for display in a user interface. */
-    name?: string;
-    /** An optional, user-friendly description of the reality model suitable for display in a user interface. */
-    description?: string;
-    /** See [[ContextRealityModel.classifiers]]. */
-    classifiers?: SpatialClassifierProps[];
-    /** See [[ContextRealityModel.planarClipMask]]. */
-    planarClipMask?: PlanarClipMaskProps;
-    /** See [[ContextRealityModel.appearanceOverrides]]. */
-    appearanceOverrides?: FeatureAppearanceProps;
-}
-/** @public */
-export declare namespace ContextRealityModelProps {
-    /** Produce a deep copy of `input`. */
-    function clone(input: ContextRealityModelProps): ContextRealityModelProps;
-}
-/** A reality model not associated with a [GeometricModel]($backend) but instead defined in a [DisplayStyle]($backend) or [DisplayStyleState]($frontend).
- * Such reality models are displayed to provide context to the view and can be freely attached and detached at display time.
- * @see [this interactive example](https://www.itwinjs.org/sample-showcase/?group=Viewer&sample=reality-data-sample)
- * @see [[DisplayStyleSettings.contextRealityModels]] to define context reality models for a display style.
- * @public
- */
-export declare class ContextRealityModel {
-    /** @internal */
-    protected readonly _props: 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.
-     * @beta
-     */
-    readonly rdSourceKey?: RealityDataSourceKey;
-    /** A name suitable for display in a user interface. By default, an empty string. */
-    readonly name: string;
-    /** The URL that supplies the 3d tiles for displaying the reality model. */
-    readonly url: string;
-    /** A description of the model suitable for display in a user interface. By default, an empty string. */
-    readonly description: string;
-    /** An optional identifier that, if present, can be used to elide a request to the reality data service. */
-    readonly realityDataId?: string;
-    /** A set of [[SpatialClassifier]]s, of which one at any given time can be used to classify the reality model. */
-    readonly classifiers?: SpatialClassifiers;
-    /** @alpha */
-    readonly orbitGtBlob?: Readonly<OrbitGtBlobProps>;
-    protected _appearanceOverrides?: FeatureAppearance;
-    protected _planarClipMask?: PlanarClipMaskSettings;
-    /** Event dispatched just before assignment to [[planarClipMaskSettings]]. */
-    readonly onPlanarClipMaskChanged: BeEvent<(newSettings: PlanarClipMaskSettings | undefined, model: ContextRealityModel) => void>;
-    /** Event dispatched just before assignment to [[appearanceOverrides]]. */
-    readonly onAppearanceOverridesChanged: BeEvent<(newOverrides: FeatureAppearance | undefined, model: ContextRealityModel) => void>;
-    /** Construct a new context reality model.
-     * @param props JSON representation of the reality model, which will be kept in sync with changes made via the ContextRealityModel's methods.
-     */
-    constructor(props: ContextRealityModelProps);
-    /** Optionally describes how the geometry of the reality model can be masked by other models. */
-    get planarClipMaskSettings(): PlanarClipMaskSettings | undefined;
-    set planarClipMaskSettings(settings: PlanarClipMaskSettings | undefined);
-    /** Overrides applied to the appearance of the reality model. Only the rgb, transparency, nonLocatable, and emphasized properties are applicable - the rest are ignored. */
-    get appearanceOverrides(): FeatureAppearance | undefined;
-    set appearanceOverrides(overrides: FeatureAppearance | undefined);
-    /** Convert this model to its JSON representation. */
-    toJSON(): ContextRealityModelProps;
-    /** Returns true if [[name]] and [[url]] match the specified name and url. */
-    matchesNameAndUrl(name: string, url: string): boolean;
-}
-/** An object that can store the JSON representation of a list of [[ContextRealityModel]]s.
- * @see [[ContextRealityModels]].
- * @see [[DisplayStyleSettingsProps.contextRealityModels]].
- * @public
- * @extensions
- */
-export interface ContextRealityModelsContainer {
-    /** The list of reality models. */
-    contextRealityModels?: ContextRealityModelProps[];
-}
-/** 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.
- * The list is automatically synchronized with the underlying JSON representation provided by the input [[ContextRealityModelsContainer]].
- * @see [this interactive example](https://www.itwinjs.org/sample-showcase/?group=Viewer&sample=reality-data-sample)
- * @see [[DisplayStyleSettings.contextRealityModels]].
- * @public
- */
-export declare class ContextRealityModels {
-    private readonly _container;
-    private readonly _createModel;
-    private readonly _models;
-    /** Event dispatched just before [[ContextRealityModel.planarClipMaskSettings]] is modified for one of the reality models. */
-    readonly onPlanarClipMaskChanged: BeEvent<(model: ContextRealityModel, newSettings: PlanarClipMaskSettings | undefined) => void>;
-    /** Event dispatched just before [[ContextRealityModel.appearanceOverrides]] is modified for one of the reality models. */
-    readonly onAppearanceOverridesChanged: BeEvent<(model: ContextRealityModel, newOverrides: FeatureAppearance | undefined) => void>;
-    /** Event dispatched when a model is [[add]]ed, [[delete]]d, [[replace]]d, or [[update]]d. */
-    readonly onChanged: BeEvent<(previousModel: ContextRealityModel | undefined, newModel: ContextRealityModel | undefined) => void>;
-    /** Construct a new list of reality models from its JSON representation. THe list will be initialized from `container.classifiers` and that JSON representation
-     * 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
-     * to become out of sync with the JSON representation.
-     * @param container The object that holds the JSON representation of the list.
-     * @param createContextRealityModel Optional function used to instantiate ContextRealityModels added to the list.
-     */
-    constructor(container: ContextRealityModelsContainer, createContextRealityModel?: (props: ContextRealityModelProps) => ContextRealityModel);
-    /** The read-only list of reality models. */
-    get models(): ReadonlyArray<ContextRealityModel>;
-    /** Append a new reality model to the list.
-     * @param The JSON representation of the reality model.
-     * @returns the newly-added reality model.
-     */
-    add(props: ContextRealityModelProps): ContextRealityModel;
-    /** Remove the specified reality model from the list.
-     * @param model The reality model to remove.
-     * @returns true if the model was removed, or false if the model was not present in the list.
-     */
-    delete(model: ContextRealityModel): boolean;
-    /** Remove all reality models from the list. */
-    clear(): void;
-    /** Replace a reality model in the list.
-     * @param toReplace The reality model to be replaced.
-     * @param replaceWith The JSON representation of the replacement reality model.
-     * @returns the newly-created reality model that replaced `toReplace`.
-     * @throws Error if `toReplace` is not present in the list
-     * @note The replacement occupies the same index in the list as `toReplace` did.
-     */
-    replace(toReplace: ContextRealityModel, replaceWith: ContextRealityModelProps): ContextRealityModel;
-    /** Change selected properties of a reality model.
-     * @param toUpdate The reality model whose properties are to be modified.
-     * @param updateProps The properties to change.
-     * @returns The updated reality model, identical to `toUpdate` except for properties explicitly supplied by `updateProps`.
-     * @throws Error if `toUpdate` is not present in the list.
-     */
-    update(toUpdate: ContextRealityModel, updateProps: Partial<ContextRealityModelProps>): ContextRealityModel;
-    private createModel;
-    private dropEventListeners;
-    private handlePlanarClipMaskChanged;
-    private handleAppearanceOverridesChanged;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { FeatureAppearance, FeatureAppearanceProps } from "./FeatureSymbology";
+import { PlanarClipMaskProps, PlanarClipMaskSettings } from "./PlanarClipMask";
+import { SpatialClassifierProps, SpatialClassifiers } from "./SpatialClassification";
+import { RealityModelDisplayProps, RealityModelDisplaySettings } from "./RealityModelDisplaySettings";
+/** JSON representation of the blob properties for an OrbitGt property cloud.
+ * @alpha
+ */
+export interface OrbitGtBlobProps {
+    rdsUrl?: string;
+    containerName: string;
+    blobFileName: string;
+    sasToken: string;
+    accountName: string;
+}
+/** Identify the Reality Data service provider
+ * @beta
+ */
+export declare enum RealityDataProvider {
+    /**
+     * This is the legacy mode where the access to the 3d tiles is harcoded in ContextRealityModelProps.tilesetUrl property.
+     * It was use to support RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles
+     * You should use other mode when possible
+     * @see [[RealityDataSource.createKeyFromUrl]] that will try to detect provider from an URL
+     */
+    TilesetUrl = "TilesetUrl",
+    /**
+     * 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.createKeyFromOrbitGtBlobProps]] that will try to detect provider from an URL
+     */
+    OrbitGtBlob = "OrbitGtBlob",
+    /**
+     * Will provide access url from realityDataId and iTwinId on contextShare for 3dTile storage format or  OPC storage format
+     * This provider support all type of 3dTile storage fomat and OrbitPointCloud: RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles, OPC
+     * @see [[RealityDataFormat]].
+     */
+    ContextShare = "ContextShare",
+    /**
+     * Will provide Open Street Map Building (OSM) from Cesium Ion (in 3dTile format)
+     */
+    CesiumIonAsset = "CesiumIonAsset"
+}
+/** Identify the Reality Data storage format
+ * @beta
+ */
+export declare enum RealityDataFormat {
+    /**
+     * 3dTile supported formats; RealityMesh3DTiles, Terrain3DTiles, Cesium3DTiles
+     * */
+    ThreeDTile = "ThreeDTile",
+    /**
+     * Orbit Point Cloud (OPC) storage format (RealityDataType.OPC)
+    */
+    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
+ * @beta
+ */
+export interface RealityDataSourceKey {
+    /**
+     * The provider that supplies the access to reality data source for displaying the reality model
+     * @see [[RealityDataProvider]] for default supported value;
+    */
+    provider: string;
+    /**
+     * The format used by the provider to store the reality data
+     * @see [[RealityDataFormat]] for default supported value;
+    */
+    format: string;
+    /** The reality data id that identify a reality data for the provider */
+    id: string;
+    /** 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 convertToString(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.
+ * @beta
+*/
+export interface RealityDataSourceProps {
+    /** The source key that identify a reality data for the provider. */
+    sourceKey: RealityDataSourceKey;
+}
+/** JSON representation of a [[ContextRealityModel]].
+ * @public
+ * @extensions
+ */
+export interface ContextRealityModelProps {
+    /** See [[ContextRealityModel.rdSourceKey]].
+     * @beta
+     */
+    rdSourceKey?: RealityDataSourceKey;
+    /** The URL that supplies the 3d tiles for displaying the reality model. */
+    tilesetUrl: string;
+    /** See [[ContextRealityModel.orbitGtBlob]].
+     * @alpha
+     */
+    orbitGtBlob?: OrbitGtBlobProps;
+    /** See [[ContextRealityModel.realityDataId]]. */
+    realityDataId?: string;
+    /** An optional, user-friendly name for the reality model suitable for display in a user interface. */
+    name?: string;
+    /** An optional, user-friendly description of the reality model suitable for display in a user interface. */
+    description?: string;
+    /** See [[ContextRealityModel.classifiers]]. */
+    classifiers?: SpatialClassifierProps[];
+    /** See [[ContextRealityModel.planarClipMask]]. */
+    planarClipMask?: PlanarClipMaskProps;
+    /** See [[ContextRealityModel.appearanceOverrides]]. */
+    appearanceOverrides?: FeatureAppearanceProps;
+    /** See [[ContextRealityModel.displaySettings]].
+     * @beta
+     */
+    displaySettings?: RealityModelDisplayProps;
+}
+/** @public */
+export declare namespace ContextRealityModelProps {
+    /** Produce a deep copy of `input`. */
+    function clone(input: ContextRealityModelProps): ContextRealityModelProps;
+}
+/** A reality model not associated with a [GeometricModel]($backend) but instead defined in a [DisplayStyle]($backend) or [DisplayStyleState]($frontend).
+ * Such reality models are displayed to provide context to the view and can be freely attached and detached at display time.
+ * @see [this interactive example](https://www.itwinjs.org/sample-showcase/?group=Viewer&sample=reality-data-sample)
+ * @see [[DisplayStyleSettings.contextRealityModels]] to define context reality models for a display style.
+ * @public
+ */
+export declare class ContextRealityModel {
+    /** @internal */
+    protected readonly _props: 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.
+     * @beta
+     */
+    readonly rdSourceKey?: RealityDataSourceKey;
+    /** A name suitable for display in a user interface. By default, an empty string. */
+    readonly name: string;
+    /** The URL that supplies the 3d tiles for displaying the reality model. */
+    readonly url: string;
+    /** A description of the model suitable for display in a user interface. By default, an empty string. */
+    readonly description: string;
+    /** An optional identifier that, if present, can be used to elide a request to the reality data service. */
+    readonly realityDataId?: string;
+    /** A set of [[SpatialClassifier]]s, of which one at any given time can be used to classify the reality model. */
+    readonly classifiers?: SpatialClassifiers;
+    /** @alpha */
+    readonly orbitGtBlob?: Readonly<OrbitGtBlobProps>;
+    protected _appearanceOverrides?: FeatureAppearance;
+    /** @beta */
+    protected _displaySettings: RealityModelDisplaySettings;
+    protected _planarClipMask?: PlanarClipMaskSettings;
+    /** Event dispatched just before assignment to [[planarClipMaskSettings]]. */
+    readonly onPlanarClipMaskChanged: BeEvent<(newSettings: PlanarClipMaskSettings | undefined, model: ContextRealityModel) => void>;
+    /** Event dispatched just before assignment to [[appearanceOverrides]]. */
+    readonly onAppearanceOverridesChanged: BeEvent<(newOverrides: FeatureAppearance | undefined, model: ContextRealityModel) => void>;
+    /** Event dispatched just before assignment to [[displaySettings]].
+     * @beta
+     */
+    readonly onDisplaySettingsChanged: BeEvent<(newSettings: RealityModelDisplaySettings, model: ContextRealityModel) => void>;
+    /** Construct a new context reality model.
+     * @param props JSON representation of the reality model, which will be kept in sync with changes made via the ContextRealityModel's methods.
+     */
+    constructor(props: ContextRealityModelProps);
+    /** Optionally describes how the geometry of the reality model can be masked by other models. */
+    get planarClipMaskSettings(): PlanarClipMaskSettings | undefined;
+    set planarClipMaskSettings(settings: PlanarClipMaskSettings | undefined);
+    /** Overrides applied to the appearance of the reality model. Only the rgb, transparency, nonLocatable, and emphasized properties are applicable - the rest are ignored. */
+    get appearanceOverrides(): FeatureAppearance | undefined;
+    set appearanceOverrides(overrides: FeatureAppearance | undefined);
+    /** Settings controlling how this reality model is displayed in a [Viewport]($frontend).
+     * @beta
+     */
+    get displaySettings(): RealityModelDisplaySettings;
+    set displaySettings(settings: RealityModelDisplaySettings);
+    /** Convert this model to its JSON representation. */
+    toJSON(): ContextRealityModelProps;
+    /** Returns true if [[name]] and [[url]] match the specified name and url. */
+    matchesNameAndUrl(name: string, url: string): boolean;
+}
+/** An object that can store the JSON representation of a list of [[ContextRealityModel]]s.
+ * @see [[ContextRealityModels]].
+ * @see [[DisplayStyleSettingsProps.contextRealityModels]].
+ * @public
+ * @extensions
+ */
+export interface ContextRealityModelsContainer {
+    /** The list of reality models. */
+    contextRealityModels?: ContextRealityModelProps[];
+}
+/** 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.
+ * The list is automatically synchronized with the underlying JSON representation provided by the input [[ContextRealityModelsContainer]].
+ * @see [this interactive example](https://www.itwinjs.org/sample-showcase/?group=Viewer&sample=reality-data-sample)
+ * @see [[DisplayStyleSettings.contextRealityModels]].
+ * @public
+ */
+export declare class ContextRealityModels {
+    private readonly _container;
+    private readonly _createModel;
+    private readonly _models;
+    /** Event dispatched just before [[ContextRealityModel.planarClipMaskSettings]] is modified for one of the reality models. */
+    readonly onPlanarClipMaskChanged: BeEvent<(model: ContextRealityModel, newSettings: PlanarClipMaskSettings | undefined) => void>;
+    /** Event dispatched just before [[ContextRealityModel.appearanceOverrides]] is modified for one of the reality models. */
+    readonly onAppearanceOverridesChanged: BeEvent<(model: ContextRealityModel, newOverrides: FeatureAppearance | undefined) => void>;
+    /** Event dispatched just before [[ContextRealityModel.displaySettings]] is modified for one of the reality models.
+     * @beta
+     */
+    readonly onDisplaySettingsChanged: BeEvent<(model: ContextRealityModel, newSettings: RealityModelDisplaySettings) => void>;
+    /** Event dispatched when a model is [[add]]ed, [[delete]]d, [[replace]]d, or [[update]]d. */
+    readonly onChanged: BeEvent<(previousModel: ContextRealityModel | undefined, newModel: ContextRealityModel | undefined) => void>;
+    /** Construct a new list of reality models from its JSON representation. THe list will be initialized from `container.classifiers` and that JSON representation
+     * 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
+     * to become out of sync with the JSON representation.
+     * @param container The object that holds the JSON representation of the list.
+     * @param createContextRealityModel Optional function used to instantiate ContextRealityModels added to the list.
+     */
+    constructor(container: ContextRealityModelsContainer, createContextRealityModel?: (props: ContextRealityModelProps) => ContextRealityModel);
+    /** The read-only list of reality models. */
+    get models(): ReadonlyArray<ContextRealityModel>;
+    /** Append a new reality model to the list.
+     * @param The JSON representation of the reality model.
+     * @returns the newly-added reality model.
+     */
+    add(props: ContextRealityModelProps): ContextRealityModel;
+    /** Remove the specified reality model from the list.
+     * @param model The reality model to remove.
+     * @returns true if the model was removed, or false if the model was not present in the list.
+     */
+    delete(model: ContextRealityModel): boolean;
+    /** Remove all reality models from the list. */
+    clear(): void;
+    /** Replace a reality model in the list.
+     * @param toReplace The reality model to be replaced.
+     * @param replaceWith The JSON representation of the replacement reality model.
+     * @returns the newly-created reality model that replaced `toReplace`.
+     * @throws Error if `toReplace` is not present in the list
+     * @note The replacement occupies the same index in the list as `toReplace` did.
+     */
+    replace(toReplace: ContextRealityModel, replaceWith: ContextRealityModelProps): ContextRealityModel;
+    /** Change selected properties of a reality model.
+     * @param toUpdate The reality model whose properties are to be modified.
+     * @param updateProps The properties to change.
+     * @returns The updated reality model, identical to `toUpdate` except for properties explicitly supplied by `updateProps`.
+     * @throws Error if `toUpdate` is not present in the list.
+     */
+    update(toUpdate: ContextRealityModel, updateProps: Partial<ContextRealityModelProps>): ContextRealityModel;
+    private createModel;
+    private dropEventListeners;
+    private handlePlanarClipMaskChanged;
+    private handleAppearanceOverridesChanged;
+    private handleDisplaySettingsChanged;
+}
 //# sourceMappingURL=ContextRealityModel.d.ts.map

package/lib/esm/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;;GAEG;AACH,yBAAiB,iBAAiB,CAAC;IACjC;;;;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,eAAe,CAAC,WAAW,EAAE,oBAAoB,GAAG,MAAM,CAEzE;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;;;GAGG;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,iDAAiD;IACjD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sGAAsG;IACtG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4GAA4G;IAC5G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACvC,kDAAkD;IAClD,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC,uDAAuD;IACvD,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,SAAgB,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnD,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;;;;;GAKG;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;AACrF,OAAO,EAAE,wBAAwB,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEtG;;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,CAAC;IACjC;;;;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,eAAe,CAAC,WAAW,EAAE,oBAAoB,GAAG,MAAM,CAEzE;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;;;GAGG;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,iDAAiD;IACjD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sGAAsG;IACtG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4GAA4G;IAC5G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACvC,kDAAkD;IAClD,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC,uDAAuD;IACvD,mBAAmB,CAAC,EAAE,sBAAsB,CAAC;IAC7C;;OAEG;IACH,eAAe,CAAC,EAAE,wBAAwB,CAAC;CAC5C;AAED,cAAc;AACd,yBAAiB,wBAAwB,CAAC;IACxC,sCAAsC;IACtC,SAAgB,KAAK,CAAC,KAAK,EAAE,wBAAwB,4BAuCpD;CACF;AAED;;;;;GAKG;AACH,qBAAa,mBAAmB;IAC9B,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAC;IACpD;;;;OAIG;IACH,SAAgB,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnD,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,YAAY;IACZ,SAAS,CAAC,gBAAgB,EAAE,2BAA2B,CAAC;IACxD,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;IAChJ;;OAEG;IACH,SAAgB,wBAAwB,wBAA6B,2BAA2B,SAAS,mBAAmB,KAAK,IAAI,EAAI;IAEzI;;OAEG;gBACgB,KAAK,EAAE,wBAAwB;IAkBlD,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;;OAEG;IACH,IAAW,eAAe,IAAI,2BAA2B,CAExD;IACD,IAAW,eAAe,CAAC,QAAQ,EAAE,2BAA2B,EAI/D;IAED,qDAAqD;IAC9C,MAAM,IAAI,wBAAwB;IAIzC,6EAA6E;IACtE,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;CAG7D;AAED;;;;;GAKG;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;;OAEG;IACH,SAAgB,wBAAwB,kBAAuB,mBAAmB,eAAe,2BAA2B,KAAK,IAAI,EAAI;IACzI,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;IAWnB,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,2BAA2B;IAInC,OAAO,CAAC,gCAAgC;IAIxC,OAAO,CAAC,4BAA4B;CAGrC"}