Changeset 11667 for code/branches/AsteroidMining_HS17/src/modules/asteroidmining/AsteroidMinable.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/AsteroidMinable.h (modified) (5 diffs)

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

@@ -29 +29 @@
 
 /**
-    @file AsteroidMinable.h
 
+    @file
+    @author remartin
+    @brief An asteroid which can be destroyed. Some smaller asteroids are created and a pickup spawns. 
+
+HANDBUCH:
+o Die Collision Shape kann nur im Konstruktor hinzugefügt werden. Die XML-Argumente werden aber erst nach dem Konstruktor gesetzt. 
+  Darum wird hier beim ersten Aufruf der tick()-Methode via putStuff() ein komplett neuer Asteroid generiert und der alte zerstört. 
+o im Level-File includes/pickups.oxi importieren. 
+
+OFFEN/Weiterentwicklung: 
+o @TODO Add resource pickups. 
+--> data_extern/images/effects: PNG's für die Pickups
+--> https://www.orxonox.net/jenkins/view/Management/job/orxonox_doxygen_trunk/javadoc/group___pickup.html
+
+o Density doesn't add up to 1...
+o Does collision damage work properly
+o Add sound effect (crunching etc. ) (No sound in space...)
+o Explosion parts
+
+ANDERORTS VERÄNDERTE SACHEN: 
+Pickup-Zeug: 
+o Pickup.h: createSpawner() neu public statt private
+o PickupSpawner.h: Zugriffsrechte setPickupTemplateName() und setMaxSpawnedItems()
+o PickupSpawner.h: In Tick() zwei Testbedingungen eingefügt.
+o Pawn.h: Attribut acceptsPickups_ inklusive get/set. 
+
+ERLEGTE FEHLER:
+o Grössenabhängige Collision Shape -> putStuff-Methode, Werte noch nicht durchgesickert. 
+o setHealth: maxHealth() des pawns setzen! 
+o Asteroiden fressen Pickups: Argument in Pawn, Test darauf in Tick() von PickupSpawner. 
+o i++ einfach ganz verhindern, ++i stattdessen. 
+o Velocity didn-t get passed properly through the 2nd constructor. Used get/set instead. 
+o Rand() geht bis zu riesigen Nummern! rnd() ist zwischen 0 und 1
+
+NOTIZEN:
+o SUPER
+o Warnungsverhinderung anderswo: (void)pickedUp; // To avoid compiler warning.
+o friend class Pickupable;
 
 */
@@ -48 +85 @@
 #include "../../orxonox/worldentities/pawns/Pawn.h"
 
-namespace orxonox
-{
+namespace orxonox{
 
 
@@ -55 +91 @@
 
         public:
-            AsteroidMinable(Context* context);// @brief This constructor is for XML access only!
-            AsteroidMinable(Context* c, float size, Vector3 position, Vector3 velocity, bool dS);// @brief Call this Constructor from other C-files.
+            // @brief This constructor is for XML access only!
+            AsteroidMinable(Context* context);
+            // @brief Call this Constructor from other C-files.
+            AsteroidMinable(Context* c, float size, Vector3 position, bool dS);
 
             virtual ~AsteroidMinable();
@@ -63 +101 @@
             virtual void tick(float dt) override;
 
-            // @brief Overwrite to prevet 'self-collision' of generated stuff
+            // @brief overloading that to prevent asteroids from taking damage from each other (domino effect etc. ) 
             virtual void hit(Pawn* originator, const Vector3& force, const btCollisionShape* cs, float damage, float healthdamage = 0.0f, float shielddamage = 0.0f);
             virtual void hit(Pawn* originator, btManifoldPoint& contactpoint, const btCollisionShape* cs, float damage, float healthdamage = 0.0f, float shielddamage = 0.0f);
@@ -80 +118 @@
             Context* context;
 
-            int size;
-            bool generateSmaller;
-            bool dropStuff;
+            int size; //!< Implies health and type of dropped pickups
+            bool generateSmaller; //!< Whether this asteroid leaves fragments
+            bool dropStuff; //!< Whether this asteroid yields valuable stuff
 
-            bool initialised;
-
+            // @brief Überschreibt die Methode in Pawn
             virtual void death(); 
 
+        private:
 
+            bool initialised; //!< Used in relation to the constructor detour described above 
 
-        private:
             void registerVariables();
+
+            // @brief Helper method. 
+            virtual void putStuff();
+
+            // @brief If the option generateSmaller is enabled, individual fragments are added with this method. 
             virtual void spawnChildren();
-            virtual void putStuff();
 
             // @brief Just for testing. Don-t work anyways. 
             void printArrayString(float thingy[]);
             // @brief Just for testing. Don-t work anyways. 
-            void printArrayString(int thingy[]);// Just for testing
-
-
-
-
+            void printArrayString(int thingy[]);
 
     }; // tolua_export