net.stemkoski.bagel

Class Rectangle

java.lang.Object

net.stemkoski.bagel.Rectangle

public class Rectangle
extends java.lang.Object

A rectangle shape, defined by its position and size, particularly useful in collision detection (see Sprite, TileMap) and for specifying area of an image to be drawn (see Texture). Rectangles with width or height equal to 0 can be used to represent edges (see Tile.edgeLeft, etc.)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) double	bottom y-coordinate of bottom edge of rectangle
(package private) double	height height of rectangle
(package private) double	left x-coordinate of left edge of rectangle
(package private) double	right x-coordinate of right edge of rectangle
(package private) double	top y-coordinate of top edge of rectangle
(package private) double	width width of rectangle

Constructor Summary

Constructors

Constructor and Description
Rectangle() Initialize rectangle with all values set to 0.
Rectangle(double left, double top, double width, double height) Initialize rectangle data from coordinates of top-left corner and size.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	contains(double x, double y) Determine if this rectangle contains the point (x,y).
(package private) Vector2	getMinTranslationVector(Rectangle other) Assuming that this rectangle and other rectangle overlap, calculate the minimum length vector required to translate this rectangle so that there is no longer any overlap between them.
(package private) boolean	overlaps(Rectangle other) Determine if this rectangle overlaps with other rectangle.
(package private) void	setValues(double left, double top, double width, double height) Update rectangle data from coordinates of top-left corner and size.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

left

double left

x-coordinate of left edge of rectangle

top

double top

y-coordinate of top edge of rectangle

width

double width

width of rectangle

height

double height

height of rectangle

right

double right

x-coordinate of right edge of rectangle

bottom

double bottom

y-coordinate of bottom edge of rectangle

Constructor Detail

Rectangle

Rectangle()

Initialize rectangle with all values set to 0.

Rectangle

Rectangle(double left,
          double top,
          double width,
          double height)

Initialize rectangle data from coordinates of top-left corner and size.

Parameters:

left - x-coordinate of top-left corner (left edge) of rectangle

top - y-coordinate of top-left corner (top edge) of rectangle

width - width of rectangle

height - height of rectangle

Method Detail

setValues

void setValues(double left,
               double top,
               double width,
               double height)

Update rectangle data from coordinates of top-left corner and size. Useful for game entities that move.

Parameters:

left - x-coordinate of top-left corner (left edge) of rectangle

top - y-coordinate of top-left corner (top edge) of rectangle

width - width of rectangle

height - height of rectangle

overlaps

boolean overlaps(Rectangle other)

Determine if this rectangle overlaps with other rectangle.

Parameters:

other - rectangle to check for overlap

Returns:

true if this rectangle overlaps with other rectangle

getMinTranslationVector

Vector2 getMinTranslationVector(Rectangle other)

Assuming that this rectangle and other rectangle overlap, calculate the minimum length vector required to translate this rectangle so that there is no longer any overlap between them.

Parameters:

other - rectangle to translate away from

Returns:

minimum length vector required to translate by to avoid overlap

contains

boolean contains(double x,
                 double y)

Determine if this rectangle contains the point (x,y).

Parameters:

x - x-coordinate of point

y - y-coordinate of point

Returns:

true, if this rectangle contains the point (x,y)