Package limn.graphics

Record Class Rect

java.lang.Object
java.lang.Record
limn.graphics.Rect
Record Components:
x - left edge
y - top edge
width - width (may be 0, never negative)
height - height (may be 0, never negative)
public record Rect(float x, float y, float width, float height) extends Record
Immutable axis-aligned rectangle in logical points.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    bottom()
    y + height.
    float
    centerX()
    Horizontal midpoint.
    float
    centerY()
    Vertical midpoint.
    boolean
    contains(float px, float py)
    Whether the point is inside, taking the left and top edges and excluding right and 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.
    float
    height()
    Returns the value of the height record component.
    Rect
    inflate(float amount)
     
    Rect
    intersect(Rect other)
     
    float
    right()
    x + width.
    final String
    toString()
    Returns a string representation of this record class.
    Rect
    union(Rect other)
     
    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 java.lang.Object

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

  • Constructor Details

    • Rect

      public Rect(float x, float y, float width, float 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

    • right

      public float right()
      x + width.

    • bottom

      public float bottom()
      y + height.

    • centerX

      public float centerX()
      Horizontal midpoint.

    • centerY

      public float centerY()
      Vertical midpoint.

    • contains

      public boolean contains(float px, float py)
      Whether the point is inside, taking the left and top edges and excluding right and bottom.

    • intersect

      public Rect intersect(Rect other)
      Returns:
      the intersection with other (a zero-sized rect if disjoint)

    • union

      public Rect union(Rect other)
      Returns:
      the smallest rect containing both this and other (zero-sized rects contribute their origin)

    • inflate

      public Rect inflate(float amount)
      Returns:
      this rect grown by amount on every side (shrunk if negative)

    • 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 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