ArcGIS Runtime SDK for iOS: AGSGeoElementViewshed Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSGeoElementViewshed Class Reference

Description

Analysis of viewshed for a specified geo-element.

Instances of this class represent an analysis object that renders a viewshed for a specified geo-element. The viewshed determines visible and non-visible areas in a scene view for an observer defined by the geo-element. The viewshed will be updated as the geo-element's location changes.

License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

Since
100.2
Inheritance diagram for AGSGeoElementViewshed:
AGSViewshed AGSAnalysis AGSObject

Instance Methods

(instancetype) - initWithGeoElement:horizontalAngle:verticalAngle:minDistance:maxDistance:headingOffset:pitchOffset:
 

Class Methods

(AGSColor *) + frustumOutlineColor
 
(instancetype) + geoElementViewshedWithGeoElement:horizontalAngle:verticalAngle:minDistance:maxDistance:headingOffset:pitchOffset:
 
(AGSColor *) + obstructedColor
 
(void) + setFrustumOutlineColor:
 
(void) + setObstructedColor:
 
(void) + setVisibleColor:
 
(AGSColor *) + visibleColor
 

Properties

BOOL frustumOutlineVisible
 
id< AGSGeoElementgeoElement
 
double headingOffset
 
double horizontalAngle
 
double maxDistance
 
double minDistance
 
double offsetX
 
double offsetY
 
double offsetZ
 
double pitchOffset
 
double verticalAngle
 
BOOL visible
 

Method Documentation

◆ frustumOutlineColor

+ (AGSColor *) frustumOutlineColor

The color used to render the frustum outline. This setting is applied to all viewshed analyses in the view.

Since
100.2

◆ geoElementViewshedWithGeoElement:horizontalAngle:verticalAngle:minDistance:maxDistance:headingOffset:pitchOffset:

+ (instancetype) geoElementViewshedWithGeoElement: (id< AGSGeoElement >)  geoElement
horizontalAngle: (double)  horizontalAngle
verticalAngle: (double)  verticalAngle
minDistance: (double)  minDistance
maxDistance: (double)  maxDistance
headingOffset: (double)  headingOffset
pitchOffset: (double)  pitchOffset 

Initialize a viewshed analysis object whose observer is defined by the provided geo-element, view angles, and heading/pitch offsets. The provided distance range defines the analysis 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.

Parameters
geoElementfrom which the position and orientation of the observer will be determined
horizontalAngleThe horizontal angle of the observer's view. Must be greater than zero and less than or equal to 360.
verticalAngleThe vertical angle of the observer's view. Must be greater than zero and less than or equal to 360.
minDistanceThe minimum distance from the observer at which visibility will be evaluated.
maxDistanceThe maximum distance from the observer at which visibility will be evaluated.
headingOffsetAn angle offset relative to the heading of the geo-element to determine the direction of the observer's view.
pitchOffsetAn angle offset relative to the pitch of the geo-element to determine the vertical angle of the observer's view. Valid values range from 0 to 180 degrees.
Returns
Initialized viewshed analysis
Since
100.2

◆ initWithGeoElement:horizontalAngle:verticalAngle:minDistance:maxDistance:headingOffset:pitchOffset:

- (instancetype) initWithGeoElement: (id< AGSGeoElement >)  geoElement
horizontalAngle: (double)  horizontalAngle
verticalAngle: (double)  verticalAngle
minDistance: (double)  minDistance
maxDistance: (double)  maxDistance
headingOffset: (double)  headingOffset
pitchOffset: (double)  pitchOffset 

Initialize a viewshed analysis object whose observer is defined by the provided geo-element, view angles, and heading/pitch offsets. The provided distance range defines the analysis 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.

Parameters
geoElementfrom which the position and orientation of the observer will be determined
horizontalAngleThe horizontal angle of the observer's view. Must be greater than zero and less than or equal to 360.
verticalAngleThe vertical angle of the observer's view. Must be greater than zero and less than or equal to 360.
minDistanceThe minimum distance from the observer at which visibility will be evaluated.
maxDistanceThe maximum distance from the observer at which visibility will be evaluated.
headingOffsetAn angle offset relative to the heading of the geo-element to determine the direction of the observer's view.
pitchOffsetAn angle offset relative to the pitch of the geo-element to determine the vertical angle of the observer's view. Valid values range from 0 to 180 degrees.
Returns
Initialized viewshed analysis
Since
100.2

