Class GeoElementLineOfSight


  • public final class GeoElementLineOfSight
    extends LineOfSight
    GeoElement Line of Sight analysis calculates segments of visibility between two GeoElements. The line of sight is calculated from the location of the observer GeoElement to the location of the target GeoElement.

    Any changes in the position of the GeoElement are applied to the line of sight.

    Since:
    10.2.0
    • Constructor Detail

      • GeoElementLineOfSight

        public GeoElementLineOfSight​(GeoElement observerGeoElement,
                                     GeoElement targetGeoElement)
        Creates an instance of GeoElementLineOfSight based on an observer and a target.
        Parameters:
        observerGeoElement - observer GeoElement
        targetGeoElement - target GeoElement
        Throws:
        IllegalArgumentException - if observerGeoElement is null
        IllegalArgumentException - if targetGeoElement is null
        Since:
        10.2.0
    • Method Detail

      • getObserverGeoElement

        public GeoElement getObserverGeoElement()
        Gets the observer GeoElement.
        Returns:
        the observer GeoElement
        Since:
        10.2.0
      • getObserverOffsetX

        public double getObserverOffsetX()
        Gets the observer's offset from the GeoElement's location along the X-axis.

        Default is 0.0.

        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 observer's offset from the GeoElement's location along the X-axis.

        Default is 0.0.

        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 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
      • setObserverOffsetY

        public void setObserverOffsetY​(double observerOffsetY)
        Sets the observer's offset from the GeoElement's location along the Y-axis.

        Default is 0.0.

        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 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
      • setObserverOffsetZ

        public void setObserverOffsetZ​(double observerOffsetZ)
        Sets the observer's offset from the GeoElement's location along the Z-axis.

        Default is 0.0.

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

        public GeoElement getTargetGeoElement()
        Gets the target GeoElement.
        Returns:
        the target GeoElement
        Since:
        10.2.0
      • getTargetOffsetX

        public double getTargetOffsetX()
        Gets the target's offset from the GeoElement's location along the X-axis.

        Default is 0.0.

        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 target's offset from the GeoElement's location along the X-axis.

        Default is 0.0.

        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 target's offset from the GeoElement's location along the Y-axis.

        Default is 0.0.

        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 target's offset from the GeoElement's location along the Y-axis.

        Default is 0.0.

        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 target's offset from the GeoElement's location along the Z-axis.

        Default is 0.0.

        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 target's offset from the GeoElement's location along the Z-axis.

        Default is 0.0.

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