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

Class GeoStandardCircle

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.GeoBaseCircle
org.apache.lucene.spatial3d.geom.GeoStandardCircle
All Implemented Interfaces:
Bounded, GeoArea, GeoAreaShape, GeoBounds, GeoCircle, GeoDistance, GeoDistanceShape, GeoMembershipShape, GeoOutsideDistance, GeoShape, GeoSizeable, Membership, PlanetObject, SerializableObject
class GeoStandardCircle extends GeoBaseCircle
Circular area with a center and cutoff angle that represents the latitude and longitude distance from the center where the planet will be cut. The resulting area is a circle for spherical planets and an ellipse otherwise.

  • Field Details

    • center

      protected final GeoPoint center
      Center of circle

    • cutoffAngle

      protected final double cutoffAngle
      Cutoff angle of circle (not quite the same thing as radius)

    • circlePlane

      protected final SidedPlane circlePlane
      The plane describing the circle (really an ellipse on a non-spherical world)

    • edgePoints

      protected final GeoPoint[] edgePoints
      A point that is on the world and on the circle plane

    • circlePoints

      protected static final GeoPoint[] circlePoints
      Notable points for a circle -- there aren't any

  • Constructor Details

    • GeoStandardCircle

      public GeoStandardCircle(PlanetModel planetModel, double lat, double lon, double cutoffAngle)
      Constructor.
      Parameters:
      planetModel - is the planet model.
      lat - is the center latitude.
      lon - is the center longitude.
      cutoffAngle - is the cutoff angle for the circle.

    • GeoStandardCircle

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

  • Method Details

    • 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

    • getRadius

      public double getRadius()
      Description copied from interface: GeoSizeable
      Returns the radius of a circle into which the GeoSizeable area can be inscribed.
      Returns:
      the radius.

    • getCenter

      public GeoPoint getCenter()
      Description copied from interface: GeoSizeable
      Returns the center of a circle into which the area will be inscribed.
      Returns:
      the center.

    • 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

    • 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 p, 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:
      p - 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.

    • getRelationship

      public int getRelationship(GeoShape geoShape)
      Description copied from interface: GeoArea
      Find the spatial relationship between a shape and the current geo area. Note: return value is how the GeoShape relates to the GeoArea, not the other way around. For example, if this GeoArea is entirely within the shape, then CONTAINS should be returned. If the shape is entirely enclosed by this GeoArea, then WITHIN should be returned.

      It is permissible to return OVERLAPS instead of WITHIN if the shape intersects with the area at even a single point. So, a circle inscribed in a rectangle could return either OVERLAPS or WITHIN, depending on implementation. It is not permissible to return CONTAINS or DISJOINT in this circumstance, however.

      Similarly, it is permissible to return OVERLAPS instead of CONTAINS under conditions where the shape consists of multiple independent overlapping subshapes, and the area overlaps one of the subshapes. It is not permissible to return WITHIN or DISJOINT in this circumstance, however.

      Specified by:
      getRelationship in interface GeoArea
      Overrides:
      getRelationship in class GeoBaseAreaShape
      Parameters:
      geoShape - is the shape to consider.
      Returns:
      the relationship, from the perspective of the shape.

    • 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