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

[wpimath] Correct Rotation3d::RotateBy doc comment (NFC) (#5541)

Browse Source 
Improve transform doc comment consistency
This commit is contained in:
Joseph Eng
2023-08-15 13:12:09 -07:00
committed by GitHub
parent 186b409e16
commit 7a37e3a496
5 changed files with 18 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
wpimath/src/main/native/include/frc/geometry/Rotation3d.h
View File

@@ -139,12 +139,12 @@ class WPILIB_DLLEXPORT Rotation3d {
/**
* Adds the new rotation to the current rotation. The other rotation is
* applied intrinsically, which means that it rotates around the axes after
* applying this rotation. For example, Rotation3d{90_deg, 0, 0}.RotateBy(
* Rotation3d{0, 90_deg, 0}) rotates by 90 degrees around the +X axis and then
* by 90 degrees around the new +Y axis (which has been moved to the +Z axis).
* applied extrinsically, which means that it rotates around the global axes.
* For example, Rotation3d{90_deg, 0, 0}.RotateBy(Rotation3d{0, 45_deg, 0})
* rotates by 90 degrees around the +X axis and then by 45 degrees around the
* global +Y axis. (This is equivalent to Rotation3d{90_deg, 45_deg, 0})
*
* @param other The rotation to rotate by.
* @param other The extrinsic rotation to rotate by.
*
* @return The new rotated Rotation3d.
*/

3
wpimath/src/main/native/include/frc/geometry/Transform2d.h
View File

@@ -94,7 +94,8 @@ class WPILIB_DLLEXPORT Transform2d {
}
/**
* Composes two transformations.
* Composes two transformations. The second transform is applied relative to
* the orientation of the first.
*
* @param other The transform to compose with this one.
* @return The composition of the two transformations.

3
wpimath/src/main/native/include/frc/geometry/Transform3d.h
View File

@@ -99,7 +99,8 @@ class WPILIB_DLLEXPORT Transform3d {
Transform3d operator/(double scalar) const { return *this * (1.0 / scalar); }
/**
* Composes two transformations.
* Composes two transformations. The second transform is applied relative to
* the orientation of the first.
*
* @param other The transform to compose with this one.
* @return The composition of the two transformations.