Changeset 5840 for code/branches/tutorial/src

Timestamp:

Sep 30, 2009, 12:56:59 PM (15 years ago)

Author:

dafrick

Message:

And the last bunch of comments.

Location:

code/branches/tutorial/src/orxonox

Files:

• pickup/BaseItem.h (modified) (3 diffs)
• worldentities/Drone.h (modified) (1 diff)

code/branches/tutorial/src/orxonox/pickup/BaseItem.h

@@ -44 +44 @@
 {
     /**
-        @brief
-            Base class for all items/pickups.
+    @brief
+        Base class for all items/pickups.
 
-            Provides common methods to be used in derived classes.
-        @author
-            Daniel 'Huty' Haggenmueller
+        Provides common methods to be used in derived classes.
+    @author
+        Daniel 'Huty' Haggenmueller
     */
     class _OrxonoxExport BaseItem : public BaseObject
@@ -61 +61 @@
 
         /**
-            @brief Checks how many instances of this item can be carried at a time.
-            @return How many of this item can be carried.
+        @brief Checks how many instances of this item can be carried at a time.
+        @return How many of this item can be carried.
         */
         virtual int getMaxCarryAmount() const
@@ -70 +70 @@
         bool removeFrom(Pawn* pawn);        //!< Removes the item from a pawn.
         /**
-            @brief
-                Method invoked when the item gets picked up.
+        @brief
+            Method invoked when the item gets picked up.
 
-                Has to be overridden for an item to work,
-                should contain a call to addTo().
+            Has to be overridden for an item to work,
+            should contain a call to addTo().
 
-            @param pawn Pawn who picks up the item.
-            @return Returns whether the pawn was able to pick up the item.
+        @param pawn Pawn who picks up the item.
+        @return Returns whether the pawn was able to pick up the item.
         */
         virtual bool pickedUp(Pawn* pawn)

code/branches/tutorial/src/orxonox/worldentities/Drone.h

@@ -100 +100 @@
             { this->rotateRoll(Vector2(value, 0)); }
             
-            void setPrimaryThrust( float thrust ){ this->primaryThrust_=thrust; }
-            void setAuxilaryThrust( float thrust ){ this->auxilaryThrust_=thrust; }
-            void setRotationThrust( float thrust ){ this->rotationThrust_=thrust; }
+            /**
+            @brief Sets the primary thrust to the input amount.
+            @param thrust The amount of thrust.
+            */
+            inline void setPrimaryThrust( float thrust )
+                { this->primaryThrust_=thrust; }            
+            inline void setAuxilaryThrust( float thrust )
+                { this->auxilaryThrust_=thrust; }
+            inline void setRotationThrust( float thrust )
+                { this->rotationThrust_=thrust; }
             
-            float getPrimaryThrust(){ return this->primaryThrust_; }
-            float getAuxilaryThrust(){ return this->auxilaryThrust_; }
-            float getRotationThrust(){ return this->rotationThrust_; }
+            /**
+            @brief Gets the primary thrust to the input amount.
+            @preturn The amount of thrust.
+            */
+            inline float getPrimaryThrust()
+                { return this->primaryThrust_; }
+            inline float getAuxilaryThrust()
+                { return this->auxilaryThrust_; }
+            inline float getRotationThrust()
+                { return this->rotationThrust_; }
             
         private: