OgreGFX::Widget Class Reference

#include <widgets.h>

Inheritance diagram for OgreGFX::Widget:

List of all members.

Public Member Functions
	Widget (GraphicsInteractionManager *gim, Widget *aParent=0, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~Widget ()
Ogre::Vector2	screenPos ()
bool	cursonInMe (const Ogre::Vector2 &pos)
virtual void	posChanged ()
virtual void	show ()
virtual void	hide ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
	Widget (GraphicsInteractionManager *gim, Widget *aParent=0, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~Widget ()
Ogre::Vector2	screenPos ()
bool	cursonInMe (const Ogre::Vector2 &pos)
virtual void	posChanged ()
virtual void	show ()
virtual void	hide ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
	Widget (GraphicsInteractionManager *gim, Widget *aParent=0, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~Widget ()
Ogre::Vector2	screenPos ()
bool	cursonInMe (const Ogre::Vector2 &pos)
virtual void	posChanged ()
virtual void	show ()
virtual void	hide ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
	Widget (GraphicsInteractionManager *gim, Widget *aParent=0, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~Widget ()
Ogre::Vector2	screenPos ()
bool	cursonInMe (const Ogre::Vector2 &pos)
virtual void	posChanged ()
virtual void	show ()
virtual void	hide ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
	Widget (GraphicsInteractionManager *gim, Widget *aParent=0, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~Widget ()
Ogre::Vector2	screenPos ()
bool	cursonInMe (const Ogre::Vector2 &pos)
virtual void	posChanged ()
virtual void	show ()
virtual void	hide ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
Public Attributes
Ogre::Vector2	pos
Ogre::Vector2	size
Widget *	parent
GraphicsInteractionManager *	gfx
Ogre::GuiMetricsMode	mode
std::string	desc
Widget *	parent
GraphicsInteractionManager *	gfx
Widget *	parent
GraphicsInteractionManager *	gfx
Widget *	parent
GraphicsInteractionManager *	gfx
Widget *	parent
GraphicsInteractionManager *	gfx

---

Detailed Description

The base class for all GUI interface elements. This class mostly provides virtual interfaces for subclasses to implement later. However, the Widget class does implement a few basic functions related to positioning.

Definition at line 44 of file widgets.h.

---

Constructor & Destructor Documentation

OgreGFX::Widget::Widget	(	GraphicsInteractionManager *	gim,
		Widget *	aParent = 0,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Description of the widget to display to the user

Constructor for basic widget requirements.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	aParent	a pointer to the parent node, if any (null if this is a root element, or pointer to another widget if this is a child of that widget). Defaults to NULL.
	defaultPos	Upper-right corner position of the widget, in absolute coordinates if this is a parent node, or relative to the parent node if this is a child node.
	defaultSize	length and height of the widget.
	defaultMode	Mode for how size/position are interpreted (relative/absolute)

See also:

~Widget()

Returns:

void

Definition at line 18 of file widgets.cpp.

References desc, gfx, mode, parent, pos, and size.

OgreGFX::Widget::~Widget

(

)

Definition at line 37 of file widgets.cpp.

OgreGFX::Widget::Widget	(	GraphicsInteractionManager *	gim,
		Widget *	aParent = 0,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Description of the widget to display tot he user

Constructor for basic widget requirements.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	aParent	a pointer to the parent node, if any (null if this is a root element, or pointer to another widget if this is a child of that widget). Defaults to NULL.
	defaultPos	Upper-right corner position of the widget, in absolute coordinates if this is a parent node, or relative to the parent node if this is a child node.
	defaultSize	length and height of the widget.

See also:

~Widget()

Returns:

void

OgreGFX::Widget::~Widget

(

)

OgreGFX::Widget::Widget	(	GraphicsInteractionManager *	gim,
		Widget *	aParent = 0,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Description of the widget to display tot he user

Constructor for basic widget requirements.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	aParent	a pointer to the parent node, if any (null if this is a root element, or pointer to another widget if this is a child of that widget). Defaults to NULL.
	defaultPos	Upper-right corner position of the widget, in absolute coordinates if this is a parent node, or relative to the parent node if this is a child node.
	defaultSize	length and height of the widget.

See also:

~Widget()

Returns:

void

OgreGFX::Widget::~Widget

(

)

OgreGFX::Widget::Widget	(	GraphicsInteractionManager *	gim,
		Widget *	aParent = 0,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Description of the widget to display tot he user

Constructor for basic widget requirements.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	aParent	a pointer to the parent node, if any (null if this is a root element, or pointer to another widget if this is a child of that widget). Defaults to NULL.
	defaultPos	Upper-right corner position of the widget, in absolute coordinates if this is a parent node, or relative to the parent node if this is a child node.
	defaultSize	length and height of the widget.

See also:

~Widget()

Returns:

void

OgreGFX::Widget::~Widget

(

)

OgreGFX::Widget::Widget	(	GraphicsInteractionManager *	gim,
		Widget *	aParent = 0,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Description of the widget to display tot he user

Constructor for basic widget requirements.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	aParent	a pointer to the parent node, if any (null if this is a root element, or pointer to another widget if this is a child of that widget). Defaults to NULL.
	defaultPos	Upper-right corner position of the widget, in absolute coordinates if this is a parent node, or relative to the parent node if this is a child node.
	defaultSize	length and height of the widget.

See also:

~Widget()

Returns:

void

OgreGFX::Widget::~Widget

(

)

---

Member Function Documentation

Ogre::Vector2 OgreGFX::Widget::screenPos

(

)

Function to return the widget's upper-right corner position. Position returned is always in absolute screen coordinates, regardless of widget being a parent or child node.

See also:

pos

Returns:

Vector2 of the absolute screen coordinates of the widget's upper-right corner.

Definition at line 41 of file widgets.cpp.

References parent, pos, and screenPos().

Referenced by cursonInMe(), and screenPos().

bool OgreGFX::Widget::cursonInMe

(

const Ogre::Vector2 &

pos

)

Function to check if the mouse is currently inside the widget's area.

Parameters:

pos

Current absolute screen position of the mouse cursor.

See also:

screenPos()

Returns:

True if the mouse is inside the widget at the time the function is called, false otherwise.

Definition at line 49 of file widgets.cpp.

References DEBUG, gfx, OgreGFX::GraphicsInteractionManager::mWindow, screenPos(), and size.

Referenced by OgreGFX::FEMarineButton::handleMouseEvent(), OgreGFX::FESCVButton::handleMouseEvent(), OgreGFX::FEButton::handleMouseEvent(), and OgreGFX::WidgetMgr::mouseOverOverlay().

virtual void OgreGFX::Widget::posChanged

(

)

[inline, virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 87 of file widgets.h.

Referenced by OgreGFX::FEPanel::addItem().

virtual void OgreGFX::Widget::show

(

)

[inline, virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 95 of file widgets.h.

virtual void OgreGFX::Widget::hide

(

)

[inline, virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 103 of file widgets.h.

virtual Ogre::OverlayElement* OgreGFX::Widget::getOverlayElementToAdd

(

)

[inline, virtual]

Returns the overlay element used to display the widgets appearance.

Returns:

Pointer to the resource that displays the widgets appearance.

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 111 of file widgets.h.

Referenced by OgreGFX::FEPanel::addItem().

Ogre::Vector2 OgreGFX::Widget::screenPos

(

)

Function to return the widget's upper-right corner position. Position returned is always in absolute screen coordinates, regardless of widget being a parent or child node.

See also:

pos

Returns:

Vector2 of the absolute screen coordinates of the widget's upper-right corner.

bool OgreGFX::Widget::cursonInMe

(

const Ogre::Vector2 &

pos

)

Function to check if the mouse is currently inside the widget's area.

Parameters:

pos

Current absolute screen position of the mouse cursor.

See also:

screenPos()

Returns:

True if the mouse is inside the widget at the time the function is called, false otherwise.

virtual void OgreGFX::Widget::posChanged

(

)

[inline, virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 83 of file widgets.h.

virtual void OgreGFX::Widget::show

(

)

[inline, virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 91 of file widgets.h.

virtual void OgreGFX::Widget::hide

(

)

[inline, virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 99 of file widgets.h.

virtual Ogre::OverlayElement* OgreGFX::Widget::getOverlayElementToAdd

(

)

[inline, virtual]

Returns the overlay element used to display the widgets appearance.

Returns:

Pointer to the resource that displays the widgets appearance.

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 107 of file widgets.h.

Ogre::Vector2 OgreGFX::Widget::screenPos

(

)

Function to return the widget's upper-right corner position. Position returned is always in absolute screen coordinates, regardless of widget being a parent or child node.

See also:

pos

Returns:

Vector2 of the absolute screen coordinates of the widget's upper-right corner.

bool OgreGFX::Widget::cursonInMe

(

const Ogre::Vector2 &

pos

)

Function to check if the mouse is currently inside the widget's area.

Parameters:

pos

Current absolute screen position of the mouse cursor.

See also:

screenPos()

Returns:

True if the mouse is inside the widget at the time the function is called, false otherwise.

virtual void OgreGFX::Widget::posChanged

(

)

[inline, virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 83 of file widgets.h.

virtual void OgreGFX::Widget::show

(

)

[inline, virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 91 of file widgets.h.

virtual void OgreGFX::Widget::hide

(

)

[inline, virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 99 of file widgets.h.

virtual Ogre::OverlayElement* OgreGFX::Widget::getOverlayElementToAdd

(

)

[inline, virtual]

Returns the overlay element used to display the widgets appearance.

Returns:

Pointer to the resource that displays the widgets appearance.

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 107 of file widgets.h.

Ogre::Vector2 OgreGFX::Widget::screenPos

(

)

Function to return the widget's upper-right corner position. Position returned is always in absolute screen coordinates, regardless of widget being a parent or child node.

See also:

pos

Returns:

Vector2 of the absolute screen coordinates of the widget's upper-right corner.

bool OgreGFX::Widget::cursonInMe

(

const Ogre::Vector2 &

pos

)

Function to check if the mouse is currently inside the widget's area.

Parameters:

pos

Current absolute screen position of the mouse cursor.

See also:

screenPos()

Returns:

True if the mouse is inside the widget at the time the function is called, false otherwise.

virtual void OgreGFX::Widget::posChanged

(

)

[inline, virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 83 of file widgets.h.

virtual void OgreGFX::Widget::show

(

)

[inline, virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 91 of file widgets.h.

virtual void OgreGFX::Widget::hide

(

)

[inline, virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 99 of file widgets.h.

virtual Ogre::OverlayElement* OgreGFX::Widget::getOverlayElementToAdd

(

)

[inline, virtual]

Returns the overlay element used to display the widgets appearance.

Returns:

Pointer to the resource that displays the widgets appearance.

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 107 of file widgets.h.

Ogre::Vector2 OgreGFX::Widget::screenPos

(

)

Function to return the widget's upper-right corner position. Position returned is always in absolute screen coordinates, regardless of widget being a parent or child node.

See also:

pos

Returns:

Vector2 of the absolute screen coordinates of the widget's upper-right corner.

bool OgreGFX::Widget::cursonInMe

(

const Ogre::Vector2 &

pos

)

Function to check if the mouse is currently inside the widget's area.

Parameters:

pos

Current absolute screen position of the mouse cursor.

See also:

screenPos()

Returns:

True if the mouse is inside the widget at the time the function is called, false otherwise.

virtual void OgreGFX::Widget::posChanged

(

)

[inline, virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 83 of file widgets.h.

virtual void OgreGFX::Widget::show

(

)

[inline, virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 91 of file widgets.h.

virtual void OgreGFX::Widget::hide

(

)

[inline, virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented in OgreGFX::UIOutline, OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, OgreGFX::FELabelPair, OgreGFX::UIOutline, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEButton, and OgreGFX::FELabelPair.

Definition at line 99 of file widgets.h.

virtual Ogre::OverlayElement* OgreGFX::Widget::getOverlayElementToAdd

(

)

[inline, virtual]

Returns the overlay element used to display the widgets appearance.

Returns:

Pointer to the resource that displays the widgets appearance.

Reimplemented in OgreGFX::FEProgressBar, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, OgreGFX::FELabel, OgreGFX::FEPanel, and OgreGFX::FELabel.

Definition at line 107 of file widgets.h.

---

Member Data Documentation

Ogre::Vector2 OgreGFX::Widget::pos

Definition at line 47 of file widgets.h.

Referenced by OgreGFX::FEPanel::addItem(), OgreGFX::FELabel::FELabel(), OgreGFX::FEPanel::FEPanel(), OgreGFX::FEProgressBar::FEProgressBar(), OgreGFX::FELabel::posChanged(), screenPos(), OgreGFX::UIOutline::UIOutline(), and Widget().

Ogre::Vector2 OgreGFX::Widget::size

Upper-right corner position of the widget, in absolute coordinates if this is a parent node, or relative to the parent node if this is a child node

Definition at line 48 of file widgets.h.

Referenced by OgreGFX::FEPanel::addItem(), cursonInMe(), OgreGFX::FELabel::FELabel(), OgreGFX::FELineWrapLabel::FELineWrapLabel(), OgreGFX::FEPanel::FEPanel(), OgreGFX::FEProgressBar::FEProgressBar(), OgreGFX::UIOutline::UIOutline(), and Widget().

Widget* OgreGFX::Widget::parent

length and height of the widget

Definition at line 49 of file widgets.h.

Referenced by screenPos(), and Widget().

GraphicsInteractionManager* OgreGFX::Widget::gfx

Parent node, if any

Definition at line 50 of file widgets.h.

Referenced by cursonInMe(), OgreGFX::FELabel::FELabel(), OgreGFX::FEPanel::FEPanel(), OgreGFX::FEProgressBar::FEProgressBar(), OgreGFX::FEMarineButton::handleMouseEvent(), OgreGFX::FESCVButton::handleMouseEvent(), OgreGFX::FEButton::handleMouseEvent(), OgreGFX::FEPanel::makeSep(), OgreGFX::FEButton::processButtonFirstEvent(), OgreGFX::FEButton::processButtonSecondEvent(), OgreGFX::UIOutline::UIOutline(), and Widget().

Ogre::GuiMetricsMode OgreGFX::Widget::mode

Graphics interaction manager singleton

Definition at line 51 of file widgets.h.

Referenced by Widget().

std::string OgreGFX::Widget::desc

Definition at line 52 of file widgets.h.

Referenced by Widget().

Widget* OgreGFX::Widget::parent

length and height of the widget

Definition at line 46 of file widgets.h.

GraphicsInteractionManager* OgreGFX::Widget::gfx

Parent node, if any

Definition at line 47 of file widgets.h.

Widget* OgreGFX::Widget::parent

length and height of the widget

Definition at line 46 of file widgets.h.

GraphicsInteractionManager* OgreGFX::Widget::gfx

Parent node, if any

Definition at line 47 of file widgets.h.

Widget* OgreGFX::Widget::parent

length and height of the widget

Definition at line 46 of file widgets.h.

GraphicsInteractionManager* OgreGFX::Widget::gfx

Parent node, if any

Definition at line 47 of file widgets.h.

Widget* OgreGFX::Widget::parent

length and height of the widget

Definition at line 46 of file widgets.h.

GraphicsInteractionManager* OgreGFX::Widget::gfx

Parent node, if any

Definition at line 47 of file widgets.h.

---

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/cagri/FastEcslent/includes/gfx/widgets.h
• /misc/grads/caballinger/svn_repos/FastECSLent/hooks/TempLocalCopy/branch/cagri77/FastEcslent/includes/gfx/widgets.h
• /misc/grads/caballinger/svn_repos/FastECSLent/hooks/TempLocalCopy/branch/simingl/includes/gfx/widgets.h
• includes/gfx/widgets.h
• /misc/grads/caballinger/svn_repos/FastECSLent/hooks/TempLocalCopy/branch/caballinger/FastEcslent/src/gfx/widgets.cpp
• /misc/grads/caballinger/svn_repos/FastECSLent/hooks/TempLocalCopy/branch/cagri/FastEcslent/src/gfx/widgets.cpp
• /misc/grads/caballinger/svn_repos/FastECSLent/hooks/TempLocalCopy/branch/cagri77/FastEcslent/src/gfx/widgets.cpp
• /misc/grads/caballinger/svn_repos/FastECSLent/hooks/TempLocalCopy/branch/simingl/src/gfx/widgets.cpp
• src/gfx/widgets.cpp

---