Package choreo.trajectory

Class EventMarker

java.lang.Object
choreo.trajectory.EventMarker
public class EventMarker extends Object
A marker for an event in a trajectory.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EventMarker.Deserializer
    GSON deserializer for choreolib event markers

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final String
    event
    The event.
    final double
    timestamp
    The timestamp of the event.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EventMarker(double timestamp, String event)
    Constructs an EventMarker with the specified parameters.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    EventMarker
    offsetBy(double timestampOffset)
    Returns a new EventMarker with the timestamp offset by the specified amount.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • timestamp

      public final double timestamp
      The timestamp of the event.

    • event

      public final String event
      The event.

  • Constructor Details

    • EventMarker

      public EventMarker(double timestamp, String event)
      Constructs an EventMarker with the specified parameters.
      Parameters:
      timestamp - The timestamp of the event.
      event - The event.

  • Method Details

    • offsetBy

      public EventMarker offsetBy(double timestampOffset)
      Returns a new EventMarker with the timestamp offset by the specified amount.
      Parameters:
      timestampOffset - The amount to offset the timestamp by.
      Returns:
      A new EventMarker with the timestamp offset by the specified amount.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object