Record Class GuiArea

java.lang.Object
java.lang.Record
net.ixdarklord.coolcatcanvas.api.client.gui.placement.GuiArea
public record GuiArea(int x, int y, int width, int height, GuiArea.Kind kind) extends Record
A box something on the screen takes up, in GUI pixels: a thing drawn (GuiArea.Kind.DRAWN: a sprite, a fill, a line of text, an item) or a widget of the open screen (GuiArea.Kind.WIDGET: a button, a text box), from GuiAreas.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    GuiArea.Kind
     

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    bottom()
     
    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.
    boolean
    intersects(int x, int y, int width, int height)
    Whether this and the box given overlap (touching edges don't).
    boolean
    isInside(int x, int y, int width, int height)
    Whether this lies wholly inside the box given.
    GuiArea.Kind
    kind()
    Returns the value of the kind record component.
    int
    right()
     
    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 Object

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

  • Constructor Details

    • GuiArea

      public GuiArea(int x, int y, int width, int height, GuiArea.Kind kind)
      Creates an instance of a GuiArea 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
      kind - the value for the kind record component

  • Method Details

    • right

      public int right()

    • bottom

      public int bottom()

    • intersects

      public boolean intersects(int x, int y, int width, int height)
      Whether this and the box given overlap (touching edges don't).

    • isInside

      public boolean isInside(int x, int y, int width, int height)
      Whether this lies wholly inside the box given.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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 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

    • kind

      public GuiArea.Kind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component