Changeset 4259 in orxonox.OLD

Timestamp:

May 22, 2005, 2:58:20 AM (19 years ago)

Author:

bensch

Message:

orxonox/branches/levelLoader: nicer comments

Location:

orxonox/branches/levelLoader/src

Files:

• glmenu/glmenu_imagescreen.cc (modified) (1 diff)
• story_entities/world.cc (modified) (1 diff)
• util/loading/load_param.cc (modified) (2 diffs)
• world_entities/skybox.cc (modified) (1 diff)
• world_entities/world_entity.cc (modified) (1 diff)

orxonox/branches/levelLoader/src/glmenu/glmenu_imagescreen.cc

@@ -57 +57 @@
 void GLMenuImageScreen::loadParams(const TiXmlElement* root)
 {
-  LoadParam<GLMenuImageScreen>(root, "BackgroundImage", this, &GLMenuImageScreen::setBackgroundImage);
-
-  LoadParam<GLMenuImageScreen>(root, "BackgroundPS", this, &GLMenuImageScreen::setPosScale);
-
-  LoadParam<GLMenuImageScreen>(root, "BarImage", this, &GLMenuImageScreen::setBarImage);
-  
-  LoadParam<GLMenuImageScreen>(root, "BarPS", this, &GLMenuImageScreen::setBarPosScale);
-
-  LoadParam<GLMenuImageScreen>(root, "ElementCount", this, &GLMenuImageScreen::setMaximum);
+  LoadParam<GLMenuImageScreen>(root, "BackgroundImage", this, &GLMenuImageScreen::setBackgroundImage)
+    .describe("sets the image to load onto the loadscreen");
+
+  LoadParam<GLMenuImageScreen>(root, "BackgroundPS", this, &GLMenuImageScreen::setPosScale)
+    .describe("The Position and Scale of the Background Image in %(0-1.0). PosX, PosY, SizeX, SizeY");
+
+  LoadParam<GLMenuImageScreen>(root, "BarImage", this, &GLMenuImageScreen::setBarImage)
+    .describe("sets the image of the LoadingBar");
+  
+  LoadParam<GLMenuImageScreen>(root, "BarPS", this, &GLMenuImageScreen::setBarPosScale)
+    .describe("The Position and Scale of the Loading Bar in %(0-1.0). PosX, PosY, SizeX, SizeY");
+
+  LoadParam<GLMenuImageScreen>(root, "ElementCount", this, &GLMenuImageScreen::setMaximum)
+    .describe("The Count of elements to load into the bar (this is only a maximum value)");
 }
 

orxonox/branches/levelLoader/src/story_entities/world.cc

@@ -210 +210 @@
   PRINTF0("Creating a World\n");
 
-  LoadParam<World>(root, "identifier", this, &World::setStoryID).describe("Sets the StoryID of this world");
-  LoadParam<World>(root, "nextid", this, &World::setNextStoryID).describe("Sets the ID of the next world");
-  LoadParam<World>(root, "path", this, &World::setPath).describe("The Filename of this World (relative from the data-dir)");
+  LoadParam<World>(root, "identifier", this, &World::setStoryID)
+    .describe("Sets the StoryID of this world");
+  LoadParam<World>(root, "nextid", this, &World::setNextStoryID)
+    .describe("Sets the ID of the next world");
+  LoadParam<World>(root, "path", this, &World::setPath)
+    .describe("The Filename of this World (relative from the data-dir)");
 
 

orxonox/branches/levelLoader/src/util/loading/load_param.cc

@@ -209 +209 @@
 void LoadClassDescription::printAll(void) 
 {
-  PRINT(3)("==============================================================\n");
-  PRINT(3)(" Listing all the Loadable Options (loaded since Game started.\n\n");
+  PRINT(3)("===============================================================\n");
+  PRINT(3)(" Listing all the Loadable Options (loaded since Game started).\n\n");
   tIterator<LoadClassDescription>* classIT = LoadClassDescription::classList->getIterator();
   LoadClassDescription* enumClassDesc = classIT->nextElement();
@@ -229 +229 @@
     }
   delete classIT;
-
-}
+  PRINT(3)("===============================================================\n");
+}

orxonox/branches/levelLoader/src/world_entities/skybox.cc

@@ -56 +56 @@
 void SkyBox::loadParams(const TiXmlElement* root)
 {
-  LoadParam<SkyBox>(root, "Materialset", this, &SkyBox::setTexture).describe("Sets the material on the SkyBox. The string must be the path relative to the data-dir, and without a trailing .jpg");
+  LoadParam<SkyBox>(root, "Materialset", this, &SkyBox::setTexture)
+    .describe("Sets the material on the SkyBox. The string must be the path relative to the data-dir, and without a trailing .jpg");
 }
 

orxonox/branches/levelLoader/src/world_entities/world_entity.cc

@@ -42 +42 @@
 {
   // name setup
-  LoadParam<WorldEntity>(root, "name", this, &WorldEntity::setName).describe("the name of the Object at hand");
+  LoadParam<WorldEntity>(root, "name", this, &WorldEntity::setName)
+    .describe("the name of the Object at hand");
 
   // Model Loading      
-  LoadParam<WorldEntity>(root, "model", this, &WorldEntity::loadModel).describe("the fileName of the model, that should be loaded onto this world-entity. (must be relative to the data-dir)") ;
+  LoadParam<WorldEntity>(root, "model", this, &WorldEntity::loadModel)
+    .describe("the fileName of the model, that should be loaded onto this world-entity. (must be relative to the data-dir)") ;
 }