Package org.apache.lucene.spatial3d.geom
Class XYZBounds
- java.lang.Object
-
- org.apache.lucene.spatial3d.geom.XYZBounds
-
-
Constructor Summary
Constructors Constructor Description XYZBounds()Construct an empty bounds object
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddBounds(XYZBounds bounds)Add a fully-formed XYZBounds to the current one.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(double x)Add a specific X value.BoundsaddXValue(GeoPoint point)Add an X value.BoundsaddYValue(double y)Add a specific Y value.BoundsaddYValue(GeoPoint point)Add a Y value.BoundsaddZValue(double z)Add a specific Z value.BoundsaddZValue(GeoPoint point)Add a Z value.DoublegetMaximumX()Return the maximum X value.DoublegetMaximumY()Return the maximum Y value.DoublegetMaximumZ()Return the maximum Z value.DoublegetMinimumX()Return the minimum X value.DoublegetMinimumY()Return the minimum Y value.DoublegetMinimumZ()Return the minimum Z value.booleanisLargestMaxX(PlanetModel planetModel)Return true if maxX is as large as the planet model allows.booleanisLargestMaxY(PlanetModel planetModel)Return true if maxY is as large as the planet model allows.booleanisLargestMaxZ(PlanetModel planetModel)Return true if maxZ is as large as the planet model allows.booleanisSmallestMinX(PlanetModel planetModel)Return true if minX is as small as the planet model allows.booleanisSmallestMinY(PlanetModel planetModel)Return true if minY is as small as the planet model allows.booleanisSmallestMinZ(PlanetModel planetModel)Return true if minZ is as small as the planet model allows.BoundsisWide()Signal that the shape exceeds Math.PI in longitude.booleanisWithin(double x, double y, double z)Courtesy method to see if a point is within the bounds.booleanisWithin(Vector v)Courtesy method to see if a point is within the bounds.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.booleanoverlaps(XYZBounds bounds)Check if another XYZBounds object overlaps this one.StringtoString()
-
-
-
Method Detail
-
getMinimumX
public Double getMinimumX()
Return the minimum X value.- Returns:
- minimum X value.
-
getMaximumX
public Double getMaximumX()
Return the maximum X value.- Returns:
- maximum X value.
-
getMinimumY
public Double getMinimumY()
Return the minimum Y value.- Returns:
- minimum Y value.
-
getMaximumY
public Double getMaximumY()
Return the maximum Y value.- Returns:
- maximum Y value.
-
getMinimumZ
public Double getMinimumZ()
Return the minimum Z value.- Returns:
- minimum Z value.
-
getMaximumZ
public Double getMaximumZ()
Return the maximum Z value.- Returns:
- maximum Z value.
-
isSmallestMinX
public boolean isSmallestMinX(PlanetModel planetModel)
Return true if minX is as small as the planet model allows.- Returns:
- true if minX has reached its bound.
-
isLargestMaxX
public boolean isLargestMaxX(PlanetModel planetModel)
Return true if maxX is as large as the planet model allows.- Returns:
- true if maxX has reached its bound.
-
isSmallestMinY
public boolean isSmallestMinY(PlanetModel planetModel)
Return true if minY is as small as the planet model allows.- Returns:
- true if minY has reached its bound.
-
isLargestMaxY
public boolean isLargestMaxY(PlanetModel planetModel)
Return true if maxY is as large as the planet model allows.- Returns:
- true if maxY has reached its bound.
-
isSmallestMinZ
public boolean isSmallestMinZ(PlanetModel planetModel)
Return true if minZ is as small as the planet model allows.- Returns:
- true if minZ has reached its bound.
-
isLargestMaxZ
public boolean isLargestMaxZ(PlanetModel planetModel)
Return true if maxZ is as large as the planet model allows.- Returns:
- true if maxZ has reached its bound.
-
overlaps
public boolean overlaps(XYZBounds bounds)
Check if another XYZBounds object overlaps this one.- Parameters:
bounds- is the other bounds object.- Returns:
- true if there is overlap.
-
addBounds
public void addBounds(XYZBounds bounds)
Add a fully-formed XYZBounds to the current one.- Parameters:
bounds- is the bounds object to modify
-
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)
Add 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)
Add 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.
-
addXValue
public Bounds addXValue(GeoPoint point)
Description copied from interface:BoundsAdd an X value.
-
addXValue
public Bounds addXValue(double x)
Add a specific X value.- Parameters:
x- is the value to add.- Returns:
- the bounds object.
-
addYValue
public Bounds addYValue(GeoPoint point)
Description copied from interface:BoundsAdd a Y value.
-
addYValue
public Bounds addYValue(double y)
Add a specific Y value.- Parameters:
y- is the value to add.- Returns:
- the bounds object.
-
addZValue
public Bounds addZValue(GeoPoint point)
Description copied from interface:BoundsAdd a Z value.
-
addZValue
public Bounds addZValue(double z)
Add a specific Z value.- Parameters:
z- is the value to add.- Returns:
- the bounds object.
-
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.
-
isWide
public Bounds isWide()
Description copied from interface:BoundsSignal that the shape exceeds Math.PI in longitude.
-
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.
-
isWithin
public boolean isWithin(Vector v)
Courtesy method to see if a point is within the bounds.- Parameters:
v- is the point/vector we want to check- Returns:
- true if the bounds contains the vector
-
isWithin
public boolean isWithin(double x, double y, double z)Courtesy method to see if a point is within the bounds.- Parameters:
x- is the x coordinatey- is the y coordinatez- is the z coordinate- Returns:
- true if the bounds contains the vector
-
-