Changeset 3449 in orxonox.OLD for orxonox/trunk/src/world.cc

Timestamp:

Mar 2, 2005, 2:23:47 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: documented orxonox.cc/h world.cc/h vector.cc/h

File:

• orxonox/trunk/src/world.cc (modified) (15 diffs)

orxonox/trunk/src/world.cc

@@ -46 +46 @@
 }
 
+/**
+   \brief creates a new World...
+   \param worldID with this ID
+*/
 World::World (int worldID)
 {
@@ -96 +100 @@
   {60.0, -10.0, 5.0}, {80.0, 10.0, 5.0}};
 
-
+/**
+   \brief initializes a new World
+*/
 ErrorMessage World::init()
 {
@@ -114 +120 @@
 
 
-
+/**
+   \brief starts the World
+*/
 ErrorMessage World::start()
 {
@@ -123 +131 @@
 }
 
+/**
+   \brief stops the world.
+
+   This happens, when the player decides to end the Level.
+*/
 ErrorMessage World::stop()
 {
@@ -129 +142 @@
 }
 
+/**
+   \brief pauses the Game
+*/
 ErrorMessage World::pause()
 {
@@ -134 +150 @@
 }
 
-
+/**
+   \brief ends the pause Phase
+*/
 ErrorMessage World::resume()
 {
@@ -140 +158 @@
 }
 
-
+/**
+   \brief destroys the World
+*/
 void World::destroy()
 {
@@ -146 +166 @@
 }
 
-
+/**
+   \brief shows the loading screen
+*/
 void World::displayLoadScreen ()
 {
@@ -160 +182 @@
 }
 
-
+/**
+   \brief removes the loadscreen, and changes over to the game
+
+   \todo take out the delay
+*/
 void World::releaseLoadScreen ()
 {
@@ -169 +195 @@
 }
 
-
+/**
+   \brief loads the World by initializing all resources, and set their default values.
+*/
 void World::load()
 {
@@ -334 +362 @@
             this->nullParent->setName ("NullParent");
 
-            // create some path nodes
-            this->pathnodes = new Vector[6];
-            this->pathnodes[0] = Vector(0, 0, 0);
-            this->pathnodes[1] = Vector(20, 10, 10);
-            this->pathnodes[2] = Vector(40, 0, 10);
-            this->pathnodes[3] = Vector(60, 10, 0);
-            this->pathnodes[4] = Vector(80, 20, 10);
-            this->pathnodes[5] = Vector(30, 50, 0);
-            
-
 
 
@@ -795 +813 @@
 
 
-/*
+/**
   \brief main loop of the world: executing all world relevant function
 
@@ -950 +968 @@
    \brief add and spawn a new entity to this world
    \param entity to be added
-   \param location where to add
+   \param absCoor At what coordinates to add this entity.
+   \param absDir In which direction should it look.
 */
 void World::spawn(WorldEntity* entity, Vector* absCoor, Quaternion* absDir)
@@ -967 +986 @@
 
 
-/*
+/**
   \brief commands that the world must catch
   \returns false if not used by the world
@@ -978 +997 @@
 
 
-
+/**
+   \brief swaps two values
+   \todo make this a global function, and take it out of world
+*/
 void World::swap (unsigned char &a, unsigned char &b)
 {