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

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

18
wpimath/src/main/java/edu/wpi/first/math/geometry/CoordinateSystem.java
View File

@@ -78,9 +78,11 @@ public class CoordinateSystem {
}
/**
* Returns an instance of the NWU coordinate system.
* Returns an instance of the North-West-Up (NWU) coordinate system.
*
* @return An instance of the NWU coordinate system.
* <p>The +X axis is north, the +Y axis is west, and the +Z axis is up.
*
* @return An instance of the North-West-Up (NWU) coordinate system.
*/
@SuppressWarnings("MethodName")
public static CoordinateSystem NWU() {
@@ -88,9 +90,11 @@ public class CoordinateSystem {
}
/**
* Returns an instance of the EDN coordinate system.
* Returns an instance of the East-Down-North (EDN) coordinate system.
*
* @return An instance of the EDN coordinate system.
* <p>The +X axis is east, the +Y axis is down, and the +Z axis is north.
*
* @return An instance of the East-Down-North (EDN) coordinate system.
*/
@SuppressWarnings("MethodName")
public static CoordinateSystem EDN() {
@@ -98,9 +102,11 @@ public class CoordinateSystem {
}
/**
* Returns an instance of the NED coordinate system.
* Returns an instance of the North-East-Down (NED) coordinate system.
*
* @return An instance of the NED coordinate system.
* <p>The +X axis is north, the +Y axis is east, and the +Z axis is down.
*
* @return An instance of the North-East-Down (NED) coordinate system.
*/
@SuppressWarnings("MethodName")
public static CoordinateSystem NED() {