com.yworks.yfiles.algorithms

Class YRectangle

java.lang.Object

com.yworks.yfiles.algorithms.YDimension

com.yworks.yfiles.algorithms.YRectangle

All Implemented Interfaces:

IPlaneObject, Comparable

public class YRectangle
extends YDimension
implements IPlaneObject

This class defines a rectangle and provides utility methods for it.

Constructor Summary

Constructors

Constructor and Description
YRectangle() Creates a new rectangle with upper left corner (0,0) and size (0,0).
YRectangle(double x, double y, double width, double height) Creates a new rectangle with given upper left corner and size.
YRectangle(YPoint pos, YDimension size) Creates a new rectangle with given upper left corner and size.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o)
boolean	contains(double x, double y) Checks whether or not this YRectangle contains the given point.
boolean	contains(double x, double y, double width, double height) Checks whether or not this YRectangle contains the rectangle defined by the given frame.
static boolean	contains(double rx, double ry, double rw, double rh, double x, double y) Determines whether the specified rectangle contains the specified point.
static boolean	contains(double rx, double ry, double rw, double rh, double x, double y, boolean closed) Determines whether the specified rectangle contains the specified point.
boolean	contains(YPoint p) Checks whether or not this YRectangle contains the given point.
boolean	contains(YRectangle p) Checks whether or not this YRectangle contains the given rectangle.
boolean	equals(Object o) Tests a dimension to equality to another dimension.
YRectangle	getBoundingBox() Gets this object.
double	getEuclideanDistance(YRectangle other) Returns the Euclidean distance to the passed rectangle.
YPoint	getLocation() Gets coordinates of upper left corner.
double	getManhattanDistance(YRectangle other) Returns the Manhattan distance to the passed rectangle.
double	getX() Gets x-coordinate of upper left corner.
double	getY() Gets y-coordinate of upper left corner.
int	hashCode()
static boolean	intersects(YRectangle r1, YRectangle r2) Returns whether or not the given rectangles intersect.
String	toString() Returns a string representation of this rectangle.

Methods inherited from class com.yworks.yfiles.algorithms.YDimension

getHeight, getWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

YRectangle

public YRectangle()

Creates a new rectangle with upper left corner (0,0) and size (0,0).

YRectangle

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

Creates a new rectangle with given upper left corner and size.

Parameters:

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

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

width - width of the rectangle.

height - height of the rectangle.

YRectangle

public YRectangle(YPoint pos,
                  YDimension size)

Creates a new rectangle with given upper left corner and size.

Parameters:

pos - upper left corner of the rectangle.

size - size of the rectangle.

Method Detail

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class YDimension

contains

public boolean contains(double x,
                        double y)

Checks whether or not this YRectangle contains the given point.

Parameters:

x - the x-coordinate of the point to check.

y - the x-coordinate of the point to check.

Returns:

true if the point lies inside the rectangle; false otherwise.

contains

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

Checks whether or not this YRectangle contains the rectangle defined by the given frame.

contains

public static final boolean contains(double rx,
                                     double ry,
                                     double rw,
                                     double rh,
                                     double x,
                                     double y)

Determines whether the specified rectangle contains the specified point.

Parameters:

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

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

rw - the width of the rectangle.

rh - the height of the rectangle.

x - the x-coordinate of the point to check.

y - the x-coordinate of the point to check.

Returns:

true if the point lies inside the rectangle; false otherwise.

contains

public static final boolean contains(double rx,
                                     double ry,
                                     double rw,
                                     double rh,
                                     double x,
                                     double y,
                                     boolean closed)

Determines whether the specified rectangle contains the specified point.

Parameters:

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

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

rw - the width of the rectangle.

rh - the height of the rectangle.

x - the x-coordinate of the point to check.

y - the x-coordinate of the point to check.

closed - if true, all points on the border of the rectangle are considered to be contained.

Returns:

true if the point lies inside the rectangle; false otherwise.

contains

public boolean contains(YPoint p)

Checks whether or not this YRectangle contains the given point.

contains

public boolean contains(YRectangle p)

Checks whether or not this YRectangle contains the given rectangle.

equals

public boolean equals(Object o)

Description copied from class: YDimension

Tests a dimension to equality to another dimension.

Overrides:

equals in class YDimension

getBoundingBox

public YRectangle getBoundingBox()

Gets this object.

Specified by:

getBoundingBox in interface IPlaneObject

Returns:

The BoundingBox.

getEuclideanDistance

public double getEuclideanDistance(YRectangle other)

Returns the Euclidean distance to the passed rectangle.

If they overlap, the distance is 0.

Parameters:

other - the second rectangle.

Returns:

the distance to the given rectangle.

getLocation

public final YPoint getLocation()

Gets coordinates of upper left corner.

Returns:

The Location.

getManhattanDistance

public double getManhattanDistance(YRectangle other)

Returns the Manhattan distance to the passed rectangle.

If they overlap the distance is 0.

Parameters:

other - the second rectangle.

Returns:

the distance to the given rectangle.

getX

public final double getX()

Gets x-coordinate of upper left corner.

Returns:

The X.

getY

public final double getY()

Gets y-coordinate of upper left corner.

Returns:

The Y.

hashCode

public int hashCode()

Overrides:

hashCode in class YDimension

intersects

public static final boolean intersects(YRectangle r1,
                                       YRectangle r2)

Returns whether or not the given rectangles intersect.

toString

public String toString()

Returns a string representation of this rectangle.

Overrides:

toString in class YDimension