Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Sep 29, 2009, 10:24:39 PM (15 years ago)
Author:
dafrick
Message:

Added some more comments to the tutorial.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r5787 r5833  
    3636namespace orxonox
    3737{
     38
     39    /**
     40    @brief
     41        Drone, that is made to move upon a specified pattern.
     42        This class was constructed for the PPS tutorial.
     43    @author
     44        Oli Scheuss
     45    */
    3846    class _OrxonoxExport Drone : public ControllableEntity
    3947    {
    … …  
    4250            virtual ~Drone();
    4351
    44             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    45             virtual void tick(float dt);
     52            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a Drone through XML.
     53            virtual void tick(float dt); //!< Defines which actions the Drone has to take in each tick.
    4654
    4755           
    … …  
    5462            virtual void rotateRoll(const Vector2& value);
    5563           
    56            
     64            /**
     65            @brief Moves the Drone in the Front/Back-direction by the specifed amount.
     66            @param value  The amount by which the drone is to be moved.
     67            */
    5768            inline void moveFrontBack(float value)
    5869            { this->moveFrontBack(Vector2(value, 0)); }
     70            /**
     71            @brief Moves the Drone in the Right/Left-direction by the specifed amount.
     72            @param value  The amount by which the drone is to be moved.
     73            */
    5974            inline void moveRightLeft(float value)
    6075            { this->moveRightLeft(Vector2(value, 0)); }
     76            /**
     77            @brief Moves the Drone in the Up/Down-direction by the specifed amount.
     78            @param value  The amount by which the drone is to be moved.
     79            */
    6180            inline void moveUpDown(float value)
    6281            { this->moveUpDown(Vector2(value, 0)); }
    6382           
     83            /**
     84            @brief Rotates the Drone around the y-axis by the specifed amount.
     85            @param value  The amount by which the drone is to be rotated.
     86            */
    6487            inline void rotateYaw(float value)
    6588            { this->rotateYaw(Vector2(value, 0)); }
     89            /**
     90            @brief Rotates the Drone around the x-axis by the specifed amount.
     91            @param value  The amount by which the drone is to be rotated.
     92            */
    6693            inline void rotatePitch(float value)
    6794            { this->rotatePitch(Vector2(value, 0)); }
     95            /**
     96            @brief Rotates the Drone around the z-axis by the specifed amount.
     97            @param value  The amount by which the drone is to be rotated.
     98            */
    6899            inline void rotateRoll(float value)
    69100            { this->rotateRoll(Vector2(value, 0)); }
    … …  
    78109           
    79110        private:
    80             DroneController *myController_;
     111            DroneController *myController_; //!< The controller of the Drone.
    81112           
    82113            Vector3 steering_;
    83             btVector3 localLinearAcceleration_;
    84             btVector3 localAngularAcceleration_;
     114            btVector3 localLinearAcceleration_; //!< The linear acceleration that is used to move the Drone the next tick.
     115            btVector3 localAngularAcceleration_; //!< The linear angular acceleration that is used to move the Drone the next tick.
    85116            float primaryThrust_;
    86117            float auxilaryThrust_;
Note: See TracChangeset for help on using the changeset viewer.