Package com.pathplanner.lib.path

Record Class RotationTarget

java.lang.Object
java.lang.Record
com.pathplanner.lib.path.RotationTarget
Record Components:
position - Waypoint relative position of this target
rotation - Target rotation
public record RotationTarget(double position, Rotation2d rotation) extends Record
A target holonomic rotation at a position along a path

  • Constructor Summary

    Constructors
    Constructor
    Description
    RotationTarget(double position, Rotation2d rotation)
    Creates an instance of a RotationTarget record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    RotationTarget
    flip()
    Flip a rotation target for the other side of the field, maintaining a blue alliance origin
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    position()
    Returns the value of the position record component.
    Rotation2d
    rotation()
    Returns the value of the rotation record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • RotationTarget

      public RotationTarget(double position, Rotation2d rotation)
      Creates an instance of a RotationTarget record class.
      Parameters:
      position - the value for the position record component
      rotation - the value for the rotation record component

  • Method Details

    • flip

      public RotationTarget flip()
      Flip a rotation target for the other side of the field, maintaining a blue alliance origin
      Returns:
      The flipped rotation target

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

    • position

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

    • rotation

      public Rotation2d rotation()
      Returns the value of the rotation record component.
      Returns:
      the value of the rotation record component