arcgis-maps-kotlin/com.arcgismaps.analysis.visibility/ViewshedParameters

ViewshedParameters

class ViewshedParameters

Parameters that control viewshed analysis for a ViewshedFunction.

Since

300.0.0

Constructors

ViewshedParameters

constructor()

Creates a ViewshedParameters.

Properties

elevationSamplingInterval

var elevationSamplingInterval: Double?

The interval at which the elevation source is sampled, in the horizontal units of the ViewshedFunction elevation extent.

fieldOfView

var fieldOfView: Double

The field of view of the observer, in degrees. The angle must be between 0 and 360 degrees and is split evenly on either side of ViewshedParameters.heading.

heading

var heading: Double

The direction that the observer is facing, in degrees. The value defines the angle in degrees clockwise relative to the Y axis of the spatial reference.

maxRadius

var maxRadius: Double?

The maximum radius for the viewshed calculation.

observerHeightOrigin

var observerHeightOrigin: HeightOrigin

Specifies how the observer position height should be interpreted. The default value is HeightOrigin.Relative.

observerPosition

var observerPosition: Point?

The observer position in 3D space. The value of Point.z is the observer height.

targetHeight

var targetHeight: Double

The height of the target, in the same unit as the elevation surface. Target height is added to all elevation values of the surface to determine visibility at each location. The default value is 0.

targetHeightOrigin

var targetHeightOrigin: HeightOrigin

Specifies how the target height should be interpreted. The default value is HeightOrigin.Relative.

Functions

clone

fun clone(): ViewshedParameters

Clone the ViewshedParameters.