Enum Class GridAlignment

java.lang.Object
java.lang.Enum<GridAlignment>
dev.prozilla.pine.common.math.vector.GridAlignment
All Implemented Interfaces:
Serializable, Comparable<GridAlignment>, Constable

public enum GridAlignment extends Enum<GridAlignment>
2-dimensional anchor point relative to the bottom-left corner of a square with width and height 1f.
  • Enum Constant Details

  • Field Details

    • x

      public final float x
      Horizontal factor of this alignment. Range from 0f to 1f.
    • y

      public final float y
      Vertical factor of this alignment. Range from 0f to 1f.
  • Method Details

    • values

      public static GridAlignment[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static GridAlignment valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • toVector

      public Vector2f toVector(float width, float height)
      Converts this alignment to a vector inside a rectangle.
      Parameters:
      width - Width of the rectangle
      height - Height of the rectangle
      Returns:
      The position inside the rectangle as a Vector2f.
    • toVector

      public Vector2f toVector()
      Returns:
      This alignment as a vector.