Package org.apache.lucene.spatial3d.geom
Class GeoWideRectangle
- java.lang.Object
-
- All Implemented Interfaces:
Bounded
,GeoArea
,GeoAreaShape
,GeoBBox
,GeoMembershipShape
,GeoOutsideDistance
,GeoShape
,GeoSizeable
,Membership
,PlanetObject
,SerializableObject
class GeoWideRectangle extends GeoBaseBBox
Bounding box wider than PI but limited on four sides (top lat, bottom lat, left lon, right lon).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
GeoWideRectangle.EitherBound
A membership implementation representing a wide (more than 180) left/right bound.
-
Field Summary
Fields Modifier and Type Field Description protected double
bottomLat
The bottom latitudeprotected SidedPlane
bottomPlane
Bottom planeprotected GeoPoint[]
bottomPlanePoints
Bottom plane's notable pointsprotected GeoPoint
centerPoint
Center pointprotected double
cosMiddleLat
Cosine of the middle latitudeprotected GeoPoint[]
edgePoints
A point on the edgeprotected GeoWideRectangle.EitherBound
eitherBound
Combined left/right boundsprotected double
leftLon
The left longitudeprotected SidedPlane
leftPlane
Left planeprotected GeoPoint[]
leftPlanePoints
Left plane's notable pointsprotected GeoPoint
LLHC
Lower left hand corner pointprotected GeoPoint
LRHC
Lower right hand corner pointstatic double
MIN_WIDE_EXTENT
Minimum extent for a rectangle of this typeprotected double
rightLon
The right longitudeprotected SidedPlane
rightPlane
Right planeprotected GeoPoint[]
rightPlanePoints
Right plane's notable pointsprotected double
topLat
The top latitudeprotected SidedPlane
topPlane
Top planeprotected GeoPoint[]
topPlanePoints
Top plane's notable pointsprotected GeoPoint
ULHC
Upper left hand corner pointprotected GeoPoint
URHC
Lower right hand corner point-
Fields 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
Constructors Constructor Description GeoWideRectangle(PlanetModel planetModel, double topLat, double bottomLat, double leftLon, double rightLon)
Accepts only values in the following ranges: lat:-PI/2 -> PI/2
, lon:-PI -> PI
.GeoWideRectangle(PlanetModel planetModel, java.io.InputStream inputStream)
Constructor for deserialization.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.GeoPoint[]
getEdgePoints()
Return a sample point that is on the outside edge/boundary of the shape.double
getRadius()
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.java.lang.String
toString()
void
write(java.io.OutputStream outputStream)
Serialize to output stream.-
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, isWithin
-
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.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 Detail
-
MIN_WIDE_EXTENT
public static final double MIN_WIDE_EXTENT
Minimum extent for a rectangle of this type- See Also:
- Constant Field Values
-
topLat
protected final double topLat
The top latitude
-
bottomLat
protected final double bottomLat
The bottom latitude
-
leftLon
protected final double leftLon
The left longitude
-
rightLon
protected final double rightLon
The right longitude
-
cosMiddleLat
protected final double cosMiddleLat
Cosine of the middle latitude
-
ULHC
protected final GeoPoint ULHC
Upper left hand corner point
-
URHC
protected final GeoPoint URHC
Lower right hand corner point
-
LRHC
protected final GeoPoint LRHC
Lower right hand corner point
-
LLHC
protected final GeoPoint LLHC
Lower left hand corner point
-
topPlane
protected final SidedPlane topPlane
Top plane
-
bottomPlane
protected final SidedPlane bottomPlane
Bottom plane
-
leftPlane
protected final SidedPlane leftPlane
Left plane
-
rightPlane
protected final SidedPlane rightPlane
Right plane
-
topPlanePoints
protected final GeoPoint[] topPlanePoints
Top plane's notable points
-
bottomPlanePoints
protected final GeoPoint[] bottomPlanePoints
Bottom plane's notable points
-
leftPlanePoints
protected final GeoPoint[] leftPlanePoints
Left plane's notable points
-
rightPlanePoints
protected final GeoPoint[] rightPlanePoints
Right plane's notable points
-
centerPoint
protected final GeoPoint centerPoint
Center point
-
eitherBound
protected final GeoWideRectangle.EitherBound eitherBound
Combined left/right bounds
-
edgePoints
protected final GeoPoint[] edgePoints
A point on the edge
-
-
Constructor Detail
-
GeoWideRectangle
public GeoWideRectangle(PlanetModel planetModel, double topLat, double bottomLat, double leftLon, double rightLon)
Accepts only values in the following ranges: lat:-PI/2 -> PI/2
, lon:-PI -> PI
. Horizontal angle must be greater than or equal to PI.- Parameters:
planetModel
- is the planet model.topLat
- is the top latitude.bottomLat
- is the bottom latitude.leftLon
- is the left longitude.rightLon
- is the right longitude.
-
GeoWideRectangle
public GeoWideRectangle(PlanetModel planetModel, java.io.InputStream inputStream) throws java.io.IOException
Constructor for deserialization.- Parameters:
planetModel
- is the planet model.inputStream
- is the input stream.- Throws:
java.io.IOException
-
-
Method Detail
-
write
public void write(java.io.OutputStream outputStream) throws java.io.IOException
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:
java.io.IOException
-
expand
public GeoBBox expand(double angle)
Description copied from interface:GeoBBox
Expand box by specified angle.- Parameters:
angle
- is the angle amount to expand the GeoBBox by.- Returns:
- a new GeoBBox.
-
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
-
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.
-
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.
-
getCenter
public GeoPoint getCenter()
Returns the center of a circle into which the area will be inscribed.- Returns:
- the center.
-
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.
-
getBounds
public void getBounds(Bounds bounds)
Description copied from interface:Bounded
Compute bounds for the shape.- Specified by:
getBounds
in interfaceBounded
- Overrides:
getBounds
in classGeoBaseShape
- Parameters:
bounds
- is the input bounds object. The input object will be modified.
-
outsideDistance
protected double outsideDistance(DistanceStyle distanceStyle, double x, double y, double z)
Description copied from class:GeoBaseMembershipShape
Called by acomputeOutsideDistance
method if X/Y/Z is not within this shape.- Specified by:
outsideDistance
in classGeoBaseMembershipShape
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classBasePlanetObject
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classBasePlanetObject
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-