GetZs(Geometry) Method

In This Topic

Obtains a geometry that is similar to the given input geometry, where some or all Z values are populated from the layer. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Function GetZs( _
   ByVal geometry As Geometry _
) As SurfaceZsResult

public SurfaceZsResult GetZs( 
   Geometry geometry
)

Parameters

geometry: the input geometry

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.
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Remarks

If the layer has no data at a particular input geometry point, then the corresponding output geometry point Z will be set to the value specified in SurfaceZsMissingHandler.DefaultOutputZ.

Use CanGetZs to determine if the layer can be used as an elevation source before calling this function.

Example

Get Z values from a layer

{
    TinLayer tinLayer = map.GetLayersAsFlattenedList().OfType<TinLayer>().FirstOrDefault();
    //Note: This method must be called on the MCT
    MapPoint mapPoint = MapView.Active.Map.CalculateFullExtent().Center; //Any Map Point
    Polyline polyline = PolylineBuilderEx.CreatePolyline(mapView.Extent); //Any Polyline

    if (tinLayer.CanGetZs())
    {
        // get z value for a mapPoint
        var zResult = tinLayer.GetZs(mapPoint);
        if (zResult.Status == SurfaceZsResultStatus.Ok)
        {
            // cast to a mapPoint
            var mapPointZ = zResult.Geometry as MapPoint;
            var z = mapPointZ.Z;
        }

        // get z values for a polyline
        zResult = tinLayer.GetZs(polyline);
        if (zResult.Status == SurfaceZsResultStatus.Ok)
        {
            // cast to a mapPoint
            var polylineZ = zResult.Geometry as Polyline;
        }
    }
}

Get Z values from a TIN Layer

{
  // Note: Needs QueuedTask to run
  {
    if (tinLayer.CanGetZs())
    {
      // get z value for a mapPoint
      var zResult = tinLayer.GetZs(mapPoint);
      if (zResult.Status == SurfaceZsResultStatus.Ok)
      {
        // cast to a mapPoint
        var mapPointZ = zResult.Geometry as MapPoint;
        var z = mapPointZ.Z;
      }

      // get z values for a polyline
      zResult = tinLayer.GetZs(polyline);
      if (zResult.Status == SurfaceZsResultStatus.Ok)
      {
        // cast to a Polyline
        var polylineZ = zResult.Geometry as Polyline;
      }
    }
  }
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.4 or higher.

Reference

Layer Class
Layer Members
Overload List

Send feedback