Package io.github.cottonmc.cotton.gui.widget.data

Record Class Rect2i

java.lang.Object
java.lang.Record
io.github.cottonmc.cotton.gui.widget.data.Rect2i
Record Components:
x - the X coordinate
y - the Y coordinate
width - the horizontal size
height - the vertical size
public record Rect2i(int x, int y, int width, int height) extends Record
An immutable, two-dimensional int rectangle consisting of a position and dimensions. This record can be used to represent rectangles on the screen.
Since:
7.0.0

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    int
    height()
    Returns the value of the height record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    width()
    Returns the value of the width record component.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Rect2i

      public Rect2i(int x, int y, int width, int height)
      Creates an instance of a Rect2i 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

    • 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 '=='.
      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 int x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

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

    • width

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

    • height

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