Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Mar 12, 2005, 12:34:15 PM (20 years ago)
Author:
bensch
Message:

orxonox/branches/trackManager: some doxygen-tags.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • orxonox/branches/trackManager/src/track_manager.cc

    r3516 r3517  
    3535  this->isJoined = false;
    3636  this->mainJoin = false;
    37   this->cond; //!< todo think!!
    3837  this->ID = -1;
    3938  this->startingTime = 0; //!< \todo eventually set this to the max time of TrackManager.
     
    111110}
    112111
     112/**
     113   \brief CONDITION that chooses the first child for the decision (static)
     114   \param nothing Nothing in this function
     115   \returns the chosen child
     116*/
    113117int TrackElement::lowest(void* nothing)
    114118{
     
    116120}
    117121
     122/**
     123   \brief CONDITION that chooses the last child for the decision (static)
     124   \param nothing Nothing in this function
     125   \returns the chosen child
     126*/
    118127int TrackElement::highest(void* nothing)
    119128{
     
    121130}
    122131
     132/**
     133   \brief CONDITION that chooses a random child for the decision (static)
     134   \param nothing Nothing in this function
     135   \returns the chosen child
     136*/
    123137int TrackElement::random(void* nothing)
    124138{
     
    130144}
    131145
    132 
     146/**
     147   \brief CONDITION that chooses child 0, if the node(probably Player)
     148   is left of its parent (z<0)) and 1/right otherwise.
     149   \param node The node to act upon.
     150   \returns the chosen child
     151*/
    133152int TrackElement::leftRight(void* node)
    134153{
     
    142161
    143162
    144 // todo
     163/**
     164   \brief CONDITION that chooses the child, that has the nearest distance to the node (probably player).
     165   \param node The node to act upon.
     166   \returns the chosen child
     167
     168   This is rather dangerous, because one must carefully set the points on the curve.
     169   The best Way is to set the nodes as wide away of each other as possible,
     170   but take into consideration, that if the nodes are to far from a center node, the center will be chosen.
     171   (play with this!!).
     172*/
    145173int TrackElement::nearest(void* node)
    146174{
     
    264292/**
    265293   \brief Sets the Type of the Curve
    266    \brief curveType The Type to set
     294   \param curveType The Type to set
     295   \param trackElem the TrackElement that should get a new Curve.
    267296*/
    268297void TrackManager::setCurveType(CurveType curveType, TrackElement* trackElem)
Note: See TracChangeset for help on using the changeset viewer.