Changeset 9420 for code

Timestamp:

Oct 29, 2012, 4:16:17 PM (12 years ago)

Author:

davidsa

Message:

Added some documentation to orxonox::Scene

Location:

code/branches/shaders/src/orxonox

Files:

• RenderQueueListener.cc (modified) (1 diff)
• Scene.cc (modified) (2 diffs)
• Scene.h (modified) (3 diffs)

code/branches/shaders/src/orxonox/RenderQueueListener.cc

@@ -30 +30 @@
 /**
   @file RenderQueueListener.cc
-  @brief Definition of the RenderQueueListener class.
+  @brief Implementation of the RenderQueueListener class.
 */
 

code/branches/shaders/src/orxonox/Scene.cc

@@ -27 +27 @@
  *
  */
+
+/**
+@file Scene.cc
+@brief Implementation of Scene Class
+*/
+
 
 #include "Scene.h"
@@ -53 +59 @@
 {
     CreateFactory(Scene);
-
+    
+    /**
+    @brief 
+        Constructor, it sets common standard paramters for a scene depending on whether it will be rendered or not.
+        It also makes sure we user our own render queue listener for rendering instead of the standard listener provided by Ogre
+    */
     Scene::Scene(BaseObject* creator) : BaseObject(creator), Synchronisable(creator)
     {

code/branches/shaders/src/orxonox/Scene.h

@@ -28 +28 @@
  */
 
+/**
+@file Scene.h
+@brief Definition of Scene Class
+*/
+
 #ifndef _Scene_H__
 #define _Scene_H__
@@ -48 +53 @@
     {
         public:
+            /**
+            @brief 
+                This class holds a Scene which is a collection of all kinds of objects to be rendered in the same space,
+                with the same physics and the same light properties. Objects can be anything from a light source, over non physical objects
+                like Billboards to just plain Models with an attached Mesh
+            */
             Scene(BaseObject* creator);
             virtual ~Scene();
@@ -94 +105 @@
                 { this->setShadow(this->bShadows_); }
 
-            Ogre::SceneManager*      sceneManager_;
-            Ogre::SceneNode*         rootSceneNode_;
+            Ogre::SceneManager*      sceneManager_; //!< This is a pointer to the Ogre SceneManager we're using to render the Scene
+            Ogre::SceneNode*         rootSceneNode_; //!< This is a pointer to the root node of the Scene tree
 
-            std::string              skybox_;
-            ColourValue              ambientLight_;
-            std::list<BaseObject*>   objects_;
-            bool                     bShadows_;
-            float                    soundReferenceDistance_;
-            Radar*                   radar_;
+            std::string              skybox_; //!< This string holds information about the skybox we're using
+            ColourValue              ambientLight_; //!< This variable holds the color value for the ambient light in our scene, usually black in space
+            std::list<BaseObject*>   objects_; //!< This list holds all the objects created in our scene
+            bool                     bShadows_; //!< Do we want shadows in our scene?
+            float                    soundReferenceDistance_; //!< This holds a reference distance, which represents the distance between our scene and the listener
+            Radar*                   radar_; //!< This is a pointer to a Radar object assigned with this scene