Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-24 01:31:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpilib] Improve curvature drive documentation (NFC) (#3783)

Browse Source
This commit is contained in:
Tyler Veness
2021-12-12 17:59:04 -08:00
committed by GitHub
parent 8b5bf8632e
commit 8d9836ca02
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
wpilibj/src/main/java/edu/wpi/first/wpilibj/drive/DifferentialDrive.java
View File

@@ -188,10 +188,9 @@ public class DifferentialDrive extends RobotDriveBase implements Sendable, AutoC
* heading change. This makes the robot more controllable at high speeds.
*
* @param xSpeed The robot's speed along the X axis [-1.0..1.0]. Forward is positive.
* @param zRotation The robot's rotation rate around the Z axis [-1.0..1.0]. Clockwise is
* positive.
* @param zRotation The normalized curvature [-1.0..1.0]. Clockwise is positive.
* @param allowTurnInPlace If set, overrides constant-curvature turning for turn-in-place
* maneuvers.
* maneuvers. zRotation will control turning rate instead of curvature.
*/
@SuppressWarnings("ParameterName")
public void curvatureDrive(double xSpeed, double zRotation, boolean allowTurnInPlace) {
@@ -313,10 +312,9 @@ public class DifferentialDrive extends RobotDriveBase implements Sendable, AutoC
* heading change. This makes the robot more controllable at high speeds.
*
* @param xSpeed The robot's speed along the X axis [-1.0..1.0]. Forward is positive.
* @param zRotation The robot's rotation rate around the Z axis [-1.0..1.0]. Clockwise is
* positive.
* @param zRotation The normalized curvature [-1.0..1.0]. Clockwise is positive.
* @param allowTurnInPlace If set, overrides constant-curvature turning for turn-in-place
* maneuvers.
* maneuvers. zRotation will control rotation rate around the Z axis instead of curvature.
* @return Wheel speeds.
*/
@SuppressWarnings("ParameterName")