Diff: Display.h

Revision:

16:8d158d39d438

Parent:

14:dd1f98f7d43a

Child:

17:1c52ff51c028

diff -r c14c72342de7 -r 8d158d39d438 Display.h
--- a/Display.h	Mon Apr 24 09:46:56 2017 +0000
+++ b/Display.h	Mon May 01 17:04:13 2017 +0000
@@ -5,6 +5,12 @@
 #include "N5110.h" 
 #include "Controller.h"
 
+/** Display Class
+@brief This class encapsulates all the algorithms reaquired for the displaying strings and time dependant patterns on the lcd.
+@author Dominic Kay
+
+@date April 2017
+*/
 class Display
 {
 
@@ -41,37 +47,36 @@
      * @param ran random number generated from operator
      * @return void
      */
-    void display_instruction(N5110 &lcd, int ran); 
-    
-    /** Methord for the mathematical operation behind the change in time before gameover */
-    void calculateWait();  
+    void display_instruction(N5110 &lcd, int ran);   
 
      
 private:
       
+     /** Methord for the mathematical operation behind the change in time before gameover */
+    void _calculateWait();
+    
     /** 
     @brief Methord allowing one octant to be displayed at one time. Also allows interaction with controller for flashing screen and sounds 
     @param id[in] void
     @return interger used in for loop (representing nember of loops) 
     */
-    void Circle(Controller &ctrl, N5110 &lcd); 
+    void _arc_selector(Controller &ctrl, N5110 &lcd); 
     
     /**
      * @brief An algorithm that draws the eight octants of a circle pixel by pixel
      * @param id[in] interger used in for loop from Circle() Methord
      * @return void
      */
-    void Drawarc(N5110 &lcd, int a); 
+    void _drawArc(N5110 &lcd, int a); 
     
-    int _h;             // <<number of arcs displayed        
+    int _h;             // <<score / number of full circle performed      
     float _w;           // <<wait time 
     int _a;             // <<for loop variable 
-    int _v;             // <<interger to tell class which random instuction to perform
-    int x;              // <<radius of circle
-    int y;              // <<y co-ordinate 
-    int x0;             // <<variable used to modify x
-    int y0;             // <<variable used to modify y
-    int radiusMod;      // <<1 - the radius of the circle
+    int _x;              // <<radius of circle
+    int _y;              // <<y co-ordinate 
+    int _x0;             // <<variable used to modify x
+    int _y0;             // <<variable used to modify y
+    int _radiusMod;      // <<1 - the radius of the circle
     
 
 };