Description
Analysis of viewshed for a specified location.
Instances of this class represent an analysis object that renders a viewshed for a specified location. The viewshed determines visible and non-visible areas in a scene view for an observer.
- License Restrictions:
- This feature requires a Standard license for production deployment. No license required in Developer mode for testing.
- Since
- 100.2
Instance Methods | |
| (instancetype) | - initWithCamera:minDistance:maxDistance: |
| (instancetype) | - initWithLocation:heading:pitch:horizontalAngle:verticalAngle:minDistance:maxDistance: |
| (void) | - updateFromCamera: |
Class Methods | |
| (AGSColor *) | + frustumOutlineColor |
| (instancetype) | + locationViewshedWithCamera:minDistance:maxDistance: |
| (instancetype) | + locationViewshedWithLocation:heading:pitch:horizontalAngle:verticalAngle:minDistance:maxDistance: |
| (AGSColor *) | + obstructedColor |
| (void) | + setFrustumOutlineColor: |
| (void) | + setObstructedColor: |
| (void) | + setVisibleColor: |
| (AGSColor *) | + visibleColor |
Properties | |
| BOOL | frustumOutlineVisible |
| double | heading |
| double | horizontalAngle |
| AGSPoint * | location |
| double | maxDistance |
| double | minDistance |
| double | pitch |
| 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
◆ initWithCamera:minDistance:maxDistance:
| - (instancetype) initWithCamera: | (AGSCamera *) | camera | |
| minDistance: | (double) | minDistance | |
| maxDistance: | (double) | maxDistance | |
Initialize a viewshed analysis object whose observer is defined using a point location of the provided camera. 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
-
camera defining the observer's location minDistance The minimum distance (in meters) from the observer at which visibility will be evaluated. maxDistance The maximum distance (in meters) from the observer at which visibility will be evaluated.
- Returns
- Initialized viewshed analysis
- Since
- 100.2
◆ initWithLocation:heading:pitch:horizontalAngle:verticalAngle:minDistance:maxDistance:
| - (instancetype) initWithLocation: | (AGSPoint *) | location | |
| heading: | (double) | heading | |
| pitch: | (double) | pitch | |
| horizontalAngle: | (double) | horizontalAngle | |
| verticalAngle: | (double) | verticalAngle | |
| minDistance: | (double) | minDistance | |
| maxDistance: | (double) | maxDistance | |
Initialize a viewshed analysis object whose observer is defined using the provided location, heading, pitch, and view angles. 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
-
location A geographic point location for the observer. heading The heading value (azimuth) that defines the observer's view direction pitch The pitch value (angle) of the observer's view. Valid values are from 0 (looking straight down) to 180 (straight up). horizontalAngle The horizontal angle of the observer's view. Must be greater than zero and less than or equal to 360. verticalAngle The vertical angle of the observer's view. Must be greater than zero and less than or equal to 360. minDistance The minimum distance (in meters) from the observer at which visibility will be evaluated. maxDistance The maximum distance (in meters) from the observer at which visibility will be evaluated.
- Returns
- Initialized viewshed analysis
- Since
- 100.2
◆ locationViewshedWithCamera:minDistance:maxDistance:
| + (instancetype) locationViewshedWithCamera: | (AGSCamera *) | camera | |
| minDistance: | (double) | minDistance | |
| maxDistance: | (double) | maxDistance | |
Initialize a viewshed analysis object whose observer's locaiton is defined using the provided camera. 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
-
camera defining the observer's location minDistance The minimum distance (in meters) from the observer at which visibility will be evaluated. maxDistance The maximum distance (in meters) from the observer at which visibility will be evaluated.
- Returns
- Initialized viewshed analysis
- Since
- 100.2
◆ locationViewshedWithLocation:heading:pitch:horizontalAngle:verticalAngle:minDistance:maxDistance:
| + (instancetype) locationViewshedWithLocation: | (AGSPoint *) | location | |
| heading: | (double) | heading | |
| pitch: | (double) | pitch | |
| horizontalAngle: | (double) | horizontalAngle | |
| verticalAngle: | (double) | verticalAngle | |
| minDistance: | (double) | minDistance | |
| maxDistance: | (double) | maxDistance | |
Initialize a viewshed analysis object whose observer is defined using the provided location, heading, pitch, and view angles. 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
-
location A geographic point location for the observer. heading The heading value (azimuth) that defines the observer's view direction pitch The pitch value (angle) of the observer's view. Valid values are from 0 (looking straight down) to 180 (straight up). horizontalAngle The horizontal angle of the observer's view. Must be greater than zero and less than or equal to 360. verticalAngle The vertical angle of the observer's view. Must be greater than zero and less than or equal to 360. minDistance The minimum distance (in meters) from the observer at which visibility will be evaluated. maxDistance The maximum distance (in meters) from the observer at which visibility will be evaluated.
- 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
-
frustumOutlineColor color 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
-
obstructedColor used 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
-
visibleColor used to render areas that are visible
- Since
- 100.2
◆ updateFromCamera:
| - (void) updateFromCamera: | (AGSCamera *) | camera |
Updates the frustum of the viewshed using the properties of the supplied Camera.
- Parameters
-
camera used to update the position, pitch, and heading of the viewshed frustum.
- 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
|
readwritenonatomicassigninherited |
Indicates whether or not the viewshed frustum should be visible
- Since
- 100.2
◆ heading
|
readwritenonatomicassign |
Observer's heading. It represents the azimuth of the observer's direction of view.
- Since
- 100.2
◆ horizontalAngle
|
readwritenonatomicassigninherited |
The horizontal angle (in degrees) of the observer's field of vision.
- Since
- 100.2
◆ location
|
readwritenonatomicstrong |
Observer location from which the viewshed is calculated.
- Since
- 100.2
◆ 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
|
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
◆ pitch
|
readwritenonatomicassign |
Pitch of the observer's field of vision. It 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).
- Since
- 100.2
◆ verticalAngle
|
readwritenonatomicassigninherited |
The vertical angle (in degrees) of the observer's field of vision.
- Since
- 100.2
◆ 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
