[wpimath] Document standard coordinate systems better (NFC) (#4228)

This commit is contained in:
Tyler Veness
2022-05-14 15:31:06 -07:00
committed by GitHub
parent 9af389b200
commit f341e1b2be
2 changed files with 20 additions and 8 deletions

View File

@@ -38,17 +38,23 @@ class WPILIB_DLLEXPORT CoordinateSystem {
CoordinateSystem& operator=(CoordinateSystem&&) = default;
/**
* Returns an instance of the NWU coordinate system.
* Returns an instance of the North-West-Up (NWU) coordinate system.
*
* The +X axis is north, the +Y axis is west, and the +Z axis is up.
*/
static CoordinateSystem NWU();
/**
* Returns an instance of the EDN coordinate system.
* Returns an instance of the East-Down-North (EDN) coordinate system.
*
* The +X axis is east, the +Y axis is down, and the +Z axis is north.
*/
static CoordinateSystem EDN();
/**
* Returns an instance of the NED coordinate system.
*
* The +X axis is north, the +Y axis is east, and the +Z axis is down.
*/
static CoordinateSystem NED();