BoundingBox (RS Core TRUNK-SNAPSHOT API)

All Known Implementing Classes:

BoundingBoxDoubleGf
```
public interface BoundingBox
```

Method Summary

Methods
Modifier and Type	Method and Description
`BoundingBox`	`clipToCoordinateSystem()`
`BoundingBox`	`convert(GeometryFactory geometryFactory)`
`BoundingBox`	`convert(GeometryFactory geometryFactory, int axisCount)`
`boolean`	`coveredBy(double... bounds)`
`boolean`	`covers(BoundingBox other)` Tests if the `BoundingBox other` lies wholely inside this `BoundingBox` (inclusive of the boundary).
`boolean`	`covers(double x, double y)` Tests if the given point lies in or on the envelope.
`boolean`	`covers(Geometry geometry)`
`boolean`	`covers(Point point)` Tests if the given point lies in or on the envelope.
`double`	`distance(BoundingBox env)` Computes the distance between this and another `BoundingBox`.
`double`	`distance(Geometry point)`
`BoundingBox`	`expand(double maxDistance)`
`BoundingBox`	`expand(double deltaX, double deltaY)`
`BoundingBox`	`expand(Point point)`
`BoundingBox`	`expandPercent(double d)`
`BoundingBox`	`expandPercent(double factorX, double factorY)`
`BoundingBox`	`expandToInclude(BoundingBox boundingBox)`
`BoundingBox`	`expandToInclude(double... coordinates)`
`BoundingBox`	`expandToInclude(Geometry geometry)`
`BoundingBox`	`expandToInclude(Record record)`
`double`	`getArea()` Gets the area of this envelope.
`double`	`getAspectRatio()`
`int`	`getAxisCount()`
`double[]`	`getBounds()`
`double[]`	`getBounds(int axisCount)`
`Point`	`getCentre()`
`double`	`getCentreX()`
`double`	`getCentreY()`
`CoordinateSystem`	`getCoordinateSystem()`
`Point`	`getCornerPoint(int i)` maxX,minY minX,minY minX,maxY maxX,maxY
`LineString`	`getCornerPoints()`
`GeometryFactory`	`getGeometryFactory()`
`double`	`getHeight()` Returns the difference between the maximum and minimum y values.
`javax.measure.Measure<javax.measure.quantity.Length>`	`getHeightLength()`
`double`	`getMax(int i)`
`<Q extends javax.measure.quantity.Quantity> javax.measure.Measurable<Q>`	`getMaximum(int axisIndex)`
`<Q extends javax.measure.quantity.Quantity> double`	`getMaximum(int axisIndex, javax.measure.unit.Unit convertUnit)`
`double`	`getMaxX()` Returns the `BoundingBox`s maximum x-value.
`double`	`getMaxY()` Returns the `BoundingBox`s maximum y-value.
`double`	`getMin(int i)`
`<Q extends javax.measure.quantity.Quantity> javax.measure.Measurable<Q>`	`getMinimum(int axisIndex)`
`<Q extends javax.measure.quantity.Quantity> double`	`getMinimum(int axisIndex, javax.measure.unit.Unit convertUnit)`
`double`	`getMinX()` Returns the `BoundingBox`s minimum x-value.
`double`	`getMinY()` Returns the `BoundingBox`s minimum y-value.
`Point`	`getRandomPointWithin()`
`int`	`getSrid()`
`Point`	`getTopLeftPoint()`
`double`	`getWidth()` Returns the difference between the maximum and minimum x values.
`javax.measure.Measure<javax.measure.quantity.Length>`	`getWidthLength()`
`BoundingBox`	`intersection(BoundingBox env)` Computes the intersection of two `BoundingBox`s.
`boolean`	`intersects(BoundingBox other)` Check if the region defined by `other` overlaps (intersects) the region of this `BoundingBox`.
`boolean`	`intersects(double x, double y)` Check if the point `(x, y)` overlaps (lies inside) the region of this `BoundingBox`.
`boolean`	`intersects(double x1, double y1, double x2, double y2)` Check if the line `(x1, y1) -> (x2, y2)` intersects (covered by or crosses) the region of this `BoundingBox`.
`boolean`	`intersects(Point p)` Check if the point `p` overlaps (lies inside) the region of this `BoundingBox`.
`boolean`	`isEmpty()`
`BoundingBox`	`move(double deltaX, double deltaY)`
`Geometry`	`toGeometry()` Creates a `Geometry` with the same extent as the given envelope.
`Polygon`	`toPolygon()`
`Polygon`	`toPolygon(GeometryFactory geometryFactory)`
`Polygon`	`toPolygon(GeometryFactory factory, int numPoints)`
`Polygon`	`toPolygon(GeometryFactory geometryFactory, int numX, int numY)`
`Polygon`	`toPolygon(int numSegments)`
`Polygon`	`toPolygon(int numX, int numY)`

- Method Detail
  - clipToCoordinateSystem
```
BoundingBox clipToCoordinateSystem()
```
  - convert
```
BoundingBox convert(GeometryFactory geometryFactory)
```
  - convert
```
BoundingBox convert(GeometryFactory geometryFactory,
                  int axisCount)
```
  - coveredBy
```
boolean coveredBy(double... bounds)
```
  - covers
```
boolean covers(BoundingBox other)
```
    Tests if the BoundingBox other lies wholely inside this BoundingBox (inclusive of the boundary).
    
    Parameters:
    other - the BoundingBox to check
    
    Returns:
    true if this BoundingBox covers the other
  - covers
```
boolean covers(double x,
             double y)
```
    Tests if the given point lies in or on the envelope.
    
    Parameters:
    x - the x-coordinate of the point which this BoundingBox is being checked for containing
    y - the y-coordinate of the point which this BoundingBox is being checked for containing
    
    Returns:
    true if (x, y) lies in the interior or on the boundary of this BoundingBox.
  - covers
```
boolean covers(Geometry geometry)
```
  - covers
```
boolean covers(Point point)
```
    Tests if the given point lies in or on the envelope.
    
    Parameters:
    p - the point which this BoundingBox is being checked for containing
    
    Returns:
    true if the point lies in the interior or on the boundary of this BoundingBox.
  - distance
```
double distance(BoundingBox env)
```
    Computes the distance between this and another BoundingBox. The distance between overlapping BoundingBoxs is 0. Otherwise, the distance is the Euclidean distance between the closest points.
  - distance
```
double distance(Geometry point)
```
  - expand
```
BoundingBox expand(double maxDistance)
```
  - expand
```
BoundingBox expand(double deltaX,
                 double deltaY)
```
  - expand
```
BoundingBox expand(Point point)
```
  - expandPercent
```
BoundingBox expandPercent(double d)
```
  - expandPercent
```
BoundingBox expandPercent(double factorX,
                        double factorY)
```
  - expandToInclude
```
BoundingBox expandToInclude(BoundingBox boundingBox)
```
  - expandToInclude
```
BoundingBox expandToInclude(double... coordinates)
```
  - expandToInclude
```
BoundingBox expandToInclude(Geometry geometry)
```
  - expandToInclude
```
BoundingBox expandToInclude(Record record)
```
  - getArea
```
double getArea()
```
    Gets the area of this envelope.
    
    Returns:
    the area of the envelope
  - getAspectRatio
```
double getAspectRatio()
```
  - getAxisCount
```
int getAxisCount()
```
  - getBounds
```
double[] getBounds()
```
  - getBounds
```
double[] getBounds(int axisCount)
```
  - getCentre
```
Point getCentre()
```
  - getCentreX
```
double getCentreX()
```
  - getCentreY
```
double getCentreY()
```
  - getCoordinateSystem
```
CoordinateSystem getCoordinateSystem()
```
  - getCornerPoint
```
Point getCornerPoint(int i)
```
    maxX,minY minX,minY minX,maxY maxX,maxY
  - getCornerPoints
```
LineString getCornerPoints()
```
  - getGeometryFactory
```
GeometryFactory getGeometryFactory()
```
  - getHeight
```
double getHeight()
```
    Returns the difference between the maximum and minimum y values.
    
    Returns:
    max y - min y, or 0 if this is a null BoundingBox
  - getHeightLength
```
javax.measure.Measure<javax.measure.quantity.Length> getHeightLength()
```
  - getMax
```
double getMax(int i)
```
  - getMaximum
```
<Q extends javax.measure.quantity.Quantity> javax.measure.Measurable<Q> getMaximum(int axisIndex)
```
  - getMaximum
```
<Q extends javax.measure.quantity.Quantity> double getMaximum(int axisIndex,
                                                            javax.measure.unit.Unit convertUnit)
```
  - getMaxX
```
double getMaxX()
```
    Returns the BoundingBoxs maximum x-value. min x > max x indicates that this is a null BoundingBox.
    
    Returns:
    the maximum x-coordinate
  - getMaxY
```
double getMaxY()
```
    Returns the BoundingBoxs maximum y-value. min y > max y indicates that this is a null BoundingBox.
    
    Returns:
    the maximum y-coordinate
  - getMin
```
double getMin(int i)
```
  - getMinimum
```
<Q extends javax.measure.quantity.Quantity> javax.measure.Measurable<Q> getMinimum(int axisIndex)
```
  - getMinimum
```
<Q extends javax.measure.quantity.Quantity> double getMinimum(int axisIndex,
                                                            javax.measure.unit.Unit convertUnit)
```
  - getMinX
```
double getMinX()
```
    Returns the BoundingBoxs minimum x-value. min x > max x indicates that this is a null BoundingBox.
    
    Returns:
    the minimum x-coordinate
  - getMinY
```
double getMinY()
```
    Returns the BoundingBoxs minimum y-value. min y > max y indicates that this is a null BoundingBox.
    
    Returns:
    the minimum y-coordinate
  - getRandomPointWithin
```
Point getRandomPointWithin()
```
  - getSrid
```
int getSrid()
```
  - getTopLeftPoint
```
Point getTopLeftPoint()
```
  - getWidth
```
double getWidth()
```
    Returns the difference between the maximum and minimum x values.
    
    Returns:
    max x - min x, or 0 if this is a null BoundingBox
  - getWidthLength
```
javax.measure.Measure<javax.measure.quantity.Length> getWidthLength()
```
  - intersection
```
BoundingBox intersection(BoundingBox env)
```
    Computes the intersection of two BoundingBoxs.
    
    Parameters:
    env - the envelope to intersect with
    
    Returns:
    a new BoundingBox representing the intersection of the envelopes (this will be the null envelope if either argument is null, or they do not intersect
  - intersects
```
boolean intersects(BoundingBox other)
```
    Check if the region defined by other overlaps (intersects) the region of this BoundingBox.
    
    Parameters:
    other - the BoundingBox which this BoundingBox is being checked for overlapping
    
    Returns:
    true if the BoundingBoxs overlap
  - intersects
```
boolean intersects(double x,
                 double y)
```
    Check if the point (x, y) overlaps (lies inside) the region of this BoundingBox.
    
    Parameters:
    x - the x-ordinate of the point
    y - the y-ordinate of the point
    
    Returns:
    true if the point overlaps this BoundingBox
  - intersects
```
boolean intersects(double x1,
                 double y1,
                 double x2,
                 double y2)
```
    Check if the line (x1, y1) -> (x2, y2) intersects (covered by or crosses) the region of this BoundingBox.
    
    Returns:
    true if the line overlaps this BoundingBox
  - intersects
```
boolean intersects(Point p)
```
    Check if the point p overlaps (lies inside) the region of this BoundingBox.
    
    Parameters:
    p - the Coordinate to be tested
    
    Returns:
    true if the point overlaps this BoundingBox
  - isEmpty
```
boolean isEmpty()
```
  - move
```
BoundingBox move(double deltaX,
               double deltaY)
```
  - toGeometry
```
Geometry toGeometry()
```
    Creates a Geometry with the same extent as the given envelope. The Geometry returned is guaranteed to be valid. To provide this behaviour, the following cases occur:
    If the BoundingBoxDoubleGf is:
    - null : returns an empty Point
    - a point : returns a non-empty Point
    - a line : returns a two-point LineString
    - a rectangle : returns a Polygon> whose points are (minx, miny), (minx, maxy), (maxx, maxy), (maxx, miny), (minx, miny).
    Parameters:
    envelope - the BoundingBoxDoubleGf to convert
    
    Returns:
    an empty Point (for null BoundingBoxDoubleGfs), a Point (when min x = max x and min y = max y) or a Polygon (in all other cases)
  - toPolygon
```
Polygon toPolygon()
```
  - toPolygon
```
Polygon toPolygon(GeometryFactory geometryFactory)
```
  - toPolygon
```
Polygon toPolygon(GeometryFactory factory,
                int numPoints)
```
  - toPolygon
```
Polygon toPolygon(GeometryFactory geometryFactory,
                int numX,
                int numY)
```
  - toPolygon
```
Polygon toPolygon(int numSegments)
```
  - toPolygon
```
Polygon toPolygon(int numX,
                int numY)
```

Interface BoundingBox

Method Summary

Method Detail

clipToCoordinateSystem

convert

convert

coveredBy

covers

covers

covers

covers

distance

distance

expand

expand

expand

expandPercent

expandPercent

expandToInclude

expandToInclude

expandToInclude

expandToInclude

getArea

getAspectRatio

getAxisCount

getBounds

getBounds

getCentre

getCentreX

getCentreY

getCoordinateSystem

getCornerPoint

getCornerPoints

getGeometryFactory

getHeight

getHeightLength

getMax

getMaximum

getMaximum

getMaxX

getMaxY

getMin

getMinimum

getMinimum

getMinX

getMinY

getRandomPointWithin

getSrid

getTopLeftPoint

getWidth

getWidthLength

intersection

intersects

intersects

intersects

intersects

isEmpty

move

toGeometry

toPolygon

toPolygon

toPolygon

toPolygon

toPolygon

toPolygon