Module technology.sola.engine
Package technology.sola.engine.assets.graphics.spritesheet

Record Class SpriteInfo

java.lang.Object
java.lang.Record
technology.sola.engine.assets.graphics.spritesheet.SpriteInfo
Record Components:
id - the id of the sprite
x - the left most coordinate of the sprite
y - the top most coordinate of the sprite
width - the width of the sprite
height - the height of the sprite
@NullMarked public record SpriteInfo(String id, int x, int y, int width, int height) extends Record
Contains information about a sprite within a spritesheet.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpriteInfo(String id, int x, int y, int width, int height)
    Creates an instance of a SpriteInfo 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.
    boolean
    hasSameBounds(SpriteInfo other)
    Checks to see if this sprite info has the same boundaries that another sprite does.
    int
    height()
    Returns the value of the height record component.
    String
    id()
    Returns the value of the id 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

    • SpriteInfo

      public SpriteInfo(String id, int x, int y, int width, int height)
      Creates an instance of a SpriteInfo record class.
      Parameters:
      id - the value for the id record component
      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

    • hasSameBounds

      public boolean hasSameBounds(SpriteInfo other)
      Checks to see if this sprite info has the same boundaries that another sprite does.
      Parameters:
      other - the other SpriteInfo to compare bounds with
      Returns:
      true if they have the same bounds

    • 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 '=='.
      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.

    • id

      public String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • 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