Changeset 10930 for code/branches/hoverHS15/src/modules/hover/Hover.cc

Timestamp:

Dec 7, 2015, 2:32:47 PM (8 years ago)

Author:

meierman

Message:

Finished with comments

File:

• code/branches/hoverHS15/src/modules/hover/Hover.cc (modified) (16 diffs)

code/branches/hoverHS15/src/modules/hover/Hover.cc

@@ -21 +21 @@
  *
  *   Author:
- *      Florian Zinggeler
+ *      Manuel Meier
  *   Co-authors:
- *      ...
+ *      Cyrill Muskelprotz
  *
  */
@@ -29 +29 @@
 /**
     @file Hover.cc
-    @brief Implementation of the Hover class.
+    @brief Implementation of the Hover class. Sets up the whole Minigame
 */
 
@@ -51 +51 @@
 {
     bool firstTick = true;
+
+    //Levelcode represents the pitch: It's a 10x10 field. 
+    // 1 represents a Wall on the right side of this square
+    // 2 represents a Wall on the top of this square
+    // 3 represents 2 and 1 at the same time
+    // Note: the levelcode is generated from the Maze-Generator functions at the beginning of the game
     int levelcode[10][10] =
         {
@@ -122 +128 @@
             g_PtY=0;
             GenerateMaze();
-            MazeOut();
             RenderMaze();
-            LevelOut();
             firstTick = false;
 
@@ -135 +139 @@
             }
 
+            //Generate inner Walls according to levelcode
             for(int y=0; y<10; y++){
                 for(int x=0; x<10; x++){
@@ -150 +155 @@
             }
 
-
+            //Generate 5 flags randomly
             for ( int i = 0; i < 5; i++ )
                 flagVector.push_back(new HoverFlag(origin_->getContext(), rand()%10, rand()%10));
 
             Flags_ = flagVector.size();
-            
-            //new HoverFlag(origin_->getContext()); //Rechts in Y Richtung
-            //new HoverWall(origin_->getContext(), 5, 6, 0); //Ueber in x richtung
-            //new HoverWall(origin_->getContext(), 5, 5, 0); //Ueber in x richtung
-        }
+
+        }//firsttick end
+
+        // Check if ship collided with one of the flags
         for ( int i = 0; i < flagVector.size(); i++ ){
             if(flagVector[i]->getCollided()){
@@ -200 +204 @@
 
 
-    ////////////////////////////////////////////////////////////////////////////
-
+    // Some definitions for the Maze-Generator
 
     //                   0  1  2  3  4  5  6  7  8
@@ -220 +223 @@
 
 
-    ////////////////////////////////////////////////////////////////////////////
-
+    /**
+    @brief
+        Checks if Direction is valid (for Maze-Generator)
+    */
     bool Hover::IsDirValid( eDirection Dir )
     {
@@ -232 +237 @@
     }
 
+    /**
+    @brief
+        Generates new Direction (for Maze-Generator)
+    */
     eDirection Hover::GetDirection()
     {
@@ -259 +268 @@
     }
 
+    /**
+    @brief
+        Generates a Maze (for Maze-Generator)
+    */
     void Hover::GenerateMaze()
     {
@@ -265 +278 @@
         for ( eDirection Dir = GetDirection(); Dir != eDirection_Invalid; Dir = GetDirection() )
         {
-            // a progress indicator, kind of
-           // if ( ++Cells % 1000 == 0 ) std::cout << ".";
-
             g_Maze[ CellIdx() ] |= Dir;
 
@@ -275 +285 @@
             g_Maze[ CellIdx() ] = Mask[ Dir ];
         }
-
-        std::cout << std::endl;
     }  
     
-
+    /**
+    @brief
+        Print Maze (for Debugging only)
+    */
     void Hover::MazeOut(){
         for ( int y = 0; y < NumCells; y++ )
@@ -302 +313 @@
     }
 
+    /**
+    @brief
+        Print Levelcode (for Debugging only)
+    */
     void Hover::LevelOut(){
         for ( int y = 0; y < NumCells; y++ )
@@ -307 +322 @@
             for ( int x = 0; x < NumCells; x++ )
             {
-                /*orxout()<<"[";
+                orxout()<<"[";
                 if ( levelcode[x][y] < 2) orxout()<<"U";
                 else orxout()<<" ";
@@ -315 +330 @@
                 orxout()<<" ";
                 orxout()<<" ";
-                orxout()<<"]";*/
-
-                orxout()<<levelcode[x][y];
+                orxout()<<"]";
             }
             orxout()<<endl;
         }
-
-
-
-    }
-
+    }
+
+    /**
+    @brief
+        Generate Levelcode from Maze
+    */
     void Hover::RenderMaze()
     {
@@ -336 +350 @@
                 if ( !( v & eDirection_Up    ) && y >0) levelcode[y][x] |= 2;
                 if ( !( v & eDirection_Right ) && x <9) levelcode[y][x] |= 1;
-                //if ( !( v & eDirection_Down  ) && y>0) levelcode[x][y-1] += 2;
-                //if ( !( v & eDirection_Left  ) && x>0) levelcode[x-1][y] += 1;
             }
         }