Class Envelope2DArchived
- All Implemented Interfaces:
Shape
,Serializable
,Cloneable
,BoundingBox
,Bounds
,Cloneable
Rectangle2D
. This implementation is provided for interoperability
between Java2D and GeoAPI.
Note: This class inherits x and y fields. But despite their names, they don't need to be oriented toward East and North respectively. The (x,y) axis can have any orientation and should be understood as "ordinate 0" and "ordinate 1" values instead. This is not specific to this implementation; in Java2D too, the visual axis orientation depend on the affine transform in the graphics context.
- Since:
- 2.1
- Author:
- Martin Desruisseaux (IRD)
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class Rectangle2D
Rectangle2D.Double, Rectangle2D.Float
-
Field Summary
Fields inherited from class Rectangle2D.Double
height, width, x, y
Fields inherited from class Rectangle2D
OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty envelope with no CRS.Envelope2DArchived
(Bounds envelope) Constructs two-dimensional envelope defined by an otherBounds
.Constructs an initially empty envelope with the defined CRS.Envelope2DArchived
(CoordinateReferenceSystem crs, double x, double y, double width, double height) Constructs two-dimensional envelope defined by the specified coordinates.Constructs two-dimensional envelope defined by an otherRectangle2D
.Envelope2DArchived
(Position2D minDP, Position2D maxDP) Constructs two-dimensional envelope defined by the specified coordinates. -
Method Summary
Modifier and TypeMethodDescriptionboolean
boundsEquals
(Bounds that, int xDim, int yDim, double eps) Returnstrue
ifthis
envelope bounds is equals tothat
envelope bounds in two specified dimensions.boolean
contains
(BoundingBox bounds) Returnstrue
if the provided bounds are contained by this bounding box.boolean
Returnstrue
if the provided location is contained by this bounding box.boolean
Compares the specified object with this envelope for equality.Returns the coordinate reference system in which the coordinates are given.final int
Returns the number of dimensions.A coordinate position consisting of all the minimal ordinates for each dimension for all points within theEnvelope
.final double
getMaximum
(int dimension) Returns the maximal ordinate along the specified dimension.final double
getMedian
(int dimension) Returns the median ordinate along the specified dimension.final double
getMinimum
(int dimension) Returns the minimal ordinate along the specified dimension.final double
getSpan
(int dimension) Returns the envelope span (typically width or height) along the specified dimension.A coordinate position consisting of all the maximal ordinates for each dimension for all points within theEnvelope
.int
hashCode()
Returns a hash value for this envelope.void
include
(double x, double y) Includes the provided coordinates, expanding as necessary.void
include
(BoundingBox bounds) Includes the provided bounding box, expanding as necessary.boolean
intersects
(BoundingBox bounds) Returnstrue
if the interior of this bounds intersects the interior of the provided bounds.void
setBounds
(BoundingBox bounds) Sets this bounding box to be the same as the specified box.void
Set the coordinate reference system in which the coordinate are given.toBounds
(CoordinateReferenceSystem targetCRS) Transforms this box to the specified CRS and returns a new bounding box for the transformed shape.toString()
Returns a string representation of this envelope.Methods inherited from class Rectangle2D.Double
createIntersection, createUnion, getBounds2D, getHeight, getWidth, getX, getY, isEmpty, outcode, setRect, setRect
Methods inherited from class Rectangle2D
add, add, add, contains, contains, getPathIterator, getPathIterator, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, union
Methods inherited from class RectangularShape
clone, contains, contains, getBounds, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal
-
Constructor Details
-
Envelope2DArchived
public Envelope2DArchived()Constructs an initially empty envelope with no CRS.Unlike a normal Envelope2DArchived we set the width and height to -1 so we can tell the difference between:
- Since:
- 2.5
-
Envelope2DArchived
Constructs an initially empty envelope with the defined CRS.- Parameters:
crs
- The coordinate reference system, ornull
.
-
Envelope2DArchived
Constructs two-dimensional envelope defined by an otherBounds
.- Parameters:
envelope
- The envelope to copy.
-
Envelope2DArchived
Constructs two-dimensional envelope defined by an otherRectangle2D
.- Parameters:
crs
- The coordinate reference system, ornull
.rect
- The rectangle to copy.
-
Envelope2DArchived
public Envelope2DArchived(CoordinateReferenceSystem crs, double x, double y, double width, double height) Constructs two-dimensional envelope defined by the specified coordinates. Despite their name, the (x,y) coordinates don't need to be oriented toward (East, North). Those parameter names simply match the x and y fields. The actual axis orientations are determined by the specified CRS. See the class javadoc for details.- Parameters:
crs
- The coordinate reference system, ornull
.x
- The x minimal value.y
- The y minimal value.width
- The envelope width.height
- The envelope height.
-
Envelope2DArchived
public Envelope2DArchived(Position2D minDP, Position2D maxDP) throws MismatchedReferenceSystemException Constructs two-dimensional envelope defined by the specified coordinates. Despite their name, the (x,y) coordinates don't need to be oriented toward (East, North). Those parameter names simply match the x and y fields. The actual axis orientations are determined by the specified CRS. See the class javadoc for details.The
minDP
andmaxDP
arguments usually contains the minimal and maximal ordinate values respectively, but this is not mandatory. The ordinates will be rearanged as needed.- Parameters:
minDP
- The fist position.maxDP
- The second position.- Throws:
MismatchedReferenceSystemException
- if the two positions don't use the same CRS.- Since:
- 2.4
-
-
Method Details
-
getCoordinateReferenceSystem
Returns the coordinate reference system in which the coordinates are given.- Specified by:
getCoordinateReferenceSystem
in interfaceBounds
- Returns:
- The coordinate reference system, or
null
.
-
setCoordinateReferenceSystem
Set the coordinate reference system in which the coordinate are given.- Parameters:
crs
- The new coordinate reference system, ornull
.
-
getDimension
public final int getDimension()Returns the number of dimensions.- Specified by:
getDimension
in interfaceBounds
- Returns:
- The dimensionality of this envelope.
-
getLowerCorner
A coordinate position consisting of all the minimal ordinates for each dimension for all points within theEnvelope
.- Specified by:
getLowerCorner
in interfaceBounds
- Returns:
- The lower corner.
-
getUpperCorner
A coordinate position consisting of all the maximal ordinates for each dimension for all points within theEnvelope
.- Specified by:
getUpperCorner
in interfaceBounds
- Returns:
- The upper corner.
-
getMinimum
Returns the minimal ordinate along the specified dimension.- Specified by:
getMinimum
in interfaceBounds
- Parameters:
dimension
- The dimension to query.- Returns:
- The minimal ordinate value along the given dimension.
- Throws:
IndexOutOfBoundsException
- If the given index is out of bounds.- See Also:
-
getMaximum
Returns the maximal ordinate along the specified dimension.- Specified by:
getMaximum
in interfaceBounds
- Parameters:
dimension
- The dimension to query.- Returns:
- The maximal ordinate value along the given dimension.
- Throws:
IndexOutOfBoundsException
- If the given index is out of bounds.- See Also:
-
getMedian
Returns the median ordinate along the specified dimension. The result should be equals (minus rounding error) to(getMaximum(dimension) - getMinimum(dimension)) / 2
.- Specified by:
getMedian
in interfaceBounds
- Parameters:
dimension
- The dimension to query.- Returns:
- The mid ordinate value along the given dimension.
- Throws:
IndexOutOfBoundsException
- If the given index is out of bounds.- See Also:
-
getSpan
Returns the envelope span (typically width or height) along the specified dimension. The result should be equals (minus rounding error) togetMaximum(dimension) - getMinimum(dimension)
.- Specified by:
getSpan
in interfaceBounds
- Parameters:
dimension
- The dimension to query.- Returns:
- The difference along maximal and minimal ordinates in the given dimension.
- Throws:
IndexOutOfBoundsException
- If the given index is out of bounds.- See Also:
-
hashCode
public int hashCode()Returns a hash value for this envelope. This value need not remain consistent between different implementations of the same class.- Overrides:
hashCode
in classRectangle2D
-
equals
Compares the specified object with this envelope for equality.- Overrides:
equals
in classRectangle2D
- Parameters:
object
- The object to compare with this envelope.- Returns:
true
if the given object is equals to this envelope.
-
boundsEquals
Returnstrue
ifthis
envelope bounds is equals tothat
envelope bounds in two specified dimensions. The coordinate reference system is not compared, since it doesn't need to have the same number of dimensions.- Parameters:
that
- The envelope to compare to.xDim
- The dimension ofthat
envelope to compare to the x dimension ofthis
envelope.yDim
- The dimension ofthat
envelope to compare to the y dimension ofthis
envelope.eps
- A small tolerance number for floating point number comparaisons. This value will be scaled according this envelope width and height.- Returns:
true
if the envelope bounds are the same (up to the specified tolerance level) in the specified dimensions, orfalse
otherwise.
-
toString
Returns a string representation of this envelope. The default implementation is okay for occasional formatting (for example for debugging purpose). But if there is a lot of envelopes to format, users will get more control by using their own instance ofCoordinateFormat
.- Overrides:
toString
in classRectangle2D.Double
- Since:
- 2.4
-
setBounds
Description copied from interface:BoundingBox
Sets this bounding box to be the same as the specified box.- Specified by:
setBounds
in interfaceBoundingBox
- Parameters:
bounds
- The new bounds.
-
include
Description copied from interface:BoundingBox
Includes the provided bounding box, expanding as necessary.- Specified by:
include
in interfaceBoundingBox
- Parameters:
bounds
- The bounds to add to this geographic bounding box.
-
include
public void include(double x, double y) Description copied from interface:BoundingBox
Includes the provided coordinates, expanding as necessary. Note that there is no guarantee that the (x, x) values are oriented toward (East, North), since it depends on the envelope CRS.- Specified by:
include
in interfaceBoundingBox
- Parameters:
x
- The first ordinate value.y
- The second ordinate value.
-
intersects
Returnstrue
if the interior of this bounds intersects the interior of the provided bounds.Note this method conflicts with
RectangularShape.intersects(Rectangle2D)
so you may need to call it via envelope2d.intersects( (Envelope2DArchived) bounds ) in order to correctly check that the coordinate reference systems match.- Specified by:
intersects
in interfaceBoundingBox
- Parameters:
bounds
- The bounds to test for intersection.- Returns:
true
if the two bounds intersect.
-
contains
Description copied from interface:BoundingBox
Returnstrue
if the provided bounds are contained by this bounding box.- Specified by:
contains
in interfaceBoundingBox
- Parameters:
bounds
- The bounds to test for inclusion.- Returns:
true
if the given bounds is inside this bounds.
-
contains
Description copied from interface:BoundingBox
Returnstrue
if the provided location is contained by this bounding box.- Specified by:
contains
in interfaceBoundingBox
- Parameters:
location
- The direct position to test for inclusion.- Returns:
true
if the given position is inside this bounds.
-
toBounds
Description copied from interface:BoundingBox
Transforms this box to the specified CRS and returns a new bounding box for the transformed shape. This method provides a convenient (while not always efficient) way to get minimum and maximum ordinate values toward some specific axis directions, typically East and North.Example: if
box
is a bounding box using a geographic CRS with WGS84 datum, then one can write:GeographicCRS targetCRS = crsAuthorityFactory.createGeographicCRS("EPSG:4326"); BoundingBox targetBox = box.toBounds(targetCRS); double minEasting = targetBox.getMinY(); double minNorthing = targetBox.getMinX();
"EPSG:4326"
has (latitude, longitude) axis order, thus the inversion of X and Y in the above code.Sophisticated applications will typically provide more efficient way to perform similar transformations in their context. This method is provided for convenience in simple cases.
- Specified by:
toBounds
in interfaceBoundingBox
- Parameters:
targetCRS
- The target CRS for the bounding box to be returned.- Returns:
- A new bounding box wich includes the shape of this box transformed to the specified target CRS.
- Throws:
TransformException
- if no transformation path has been found from this box CRS to the specified target CRS, or if the transformation failed for an other reason.
-