Ogc3DTilesLayer

A layer to visualize 3D tiles data that conforms to the OGC 3D Tiles specification. The 3D Tiles Open Geospatial Consortium (OGC) specification defines a spatial data structure and a set of tile formats designed for streaming and rendering 3D geospatial content. A 3D Tiles data set, known as a tileset, defines one or more tile formats organized into a hierarchical spatial data structure. For more information, see the https://www.ogc.org/standard/3DTiles.

An Ogc3DTilesLayer can display data from a public service, a tileset (.json), or a 3D tiles archive format (.3tz). If a service requires an API key, use the Ogc3DTilesLayer.customParameters property to populate the key and value.

Functional characteristics

3D Tiles datasets can contain many types of data, which can be of integrated mesh or 3D object type. An integrated mesh represents the continuous meshes with textures and replaces the surface. If a dataset needs to be drawn as an integrated mesh, the Ogc3DTilesLayer.occludeSurface property must be true. This will cause the layer to draw on top of the surface.

3D Tiles have a default horizontal coordinate system of World Geodetic System 1984 (WGS84) and a vertical coordinate system of WGS84, which defines height based on an ellipsoidal model. However, an ArcGISScene uses the Earth Gravitational Model (EGM) or "gravity-related geoid" vertical coordinate system. Therefore, the z-values of Ogc3DTilesLayer objects are projected and rendered at the resolution of EGM96 within the scene. If you would like to use higher precision projection engine data such as EGM 2008, you can provide the path to the directory containing projection engine data by setting the TransformationCatalog.projectionEngineDirectory property.

Performance characteristics

For an Ogc3DTilesLayer, the rendering of 3D data is based on the current level of detail (LOD), which is determined by the distance from the current viewpoint camera. Each object in the 3D tiles layer represented differently at various LODs determined by the camera distance. As the camera distance changes in the scene, objects are displayed appropriately for the current LOD. This results in optimal client performance, and avoids frequently loading and unloading objects.

OGC3DTilesLayer supports:

  • Batched 3D Model (b3dm) data representing heterogeneous 3D models like textured terrains and surfaces, buildings and so on.

Since

200.4.0

See also

Constructors

Link copied to clipboard
constructor(item: PortalItem)

Creates an OGC3DTilesLayer object with a portal item.

constructor(uri: String)

Creates an OGC3DTilesLayer object.

Properties

Link copied to clipboard

The layer altitude offset. This raises or lowers all features in the layer by the given offset.

Link copied to clipboard

The dictionary of custom parameters (such as an API key) to be sent with the requests issued by this layer.

Link copied to clipboard

True to hide the surface if it intersects the layer, false otherwise. The default value is true.

Link copied to clipboard
val uri: String?

The URI of the layer.

Inherited properties

Link copied to clipboard

The attribution text for the layer.

Link copied to clipboard
open override val canChangeVisibility: Boolean

A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

Link copied to clipboard

The description for the layer.

Link copied to clipboard

The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from its FeatureTable.extent.

Link copied to clipboard
var id: String

The unique identifying string for the layer, as specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.

Link copied to clipboard

True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.

Link copied to clipboard
open override var isVisible: Boolean

The layer content's visibility. The layer content visibility. Will return false if an error occurs.

Link copied to clipboard
val item: Item?

The item the layer has been created from.

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard

The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.

Link copied to clipboard

The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.

Link copied to clipboard
open override var name: String

The name of this layer.

Link copied to clipboard

The opacity for the layer. The opacity of this layer as a value between 0 (fully transparent) and 1 (fully opaque). The default opacity value is 1.

Link copied to clipboard
open override var showInLegend: Boolean

A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.

Link copied to clipboard

The spatial reference of the layer.

Link copied to clipboard
open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

Link copied to clipboard
val visibilityChanged: SharedFlow<Boolean>

Callback invoked when the visibility of the layer changes.

Functions

Link copied to clipboard
open override fun clone(): Ogc3DTilesLayer

Clones the Ogc3DTilesLayer.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun isVisibleAtScale(scale: Double): Boolean

Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.