Changeset 2141 in orxonox.OLD for orxonox/branches/chris/src/track.cc

Timestamp:

Jul 14, 2004, 3:31:42 PM (21 years ago)

Author:

chris

Message:

orxonox/branches/chris: added lots and lots of doxygen tags

File:

• orxonox/branches/chris/src/track.cc (modified) (5 diffs)

orxonox/branches/chris/src/track.cc

@@ -20 +20 @@
 using namespace std;
 
+/**
+        \brief creates a null Track part
+*/
 Track::Track ()
 {
@@ -28 +31 @@
 }
 
+/**
+        \brief creates a functional base Track part
+        \param number: the ID if this Track part
+        \param next: the ID of the next Track part
+        \param start: pointer to an anchor point (Vector) representing the offset of this part
+        \param finish: pointer to an anchor point (Vector) representing the end of this part
+*/
 Track::Track (Uint32 number, Uint32 next, Vector* start, Vector* finish)
 {
@@ -36 +46 @@
 }
 
+/**
+        \brief removes the Track part from memory
+*/
 Track::~Track ()
 {
 }
 
+/**
+        \brief calculate a camera Placement from a "look at"-Location
+        \param lookat: the Location the camera should be centered on
+        \param camplc: pointer to a buffer where the new camera Placement should be put into
+        
+        Theoretically you can place the camera wherever you want, but for the sake of common sense I suggest that you at least
+        try to keep the thing that should be looked at inside camera boundaries.
+*/
 void Track::map_camera (Location* lookat, Placement* camplc)
 {
-printf("Track|Mapping camera: %d (%f)\n", lookat->part, lookat->dist);
         Line trace(*offset, *end - *offset);
         float l = trace.len ();
@@ -48 +68 @@
 //      camplc->r = *offset + Vector(0,0,0.5);
 //      camplc->w = Quaternion (trace.a, Vector(0,0,1));
-        
+        float r = (lookat->dist)*PI / l;
         camplc->r = trace.r + (trace.a * ((lookat->dist-10.0) / l)) + Vector(0,0,5.0);
-        camplc->w = Quaternion(Vector(0,0,0) - ((trace.r + (trace.a * ((lookat->dist) / l)) - camplc->r)), Vector(0,0,1));
+        camplc->w = Quaternion(Vector(0,0,0) - ((trace.r + (trace.a * ((lookat->dist) / l)) - camplc->r)), Vector(0,sin(r),cos(r)));
         
 }
 
+/**
+        \brief calculate a Placement from a given Location
+        \param loc: the Location the entity is in
+        \param plc: a pointer to a buffer where the corresponding Placement should be put into
+        
+        There are no limitations to how you transform a Location into a Placement, but for the sake of placement compatibility between
+        track parts you should make sure that the resulting Placement at dist == 0 is equal to the offset Vector and the Placement at
+        dist == len() is equal to the end Vector. Elseway there will be ugly artifacts when transfering between track parts.
+*/
 bool Track::map_coords (Location* loc, Placement* plc)
 {
-printf("Track|Mapping coords: %d (%f)\n", loc->part, loc->dist);
         Line trace(*offset, *end - *offset);
         float l = trace.len ();
@@ -75 +103 @@
 }
 
+/**
+        \brief this is called when a WorldEntity enters a Track part
+        \param entity: pointer to the WorldEntity in question
+        
+        You can do stuff like add or remove effects, do some coordinate finetuning or whatever in here.
+*/
 void Track::post_enter (WorldEntity* entity)
 {
 }
 
+/**
+        \brief this is called when a WorldEntity leaves a Track part
+        \param entity: pointer to the WorldEntity in question
+        
+        You can do stuff like add or remove effects, do some coordinate finetuning or whatever in here.
+*/
 void Track::post_leave (WorldEntity* entity)
 {
 }
 
+/**
+        \brief this is called every frame
+        \param deltaT: amount of time passed since the last frame in seconds
+        
+        Do time based or polling scripts here. 
+*/
 void Track::tick (float deltaT)
 {