Envelope (geolatte-geom 0.15 API)

java.lang.Object
- org.geolatte.geom.Envelope

```
public class Envelope
extends Object
```
An envelope or bounding box implementation.
An Envelope is characterised by the minimum and maximum x and y coordinates. An Envelope is empty if the set of enclosed points is empty.

Author:

Karel Maesen, Geovise BVBA, 2011
An empty Envelope has Double.NaN for min. and max. X and Y coordinates.

Field Summary

Fields
Modifier and Type Field and Description

static Envelope EMPTY
An empty Envelope

Fields
Modifier and Type	Field and Description
`static Envelope`	`EMPTY` An empty `Envelope`

Constructor Summary

Constructors
Constructor and Description
`Envelope(double minX, double minY, double maxX, double maxY)` Create an instance using the specified coordinates.
`Envelope(double minX, double minY, double maxX, double maxY, CrsId crsId)` Create an instance using the specified coordinates and `CrsId`.
`Envelope(Point lowerLeft, Point upperRight)` Creates an instance from specified lower-left and upper-right `Point`s.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(Envelope other)` Checks whether this `Envelope` contains the specifies `Envelope`.
`boolean`	`contains(Point p)` Checks whether this `Envelope` contains the specifies `Envelope`.
`boolean`	`equals(Object o)`
`CrsId`	`getCrsId()` Returns the `CrsId` for this `Envelope`
`double`	`getHeight()` returns the height of this `Envelope`.
`double`	`getMaxX()` Return the maximum X-coordinate.
`double`	`getMaxY()` Return the maximum Y-coordinate.
`double`	`getMinX()` Return the minimum X-coordinate.
`double`	`getMinY()` Return the minimum Y-coordinate.
`double`	`getWidth()` returns the width of this `Envelope`.
`int`	`hashCode()`
`Envelope`	`intersect(Envelope other)` Intersects the specified `Envelope` with this `Envelope` and returns the result.
`boolean`	`intersects(Envelope other)` Checks whether this `Envelope` intersects the specifies `Envelope`.
`boolean`	`isEmpty()` Checks whether this `Envelope` is empty.
`Point`	`lowerLeft()` Returns the lower-left point of this `Envelope`.
`Point`	`lowerRight()` Returns the lower-right point of this `Envelope`.
`String`	`toString()`
`static Envelope`	`union(Envelope b1, Envelope b2)` Creates an `Envelope` that is the set-theoretic union of the specified `Envelopes`.
`Point`	`upperLeft()` Returns the upper-left point of this `Envelope`.
`Point`	`upperRight()` Returns the upper-right point of this `Envelope`.
`boolean`	`within(Envelope other)` Checks whether this `Envelope` is contained within the specified `Envelope`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final Envelope EMPTY
```
    An empty Envelope
- Constructor Detail
  - Envelope
```
public Envelope(Point lowerLeft,
                Point upperRight)
```
    Creates an instance from specified lower-left and upper-right Points.
    
    Parameters:
    
    lowerLeft - the Point designating the lower-left coordinates
    
    upperRight - the Point designating the upper-right coordinates of the envelope.
    
    Throws:
    
    IllegalArgumentException - if lowerLeft and upperRight have different CrsId's
  - Envelope
```
public Envelope(double minX,
                double minY,
                double maxX,
                double maxY)
```
    Create an instance using the specified coordinates.
    The CrsId will be UNDEFINED.
    
    Parameters:
    
    minX - minimum X-coordinate
    
    minY - minimum Y-coordinate
    
    maxX - minimum Y-coordinate
    
    maxY - maximum Y-coordinate
  - Envelope
```
public Envelope(double minX,
                double minY,
                double maxX,
                double maxY,
                CrsId crsId)
```
    Create an instance using the specified coordinates and CrsId.
    
    Parameters:
    
    minX - minimum X-coordinate
    
    minY - minimum Y-coordinate
    
    maxX - minimum Y-coordinate
    
    maxY - maximum Y-coordinate
    
    crsId - the CrsId that identifies the CoordinateReferenceSystem for the coordinates of the envelope.
- Method Detail
  - getCrsId
```
public CrsId getCrsId()
```
    Returns the CrsId for this Envelope
    
    Returns:
  - getMinX
