Package org.apache.lucene.spatial3d.geom
Class GeoSouthRectangle
- All Implemented Interfaces:
Bounded
,GeoArea
,GeoAreaShape
,GeoBBox
,GeoMembershipShape
,GeoOutsideDistance
,GeoShape
,GeoSizeable
,Membership
,PlanetObject
,SerializableObject
Bounding box limited on three sides (top lat, left lon, right lon). The other corner is the south
pole. The left-right maximum extent for this shape is PI; for anything larger, use
GeoWideSouthRectangle
.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final SidedPlane
Backing plane (for narrow angles)protected final GeoPoint
The center pointprotected final double
The cosine of a middle latitudeprotected final GeoPoint[]
A point on the edgeprotected final double
The left longitude of the rectprotected final SidedPlane
The left planeprotected final GeoPoint[]
Notable points for the left planeprotected final double
The right longitude of the rectprotected final SidedPlane
The right planeprotected final GeoPoint[]
Notable points for the right planeprotected final double
The top latitude of the rectprotected final SidedPlane
The top planeprotected final GeoPoint[]
Notable points for the top planeprotected final GeoPoint
The upper left hand corner of the rectangleprotected final GeoPoint
The upper right hand corner of the rectangleFields 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
ConstructorsConstructorDescriptionGeoSouthRectangle
(PlanetModel planetModel, double topLat, double leftLon, double rightLon) Accepts only values in the following ranges: lat:-PI/2 -> PI/2
, lon:-PI -> PI
GeoSouthRectangle
(PlanetModel planetModel, InputStream inputStream) Constructor for deserialization. -
Method Summary
Modifier and TypeMethodDescriptionboolean
expand
(double angle) Expand box by specified angle.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.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 Details
-
topLat
protected final double topLatThe top latitude of the rect -
leftLon
protected final double leftLonThe left longitude of the rect -
rightLon
protected final double rightLonThe right longitude of the rect -
cosMiddleLat
protected final double cosMiddleLatThe cosine of a middle latitude -
ULHC
The upper left hand corner of the rectangle -
URHC
The upper right hand corner of the rectangle -
topPlane
The top plane -
leftPlane
The left plane -
rightPlane
The right plane -
backingPlane
Backing plane (for narrow angles) -
topPlanePoints
Notable points for the top plane -
leftPlanePoints
Notable points for the left plane -
rightPlanePoints
Notable points for the right plane -
centerPoint
The center point -
edgePoints
A point on the edge
-
-
Constructor Details
-
GeoSouthRectangle
Accepts only values in the following ranges: lat:-PI/2 -> PI/2
, lon:-PI -> PI
- Parameters:
planetModel
- is the planet model.topLat
- is the top latitude.leftLon
- is the left longitude.rightLon
- is the right longitude.
-
GeoSouthRectangle
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
-
expand
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
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
Description copied from interface:GeoSizeable
Returns the center of a circle into which the area will be inscribed.- Returns:
- the center.
-
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 classGeoBaseShape
- Parameters:
bounds
- is the input bounds object. The input object will be modified.
-
outsideDistance
Description copied from class:GeoBaseMembershipShape
Called by acomputeOutsideDistance
method if X/Y/Z is not within this shape.- Specified by:
outsideDistance
in classGeoBaseMembershipShape
-
equals
- Overrides:
equals
in classBasePlanetObject
-
hashCode
public int hashCode()- Overrides:
hashCode
in classBasePlanetObject
-
toString
-