com.luciad.geometries

Class Bounds

java.lang.Object

com.luciad.geometries.Geometry

com.luciad.geometries.Bounds

All Implemented Interfaces:

AutoCloseable

public final class Bounds
extends Geometry
implements AutoCloseable

Represents a bounds.

See Also:

GeometryFactory#createBounds, Bounds#Bounds

Constructor Summary

Constructors

Constructor and Description
Bounds(Bounds other)
Bounds(CoordinateReference reference, Coordinate lowerLeft, Coordinate upperRight) Creates a new Bounds instance based on lower left and upper right corners.
Bounds(CoordinateReference reference, Coordinate location, double width, double height, double depth) Creates a new Bounds instance based on a point, and the width, height and depth with respect to that point.

Method Summary

Modifier and Type	Method and Description
static Bounds	boundsUnion(Bounds bounds1, Bounds bounds2) Returns the union of the two bounds objects, provided they are defined in the same coordinate reference.
void	close()
static boolean	contains2D(Bounds bounds1, Bounds bounds2)
static boolean	contains2D(Bounds bounds1, Bounds bounds2, double eps)
static boolean	contains2D(Bounds bounds, Coordinate coordinate)
static boolean	contains2D(Bounds bounds, Coordinate coordinate, double eps)
static boolean	contains3D(Bounds bounds, Coordinate coordinate)
static boolean	contains3D(Bounds bounds, Coordinate coordinate, double eps)
boolean	equals(Object other)
protected void	finalize()
Coordinate	getCenter()
double	getDepth()
double	getHeight()
Coordinate	getLocation()
Coordinate	getLowerLeftCorner()
Coordinate	getLowerRightCorner()
Coordinate	getUpperLeftCorner()
Coordinate	getUpperRightCorner()
double	getWidth()
int	hashCode()
static boolean	interacts2D(Bounds bounds1, Bounds bounds2)
static boolean	interacts2D(Bounds bounds1, Bounds bounds2, double eps)
static Bounds	intersection2D(Bounds bounds1, Bounds bounds2) Returns the intersection of the two given bounds geometries.

Methods inherited from class com.luciad.geometries.Geometry

getBounds, getReference

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Bounds

public Bounds(@NotNull
              Bounds other)

Bounds

public Bounds(@NotNull
              CoordinateReference reference,
              @NotNull
              Coordinate location,
              double width,
              double height,
              double depth)

Creates a new Bounds instance based on a point, and the width, height and depth with respect to that point.

Parameters:

reference - the coordinate reference

location - the lower left location of the bounds

width - the width

height - the height

depth - the depth

Bounds

public Bounds(@NotNull
              CoordinateReference reference,
              @NotNull
              Coordinate lowerLeft,
              @NotNull
              Coordinate upperRight)

Creates a new Bounds instance based on lower left and upper right corners.

This method will take wrap-around the 180° meridian into account when the coordinate reference is geodetic.

Parameters:

reference - the coordinate reference

lowerLeft - the lower left corner of the bounds

upperRight - the upper right corner of the bounds

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Geometry

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class Geometry

getLocation

@NotNull
public Coordinate getLocation()

Returns:

the lower left corner of this Bounds instance.

getWidth

public double getWidth()

Returns:

the width of this bounds instance

getHeight

public double getHeight()

Returns:

the height of this bounds instance

getDepth

public double getDepth()

Returns:

the depth of this bounds instance

getCenter

@NotNull
public Coordinate getCenter()

Returns:

the center of this Bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

getLowerLeftCorner

@NotNull
public Coordinate getLowerLeftCorner()

Returns:

the lower left corner of this Bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

getLowerRightCorner

@NotNull
public Coordinate getLowerRightCorner()

Returns:

the lower right corner of this Bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

getUpperLeftCorner

@NotNull
public Coordinate getUpperLeftCorner()

Returns:

the upper left corner of this Bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

getUpperRightCorner