```
public double getMinX()
```
    Return the minimum X-coordinate.
    
    Returns:
    
    minimum X-coordinate
  - getMinY
```
public double getMinY()
```
    Return the minimum Y-coordinate.
    
    Returns:
    
    minimum Y-coordinate
  - getMaxX
```
public double getMaxX()
```
    Return the maximum X-coordinate.
    
    Returns:
    
    maximum X-coordinate
  - getMaxY
```
public double getMaxY()
```
    Return the maximum Y-coordinate.
    
    Returns:
    
    maximum Y-coordinate
  - getWidth
```
public double getWidth()
```
    returns the width of this Envelope.
    
    Returns:
    
    this Envelope's width
  - getHeight
```
public double getHeight()
```
    returns the height of this Envelope.
    
    Returns:
    
    this Envelope's height
  - lowerLeft
```
public Point lowerLeft()
```
    Returns the lower-left point of this Envelope.
    
    Returns:
    
    the lower-left point
  - upperRight
```
public Point upperRight()
```
    Returns the upper-right point of this Envelope.
    
    Returns:
    
    the upper-right point
  - upperLeft
```
public Point upperLeft()
```
    Returns the upper-left point of this Envelope.
    
    Returns:
    
    the upper-left point
  - lowerRight
```
public Point lowerRight()
```
    Returns the lower-right point of this Envelope.
    
    Returns:
    
    the lower-right point
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - union
```
public static Envelope union(Envelope b1,
                             Envelope b2)
```
    Creates an Envelope that is the set-theoretic union of the specified Envelopes.
    
    Parameters:
    
    b1 - first operand
    
    b2 - second operand
    
    Returns:
    
    an Envelope that encompasses both operands.
    
    Throws:
    
    IllegalArgumentException - when the operand Envelopes don't have the same coordinate reference system.
  - intersect
```
public Envelope intersect(Envelope other)
```
    Intersects the specified Envelope with this Envelope and returns the result.
    
    Parameters:
    
    other - the Envelope to intersect with this instance
    
    Returns:
    
    the set-theoretic intersection of this Envelope and the specified Envelope.
    
    Throws:
    
    IllegalArgumentException - when the specified Envelope doesn't have the same coordinate reference system as this instance.
  - isEmpty
```
public boolean isEmpty()
```
    Checks whether this Envelope is empty.
    
    Returns:
    
    true iff this instance is empty (the empty set).
  - within
```
public boolean within(Envelope other)
```
    Checks whether this Envelope is contained within the specified Envelope
    
    Parameters:
    
    other - the other Envelope
    
    Returns:
    
    true iff this instance is contained within the specified Envelope
    
    Throws:
    
    IllegalArgumentException - when the specified Envelope doesn't have the same coordinate reference system as this instance.
  - contains
```
public boolean contains(Envelope other)
```
    Checks whether this Envelope contains the specifies Envelope.
    
    Parameters:
    
    other - the other Envelope
    
    Returns:
    
    true iff this instance contains the specified Envelope
    
    Throws:
    
    IllegalArgumentException - when the specified Envelope doesn't have the same coordinate reference system as this instance.
  - contains
```
public boolean contains(Point p)
```
    Checks whether this Envelope contains the specifies Envelope.
    
    Parameters:
    
    p - the Point
    
    Returns:
    
    true iff this instance contains the specified Point
    
    Throws:
    
    IllegalArgumentException - when the specified Point doesn't have the same coordinate reference system as this instance.
  - intersects
```
public boolean intersects(Envelope other)
```
    Checks whether this Envelope intersects the specifies Envelope.
    Two instances intersect when their set-theoretic intersection is non-empty.
    
    Parameters:
    
    other - the other Envelope
    
    Returns:
    
    true iff this instance intersects with the other Envelope
    
    Throws:
    
    IllegalArgumentException - when the specified Envelope doesn't have the same coordinate reference system as this instance.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Envelope

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Constructor Detail

Envelope

Envelope

Envelope

Method Detail

getCrsId

getMinX

getMinY

getMaxX

getMaxY

getWidth

getHeight

lowerLeft

upperRight

upperLeft

lowerRight

toString

union

intersect

isEmpty

within

contains

contains

intersects

equals

hashCode