Changeset 8855 for code/trunk/src/modules/weapons/projectiles/SimpleRocket.cc

Timestamp:

Aug 22, 2011, 3:05:26 PM (13 years ago)

Author:

dafrick

Message:

Cleaning up game immersion. Roughly documenting weapons module.

File:

• code/trunk/src/modules/weapons/projectiles/SimpleRocket.cc (modified) (10 diffs)

code/trunk/src/modules/weapons/projectiles/SimpleRocket.cc

@@ -21 +21 @@
  *
  *   Author:
- *      Oliver Scheuss
+ *      Gabriel Nadler
  *   Co-authors:
  *      simonmie
@@ -27 +27 @@
  */
 
+/**
+    @file SimpleRocket.h
+    @brief Implementation of the SimpleRocket class.
+*/
+
+
 #include "SimpleRocket.h"
 
@@ -33 +39 @@
 #include "core/CoreIncludes.h"
 #include "core/XMLPort.h"
+#include "util/Debug.h"
+
+#include "controllers/Controller.h"
+#include "graphics/Model.h"
+#include "graphics/ParticleSpawner.h"
+#include "infos/PlayerInfo.h"
+#include "objects/collisionshapes/ConeCollisionShape.h"
 #include "worldentities/pawns/Pawn.h"
-#include "graphics/ParticleSpawner.h"
-#include "graphics/Model.h"
-#include "objects/collisionshapes/ConeCollisionShape.h"
-#include "infos/PlayerInfo.h"
-#include "controllers/Controller.h"
+#include "sound/WorldSound.h"
+
 #include "weapons/RocketController.h"
-#include "sound/WorldSound.h"
-#include "util/Debug.h"
 
 namespace orxonox
@@ -53 +61 @@
         , RadarViewable(creator, static_cast<WorldEntity*>(this))
     {
-        RegisterObject(SimpleRocket);// - register the SimpleRocket class to the core
+        RegisterObject(SimpleRocket);// Register the SimpleRocket class to the core
 
         this->localAngularVelocity_ = 0;
-        this->lifetime_ = 10;
-
-        this->setMass(15);
-//        COUT(4) << "simplerocket constructed\n";
+        this->lifetime_ = 10.f;
+
+        this->setMass(15.0);
 
         if (GameMode::isMaster())
         {
             this->setCollisionType(WorldEntity::Kinematic);
-            this->fuel_=true;
-
+            this->fuel_ = true;
+
+            // Create rocket model.
             Model* model = new Model(this);
             model->setMeshSource("rocket.mesh");
@@ -71 +79 @@
             this->attach(model);
 
+            // Add effects.
             this->fire_ = new ParticleEmitter(this);
             this->attach(this->fire_);
@@ -80 +89 @@
             this->setCollisionType(Kinematic);
 
+            // Add collision shape.
             // TODO: fix the orientation and size of this collision shape to match the rocket
             ConeCollisionShape* collisionShape = new ConeCollisionShape(this);
@@ -86 +96 @@
             collisionShape->setHeight(5);
             this->attachCollisionShape(collisionShape);
-            this->destroyTimer_.setTimer(this->lifetime_, false, createExecutor(createFunctor(&SimpleRocket::destroyObject, this)));
+            
+            this->destroyTimer_.setTimer(this->lifetime_, false, createExecutor(createFunctor(&BasicProjectile::destroyObject, this)));
         }
 
@@ -97 +108 @@
 
     /**
-    * @brief updates state of rocket, disables fire if no fuel
-    * @param dt tick-length
+    @brief
+        Updates state of rocket, disables fire if no fuel
+    @param dt
+        tick-length
     */
     void SimpleRocket::tick(float dt)
     {
-
         SUPER(SimpleRocket, tick, dt);
-        if ( GameMode::isMaster() )
+        
+        if (GameMode::isMaster())
         {
-
-
             this->setAngularVelocity(this->getOrientation() * this->localAngularVelocity_);
             this->setVelocity( this->getOrientation()*WorldEntity::FRONT*this->getVelocity().length() );
             this->localAngularVelocity_ = 0;
 
-
             if (this->fuel_)
             {
-                if (this->destroyTimer_.getRemainingTime()<  (static_cast<float>(this->FUEL_PERCENTAGE)/100) *this->lifetime_ )
-                    this->fuel_=false;
+                if (this->destroyTimer_.getRemainingTime() < this->FUEL_PERCENTAGE*this->lifetime_ )
+                    this->fuel_ = false;
             } else
                 this->disableFire();
-
-            if( this->getBDestroy() )
-                this->destroy();
         }
 
-    }
-
-    /**
-    * @brief Sets the Acceleration to 0 and detaches the fire
-    * @return void
+        this->destroyCheck();
+    }
+
+    /**
+    @brief
+        Sets the Acceleration to 0 and detaches the fire.
     */
     void SimpleRocket::disableFire()
@@ -136 +144 @@
     }
 
-    /**s
+    /**
     @brief
         Destructor. Destroys controller, if present and kills sounds, if playing.
@@ -153 +161 @@
     /**
     @brief
-        Method for creating a SimpleRocket through XML.
-    */
-    void SimpleRocket::XMLPort(Element& xmlelement, XMLPort::Mode mode)
-    {
-        // this calls the XMLPort function of the parent class
-        SUPER(SimpleRocket, XMLPort, xmlelement, mode);
-    }
-
-    void SimpleRocket::setOwner(Pawn* owner)
-    {
-        this->owner_ = owner;
-        this->player_ = this->getOwner()->getPlayer();
-    }
-
-
-    /* Calls the collidesAgainst function of BasicProjectile
-     */
+        Set the entity that fired the SimpleRocket.
+    @param shooter
+        A pointer to the Pawn that fired the SimpleRocket.
+    */
+    void SimpleRocket::setShooter(Pawn* shooter)
+    {
+        BasicProjectile::setShooter(shooter);
+        
+        this->player_ = this->getShooter()->getPlayer();
+    }
+
     bool SimpleRocket::collidesAgainst(WorldEntity* otherObject, btManifoldPoint& contactPoint)
     {
-        return BasicProjectile::basicCollidesAgainst(otherObject,contactPoint,this->getOwner(),this);
-    }
-
-    void SimpleRocket::destroyObject()
-    {
-        if (GameMode::isMaster())
-        {
-            this->destroy();
-        }
+        return this->processCollision(otherObject, contactPoint);
     }