Record Class SpringInterpolator

java.lang.Object
java.lang.Record
cromveil.combatnumbers.animation.SpringInterpolator
All Implemented Interfaces:
Interpolator
public record SpringInterpolator(float from, float to, float velocity, float stiffness, float damping, ComposeMode compose) extends Record implements Interpolator

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpringInterpolator(float from, float to, float velocity, float stiffness, float damping, ComposeMode compose)
    Creates an instance of a SpringInterpolator record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    ComposeMode
    compose()
    Returns the value of the compose record component.
    float
    damping()
    Returns the value of the damping record component.
    float
    endValue()
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    float
    from()
    Returns the value of the from record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    float
    startValue()
     
    float
    stiffness()
    Returns the value of the stiffness record component.
    float
    to()
    Returns the value of the to record component.
    final String
    toString()
    Returns a string representation of this record class.
    float
    velocity()
    Returns the value of the velocity record component.
    static SpringInterpolator
    withDefaults(float from, float to, float velocity)
     
    static SpringInterpolator
    withDefaults(float from, float to, float velocity, ComposeMode compose)
     

    Methods inherited from class Object

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

  • Constructor Details

    • SpringInterpolator

      public SpringInterpolator(float from, float to, float velocity, float stiffness, float damping, ComposeMode compose)
      Creates an instance of a SpringInterpolator record class.
      Parameters:
      from - the value for the from record component
      to - the value for the to record component
      velocity - the value for the velocity record component
      stiffness - the value for the stiffness record component
      damping - the value for the damping record component
      compose - the value for the compose record component

  • Method Details

    • withDefaults

      public static SpringInterpolator withDefaults(float from, float to, float velocity, ComposeMode compose)

    • withDefaults

      public static SpringInterpolator withDefaults(float from, float to, float velocity)

    • startValue

      public float startValue()
      Specified by:
      startValue in interface Interpolator

    • endValue

      public float endValue()
      Specified by:
      endValue in interface Interpolator

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • from

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

    • to

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

    • velocity

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

    • stiffness

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

    • damping

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

    • compose

      public ComposeMode compose()
      Returns the value of the compose record component.
      Specified by:
      compose in interface Interpolator
      Returns:
      the value of the compose record component