Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4453 in orxonox.OLD for orxonox/trunk/src


Ignore:
Timestamp:
Jun 1, 2005, 11:22:18 PM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: docu for the image_screen

Location:
orxonox/trunk/src/glmenu
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/glmenu/glmenu_imagescreen.cc

    r4357 r4453  
    4747   \brief Loads a GLMenu from an inputElement
    4848   \param root The Element to load the GLMenu from
    49 
    50    Tags are:
    51    \li BackgroundImage STRING: the background Image
    52    \li BarImage: STRING: the Image on the Bar
    53    \li BackgroundPS: FLOAT FLOAT FLOAT FLOAT: posX posY scaleX scaleY
    54    \li BarPS: FLOAT FLOAT FLOAT FLOAT: posX posY scaleX scaleY
    55    \li ElementCount: INT: how many elements will be loaded
    5649*/
    5750void GLMenuImageScreen::loadParams(const TiXmlElement* root)
    … …  
    10396/**
    10497    \brief sets the background image name
    105     \param file name of the backgroun-image
     98    \param backImageName name of the backgroun-image
    10699 */
    107100void GLMenuImageScreen::setBackgroundImage (const char* backImageName)
    … …  
    110103}
    111104
    112 
    113105/**
    114106   \brief sets position of the ImageScreen
    115    \param x offset from the top left corner in percent(0-1) of the screensize
    116    \param y offset from the top left corner in percent(0-1) of the screensize
     107   \param offsetX offset from the top left corner in percent(0-1) of the screensize
     108   \param offsetY offset from the top left corner in percent(0-1) of the screensize
    117109*/
    118110void GLMenuImageScreen::setPosition(float offsetX, float offsetY)
    … …  
    122114}
    123115
    124 
    125 /*
     116/**
    126117  \brief sets size of the ImageScreen
    127118  \param scaleX the scaleing of the image into the x-direction (in percent (0-1))
    … …  
    134125}
    135126
    136 /*
     127/**
    137128  \brief sets position and size of the ImageScreen
    138   \param x offset from the top left corner in percent(0-1) of the screensize
    139   \param y offset from the top left corner in percent(0-1) of the screensize
     129  \param offsetX offset from the top left corner in percent(0-1) of the screensize
     130  \param offsetY offset from the top left corner in percent(0-1) of the screensize
    140131  \param scaleX the scaleing of the image into the x-direction (in percent (0-1))
    141132  \param scaleY the scaleing of the image into the y-direction (in percent (0-1))
    … …  
    173164/**
    174165   \brief set the maximum of countable steps
    175    \param maximum of steps
     166   \param maxValue of steps
    176167*/
    177168void GLMenuImageScreen::setMaximum(int maxValue)
    … …  
    180171}
    181172
    182 
    183 /**
    184    \brief gets the maximum of countable steps
    185 */
    186 int GLMenuImageScreen::getMaximum()
    187 {
    188   return this->maxValue;
    189 }
    190 
    191 
    192173/**
    193174   \brief set current value
    194    \param current value
     175   \param currentValue value to set
    195176*/
    196177void GLMenuImageScreen::setValue(int currentValue)

  • orxonox/trunk/src/glmenu/glmenu_imagescreen.h

    r4451 r4453  
    11/*!
    2     \file glmenu_imagescreen
    3     \brief class to display a image
     2    \file glmenu_imagescreen.h
     3    \brief class to display a LoadScreen
    44*/
    5 
    65
    76#ifndef _GLMENU_IMAGESCREEN_H
    … …  
    1312class TiXmlElement;
    1413
     14//! A class to display a loadScreen
    1515class GLMenuImageScreen : public BaseObject {
    1616
    … …  
    3434
    3535  void setMaximum (int maxValue);
    36   int getMaximum ();
     36  /** \returns the maximum of countable steps*/
     37  inline int GLMenuImageScreen::getMaximum(void) const { return this->maxValue; };
     38
    3739  void setValue (int currentValue);
    3840  int getValue ();
    … …  
    4143
    4244 private:
    43   char* backImageName;       //!< the name of the file of the background image
    44   float scaleX, scaleY;      //!< hight and width of the image
    45   float offsetX, offsetY;    //!< offset of the image from left and up
    46   Material* backMat;         //!< Background Material.
    47   float barX, barY, barW, barH; //!< Position and Scale of the bar.
    48   Material* barMat;          //!< A Material for the Loading-Bar
     45  // background image
     46  char*         backImageName;       //!< the name of the file of the background image
     47  float         offsetX;             //!< X-offset of the the image from the left
     48  float         offsetY;             //!< Y-offset of the image from the top
     49  float         scaleX;              //!< width of the image
     50  float         scaleY;              //!< height of the image
     51  Material*     backMat;             //!< Background Material.
     52
     53  // Load-Bar
     54  float         barX;                //!< X-position of the Bar
     55  float         barY;                //!< Y-position of the Bar
     56  float         barW;                //!< Width of the Bat
     57  float         barH;                //!< Height of the Bar.
     58  Material*     barMat;              //!< A Material for the Loading-Bar
    4959
    5060  /* progress bar values */
    51   int currentValue;          //!< the current count of step() calls fired yet
    52   int maxValue;              //!< total count of steps
     61  int           currentValue;        //!< the current count of step() calls fired yet
     62  int           maxValue;            //!< total count of steps
    5363
    5464};
Note: See TracChangeset for help on using the changeset viewer.