Class Surface

Surface contains elevation sources and defines a surface upon which layers and overlays can be draped.

Inheritance

System.Object

Surface

Implements

ILoadable

System.ComponentModel.INotifyPropertyChanged

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Esri.ArcGISRuntime.Mapping

Assembly: Esri.ArcGISRuntime.dll

Syntax

public class Surface : ILoadable, INotifyPropertyChanged

Remarks

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.

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 (null if loading was successful).
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
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
Loaded	Occurs when the surface is loaded.
LoadStatusChanged	Occurs when the surface LoadStatus property is changed.
PropertyChanged	Occurs when a property value changes.

Applies to

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.0 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.15
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

Relevant samples

Add an integrated mesh layer: View an integrated mesh layer from a scene service.

Change atmosphere effect: Changes the appearance of the atmosphere in a scene.

Choose camera controller: Control the behavior of the camera in a scene.