Ogc3DTilesLayer class final
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 OGC 3D Tiles specification.
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.
Constructors
- Ogc3DTilesLayer.withPortalItem(PortalItem item)
-
Creates an OGC3DTilesLayer object with a portal item.
factory
- Ogc3DTilesLayer.withUri(Uri uri)
-
Creates an OGC3DTilesLayer object.
factory
Properties
- altitudeOffset ↔ double
-
The layer altitude offset.
getter/setter pair
- attribution → String
-
The attribution text for the layer.
no setterinherited
- canChangeVisibility → bool
-
A flag indicating whether the layer content's visibility can be changed.
no setterinherited
-
customParameters
→ Map<
String, String> -
The dictionary of custom parameters (such as an API key) to be sent with
the requests issued by this layer.
no setter
- description ↔ String
-
The description for the layer.
getter/setter pairinherited
- fullExtent → Envelope?
-
The full extent of this layer, which is the extent where all layer data is
contained.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- id ↔ String
-
The unique identifying string for the layer, as specified in a map or
scene.
getter/setter pairinherited
- isIdentifyEnabled → bool
-
True if the layer supports identify, false otherwise.
no setterinherited
- isVisible ↔ bool
-
The layer content's visibility.
getter/setter pairinherited
- item → Item?
-
The item the layer has been created from.
no setterinherited
- loadError → ArcGISException?
-
The load error.
no setterinherited
- loadStatus → LoadStatus
-
The load status.
no setterinherited
- maxScale ↔ double
-
The maximum scale for the layer.
getter/setter pairinherited
- minScale ↔ double
-
The minimum scale for the layer.
getter/setter pairinherited
- name ↔ String
-
The layer content's name.
getter/setter pairinherited
- occludeSurface ↔ bool
-
True to hide the surface if it intersects the layer, false otherwise.
getter/setter pair
-
onLoadStatusChanged
→ Stream<
LoadStatus> -
A stream that reports changes to the LoadStatus.
no setterinherited
-
onSubLayerContentChanged
→ Stream<
List< LayerContent> > -
Callback invoked when the sublayer content of the layer content have
changed.
no setterinherited
-
onVisibilityChanged
→ Stream<
bool> -
Callback invoked when the visibility of the layer changes.
no setterinherited
- opacity ↔ double
-
The opacity for the layer.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showInLegend ↔ bool
-
A flag indicating whether the layer content participates in the legend.
getter/setter pairinherited
- spatialReference → SpatialReference?
-
The spatial reference of the layer.
no setterinherited
-
subLayerContents
→ List<
LayerContent> -
The sub layer contents of a layer content.
no setterinherited
- uri → Uri?
-
The URI of the layer.
no setter
Methods
-
cancelLoad(
) → void -
Cancels loading metadata for the object.
inherited
-
clone(
) → Layer -
Clones this instance of the layer and its members.
inherited
-
fetchLegendInfos(
) → Future< List< LegendInfo> > -
Fetches the list of legend info.
inherited
-
isVisibleAtScale(
double scale) → bool -
Returns the layer content's effective visibility at the specified scale.
inherited
-
load(
) → Future< void> -
Loads the metadata for the object asynchronously.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
retryLoad(
) → Future< void> -
Loads or retries loading metadata for the object asynchronously.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited