Class GeoElementViewshed
- java.lang.Object
-
- com.esri.arcgisruntime.geoanalysis.Analysis
-
- com.esri.arcgisruntime.geoanalysis.Viewshed
-
- com.esri.arcgisruntime.geoanalysis.GeoElementViewshed
-
public final class GeoElementViewshed extends Viewshed
GeoElementViewshed can be used to perform viewshed analysis from a location, known as an observer, where the observer's location and direction are relative to those of the GeoElement.The relative location of the observer can be controlled using
setOffsetX(double)
,setOffsetY(double)
andsetOffsetZ(double)
.The relative direction of the observer can be controlled using
setHeadingOffset(double)
andsetPitchOffset(double)
.- Since:
- 100.2.0
-
-
Constructor Summary
Constructors Constructor Description GeoElementViewshed(GeoElement geoElement, double horizontalAngle, double verticalAngle, double minDistance, double maxDistance, double headingOffset, double pitchOffset)
Constructs a viewshed with the observer location and direction synchronized with that of a GeoElement.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GeoElement
getGeoElement()
Gets the GeoElement used to create this viewshed.double
getHeadingOffset()
Gets the offset from the GeoElement's heading.double
getOffsetX()
Gets the observer's offset from the GeoElement's location along the x-axis.double
getOffsetY()
Gets the observer's offset from the GeoElement's location along the y-axis.double
getOffsetZ()
Gets the observer's offset from the GeoElement's location along the z-axis.double
getPitchOffset()
Gets the offset from the GeoElement's pitch.void
setHeadingOffset(double headingOffset)
Sets the offset from the GeoElement's heading.void
setOffsetX(double offsetX)
Sets the observer's offset from the GeoElement's location along the x-axis.void
setOffsetY(double offsetY)
Sets the observer's offset from the GeoElement's location along the y-axis.void
setOffsetZ(double offsetZ)
Sets the observer's offset from the GeoElement's location along the z-axis.void
setPitchOffset(double pitchOffset)
Sets the offset from the GeoElement's pitch.-
Methods inherited from class com.esri.arcgisruntime.geoanalysis.Viewshed
getFrustumOutlineColor, getHorizontalAngle, getMaxDistance, getMinDistance, getObstructedColor, getVerticalAngle, getVisibleColor, isFrustumOutlineVisibile, setFrustumOutlineColor, setFrustumOutlineVisible, setHorizontalAngle, setMaxDistance, setMinDistance, setObstructedColor, setVerticalAngle, setVisibleColor
-
Methods inherited from class com.esri.arcgisruntime.geoanalysis.Analysis
isVisible, setVisible
-
-
-
-
Constructor Detail
-
GeoElementViewshed
public GeoElementViewshed(GeoElement geoElement, double horizontalAngle, double verticalAngle, double minDistance, double maxDistance, double headingOffset, double pitchOffset)
Constructs a viewshed with the observer location and direction synchronized with that of a GeoElement. The spread is calculated by horizontalAngle, verticalAngle, minDistance and maxDistance, and direction is specified by headingOffset and pitchOffset, which are relative to the GeoElement.- Parameters:
geoElement
- the GeoElement relative to which the observer location and direction will be synchronizedhorizontalAngle
- the horizontal spread of the viewshed, in degrees, > 0 and <= 360verticalAngle
- the vertical spread of the viewshed, in degrees, > 0 and <= 360minDistance
- the minimum distance from the observer to render, in meters within [0, Double.MAX_VALUE]maxDistance
- the maximum distance from the observer to render, in meters within [0, Double.MAX_VALUE]headingOffset
- the offset from the GeoElement's heading, in degreespitchOffset
- the offset from the GeoElement's pitch, in degrees- Throws:
IllegalArgumentException
- if geoElement is null- Since:
- 100.2.0
-
-
Method Detail
-
getGeoElement
public GeoElement getGeoElement()
Gets the GeoElement used to create this viewshed.- Returns:
- the GeoElement used to create this viewshed.
- Since:
- 100.2.0
-
getHeadingOffset
public double getHeadingOffset()
Gets the offset from the GeoElement's heading.The viewshed's heading is the sum of the GeoElement's heading and this offset.
- Returns:
- the offset from the GeoElement's heading, in degrees
- Since:
- 100.2.0
-
setHeadingOffset
public void setHeadingOffset(double headingOffset)
Sets the offset from the GeoElement's heading.The viewshed's heading is the sum of the GeoElement's heading and this offset.
- Parameters:
headingOffset
- the offset from the GeoElement's heading, in degrees- Since:
- 100.2.0
-
getPitchOffset
public double getPitchOffset()
Gets the offset from the GeoElement's pitch.The viewshed's pitch is the sum of the GeoElement's pitch and this offset.
- Returns:
- the offset from the GeoElement's pitch, in degrees
- Since:
- 100.2.0
-
setPitchOffset
public void setPitchOffset(double pitchOffset)
Sets the offset from the GeoElement's pitch.The viewshed's pitch is the sum of the GeoElement's pitch and this offset.
- Parameters:
pitchOffset
- the offset from the GeoElement's pitch, in degrees- Since:
- 100.2.0
-
getOffsetX
public double getOffsetX()
Gets the observer's offset from the GeoElement's location along the x-axis.Default is 0.0.
- Returns:
- the observer's offset from the GeoElement's location along the x-axis
- Since:
- 100.2.0
-
setOffsetX
public void setOffsetX(double offsetX)
Sets the observer's offset from the GeoElement's location along the x-axis.Default is 0.0.
- Parameters:
offsetX
- the observer's offset from the GeoElement's location along the x-axis- Since:
- 100.2.0
-
getOffsetY
public double getOffsetY()
Gets the observer's offset from the GeoElement's location along the y-axis.Default is 0.0.
- Returns:
- the observer's offset from the GeoElement's location along the y-axis
- Since:
- 100.2.0
-
setOffsetY
public void setOffsetY(double offsetY)
Sets the observer's offset from the GeoElement's location along the y-axis.Default is 0.0.
- Parameters:
offsetY
- the observer's offset from the GeoElement's location along the y-axis- Since:
- 100.2.0
-
getOffsetZ
public double getOffsetZ()
Gets the observer's offset from the GeoElement's location along the z-axis.Default is 0.0.
- Returns:
- the observer's offset from the GeoElement's location along the z-axis
- Since:
- 100.2.0
-
setOffsetZ
public void setOffsetZ(double offsetZ)
Sets the observer's offset from the GeoElement's location along the z-axis.Default is 0.0.
- Parameters:
offsetZ
- the observer's offset from the GeoElement's location along the z-axis- Since:
- 100.2.0
-
-