Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

orxonox/trunk: docu for the image_screen

File:
1 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)
Note: See TracChangeset for help on using the changeset viewer.