WPILibC++  2020.3.2-60-g3011ebe
frc::Twist2d Struct Reference

A change in distance along arc since the last pose update. More...

#include <Twist2d.h>

Public Member Functions

bool operator== (const Twist2d &other) const
 Checks equality between this Twist2d and another object. More...
 
bool operator!= (const Twist2d &other) const
 Checks inequality between this Twist2d and another object. More...
 

Public Attributes

units::meter_t dx = 0_m
 Linear "dx" component.
 
units::meter_t dy = 0_m
 Linear "dy" component.
 
units::radian_t dtheta = 0_rad
 Angular "dtheta" component (radians)
 

Detailed Description

A change in distance along arc since the last pose update.

We can use ideas from differential calculus to create new Pose2ds from a Twist2d and vise versa.

A Twist can be used to represent a difference between two poses.

Member Function Documentation

◆ operator!=()

bool frc::Twist2d::operator!= ( const Twist2d other) const
inline

Checks inequality between this Twist2d and another object.

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

◆ operator==()

bool frc::Twist2d::operator== ( const Twist2d other) const
inline

Checks equality between this Twist2d and another object.

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

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