Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.geoanalysis

Class GeoElementLineOfSight

java.lang.Object
com.esri.arcgisruntime.geoanalysis.Analysis
com.esri.arcgisruntime.geoanalysis.LineOfSight
com.esri.arcgisruntime.geoanalysis.GeoElementLineOfSight
public final class GeoElementLineOfSight extends LineOfSight
An analysis object that evaluates visibility along a line defined by observer and target GeoElement objects.

GeoElementLineOfSight renders a line between an observer GeoElement and a target GeoElement (each using Point geometry).

Visible and obstructed portions of the line are displayed with unique colors (green and red by default). The observer and/or target GeoElements may be moving, in which case visibility will be dynamically updated. Supported GeoElement types are Graphic, Feature, and DynamicEntity.

Since:
10.2.0

  • Constructor Details

    • GeoElementLineOfSight

      public GeoElementLineOfSight(GeoElement observerGeoElement, GeoElement targetGeoElement)
      Creates a LineOfSight analysis object that defines an observer and a target using point GeoElement objects.

      The LineOfSight analysis result is a line rendered between the observer and target elements with distinct colors representing visible and obstructed segments. Supported GeoElement types are Graphic, Feature, and DynamicEntity.

      Parameters:
      observerGeoElement - a GeoElement that defines the observer
      targetGeoElement - a GeoElement that defines the target
      Throws:
      IllegalArgumentException - if observerGeoElement is null
      IllegalArgumentException - if targetGeoElement is null
      Since:
      10.2.0

  • Method Details

    • getObserverGeoElement

      public GeoElement getObserverGeoElement()
      Gets the observer GeoElement of the GeoElementLineOfSight.

      The observer GeoElement must have point geometry. Supported GeoElement types are Graphic, Feature, and DynamicEntity.

      Returns:
      the observer GeoElement
      Since:
      10.2.0

    • getObserverOffsetX

      public double getObserverOffsetX()
      Gets the location offset applied to the observer GeoElement in the X direction.

      The observer location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the observer relative to the GeoElement is always maintained, even when the GeoElement moves.

      Returns:
      the observer's location offset from the GeoElement's location along the x-axis
      Since:
      100.2.0

    • setObserverOffsetX

      public void setObserverOffsetX(double observerOffsetX)
      Sets the location offset applied to the observer GeoElement in the X direction.

      The observer location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the observer relative to the GeoElement is always maintained, even when the GeoElement moves.

      Parameters:
      observerOffsetX - the observer's offset from the from GeoElement's location along the x-axis
      Since:
      100.2.0

    • getObserverOffsetY

      public double getObserverOffsetY()
      Gets the location offset applied to the observer GeoElement in the Y direction.

      The observer location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the observer relative to the GeoElement is always maintained, even when the GeoElement moves.

      Returns:
      the observer's offset from the GeoElement's location along the y-axis
      Since:
      100.2.0

    • setObserverOffsetY

      public void setObserverOffsetY(double observerOffsetY)
      Sets the location offset applied to the observer GeoElement in the Y direction.

      The observer location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the observer relative to the GeoElement is always maintained, even when the GeoElement moves.

      Parameters:
      observerOffsetY - the observer's offset from the from GeoElement's location along the y-axis
      Since:
      100.2.0

    • getObserverOffsetZ

      public double getObserverOffsetZ()
      Gets the location offset applied to the observer GeoElement in the Z direction.

      The observer location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the observer relative to the GeoElement is always maintained, even when the GeoElement moves.

      Returns:
      the observer's offset from the GeoElement's location along the z-axis
      Since:
      100.2.0

    • setObserverOffsetZ

      public void setObserverOffsetZ(double observerOffsetZ)
      Sets the location offset applied to the observer GeoElement in the Z direction.

      The observer location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the observer relative to the GeoElement is always maintained, even when the GeoElement moves.

      Parameters:
      observerOffsetZ - the observer's offset from the from GeoElement's location along the z-axis
      Since:
      100.2.0

    • getTargetGeoElement

      public GeoElement getTargetGeoElement()
      The target GeoElement of the GeoElementLineOfSight.

      The target GeoElement must have point geometry. Supported GeoElement types are Graphic, Feature, and DynamicEntity.

      Returns:
      the target GeoElement
      Since:
      10.2.0

    • getTargetOffsetX

      public double getTargetOffsetX()
      Get the location offset applied to the target GeoElement in the X direction.

      The target location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the target relative to the GeoElement is always maintained, even when the GeoElement moves.

      Returns:
      the target's offset from the GeoElement's location along the x-axis
      Since:
      100.2.0

    • setTargetOffsetX

      public void setTargetOffsetX(double targetOffsetX)
      Sets the location offset applied to the target GeoElement in the X direction.

      The target location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the target relative to the GeoElement is always maintained, even when the GeoElement moves.

      Parameters:
      targetOffsetX - the target's offset from the GeoElement's location along the x-axis
      Since:
      100.2.0

    • getTargetOffsetY

      public double getTargetOffsetY()
      Gets the location offset applied to the target GeoElement in the Y direction.

      The target location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the target relative to the GeoElement is always maintained, even when the GeoElement moves.

      Returns:
      the target's offset from the GeoElement's location along the y-axis
      Since:
      100.2.0

    • setTargetOffsetY

      public void setTargetOffsetY(double targetOffsetY)
      Sets the location offset applied to the target GeoElement in the Y direction.

      The target location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the target relative to the GeoElement is always maintained, even when the GeoElement moves.

      Parameters:
      targetOffsetY - the target's offset from the GeoElement's location along the y-axis
      Since:
      100.2.0

    • getTargetOffsetZ

      public double getTargetOffsetZ()
      Gets the location offset applied to the target GeoElement in the Z direction.

      The target location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the target relative to the GeoElement is always maintained, even when the GeoElement moves.

      Returns:
      the target's offset from the GeoElement's location along the z-axis
      Since:
      100.2.0

    • setTargetOffsetZ

      public void setTargetOffsetZ(double targetOffsetZ)
      Sets the location offset applied to the target GeoElement in the Z direction.

      The target location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the target relative to the GeoElement is always maintained, even when the GeoElement moves.

      Parameters:
      targetOffsetZ - the target's offset from the GeoElement's location along the z-axis
      Since:
      100.2.0