Changeset 2141 in orxonox.OLD for orxonox/branches/chris/src/world.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/world.cc (modified) (9 diffs)

orxonox/branches/chris/src/world.cc

@@ -27 +27 @@
 
 /** 
-   \brief Create a new World
+   \brief create a new World
    
    This creates a new empty world!
@@ -36 +36 @@
 }
 
-
+/** 
+   \brief remove the World from memory
+*/
 World::~World ()
 {
@@ -43 +45 @@
 }
 
+/** 
+   \brief checks for collisions
+   
+   This method runs through all WorldEntities known to the world and checks for collisions between them.
+   In case of collisions the collide() method of the corresponding entities is called.
+*/
 void World::collide ()
 {
@@ -75 +83 @@
 }
 
+/** 
+   \brief runs through all entities calling their draw() methods
+*/
 void World::draw ()
 {
@@ -140 +151 @@
 }
 
+/** 
+   \brief updates Placements and notifies entities when they left the world
+   
+   This runs trough all WorldEntities and maps Locations to Placements if they are bound, checks
+   whether they left the level boundaries and calls appropriate functions.
+*/
 void World::update ()
 {
@@ -190 +207 @@
 }
 
+/** 
+  \brief relays the passed time since the last frame to entities and Track parts
+        \param deltaT: the time passed since the last frame in milliseconds
+*/
 void World::time_slice (Uint32 deltaT)
 {
@@ -209 +230 @@
 }
 
+/**
+        \brief removes level data from memory
+*/
 void World::unload()
 {
@@ -215 +239 @@
 }
 
+/**
+        \brief loads a simple level for testing purposes
+*/
 void World::load_debug_level()
 {
@@ -245 +272 @@
 }
 
+/**
+        \brief calls the correct mapping function to convert a given "look at"-Location to a Camera Placement
+*/
 void World::calc_camera_pos (Location* loc, Placement* plc)
 {