Skip To Content ArcGIS for Developers Sign In Dashboard

Viewshed QML Type

A base type for the Analysis types that determine visible and non-visible areas in a scene view. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.2
Inherits:

Analysis

Inherited By:

GeoElementViewshed and LocationViewshed

Properties

Signals

Methods

Detailed Description

Visible and non-visible areas are determined for an area defined by an observer location, horizontal and vertical view angles, and a minimum/maximum distance range. These properties define a frustum (3D solid) inside of which visibility is calculated.

The minimum distance allows you to exclude obstacles close to the observer (the corner of a building, for example). Since terrain and other obstacles between the observer and the specified minimum distance are completely excluded from the analysis, this value should be relatively small.

Visibility is not evaluated beyond the maximum distance specified. This can be used to model factors that restrict the visible distance.

Note: You cannot declare or create a component of this type in QML code.

Property Documentation

frustumOutlineVisible : double

Whether the Viewshed frustum outline is visible.

The frustum outline visibility can be controlled for individual Viewsheds.


horizontalAngle : double

The horizontal angle of the observer's field of vision in degrees (0-360).


maxDistance : bool

The maximum distance from the observer at which visibility will be evaluated.


minDistance : double

The minimum distance from the observer at which visibility will be evaluated.


verticalAngle : double

The vertical angle of the observer's field of vision in degrees (0-360).


Signal Documentation

frustumOutlineVisibleChanged()

Emitted when the frustumOutlineVisible property changes.


horizontalAngleChanged()

Emitted when the horizontalAngle property changes.


maxDistanceChanged()

Emitted when the maxDistance property changes.


minDistanceChanged()

Emitted when the minDistance property changes.


verticalAngleChanged()

Emitted when the verticalAngle property changes.


Method Documentation

color frustumOutlineColor()

Returns the color used to render the frustum outline.

The frustum (3D solid) within which visibility is evaluated can be symbolized with a specified outline color.

This is a global setting and applies to all viewsheds within the application.


color obstructedColor()

Returns the color with which non-visible areas of the viewshed will be rendered.

Areas of the scene view that are not visible from the observer location and within the frustum defined for the viewshed analysis will be rendered using the specified color.

This is a global setting and applies to all viewsheds within the application.


void setFrustumOutlineColor(color frustumOutlineColor)

Sets the color used to render the frustum outline to frustumOutlineColor.

The frustum (3D solid) within which visibility is evaluated can be symbolized with a specified outline color.

This is a global setting and applies to all viewsheds within the application.


void setObstructedColor(color obstructedColor)

Sets the color with which non-visible areas of the viewshed will be rendered to obstructedColor.

Areas of the scene view that are not visible from the observer location and within the frustum defined for the viewshed analysis will be rendered using the specified color.

This is a global setting and applies to all viewsheds within the application.


void setVisibleColor(color visibleColor)

Sets the color with which visible areas of the viewshed will be rendered to visibleColor.

Areas of the scene view that are visible from the observer location and within the frustum defined for the viewshed analysis will be rendered using the specified color.

This is a global setting and applies to all viewsheds within the application.


color visibleColor()

Returns the color with which visible areas of the viewshed will be rendered.

Areas of the scene view that are visible from the observer location and within the frustum defined for the viewshed analysis will be rendered using the specified color.

This is a global setting and applies to all viewsheds within the application.



Feedback on this topic?