com.yworks.yfiles.algorithms

Class Rectangle2D

java.lang.Object

com.yworks.yfiles.algorithms.Rectangle2D

All Implemented Interfaces:

ICloneable

public class Rectangle2D
extends Object
implements ICloneable

Represents a two-dimensional rectangle of size (width x height), located at the point (x, y).

Constructor Summary

Constructors

Constructor and Description
Rectangle2D() Creates a new rectangle of size (0 x 0) at the location (0, 0).
Rectangle2D(double x, double y, double width, double height) Creates a new rectangle of the specified size at the specified location.

Method Summary

Modifier and Type	Method and Description
void	add(double px, double py) Adds a point, specified by its coordinates, to this rectangle.
void	add(Rectangle2D r) Adds a rectangle to this rectangle.
Rectangle2D	clone() Creates a new instance of this class that has the same values as this objects.
boolean	contains(double x, double y) Checks if the point specified by the given coordinates is contained in this rectangle.
boolean	contains(double x, double y, double width, double height) Checks whether this rectangle completely contains the second specified rectangle.
boolean	contains(Rectangle2D rect) Checks whether this rectangle completely contains the second specified rectangle.
Rectangle2D	createIntersection(Rectangle2D r) Calculates the intersection of this rectangle with the given rectangle and returns the result as new rectangle.
Rectangle2D	createUnion(Rectangle2D r) Calculates the union of this rectangle with the given rectangle and returns the result as new rectangle.
boolean	equals(Object obj) Returns whether this rectangle and obj are equal.
Rectangle2D	getBounds2D() Gets the bounds of this instance in double precision.
double	getCenterX() Gets the x coordinate of the center point of this rectangle.
double	getCenterY() Gets the y coordinate of the center point of this rectangle.
Rectangle2D	getFrame() Gets the outer bounds of this rectangle in double coordinates.
double	getHeight() Gets the height of this rectangle.
double	getMaxX() Gets the largest x coordinate of this rectangle.
double	getMaxY() Gets the largest y coordinate of this rectangle.
double	getMinX() Gets the smallest x coordinate of this rectangle.
double	getMinY() Gets the smallest y coordinate of this rectangle.
double	getWidth() Gets the width of this rectangle.
double	getX() Gets the x coordinate of the upper left corner.
double	getY() Gets the y coordinate of the upper left corner.
int	hashCode()
static void	intersect(Rectangle2D src1, Rectangle2D src2, Rectangle2D dst) Calculates the intersection of the first and second specified rectangle and sets the resulting location and size to the third rectangle.
boolean	intersects(double x, double y, double width, double height) Checks whether this rectangle and the second specified rectangle intersect.
boolean	intersects(Rectangle2D rect) Checks whether this rectangle and the second specified rectangle intersect.
boolean	intersectsLine(double x1, double y1, double x2, double y2) Checks if the line segment specified by the given coordinates intersects this rectangle.
boolean	isEmpty() Gets whether this instance is empty, i.e.
void	setFrame(double x, double y, double width, double height) Sets the outer bounds of this rectangle based on the specified location and size.
void	setFrame(Rectangle2D value) Sets the outer bounds of this rectangle in double coordinates.
void	setFrameFromCenter(double centerX, double centerY, double cornerX, double cornerY) Sets the outer bounds of this rectangle based on the specified new center and corner.
void	setFrameFromCenter(Point2D center, Point2D corner) Sets the outer bounds of this rectangle based on the specified new center and corner.
void	setFrameFromDiagonal(double x1, double y1, double x2, double y2) Sets the outer bounds of this rectangle based on the end points of one of its diagonals.
void	setFrameFromDiagonal(Point2D p1, Point2D p2) Sets the outer bounds of this rectangle based on the end points of one of its diagonals.
void	setRect(double x, double y, double width, double height) Sets the location and size of this rectangle to the specified values.
void	setRect(Rectangle2D value) Sets the location and size of this rectangle to be similar to the specified rectangle.
String	toString()
static void	union(Rectangle2D src1, Rectangle2D src2, Rectangle2D dst) Calculates the union of the first and second specified rectangle and sets the resulting location and size to the third rectangle.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rectangle2D

public Rectangle2D()

Creates a new rectangle of size (0 x 0) at the location (0, 0).

Rectangle2D

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

