Class GeoCorridor

  • java.lang.Object
    • com.here.sdk.core.GeoCorridor

  • public final class GeoCorridor
    extends java.lang.Object

    A geographical area that wraps around a geographical polyline with a given distance. The corridor has round edges at the endpoints of the polyline. The distance from any point of the polyline to the closest border of the corridor is always the same.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Integer halfWidthInMeters
      The shortest distance from any point on the polyline to the border of the corridor.
      java.util.List<GeoCoordinates> polyline
      The polyline passing through the middle of the corridor.
    • Constructor Summary

      Constructors 
      Constructor Description
      GeoCorridor​(java.util.List<GeoCoordinates> polyline)
      Constructs a GeoCorridor from the provided polyline.
      GeoCorridor​(java.util.List<GeoCoordinates> polyline, int halfWidthInMeters)
      Constructs a GeoCorridor from the provided polyline and half-width in meters.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      int hashCode()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • polyline

        @NonNull
        public final java.util.List<GeoCoordinates> polyline

        The polyline passing through the middle of the corridor.

      • halfWidthInMeters

        @Nullable
        public final java.lang.Integer halfWidthInMeters

        The shortest distance from any point on the polyline to the border of the corridor.

    • Constructor Detail

      • GeoCorridor

        public GeoCorridor​(@NonNull
                           java.util.List<GeoCoordinates> polyline,
                           int halfWidthInMeters)

        Constructs a GeoCorridor from the provided polyline and half-width in meters.

        Parameters:
        polyline -

        The polyline passing through the middle of the corridor.

        halfWidthInMeters -

        The shortest distance from any point on the polyline to the border of the corridor.

      • GeoCorridor

        public GeoCorridor​(@NonNull
                           java.util.List<GeoCoordinates> polyline)

        Constructs a GeoCorridor from the provided polyline.

        Parameters:
        polyline -

        The polyline passing through the middle of the corridor.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object