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

[wpimath] Document extrinsic vs intrinsic rotations (NFC) (#5508)

Browse Source
This commit is contained in:
Joseph Eng
2023-08-06 19:59:42 -07:00
committed by GitHub
parent 84ed8aec05
commit b5bd0771eb
8 changed files with 37 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
wpimath/src/main/native/include/frc/geometry/Pose3d.h
View File

@@ -56,7 +56,9 @@ class WPILIB_DLLEXPORT Pose3d {
/**
* Transforms the pose by the given transformation and returns the new
* transformed pose.
* transformed pose. The transform is applied relative to the pose's frame.
* Note that this differs from Pose3d::RotateBy(const Rotation3d&), which is
* applied relative to the global frame and around the origin.
*
* @param other The transform to transform the pose by.
*
@@ -133,14 +135,18 @@ class WPILIB_DLLEXPORT Pose3d {
/**
* Rotates the pose around the origin and returns the new pose.
*
* @param other The rotation to transform the pose by.
* @param other The rotation to transform the pose by, which is applied
* extrinsically (from the global frame).
*
* @return The rotated pose.
*/
Pose3d RotateBy(const Rotation3d& other) const;
/**
* Transforms the pose by the given transformation and returns the new pose.
* Transforms the pose by the given transformation and returns the new
* transformed pose. The transform is applied relative to the pose's frame.
* Note that this differs from Pose3d::RotateBy(const Rotation3d&), which is
* applied relative to the global frame and around the origin.
*
* @param other The transform to transform the pose by.
*