org.jsfml.graphics

Class IntRect

java.lang.Object

org.jsfml.graphics.IntRect

All Implemented Interfaces:

Serializable

public final class IntRect
extends Object
implements Serializable

Represents an axis-aligned rectangle using integer coordinates.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static IntRect	EMPTY An empty rectangle with no dimensions.
int	height The height of the rectangle.
int	left The X coordinate of the rectangle's left edge.
int	top The Y coordinate of the rectangle's top edge.
int	width The width of the rectangle.

Constructor Summary

Constructors

Constructor and Description
IntRect(FloatRect rect) Constructs a new rectangle by converting a floating point rectangle.
IntRect(int left, int top, int width, int height) Constructs a new rectangle with the specified parameters.
IntRect(Vector2i position, Vector2i size) Constructs a new rectangle with the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(int x, int y) Tests whether a point is inside the rectangle's boundaries, including its edges.
boolean	contains(Vector2i point) Tests whether a point is inside the rectangle's boundaries, including its edges.
boolean	equals(Object o)
int	hashCode()
IntRect	intersection(IntRect rect) Tests whether this rectangle intersects with another rectangle and calculates the rectangle of intersection.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final IntRect EMPTY

An empty rectangle with no dimensions.

left

public final int left

The X coordinate of the rectangle's left edge.

top

public final int top

The Y coordinate of the rectangle's top edge.

width

public final int width

The width of the rectangle.

height

public final int height

The height of the rectangle.

Constructor Detail

IntRect

public IntRect(int left,
       int top,
       int width,
       int height)

Constructs a new rectangle with the specified parameters.

Parameters:

left - the X coordinate of the rectangle's left edge.

top - the Y coordinate of the rectangle's top edge.

width - the rectangle's width.

height - the rectangle's height.

IntRect

public IntRect(Vector2i position,
       Vector2i size)

Constructs a new rectangle with the specified parameters.

Parameters:

position - the position of the rectangle's top left corner.

size - the rectangle's dimension.

IntRect

public IntRect(FloatRect rect)

Constructs a new rectangle by converting a floating point rectangle.

The fractions of the components will be removed.

Parameters:

rect - the rectangle to convert.

Method Detail

contains

public boolean contains(int x,
               int y)

Tests whether a point is inside the rectangle's boundaries, including its edges.

Parameters:

x - the X coordinate of the tested point.

y - the Y coordinate of the tested point.

Returns:

true if the point lies within the rectangle's boundaries, false otherwise.

contains

public boolean contains(Vector2i point)

Tests whether a point is inside the rectangle's boundaries, including its edges.

Parameters:

point - the point to be tested.

Returns:

true if the point lies within the rectangle's boundaries, false otherwise.

intersection

public IntRect intersection(IntRect rect)

Tests whether this rectangle intersects with another rectangle and calculates the rectangle of intersection.

Parameters:

rect - the rectangle to test against.

Returns:

the intersection rectangle, or null if the rectangles do not intersect.

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