Module org.apache.lucene.spatial3d
Package org.apache.lucene.spatial3d.geom

Class GeoStandardPath

java.lang.Object
org.apache.lucene.spatial3d.geom.BasePlanetObject
org.apache.lucene.spatial3d.geom.GeoBaseBounds
org.apache.lucene.spatial3d.geom.GeoBaseShape
org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
org.apache.lucene.spatial3d.geom.GeoBasePath
org.apache.lucene.spatial3d.geom.GeoStandardPath
All Implemented Interfaces:
Bounded, GeoArea, GeoAreaShape, GeoBounds, GeoDistance, GeoDistanceShape, GeoMembershipShape, GeoOutsideDistance, GeoPath, GeoShape, Membership, PlanetObject, SerializableObject
class GeoStandardPath extends GeoBasePath
GeoShape representing a path across the surface of the globe, with a specified half-width. Path is described by a series of points. Distances are measured from the starting point along the path, and then at right angles to the path.

  • Field Details

    • cutoffAngle

      protected final double cutoffAngle
      The cutoff angle (width)

    • sinAngle

      protected final double sinAngle
      Sine of cutoff angle

    • cosAngle

      protected final double cosAngle
      Cosine of cutoff angle

    • points

      protected final List<GeoPoint> points
      The original list of path points

    • rootComponent

      protected GeoStandardPath.PathComponent rootComponent
      The b-tree of PathComponents

    • edgePoints

      protected GeoPoint[] edgePoints
      A point on the edge

    • isDone

      protected boolean isDone
      Set to true if path has been completely constructed

  • Constructor Details

    • GeoStandardPath

      public GeoStandardPath(PlanetModel planetModel, double maxCutoffAngle, GeoPoint[] pathPoints)
      Constructor.
      Parameters:
      planetModel - is the planet model.
      maxCutoffAngle - is the width of the path, measured as an angle.
      pathPoints - are the points in the path.

    • GeoStandardPath

      public GeoStandardPath(PlanetModel planetModel, double maxCutoffAngle)
      Piece-wise constructor. Use in conjunction with addPoint() and done().
      Parameters:
      planetModel - is the planet model.
      maxCutoffAngle - is the width of the path, measured as an angle.

    • GeoStandardPath

      public GeoStandardPath(PlanetModel planetModel, InputStream inputStream) throws IOException
      Constructor for deserialization.
      Parameters:
      planetModel - is the planet model.
      inputStream - is the input stream.
      Throws:
      IOException

  • Method Details

    • addPoint

      public void addPoint(double lat, double lon)
      Add a point to the path.
      Parameters:
      lat - is the latitude of the point.
      lon - is the longitude of the point.

    • done

      public void done()
      Complete the path.

    • write

      public void write(OutputStream outputStream) throws IOException
      Description copied from interface: SerializableObject
      Serialize to output stream.
      Specified by:
      write in interface SerializableObject
      Overrides:
      write in class BasePlanetObject
      Parameters:
      outputStream - is the output stream to write to.
      Throws:
      IOException

    • computePathCenterDistance

      public double computePathCenterDistance(DistanceStyle distanceStyle, double x, double y, double z)
      Description copied from interface: GeoPath
      Compute the shortest distance from the path center to the GeoPoint. The distance is meant to allow comparisons between different paths to find the one that goes closest to a point.
      Parameters:
      distanceStyle - is the distance style.
      x - is the point's unit x coordinate (using U.S. convention).
      y - is the point's unit y coordinate (using U.S. convention).
      z - is the point's unit z coordinate (using U.S. convention).
      Returns:
      the shortest distance from the path center to the point.

    • computeNearestDistance

      public double computeNearestDistance(DistanceStyle distanceStyle, double x, double y, double z)
      Description copied from interface: GeoPath
      Compute the nearest path distance to the GeoPoint. The path distance will not include the distance from the path itself to the point, but just the distance along the path to the nearest point on the path.
      Parameters:
      x - is the point's unit x coordinate (using U.S. convention).
      y - is the point's unit y coordinate (using U.S. convention).
      z - is the point's unit z coordinate (using U.S. convention).
      Returns:
      the distance to the nearest path point.

    • distance

      protected double distance(DistanceStyle distanceStyle, double x, double y, double z)
      Description copied from class: GeoBaseDistanceShape
      Called by a computeDistance method if X/Y/Z is within this shape.
      Specified by:
      distance in class GeoBaseDistanceShape

    • deltaDistance

      protected double deltaDistance(DistanceStyle distanceStyle, double x, double y, double z)
      Description copied from class: GeoBaseDistanceShape
      Called by a computeDeltaDistance method if X/Y/Z is within this shape.
      Overrides:
      deltaDistance in class GeoBaseDistanceShape

    • distanceBounds

      protected void distanceBounds(Bounds bounds, DistanceStyle distanceStyle, double distanceValue)
      Description copied from class: GeoBaseDistanceShape
      Called by a getDistanceBounds method if distanceValue is not Double.POSITIVE_INFINITY.
      Specified by:
      distanceBounds in class GeoBaseDistanceShape

    • outsideDistance

      protected double outsideDistance(DistanceStyle distanceStyle, double x, double y, double z)
      Description copied from class: GeoBaseMembershipShape
      Called by a computeOutsideDistance method if X/Y/Z is not within this shape.
      Specified by:
      outsideDistance in class GeoBaseMembershipShape

    • isWithin

      public boolean isWithin(double x, double y, double z)
      Description copied from interface: Membership
      Check if a point is within this shape.
      Parameters:
      x - is x coordinate of point to check.
      y - is y coordinate of point to check.
      z - is z coordinate of point to check.
      Returns:
      true if the point is within this shape

    • getEdgePoints

      public GeoPoint[] getEdgePoints()
      Description copied from interface: GeoShape
      Return a sample point that is on the outside edge/boundary of the shape.
      Returns:
      samples of all edge points from distinct edge sections. Typically one point is returned, but zero or two are also possible.

    • intersects

      public boolean intersects(Plane plane, GeoPoint[] notablePoints, Membership... bounds)
      Description copied from interface: GeoShape
      Assess whether a plane, within the provided bounds, intersects with the shape's edges. Any overlap, even a single point, is considered to be an intersection. Note well that this method is allowed to return "true" if there are internal edges of a composite shape which intersect the plane. Doing this can cause getRelationship() for most GeoBBox shapes to return OVERLAPS rather than the more correct CONTAINS, but that cannot be helped for some complex shapes that are built out of overlapping parts.
      Parameters:
      plane - is the plane to assess for intersection with the shape's edges or bounding curves.
      notablePoints - represents the intersections of the plane with the supplied bounds. These are used to disambiguate when two planes are identical and it needs to be determined whether any points exist that fulfill all the bounds.
      bounds - are a set of bounds that define an area that an intersection must be within in order to qualify (provided by a GeoArea).
      Returns:
      true if there's such an intersection, false if not.

    • intersects

      public boolean intersects(GeoShape geoShape)
      Description copied from interface: GeoAreaShape
      Assess whether a shape intersects with any of the edges of this shape. Note well that this method must return false if the shape contains or is disjoint with the given shape. It is permissible to return true if the shape is within the specified shape, if it is difficult to compute intersection with edges.
      Parameters:
      geoShape - is the shape to assess for intersection with this shape's edges.
      Returns:
      true if there's such an intersection, false if not.

    • getBounds

      public void getBounds(Bounds bounds)
      Description copied from interface: Bounded
      Compute bounds for the shape.
      Specified by:
      getBounds in interface Bounded
      Overrides:
      getBounds in class GeoBaseBounds
      Parameters:
      bounds - is the input bounds object. The input object will be modified.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class BasePlanetObject

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BasePlanetObject

    • toString

      public String toString()
      Overrides:
      toString in class Object