Changeset 159 for code/branches/main_reto_vs05/src/ogre_control.cc

Timestamp:

Nov 3, 2007, 11:06:43 PM (16 years ago)

Author:

rgrieder

Message:

 

File:

• code/branches/main_reto_vs05/src/ogre_control.cc (modified) (8 diffs)

code/branches/main_reto_vs05/src/ogre_control.cc

@@ -26 +26 @@
  */
 
+/**
+* Ogre control class.
+* This is merely a convenient way to handle Ogre. It only holds the Root
+* object and the render Window. These are the objects, that are independant
+* of the game state (playing, menu browsing, loading, etc.).
+* This class could easily be merged into the Orxnox class.
+*/
+
+
 #include "ogre_control.h"
 
 
+/**
+* Provide support for mac users.
+*/
 #if OGRE_PLATFORM == OGRE_PLATFORM_APPLE
 // This function will locate the path to our application on OS X,
@@ -56 +68 @@
 
 
-OgreControl::OgreControl()
-{
-        mRoot = 0;
+/**
+* Constructor that determines the resource path platform dependant.
+*/
+OgreControl::OgreControl() : root_(0)
+{
         // Provide a nice cross platform solution for locating the configuration
         // files. On windows files are searched for in the current working
@@ -64 +78 @@
   // function macBundlePath does this for us.
 #if OGRE_PLATFORM == OGRE_PLATFORM_APPLE
-        mResourcePath = macBundlePath() + "/Contents/Resources/";
+        resourcePath_ = macBundlePath() + "/Contents/Resources/";
 #else
-        mResourcePath = "";
-#endif
-}
-
-
-// standard destructor
+        resourcePath_ = "";
+#endif
+}
+
+
+/**
+* Standard Destructor.
+*/
 OgreControl::~OgreControl()
 {
-        if (mRoot)
-                delete mRoot;
-}
-
-
-/**------------- SETTING UP OGRE --------------**/
-
+        if (root_)
+                delete root_;
+}
+
+
+/* Sets up Ogre.
+* First, the Root object is being created, then the resources are defined
+* (not loaded!). And last but not least, the render settings (like resolution
+* or AA level) are prompted to the user.
+*/
 bool OgreControl::initialise(void)
 {
@@ -86 +105 @@
         // only use plugins.cfg if not static
 #ifndef OGRE_STATIC_LIB
-        pluginsPath = mResourcePath + "plugins.cfg";
-#endif
-
-        mRoot = new Root(pluginsPath, 
-                mResourcePath + "ogre.cfg", mResourcePath + "Ogre.log");
+        pluginsPath = resourcePath_ + "plugins.cfg";
+#endif
+
+        root_ = new Root(pluginsPath, 
+                resourcePath_ + "ogre.cfg", resourcePath_ + "Ogre.log");
 
         setupResources();
@@ -101 +120 @@
 
 
-// Method which will define the source of resources
-// (other than current folder)
+/**
+* Defines the source of the resources.
+*/
 void OgreControl::setupResources(void)
 {
         // Load resource paths from config file
         ConfigFile cf;
-        cf.load(mResourcePath + "resources.cfg");
+        cf.load(resourcePath_ + "resources.cfg");
 
         // Go through all sections & settings in the file
@@ -137 +157 @@
 
 
+/**
+* Prompts a setting window for the render engine if that has not already
+* been done.
+* The method also calls the root initialiser in order to get a render window.
+*/
 bool OgreControl::configure(void)
 {
@@ -142 +167 @@
         // You can skip this and use root.restoreConfig() to load configuration
         // settings if you were sure there are valid ones saved in ogre.cfg
-        if(!mRoot->restoreConfig() && !mRoot->showConfigDialog())
+        if(!root_->restoreConfig() && !root_->showConfigDialog())
                 return false;
 
@@ -148 +173 @@
         // Here we choose to let the system create a default
   // rendering window by passing 'true'
-        mWindow = mRoot->initialise(true);
-        mRoot->saveConfig();
+        root_->saveConfig();
+        window_ = root_->initialise(true);
         return true;
 }
 
 
+/**
+* Returns the root object.
+* @return Root object.
+*/
 Root* OgreControl::getRoot(void)
 {
-        return mRoot;
-}
-
-
+        return root_;
+}
+
+
+/**
+* Returns the render window.
+* @return Render window.
+*/
 RenderWindow* OgreControl::getRenderWindow(void)
 {
-        return mWindow;
-}
-
-
+        return window_;
+}
+
+
+/**
+* Returns the resource path.
+* @return Resource path.
+*/
 Ogre::String OgreControl::getResourcePath(void)
 {
-        return mResourcePath;
-}
+        return resourcePath_;
+}