OgreGFX::FELabel Class Reference

#include <widgets.h>

Inheritance diagram for OgreGFX::FELabel:

List of all members.

Public Member Functions
	FELabel (GraphicsInteractionManager *gim, std::string caption="FELabel", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Red, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=DEFAULT_LABEL_SIZE, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabel ()
virtual void	setCaption (std::string val)
virtual void	show ()
virtual void	hide ()
virtual void	posChanged ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
	FELabel (GraphicsInteractionManager *gim, std::string caption="FELabel", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Red, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=DEFAULT_LABEL_SIZE, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabel ()
void	setCaption (std::string val)
virtual void	show ()
virtual void	hide ()
virtual void	posChanged ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
	FELabel (GraphicsInteractionManager *gim, std::string caption="FELabel", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Red, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=DEFAULT_LABEL_SIZE, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabel ()
void	setCaption (std::string val)
virtual void	show ()
virtual void	hide ()
virtual void	posChanged ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
	FELabel (GraphicsInteractionManager *gim, std::string caption="FELabel", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Red, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=DEFAULT_LABEL_SIZE, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabel ()
void	setCaption (std::string val)
virtual void	show ()
virtual void	hide ()
virtual void	posChanged ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
	FELabel (GraphicsInteractionManager *gim, std::string caption="FELabel", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Red, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize=DEFAULT_LABEL_SIZE, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabel ()
void	setCaption (std::string val)
virtual void	show ()
virtual void	hide ()
virtual void	posChanged ()
virtual Ogre::OverlayElement *	getOverlayElementToAdd ()
Public Attributes
Ogre::OverlayManager *	overlayManagerPtr
std::string	caption
Ogre::ColourValue	color
Ogre::Vector2	offset
Ogre::TextAreaOverlayElement *	textArea
Ogre::OverlayManager *	overlayManagerPtr
Ogre::TextAreaOverlayElement *	textArea
Ogre::OverlayManager *	overlayManagerPtr
Ogre::TextAreaOverlayElement *	textArea
Ogre::OverlayManager *	overlayManagerPtr
Ogre::TextAreaOverlayElement *	textArea
Ogre::OverlayManager *	overlayManagerPtr
Ogre::TextAreaOverlayElement *	textArea

---

Detailed Description

A basic type of widget used for displaying text.

Definition at line 234 of file widgets.h.

---

Constructor & Destructor Documentation

OgreGFX::FELabel::FELabel	(	GraphicsInteractionManager *	gim,
		std::string	caption = "FELabel",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Red,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = DEFAULT_LABEL_SIZE,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a Label widget, which displays some text.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption	The text to display in the panel
	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.
	color	The color of the displayed text. Defaults to red
	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:

~FELabel()

Definition at line 235 of file widgets.cpp.

References color, DEBUG, OgreGFX::WidgetMgr::getNextId(), OgreGFX::Widget::gfx, offset, overlayManagerPtr, OgreGFX::Widget::pos, OgreGFX::Widget::size, textArea, and OgreGFX::GraphicsInteractionManager::widgetMgr.

OgreGFX::FELabel::~FELabel

(

)

Definition at line 257 of file widgets.cpp.

OgreGFX::FELabel::FELabel	(	GraphicsInteractionManager *	gim,
		std::string	caption = "FELabel",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Red,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = DEFAULT_LABEL_SIZE,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a Label widget, which displays some text.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption	The text to display in the panel
	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.
	color	The color of the displayed text. Defaults to red
	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:

~FELabel()

OgreGFX::FELabel::~FELabel

(

)

OgreGFX::FELabel::FELabel	(	GraphicsInteractionManager *	gim,
		std::string	caption = "FELabel",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Red,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = DEFAULT_LABEL_SIZE,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a Label widget, which displays some text.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption	The text to display in the panel
	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.
	color	The color of the displayed text. Defaults to red
	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:

~FELabel()

OgreGFX::FELabel::~FELabel

(

)

OgreGFX::FELabel::FELabel	(	GraphicsInteractionManager *	gim,
		std::string	caption = "FELabel",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Red,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = DEFAULT_LABEL_SIZE,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a Label widget, which displays some text.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption	The text to display in the panel
	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.
	color	The color of the displayed text. Defaults to red
	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:

~FELabel()

OgreGFX::FELabel::~FELabel

(

)

OgreGFX::FELabel::FELabel	(	GraphicsInteractionManager *	gim,
		std::string	caption = "FELabel",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Red,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultSize = DEFAULT_LABEL_SIZE,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a Label widget, which displays some text.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption	The text to display in the panel
	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.
	color	The color of the displayed text. Defaults to red
	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:

~FELabel()

OgreGFX::FELabel::~FELabel

(

)

---

Member Function Documentation

void OgreGFX::FELabel::setCaption

(

std::string

val

)

[virtual]

Size of the text area within the widget, defined by widget size - offset

Sets the text displayed by the label.

Parameters:

val

The string to display

Returns:

void

Reimplemented in OgreGFX::FELineWrapLabel.

Definition at line 261 of file widgets.cpp.

References caption, and textArea.

Referenced by OgreGFX::FELabelPair::setLeft(), and OgreGFX::FELabelPair::setRight().

void OgreGFX::FELabel::show

(

)

[virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented from OgreGFX::Widget.

Definition at line 267 of file widgets.cpp.

References DEBUG.

Referenced by OgreGFX::WidgetMgr::initialize(), and OgreGFX::FELabelPair::show().

void OgreGFX::FELabel::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::Widget.

Definition at line 272 of file widgets.cpp.

References textArea.

Referenced by OgreGFX::FELabelPair::hide().

void OgreGFX::FELabel::posChanged

(

)

[virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented from OgreGFX::Widget.

Definition at line 280 of file widgets.cpp.

References OgreGFX::Widget::pos, and textArea.

Ogre::OverlayElement * OgreGFX::FELabel::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 276 of file widgets.cpp.

References textArea.

void OgreGFX::FELabel::setCaption

(

std::string

val

)

Size of the text area within the widget, defined by widget size - offset

Sets the text displayed by the label.

Parameters:

val

The string to display

Returns:

void

Reimplemented in OgreGFX::FELineWrapLabel.

virtual void OgreGFX::FELabel::show

(

)

[virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented from OgreGFX::Widget.

virtual void OgreGFX::FELabel::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::Widget.

virtual void OgreGFX::FELabel::posChanged

(

)

[virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented from OgreGFX::Widget.

virtual Ogre::OverlayElement* OgreGFX::FELabel::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.

void OgreGFX::FELabel::setCaption

(

std::string

val

)

Size of the text area within the widget, defined by widget size - offset

Sets the text displayed by the label.

Parameters:

val

The string to display

Returns:

void

Reimplemented in OgreGFX::FELineWrapLabel.

virtual void OgreGFX::FELabel::show

(

)

[virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented from OgreGFX::Widget.

virtual void OgreGFX::FELabel::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::Widget.

virtual void OgreGFX::FELabel::posChanged

(

)

[virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented from OgreGFX::Widget.

virtual Ogre::OverlayElement* OgreGFX::FELabel::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.

void OgreGFX::FELabel::setCaption

(

std::string

val

)

Size of the text area within the widget, defined by widget size - offset

Sets the text displayed by the label.

Parameters:

val

The string to display

Returns:

void

Reimplemented in OgreGFX::FELineWrapLabel.

virtual void OgreGFX::FELabel::show

(

)

[virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented from OgreGFX::Widget.

virtual void OgreGFX::FELabel::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::Widget.

virtual void OgreGFX::FELabel::posChanged

(

)

[virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented from OgreGFX::Widget.

virtual Ogre::OverlayElement* OgreGFX::FELabel::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.

void OgreGFX::FELabel::setCaption

(

std::string

val

)

Size of the text area within the widget, defined by widget size - offset

Sets the text displayed by the label.

Parameters:

val

The string to display

Returns:

void

Reimplemented in OgreGFX::FELineWrapLabel.

virtual void OgreGFX::FELabel::show

(

)

[virtual]

Draws and displays the widget and all sub-elements.

See also:

hide()

Reimplemented from OgreGFX::Widget.

virtual void OgreGFX::FELabel::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::Widget.

virtual void OgreGFX::FELabel::posChanged

(

)

[virtual]

Updates the relative position of all sub-elements/widgets

See also:

screenPos()

Reimplemented from OgreGFX::Widget.

virtual Ogre::OverlayElement* OgreGFX::FELabel::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.

---

Member Data Documentation

Ogre::OverlayManager* OgreGFX::FELabel::overlayManagerPtr

Definition at line 253 of file widgets.h.

Referenced by FELabel().

std::string OgreGFX::FELabel::caption

Definition at line 254 of file widgets.h.

Referenced by OgreGFX::WidgetMgr::frameRenderingQueued(), OgreGFX::WidgetMgr::mouseOverButton(), OgreGFX::FELineWrapLabel::setCaption(), and setCaption().

Ogre::ColourValue OgreGFX::FELabel::color

The text displayed by the label

Definition at line 255 of file widgets.h.

Referenced by FELabel().

Ogre::Vector2 OgreGFX::FELabel::offset

The color of the text displayed

Definition at line 256 of file widgets.h.

Referenced by FELabel().

Ogre::TextAreaOverlayElement* OgreGFX::FELabel::textArea

Distance the text should stay away from the edges of the widget.

Definition at line 257 of file widgets.h.

Referenced by OgreGFX::WidgetMgr::activateMenu(), FELabel(), OgreGFX::FELineWrapLabel::FELineWrapLabel(), OgreGFX::WidgetMgr::frameRenderingQueued(), getOverlayElementToAdd(), hide(), OgreGFX::WidgetMgr::mouseOverButton(), posChanged(), OgreGFX::FELineWrapLabel::setCaption(), and setCaption().

Ogre::OverlayManager* OgreGFX::FELabel::overlayManagerPtr

Definition at line 220 of file widgets.h.

Ogre::TextAreaOverlayElement* OgreGFX::FELabel::textArea

Distance the text should stay away from the edges of the widget.

Definition at line 224 of file widgets.h.

Ogre::OverlayManager* OgreGFX::FELabel::overlayManagerPtr

Definition at line 220 of file widgets.h.

Ogre::TextAreaOverlayElement* OgreGFX::FELabel::textArea

Distance the text should stay away from the edges of the widget.

Definition at line 224 of file widgets.h.

Ogre::OverlayManager* OgreGFX::FELabel::overlayManagerPtr

Definition at line 220 of file widgets.h.

Ogre::TextAreaOverlayElement* OgreGFX::FELabel::textArea

Distance the text should stay away from the edges of the widget.

Definition at line 224 of file widgets.h.

Ogre::OverlayManager* OgreGFX::FELabel::overlayManagerPtr

Definition at line 220 of file widgets.h.

Ogre::TextAreaOverlayElement* OgreGFX::FELabel::textArea

Distance the text should stay away from the edges of the widget.

Definition at line 224 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

---