OgreGFX::FEProgressBar Class Reference

#include <widgets.h>

Inheritance diagram for OgreGFX::FEProgressBar:

List of all members.

Public Member Functions
	FEProgressBar (GraphicsInteractionManager *gim, std::string name="FEProgressBar", Widget *aParent=0, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=Ogre::Vector2::NEGATIVE_UNIT_X, std::string barMaterial=DEFAULT_PANEL_MATERIAL, std::string fillMaterial=DEFAULT_PANEL_MATERIAL, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FEProgressBar ()
void	UpdateFillPercent ()
virtual void	show ()
virtual void	hide ()
virtual void	posChanged ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
Public Attributes
Ogre::OverlayManager *	overlayManagerPtr
Ogre::OverlayContainer *	progressBar
std::string	barMaterial
std::string	fillMaterial
std::string	name
double	percentFull

---

Detailed Description

Definition at line 132 of file widgets.h.

---

Constructor & Destructor Documentation

OgreGFX::FEProgressBar::FEProgressBar	(	GraphicsInteractionManager *	gim,
		std::string	name = "FEProgressBar",
		Widget *	aParent = 0,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = Ogre::Vector2::NEGATIVE_UNIT_X,
		std::string	barMaterial = DEFAULT_PANEL_MATERIAL,
		std::string	fillMaterial = DEFAULT_PANEL_MATERIAL,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Definition at line 592 of file widgets.cpp.

References OgreGFX::WidgetMgr::getNextId(), OgreGFX::Widget::gfx, overlayManagerPtr, percentFull, OgreGFX::Widget::pos, progressBar, OgreGFX::Widget::size, UpdateFillPercent(), and OgreGFX::GraphicsInteractionManager::widgetMgr.

OgreGFX::FEProgressBar::~FEProgressBar

(

)

---

Member Function Documentation

void OgreGFX::FEProgressBar::UpdateFillPercent

(

)

Definition at line 620 of file widgets.cpp.

References percentFull, and progressBar.

Referenced by FEProgressBar(), and OgreGFX::WidgetMgr::frameRenderingQueued().

void OgreGFX::FEProgressBar::show

(

)

[virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented from OgreGFX::Widget.

Definition at line 627 of file widgets.cpp.

References progressBar.

Referenced by OgreGFX::WidgetMgr::initialize().

void OgreGFX::FEProgressBar::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::Widget.

Definition at line 633 of file widgets.cpp.

References progressBar.

void OgreGFX::FEProgressBar::posChanged

(

)

[virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented from OgreGFX::Widget.

Definition at line 638 of file widgets.cpp.

References progressBar.

Ogre::OverlayElement * OgreGFX::FEProgressBar::getOverlayElementToAdd

(

)

[virtual]

Returns the overlay element used to display the widgets appearance.

Returns:

Pointer to the resource that displays the widgets appearance.

Reimplemented from OgreGFX::Widget.

Definition at line 644 of file widgets.cpp.

References progressBar.

---

Member Data Documentation

Ogre::OverlayManager* OgreGFX::FEProgressBar::overlayManagerPtr

Definition at line 143 of file widgets.h.

Referenced by FEProgressBar().

Ogre::OverlayContainer* OgreGFX::FEProgressBar::progressBar

Definition at line 144 of file widgets.h.

Referenced by FEProgressBar(), getOverlayElementToAdd(), hide(), posChanged(), show(), and UpdateFillPercent().

std::string OgreGFX::FEProgressBar::barMaterial

Definition at line 146 of file widgets.h.

std::string OgreGFX::FEProgressBar::fillMaterial

The name of the texture to display

Definition at line 147 of file widgets.h.

std::string OgreGFX::FEProgressBar::name

The name of the texture to display

Definition at line 148 of file widgets.h.

double OgreGFX::FEProgressBar::percentFull

The name given to this progress bar

Definition at line 149 of file widgets.h.

Referenced by OgreGFX::WidgetMgr::deactivateMenu(), FEProgressBar(), OgreGFX::WidgetMgr::frameRenderingQueued(), and UpdateFillPercent().

---

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

• /misc/grads/caballinger/svn_repos/FastECSLent/hooks/TempLocalCopy/branch/caballinger/FastEcslent/includes/gfx/widgets.h
• /misc/grads/caballinger/svn_repos/FastECSLent/hooks/TempLocalCopy/branch/caballinger/FastEcslent/src/gfx/widgets.cpp

---