GetZsFromSurfaceAsync(Geometry,ElevationSurfaceLayer,SurfaceZsMissingHandler,CancellationToken) Method

In This Topic

Obtains a geometry that is similar to the given input geometry, where some or all Z values are populated from an Elevation Surface identified by the given surface name.

Syntax

C#
Visual Basic (Declaration)

public Task<SurfaceZsResult> GetZsFromSurfaceAsync( 
   Geometry geometry,
   ElevationSurfaceLayer surfaceLayer,
   SurfaceZsMissingHandler missingHandler,
   CancellationToken cancellationToken
)

Public Overloads Function GetZsFromSurfaceAsync( _
   ByVal geometry As Geometry, _
   ByVal surfaceLayer As ElevationSurfaceLayer, _
   ByVal missingHandler As SurfaceZsMissingHandler, _
   ByVal cancellationToken As CancellationToken _
) As Task(Of SurfaceZsResult)

Parameters

geometry: the input geometry
surfaceLayer: identifies the surface to be used - if specified null, then the default Ground Surface will be used
missingHandler: provides options to handle missing Zs in the surface
cancellationToken: provides a way to cancel the operation

Return Value

a result that contains a status , plus an output geometry only if the status is favorable

Exceptions

Exception	Description
System.ArgumentNullException	the input geometry is null
System.ArgumentException	this Map does not have a surface named surfaceName
System.ArgumentException	this Map does not have a default Ground Surface (when surfaceName is specified null)
System.InvalidOperationException	this Map does not have a CIM definition
System.InvalidOperationException	this Map does not have any surfaces

Remarks

The missingHandler will be used to determine what to do if the surface has no data at a particular input geometry point. The corresponding output geometry point or vertex Z will be set to the value specified in the provided missingHandler.OutputZ property. The missingHandler.OnlyProcessMissingZs parameter can be used to overwrite all Z values or only those that are designated as missing based on a comparison the InputZ value.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Map Class
Map Members
Overload List

Send feedback