Record Class MinimumTranslationVector

java.lang.Object
java.lang.Record
technology.sola.engine.physics.MinimumTranslationVector
Record Components:
normal - the collision normal
penetration - the penetration of the collision

@NullMarked public record MinimumTranslationVector(Vector2D normal, float penetration) extends Record
The minimum translation vector contains the information needed to resolve a collision.
  • Constructor Details

    • MinimumTranslationVector

      public MinimumTranslationVector(Vector2D normal, float penetration)
      Creates an instance of a MinimumTranslationVector record class.
      Parameters:
      normal - the value for the normal record component
      penetration - the value for the penetration record component
  • Method Details

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

      public Vector2D normal()
      Returns the value of the normal record component.
      Returns:
      the value of the normal record component
    • penetration

      public float penetration()
      Returns the value of the penetration record component.
      Returns:
      the value of the penetration record component