Package org.apache.lucene.spatial3d.geom
Class LatLonBounds
- java.lang.Object
-
- org.apache.lucene.spatial3d.geom.LatLonBounds
-
-
Constructor Summary
Constructors Constructor Description LatLonBounds()Construct an empty bounds object
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BoundsaddHorizontalPlane(PlanetModel planetModel, double latitude, Plane horizontalPlane, Membership... bounds)Add a horizontal plane to the bounds description.BoundsaddIntersection(PlanetModel planetModel, Plane plane1, Plane plane2, Membership... bounds)Add the intersection between two planes to the bounds description.BoundsaddPlane(PlanetModel planetModel, Plane plane, Membership... bounds)Add a general plane to the bounds description.BoundsaddPoint(GeoPoint point)Add a single point.BoundsaddVerticalPlane(PlanetModel planetModel, double longitude, Plane verticalPlane, Membership... bounds)Add a vertical plane to the bounds description.BoundsaddXValue(GeoPoint point)Add an X value.BoundsaddYValue(GeoPoint point)Add a Y value.BoundsaddZValue(GeoPoint point)Add a Z value.booleancheckNoBottomLatitudeBound()Check if there's no bottom latitude bound.booleancheckNoLongitudeBound()Check if there's no longitude bound.booleancheckNoTopLatitudeBound()Check if there's no top latitude bound.DoublegetLeftLongitude()Get left longitude, if any.DoublegetMaxLatitude()Get maximum latitude, if any.DoublegetMinLatitude()Get minimum latitude, if any.DoublegetRightLongitude()Get right longitude, if any.BoundsisWide()Signal that the shape exceeds Math.PI in longitude.BoundsnoBottomLatitudeBound()Signal that there is no bottom latitude bound.BoundsnoBound(PlanetModel planetModel)Signal that there is no bound whatsoever.BoundsnoLongitudeBound()Signal that there is no longitude bound.BoundsnoTopLatitudeBound()Signal that there is no top latitude bound.StringtoString()
-
-
-
Method Detail
-
getMaxLatitude
public Double getMaxLatitude()
Get maximum latitude, if any.- Returns:
- maximum latitude or null.
-
getMinLatitude
public Double getMinLatitude()
Get minimum latitude, if any.- Returns:
- minimum latitude or null.
-
getLeftLongitude
public Double getLeftLongitude()
Get left longitude, if any.- Returns:
- left longitude, or null.
-
getRightLongitude
public Double getRightLongitude()
Get right longitude, if any.- Returns:
- right longitude, or null.
-
checkNoLongitudeBound
public boolean checkNoLongitudeBound()
Check if there's no longitude bound.- Returns:
- true if no longitude bound.
-
checkNoTopLatitudeBound
public boolean checkNoTopLatitudeBound()
Check if there's no top latitude bound.- Returns:
- true if no top latitude bound.
-
checkNoBottomLatitudeBound
public boolean checkNoBottomLatitudeBound()
Check if there's no bottom latitude bound.- Returns:
- true if no bottom latitude bound.
-
addPlane
public Bounds addPlane(PlanetModel planetModel, Plane plane, Membership... bounds)
Description copied from interface:BoundsAdd a general plane to the bounds description.
-
addHorizontalPlane
public Bounds addHorizontalPlane(PlanetModel planetModel, double latitude, Plane horizontalPlane, Membership... bounds)
Description copied from interface:BoundsAdd a horizontal plane to the bounds description. This method should EITHER use the supplied latitude, OR use the supplied plane, depending on what is most efficient.- Specified by:
addHorizontalPlanein interfaceBounds- Parameters:
planetModel- is the planet model.latitude- is the latitude.horizontalPlane- is the plane.bounds- are the constraints on the plane.- Returns:
- updated Bounds object.
-
addVerticalPlane
public Bounds addVerticalPlane(PlanetModel planetModel, double longitude, Plane verticalPlane, Membership... bounds)
Description copied from interface:BoundsAdd a vertical plane to the bounds description. This method should EITHER use the supplied longitude, OR use the supplied plane, depending on what is most efficient.- Specified by:
addVerticalPlanein interfaceBounds- Parameters:
planetModel- is the planet model.longitude- is the longitude.verticalPlane- is the plane.bounds- are the constraints on the plane.- Returns:
- updated Bounds object.
-
isWide
public Bounds isWide()
Description copied from interface:BoundsSignal that the shape exceeds Math.PI in longitude.
-
addXValue
public Bounds addXValue(GeoPoint point)
Description copied from interface:BoundsAdd an X value.
-
addYValue
public Bounds addYValue(GeoPoint point)
Description copied from interface:BoundsAdd a Y value.
-
addZValue
public Bounds addZValue(GeoPoint point)
Description copied from interface:BoundsAdd a Z value.
-
addIntersection
public Bounds addIntersection(PlanetModel planetModel, Plane plane1, Plane plane2, Membership... bounds)
Description copied from interface:BoundsAdd the intersection between two planes to the bounds description. Where the shape has intersecting planes, it is better to use this method than just adding the point, since this method takes each plane's error envelope into account.- Specified by:
addIntersectionin interfaceBounds- Parameters:
planetModel- is the planet model.plane1- is the first plane.plane2- is the second plane.bounds- are the membership bounds for the intersection.
-
addPoint
public Bounds addPoint(GeoPoint point)
Description copied from interface:BoundsAdd a single point.
-
noLongitudeBound
public Bounds noLongitudeBound()
Description copied from interface:BoundsSignal that there is no longitude bound.- Specified by:
noLongitudeBoundin interfaceBounds- Returns:
- the updated Bounds object.
-
noTopLatitudeBound
public Bounds noTopLatitudeBound()
Description copied from interface:BoundsSignal that there is no top latitude bound.- Specified by:
noTopLatitudeBoundin interfaceBounds- Returns:
- the updated Bounds object.
-
noBottomLatitudeBound
public Bounds noBottomLatitudeBound()
Description copied from interface:BoundsSignal that there is no bottom latitude bound.- Specified by:
noBottomLatitudeBoundin interfaceBounds- Returns:
- the updated Bounds object.
-
noBound
public Bounds noBound(PlanetModel planetModel)
Description copied from interface:BoundsSignal that there is no bound whatsoever. The bound is limited only by the constraints of the planet.
-
-