OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
OgreBites::ProgressBar Class Reference

Basic progress bar widget. More...

#include <OgreTrays.h>

+ Inheritance diagram for OgreBites::ProgressBar:

Public Member Functions

 ProgressBar (const Ogre::String &name, const Ogre::DisplayString &caption, Ogre::Real width, Ogre::Real commentBoxWidth)
 Do not instantiate any widgets directly. Use TrayManager. More...
 
const Ogre::DisplayStringgetCaption ()
 
const Ogre::DisplayStringgetComment ()
 
Ogre::Real getProgress ()
 Gets the progress as a percentage. More...
 
void setCaption (const Ogre::DisplayString &caption)
 
void setComment (const Ogre::DisplayString &comment)
 
void setProgress (Ogre::Real progress)
 Sets the progress as a percentage. More...
 
- Public Member Functions inherited from OgreBites::Widget
 Widget ()
 
virtual ~Widget ()
 
void _assignListener (TrayListener *listener)
 
void _assignToTray (TrayLocation trayLoc)
 
virtual void _cursorMoved (const Ogre::Vector2 &cursorPos, float wheelDelta)
 
virtual void _cursorPressed (const Ogre::Vector2 &cursorPos)
 
virtual void _cursorReleased (const Ogre::Vector2 &cursorPos)
 
virtual void _focusLost ()
 
void cleanup ()
 
const Ogre::StringgetName ()
 
Ogre::OverlayElementgetOverlayElement ()
 
TrayLocation getTrayLocation ()
 
void hide ()
 
bool isVisible ()
 
void show ()
 

Additional Inherited Members

- Static Public Member Functions inherited from OgreBites::Widget
static Ogre::Vector2 cursorOffset (Ogre::OverlayElement *element, const Ogre::Vector2 &cursorPos)
 Static utility method used to get the cursor's offset from the center of an overlay element in pixels. More...
 
static void fitCaptionToArea (const Ogre::DisplayString &caption, Ogre::TextAreaOverlayElement *area, Ogre::Real maxWidth)
 Static utility method to cut off a string to fit in a text area. More...
 
static Ogre::Real getCaptionWidth (const Ogre::DisplayString &caption, Ogre::TextAreaOverlayElement *area)
 Static utility method used to get the width of a caption in a text area. More...
 
static bool isCursorOver (Ogre::OverlayElement *element, const Ogre::Vector2 &cursorPos, Ogre::Real voidBorder=0)
 Static utility method to check if the cursor is over an overlay element. More...
 
static void nukeOverlayElement (Ogre::OverlayElement *element)
 Static utility method to recursively delete an overlay element plus all of its children from the system. More...
 

Detailed Description

Basic progress bar widget.

Constructor & Destructor Documentation

◆ ProgressBar()

OgreBites::ProgressBar::ProgressBar ( const Ogre::String name,
const Ogre::DisplayString caption,
Ogre::Real  width,
Ogre::Real  commentBoxWidth 
)

Do not instantiate any widgets directly. Use TrayManager.

Member Function Documentation

◆ setProgress()

void OgreBites::ProgressBar::setProgress ( Ogre::Real  progress)

Sets the progress as a percentage.

◆ getProgress()

Ogre::Real OgreBites::ProgressBar::getProgress ( )
inline

Gets the progress as a percentage.

◆ getCaption()

const Ogre::DisplayString& OgreBites::ProgressBar::getCaption ( )
inline

◆ setCaption()

void OgreBites::ProgressBar::setCaption ( const Ogre::DisplayString caption)
inline

◆ getComment()

const Ogre::DisplayString& OgreBites::ProgressBar::getComment ( )
inline

◆ setComment()

void OgreBites::ProgressBar::setComment ( const Ogre::DisplayString comment)
inline

The documentation for this class was generated from the following file: