Changeset 4453 in orxonox.OLD for orxonox/trunk/src/glmenu/glmenu_imagescreen.h

Timestamp:

Jun 1, 2005, 11:22:18 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: docu for the image_screen

File:

• orxonox/trunk/src/glmenu/glmenu_imagescreen.h (modified) (4 diffs)

orxonox/trunk/src/glmenu/glmenu_imagescreen.h

@@ -1 +1 @@
 /*! 
-    \file glmenu_imagescreen
-    \brief class to display a image
+    \file glmenu_imagescreen.h
+    \brief class to display a LoadScreen
 */
-
 
 #ifndef _GLMENU_IMAGESCREEN_H
@@ -13 +12 @@
 class TiXmlElement;
 
+//! A class to display a loadScreen
 class GLMenuImageScreen : public BaseObject {
 
@@ -34 +34 @@
 
   void setMaximum (int maxValue);
-  int getMaximum ();
+  /** \returns the maximum of countable steps*/
+  inline int GLMenuImageScreen::getMaximum(void) const { return this->maxValue; };
+
   void setValue (int currentValue);
   int getValue ();
@@ -41 +43 @@
 
  private:
-  char* backImageName;       //!< the name of the file of the background image
-  float scaleX, scaleY;      //!< hight and width of the image
-  float offsetX, offsetY;    //!< offset of the image from left and up
-  Material* backMat;         //!< Background Material.
-  float barX, barY, barW, barH; //!< Position and Scale of the bar.
-  Material* barMat;          //!< A Material for the Loading-Bar
+  // background image
+  char*         backImageName;       //!< the name of the file of the background image
+  float         offsetX;             //!< X-offset of the the image from the left
+  float         offsetY;             //!< Y-offset of the image from the top
+  float         scaleX;              //!< width of the image
+  float         scaleY;              //!< height of the image
+  Material*     backMat;             //!< Background Material.
+
+  // Load-Bar
+  float         barX;                //!< X-position of the Bar
+  float         barY;                //!< Y-position of the Bar
+  float         barW;                //!< Width of the Bat
+  float         barH;                //!< Height of the Bar.
+  Material*     barMat;              //!< A Material for the Loading-Bar
 
   /* progress bar values */
-  int currentValue;          //!< the current count of step() calls fired yet
-  int maxValue;              //!< total count of steps
+  int           currentValue;        //!< the current count of step() calls fired yet
+  int           maxValue;            //!< total count of steps
 
 };