agi.foundation.coordinates

(agi.foundation.core-2024r2.jar)

Class BoundingRectangle

java.lang.Object

agi.foundation.coordinates.BoundingRectangle

All Implemented Interfaces:

IEquatable<BoundingRectangle>, ImmutableValueType, ValueType, IEquatableEpsilon<BoundingRectangle>

public final class BoundingRectangle
extends Object
implements IEquatable<BoundingRectangle>, IEquatableEpsilon<BoundingRectangle>, ImmutableValueType

A bounding rectangle in a two-dimensional plane given by two corner points.

Constructor Summary

Constructors

Constructor and Description
BoundingRectangle() Initializes a new instance.
BoundingRectangle(double[] elements) Initializes a new instance from the first four consecutive elements in the provided array.
BoundingRectangle(double[] elements, int startIndex) Initializes a new instance from four consecutive elements in the provided array.
BoundingRectangle(double left, double bottom, double right, double top) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(BoundingRectangle left, BoundingRectangle right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsEpsilon(BoundingRectangle other, double epsilon) Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
boolean	equalsType(BoundingRectangle other) Indicates whether another instance of this type is exactly equal to this instance.
static BoundingRectangle	fromWidthHeight(double x, double y, double width, double height) Initializes a new instance.
double	get(int index) Gets the value of the specified element with index of 0, 1, 2, and 3 corresponding to the coordinates Left (get), Bottom (get), Right (get), and Top (get).
double	getBottom() Gets the y-coordinate of the bottom edge of the rectangle.
static BoundingRectangle	getEmpty() Gets a BoundingRectangle with all values set to zero.
double	getHeight() Gets the height of the rectangle.
double	getLeft() Gets the x-coordinate of the left edge of the rectangle.
int	getLength() Gets the number of elements in this set of coordinates.
double	getRight() Gets the x-coordinate of the right edge of the rectangle.
double	getTop() Gets the y-coordinate of the top edge of the rectangle.
double	getWidth() Gets the width of the rectangle.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(BoundingRectangle left, BoundingRectangle right) Returns true if the two instances are not exactly equal.
String	toString() Returns the string representation of the value of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundingRectangle

public BoundingRectangle()

Initializes a new instance.

BoundingRectangle

public BoundingRectangle(double left,
                         double bottom,
                         double right,
                         double top)

Initializes a new instance.

Parameters:

left - The x coordinate of the lower-left corner.

bottom - The y coordinate of the lower-left corner.

right - The x coordinate of the upper-right corner.

top - The y coordinate of the upper-right corner.

Throws:

ArgumentException - Thrown when the right parameter is less than the left parameter or when the top parameter is less than the bottom parameter.

BoundingRectangle

public BoundingRectangle(@Nonnull
                         double[] elements)

Initializes a new instance from the first four consecutive elements in the provided array.

Parameters:

elements - The array of coordinate values.

Throws:

ArgumentNullException - The array of elements cannot be null.

ArgumentOutOfRangeException - An object of this type must be constructed from an array with at least four elements.

ArgumentException - Thrown when the right parameter is less than the left parameter or when the top parameter is less than the bottom parameter.

BoundingRectangle

public BoundingRectangle(@Nonnull
                         double[] elements,
                         int startIndex)

Initializes a new instance from four consecutive elements in the provided array.

Parameters:

elements - The array of coordinate values.

startIndex - The index of the first element in the array to use.

Throws:

ArgumentNullException - Thrown when the array of elements is null.

ArgumentOutOfRangeException - Thrown when an object of this type is constructed from an array with less than four elements.

ArgumentException - Thrown when the right parameter is less than the left parameter or when the top parameter is less than the bottom parameter.

Method Detail

getEmpty

@Nonnull
public static BoundingRectangle getEmpty()

Gets a BoundingRectangle with all values set to zero.

fromWidthHeight

@Nonnull
public static BoundingRectangle fromWidthHeight(double x,
                                                          double y,
                                                          double width,
                                                          double height)

Initializes a new instance.

Parameters:

x - The x coordinate of the lower-left corner.

y - The y coordinate of the lower-left corner.

width - The width of the rectangle.

height - The height of the rectangle.

Returns:

A new BoundingRectangle.

getLeft

public final double getLeft()

Gets the x-coordinate of the left edge of the rectangle.

getTop

public final double getTop()

Gets the y-coordinate of the top edge of the rectangle.

getBottom

public final double getBottom()

Gets the y-coordinate of the bottom edge of the rectangle.

getRight

public final double getRight()

Gets the x-coordinate of the right edge of the rectangle.

getWidth

public final double getWidth()

Gets the width of the rectangle.

getHeight

public final double getHeight()

Gets the height of the rectangle.

getLength

public final int getLength()

Gets the number of elements in this set of coordinates.

get

public final double get(int index)

Gets the value of the specified element with index of 0, 1, 2, and 3 corresponding to the coordinates Left (get), Bottom (get), Right (get), and Top (get).

Parameters:

index - The index to retrieve.

Returns:

The coordinate associated with the specified index.

Throws:

ArgumentOutOfRangeException - Thrown when index is less than 0 or greater than or equal to Length (get).

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(@Nonnull
                                BoundingRectangle other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<BoundingRectangle>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equalsEpsilon

public final boolean equalsEpsilon(@Nonnull
                                   BoundingRectangle other,
                                   double epsilon)

Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.

Specified by:

equalsEpsilon in interface IEquatableEpsilon<BoundingRectangle>

Parameters:

other - The set of BoundingRectangle coordinates to compare to this instance.

epsilon - The limit at which the absolute differences between the coordinate values will not be considered equal.

Returns:

true if the absolute differences are less than or equal to epsilon; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Returns the string representation of the value of this instance.

Overrides:

toString in class Object

Returns:

A string that represents the value of this instance in the form "Left, Bottom, Right, Top".

equals

public static boolean equals(@Nonnull
                             BoundingRectangle left,
                             @Nonnull
                             BoundingRectangle right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                BoundingRectangle left,
                                @Nonnull
                                BoundingRectangle right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.