org.joml.primitives

Class Rectanglei

java.lang.Object

org.joml.primitives.Rectanglei

All Implemented Interfaces:

Externalizable, Serializable

public class Rectanglei
extends Object
implements Externalizable

Represents a 2D axis-aligned rectangle.

Author:

Kai Burjack

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	maxX The x coordinate of the maximum corner.
int	maxY The y coordinate of the maximum corner.
int	minX The x coordinate of the minimum corner.
int	minY The y coordinate of the minimum corner.

Constructor Summary

Constructors

Constructor and Description
Rectanglei() Create a new Rectanglei with a minimum and maximum corner of (0, 0).
Rectanglei(int minX, int minY, int maxX, int maxY) Create a new Rectanglei with the given minimum and maximum corner coordinates.
Rectanglei(Rectanglei source) Create a new Rectanglei as a copy of the given source.
Rectanglei(org.joml.Vector2ic min, org.joml.Vector2ic max) Create a new Rectanglei with the given min and max corner coordinates.

Method Summary

Modifier and Type	Method and Description
int	area() Return the area of the rectangle
boolean	containsPoint(float x, float y) Test whether the point (x, y) lies inside this BlockRegion.
boolean	containsPoint(int x, int y) Check if this rectangle contains the given point (x, y).
boolean	containsPoint(org.joml.Vector2fc point) Test whether the point (x, y) lies inside this BlockRegion.
boolean	containsPoint(org.joml.Vector2ic point) Check if this rectangle contains the given point.
boolean	containsRectangle(Rectangled rectangle) Check if this rectangle contains the given rectangle.
boolean	containsRectangle(Rectanglef rectangle) Check if this rectangle contains the given rectangle.
boolean	containsRectangle(Rectanglei rectangle) Check if this rectangle contains the given rectangle.
boolean	equals(Object obj)
int	hashCode()
Rectanglei	intersection(Rectanglei other) Compute the rectangle of intersection between this and the given rectangle.
Rectanglei	intersection(Rectanglei other, Rectanglei dest) Compute the rectangle of intersection between this and the given rectangle and store the result in dest.
boolean	intersectsRectangle(Rectangled other) Check if this and the given rectangle intersect.
boolean	intersectsRectangle(Rectanglef other) Check if this and the given rectangle intersect.
boolean	intersectsRectangle(Rectanglei other) Check if this and the given rectangle intersect.
boolean	isValid() Check whether this rectangle represents a valid rectangle.
org.joml.Vector2i	lengths(org.joml.Vector2i dest) Return the length of this rectangle in the X and Y dimensions and store the result in dest.
int	lengthX() Return the length of the rectangle in the X dimension.
int	lengthY() Return the length of the rectangle in the Y dimension.
void	readExternal(ObjectInput in)
Rectanglei	scale(int sf) Scale this about the origin.
Rectanglei	scale(int sx, int sy) Scale this about the origin.
Rectanglei	scale(int sf, int ax, int ay) Scale this about an anchor.
Rectanglei	scale(int sx, int sy, int ax, int ay) Scale this about an anchor.
Rectanglei	scale(int sx, int sy, int ax, int ay, Rectanglei dest) Scale this about an anchor and store the result in dest.
Rectanglei	scale(int sf, int ax, int ay, Rectanglei dest) Scale this about an anchor and store the result in dest.
Rectanglei	scale(int sx, int sy, Rectanglei dest) Scale this about the origin and store the result in dest.
Rectanglei	scale(int sx, int sy, org.joml.Vector2ic anchor) Scale this about an anchor.
Rectanglei	scale(int sx, int sy, org.joml.Vector2ic anchor, Rectanglei dest) Scale this about an anchor and store the result in dest.
Rectanglei	scale(int sf, Rectanglei dest) Scale this about the origin and store the result in dest.
Rectanglei	scale(int sf, org.joml.Vector2ic anchor) Scale this about an anchor.
Rectanglei	scale(int sf, org.joml.Vector2ic anchor, Rectanglei dest) Scale this about an anchor and store the result in dest.
Rectanglei	set(Rectanglei source) Set this Rectanglei to be a clone of source.
Rectanglei	setMax(int maxX, int maxY) Set the maximum corner coordinates.
Rectanglei	setMax(org.joml.Vector2ic max) Set the maximum corner coordinates.
Rectanglei	setMin(int minX, int minY) Set the minimum corner coordinates.
Rectanglei	setMin(org.joml.Vector2ic min) Set the minimum corner coordinates.
String	toString() Return a string representation of this rectangle.
String	toString(NumberFormat formatter) Return a string representation of this rectangle by formatting the vector components with the given NumberFormat.
Rectanglei	translate(int x, int y) Translate this by the vector (x, y).
Rectanglei	translate(int x, int y, Rectanglei dest) Translate this by the vector (x, y) and store the result in dest.
Rectanglei	translate(org.joml.Vector2ic xy) Translate this by the given vector xy.
Rectanglei	translate(org.joml.Vector2ic xy, Rectanglei dest) Translate this by the given vector xy and store the result in dest.
Rectanglei	union(int x, int y) Set this to the union of this and the given point p.
Rectanglei	union(int x, int y, Rectanglei dest) Compute the union of this and the given point (x, y, z) and store the result in dest.
Rectanglei	union(Rectanglei other) Set this to the union of this and other.
Rectanglei	union(Rectanglei other, Rectanglei dest) Compute the union of this and other and store the result in dest.
Rectanglei	union(org.joml.Vector2ic p) Set this to the union of this and the given point p.
Rectanglei	union(org.joml.Vector2ic p, Rectanglei dest) Compute the union of this and the given point p and store the result in dest.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

minX

public int minX

The x coordinate of the minimum corner.

minY

public int minY

The y coordinate of the minimum corner.

maxX

public int maxX

The x coordinate of the maximum corner.

maxY

public int maxY

The y coordinate of the maximum corner.

Constructor Detail

Rectanglei

public Rectanglei()

Create a new Rectanglei with a minimum and maximum corner of (0, 0).

Rectanglei

public Rectanglei(Rectanglei source)

Create a new Rectanglei as a copy of the given source.

Parameters:

source - the Rectanglei to copy from

Rectanglei

public Rectanglei(org.joml.Vector2ic min,
                  org.joml.Vector2ic max)

Create a new Rectanglei with the given min and max corner coordinates.

Parameters:

min - the minimum coordinates

max - the maximum coordinates

Rectanglei

public Rectanglei(int minX,
                  int minY,
                  int maxX,
                  int maxY)

Create a new Rectanglei with the given minimum and maximum corner coordinates.

Parameters:

minX - the x coordinate of the minimum corner

minY - the y coordinate of the minimum corner

maxX - the x coordinate of the maximum corner

maxY - the y coordinate of the maximum corner

Method Detail

set

public Rectanglei set(Rectanglei source)

Set this Rectanglei to be a clone of source.

Parameters:

source - the Rectanglei to copy from

Returns:

this

setMin

public Rectanglei setMin(int minX,
                         int minY)

Set the minimum corner coordinates.

Parameters:

minX - the x coordinate of the minimum corner

minY - the y coordinate of the minimum corner

Returns:

this

setMin

public Rectanglei setMin(org.joml.Vector2ic min)

Set the minimum corner coordinates.

Parameters:

min - the minimum coordinates

Returns:

this

setMax

public Rectanglei setMax(int maxX,
                         int maxY)

Set the maximum corner coordinates.

Parameters:

maxX - the x coordinate of the maximum corner

maxY - the y coordinate of the maximum corner

Returns:

this

setMax

public Rectanglei setMax(org.joml.Vector2ic max)

Set the maximum corner coordinates.

Parameters:

max - the maximum coordinates

Returns:

this

lengthX

public int lengthX()

Return the length of the rectangle in the X dimension.

Returns:

length in the X dimension

lengthY

public int lengthY()

Return the length of the rectangle in the Y dimension.

Returns:

length in the Y dimension

area

public int area()

Return the area of the rectangle

Returns:

area

union

public Rectanglei union(int x,
                        int y)

Set this to the union of this and the given point p.

Parameters:

x - the x coordinate of the point

y - the y coordinate of the point

Returns:

this

union

public Rectanglei union(org.joml.Vector2ic p)

Set this to the union of this and the given point p.

Parameters:

p - the point

Returns:

this

union

public Rectanglei union(int x,
                        int y,
                        Rectanglei dest)

Compute the union of this and the given point (x, y, z) and store the result in dest.

Parameters:

x - the x coordinate of the point

y - the y coordinate of the point

dest - will hold the result

Returns:

dest

union

public Rectanglei union(org.joml.Vector2ic p,
                        Rectanglei dest)

Compute the union of this and the given point p and store the result in dest.

Parameters:

p - the point

dest - will hold the result

Returns:

dest

union

public Rectanglei union(Rectanglei other)

Set this to the union of this and other.

Parameters:

other - the other Rectanglei

Returns:

this

union

public Rectanglei union(Rectanglei other,
                        Rectanglei dest)

Compute the union of this and other and store the result in dest.

Parameters:

other - the other Rectanglei

dest - will hold the result

Returns:

dest

intersectsRectangle

public boolean intersectsRectangle(Rectangled other)

Check if this and the given rectangle intersect.

Parameters:

other - the other rectangle

Returns:

true iff both rectangles intersect; false otherwise

intersectsRectangle

public boolean intersectsRectangle(Rectanglef other)

Check if this and the given rectangle intersect.

Parameters:

other - the other rectangle

Returns:

true iff both rectangles intersect; false otherwise

intersectsRectangle

public boolean intersectsRectangle(Rectanglei other)

Check if this and the given rectangle intersect.

Parameters:

other - the other rectangle

Returns:

true iff both rectangles intersect; false otherwise

isValid

public boolean isValid()

Check whether this rectangle represents a valid rectangle.

Returns:

true iff this rectangle is valid; false otherwise

intersection

public Rectanglei intersection(Rectanglei other)

Compute the rectangle of intersection between this and the given rectangle.

If the two rectangles do not intersect, then the minimum coordinates of this will have a value of Integer.MAX_VALUE and the maximum coordinates will have a value of Integer.MIN_VALUE.

Parameters:

other - the other rectangle

Returns:

this

intersection

public Rectanglei intersection(Rectanglei other,
                               Rectanglei dest)

Compute the rectangle of intersection between this and the given rectangle and store the result in dest.

If the two rectangles do not intersect, then the minimum coordinates of dest will have a value of Integer.MAX_VALUE and the maximum coordinates will have a value of Integer.MIN_VALUE.

Parameters:

other - the other rectangle

dest - will hold the result

Returns:

dest

lengths

public org.joml.Vector2i lengths(org.joml.Vector2i dest)

Return the length of this rectangle in the X and Y dimensions and store the result in dest.

Parameters:

dest - will hold the result

Returns:

dest

containsRectangle

public boolean containsRectangle(Rectangled rectangle)

Check if this rectangle contains the given rectangle.

Parameters:

rectangle - the rectangle to test

Returns:

true iff this rectangle contains the rectangle; false otherwise

containsRectangle

public boolean containsRectangle(Rectanglef rectangle)

Check if this rectangle contains the given rectangle.

Parameters:

rectangle - the rectangle to test

Returns:

true iff this rectangle contains the rectangle; false otherwise

containsRectangle

public boolean containsRectangle(Rectanglei rectangle)

Check if this rectangle contains the given rectangle.

Parameters:

rectangle - the rectangle to test

Returns:

true iff this rectangle contains the rectangle; false otherwise

containsPoint

public boolean containsPoint(org.joml.Vector2ic point)

Check if this rectangle contains the given point.

Parameters:

point - the point to test

Returns:

true iff this rectangle contains the point; false otherwise

containsPoint

public boolean containsPoint(float x,
                             float y)

Test whether the point (x, y) lies inside this BlockRegion.

Parameters:

x - the x coordinate of the point

y - the y coordinate of the point

Returns:

true iff the given point lies inside this BlockRegion; false otherwise

containsPoint

public boolean containsPoint(org.joml.Vector2fc point)

Test whether the point (x, y) lies inside this BlockRegion.

Parameters:

point - the point to test

Returns:

true iff the given point lies inside this BlockRegion; false otherwise

containsPoint

public boolean containsPoint(int x,
                             int y)

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

Parameters:

x - the x coordinate of the point to check

y - the y coordinate of the point to check

Returns:

true iff this rectangle contains the point; false otherwise

translate

public Rectanglei translate(org.joml.Vector2ic xy)

Translate this by the given vector xy.

Parameters:

xy - the vector to translate by

Returns:

this

translate

public Rectanglei translate(org.joml.Vector2ic xy,
                            Rectanglei dest)

Translate this by the given vector xy and store the result in dest.

Parameters:

xy - the vector to translate by

dest - will hold the result

Returns:

dest

translate

public Rectanglei translate(int x,
                            int y)

Translate this by the vector (x, y).

Parameters:

x - the x coordinate to translate by

y - the y coordinate to translate by

Returns:

this

translate

public Rectanglei translate(int x,
                            int y,
                            Rectanglei dest)

Translate this by the vector (x, y) and store the result in dest.

Parameters:

x - the x coordinate to translate by

y - the y coordinate to translate by

dest - will hold the result

Returns:

dest

scale

public Rectanglei scale(int sf)

Scale this about the origin.

Parameters:

sf - the scaling factor in the x and y axis.

Returns:

this

scale

public Rectanglei scale(int sf,
                        Rectanglei dest)

Scale this about the origin and store the result in dest.

Parameters:

sf - the scaling factor in the x and y axis

dest - will hold the result

Returns:

dest

scale

public Rectanglei scale(int sf,
                        int ax,
                        int ay)

Scale this about an anchor.

This is effectively equivalent to

     translate(-ax, -ay);
     scale(sf);
     translate(ax, ay);
 

Parameters:

sf - the scaling factor in the x and y axis

ax - the x coordinate of the anchor

ay - the y coordinate of the anchor

Returns:

this

scale

public Rectanglei scale(int sf,
                        int ax,
                        int ay,
                        Rectanglei dest)

Scale this about an anchor and store the result in dest.

This is effectively equivalent to

     translate(-ax, -ay);
     scale(sf);
     translate(ax, ay);
 

Parameters:

sf - the scaling factor in the x and y axis

ax - the x coordinate of the anchor

ay - the y coordinate of the anchor

dest - will hold the result

Returns:

dest

scale

public Rectanglei scale(int sf,
                        org.joml.Vector2ic anchor)

Scale this about an anchor.

This is effectively equivalent to

     translate(anchor.negate());
     scale(sf);
     translate(anchor.negate());
 

Parameters:

sf - the scaling factor in the x and y axis

anchor - the location of the anchor

Returns:

this

scale

public Rectanglei scale(int sf,
                        org.joml.Vector2ic anchor,
                        Rectanglei dest)

Scale this about an anchor and store the result in dest.

This is effectively equivalent to

     translate(anchor.negate());
     scale(sf);
     translate(anchor.negate());
 

Parameters:

sf - the scaling factor in the x and y axis

anchor - the location of the anchor

dest - will hold the result

Returns:

dest

scale

public Rectanglei scale(int sx,
                        int sy)

Scale this about the origin.

Parameters:

sx - the scaling factor on the x axis

sy - the scaling factor on the y axis

Returns:

this

scale

public Rectanglei scale(int sx,
                        int sy,
                        Rectanglei dest)

Scale this about the origin and store the result in dest.

Parameters:

sx - the scaling factor on the x axis

sy - the scaling factor on the y axis

dest - will hold the result

Returns:

dest

scale

public Rectanglei scale(int sx,
                        int sy,
                        int ax,
                        int ay)

Scale this about an anchor. This is equivalent to

     translate(-ax, -ay);
     scale(sx, sy);
     translate(ax, ay);
 

Parameters:

sx - the scaling factor on the x axis

sy - the scaling factor on the y axis

ax - the x coordinate of the anchor

ay - the y coordinate of the anchor

Returns:

this

scale

public Rectanglei scale(int sx,
                        int sy,
                        org.joml.Vector2ic anchor)

Scale this about an anchor.

This is equivalent to

     translate(anchor.negate());
     scale(sx, sy);
     translate(anchor.negate());
 

Parameters:

sx - the scaling factor on the x axis

sy - the scaling factor on the y axis

anchor - the location of the anchor

Returns:

this

scale

public Rectanglei scale(int sx,
                        int sy,
                        int ax,
                        int ay,
                        Rectanglei dest)

Scale this about an anchor and store the result in dest.

This is equivalent to

     translate(-ax, -ay);
     scale(sx, sy);
     translate(ax, ay);
 

Parameters:

sx - the scaling factor on the x axis

sy - the scaling factor on the y axis

ax - the x coordinate of the anchor

ay - the y coordinate of the anchor

dest - will hold the result

Returns:

dest

scale

public Rectanglei scale(int sx,
                        int sy,
                        org.joml.Vector2ic anchor,
                        Rectanglei dest)

Scale this about an anchor and store the result in dest.

This is equivalent to

     translate(anchor.negate());
     scale(sx, sy);
     translate(anchor.negate());
 

Parameters:

sx - the scaling factor on the x axis

sy - the scaling factor on the y axis

anchor - the location of the anchor

dest - will hold the result

Returns:

dest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Return a string representation of this rectangle.

This method creates a new DecimalFormat on every invocation with the format string "0.000E0;-".

Overrides:

toString in class Object

Returns:

the string representation

toString

public String toString(NumberFormat formatter)

Return a string representation of this rectangle by formatting the vector components with the given NumberFormat.

Parameters:

formatter - the NumberFormat used to format the vector components with

Returns:

the string representation

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException