Package io.github.srcimon.screwbox.core

Class Bounds

java.lang.Object

io.github.srcimon.screwbox.core.Bounds

All Implemented Interfaces:

Serializable

public final class Bounds
extends Object
implements Serializable

Bounds represents a space in the 2d world. It's defined by its position() (center of the area) and its extents() (the Vector from the center to it's lower right corner. The origin() defines the upper left corner.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static Bounds	$$(double x, double y, double width, double height)	Creates a new Bounds at the given origin().
List<Bounds>	allIntersecting(List<Bounds> others)	Returns only the Bounds that intersect this Bounds.
static Bounds	atOrigin(double x, double y, double width, double height)	Creates a new Bounds at the given origin().
static Bounds	atOrigin(Vector origin, double width, double height)	Creates a new Bounds at the given origin().
static Bounds	atPosition(double x, double y, double width, double height)	Creates a new Bounds at the given position().
static Bounds	atPosition(Vector position, double width, double height)	Creates a new Bounds at the given position().
Vector	bottomLeft()
Vector	bottomRight()
boolean	contains(Vector position)	Checks if the given position is within this Bounds.
boolean	equals(Object obj)
Vector	extents()
int	hashCode()
double	height()	Returns the height of this Bounds.
Bounds	inflated(double inflation)	Returns a new instance of Bounds at the same position() but with different size().
Bounds	inflatedTop(int value)	Same as inflated(double) but only inflates the top Line of the Bounds.
Optional<Bounds>	intersection(Bounds other)	Returns the intersection area between this Bounds and the other Bounds.
boolean	intersects(Bounds other)	Checks if this Bounds intersects another Bounds.
static Bounds	max()	Creates a new Bounds on maximum size and position() on the center of the game World.
double	maxX()
double	maxY()
double	minX()
double	minY()
Bounds	moveBy(double x, double y)	Returns a instance of this Bounds that was moved by the given X and Y values to a new position.
Bounds	moveBy(Vector vector)	Returns a instance of this Bounds that was moved by the given Vector to a new position.
Bounds	moveTo(Vector newPosition)	Returns a instance of this Bounds that was moved to the given position.
Vector	origin()
double	overlapArea(Bounds other)	Calculates the area of overlap between this Bounds and the other Bounds.
Vector	position()
Vector	size()	Returns the size of the Bounds.
Vector	topRight()
String	toString()
boolean	touches(Bounds other)	Checks if this Bounds touches another Bounds.
double	width()	Returns the width of this Bounds.

Methods inherited from class java.lang.Object

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

Method Details

atPosition

public static Bounds atPosition(double x,
 double y,
 double width,
 double height)

Creates a new Bounds at the given position().

See Also:

• atOrigin(io.github.srcimon.screwbox.core.Vector, double, double)

atPosition

public static Bounds atPosition(Vector position,
 double width,
 double height)

Creates a new Bounds at the given position().

See Also:

• atOrigin(io.github.srcimon.screwbox.core.Vector, double, double)

atOrigin

public static Bounds atOrigin(Vector origin,
 double width,
 double height)

Creates a new Bounds at the given origin().

See Also:

• atPosition(double, double, double, double)

$$

public static Bounds $$(double x,
 double y,
 double width,
 double height)

Creates a new Bounds at the given origin(). Short form of atOrigin(double, double, double, double)

See Also:

• atPosition(double, double, double, double)

atOrigin

public static Bounds atOrigin(double x,
 double y,
 double width,
 double height)

Creates a new Bounds at the given origin().

See Also:

• atPosition(double, double, double, double)
• $$(double, double, double, double)

max

public static Bounds max()

Creates a new Bounds on maximum size and position() on the center of the game World.

contains

public boolean contains(Vector position)

Checks if the given position is within this Bounds.

moveBy

public Bounds moveBy(Vector vector)

Returns a instance of this Bounds that was moved by the given Vector to a new position. width() and height() stay the same.

See Also:

• moveBy(double, double)
• moveTo(Vector)

moveBy

public Bounds moveBy(double x,
 double y)

Returns a instance of this Bounds that was moved by the given X and Y values to a new position. width() and height() stay the same.

See Also:

• moveBy(Vector)
• moveTo(Vector)

moveTo

public Bounds moveTo(Vector newPosition)

Returns a instance of this Bounds that was moved to the given position. width() and height() stay the same.

See Also:

• moveBy(Vector)
• moveBy(double, double)

origin

public Vector origin()

size

public Vector size()

Returns the size of the Bounds.

inflated

public Bounds inflated(double inflation)

Returns a new instance of Bounds at the same position() but with different size(). Positive values increase the size(), negative one decreases the size().

inflatedTop

public Bounds inflatedTop(int value)

Same as inflated(double) but only inflates the top Line of the Bounds.

touches

public boolean touches(Bounds other)

Checks if this Bounds touches another Bounds. Is also true if it intersects(Bounds) the other Bounds.

See Also:

• intersects(Bounds)

intersects

public boolean intersects(Bounds other)

Checks if this Bounds intersects another Bounds.

See Also:

• touches(Bounds)
• intersection(Bounds)

width

public double width()

Returns the width of this Bounds.

height

public double height()

Returns the height of this Bounds.

overlapArea

public double overlapArea(Bounds other)

Calculates the area of overlap between this Bounds and the other Bounds.

extents

public Vector extents()

minX

public double minX()

maxX

public double maxX()

minY

public double minY()

maxY

public double maxY()

toString

public String toString()

Overrides:

toString in class Object

position

public Vector position()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

bottomLeft

public Vector bottomLeft()

bottomRight

public Vector bottomRight()

topRight

public Vector topRight()

intersection

public Optional<Bounds> intersection(Bounds other)

Returns the intersection area between this Bounds and the other Bounds. Returns Optional.empty() if there is no intersection between both Bounds.

See Also:

• intersects(Bounds)

allIntersecting

public List<Bounds> allIntersecting(List<Bounds> others)

Returns only the Bounds that intersect this Bounds.