ArcGISSceneLayer class final
A layer to visualize data from an ArcGIS scene service or a local scene package.
Scene layers display content from a scene service or a scene package.
ArcGISSceneLayer optimized to displaying large amounts of data in an ArcGISSceneViewController. It can display data published as scene services, scene layer packages (.slpk), and scene layers in mobile scene packages (.mspk).
ArcGISSceneLayer supports:
- 3D Object (e.g. buildings)
- Integrated mesh (e.g. buildings, trees, and elevation) (see IntegratedMeshLayer)
- Point features (e.g. trees)
The scene layer complies with the Indexed 3D Scene layer (I3S) format. It is an open 3D content delivery format used to disseminate 3D GIS data to mobile, web, and desktop clients.
Functional characteristics
- 3D object — 3D object scene layers contain objects explicitly modeled in three dimensions and are used to represent objects such as buildings. These features have attributes and can be identified. See the 3D Object Scene Layer for more information.
- Integrated mesh — 3D mesh data is typically captured by an automated process for constructing 3D objects out of large sets of overlapping imagery. The result integrates the original input image information as a textured mesh including 3D objects, such as buildings and trees, and elevation information. Integrated mesh scene layers are often created for citywide 3D mapping. They can represent something as small as a single building or as large as a city or state. They are often assembled automatically from imagery collected by a drone; they cannot be restyled because there is no underlying feature data. See the Integrated Mesh Scene Layer for more information.
- Point features — To ensure fast visualization, cached scene layers are used to display large amounts of 3D point data about individual features, such as all the trees in a city. Point scene layers have features that can be identified and that have attributes that may be cached or available from an associated feature layer. The display of point scene layers is automatically thinned to improve performance and visibility at smaller scales and longer distances. Automatic thinning means that not all features are displayed at small scales; as you zoom in, additional features are displayed. See the Point scene layer for more information.
Point scene layers are generated from point feature layers. Point scene layers can be generated by ArcGIS Pro and hosted as a scene service or scene layer package.
Note: When publishing a scene from ArcGIS Pro (sharing as a web scene) any point feature layers in the 3D Layers section of the contents pane will be published as a scene service. The scene service will be referenced within the web scene.
Performance characteristics
For a scene layer, the rendering of 3D data is based on the current level of detail (LOD), which is determined by the distance from the camera. Each object in a 3D object service is represented differently at various LODs determined by the camera distance. As the camera distance changes in the scene, objects will be displayed appropriately for the current LOD. This results in good client performance and low memory usage, at the expense of frequently loading and unloading objects.
- Inheritance
- Implemented types
Constructors
- ArcGISSceneLayer.withItem(Item item)
-
Creates an ArcGIS scene layer from a PortalItem representing an ArcGIS
scene service.
factory
- ArcGISSceneLayer.withUri(Uri uri)
-
Creates an ArcGIS scene layer from the specified URI.
factory
Properties
- altitudeOffset ↔ double
-
The layer altitude offset.
getter/setter pair
- apiKey ↔ String
-
The API key allows your app to access ArcGIS location services and private
portal items.
getter/setter pairoverride
- 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
- dataType → SceneLayerDataType
-
The type of data contained in an ArcGIS scene layer, such as integrated
mesh or 3D scene objects.
no setter
- description ↔ String
-
The description for the layer.
getter/setter pairinherited
- featureTable → FeatureTable?
-
The feature table associated with this layer.
no setter
- 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
- labelsEnabled ↔ bool
-
True if labels should be displayed, false otherwise.
getter/setter pair
- 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
-
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
- polygonFilter ↔ SceneLayerPolygonFilter?
-
A filter applied to a feature-based ArcGISSceneLayer to include or
exclude features within the polygons.
getter/setter pair
- renderer ↔ Renderer?
-
Specifies how the 3D objects or point features in the layer are
symbolized.
getter/setter pair
- 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
- surfacePlacement ↔ SurfacePlacement
-
The surface placement specifies how the layer's data should be placed in
relation to the scene's surface.
getter/setter pair
- uri → Uri?
-
The URL of an ArcGIS scene service or the path to a local scene layer
package (.slpk) file.
no setter
Methods
-
cancelLoad(
) → void -
Cancels loading metadata for the object.
inherited
-
clearSelection(
) → void - Clears all selected features.
-
clone(
) → Layer -
Clones this instance of the layer and its members.
inherited
-
fetchLegendInfos(
) → Future< List< LegendInfo> > -
Fetches the list of legend info.
inherited
-
getSelectedFeatures(
) → Future< FeatureQueryResult> - Returns a collection of the currently selected features.
-
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
-
resetFeaturesVisible(
) → void - Reset the visibility of all features back to their original state.
-
retryLoad(
) → Future< void> -
Loads or retries loading metadata for the object asynchronously.
inherited
-
selectFeature(
Feature feature) → void - Selects the given feature and adds it to the current list of selected features.
-
selectFeatures(
List< Feature> features) → void - Selects the features in the collection and adds them to the current collection of selected features.
-
setFeaturesVisible(
{required List< Feature> features, required bool visible}) → void - Sets the visibility of all features in the collection.
-
setFeatureVisible(
{required Feature feature, required bool visible}) → void - Sets the visibility of the given feature.
-
toString(
) → String -
A string representation of this object.
inherited
-
unselectFeature(
Feature feature) → void - Unselects the given feature and removes it from the current collection of selected features.
-
unselectFeatures(
List< Feature> features) → void - Unselects the features in the given collection and removes them from the current collection of selected features.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited