Record Class Rect

java.lang.Object
java.lang.Record
dev.boze.api.gui.util.Rect
public record Rect(double x, double y, double width, double height) extends Record
An axis-aligned rectangle in GUI-scaled pixels.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Rect(double x, double y, double width, double height)
    Creates an instance of a Rect record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    bottom()
     
    double
    centerX()
     
    double
    centerY()
     
    boolean
    contains(double px, double py)
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    height()
    Returns the value of the height record component.
    double
    right()
     
    final String
    toString()
    Returns a string representation of this record class.
    double
    width()
    Returns the value of the width record component.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.

    Methods inherited from class Object

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

  • Constructor Details

    • Rect

      public Rect(double x, double y, double width, double height)
      Creates an instance of a Rect record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      width - the value for the width record component
      height - the value for the height record component

  • Method Details

    • contains

      public boolean contains(double px, double py)

    • right

      public double right()

    • bottom

      public double bottom()

    • centerX

      public double centerX()

    • centerY

      public double centerY()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • x

      public double x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public double y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • width

      public double width()
      Returns the value of the width record component.
      Returns:
      the value of the width record component

    • height

      public double height()
      Returns the value of the height record component.
      Returns:
      the value of the height record component