Package limn.math

Record Class Vec2

java.lang.Object
java.lang.Record
limn.math.Vec2
public record Vec2(float x, float y) extends Record
An immutable 2-component vector (single precision): texture coords, screen points.

The arithmetic is component-wise; normalize() is the only operation with an edge case.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Vec2
    ONE
    Both components one.
    static final Vec2
    ZERO
    Both components zero.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Vec2
    add(Vec2 o)
     
    float
    dot(Vec2 o)
     
    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
    length()
     
    float
    lengthSquared()
     
    Vec2
    mul(float s)
     
    Vec2
    normalize()
    Unit vector in the same direction; returns ZERO for a zero-length input.
    Vec2
    sub(Vec2 o)
     
    final String
    toString()
    Returns a string representation of this record class.
    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

  • Field Details

    • ZERO

      public static final Vec2 ZERO
      Both components zero.

    • ONE

      public static final Vec2 ONE
      Both components one.

  • Constructor Details

    • Vec2

      public Vec2(float x, float y)
      Creates an instance of a Vec2 record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component

  • Method Details

    • add

      public Vec2 add(Vec2 o)
      Returns:
      the sum of this vector and o

    • sub

      public Vec2 sub(Vec2 o)
      Returns:
      this vector minus o

    • mul

      public Vec2 mul(float s)
      Returns:
      this vector scaled by s

    • dot

      public float dot(Vec2 o)
      Returns:
      the dot product of this vector and o

    • lengthSquared

      public float lengthSquared()
      Returns:
      the squared length, which needs no square root

    • length

      public float length()
      Returns:
      the Euclidean length

    • normalize

      public Vec2 normalize()
      Unit vector in the same direction; returns ZERO for a zero-length input.

    • 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