Skip to content

Deprecate in-house path planning and path following - #698

Open
NormalDuck wants to merge 1 commit into
mainfrom
deprecate/path-planning
Open

NormalDuck wants to merge 1 commit into
mainfrom
deprecate/path-planning

Conversation

@NormalDuck

Copy link
Copy Markdown
Contributor

Why are we doing this?

Robot projects now plan and follow paths with PathPlanner, so the library's own path planning and following code is on its way out. TeamXbot2026 still references some of it (XbotSwervePoint, SwervePointPathPlanning, SwerveSimpleBezierCommand, SwerveSimpleTrajectoryCommand, SwerveSimpleTrajectoryMode, Obstacle), so this PR only deprecates it. Deletion can follow once robot code has moved off these classes.

Whats changing?

Each of these types gets @Deprecated and a @deprecated Javadoc note pointing at PathPlanner. There are no behaviour changes and nothing is removed.

  • Obstacle-avoiding planner: LowResField, Obstacle, SwervePointPathPlanning, ProvidesWaypoints
  • Swerve trajectory following: SwerveSimpleTrajectoryCommand, SwerveSimpleTrajectoryLogic, SwerveSimpleBezierCommand, SwerveSimpleBezierLogic, SwerveSimpleTrajectoryMode, SimpleInterpolator, SimpleTimeInterpolator, XbotSwervePoint, ProvidesInterpolationData
  • Tank pure pursuit: PurePursuitCommand, ConfigurablePurePursuitCommand, PurePursuitTest, PurePursuitTestComponent

Questions/notes for reviewers

  • Robot projects that use these classes will start seeing deprecation warnings at compile time. Builds that treat warnings as errors would need to suppress them or migrate.
  • Left alone on purpose, since they were not part of the agreed list: RabbitPoint and RabbitPointBuilder (only used by pure pursuit and PlanarTestVisualizer), SwervePointKinematics, and SwerveKinematicsCalculator. Say if these should be deprecated too.
  • I used plain @Deprecated rather than forRemoval = true, because removal warnings also fire inside the deprecated classes that use each other.

How this was tested

  • unit tests added
  • tested on robot

Annotation-only change; ./gradlew build passes locally.

🤖 Generated with Claude Code

Mark the obstacle-avoiding planner, the swerve trajectory and Bezier
commands, and tank pure pursuit as @deprecated now that robot projects
plan paths with PathPlanner. Nothing is removed yet.

Co-Authored-By: Claude <noreply@anthropic.com>
@NormalDuck
NormalDuck requested a review from a team as a code owner November 16, 2026 05:11

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant