Changeset 3517 in orxonox.OLD for orxonox/branches/trackManager/src/track_manager.h

Timestamp:

Mar 12, 2005, 12:34:15 PM (20 years ago)

Author:

bensch

Message:

orxonox/branches/trackManager: some doxygen-tags.

File:

• orxonox/branches/trackManager/src/track_manager.h (modified) (6 diffs)

orxonox/branches/trackManager/src/track_manager.h

@@ -16 +16 @@
 
 class PNode;
-
-//! condition for choosing a certain Path. \todo implement a useful way.
-struct PathCondition
-{
-  
-};
-  
 
 //! A Graph-Element, that holds the curve-structure of a Level.
@@ -44 +37 @@
   bool isJoined;             //!< If the End of the Curve is joined.
   bool mainJoin;             //!< If the End of the Curve is joined, and this is the one Curve the others join to.
-  PathCondition cond;        //!< The Split Condition;
   int ID;                    //!< The ID of this TrackElement
   float startingTime;        //!< The time at which this Track begins.
@@ -67 +59 @@
   int leftRight(void* node);
   int nearest(void* node);
-  int enemyKilled(void* entity);
+  // todo  int enemyKilled(void* entity);
 };
 
+//! the Condition to choose between the different ways of the game.
 enum CONDITION {LOWEST, HIGHEST, RANDOM, LEFTRIGHT, NEAREST, ENEMYKILLED};
 
@@ -118 +111 @@
   float maxTime;                      //!< The maximal time the track has.
   int trackElemCount;                 //!< The count of TrackElements that exist.
-  PNode* bindSlave;
+  PNode* bindSlave;                   //!< The node that is slave to the TrackManager. This node will be moved while update the TrackManager, and must NOT move itself.
   
   void initChildren(unsigned int childCount);
@@ -130 +123 @@
   // Methods to change the Path (initialisation)
   void workOn(unsigned int trackID);
-  inline void setCurveType(CurveType curveType) { this->setCurveType (curveType, this->currentTrackElem);}
+  /** \see setCurveType(CurveType curveType, TrackElement* trackElem); \param curveType the type of the Curve */
+  inline void setCurveType(CurveType curveType) { this->setCurveType (curveType, this->currentTrackElem);};
   void setCurveType(CurveType curveType, TrackElement* trackElem);
   void setDuration(float time);
@@ -140 +134 @@
   void forkV(unsigned int count, int* trackIDs);
   void condition(CONDITION cond, void* subject);
-  void condition(unsigned int groupID, CONDITION cond, void* subject); //!< \todo really do this!!
+  void condition(unsigned int groupID, CONDITION cond, void* subject);
   void join(unsigned int count, ...);
   void joinV(unsigned int count, int* trackIDs);