Added comments to the main.c file

hexagon.c

@@ -8,25 +8,36 @@
 #include "syscall.h"
 
 #define FPS 60
+//duration of a frame
 #define FRAME_TIME 1/FPS
+
+//see struct.h
 Line lines[6] = {{0, NULL, 0},{1, NULL, 60},{2, NULL, 120},{3, NULL, 180},{4, NULL, 240},{5, NULL, 300}};
 
+//oriented angle between the player and the horizontal axis
 int player_angle=0;
 
 Camera cam = {64, 32, 0};
 
+//linked list of obstacles
 Wall *list = NULL;
 
+//delta angle: defines the 'speed' of the player
 float dAngle = 10;
 
+//function prototypes
+//draws the player
 void drawPlayer();
-
+//draws one of the lines (from 0 to 2)
 void drawDiagonal(int nb);
 
 int AddIn_main(int isAppli, unsigned short OptionNum)
 {
+	//variables for fps calculation
     unsigned int fps = 0, frame = 0, tempsOrigine = RTC_GetTicks();
+	//char string to display the fps
     unsigned char fps_text[8] = {0};
+	//rand initialisation
     srand(RTC_GetTicks());
 
     //list = addWall(list, 128, 8, 1, 1);
@@ -34,26 +45,30 @@ int AddIn_main(int isAppli, unsigned short OptionNum)
     while(KeyUp(K_EXIT)){
         //fps
         int current_frame_time = RTC_GetTicks();
-        if(RTC_GetTicks() - tempsOrigine >= 32 )//1/4 seconds
+        if(RTC_GetTicks() - tempsOrigine >= 32 )//if 1/4 seconds elapsed
         {
             fps = frame*4;
             frame = 0;
             tempsOrigine = RTC_GetTicks();
         }
         frame++;
-
+	
+	//rotating the camera
         cam.angle = (int) (cam.angle + dAngle);
         if(cam.angle >= 360)cam.angle = cam.angle - 359;
-        if(list != NULL){
-            update(list);
-            if(isColliding(list, player_angle) == true)
-            {
-                PrintMini(50, 0, "TOUCHE", MINI_OVER);
-            }
-            list = removeWall(list, 0);
+        if(list != NULL){ //if the linked list is not empty
+            update(list); //update the linked list
 
+        if(isColliding(list, player_angle) == true) //if the player and a wall collide
+     	{
+            PrintMini(50, 0, "TOUCHE", MINI_OVER); //death handling
         }
-        if(rand() % 40 == 1)
+            list = removeWall(list, 0); //remove every wall whose distance to the center equals zero
+
+        }
+	//level generation
+	//TODO: something else than pure randomness
+        if(rand() % 40 == 1)//
         {
             list = addWall(list, 128, 8, 1, rand()%6);
         }else if(rand() % 70 == 1)
@@ -64,19 +79,28 @@ int AddIn_main(int isAppli, unsigned short OptionNum)
                 if(i != emptyRow)
                     list = addWall(list, 128, 15, 1, i);
         }
+	//draw the player and the lines
         drawPlayer();
         drawDiagonal(1);
         drawDiagonal(2);
         drawDiagonal(3);
+
+	//printing debug information
         intToStr(fps_text, fps);
         PrintMini(0, 0, fps_text, MINI_OVER);
         intToStr(fps_text, player_angle);
         PrintMini(116, 0, fps_text, MINI_OVER);
+
+	//showing the walls
         if(list != NULL)
             show(list, &cam);
-    
+    	
+	//updating the screen
         ML_display_vram();
         ML_clear_vram();
+
+	//player input
+	//TODO: no magic values
         if(KeyDown(K_LEFT))
         {
             player_angle-=15;
@@ -85,6 +109,9 @@ int AddIn_main(int isAppli, unsigned short OptionNum)
         {
             player_angle+=15;
         }
+
+	//manually change the rotation speed
+	//TODO: automatize this
         if(KeyDown(K_PLUS))
         {
             dAngle += 0.2;
@@ -93,6 +120,8 @@ int AddIn_main(int isAppli, unsigned short OptionNum)
         {
             dAngle -= 0.2;
         }
+
+	//the angle must not be greater than 360
         if(player_angle < 0)
             player_angle = 360 + player_angle;
         player_angle = player_angle % 360;
@@ -103,15 +132,20 @@ int AddIn_main(int isAppli, unsigned short OptionNum)
             {}
         }
         //while
+	//pause
         Sleep(1/0.06);
     }
 
     return 1;
 }
 
+//draws the player
+//at first, was supposed to draw an hexagon in the center, plus a triangle to show the player,
+//but the hexagon was not visible, and it was a pixel mess, so we're showing a circle instead.
+//there is still for code to calculate the vertices of the hexagon, in case we want to change that again
 void drawPlayer()
 {
-    int x[6];
+/*    int x[6];
     int y[6];
     int i = 0;
 
@@ -121,17 +155,22 @@ void drawPlayer()
         x[i] = 16*cos(PI*angle/180) + cam.cX;
         y[i] = 16*sin(PI*angle/180) + cam.cY;
     }
+*/
+	//draw the aforementionned circle, depending on the camera's center
     ML_filled_circle(cam.cX, cam.cY, 6, BLACK);
+	//draw the player. At such a low scale, it was impossible to draw a rotating triangle, so its a radius 1 circle instead.
     ML_filled_circle(9*cos( PI*(player_angle + cam.angle)/180) + cam.cX, 9*sin( PI*(player_angle+cam.angle)/180) + cam.cY, 1, BLACK);
     
 }
 
+//draws one of the three rotating lines
 void drawDiagonal(int nb)
 {
     int tmp_angle = 0;
     float coeff = 0;
     int x1 = 0, y1 = 0, x2 = 0, y2 = 0;
 
+	//defining the angle between the line and the horizontal axis
     if(nb == 1)
         tmp_angle = cam.angle + 60;
     else if(nb == 2)
@@ -140,9 +179,10 @@ void drawDiagonal(int nb)
         tmp_angle = 300 + cam.angle;
     if(tmp_angle >= 360)tmp_angle = tmp_angle - 359;
 
-
+	//defining the slope coefficient
     coeff = sin(PI*tmp_angle / 180)/cos(PI * tmp_angle / 180);
 
+	//ML needs four coordinates in order to draw a line
     x1 = -32/coeff;
     y1 = -32;
 
@@ -156,6 +196,7 @@ void drawDiagonal(int nb)
         x2 = 64;
         y2 = 64*coeff;
     }
+	//drawing the line
         ML_line(x1 + cam.cX, y1 + cam.cY, x2 + cam.cX, y2 + cam.cY, BLACK);
 }