ViewshedParameters Class

Member Function Documentation

[explicit] ViewshedParameters::ViewshedParameters(QObject *parent = nullptr)

Creates a ViewshedParameters.

• parent - The optional parent QObject.

[override virtual noexcept] ViewshedParameters::~ViewshedParameters()

Destructor.

Esri::ArcGISRuntime::ViewshedParameters *ViewshedParameters::clone() const

Returns clone the ViewshedParameters.

std::optional<double> ViewshedParameters::elevationSamplingInterval() const

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

A viewshed is evaluated by horizontally sampling the ViewshedFunction elevation surface at discrete intervals. This parameter indicates the size of the sampling interval in the horizontal unit of the elevation surface SpatialReference.

Decreasing the interval increases the frequency at which the elevation surface is sampled, resulting in a higher fidelity, and more accurate, viewshed. Use a resolution of std::nullopt to sample the elevation surface at its full resolution for the highest fidelity viewshed.

Increasing the interval means the elevation surface is sampled at coarser intervals, giving a lower fidelity, and more approximate, viewshed.

A small sampling interval is computationally more expensive and is slower to produce a result compared to using a larger sampling interval.

The default value is std::nullopt, which samples the elevation surface at the full resolution of the data.

See also setElevationSamplingInterval(), ViewshedFunction, ContinuousField::extent, Geometry::spatialReference, and SpatialReference::unit.

double ViewshedParameters::fieldOfView() const

Returns 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 heading.

A value of 360 degrees means that the observer can see in all directions.

The default value is 360.

See also setFieldOfView().

double ViewshedParameters::heading() const

Returns 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.

The default value is 0.

See also setHeading() and fieldOfView.

std::optional<double> ViewshedParameters::maxRadius() const

Returns the maximum radius for the viewshed calculation.

It must be a positive value in the horizontal unit of the ContinuousField elevation surface spatial reference that was used to create the ViewshedFunction.

Set to std::nullopt to calculate the viewshed for the full extent.

The default value is 10000.

See also setMaxRadius().

Esri::ArcGISRuntime::HeightOrigin ViewshedParameters::observerHeightOrigin() const

Specifies and returns how the observer position height should be interpreted.

The default value is HeightOrigin::Relative.

See also setObserverHeightOrigin(), observerPosition, and Point::z.

Esri::ArcGISRuntime::Point ViewshedParameters::observerPosition() const

Returns the observer position in 3D space.

The value of Point::z is the observer height.

See also setObserverPosition().

void ViewshedParameters::setElevationSamplingInterval(std::optional<double> elevationSamplingInterval)

Sets the elevationSamplingInterval to elevationSamplingInterval.

See also elevationSamplingInterval.

void ViewshedParameters::setFieldOfView(double fieldOfView)

Sets the fieldOfView to fieldOfView.

See also fieldOfView.

void ViewshedParameters::setHeading(double heading)

Sets the heading to heading.

See also heading.

void ViewshedParameters::setMaxRadius(std::optional<double> maxRadius)

Sets the maxRadius to maxRadius.

See also maxRadius.

void ViewshedParameters::setObserverHeightOrigin(Esri::ArcGISRuntime::HeightOrigin observerHeightOrigin)

Sets the observerHeightOrigin to observerHeightOrigin.

See also observerHeightOrigin.

void ViewshedParameters::setObserverPosition(const Esri::ArcGISRuntime::Point &observerPosition)

Sets the observerPosition to observerPosition.

See also observerPosition.

void ViewshedParameters::setTargetHeight(double targetHeight)

Sets the targetHeight to targetHeight.

See also targetHeight.

void ViewshedParameters::setTargetHeightOrigin(Esri::ArcGISRuntime::HeightOrigin targetHeightOrigin)

Sets the targetHeightOrigin to targetHeightOrigin.

See also targetHeightOrigin.

double ViewshedParameters::targetHeight() const

Returns 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.

See also setTargetHeight() and targetHeightOrigin.

Esri::ArcGISRuntime::HeightOrigin ViewshedParameters::targetHeightOrigin() const

Specifies and returns how the target height should be interpreted.

The default value is HeightOrigin::Relative.

See also setTargetHeightOrigin().