WPILibC++ 2024.3.2
frc::MecanumDriveWheelPositions Struct Reference

Represents the wheel positions for a mecanum drive drivetrain. More...

#include <frc/kinematics/MecanumDriveWheelPositions.h>

Public Member Functions

bool operator== (const MecanumDriveWheelPositions &other) const =default
 Checks equality between this MecanumDriveWheelPositions and another object. More...
 
bool operator!= (const MecanumDriveWheelPositions &other) const =default
 Checks inequality between this MecanumDriveWheelPositions and another object. More...
 
MecanumDriveWheelPositions Interpolate (const MecanumDriveWheelPositions &endValue, double t) const
 

Public Attributes

units::meter_t frontLeft = 0_m
 Distance driven by the front-left wheel. More...
 
units::meter_t frontRight = 0_m
 Distance driven by the front-right wheel. More...
 
units::meter_t rearLeft = 0_m
 Distance driven by the rear-left wheel. More...
 
units::meter_t rearRight = 0_m
 Distance driven by the rear-right wheel. More...
 

Detailed Description

Represents the wheel positions for a mecanum drive drivetrain.

Member Function Documentation

◆ Interpolate()

MecanumDriveWheelPositions frc::MecanumDriveWheelPositions::Interpolate ( const MecanumDriveWheelPositions endValue,
double  t 
) const
inline

◆ operator!=()

bool frc::MecanumDriveWheelPositions::operator!= ( const MecanumDriveWheelPositions other) const
default

Checks inequality between this MecanumDriveWheelPositions and another object.

Parameters
otherThe other object.
Returns
Whether the two objects are not equal.

◆ operator==()

bool frc::MecanumDriveWheelPositions::operator== ( const MecanumDriveWheelPositions other) const
default

Checks equality between this MecanumDriveWheelPositions and another object.

Parameters
otherThe other object.
Returns
Whether the two objects are equal.

Member Data Documentation

◆ frontLeft

units::meter_t frc::MecanumDriveWheelPositions::frontLeft = 0_m

Distance driven by the front-left wheel.

◆ frontRight

units::meter_t frc::MecanumDriveWheelPositions::frontRight = 0_m

Distance driven by the front-right wheel.

◆ rearLeft

units::meter_t frc::MecanumDriveWheelPositions::rearLeft = 0_m

Distance driven by the rear-left wheel.

◆ rearRight

units::meter_t frc::MecanumDriveWheelPositions::rearRight = 0_m

Distance driven by the rear-right wheel.


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