com.luciad.cartesian

Class Rectangle

java.lang.Object

com.luciad.cartesian.Rectangle

public final class Rectangle
extends Object

A "POD" for a 2D rectangle.

Not a geometry, to be used for communicating 2D cartesian rectangles.

Constructor Summary

Constructors

Constructor and Description
Rectangle() Creates a Rectangle at the origin, with width and height 0.
Rectangle(Coordinate corner1, Coordinate corner2) Creates a Rectangle with the given corners.
Rectangle(double x, double y, double width, double height) Creates a Rectangle with the provided x, y, width, and height values.
Rectangle(Rectangle other)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Coordinate	getCenter() Returns the coordinate in the center of this rectangle.
double	getHeight() The rectangle's height.
Coordinate	getLowerLeftCorner() Returns the coordinate at the lower left corner of this rectangle.
Coordinate	getLowerRightCorner() Returns the coordinate at the lower right corner of this rectangle.
Coordinate	getUpperLeftCorner() Returns the coordinate at the upper left corner of this rectangle.
Coordinate	getUpperRightCorner() Returns the coordinate at the upper right corner of this rectangle.
double	getWidth() The rectangle's width.
double	getX() The lower left corner's x-ordinate.
double	getY() The lower left corner's y-ordinate.
void	grow(double margin) Grows this rectangle by the given margin.
int	hashCode() Returns the hash for this rectangle.
boolean	isValid() Returns whether all fields are neither not-a-number nor infinite and the width and height are non-negative.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Rectangle

public Rectangle()

Creates a Rectangle at the origin, with width and height 0.

Rectangle

public Rectangle(double x,
                 double y,
                 double width,
                 double height)

Creates a Rectangle with the provided x, y, width, and height values.

Parameters:

x - the lower left corner's x-ordinate

y - the lower left corner's y-ordinate

width - the rectangle's width

height - the rectangle's height

Rectangle

public Rectangle(@NotNull
                 Coordinate corner1,
                 @NotNull
                 Coordinate corner2)

Creates a Rectangle with the given corners.

The corners do not need to have any particular relation to each other. Only the x and y ordinates of the corners are considered.

Parameters:

corner1 - one corner position

corner2 - another corner position

Rectangle

public Rectangle(@NotNull
                 Rectangle other)

Method Detail

grow

public void grow(double margin)

Grows this rectangle by the given margin.

The lower left corner is moved in the direction of negative x and y by margin. The upper right corner is moved in the direction of positive x and y by margin.

Parameters:

margin - a margin

getX

public double getX()

The lower left corner's x-ordinate.

getY

public double getY()

The lower left corner's y-ordinate.

getWidth

public double getWidth()

The rectangle's width.

getHeight

public double getHeight()

The rectangle's height.

getLowerLeftCorner

@NotNull
public Coordinate getLowerLeftCorner()

Returns the coordinate at the lower left corner of this rectangle.

Returns:

the coordinate at the lower left corner of this rectangle.

getLowerRightCorner

@NotNull
public Coordinate getLowerRightCorner()

Returns the coordinate at the lower right corner of this rectangle.

Returns:

the coordinate at the lower right corner of this rectangle.

getUpperLeftCorner

@NotNull
public Coordinate getUpperLeftCorner()

Returns the coordinate at the upper left corner of this rectangle.

Returns:

the coordinate at the upper left corner of this rectangle.

getUpperRightCorner

@NotNull
public Coordinate getUpperRightCorner()

Returns the coordinate at the upper right corner of this rectangle.

Returns:

the coordinate at the upper right corner of this rectangle.

getCenter

@NotNull
public Coordinate getCenter()

Returns the coordinate in the center of this rectangle.

Returns:

the coordinate in the center of this rectangle.

isValid

public boolean isValid()

Returns whether all fields are neither not-a-number nor infinite and the width and height are non-negative.

Returns:

whether all fields are neither not-a-number nor infinite and the width and height are non-negative.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns the hash for this rectangle.

Overrides:

hashCode in class Object

Returns:

the hash for this rectangle.

toString

@NotNull
public String toString()

Overrides:

toString in class Object