Changeset 11667 for code/branches/AsteroidMining_HS17/src/modules/asteroidmining/SpicedAsteroidField.h

Timestamp:

Dec 12, 2017, 8:29:52 PM (8 years ago)

Author:

remartin

Message:

Added tilting for the spicedAsteroidBelt. Finished commenting, polish up. Done.

File:

• code/branches/AsteroidMining_HS17/src/modules/asteroidmining/SpicedAsteroidField.h (modified) (4 diffs)

code/branches/AsteroidMining_HS17/src/modules/asteroidmining/SpicedAsteroidField.h

@@ -23 +23 @@
  *      Fabian 'x3n' Landau
  *   Co-authors:
- *      ...
  *
  */
@@ -29 +28 @@
 /**
 
-    @file SpicedAsteroidField.h
+    @file 
+    @author remartin
     @brief Asteroid field with lots of parameters. Derived from asteroidField.lua
 
-
+    Generates a bunch of asteroids that may contain some stuff. 
+    It is required to wait until all XML-arguments are set. That's why the actual 
+    generation happens when tick() gets called for the first time. 
+    
 */
 
@@ -91 +94 @@
             Context* context;
 
-            float count;
-            float mDensity; // Mineral density, between 0 and 1;
+            float count; //!< Number of asteroids generated
+            float mDensity; //!< Mineral density, between 0 and 1;
 
-            Vector3 position;
+            Vector3 position; //!< The center
             
-            int maxSize;
-            int minSize;
+            int maxSize; //!< Upper bound to asteroid size 
+            int minSize; //!< Lower bound to asteroid size
 
-            float radius; 
-            bool foggy;
+            float radius; //!< Asteroids can appear within a sphere. 
+            bool foggy; //!< Whether there's fog
             float fogDensity; 
-
-            virtual void create();
-
 
 
@@ -110 +110 @@
             void registerVariables();
 
+            virtual void create();
+
+
     }; // tolua_export
 } // tolua_export