org.joml.primitives

Class Rectangled

java.lang.Object

org.joml.primitives.Rectangled

All Implemented Interfaces:

Externalizable, Serializable

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

Constructor Summary

Constructors

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

Method Summary

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

The x coordinate of the minimum corner.

minY

public double minY

The y coordinate of the minimum corner.

maxX

public double maxX

The x coordinate of the maximum corner.

maxY

public double maxY

The y coordinate of the maximum corner.

Constructor Detail

Rectangled

public Rectangled()

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

Rectangled

public Rectangled(Rectangled source)

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

Parameters:

source - the Rectangled to copy from

Rectangled

public Rectangled(org.joml.Vector2dc min,
                  org.joml.Vector2dc max)

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

Parameters:

min - the minimum coordinates

max - the maximum coordinates

Rectangled

public Rectangled(double minX,
                  double minY,
                  double maxX,
                  double maxY)

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

Set this Rectangled to be a clone of source.

Parameters:

source - the Rectangled to copy from

Returns:

this

setMin

public Rectangled setMin(double minX,
                         double 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 Rectangled setMin(org.joml.Vector2dc min)

Set the minimum corner coordinates.

Parameters:

min - the minimum coordinates

Returns:

this

setMax

public Rectangled setMax(double maxX,
                         double 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 Rectangled setMax(org.joml.Vector2dc max)

Set the maximum corner coordinates.

Parameters:

max - the maximum coordinates

Returns:

this

lengthX

public double lengthX()

Return the length of the rectangle in the X dimension.

Returns:

length in the X dimension

lengthY

public double lengthY()

Return the length of the rectangle in the Y dimension.

Returns:

length in the Y dimension

area

public double area()

Return the area of the rectangle

Returns:

area

isValid

public boolean isValid()

Check whether this rectangle represents a valid rectangle.

Returns:

true iff this rectangle is valid; false otherwise

intersection

public Rectangled intersection(Rectangled other)

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

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

Parameters:

other - the other rectangle

Returns:

this

intersection

public Rectangled intersection(Rectangled other,
                               Rectangled 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

intersection

public Rectangled intersection(Rectanglef other,
                               Rectangled 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

intersection

public Rectangled intersection(Rectanglei other,
                               Rectangled 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.Vector2d lengths(org.joml.Vector2d 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

union

public Rectangled union(double x,
                        double 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 Rectangled union(org.joml.Vector2dc p)

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

Parameters:

p - the point

Returns:

this

union

public Rectangled union(double x,
                        double y,
                        Rectangled 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 Rectangled union(org.joml.Vector2dc p,
                        Rectangled 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 Rectangled union(Rectangled other)

Set this to the union of this and other.

Parameters:

other - the other Rectanglef

Returns:

this

union

public Rectangled union(Rectangled other,
                        Rectangled dest)

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

Parameters:

other - the other Rectangled

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

containsPoint

public boolean containsPoint(org.joml.Vector2dc 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(double x,
                             double 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 Rectangled translate(org.joml.Vector2dc xy)

Translate this by the given vector xy.

Parameters:

xy - the vector to translate by

Returns:

this

translate

public Rectangled translate(org.joml.Vector2dc xy,
                            Rectangled 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 Rectangled translate(org.joml.Vector2fc xy)

Translate this by the given vector xy.

Parameters:

xy - the vector to translate by

Returns:

this

translate

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

Scale this about the origin.

Parameters:

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

Returns:

this

scale

public Rectangled scale(double sf,
                        Rectangled 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 Rectangled scale(double sf,
                        double ax,
                        double 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 Rectangled scale(double sf,
                        double ax,
                        double ay,
                        Rectangled 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 Rectangled scale(double sf,
                        org.joml.Vector2dc 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 Rectangled scale(double sf,
                        org.joml.Vector2dc anchor,
                        Rectangled 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 Rectangled scale(double sx,
                        double 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 Rectangled scale(double sx,
                        double sy,
                        Rectangled 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 Rectangled scale(double sx,
                        double sy,
                        double ax,
                        double 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 Rectangled scale(double sx,
                        double sy,
                        org.joml.Vector2dc 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 Rectangled scale(double sx,
                        double sy,
                        double ax,
                        double ay,
                        Rectangled 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 Rectangled scale(double sx,
                        double sy,
                        org.joml.Vector2dc anchor,
                        Rectangled 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