Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 5840 for code


Ignore:
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:
2 edited

Legend:

Unmodified
Added
Removed

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

    r5738 r5840  
    4444{
    4545    /**
    46         @brief
    47             Base class for all items/pickups.
     46    @brief
     47        Base class for all items/pickups.
    4848
    49             Provides common methods to be used in derived classes.
    50         @author
    51             Daniel 'Huty' Haggenmueller
     49        Provides common methods to be used in derived classes.
     50    @author
     51        Daniel 'Huty' Haggenmueller
    5252    */
    5353    class _OrxonoxExport BaseItem : public BaseObject
    … …  
    6161
    6262        /**
    63             @brief Checks how many instances of this item can be carried at a time.
    64             @return How many of this item can be carried.
     63        @brief Checks how many instances of this item can be carried at a time.
     64        @return How many of this item can be carried.
    6565        */
    6666        virtual int getMaxCarryAmount() const
    … …  
    7070        bool removeFrom(Pawn* pawn);        //!< Removes the item from a pawn.
    7171        /**
    72             @brief
    73                 Method invoked when the item gets picked up.
     72        @brief
     73            Method invoked when the item gets picked up.
    7474
    75                 Has to be overridden for an item to work,
    76                 should contain a call to addTo().
     75            Has to be overridden for an item to work,
     76            should contain a call to addTo().
    7777
    78             @param pawn Pawn who picks up the item.
    79             @return Returns whether the pawn was able to pick up the item.
     78        @param pawn Pawn who picks up the item.
     79        @return Returns whether the pawn was able to pick up the item.
    8080        */
    8181        virtual bool pickedUp(Pawn* pawn)

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

    r5835 r5840  
    100100            { this->rotateRoll(Vector2(value, 0)); }
    101101           
    102             void setPrimaryThrust( float thrust ){ this->primaryThrust_=thrust; }
    103             void setAuxilaryThrust( float thrust ){ this->auxilaryThrust_=thrust; }
    104             void setRotationThrust( float thrust ){ this->rotationThrust_=thrust; }
     102            /**
     103            @brief Sets the primary thrust to the input amount.
     104            @param thrust The amount of thrust.
     105            */
     106            inline void setPrimaryThrust( float thrust )
     107                { this->primaryThrust_=thrust; }           
     108            inline void setAuxilaryThrust( float thrust )
     109                { this->auxilaryThrust_=thrust; }
     110            inline void setRotationThrust( float thrust )
     111                { this->rotationThrust_=thrust; }
    105112           
    106             float getPrimaryThrust(){ return this->primaryThrust_; }
    107             float getAuxilaryThrust(){ return this->auxilaryThrust_; }
    108             float getRotationThrust(){ return this->rotationThrust_; }
     113            /**
     114            @brief Gets the primary thrust to the input amount.
     115            @preturn The amount of thrust.
     116            */
     117            inline float getPrimaryThrust()
     118                { return this->primaryThrust_; }
     119            inline float getAuxilaryThrust()
     120                { return this->auxilaryThrust_; }
     121            inline float getRotationThrust()
     122                { return this->rotationThrust_; }
    109123           
    110124        private:
Note: See TracChangeset for help on using the changeset viewer.