Robot Core Documentation
Loading...
Searching...
No Matches
com.pathplanner.lib.path.PathConstraints Class Reference

Public Member Functions

 PathConstraints (double maxVelocityMps, double maxAccelerationMpsSq, double maxAngularVelocityRps, double maxAngularAccelerationRpsSq)
 
double getMaxVelocityMps ()
 
double getMaxAccelerationMpsSq ()
 
double getMaxAngularVelocityRps ()
 
double getMaxAngularAccelerationRpsSq ()
 

Detailed Description

Kinematic path following constraints

Constructor & Destructor Documentation

◆ PathConstraints()

com.pathplanner.lib.path.PathConstraints.PathConstraints ( double maxVelocityMps,
double maxAccelerationMpsSq,
double maxAngularVelocityRps,
double maxAngularAccelerationRpsSq )

Create a new path constraints object

Parameters
maxVelocityMpsMax linear velocity (M/S)
maxAccelerationMpsSqMax linear acceleration (M/S^2)
maxAngularVelocityRpsMax angular velocity (Rad/S)
maxAngularAccelerationRpsSqMax angular acceleration (Rad/S^2)

Member Function Documentation

◆ getMaxAccelerationMpsSq()

double com.pathplanner.lib.path.PathConstraints.getMaxAccelerationMpsSq ( )

Get the max linear acceleration

Returns
Max linear acceleration (M/S^2)

◆ getMaxAngularAccelerationRpsSq()

double com.pathplanner.lib.path.PathConstraints.getMaxAngularAccelerationRpsSq ( )

Get the max angular acceleration

Returns
Max angular acceleration (Rad/S^2)

◆ getMaxAngularVelocityRps()

double com.pathplanner.lib.path.PathConstraints.getMaxAngularVelocityRps ( )

Get the max angular velocity

Returns
Max angular velocity (Rad/S)

◆ getMaxVelocityMps()

double com.pathplanner.lib.path.PathConstraints.getMaxVelocityMps ( )

Get the max linear velocity

Returns
Max linear velocity (M/S)

The documentation for this class was generated from the following file: