Changeset 8855 for code/trunk/src/modules/weapons/projectiles/BillboardProjectile.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/BillboardProjectile.cc (modified) (5 diffs)

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

@@ -27 +27 @@
  */
 
+/**
+    @file BillboardProjectile.h
+    @brief Implementation of the BillboardProjectile class.
+*/
+
 #include "BillboardProjectile.h"
 
@@ -44 +49 @@
         {
             assert(this->getScene()->getSceneManager()); // getScene() was already checked by WorldEntity
+
+            // Create the billboard.
             this->billboard_.setBillboardSet(this->getScene()->getSceneManager(), "Examples/Flare", ColourValue(0.5f, 0.5f, 0.7f, 0.8f), 1);
             this->attachOgreObject(this->billboard_.getBillboardSet());
@@ -57 +64 @@
     }
 
+    /**
+    @brief
+        Set the colour of the BillboardProjectile.
+    @param colour
+        The colour to be set.
+    */
     void BillboardProjectile::setColour(const ColourValue& colour)
     {
@@ -62 +75 @@
     }
 
+    /**
+    @brief
+        Set the material of the BillboardProjectile.
+    @param material
+        The material name.
+    */
     void BillboardProjectile::setMaterial(const std::string& material)
     {
@@ -67 +86 @@
     }
 
+    /**
+    @brief
+        Is called when the visibility of the BillboardProjectile has changed.
+    */
     void BillboardProjectile::changedVisibility()
     {
         SUPER(BillboardProjectile, changedVisibility);
 
+        // Also change the visibility of the billboard.
         this->billboard_.setVisible(this->isVisible());
     }