Surface QML Type
The surface contains elevation sources and defines a surface upon which layers and overlays can be draped. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
- List of all members, including inherited members
- Surface is part of QML Type List.
Properties
- backgroundGrid : BackgroundGrid
- elevationExaggeration : real
- elevationSources : ElevationSourceListModel
- enabled : bool
- loadError : Error
- loadStatus : Enums.LoadStatus
- locationToElevationResult : double
- locationToElevationStatus : Enums.TaskStatus
- name : string
- navigationConstraint : Enums.NavigationConstraint
- opacity : real
Signals
- backgroundGridChanged()
- elevationExaggerationChanged()
- enabledChanged()
- loadErrorChanged()
- loadStatusChanged()
- locationToElevationStatusChanged()
- nameChanged()
- navigationConstraintChanged()
- opacityChanged()
Methods
- void cancelLoad()
- bool cancelTask(string taskId)
- void load()
- string locationToElevation(Point location)
- void retryLoad()
Detailed Description
The surface is used to represent the ground in a scene. It is comprised of a collection of elevation sources (ElevationSource) which are combined in the scene to generate the surface.
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
| Type | Default Property |
|---|---|
| ElevationSource | elevationSources (appends to model) |
| BackgroundGrid | backgroundGrid (since Esri.ArcGISRuntime 100.1) |
The QML type Surface contains a list of elevation sources, and defines a surface upon which layers and overlays can be draped. The order of the elevation sources determines how the elevations are blended together for each level of detail.
See also Loadable and Cancelable.
Property Documentation
[default, since Esri.ArcGISRuntime 100.1] backgroundGrid : BackgroundGrid |
Grid and color settings to render the background grid of this surface.
The background grid is visible when no data is draped on the surface.
This property was introduced in Esri.ArcGISRuntime 100.1.
elevationExaggeration : real |
The elevation exaggeration for the surface.
The altitude values of the surface data are multiplied by the exaggeration value. The default value is 1.0, indicating no exaggeration.
[default] elevationSources : ElevationSourceListModel |
Returns the list of elevation sources for the surface (read-only).
Elevation sources are an ordered collection of ElevationSource data that are combined to generate elevation values for the surface. The order of the elevation sources in the collection indicate which elevation has priority when the sources are spatially coincident. The collection is specific to a surface so you cannot reuse an elevation source collection coming from another Surface.
See also Surface.
enabled : bool |
true if the surface is enabled, false otherwise.
This value indicates if the surface is enabled and is rendered. If true, the surface's elevation sources are only used in the calculation of the surface if their ElevationSource::enabled is also true.
[read-only] loadError : Error |
Returns the load error (read-only).
Note: load errors are also reported on the error property and emit the errorChanged signal.
See also Loadable.
[read-only] loadStatus : Enums.LoadStatus |
Returns an enumeration value for the current load status of the surface (read-only).
See also Loadable and Enums.LoadStatus.
[read-only] locationToElevationResult : double |
The elevation calculated by locationToElevation method for the specified map point.
The elevation is expressed in meters above sea level.
[read-only] locationToElevationStatus : Enums.TaskStatus |
Returns the status of the latest asynchronous task to calculate the elevation of a location (read-only).
The task is started using locationToElevation.
See also Enums.TaskStatus.
name : string |
The name of the surface.
[since Esri.ArcGISRuntime 100.5] navigationConstraint : Enums.NavigationConstraint |
The type of navigation constraint of the surface.
This property determines whether the camera altitude is affected by the elevation at the location of the camera. You can restrict the camera to stay above the ground or allow it to move below the surface. The default value is Enums.NavigationConstraintStayAbove.
This property was introduced in Esri.ArcGISRuntime 100.5.
[since Esri.ArcGISRuntime 100.5] opacity : real |
The opacity applied to the surface.
The opacity value of all layers in the basemap, associated with this surface, and the backgroundGrid are multiplied by this opacity value. The value can be between 0 and 1.0, where 0 is transparent and 1.0 is solid or opaque.
You can adjust this ground surface opacity property to see through the ground. Changing this property also changes the transparency of the basemap. (Draped operational layers are not affected by this property.) Valid values are from 0.0 (full transparency) to 1.0 (full opacity).
The opacity affects all base layers and the grid color:
- If an individual base layer has 50% opacity and the surface has 50% opacity, the effect will be multiplicative, i.e. the base layer will appear to have 25% opacity.
- If the grid color has an alpha value of 50% and the surface has 50% opacity, the effect on the grid will also be multiplicative.
The default value is 1.0.
This property was introduced in Esri.ArcGISRuntime 100.5.
Signal Documentation
|
Emitted when the backgroundGrid property changes.
Note: The corresponding handler is onBackgroundGridChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
elevationExaggerationChanged() |
Emitted when the elevationExaggeration property of the surface changes.
Note: The corresponding handler is onElevationExaggerationChanged.
enabledChanged() |
Emitted when the enabled property of the surface changes.
Note: The corresponding handler is onEnabledChanged.
loadErrorChanged() |
loadStatusChanged() |
Emitted when the loadStatus property of the surface changes.
Note: The corresponding handler is onLoadStatusChanged.
See also Loadable.
locationToElevationStatusChanged() |
Emitted when the locationToElevationStatus property of the surface changes.
Note: The corresponding handler is onLocationToElevationStatusChanged.
nameChanged() |
Emitted when the name property of the surface changes.
Note: The corresponding handler is onNameChanged.
|
Emitted when the navigationConstraint property changes.
Note: The corresponding handler is onNavigationConstraintChanged.
This signal was introduced in Esri.ArcGISRuntime 100.5.
|
Emitted when the opacity property changes.
Note: The corresponding handler is onOpacityChanged.
This signal was introduced in Esri.ArcGISRuntime 100.5.
Method Documentation
void cancelLoad() |
See also Loadable.
bool cancelTask(string taskId) |
Cancel the task with the ID taskId.
Returns false if the task cannot be canceled or there is no task with the specified id taskId.
See also Cancelable.
void load() |
See also Loadable.
string locationToElevation(Point location) |
Gets the elevation (in meters) for the specified location on the surface using an asynchronous task.
Before calling this method, check the locationToElevationStatus property to see whether a locationToElevation task is already in progress. If so, then this method cannot start a new task.
Returns a task ID that can be used to cancel the task.
See also Cancelable.
void retryLoad() |
See also Loadable.