Package nl.colorize.multimedialib.math

Record Class Angle

java.lang.Object
java.lang.Record
nl.colorize.multimedialib.math.Angle
public record Angle(float degrees) extends Record
Immutable representation of an angle in degrees. Angles are normalized to the range between 0 and 360, so an angle of 20 degrees is considered equivalent to an angle of 380 degrees.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Angle
    ORIGIN
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Angle(float degrees)
    Creates an instance of a Angle record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    degrees()
    Returns the value of the degrees record component.
    float
    difference(Angle other)
    Returns the distance between this angle and the specified other angle, in degrees.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    float
    getRadians()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    Angle
    move(float byDegrees)
     
    Angle
    move(Angle other)
     
    String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ORIGIN

      public static final Angle ORIGIN

  • Constructor Details

    • Angle

      public Angle(float degrees)
      Creates an instance of a Angle record class.
      Parameters:
      degrees - the value for the degrees record component

  • Method Details

    • getRadians

      public float getRadians()

    • difference

      public float difference(Angle other)
      Returns the distance between this angle and the specified other angle, in degrees. The returned value will be in the range between 0 and 180 degrees.

    • move

      public Angle move(Angle other)

    • move

      public Angle move(float byDegrees)

    • toString

      public 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.

    • degrees

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