Record Class GuiRect

java.lang.Object
java.lang.Record
com.render.api.gui.GuiRect
Record Components:
x - left coordinate
y - top coordinate
width - non-negative width
height - non-negative height
public record GuiRect(float x, float y, float width, float height) extends Record
Immutable rectangle in RenderLib design-space coordinates.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    bottom()
    Returns the bottom edge.
    float
    centerX()
     
    float
    centerY()
     
    boolean
    contains(float pointX, float pointY)
     
    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.
    float
    height()
    Returns the value of the height record component.
    GuiRect
    inset(float amount)
    Returns a rectangle inset on every edge.
    GuiRect
    inset(float horizontal, float vertical)
    Returns a rectangle inset horizontally and vertically.
    GuiRect
    intersection(GuiRect other)
    Returns the overlapping area of this rectangle and another rectangle.
    float
    right()
    Returns the right edge.
    final String
    toString()
    Returns a string representation of this record class.
    float
    width()
    Returns the value of the width record component.
    float
    x()
    Returns the value of the x record component.
    float
    y()
    Returns the value of the y record component.

    Methods inherited from class Object

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

  • Constructor Details

    • GuiRect

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

    • right

      public float right()
      Returns the right edge.
      Returns:
      x + width

    • bottom

      public float bottom()
      Returns the bottom edge.
      Returns:
      y + height

    • centerX

      public float centerX()

    • centerY

      public float centerY()

    • contains

      public boolean contains(float pointX, float pointY)

    • inset

      public GuiRect inset(float amount)
      Returns a rectangle inset on every edge. Negative values expand the rectangle.
      Parameters:
      amount - inset in design-space pixels
      Returns:
      inset rectangle

    • inset

      public GuiRect inset(float horizontal, float vertical)
      Returns a rectangle inset horizontally and vertically. Negative values expand it.
      Parameters:
      horizontal - horizontal inset per edge
      vertical - vertical inset per edge
      Returns:
      inset rectangle

    • intersection

      public GuiRect intersection(GuiRect other)
      Returns the overlapping area of this rectangle and another rectangle.
      Parameters:
      other - rectangle to intersect with
      Returns:
      intersection, with zero width or height when the rectangles do not overlap

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

    • y

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

    • width

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

    • height

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