ContextRealityModelState Class
A ContextRealityModel attached to a DisplayStyleState supplying a TileTreeReference used to draw the reality model in a Viewport.
@see - DisplayStyleSettings.contextRealityModels.
Extends
Inherited methods
Name | Inherited from | Description |
---|---|---|
matchesNameAndUrl(name: string, url: string): boolean Inherited | ContextRealityModel | Returns true if name and url match the specified name and url. |
toJSON(): ContextRealityModelProps Inherited | ContextRealityModel | Convert this model to its JSON representation. |
Properties
Name | Type | Description | |
---|---|---|---|
classifiers Accessor ReadOnly | SpatialClassifiersState | The set of available ActiveSpatialClassifiers that can be used to classify the reality model. | |
iModel Readonly | IModelConnection | The iModel with which the reality model is associated. | |
isGlobal Accessor ReadOnly | boolean | Whether the reality model spans the entire globe ellipsoid. | |
modelId Accessor ReadOnly | undefined | string | The transient Id assigned to this reality model at run-time. | |
rdSourceKey Readonly | RealityDataSourceKey | The reality data source key with which the reality model is associated. | |
treeRef Accessor ReadOnly | TileTreeReference | The tile tree reference responsible for drawing the reality model into a Viewport. |
Inherited properties
Name | Type | Inherited from | Description |
---|---|---|---|
_appearanceOverrides Protected Inherited | FeatureAppearance | undefined | ContextRealityModel | |
_displaySettings Protected Inherited | RealityModelDisplaySettings | ContextRealityModel | |
_planarClipMask Protected Inherited | PlanarClipMaskSettings | undefined | ContextRealityModel | |
appearanceOverrides Accessor Inherited | undefined | FeatureAppearance | ContextRealityModel | Overrides applied to the appearance of the reality model. Only the rgb, transparency, nonLocatable, and emphasized properties are applicable - the rest are ignored. |
description Readonly Inherited | string | ContextRealityModel | A description of the model suitable for display in a user interface. |
displaySettings Accessor Inherited | RealityModelDisplaySettings | ContextRealityModel | Settings controlling how this reality model is displayed in a Viewport. |
invisible Accessor Inherited | boolean | ContextRealityModel | If true, reality model is not drawn. |
name Readonly Inherited | string | ContextRealityModel | A name suitable for display in a user interface. |
onAppearanceOverridesChanged Readonly Inherited | BeEvent<(newOverrides: FeatureAppearance, model: ContextRealityModel) => void> | ContextRealityModel | Event dispatched just before assignment to ContextRealityModel.appearanceOverrides. |
onDisplaySettingsChanged Readonly Inherited | BeEvent<(newSettings: RealityModelDisplaySettings, model: ContextRealityModel) => void> | ContextRealityModel | Event dispatched just before assignment to ContextRealityModel.displaySettings. |
onInvisibleChanged Readonly Inherited | BeEvent<(invisible: boolean, model: ContextRealityModel) => void> | ContextRealityModel | Event dispatched just before a model become invisible |
onPlanarClipMaskChanged Readonly Inherited | BeEvent<(newSettings: PlanarClipMaskSettings, model: ContextRealityModel) => void> | ContextRealityModel | Event dispatched just before assignment to ContextRealityModel.planarClipMaskSettings. |
planarClipMaskSettings Accessor Inherited | undefined | PlanarClipMaskSettings | ContextRealityModel | Optionally describes how the geometry of the reality model can be masked by other models. |
realityDataId Readonly Inherited | string | undefined | ContextRealityModel | An optional identifier that, if present, can be used to elide a request to the reality data service. |
url Readonly Inherited | string | ContextRealityModel | The URL that supplies the 3d tiles for displaying the reality model. |
Defined in
Last Updated: 17 December, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.