Record Class KeyFrame

java.lang.Object
java.lang.Record
nl.colorize.util.animation.KeyFrame
All Implemented Interfaces:
Comparable<KeyFrame>
public record KeyFrame(float time, float value) extends Record implements Comparable<KeyFrame>
Defines a property's value at a certain point in time, used in conjunction with Timeline. The key frame's time indicates its position on the timeline, in seconds. The timeline will then use the key frame data, interpolating between key frames when necessary.

  • Constructor Summary

    Constructors
    Constructor
    Description
    KeyFrame(float time, float value)
    Creates an instance of a KeyFrame record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(KeyFrame other)
     
    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
    time()
    Returns the value of the time record component.
    String
    toString()
    Returns a string representation of this record class.
    float
    value()
    Returns the value of the value record component.

    Methods inherited from class Object

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

  • Constructor Details

    • KeyFrame

      public KeyFrame(float time, float value)
      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

  • Method Details

    • compareTo

      public int compareTo(KeyFrame other)
      Specified by:
      compareTo in interface Comparable<KeyFrame>

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

    • time

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

    • value

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