Module io.sf.carte.echosvg.anim
Package io.sf.carte.echosvg.anim.timing

Class InstanceTime

java.lang.Object
io.sf.carte.echosvg.anim.timing.InstanceTime
All Implemented Interfaces:
Comparable<InstanceTime>
public class InstanceTime extends Object implements Comparable<InstanceTime>
A class that represents an instance time created from a timing specification.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    clearOnReset
    Whether this InstanceTime should be removed from an element's begin or end instance time lists upon reset.
    protected TimingSpecifier
    creator
    The TimingSpecifier that created this InstanceTime.
    protected float
    time
    The time.

  • Constructor Summary

    Constructors
    Constructor
    Description
    InstanceTime(TimingSpecifier creator, float time, boolean clearOnReset)
    Creates a new InstanceTime.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(InstanceTime it)
    Compares this InstanceTime with another.
    boolean
    getClearOnReset()
    Returns whether the InstanceTime should be removed from the element's begin or end instance time list when it is reset.
    float
    getTime()
    Returns the time of this instance time.
    String
    toString()
    Returns a string representation of this InstanceTime.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • time

      protected float time
      The time.

    • creator

      protected TimingSpecifier creator
      The TimingSpecifier that created this InstanceTime.

    • clearOnReset

      protected boolean clearOnReset
      Whether this InstanceTime should be removed from an element's begin or end instance time lists upon reset.

  • Constructor Details

    • InstanceTime

      public InstanceTime(TimingSpecifier creator, float time, boolean clearOnReset)
      Creates a new InstanceTime.
      Parameters:
      creator - the TimingSpecifier that created this InstanceTime
      time - the new time, in parent simple time
      clearOnReset - whether this InstanceTime should be removed from an instance time list upon element reset

  • Method Details

    • getClearOnReset

      public boolean getClearOnReset()
      Returns whether the InstanceTime should be removed from the element's begin or end instance time list when it is reset.

    • getTime

      public float getTime()
      Returns the time of this instance time.

    • toString

      public String toString()
      Returns a string representation of this InstanceTime.
      Overrides:
      toString in class Object

    • compareTo

      public int compareTo(InstanceTime it)
      Compares this InstanceTime with another.
      Specified by:
      compareTo in interface Comparable<InstanceTime>