Changeset 1244 for code/branches/ogre/src/orxonox/Orxonox.cc

Timestamp:

May 7, 2008, 9:20:42 AM (16 years ago)

Author:

rgrieder

Message:

• added some comments and COUTs

File:

• code/branches/ogre/src/orxonox/Orxonox.cc (modified) (18 diffs)

code/branches/ogre/src/orxonox/Orxonox.cc

@@ -37 +37 @@
 
 //****** STD *******
-//#include <iostream>
-//#include <exception>
 #include <deque>
 
 //****** OGRE ******
-//#include <OgreException.h>
 #include <OgreFrameListener.h>
 #include <OgreOverlay.h>
@@ -159 +156 @@
 
   /**
-   * create a new instance of Orxonox
+   * Create a new instance of Orxonox. Avoid doing any actual work here.
    */
   Orxonox::Orxonox()
@@ -177 +174 @@
 
   /**
-   * destruct Orxonox
+   * Destruct Orxonox.
    */
   Orxonox::~Orxonox()
@@ -208 +205 @@
 
   /**
-   * @return singleton object
+   * @return singleton reference
    */
   Orxonox* Orxonox::getSingleton()
@@ -248 +245 @@
       return false;
 
+    COUT(3) << "*** Orxonox: Mode is " << mode << "." << std::endl;
     if (mode == "client")
       mode_ = CLIENT;
@@ -260 +258 @@
 
     // for playable server, client and standalone, the startup
-    // procedure until the GUI is the identical
+    // procedure until the GUI is identical
 
     TclBind::getInstance().setDataPath(dataPath);
@@ -284 +282 @@
       return false;
 
-    // Calls the InputHandler which sets up the input devices.
+    // Calls the InputManager which sets up the input devices.
     // The render window width and height are used to set up the mouse movement.
     if (!InputManager::initialise(ogre_->getWindowHandle(),
@@ -290 +288 @@
       return false;
 
-    // TODO: Spread this so that this call onyl initialises things needed for the GUI
-    ogre_->initialiseResources();
+    // TODO: Spread this so that this call only initialises things needed for the GUI
+    if (!ogre_->initialiseResources())
+      return false;
 
     // TOOD: load the GUI here
@@ -298 +297 @@
     // TODO: run GUI here
 
-    // The following lines depend very much on the GUI, so they're probably misplaced here..
+    // The following lines depend very much on the GUI output, so they're probably misplaced here..
 
     InputManager::setInputState(InputManager::IS_NONE);
@@ -325 +324 @@
   }
 
+  /**
+   * Loads everything in the scene except for the actual objects.
+   * This includes HUD, Console..
+   */
   bool Orxonox::loadPlayground()
   {
@@ -338 +341 @@
 
     // Load the HUD
+    COUT(3) << "*** Orxonox: Loading HUD..." << std::endl;
     Ogre::Overlay* hudOverlay = Ogre::OverlayManager::getSingleton().getByName("Orxonox/HUD1.2");
     orxonoxHUD_ = new HUD();
@@ -344 +348 @@
     hudOverlay->show();
 
+    COUT(3) << "*** Orxonox: Loading Console..." << std::endl;
     InputBuffer* ib = dynamic_cast<InputBuffer*>(InputManager::getKeyHandler("buffer"));
     /*
@@ -365 +370 @@
   }
 
+  /**
+   * Level loading method for server mode.
+   */
   bool Orxonox::serverLoad()
   {
-    COUT(2) << "initialising server" << std::endl;
+    COUT(2) << "Loading level in server mode" << std::endl;
 
     server_g = new network::Server();
@@ -379 +387 @@
   }
 
+  /**
+   * Level loading method for client mode.
+   */
   bool Orxonox::clientLoad()
   {
-    COUT(2) << "initialising client" << std::endl;\
+    COUT(2) << "Loading level in client mode" << std::endl;\
 
     if (serverIp_.compare("") == 0)
@@ -394 +405 @@
   }
 
+  /**
+   * Level loading method for standalone mode.
+   */
   bool Orxonox::standaloneLoad()
   {
-    COUT(2) << "initialising standalone mode" << std::endl;
+    COUT(2) << "Loading level in standalone mode" << std::endl;
 
     if (!loadScene())
@@ -404 +418 @@
   }
 
+  /**
+   * Helper method to load a level.
+   */
   bool Orxonox::loadScene()
   {
@@ -447 +464 @@
     timer_->reset();
 
+    COUT(3) << "*** Orxonox: Starting the main loop." << std::endl;
           while (!bAbort_)
           {
@@ -534 +552 @@
   }
 
+  /**
+   * Static function that shows the console in game mode.
+   */
   void Orxonox::activateConsole()
   {
+    // currently, the console shows itself when feeded with input.
     InputManager::setInputState(InputManager::IS_CONSOLE);
   }