Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD for orxonox/trunk/src/util/track


Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit :)

Location:
orxonox/trunk/src/util/track
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/util/track/pilot_node.cc

    r4597 r4836  
    2626
    2727/**
    28    \brief standard constructor
     28 * standard constructor
    2929*/
    3030PilotNode::PilotNode ()
    … …  
    3939
    4040/**
    41    \brief standard deconstructor
     41 * standard deconstructor
    4242*/
    4343PilotNode::~PilotNode ()
    … …  
    4747
    4848/**
    49     \brief ticks the node
    50     \param time the time about whitch to tick                                           \
     49  * ticks the node
     50  * @param time the time about whitch to tick                                           \
    5151*/
    5252void PilotNode::tick(float time)
    … …  
    5757
    5858/**
    59    \brief action if player moves
    60    \param time the timeslice since the last frame
     59 * action if player moves
     60 * @param time the timeslice since the last frame
    6161*/
    6262void PilotNode::move (float time)
    … …  
    9898
    9999/**
    100    \brief handles events
    101    \param event the event that occured
     100 * handles events
     101 * @param event the event that occured
    102102*/
    103103void PilotNode::process( const Event &event)

  • orxonox/trunk/src/util/track/pilot_node.h

    r4597 r4836  
    11/*!
    22    \file pilot_node.h
    3     \brief Definition of a PilotNode
     3  * Definition of a PilotNode
    44*/
    55

  • orxonox/trunk/src/util/track/track_manager.cc

    r4834 r4836  
    3636
    3737/**
    38    \brief initializes a TrackElement (sets the default values)
     38 * initializes a TrackElement (sets the default values)
    3939*/
    4040TrackElement::TrackElement()
    … …  
    6666
    6767/**
    68     \brief destroys all alocated memory)
    69     \todo eventually when deleting a TrackElement you would not like to delete all its preceding TrackElements
     68  * destroys all alocated memory)
     69    @todo eventually when deleting a TrackElement you would not like to delete all its preceding TrackElements
    7070*/
    7171TrackElement::~TrackElement()
    … …  
    9191
    9292/**
    93    \brief Searches through all the TrackElements for trackID.
    94    \param trackID The ID to search for.
    95    \returns The TrackElement if Found, NULL otherwise.
     93 * Searches through all the TrackElements for trackID.
     94 * @param trackID The ID to search for.
     95 * @returns The TrackElement if Found, NULL otherwise.
    9696*/
    9797TrackElement* TrackElement::findByID(unsigned int trackID)
    … …  
    120120
    121121/**
    122    \brief Searches through all the TrackElements for a trackName
    123    \param trackName The name to search for.
    124    \returns The TrackElement if Found, NULL otherwise.
     122 * Searches through all the TrackElements for a trackName
     123 * @param trackName The name to search for.
     124 * @returns The TrackElement if Found, NULL otherwise.
    125125*/
    126126TrackElement* TrackElement::findByName(const char* trackName)
    … …  
    148148
    149149/**
    150    \brief checks if there are any BackLoops in the Track
    151    \returns true if NO loop was found, false Otherwise
     150 * checks if there are any BackLoops in the Track
     151 * @returns true if NO loop was found, false Otherwise
    152152   You actually have to act on false!!
    153153*/
    … …  
    164164
    165165/**
    166    \brief checks if there are any BackLoops in the Track.
    167    \param trackList A list of stored tracks, to search in.
    168    \returns true if NO loop was found, false Otherwise
     166 * checks if there are any BackLoops in the Track.
     167 * @param trackList A list of stored tracks, to search in.
     168 * @returns true if NO loop was found, false Otherwise
    169169   You actually have to act on false!!
    170170*/
    … …  
    192192
    193193/**
    194    \param childCount which child to return
    195    \returns the n-the children (starting at 0).
     194 * @param childCount which child to return
     195 * @returns the n-the children (starting at 0).
    196196   Be aware, that when the trackElement has no Children, NULL will be returned
    197197*/
    … …  
    214214
    215215/**
    216    \brief prints out debug information about this TrackElement
     216 * prints out debug information about this TrackElement
    217217*/
    218218void TrackElement::debug() const
    … …  
    260260
    261261/**
    262    \brief CONDITION that chooses the first child for the decision (static)
    263    \param nothing Nothing in this function
    264    \returns the chosen child
     262 * CONDITION that chooses the first child for the decision (static)
     263 * @param nothing Nothing in this function
     264 * @returns the chosen child
    265265*/
    266266int TrackElement::lowest(const void* nothing) const
    … …  
    270270
    271271/**
    272    \brief CONDITION that chooses the last child for the decision (static)
    273    \param nothing Nothing in this function
    274    \returns the chosen child
     272 * CONDITION that chooses the last child for the decision (static)
     273 * @param nothing Nothing in this function
     274 * @returns the chosen child
    275275*/
    276276int TrackElement::highest(const void* nothing) const
    … …  
    280280
    281281/**
    282    \brief CONDITION that chooses a random child for the decision (static)
    283    \param nothing Nothing in this function
    284    \returns the chosen child
     282 * CONDITION that chooses a random child for the decision (static)
     283 * @param nothing Nothing in this function
     284 * @returns the chosen child
    285285*/
    286286int TrackElement::random(const void* nothing) const
    … …  
    294294
    295295/**
    296    \brief CONDITION that chooses child 0, if the node(probably Player)
     296 * CONDITION that chooses child 0, if the node(probably Player)
    297297   is left of its parent (z<0)) and 1/right otherwise.
    298    \param node The node to act upon.
    299    \returns the chosen child
     298 * @param node The node to act upon.
     299 * @returns the chosen child
    300300*/
    301301int TrackElement::leftRight(const void* node) const
    … …  
    311311
    312312/**
    313    \brief CONDITION that chooses the child, that has the nearest distance to the node (probably player).
    314    \param node The node to act upon.
    315    \returns the chosen child
     313 * CONDITION that chooses the child, that has the nearest distance to the node (probably player).
     314 * @param node The node to act upon.
     315 * @returns the chosen child
    316316
    317317   This is rather dangerous, because one must carefully set the points on the curve.
    … …  
    354354////////////////////////
    355355/**
    356    \brief standard constructor
     356 * standard constructor
    357357
    358358*/
    … …  
    391391
    392392/**
    393    \brief loads a trackElement from a TiXmlElement
    394    \param root the TiXmlElement to load the Data from
     393 * loads a trackElement from a TiXmlElement
     394 * @param root the TiXmlElement to load the Data from
    395395*/
    396396bool TrackManager::loadParams(const TiXmlElement* root)
    … …  
    449449
    450450/**
    451    \brief standard destructor
     451 * standard destructor
    452452*/
    453453TrackManager::~TrackManager()
    … …  
    469469// INITIALIZE //
    470470/**
    471    \brief reserves Space for childCount children
    472    \param childCount The Count of children to make space for.
    473    \param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
     471 * reserves Space for childCount children
     472 * @param childCount The Count of children to make space for.
     473 * @param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
    474474*/
    475475void TrackManager::initChildren(unsigned int childCount, TrackElement* trackElem)
    … …  
    513513
    514514/**
    515    \brief Sets the trackID we are working on.
    516    \param trackID the trackID we are working on
     515 * Sets the trackID we are working on.
     516 * @param trackID the trackID we are working on
    517517*/
    518518void TrackManager::workOn(unsigned int trackID)
    … …  
    527527
    528528/**
    529    \brief Sets the TrackElement to work on
    530    \param trackName the Name of the Track to work on
     529 * Sets the TrackElement to work on
     530 * @param trackName the Name of the Track to work on
    531531*/
    532532void TrackManager::workOnS(const char* trackName)
    … …  
    541541
    542542/**
    543    \brief Sets the Type of the Curve
    544    \param curveType The Type to set
    545    \param trackElem the TrackElement that should get a new Curve.
    546 
    547    \brief this will possibly get obsolete during the process.
     543 * Sets the Type of the Curve
     544 * @param curveType The Type to set
     545 * @param trackElem the TrackElement that should get a new Curve.
     546
     547 * this will possibly get obsolete during the process.
    548548*/
    549549void TrackManager::setCurveType(CurveType curveType, TrackElement* trackElem)
    … …  
    564564
    565565/**
    566    \param duration the duration of the TrackElement
     566 * @param duration the duration of the TrackElement
    567567   \see void TrackManager::setDuration(float duration, TrackElement* trackElem)
    568568*/
    … …  
    573573
    574574/**
    575    \brief Sets the duration of the current path in seconds.
    576    \param duration The duration in seconds.
    577    \param trackElem The TrackElement to apply this to.
     575 * Sets the duration of the current path in seconds.
     576 * @param duration The duration in seconds.
     577 * @param trackElem The TrackElement to apply this to.
    578578*/
    579579void TrackManager::setDuration(float duration, TrackElement* trackElem)
    … …  
    587587
    588588/**
    589    \brief adds a point to trackElem
    590    \param x x coord
    591    \param y y coord
    592    \param z z coord
    593    \param trackElem The TrackElement to add the Point to
     589 * adds a point to trackElem
     590 * @param x x coord
     591 * @param y y coord
     592 * @param z z coord
     593 * @param trackElem The TrackElement to add the Point to
    594594*/
    595595void TrackManager::addPoint(float x, float y, float z)
    … …  
    599599
    600600/**
    601    \brief adds a point to trackElem
    602    \param newPoint The point to add.
    603    \param trackElem The TrackElement to add the Point to
     601 * adds a point to trackElem
     602 * @param newPoint The point to add.
     603 * @param trackElem The TrackElement to add the Point to
    604604*/
    605605void TrackManager::addPointV(Vector newPoint, TrackElement* trackElem)
    … …  
    618618
    619619/**
    620    \brief adds a new Hot Point
    621    \param x: the x coordinate of the hotpoint
    622    \param y: the y coordinate of the hotpoint
    623    \param z: the z coordinate of the hotpoint
     620 * adds a new Hot Point
     621 * @param x: the x coordinate of the hotpoint
     622 * @param y: the y coordinate of the hotpoint
     623 * @param z: the z coordinate of the hotpoint
    624624   \see int TrackManager::addHotPointV(Vector newPoint, TrackElement* trackElem)
    625625*/
    … …  
    630630
    631631/**
    632    \brief adds save/splitpoint.
    633    \param newPoint The point to add.
    634    \param trackElem if supplied it will add a hotpoint on this TrackElement
    635    \returns A Pointer to a newly appended Curve
     632 * adds save/splitpoint.
     633 * @param newPoint The point to add.
     634 * @param trackElem if supplied it will add a hotpoint on this TrackElement
     635 * @returns A Pointer to a newly appended Curve
    636636*/
    637637int TrackManager::addHotPointV(Vector newPoint, TrackElement* trackElem)
    … …  
    646646    }
    647647
    648   // \todo HotPoint Handling.
     648  // @todo HotPoint Handling.
    649649  trackElem->curve->addNode(newPoint);
    650650  trackElem->nodeCount++;
    … …  
    653653
    654654/**
    655    \todo this must be better
     655   @todo this must be better
    656656*/
    657657void TrackManager::setSavePointS(const char* nextElementName)
    … …  
    663663
    664664/**
    665    \brief Sets the last HotPoint into a savePoint.
    666    \param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
    667    \returns A Pointer to a newly appended Curve
     665 * Sets the last HotPoint into a savePoint.
     666 * @param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
     667 * @returns A Pointer to a newly appended Curve
    668668
    669669   If no HotPoint was defined the last added Point will be rendered into a savePoint. \n
    … …  
    688688
    689689/**
    690    \brief adds some interessting non-linear movments through the level.
    691    \param count The Count of children the fork will produce
     690 * adds some interessting non-linear movments through the level.
     691 * @param count The Count of children the fork will produce
    692692
    693693   If no HotPoint was defined the last added Point will be rendered into a fork. \n
    … …  
    709709
    710710/**
    711    \param count how many children to produce
    712    \param ... the information on the children (these are the Stings of their names
     711 * @param count how many children to produce
     712 * @param ... the information on the children (these are the Stings of their names
    713713   \see TrackManager::fork(unsigned int count, ...)
    714714
    … …  
    747747
    748748/**
    749    \brief adds some interessting non-linear movments through the level.
    750    \param count The Count of childrens the current HotPoint will have.
    751    \param trackIDs A Pointer to an Array of ints which will hold the trackID's (the user will have to reserve space for this).
    752    \param trackNames the names for the tracks as a char-arrey-array
    753    \param trackElem The TrackElement to appy this to. (if NULL choose this->currentTrackElement)
     749 * adds some interessting non-linear movments through the level.
     750 * @param count The Count of childrens the current HotPoint will have.
     751 * @param trackIDs A Pointer to an Array of ints which will hold the trackID's (the user will have to reserve space for this).
     752 * @param trackNames the names for the tracks as a char-arrey-array
     753 * @param trackElem The TrackElement to appy this to. (if NULL choose this->currentTrackElement)
    754754   \see TrackManager::fork(unsigned int count, ...)
    755755*/
    … …  
    770770
    771771/**
    772    \brief decides under what condition a certain Path will be chosen.
    773    \param trackID the trackID to apply this to.
    774    \param cond the CONDITION of the decision
    775    \param subject the Subject that will be decided upon with CONDITION cond.
     772 * decides under what condition a certain Path will be chosen.
     773 * @param trackID the trackID to apply this to.
     774 * @param cond the CONDITION of the decision
     775 * @param subject the Subject that will be decided upon with CONDITION cond.
    776776*/
    777777void TrackManager::condition(unsigned int trackID, CONDITION cond, void* subject)
    … …  
    781781
    782782/**
    783    \brief decides under what condition a certain Path will be chosen.
    784    \param cond the CONDITION of the decision
    785    \param subject the Subject that will be decided upon with CONDITION cond.
    786    \param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
     783 * decides under what condition a certain Path will be chosen.
     784 * @param cond the CONDITION of the decision
     785 * @param subject the Subject that will be decided upon with CONDITION cond.
     786 * @param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
    787787*/
    788788void TrackManager::condition(CONDITION cond, void* subject, TrackElement* trackElem)
    … …  
    823823
    824824/**
    825    \brief joins some tracks together again.
    826    \param count The count of Paths to join.
     825 * joins some tracks together again.
     826 * @param count The count of Paths to join.
    827827
    828828   Join will set the localTime to the longest time a Path has to get to this Point. \n
    … …  
    844844
    845845/**
    846    \brief Joins some Tracks together again.
    847    \param count The count of trackElements to join
     846 * Joins some Tracks together again.
     847 * @param count The count of trackElements to join
    848848   \see void TrackManager::join(unsigned int count, ...)
    849849
    … …  
    894894
    895895/**
    896    \brief joins some tracks together again.
    897    \param count The count of Paths to join.
    898    \param trackIDs an Array with the trackID's to join
     896 * joins some tracks together again.
     897 * @param count The count of Paths to join.
     898 * @param trackIDs an Array with the trackID's to join
    899899
    900900   \see void TrackManager::join(unsigned int count, ...)
    … …  
    988988
    989989/**
    990    \brief finalizes the TrackSystem. after this it will not be editable anymore
    991 
    992    \todo check for any inconsistencies, output errors
     990 * finalizes the TrackSystem. after this it will not be editable anymore
     991
     992   @todo check for any inconsistencies, output errors
    993993*/
    994994void TrackManager::finalize()
    … …  
    10361036
    10371037/**
    1038    \brief calculates the Position for the localTime of the Track.
    1039    \returns the calculated Position
     1038 * calculates the Position for the localTime of the Track.
     1039 * @returns the calculated Position
    10401040*/
    10411041Vector TrackManager::calcPos() const
    … …  
    10451045
    10461046/**
    1047    \brief calculates the Rotation for the localTime of the Track.
    1048    \returns the calculated Rotation
     1047 * calculates the Rotation for the localTime of the Track.
     1048 * @returns the calculated Rotation
    10491049*/
    10501050Vector TrackManager::calcDir() const
    … …  
    10541054
    10551055/**
    1056    \returns the current Width of the track
     1056 * @returns the current Width of the track
    10571057*/
    10581058float TrackManager::getWidth() const
    … …  
    10621062
    10631063/**
    1064    \brief Advances the local-time of the Track around dt
    1065    \param dt The time about which to advance.
     1064 * Advances the local-time of the Track around dt
     1065 * @param dt The time about which to advance.
    10661066
    10671067   This function also checks, if the TrackElement has to be changed.
    … …  
    11041104
    11051105/**
    1106    \brief Jumps to a certain point on the Track.
    1107    \param time The time on the Track to jump to.
     1106 * Jumps to a certain point on the Track.
     1107 * @param time The time on the Track to jump to.
    11081108
    11091109   This should be used to Jump backwards on a Track, because moving forward means to change between the Path. (it then tries to choose the default.)
    … …  
    11251125
    11261126/**
    1127    \brief a Function that decides which Path we should follow.
    1128    \param trackElem The Path to choose.
     1127 * a Function that decides which Path we should follow.
     1128 * @param trackElem The Path to choose.
    11291129
    11301130*/
    … …  
    11351135
    11361136/**
    1137    \brief Sets the PNode, that should be moved along the Tack
    1138    \param bindSlave the PNode to set
     1137 * Sets the PNode, that should be moved along the Tack
     1138 * @param bindSlave the PNode to set
    11391139*/
    11401140void TrackManager::setBindSlave(PNode* bindSlave)
    … …  
    11441144
    11451145/**
    1146    \returns the main TrackNode
     1146 * @returns the main TrackNode
    11471147*/
    11481148PNode* TrackManager::getTrackNode()
    … …  
    11541154
    11551155/**
    1156    \brief Imports a model of the Graph into the OpenGL-environment.
    1157    \param dt The Iterator used in seconds for Painting the Graph.
     1156 * Imports a model of the Graph into the OpenGL-environment.
     1157 * @param dt The Iterator used in seconds for Painting the Graph.
    11581158
    11591159   This is for testing facility only. Do this if you want to see the Path inside the Level.
    … …  
    11781178
    11791179/**
    1180    \brief outputs debug information about the trackManager
    1181    \param level how much debug
     1180 * outputs debug information about the trackManager
     1181 * @param level how much debug
    11821182*/
    11831183void TrackManager::debug(unsigned int level) const

  • orxonox/trunk/src/util/track/track_manager.h

    r4834 r4836  
    11/*!
    22    \file track_manager.h
    3     \brief manages all tracks defined in the world and the path the player takes
     3  * manages all tracks defined in the world and the path the player takes
    44
    55    it is a container for all tracks and all track-nodes. it manages the movement of
    … …  
    136136 public:
    137137  virtual ~TrackManager();
    138   /** \returns a Pointer to the only object of this Class */
     138  /** @returns a Pointer to the only object of this Class */
    139139  inline static TrackManager* getInstance() { if (!singletonRef) singletonRef = new TrackManager();  return singletonRef; };
    140140
    … …  
    145145  void workOnS(const char* trackName);
    146146
    147   /** \see setCurveType(CurveType curveType, TrackElement* trackElem); \param curveType the type of the Curve */
     147  /** \see setCurveType(CurveType curveType, TrackElement* trackElem); @param curveType the type of the Curve */
    148148  inline void setCurveType(CurveType curveType) { this->setCurveType (curveType, this->currentTrackElem);};
    149149  void setCurveType(CurveType curveType, TrackElement* trackElem);

  • orxonox/trunk/src/util/track/track_node.cc

    r4597 r4836  
    2626
    2727/**
    28    \brief standard constructor
     28 * standard constructor
    2929*/
    3030TrackNode::TrackNode ()
    … …  
    3939
    4040/**
    41    \brief standard deconstructor
     41 * standard deconstructor
    4242*/
    4343TrackNode::~TrackNode ()

  • orxonox/trunk/src/util/track/track_node.h

    r4489 r4836  
    11/*!
    22    \file track_node.h
    3     \brief Definition of the TrackNode are located here
     3  * Definition of the TrackNode are located here
    44   
    55    the TrackNode is the node, that follows the Track (and the TrackManager)
Note: See TracChangeset for help on using the changeset viewer.