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.GeoExactCircle
- All Implemented Interfaces:
Bounded
,GeoArea
,GeoAreaShape
,GeoBounds
,GeoCircle
,GeoDistance
,GeoDistanceShape
,GeoMembershipShape
,GeoOutsideDistance
,GeoShape
,GeoSizeable
,Membership
,PlanetObject
,SerializableObject
Circular area with a center and a radius that represents the surface distance to the center. The
circle is divided in sectors where the circle edge is approximated using Vincenty formulae. The
higher is the precision the more sectors are needed to describe the shape and therefore a penalty
in performance.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
A temporary description of a section of circle.protected static class
A description of a section of circle. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final double
Actual accuracyprotected final GeoPoint
Center of circleprotected final List
<GeoExactCircle.CircleSlice> Slices of the circleprotected final GeoPoint[]
A point that is on the edge of the circleprotected final double
Radius of circleFields inherited from class org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
ALL_INSIDE, NONE_INSIDE, SOME_INSIDE
Fields inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
planetModel
-
Constructor Summary
ConstructorsConstructorDescriptionGeoExactCircle
(PlanetModel planetModel, double lat, double lon, double radius, double accuracy) Constructor.GeoExactCircle
(PlanetModel planetModel, InputStream inputStream) Constructor for deserialization. -
Method Summary
Modifier and TypeMethodDescriptionprotected double
distance
(DistanceStyle distanceStyle, double x, double y, double z) Called by acomputeDistance
method if X/Y/Z is within this shape.protected void
distanceBounds
(Bounds bounds, DistanceStyle distanceStyle, double distanceValue) Called by agetDistanceBounds
method if distanceValue is not Double.POSITIVE_INFINITY.boolean
void
Compute bounds for the shape.Returns the center of a circle into which the area will be inscribed.GeoPoint[]
Return a sample point that is on the outside edge/boundary of the shape.double
Returns the radius of a circle into which the GeoSizeable area can be inscribed.int
hashCode()
boolean
intersects
(GeoShape geoShape) Assess whether a shape intersects with any of the edges of this shape.boolean
intersects
(Plane p, GeoPoint[] notablePoints, Membership... bounds) Assess whether a plane, within the provided bounds, intersects with the shape's edges.boolean
isWithin
(double x, double y, double z) Check if a point is within this shape.protected double
outsideDistance
(DistanceStyle distanceStyle, double x, double y, double z) Called by acomputeOutsideDistance
method if X/Y/Z is not within this shape.toString()
void
write
(OutputStream outputStream) Serialize to output stream.Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
computeDeltaDistance, computeDeltaDistance, computeDistance, computeDistance, deltaDistance, getDistanceBounds, isWithin
Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
getRelationship, isGeoAreaShapeInsideShape, isShapeInsideGeoAreaShape
Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
computeOutsideDistance, computeOutsideDistance
Methods inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
getPlanetModel
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoArea
getRelationship
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoDistance
computeDeltaDistance, computeDeltaDistance, computeDistance, computeDistance
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoDistanceShape
getDistanceBounds
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoOutsideDistance
computeOutsideDistance, computeOutsideDistance
Methods inherited from interface org.apache.lucene.spatial3d.geom.Membership
isWithin
Methods inherited from interface org.apache.lucene.spatial3d.geom.PlanetObject
getPlanetModel
-
Field Details
-
center
Center of circle -
radius
protected final double radiusRadius of circle -
actualAccuracy
protected final double actualAccuracyActual accuracy -
edgePoints
A point that is on the edge of the circle -
circleSlices
Slices of the circle
-
-
Constructor Details
-
GeoExactCircle
public GeoExactCircle(PlanetModel planetModel, double lat, double lon, double radius, double accuracy) Constructor.- Parameters:
planetModel
- is the planet model.lat
- is the center latitude.lon
- is the center longitude.radius
- is the surface radius for the circle.accuracy
- is the allowed error value (linear distance). Maximum accuracy is 1e-12.
-
GeoExactCircle
Constructor for deserialization.- Parameters:
planetModel
- is the planet model.inputStream
- is the input stream.- Throws:
IOException
-
-
Method Details
-
write
Description copied from interface:SerializableObject
Serialize to output stream.- Specified by:
write
in interfaceSerializableObject
- Overrides:
write
in classBasePlanetObject
- 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
Description copied from interface:GeoSizeable
Returns the center of a circle into which the area will be inscribed.- Returns:
- the center.
-
distance
Description copied from class:GeoBaseDistanceShape
Called by acomputeDistance
method if X/Y/Z is within this shape.- Specified by:
distance
in classGeoBaseDistanceShape
-
distanceBounds
Description copied from class:GeoBaseDistanceShape
Called by agetDistanceBounds
method if distanceValue is not Double.POSITIVE_INFINITY.- Specified by:
distanceBounds
in classGeoBaseDistanceShape
-
outsideDistance
Description copied from class:GeoBaseMembershipShape
Called by acomputeOutsideDistance
method if X/Y/Z is not within this shape.- Specified by:
outsideDistance
in classGeoBaseMembershipShape
-
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
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
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
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
Description copied from interface:Bounded
Compute bounds for the shape.- Specified by:
getBounds
in interfaceBounded
- Overrides:
getBounds
in classGeoBaseBounds
- Parameters:
bounds
- is the input bounds object. The input object will be modified.
-
equals
- Overrides:
equals
in classBasePlanetObject
-
hashCode
public int hashCode()- Overrides:
hashCode
in classBasePlanetObject
-
toString
-