Package me.deecaad.core.transition

Record Class Keyframe<T>

java.lang.Object
java.lang.Record
me.deecaad.core.transition.Keyframe<T>
Record Components:
time - Normalized time in [0, 1]. The first keyframe in a transition must have time == 0; the last must have time == 1.
value - The non-null value at time.
easingToNext - The non-null easing applied along the segment from THIS keyframe to the next. Ignored on the last keyframe.
public record Keyframe<T>(double time, T value, @NotNull Easing easingToNext) extends Record
One sample in a Transition: the normalized time at which value should be reached, and the easingToNext curve that shapes how the previous segment approaches this keyframe.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Keyframe(double time, T value, @NotNull Easing easingToNext)
    Creates an instance of a Keyframe record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Easing
    easingToNext()
    Returns the value of the easingToNext record component.
    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.
    double
    time()
    Returns the value of the time record component.
    final String
    toString()
    Returns a string representation of this record class.
    T
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Keyframe

      public Keyframe(double time, @NotNull T value, @NotNull @NotNull Easing easingToNext)
      Creates an instance of a Keyframe record class.
      Parameters:
      time - the value for the time record component
      value - the value for the value record component
      easingToNext - the value for the easingToNext 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.

    • time

      public double time()
      Returns the value of the time record component.
      Returns:
      the value of the time record component

    • value

      @NotNull public T value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • easingToNext

      @NotNull public @NotNull Easing easingToNext()
      Returns the value of the easingToNext record component.
      Returns:
      the value of the easingToNext record component