org.joml.primitives

Class Rectanglef

java.lang.Object

org.joml.primitives.Rectanglef

All Implemented Interfaces:

Externalizable, Serializable

public class Rectanglef
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
float	maxX The x coordinate of the maximum corner.
float	maxY The y coordinate of the maximum corner.
float	minX The x coordinate of the minimum corner.
float	minY The y coordinate of the minimum corner.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
float	area() Return the area of the rectangle
boolean	containsPoint(float x, float y) Check if this rectangle contains the given point (x, y).
boolean	containsPoint(org.joml.Vector2fc 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()
Rectanglef	intersection(Rectanglef other) Compute the rectangle of intersection between this and the given rectangle.
Rectanglef	intersection(Rectanglef other, Rectanglef dest) Compute the rectangle of intersection between this and the given rectangle and store the result in dest.
Rectanglef	intersection(Rectanglei other) Compute the rectangle of intersection between this and the given rectangle.
Rectanglef	intersection(Rectanglei other, Rectanglef 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.Vector2f	lengths(org.joml.Vector2f dest) Return the length of this rectangle in the X and Y dimensions and store the result in dest.
float	lengthX() Return the length of the rectangle in the X dimension.
float	lengthY() Return the length of the rectangle in the Y dimension.
void	readExternal(ObjectInput in)
Rectanglef	scale(float sf) Scale this about the origin.
Rectanglef	scale(float sx, float sy) Scale this about the origin.
Rectanglef	scale(float sf, float ax, float ay) Scale this about an anchor.
Rectanglef	scale(float sx, float sy, float ax, float ay) Scale this about an anchor.
Rectanglef	scale(float sx, float sy, float ax, float ay, Rectanglef dest) Scale this about an anchor and store the result in dest.
Rectanglef	scale(float sf, float ax, float ay, Rectanglef dest) Scale this about an anchor and store the result in dest.
Rectanglef	scale(float sx, float sy, Rectanglef dest) Scale this about the origin and store the result in dest.
Rectanglef	scale(float sx, float sy, org.joml.Vector2fc anchor) Scale this about an anchor.
Rectanglef	scale(float sx, float sy, org.joml.Vector2fc anchor, Rectanglef dest) Scale this about an anchor and store the result in dest.
Rectanglef	scale(float sf, Rectanglef dest) Scale this about the origin and store the result in dest.
Rectanglef	scale(float sf, org.joml.Vector2fc anchor) Scale this about an anchor.
Rectanglef	scale(float sf, org.joml.Vector2fc anchor, Rectanglef dest) Scale this about an anchor and store the result in dest.
Rectanglef	set(Rectanglef source) Set this Rectanglei to be a clone of source.
Rectanglef	setMax(float maxX, float maxY) Set the maximum corner coordinates.
Rectanglef	setMax(org.joml.Vector2fc max) Set the maximum corner coordinates.
Rectanglef	setMin(float minX, float minY) Set the minimum corner coordinates.
Rectanglef	setMin(org.joml.Vector2fc 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.
Rectanglef	translate(float x, float y) Translate this by the vector (x, y).
Rectanglef	translate(float x, float y, Rectanglef dest) Translate this by the vector (x, y) and store the result in dest.
Rectanglef	translate(org.joml.Vector2fc xy) Translate this by the given vector xy.
Rectanglef	translate(org.joml.Vector2fc xy, Rectanglef dest) Translate this by the given vector xy and store the result in dest.
Rectanglef	union(float x, float y) Set this to the union of this and the given point p.
Rectanglef	union(float x, float y, Rectanglef dest) Compute the union of this and the given point (x, y, z) and store the result in dest.
Rectanglef	union(Rectanglef other) Set this to the union of this and other.
Rectanglef	union(Rectanglef other, Rectanglef dest) Compute the union of this and other and store the result in dest.
Rectanglef	union(org.joml.Vector2fc p) Set this to the union of this and the given point p.
Rectanglef	union(org.joml.Vector2ic p, Rectanglef 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 float minX

The x coordinate of the minimum corner.

minY

public float minY

The y coordinate of the minimum corner.

maxX

public float maxX

The x coordinate of the maximum corner.

maxY

public float maxY

The y coordinate of the maximum corner.

Constructor Detail

Rectanglef

public Rectanglef()

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

Rectanglef

public Rectanglef(Rectanglef source)

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

Parameters:

source - the Rectanglef to copy from

Rectanglef

public Rectanglef(org.joml.Vector2fc min,
                  org.joml.Vector2fc max)

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

Parameters:

min - the minimum coordinates

max - the maximum coordinates

Rectanglef

public Rectanglef(float minX,
                  float minY,
                  float maxX,
                  float maxY)

Create a new Rectanglef 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 Rectanglef set(Rectanglef source)

Set this Rectanglei to be a clone of source.

Parameters:

source - the Rectanglei to copy from

Returns:

this

setMin

public Rectanglef setMin(float minX,
                         float 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 Rectanglef setMin(org.joml.Vector2fc min)

Set the minimum corner coordinates.

Parameters:

min - the minimum coordinates

Returns:

this

setMax

public Rectanglef setMax(float maxX,
                         float 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 Rectanglef setMax(org.joml.Vector2fc max)

Set the maximum corner coordinates.

Parameters:

max - the maximum coordinates

Returns:

this

lengthX

public float lengthX()

Return the length of the rectangle in the X dimension.

Returns:

length in the X dimension

lengthY

public float lengthY()

Return the length of the rectangle in the Y dimension.

Returns:

length in the Y dimension

area

public float area()

Return the area of the rectangle

Returns:

area

union

public Rectanglef union(float x,
                        float 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 Rectanglef union(org.joml.Vector2fc p)

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

Parameters:

p - the point

Returns:

this

union

public Rectanglef union(float x,
                        float y,
                        Rectanglef 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 Rectanglef union(org.joml.Vector2ic p,
                        Rectanglef 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 Rectanglef union(Rectanglef other)

Set this to the union of this and other.

Parameters:

other - the other Rectanglef

Returns:

this

union

public Rectanglef union(Rectanglef other,
                        Rectanglef dest)

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

Parameters:

other - the other Rectanglef

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 Rectanglef intersection(Rectanglef other)

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

If the two rectangles do not intersect, then Float.NaN is stored in each component of dest.

Parameters:

other - the other rectangle

Returns:

this

intersection

public Rectanglef intersection(Rectanglei other)

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

If the two rectangles do not intersect, then Float.NaN is stored in each component of dest.

Parameters:

other - the other rectangle

Returns:

this

intersection

public Rectanglef intersection(Rectanglef other,
                               Rectanglef 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 Float.NaN is stored in each component of dest.

Parameters:

other - the other rectangle

dest - will hold the result

Returns:

dest

intersection

public Rectanglef intersection(Rectanglei other,
                               Rectanglef 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 Double.NaN is stored in each component of dest.

Parameters:

other - the other rectangle

dest - will hold the result

Returns:

dest

lengths

public org.joml.Vector2f lengths(org.joml.Vector2f 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.Vector2fc 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)

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 Rectanglef translate(org.joml.Vector2fc xy)

Translate this by the given vector xy.

Parameters:

xy - the vector to translate by

Returns:

this

translate

public Rectanglef translate(org.joml.Vector2fc xy,
                            Rectanglef 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 Rectanglef translate(float x,
                            float 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 Rectanglef translate(float x,
                            float y,
                            Rectanglef 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 Rectanglef scale(float sf)

Scale this about the origin.

Parameters:

sf - the scaling factor in the x and y axis

Returns:

this

scale

public Rectanglef scale(float sf,
                        Rectanglef 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 Rectanglef scale(float sf,
                        float ax,
                        float ay)

Scale this about an anchor.

This is 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 Rectanglef scale(float sf,
                        float ax,
                        float ay,
                        Rectanglef dest)

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

This is equivalent to translate(-ax, -ay, dest).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 Rectanglef scale(float sf,
                        org.joml.Vector2fc anchor)

Scale this about an anchor.

This is 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 Rectanglef scale(float sf,
                        org.joml.Vector2fc anchor,
                        Rectanglef dest)

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

This is equivalent to translate(anchor.negate(), dest).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 Rectanglef scale(float sx,
                        float 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 Rectanglef scale(float sx,
                        float sy,
                        Rectanglef 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 Rectanglef scale(float sx,
                        float sy,
                        float ax,
                        float 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 Rectanglef scale(float sx,
                        float sy,
                        org.joml.Vector2fc 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 Rectanglef scale(float sx,
                        float sy,
                        float ax,
                        float ay,
                        Rectanglef dest)

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

This is equivalent to translate(-ax, -ay, dest).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 Rectanglef scale(float sx,
                        float sy,
                        org.joml.Vector2fc anchor,
                        Rectanglef dest)

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

This is equivalent to translate(anchor.negate(), dest).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