Creates a new rectangle of the specified size at the specified location.

Parameters:

x - the x-coordinate of the upper left corner of the created rectangle.

y - the y-coordinate of the upper left corner of the created rectangle.

width - the width of the created rectangle.

height - the height of the created rectangle.

Method Detail

add

public void add(double px,
                double py)

Adds a point, specified by its coordinates, to this rectangle.

The rectangle will be grown if necessary. Note that for points that would lie on the right or bottom border of the rectangle, contains(double, double) will still return false for the added point.

Parameters:

px - the x coordinate of the point to add

py - the y coordinate of the point to add

add

public void add(Rectangle2D r)

Adds a rectangle to this rectangle.

The rectangle will be grown to the union of both rectangles

Parameters:

r - the rectangle to add

clone

public Rectangle2D clone()

Creates a new instance of this class that has the same values as this objects.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

a new instance of this class that has the same values as this objects.

See Also:

Object.clone()

contains

public boolean contains(double x,
                        double y)

Checks if the point specified by the given coordinates is contained in this rectangle.

Parameters:

x - the x-coordinate of the point.

y - the y-coordinate of the point.

Returns:

true if the specified point is contained in this rectangle; false otherwise.

contains

public boolean contains(double x,
                        double y,
                        double width,
                        double height)

Checks whether this rectangle completely contains the second specified rectangle.

Parameters:

x - the x coordinate of the second rectangle.

y - the y coordinate of the second rectangle.

width - the width coordinate of the second rectangle.

height - the height coordinate of the second rectangle.

Returns:

true if this rectangle contains the second one

contains

public boolean contains(Rectangle2D rect)

Checks whether this rectangle completely contains the second specified rectangle.

Parameters:

rect - the rectangle to check for containment

Returns:

true if this rectangle contains the second one

createIntersection

public Rectangle2D createIntersection(Rectangle2D r)

Calculates the intersection of this rectangle with the given rectangle and returns the result as new rectangle.

Parameters:

r - a rectangle to intersect with this rectangle.

Returns:

a new rectangle that represents the calculated intersection.

createUnion

public Rectangle2D createUnion(Rectangle2D r)

Calculates the union of this rectangle with the given rectangle and returns the result as new rectangle.

Parameters:

r - a rectangle to union with this rectangle.

Returns:

a new rectangle that represents the calculated union.

equals

public boolean equals(Object obj)

Returns whether this rectangle and obj are equal.

Two rectangles are considered equal if the have the same location and size.

Overrides:

equals in class Object

Parameters:

obj - The object to test for equality

Returns:

true if both objects are equal.

getBounds2D

public Rectangle2D getBounds2D()

Gets the bounds of this instance in double precision.

Returns:

the bounds of this instance in double precision.

getCenterX

public double getCenterX()

Gets the x coordinate of the center point of this rectangle.

Returns:

the x coordinate of the center point of this rectangle.

getCenterY

public double getCenterY()

Gets the y coordinate of the center point of this rectangle.

Returns:

the y coordinate of the center point of this rectangle.

getFrame

public Rectangle2D getFrame()

Gets the outer bounds of this rectangle in double coordinates.

Returns:

a new double-precision rectangle which represents the outer bounds of this rectangle.

See Also:

setFrame(Rectangle2D)

getHeight

public double getHeight()

Gets the height of this rectangle.

Returns:

the height.

getMaxX

public double getMaxX()

Gets the largest x coordinate of this rectangle.

Returns:

the largest x coordinate of this rectangle.

getMaxY

public double getMaxY()

Gets the largest y coordinate of this rectangle.

Returns:

the largest y coordinate of this rectangle.

getMinX

public double getMinX()

Gets the smallest x coordinate of this rectangle.

Returns:

the smallest x coordinate of this rectangle.

getMinY

public double getMinY()

Gets the smallest y coordinate of this rectangle.

Returns:

the smallest y coordinate of this rectangle.

getWidth

public double getWidth()

Gets the width of this rectangle.

Returns:

the width.

getX

public double getX()

Gets the x coordinate of the upper left corner.

Returns:

the x coordinate of the upper left corner.

getY

public double getY()

Gets the y coordinate of the upper left corner.

Returns:

the y coordinate of the upper left corner.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

intersect

public static final void intersect(Rectangle2D src1,
                                   Rectangle2D src2,
                                   Rectangle2D dst)

Calculates the intersection of the first and second specified rectangle and sets the resulting location and size to the third rectangle.

Parameters:

src1 - the first rectangle to intersect.

src2 - the second rectangle to intersect.

dst - the rectangle to which the result is set.

intersects

public boolean intersects(double x,
                          double y,
                          double width,
                          double height)

Checks whether this rectangle and the second specified rectangle intersect.

Parameters:

x - the x coordinate of the second rectangle.

y - the y coordinate of the second rectangle.

width - the width coordinate of the second rectangle.

height - the height coordinate of the second rectangle.

Returns:

true if both rectangles intersect

intersects

public boolean intersects(Rectangle2D rect)

Checks whether this rectangle and the second specified rectangle intersect.

Parameters:

rect - the rectangle to check for intersection

Returns:

true if both rectangles intersect

intersectsLine

public boolean intersectsLine(double x1,
                              double y1,
                              double x2,
                              double y2)

Checks if the line segment specified by the given coordinates intersects this rectangle.

Parameters:

x1 - the x-coordinate of the first end point of the line.

y1 - the y-coordinate of the first end point of the line.

x2 - the x-coordinate of the other end point of the line.

y2 - the y-coordinate of the other end point of the line.

Returns:

true if the specified line intersects this rectangle; false otherwise.

isEmpty

public boolean isEmpty()

Gets whether this instance is empty, i.e.

covers no area.

Returns:

true iff this rectangle is empty.

setFrame

public void setFrame(double x,
                     double y,
                     double width,
                     double height)

Sets the outer bounds of this rectangle based on the specified location and size.

Parameters:

x - the new x-coordinate of the upper left corner.

y - the new y-coordinate of the upper left corner.

width - the new width.

height - the new height.

setFrame

public void setFrame(Rectangle2D value)

Sets the outer bounds of this rectangle in double coordinates.

Parameters:

value - a new double-precision rectangle which represents the outer bounds of this rectangle.

See Also:

getFrame()

setFrameFromCenter

public void setFrameFromCenter(double centerX,
                               double centerY,
                               double cornerX,
                               double cornerY)

Sets the outer bounds of this rectangle based on the specified new center and corner.

Parameters:

centerX - the x-coordinate of the new center of this rectangle.

centerY - the y-coordinate of the new center of this rectangle.

cornerX - the x-coordinate of any new corner of this rectangle.

cornerY - the y-coordinate of any new corner of this rectangle.

setFrameFromCenter

public void setFrameFromCenter(Point2D center,
                               Point2D corner)

Sets the outer bounds of this rectangle based on the specified new center and corner.

Parameters:

center - the new center of this rectangle.

corner - any new corner of this rectangle.

setFrameFromDiagonal

public void setFrameFromDiagonal(double x1,
                                 double y1,
                                 double x2,
                                 double y2)

Sets the outer bounds of this rectangle based on the end points of one of its diagonals.

Parameters:

x1 - the x-coordinate of the first end point of a diagonal.

y1 - the y-coordinate of the first end point of a diagonal.

x2 - the x-coordinate of the other end point of a diagonal.

y2 - the y-coordinate of the other end point of a diagonal.

setFrameFromDiagonal

public void setFrameFromDiagonal(Point2D p1,
                                 Point2D p2)

Sets the outer bounds of this rectangle based on the end points of one of its diagonals.

Parameters:

p1 - the first end point of a diagonal.

p2 - the other end point of a diagonal.

setRect

public void setRect(double x,
                    double y,
                    double width,
                    double height)

Sets the location and size of this rectangle to the specified values.

Parameters:

x - the new x-coordinate of the upper left corner.

y - the new y-coordinate of the upper left corner.

width - the new width.

height - the new height.

setRect

public void setRect(Rectangle2D value)

Sets the location and size of this rectangle to be similar to the specified rectangle.

Parameters:

value - a rectangle that specifies the new location and size of this rectangle.

toString

public String toString()

Overrides:

toString in class Object

union

public static final void union(Rectangle2D src1,
                               Rectangle2D src2,
                               Rectangle2D dst)

Calculates the union of the first and second specified rectangle and sets the resulting location and size to the third rectangle.

Parameters:

src1 - the first rectangle to union.

src2 - the second rectangle to union.

dst - the rectangle to which the result is set.