Package com.pathplanner.lib.pathfinding

Record Class LocalADStar.GridPosition

java.lang.Object
java.lang.Record
com.pathplanner.lib.pathfinding.LocalADStar.GridPosition
Record Components:
x - X index in the grid
y - Y index in the grid
All Implemented Interfaces:
Comparable<LocalADStar.GridPosition>
Enclosing class:
LocalADStar
public static record LocalADStar.GridPosition(int x, int y) extends Record implements Comparable<LocalADStar.GridPosition>
Represents a node in the pathfinding grid

  • Constructor Summary

    Constructors
    Constructor
    Description
    GridPosition(int x, int y)
    Creates an instance of a GridPosition record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(LocalADStar.GridPosition o)
     
    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.
    final String
    toString()
    Returns a string representation of this record class.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GridPosition

      public GridPosition(int x, int y)
      Creates an instance of a GridPosition record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component

  • Method Details

    • compareTo

      public int compareTo(LocalADStar.GridPosition o)
      Specified by:
      compareTo in interface Comparable<LocalADStar.GridPosition>

    • 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. All components in this record class 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.

    • x

      public int x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public int y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component