◆ obstructedColor

+ (AGSColor *) obstructedColor

The color with which non-visible areas of all viewsheds will be rendered. This setting is applied to all viewshed analyses in the view.

Since
100.2

◆ setFrustumOutlineColor:

+ (void) setFrustumOutlineColor: (AGSColor *)  frustumOutlineColor

Sets the color used to render the frustum outline. This setting is applied to all viewshed analyses in the view.

Parameters
frustumOutlineColorcolor of the viewshed frustum's outline
Since
100.2

◆ setObstructedColor:

+ (void) setObstructedColor: (AGSColor *)  obstructedColor

Sets the color with which non-visible areas of all viewsheds will be rendered. This setting is applied to all viewshed analyses in the view.

Parameters
obstructedColorused to render areas that are not visible
Since
100.2

◆ setVisibleColor:

+ (void) setVisibleColor: (AGSColor *)  visibleColor

Sets the color with which visible areas of all viewsheds will be rendered. This setting is applied to all viewshed analyses in the view.

Parameters
visibleColorused to render areas that are visible
Since
100.2

◆ visibleColor

+ (AGSColor *) visibleColor

The color with which visible areas of all viewsheds will be rendered. This setting is applied to all viewshed analyses in the view.

Since
100.2

Property Documentation

◆ frustumOutlineVisible

- (BOOL) frustumOutlineVisible
readwritenonatomicassigninherited

Indicates whether or not the viewshed frustum should be visible

Since
100.2

◆ geoElement

- (id<AGSGeoElement>) geoElement
readnonatomicstrong

Geo-element that represents the observer for the viewshed analysis. The observer's location, heading, and pitch are determined by the location and orientation of this geo-element.

Since
100.2

◆ headingOffset

- (double) headingOffset
readwritenonatomicassign

The offset angle applied to the heading of the geo-element. The observer heading is determined by the geo-element heading plus the heading offset.

Since
100.2

◆ horizontalAngle

- (double) horizontalAngle
readwritenonatomicassigninherited

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

Since
100.2

◆ maxDistance

- (double) maxDistance
readwritenonatomicassigninherited

The maximum distance (in meters) from the observer at which visibility will be evaluated. This can be used to model factors that restrict the visible distance.

Since
100.2

◆ minDistance

- (double) minDistance
readwritenonatomicassigninherited

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

Since
100.2

◆ offsetX

- (double) offsetX
readwritenonatomicassign

The location offset in the X direction that defines the observer relative to the geo-element.

The observer location is determined by the geo-element location plus the offset X,Y,Z values. Any rotations applied to the geo-element will also be applied to the X,Y,Z offsets. This allows the observer to be positioned relative to the geo-element and maintain the relative position even when the geo-element moves and rotates.

Since
100.2

◆ offsetY

- (double) offsetY
readwritenonatomicassign

The location offset in the Y direction that defines the observer relative to the geo-element.

The observer location is determined by the geo-element location plus the offset X,Y,Z values. Any rotations applied to the geo-element will also be applied to the X,Y,Z offsets. This allows the observer to be positioned relative to the geo-element and maintain the relative position even when the geo-element moves and rotates.

Since
100.2

◆ offsetZ

- (double) offsetZ
readwritenonatomicassign

The location offset in the X direction that defines the observer relative to the geo-element.

The observer location is determined by the geo-element location plus the offset X,Y,Z values. Any rotations applied to the geo-element will also be applied to the X,Y,Z offsets. This allows the observer to be positioned relative to the geo-element and maintain the relative position even when the geo-element moves and rotates.

Since
100.2

◆ pitchOffset

- (double) pitchOffset
readwritenonatomicassign

The offset angle applied to the pitch of the geo-element. The observer pitch is determined by the geo-element pitch plus the pitch offset. Valid values range from 0 to 180 degrees.

Since
100.2

◆ verticalAngle

- (double) verticalAngle
readwritenonatomicassigninherited

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

Since
100.2

◆ visible

- (BOOL) visible
readwritenonatomicassigninherited

Indicates whether the results of this analysis should be visible or not. Visibility can be controlled for individual analyses as well as for the analysis overlay that contains them.

Since
100.2