OgreBites::ParamsPanel Class Reference

Basic parameters panel widget. More...

#include <OgreTrays.h>

Inheritance diagram for OgreBites::ParamsPanel:

Public Member Functions
	ParamsPanel (const Ogre::String &name, Ogre::Real width, unsigned int lines)
	Do not instantiate any widgets directly. Use TrayManager. More...
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::StringVector &	getAllParamNames ()
const Ogre::StringVector &	getAllParamValues ()
const Ogre::String &	getName ()
Ogre::OverlayElement *	getOverlayElement ()
Ogre::DisplayString	getParamValue (const Ogre::DisplayString &paramName)
Ogre::DisplayString	getParamValue (unsigned int index)
TrayLocation	getTrayLocation ()
void	hide ()
bool	isVisible ()
void	setAllParamNames (const Ogre::StringVector &paramNames)
void	setAllParamValues (const Ogre::StringVector &paramValues)
void	setParamValue (const Ogre::DisplayString &paramName, const Ogre::DisplayString &paramValue)
void	setParamValue (unsigned int index, const Ogre::DisplayString &paramValue)
void	show ()

Static Public Member Functions
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 parameters panel widget.

Constructor & Destructor Documentation

ParamsPanel()

OgreBites::ParamsPanel::ParamsPanel	(	const Ogre::String &	name,
		Ogre::Real	width,
		unsigned int	lines
	)

Do not instantiate any widgets directly. Use TrayManager.

Member Function Documentation

setAllParamNames()

void OgreBites::ParamsPanel::setAllParamNames

(

const Ogre::StringVector &

paramNames

)

getAllParamNames()

const Ogre::StringVector& OgreBites::ParamsPanel::getAllParamNames ( )

inline

setAllParamValues()

void OgreBites::ParamsPanel::setAllParamValues

(

const Ogre::StringVector &

paramValues

)

setParamValue() [1/2]

void OgreBites::ParamsPanel::setParamValue	(	const Ogre::DisplayString &	paramName,
		const Ogre::DisplayString &	paramValue
	)

setParamValue() [2/2]

void OgreBites::ParamsPanel::setParamValue	(	unsigned int	index,
		const Ogre::DisplayString &	paramValue
	)

getParamValue() [1/2]

Ogre::DisplayString OgreBites::ParamsPanel::getParamValue

(

const Ogre::DisplayString &

paramName

)

getParamValue() [2/2]

Ogre::DisplayString OgreBites::ParamsPanel::getParamValue

(

unsigned int

index

)

getAllParamValues()

const Ogre::StringVector& OgreBites::ParamsPanel::getAllParamValues ( )

inline

cleanup()

void OgreBites::Widget::cleanup ( )

inherited

nukeOverlayElement()

static void OgreBites::Widget::nukeOverlayElement ( Ogre::OverlayElement *  element )

staticinherited

Static utility method to recursively delete an overlay element plus all of its children from the system.

isCursorOver()

static bool OgreBites::Widget::isCursorOver ( Ogre::OverlayElement *  element, const Ogre::Vector2 &  cursorPos, Ogre::Real  voidBorder = 0  )

staticinherited

Static utility method to check if the cursor is over an overlay element.

cursorOffset()

static Ogre::Vector2 OgreBites::Widget::cursorOffset ( Ogre::OverlayElement *  element, const Ogre::Vector2 &  cursorPos  )

staticinherited

Static utility method used to get the cursor's offset from the center of an overlay element in pixels.

getCaptionWidth()

static Ogre::Real OgreBites::Widget::getCaptionWidth ( const Ogre::DisplayString &  caption, Ogre::TextAreaOverlayElement *  area  )

staticinherited

Static utility method used to get the width of a caption in a text area.

fitCaptionToArea()

static void OgreBites::Widget::fitCaptionToArea ( const Ogre::DisplayString &  caption, Ogre::TextAreaOverlayElement *  area, Ogre::Real  maxWidth  )

staticinherited

Static utility method to cut off a string to fit in a text area.

getOverlayElement()

Ogre::OverlayElement* OgreBites::Widget::getOverlayElement ( )

inlineinherited

getName()

const Ogre::String& OgreBites::Widget::getName ( void  )

inlineinherited

getTrayLocation()

TrayLocation OgreBites::Widget::getTrayLocation ( )

inlineinherited

hide()

void OgreBites::Widget::hide ( )

inlineinherited

show()

void OgreBites::Widget::show ( )

inlineinherited

isVisible()

bool OgreBites::Widget::isVisible ( void  )

inlineinherited

_cursorPressed()

virtual void OgreBites::Widget::_cursorPressed ( const Ogre::Vector2 &  cursorPos )

inlinevirtualinherited

Reimplemented in OgreBites::CheckBox, OgreBites::Slider, OgreBites::Label, OgreBites::SelectMenu, OgreBites::TextBox, and OgreBites::Button.

_cursorReleased()

virtual void OgreBites::Widget::_cursorReleased ( const Ogre::Vector2 &  cursorPos )

inlinevirtualinherited

Reimplemented in OgreBites::Slider, OgreBites::SelectMenu, OgreBites::TextBox, and OgreBites::Button.

_cursorMoved()

virtual void OgreBites::Widget::_cursorMoved ( const Ogre::Vector2 &  cursorPos, float  wheelDelta  )

inlinevirtualinherited

Reimplemented in OgreBites::CheckBox, OgreBites::Slider, OgreBites::SelectMenu, OgreBites::TextBox, and OgreBites::Button.

_focusLost()

virtual void OgreBites::Widget::_focusLost ( )

inlinevirtualinherited

Reimplemented in OgreBites::CheckBox, OgreBites::Slider, OgreBites::SelectMenu, OgreBites::TextBox, and OgreBites::Button.

_assignToTray()

void OgreBites::Widget::_assignToTray ( TrayLocation  trayLoc )

inlineinherited

_assignListener()

void OgreBites::Widget::_assignListener ( TrayListener *  listener )

inlineinherited

---

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

• OgreTrays.h