@NotNull
public Coordinate getUpperRightCorner()

Returns:

the upper right corner of this Bounds instance. When this bounds uses a geodetic reference, this method normalizes the result.

boundsUnion

@NotNull
public static Bounds boundsUnion(@NotNull
                                          Bounds bounds1,
                                          @NotNull
                                          Bounds bounds2)
                                   throws IllegalArgumentException

Returns the union of the two bounds objects, provided they are defined in the same coordinate reference.

Parameters:

bounds1 - the first bounds.

bounds2 - the second bounds.

Returns:

the union of the two bounds objects.

Throws:

IllegalArgumentException - if the bounds are not defined in the same coordinate reference.

intersection2D

@Nullable
public static Bounds intersection2D(@NotNull
                                              Bounds bounds1,
                                              @NotNull
                                              Bounds bounds2)

Returns the intersection of the two given bounds geometries.

Parameters:

bounds1 - a bounds instance

bounds2 - an other bounds instance

Returns:

the intersection of the given bounds geometries. If geodetic bounds, the result is normalized.

interacts2D

public static boolean interacts2D(@NotNull
                                  Bounds bounds1,
                                  @NotNull
                                  Bounds bounds2,
                                  double eps)
                           throws IllegalArgumentException

Parameters:

bounds1 - the first bounds.

bounds2 - the second bounds.

eps - a tolerance for the interaction check.

Returns:

true if the two bounds interact in 2D.

Throws:

IllegalArgumentException - if the bounds are not defined in the same coordinate reference.

interacts2D

public static boolean interacts2D(@NotNull
                                  Bounds bounds1,
                                  @NotNull
                                  Bounds bounds2)
                           throws IllegalArgumentException

Parameters:

bounds1 - the first bounds.

bounds2 - the second bounds.

Returns:

true if the two bounds interact in 2D.

Throws:

IllegalArgumentException - if the bounds are not defined in the same coordinate reference.

contains2D

public static boolean contains2D(@NotNull
                                 Bounds bounds,
                                 @NotNull
                                 Coordinate coordinate,
                                 double eps)

Returns:

true if this bounds contains the specified coordinate, considering only the x and y values

contains2D

public static boolean contains2D(@NotNull
                                 Bounds bounds,
                                 @NotNull
                                 Coordinate coordinate)

Returns:

true if this bounds contains the specified coordinate, considering only the x and y values

contains2D

public static boolean contains2D(@NotNull
                                 Bounds bounds1,
                                 @NotNull
                                 Bounds bounds2,
                                 double eps)
                          throws IllegalArgumentException

Parameters:

bounds1 - a bounds instance.

bounds2 - an other bounds instance.

eps - a tolerance for the contains check.

Returns:

if the first bounds contains the second bounds.

Throws:

IllegalArgumentException - if the bounds are not defined in the same coordinate reference.

contains2D

public static boolean contains2D(@NotNull
                                 Bounds bounds1,
                                 @NotNull
                                 Bounds bounds2)
                          throws IllegalArgumentException

Parameters:

bounds1 - a bounds instance.

bounds2 - an other bounds instance.

Returns:

if the first bounds contains the second bounds.

Throws:

IllegalArgumentException - if the bounds are not defined in the same coordinate reference.

contains3D

public static boolean contains3D(@NotNull
                                 Bounds bounds,
                                 @NotNull
                                 Coordinate coordinate,
                                 double eps)

Parameters:

bounds - a bounds instance.

coordinate - a coordinate.

eps - a tolerance for the contains check.

Returns:

true if this bounds contains the specified coordinate.

contains3D

public static boolean contains3D(@NotNull
                                 Bounds bounds,
                                 @NotNull
                                 Coordinate coordinate)

Parameters:

bounds - a bounds instance.

coordinate - a coordinate.

Returns:

true if this bounds contains the specified coordinate.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object other)

Overrides:

equals in class Object