LocationViewshed

LocationViewshed is an analysis object that renders a viewshed for a specified point location. LocationViewshed determines visible and non-visible areas in a scene view for an observer defined with a map location (point).

Since

200.1.0

See also

Constructors

Link copied to clipboard
constructor(camera: Camera, minDistance: Double? = null, maxDistance: Double? = null)

Creates a viewshed analysis object whose observer is defined using a point location. Provide a Camera and distance range to define the analysis frustum. Visible and non-visible areas are determined for an area defined by the camera and the min/max distance range. The parameters define the frustum over which visibility is calculated from the camera/observer location. Terrain and other obstacles between the observer and the minimum distance are excluded from the analysis, as are areas beyond the maximum distance.

constructor(location: Point, heading: Double, pitch: Double, horizontalAngle: Double, verticalAngle: Double, minDistance: Double? = null, maxDistance: Double? = null)

Creates a viewshed analysis object whose observer is defined using a point location. Provide a map location and frustum parameters for the analysis. Visible and non-visible areas are determined for an area defined by the observer location, view angles, and the min/max distance range. The parameters define the frustum over which visibility is calculated from the observer location. The horizontal and vertical angles must be greater than zero to define a valid frustum and are constrained to a maximum of 120 degrees. Terrain and other obstacles between the observer and the minimum distance are excluded from the analysis, as are areas beyond the maximum distance.

Properties

Link copied to clipboard

The observer's heading. The heading represents the azimuth of the observer's direction of view. The value provided will be normalized to a value between 0 and 360 degrees.

Link copied to clipboard

The observer location of the viewshed.

Link copied to clipboard

The pitch of the observer's field of vision. Pitch is the angle of the observer's field of vision relative to the surface. Valid values are from 0 (looking straight down) to 180 (straight up).

Inherited properties

Link copied to clipboard

Whether or not the Viewshed frustum is visible. The frustum visibility can be controlled for individual Viewsheds.

Link copied to clipboard

The horizontal angle of the observer's field of vision. 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 horizontal angle must be greater than zero to define a valid frustum and is constrained to a maximum of 360 degrees.

Link copied to clipboard

Whether or not an Analysis is visible. Visibility can be controlled for individual Analyses as well as for the AnalysisOverlay that contains them. Will return false if an error occurs.

Link copied to clipboard

The maximum distance from the observer at which visibility will be evaluated. Visibility is not evaluated beyond the maximum distance specified. This can be used to model factors that restrict the visible distance.

Link copied to clipboard

The minimum distance from the observer at which visibility will be evaluated. 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.

Link copied to clipboard

The vertical angle of the observer's field of vision. 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 vertical angle must be greater than zero to define a valid frustum and is constrained to a maximum of 360 degrees.

Functions

Link copied to clipboard

Updates the frustum of the viewshed using the properties of the supplied Camera. The Camera is used to update the position, pitch, and heading of the viewshed frustum.