core / com.acmerobotics.roadrunner.followers / PathFollower

PathFollower

abstract class PathFollower

Generic Path follower for time-independent pose reference tracking.

Parameters

clock - clock

Constructors

<init>

PathFollower(admissibleError: Pose2d, clock: NanoClock = NanoClock.system())

Generic Path follower for time-independent pose reference tracking.

Properties

clock

val clock: NanoClock

clock

lastError

abstract var lastError: Pose2d

Robot pose error computed in the last update call.

path

lateinit var path: Path

Path being followed if isFollowing is true.

Functions

followPath

open fun followPath(path: Path): Unit

Follow the given path.

internalUpdate

abstract fun internalUpdate(currentPose: Pose2d): DriveSignal

isFollowing

fun isFollowing(): Boolean

Returns true if the current path has finished executing.

update

fun update(currentPose: Pose2d): DriveSignal

Run a single iteration of the path follower.

Inheritors

GVFFollower

class GVFFollower : PathFollower

State-of-the-art path follower based on the GuidingVectorField.