Changeset 11667 for code/branches/AsteroidMining_HS17/src/modules/asteroidmining/AsteroidMinable.cc

Timestamp:

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

Author:

remartin

Message:

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

File:

• code/branches/AsteroidMining_HS17/src/modules/asteroidmining/AsteroidMinable.cc (modified) (14 diffs)

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

@@ -29 +29 @@
 /*
 
-    @file AsteroidMinable.cc
-
-*
-*
-* An asteroid which can be destroyed. Some smaller asteroids are created and a pickup 
-* spawns. 
-*
-*
-*
-
-*/
-
-/*
-Veraenderungstagebuch
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-
-KNACKPUNKTE: 
-o Super-XML-Argumente werden nicht richtig geparst (Velocity, Pitch, Yaw etc. ) 
-
-
-OFFEN: 
-
-o Add custom pickup 'resources'. Weird template stuff -> Problems setting 'size' and other properties? setNumber of Resources. 
---> PickupTemplateName_ in PickupSpawner ist ein string. Wird via getBaseClassIdentifier ausgelesen, daraus wird ein Pickupable fabriziert. 
---> MunitionPickup erbt von Pickup erbt von collectiblePickup erbt von Pickupable
-----> im MineralsPickup die isPickedUp()-Methode überschreiben? 
---> data_extern/images/effects: PNG's für die Pickups und GUI-Dinger. 
+    @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 Anfangsgeschwindigkeit fuers Asteroidenfeld
 o Density doesn't add up to 1...
-o set collisionDamage? Just for static entities?
-
-o Dokumentieren mit @brief?
-o unregister -empty- asteroids from radar. (or turn them green or whatever)
+o Does collision damage work properly
 o Add sound effect (crunching etc. ) (No sound in space...)
 o Explosion parts
 
-HANDBUCH:
-o im Level-File includes/pickups.oxi importieren. 
-o Bei der XML-Variante wird beim ersten Aufruf der Tick-Methode ein neuer Asteroid generiert, 
-  damit die Groesse der Collision Shape korrekt initialisiert wird. 
-
-FREMDANPASSUNGEN: 
+ANDERORTS VERÄNDERTE SACHEN: 
 Pickup-Zeug: 
-o Pickup.h: Zugriffsänderung createSpawner
+o Pickup.h: createSpawner() neu public statt private
 o PickupSpawner.h: Zugriffsrechte setPickupTemplateName() und setMaxSpawnedItems()
-o PickupSpawner.h: In Tick() zwei Testbedingungen eingefuegt. 
+o PickupSpawner.h: In Tick() zwei Testbedingungen eingefügt.
 o Pawn.h: Attribut acceptsPickups_ inklusive get/set. 
 
 ERLEGTE FEHLER:
-o Rand() geht bis zu riesigen Nummern! 
-o Pickupgenerierung: vgl. Fremdanpassungen. 
-o Minimalbegrenzung fuer Masse vergessen. 
-o Dynamische Definition -> putStuff-Methode, Werte noch nicht durchgesickert. 
-o Error-Nachricht: Einfach Argumente leer lassen. 
-o Pickups: setMaxSpawned funktioniert nicht -> Bastelloesung: Auf 2 statt eins setzen, erstes wird wohl direkt zerstoert. 
-o setHealth: Wird mit Max verwurstelt, war 0. 
-o Position nicht gesetzt -> alles im Ursprung, Kollision -> fliegt davon. 
-o nimmt zuviel Schaden. -> wird mit maxHealth verwurstelt -> einfach auch setzen. 
-
-o Groessenabhaengige Collison shape: Umweg ueber zweiten Konstruktor. 
-o Absturz beim Asteroidengenerieren: Health war auf 0 gesetzt! Wurde nur bei der xml-Variante definiert. 
+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 Man kann keine Arrays der Groesse 0 initialisieren, aber auch nicht per IF 2x definieren. 
 o i++ einfach ganz verhindern, ++i stattdessen. 
-o Discusting mixup with array length, accessing element a[len]...
-o unitialised mass value -> obese asteroid, physics bug. 
-
+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 entspricht ueberladen, andere Argumente der Methode. 
+o SUPER
 o Warnungsverhinderung anderswo: (void)pickedUp; // To avoid compiler warning.
-
-Was ist das?         friend class Pickupable;
+o friend class Pickupable;
 
 
@@ -150 +112 @@
         this->acceptsPickups_ = false; 
 
-        //Noetig, damit nicht sofort zerstoert?
         this->setCollisionType(WorldEntity::CollisionType::Dynamic);
         this->enableCollisionCallback();
 
-
         // Old from Pawn
         this->registerVariables();
 
         this->initialised = false;
-
     }
 
     // @brief Use this constructor with care. Mainly used internally, arguments are passed directly. 
-    AsteroidMinable::AsteroidMinable(Context* c, float size, Vector3 position, Vector3 v, bool dropStuff) : Pawn(c){
+    AsteroidMinable::AsteroidMinable(Context* c, float size, Vector3 position, bool dropStuff) : Pawn(c){
 
         RegisterObject(AsteroidMinable);
@@ -172 +131 @@
             this->setRadarObjectShape(RadarViewable::Shape::Dot);
         }else{
-            // Somehow remove from radar?
+            // Somehow remove from radar? (all pawns get registered automatically... )
+            this->setRadarObjectColour(ColourValue(0.663f, 0.663f, 0.663f, 1.0f));
+            this->setRadarObjectShape(RadarViewable::Shape::Dot);
         }
 
@@ -184 +145 @@
 
         this->setPosition(position);
-        this->setVelocity(v); 
         //this->roll = rand()*5; //etwas Drehung. Richtige Variable?
 
         this->setCollisionType(WorldEntity::CollisionType::Dynamic);
         this->enableCollisionCallback();
-
 
         // Add Model, random one of the 6 shapes
@@ -214 +173 @@
     }
 
-    // @brief Helper method. Create a new asteroid to have an appropriate size for the collision shape etc. 
+    // @brief Helper method. 
     void AsteroidMinable::putStuff(){
 
-        // Just create a new asteroid to avoid Collision shape scale problems etc. 
-        AsteroidMinable* reborn = new AsteroidMinable(this->context, this->size, this->getPosition(), this->getVelocity(), this->dropStuff);
+        AsteroidMinable* reborn = new AsteroidMinable(this->context, this->size, this->getPosition(), this->dropStuff);
+        reborn->setVelocity(this->getVelocity());
+        // reborn->setAngularVelocity(this->getAngularVelocity()); // Add all other stuff, too?
         (void)reborn; // avoid compiler warning
+
         this->bAlive_ = false;
         this->destroyLater();
@@ -258 +219 @@
     }
 
-    void AsteroidMinable::death(){ // ueberschreibt das Zeug in Pawn
+    void AsteroidMinable::death(){ // @brief Überschreibt die Methode in Pawn
 
         // just copied that from somewhere else. 
@@ -268 +229 @@
 
 
-        // Pickups which can be harvested. 
+        // Pickups which can be harvested. It's munition at the moment, could be changed/extended. 
         if(dropStuff){
             PickupSpawner* thingy = new PickupSpawner(this->context);
-            // OFFEN: more precise size relation in custom resource pickup. 
+
             char tname[] = ""; // can-t overwrite strings easily in C (strcat etc.)
             if(this->size <= 5){
@@ -291 +252 @@
     }
 
-
-void AsteroidMinable::spawnChildren(){// Spawn smaller Children 
+// @brief If the option generateSmaller is enabled, individual fragments are added with this method. 
+    void AsteroidMinable::spawnChildren(){
 
     if (this->size <=1){return;} // Absicherung trivialer Fall
@@ -298 +259 @@
     int massRem = this->size-1; //some mass is lost
     int num = round(rnd()*(massRem-1)) + 1; // random number of children, at least one
-    if(num > 10){num = 10;} // no max function in C!
-    int masses[num]; // Masses of the asteroids, at least one. 
-
+    if(num > 10){num = 10;} // no max function in C? 
+    int masses[num]; // Masses of the asteroids
     // orxout() << "SpawnChildren(): Passed basic stuff. num = " << num << "; massRem(total) = "<< massRem << endl;
-
-    massRem = massRem-num; // mass is at least one, add again below. 
+    massRem = massRem-num; // mass must be at least one, add later.  
 
     // Randomnised spawning points for the new asteroids
@@ -348 +307 @@
     //orxout() << "SpawnChildren(): Passed angle stuff. " << endl;
 
-    // 'Triangular', discrete probability "density" with max at the expected value massRem/num at a. a+b = c
-    if(massRem>0){ // Required to avoid array of size 0 or access problems
+    // Triangular, discrete probability "density" with max at the average value massRem/num. 50% chance to be below that. 
+    if(massRem>0){
         int c = massRem;
         float probDensity[c];
@@ -372 +331 @@
 
         // Distributing the mass to individual asteroids
-        int result;
-        float rVal;// between 0 and 1
-        float probSum;
+        int result; 
+        float rVal; // between 0 and 1
+        float probSum; // summing up until rval is reached. 
         for(int trav = 0; trav<num; ++trav){
-            result = 0;// reset
-            rVal = rnd();// between 0 and 1
+            result = 0;
+            rVal = rnd(); 
             probSum = probDensity[0]; 
 
-            while(rVal>probSum && result<massRem){// Not yet found && there-s smth left to distribute (Incrementing once inside!)
+            while(rVal>probSum && result<massRem){// Not yet found && there-s smth left to distribute (Incrementing inside!)
                 if(result<(massRem-2)){probSum = probSum + probDensity[result+1];} // avoid logical/acess error
                 ++result;
             }
 
+            masses[trav] = 1 +result; // Fragments have mass of at least one. 
             massRem = massRem-result;
-            masses[trav] = 1 +result; // Fragments have mass of at least one. 
+
         }
     }else{
@@ -404 +364 @@
         }
         
-        AsteroidMinable* child = new AsteroidMinable(this->context, masses[fisch], this->getPosition() + *pos, this->getVelocity(), this->dropStuff);
+        AsteroidMinable* child = new AsteroidMinable(this->context, masses[fisch], this->getPosition() + *pos, this->dropStuff);
+        child->setVelocity(this->getVelocity());
 
         if(child == nullptr){
@@ -414 +375 @@
 }
 
-
+// @brief overloading that to prevent asteroids from taking damage from each other (domino effect etc. ) 
     void AsteroidMinable::hit(Pawn* originator, const Vector3& force, const btCollisionShape* cs, float damage, float healthdamage, float shielddamage){
 
-        orxout() << "AsteroidMining::Hit(Variante 1) Dings aufgerufen. " << endl;
-
-        // Kollision mit anderem Asteroid oder Pickup verhindern. In diesem Fall einfach nichts tun. 
-        // Wird staending aufgerufen -> Rechenleistung?
+        // orxout() << "AsteroidMining::Hit(Variante 1) Dings aufgerufen. " << endl; 
         if(orxonox_cast<AsteroidMinable*>(originator) || orxonox_cast<Pickup*>(originator)){return;}
         this->damage(damage, healthdamage, shielddamage, originator, cs);
         this->setVelocity(this->getVelocity() + force);
-
-
 
         // if (this->getGametype() && this->getGametype()->allowPawnHit(this, originator))// && (!this->getController() || !this->getController()->getGodMode()) )
@@ -434 +390 @@
     }
 
+// @brief overloading that to prevent asteroids from taking damage from each other (domino effect etc. ) 
     void AsteroidMinable::hit(Pawn* originator, btManifoldPoint& contactpoint, const btCollisionShape* cs, float damage, float healthdamage, float shielddamage){
 
         //orxout() << "AsteroidMining::Hit(Variante 2) Dings aufgerufen. " << endl;
-        // Kollision mit anderem Asteroid oder Pickup (OFFEN: evtl. Spawner oder irgendwas?) verhindern. In diesem Fall einfach nichts tun. 
-        // Wird staending aufgerufen -> Rechenleistung?
         if(orxonox_cast<AsteroidMinable*>(originator) || orxonox_cast<Pickup*>(originator)){return;}
-
-        //orxout() << "Schaden. HP: " << this->health_ << " Dmg: " << damage << " hDmg: " << healthdamage << " sDmg: " << shielddamage << endl;
-
         this->damage(damage, healthdamage, shielddamage, originator, cs);
-
-
-
 
         // if (this->getGametype() && this->getGametype()->allowPawnHit(this, originator))// && (!this->getController() || !this->getController()->getGodMode()) )