Class Surface
Surface contains elevation sources and defines a surface upon which layers and overlays can be draped.
Namespace: Esri.ArcGISRuntime.Mapping
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class Surface : ILoadable, INotifyPropertyChangedRemarks
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.
Surface provides methods for retrieving elevation values at one or more locations. Use ApplyElevationAsync(Geometry, CancellationToken) to efficiently determine the elevation for all vertices in a geometry. Use GetElevationAsync(MapPoint) when you only need the elevation for a single point.
Constructors
| Name | Description |
|---|---|
| Surface() | Initializes a new instance of the Surface class. |
Properties
| Name | Description |
|---|---|
| BackgroundGrid | Gets or sets the grid and color settings to render the background grid of this surface. |
| ElevationExaggeration | Gets or sets the elevation exaggeration for the surface. |
| ElevationSources | Gets the collection of elevation sources in the surface. |
| IsEnabled | Gets or sets a value indicating whether this surface is enabled and should be rendered. |
| LoadError | Gets the load error of the surface ( |
| LoadStatus | Gets the load status of the surface. |
| Name | Gets or sets the name for the surface. |
| NavigationConstraint | Gets or sets the type of navigation constraint of the surface. |
| Opacity | Gets or sets the opacity applied to the surface. |
Methods
| Name | Description |
|---|---|
| ApplyElevationAsync(Geometry, CancellationToken) | Gets and applies an elevation (in meters) for each point in the input geometry. |
| CancelLoad() | Cancels an ongoing load. |
| GetElevationAsync(MapPoint) | Gets the elevation (in meters) for the specified location on the surface. |
| LoadAsync() | Initiates loading of the surface. |
| RetryLoadAsync() | Retry loading the surface. |
Events
| Name | Description |
|---|---|
| LoadStatusChanged | Occurs when the surface LoadStatus property is changed. |
| Loaded | Occurs when the surface is loaded. |
| PropertyChanged | Occurs when a property value changes. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.8 |
| .NET | 100.13 - 300.0 |
| .NET Windows | 100.13 - 300.0 |
| .NET Android | 200.0 - 300.0 |
| .NET iOS | 200.0 - 300.0 |
| .NET Framework | 100.0 - 200.8 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.8 |