Diff: SparkfunAnalogJoystick.cpp

Revision:

1:ed0057aa2e31

Parent:

0:ed9ee35481a9

Child:

2:4761030c1a7d

--- a/SparkfunAnalogJoystick.cpp	Sat Mar 07 23:28:06 2015 +0000
+++ b/SparkfunAnalogJoystick.cpp	Sun Mar 08 05:43:45 2015 +0000
@@ -3,23 +3,28 @@
 
 #define M_PI 3.14159265358979323846
 
+// Constructor
 SparkfunAnalogJoystick::SparkfunAnalogJoystick(PinName vert, PinName horz, PinName sel): VERT(vert), HORZ(horz), SEL(sel)
 {
     SEL.mode(PullUp);
 }
 
+// Get the button status
 int SparkfunAnalogJoystick::button(){
     return 1-SEL;
 }
 
+// X axis value, reverse the value to get the x value in a normal Cartesian coordinate system
 float SparkfunAnalogJoystick::xAxis(){
     return -(HORZ-0.5)*2;
 }
 
+// Y axis value
 float SparkfunAnalogJoystick::yAxis(){
     return (VERT-0.5)*2;
 }
 
+// Calculate the angle value in a polar coordinate system
 float SparkfunAnalogJoystick::angle(){
     float horz=-(HORZ-0.5)*2;
     float vert=(VERT-0.5)*2;
@@ -34,6 +39,7 @@
     return angle;
 }
 
+// Calculate the normalized distance value in a polar coordinate system
 float SparkfunAnalogJoystick::distance(){
     float horz=-(HORZ-0.5)*2;
     float vert=(VERT-0.5)*2;