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.

Location:
code/branches/tutorial/src/orxonox
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • code/branches/tutorial/src/orxonox/controllers/DroneController.cc

    r5786 r5833  
    3434namespace orxonox
    3535{
     36    /**
     37    @brief
     38        Constructor.
     39    */
    3640    DroneController::DroneController(BaseObject* creator) : Controller(creator)
    3741    {
    … …  
    5155    }
    5256
     57    /**
     58    @brief
     59        The controlling happens here. This method defines what the controller has to do each tick.
     60    @param dt
     61        The duration of the tick.
     62    */
    5363    void DroneController::tick(float dt)
    5464    {

  • code/branches/tutorial/src/orxonox/controllers/DroneController.h

    r5766 r5833  
    3737namespace orxonox
    3838{
     39    /**
     40    @brief
     41        Controller for the Drone of the PPS tutorial.
     42    @author
     43        Oli Scheuss
     44    */
    3945    class _OrxonoxExport DroneController : public Controller, public Tickable
    4046    {
    … …  
    4349            virtual ~DroneController();
    4450           
    45             virtual void tick(float dt);
     51            virtual void tick(float dt); //!< The controlling happens here. This method defines what the controller has to do each tick.
    4652
    4753        protected:

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

    r5793 r5833  
    3838    CreateFactory(Drone);
    3939
     40    /**
     41    @brief
     42        Constructor. Registers the object and initializes some default values.
     43    */
    4044    Drone::Drone(BaseObject* creator) : ControllableEntity(creator)
    4145    {
    42         //put your code in here:
     46        // put your code in here:
    4347        // - register the drone class to the core
    4448        // - create a new controller and pass our this pointer to it as creator
    … …  
    5862    }
    5963
     64    /**
     65    @brief
     66        Destructor. Destroys controller, if present.
     67    */
    6068    Drone::~Drone()
    6169    {
    … …  
    6472    }
    6573
     74    /**
     75    @brief
     76        Method for creating a Drone through XML.
     77    */
    6678    void Drone::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    6779    {
    … …  
    7486    }
    7587
     88    /**
     89    @brief
     90        Defines which actions the Drone has to take in each tick.
     91    @param dt
     92        The length of the tick.
     93    */
    7694    void Drone::tick(float dt)
    7795    {
    … …  
    95113    }
    96114   
    97    
     115    /**
     116    @brief
     117        Moves the Drone in the negative z-direction (Front/Back) by an amount specified by the first component of the input 2-dim vector.
     118    @param value
     119        The vector determining the amount of the movement.
     120    */
    98121    void Drone::moveFrontBack(const Vector2& value)
    99122    {
    … …  
    102125    }
    103126
     127    /**
     128    @brief
     129        Moves the Drone in the x-direction (Right/Left) by an amount specified by the first component of the input 2-dim vector.
     130    @param value
     131        The vector determining the amount of the movement.
     132    */
    104133    void Drone::moveRightLeft(const Vector2& value)
    105134    {
    … …  
    108137    }
    109138
     139    /**
     140    @brief
     141        Moves the Drone in the y-direction (Up/Down) by an amount specified by the first component of the input 2-dim vector.
     142    @param value
     143        The vector determining the amount of the movement.
     144    */
    110145    void Drone::moveUpDown(const Vector2& value)
    111146    {
    … …  
    114149    }
    115150
     151    /**
     152    @brief
     153        Rotates the Drone around the y-axis by the amount specified by the first component of the input 2-dim vector.
     154    @param value
     155        The vector determining the amount of the angular movement.
     156    */
    116157    void Drone::rotateYaw(const Vector2& value)
    117158    {
    … …  
    119160    }
    120161
     162    /**
     163    @brief
     164        Rotates the Drone around the x-axis by the amount specified by the first component of the input 2-dim vector.
     165    @param value
     166        The vector determining the amount of the angular movement.
     167    */
    121168    void Drone::rotatePitch(const Vector2& value)
    122169    {
    … …  
    124171    }
    125172
     173    /**
     174    @brief
     175        Rotates the Drone around the z-axis by the amount specified by the first component of the input 2-dim vector.
     176    @param value
     177        The vector determining the amount of the angular movement.
     178    */
    126179    void Drone::rotateRoll(const Vector2& value)
    127180    {

  • 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.