Package org.apache.lucene.spatial3d.geom
Class GeoDegeneratePoint
- java.lang.Object
-
- org.apache.lucene.spatial3d.geom.Vector
-
- org.apache.lucene.spatial3d.geom.GeoPoint
-
- org.apache.lucene.spatial3d.geom.GeoDegeneratePoint
-
- All Implemented Interfaces:
Bounded
,GeoArea
,GeoAreaShape
,GeoBBox
,GeoCircle
,GeoDistance
,GeoDistanceShape
,GeoMembershipShape
,GeoOutsideDistance
,GeoPointShape
,GeoShape
,GeoSizeable
,Membership
,PlanetObject
,SerializableObject
class GeoDegeneratePoint extends GeoPoint implements GeoPointShape
This class represents a degenerate point bounding box. It is not a simple GeoPoint because we must have the latitude and longitude.
-
-
Field Summary
Fields Modifier and Type Field Description protected GeoPoint[]
edgePoints
Edge point is an area containing just thisprotected PlanetModel
planetModel
Current planet model, since we don't extend BasePlanetObject-
Fields inherited from class org.apache.lucene.spatial3d.geom.GeoPoint
latitude, longitude, magnitude
-
Fields inherited from class org.apache.lucene.spatial3d.geom.Vector
MINIMUM_ANGULAR_RESOLUTION, MINIMUM_RESOLUTION, MINIMUM_RESOLUTION_CUBED, MINIMUM_RESOLUTION_SQUARED, x, y, z
-
-
Constructor Summary
Constructors Constructor Description GeoDegeneratePoint(PlanetModel planetModel, double lat, double lon)
Constructor.GeoDegeneratePoint(PlanetModel planetModel, java.io.InputStream inputStream)
Constructor for deserialization.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double
computeDistance(DistanceStyle distanceStyle, double x, double y, double z)
Compute this shape's internal "distance" to the GeoPoint.double
computeOutsideDistance(DistanceStyle distanceStyle, double x, double y, double z)
Compute this shape's distance to the GeoPoint.double
computeOutsideDistance(DistanceStyle distanceStyle, GeoPoint point)
Compute this shape's distance to the GeoPoint.boolean
equals(java.lang.Object o)
GeoBBox
expand(double angle)
Expand box by specified angle.void
getBounds(Bounds bounds)
Compute bounds for the shape.GeoPoint
getCenter()
Returns the center of a circle into which the area will be inscribed.void
getDistanceBounds(Bounds bounds, DistanceStyle distanceStyle, double distanceValue)
Compute a bound based on a provided distance measure.GeoPoint[]
getEdgePoints()
Return a sample point that is on the outside edge/boundary of the shape.PlanetModel
getPlanetModel()
Returns thePlanetModel
provided when this shape was created.double
getRadius()
Returns the radius of a circle into which the GeoSizeable area can be inscribed.int
getRelationship(GeoShape shape)
Find the spatial relationship between a shape and the current geo area.boolean
intersects(GeoShape geoShape)
Assess whether a shape intersects with any of the edges of this shape.boolean
intersects(Plane plane, 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.boolean
isWithin(Vector point)
Check if a point is within this shape.java.lang.String
toString()
-
Methods inherited from class org.apache.lucene.spatial3d.geom.GeoPoint
arcDistance, arcDistance, getLatitude, getLongitude, isIdentical, isIdentical, magnitude, write
-
Methods inherited from class org.apache.lucene.spatial3d.geom.Vector
computeDesiredEllipsoidMagnitude, computeDesiredEllipsoidMagnitude, crossProductEvaluateIsZero, dotProduct, dotProduct, hashCode, isNumericallyIdentical, isNumericallyIdentical, isParallel, isParallel, isWithin, linearDistance, linearDistance, linearDistanceSquared, linearDistanceSquared, magnitude, normalDistance, normalDistance, normalDistanceSquared, normalDistanceSquared, normalize, rotateXY, rotateXY, rotateXZ, rotateXZ, rotateZY, rotateZY, translate
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoDistance
computeDeltaDistance, computeDeltaDistance, computeDistance
-
Methods inherited from interface org.apache.lucene.spatial3d.geom.SerializableObject
write
-
-
-
-
Field Detail
-
planetModel
protected final PlanetModel planetModel
Current planet model, since we don't extend BasePlanetObject
-
edgePoints
protected final GeoPoint[] edgePoints
Edge point is an area containing just this
-
-
Constructor Detail
-
GeoDegeneratePoint
public GeoDegeneratePoint(PlanetModel planetModel, double lat, double lon)
Constructor.- Parameters:
planetModel
- is the planet model to use.lat
- is the latitude.lon
- is the longitude.
-
GeoDegeneratePoint
public GeoDegeneratePoint(PlanetModel planetModel, java.io.InputStream inputStream) throws java.io.IOException
Constructor for deserialization.- Parameters:
planetModel
- is the planet model to use.inputStream
- is the input stream.- Throws:
java.io.IOException
-
-
Method Detail
-
getPlanetModel
public PlanetModel getPlanetModel()
Description copied from interface:PlanetObject
Returns thePlanetModel
provided when this shape was created.- Specified by:
getPlanetModel
in interfacePlanetObject
-
expand
public GeoBBox expand(double angle)
Description copied from interface:GeoBBox
Expand box by specified angle.
-
getEdgePoints
public GeoPoint[] getEdgePoints()
Description copied from interface:GeoShape
Return a sample point that is on the outside edge/boundary of the shape.- Specified by:
getEdgePoints
in interfaceGeoShape
- 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.- Specified by:
intersects
in interfaceGeoShape
- 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.- Specified by:
intersects
in interfaceGeoAreaShape
- 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.
-
computeOutsideDistance
public double computeOutsideDistance(DistanceStyle distanceStyle, GeoPoint point)
Description copied from interface:GeoOutsideDistance
Compute this shape's distance to the GeoPoint. A return value of 0.0 should be returned for points inside of the shape.- Specified by:
computeOutsideDistance
in interfaceGeoOutsideDistance
- Parameters:
distanceStyle
- is the distance style.point
- is the point to compute the distance to.- Returns:
- the distance.
-
computeOutsideDistance
public double computeOutsideDistance(DistanceStyle distanceStyle, double x, double y, double z)
Description copied from interface:GeoOutsideDistance
Compute this shape's distance to the GeoPoint. A return value of 0.0 should be returned for points inside of the shape.- Specified by:
computeOutsideDistance
in interfaceGeoOutsideDistance
- 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 distance.
-
isWithin
public boolean isWithin(Vector point)
Description copied from interface:Membership
Check if a point is within this shape.- Specified by:
isWithin
in interfaceMembership
- Parameters:
point
- is the point to check.- Returns:
- true if the point is within this shape
-
isWithin
public boolean isWithin(double x, double y, double z)
Description copied from interface:Membership
Check if a point is within this shape.- Specified by:
isWithin
in interfaceMembership
- 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
-
getRadius
public double getRadius()
Description copied from interface:GeoSizeable
Returns the radius of a circle into which the GeoSizeable area can be inscribed.- Specified by:
getRadius
in interfaceGeoSizeable
- 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.- Specified by:
getCenter
in interfaceGeoSizeable
- Returns:
- the center.
-
getRelationship
public int getRelationship(GeoShape shape)
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 interfaceGeoArea
- Parameters:
shape
- is the shape to consider.- Returns:
- the relationship, from the perspective of the shape.
-
computeDistance
public double computeDistance(DistanceStyle distanceStyle, double x, double y, double z)
Description copied from interface:GeoDistance
Compute this shape's internal "distance" to the GeoPoint. Implementations should clarify how this is computed when it's non-obvious. A return value of Double.POSITIVE_INFINITY should be returned for points outside of the shape.- Specified by:
computeDistance
in interfaceGeoDistance
- 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 distance.
-
getDistanceBounds
public void getDistanceBounds(Bounds bounds, DistanceStyle distanceStyle, double distanceValue)
Description copied from interface:GeoDistanceShape
Compute a bound based on a provided distance measure. This method takes an input distance and distance metric and provides bounds on the shape if reduced to match that distance. The method is allowed to return bounds that are larger than the distance would indicate, but never smaller.- Specified by:
getDistanceBounds
in interfaceGeoDistanceShape
- Parameters:
bounds
- is the bounds object to update.distanceStyle
- describes the type of distance metric provided.distanceValue
- is the distance metric to use. It is presumed that the distance metric was produced with the same distance style as is provided to this method.
-
-