Module be.yildizgames.common.geometry

Package be.yildizgames.common.geometry

Class Rectangle

java.lang.Object

be.yildizgames.common.geometry.Rectangle

public final class Rectangle
extends Object

Represent a 2D rectangle and contains the 4 extremities data.

Author:

Gregory Van den Borre

Constructor Summary

Constructors

Constructor	Description
Rectangle()
Rectangle(int left, int top, int right, int bottom)

Method Summary

Modifier and Type	Method	Description
boolean	contain(float x, float y)	Check if a point is contained in this rectangle.
boolean	contain(Point2D point)	Check if a point is contained in this rectangle.
boolean	equals(Object o)
int	getBottom()
int	getHeight()
int	getLeft()
int	getRight()
int	getTop()
int	getWidth()
int	hashCode()
void	move(int x, int y)	Update the rectangle coordinates by adding values to it, this behave the same as if the rectangle was moving.
void	normalize()	Check that x1 is smaller than x2 and that y1 is smaller than y2.
void	reset()	Set all values to 0.
void	setBottom(int bottom)
void	setLeft(int left)
void	setRight(int right)
void	setTop(int top)
void	setValues(int leftValue, int topValue, int rightValue, int bottomValue)	Update the Rectangle values.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Rectangle

public Rectangle(int left,
                 int top,
                 int right,
                 int bottom)

Rectangle

public Rectangle()

Method Detail

contain

public boolean contain(float x,
                       float y)

Check if a point is contained in this rectangle. i.e. a point with coordinates(5,3) would be contained in a rectangle (x1=0, x2=10, y1=2, y2=4).

Parameters:

x - X coordinate for the point to check.

y - Y coordinate for the point to check.

Returns:

true if the point is within this rectangle.

contain

public boolean contain(Point2D point)

Check if a point is contained in this rectangle. i.e. a point with coordinates(5,3) would be contained in a rectangle (x1=0, x2=10, y1=2, y2=4).

Parameters:

point - Point to check.

Returns:

true if the point is within this rectangle.

getHeight

public int getHeight()

Returns:

The rectangle height size.

getWidth

public int getWidth()

Returns:

The rectangle width size.

move

public void move(int x,
                 int y)

Update the rectangle coordinates by adding values to it, this behave the same as if the rectangle was moving.

Parameters:

x - Value to add to left and right.

y - Value to add to top and bottom.

normalize

public void normalize()

Check that x1 is smaller than x2 and that y1 is smaller than y2. If not values are swapped.

reset

public void reset()

Set all values to 0.

setValues

public void setValues(int leftValue,
                      int topValue,
                      int rightValue,
                      int bottomValue)

Update the Rectangle values.

Parameters:

leftValue - New value for left.

topValue - New value for top.

rightValue - New value for right.

bottomValue - New value for bottom.

getLeft

public int getLeft()

getTop

public int getTop()

getRight

public int getRight()

getBottom

public int getBottom()

setLeft

public void setLeft(int left)

setTop

public void setTop(int top)

setRight

public void setRight(int right)

setBottom

public void setBottom(int bottom)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object