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.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    {
Note: See TracChangeset for help on using the changeset viewer.