OgreGFX::FELabelPair Class Reference

#include <widgets.h>

Inheritance diagram for OgreGFX::FELabelPair:

List of all members.

Public Member Functions
	FELabelPair (GraphicsInteractionManager *gim, std::string caption1="Key", std::string caption2="Value", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Green, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultColumnWidths=Ogre::Vector2(100, 200), int columnHeight=DEFAULT_LABEL_SIZE.y, std::string materialName=DEFAULT_PANEL_MATERIAL, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabelPair ()
virtual void	show ()
virtual void	hide ()
void	setLeft (std::string val)
void	setRight (std::string val)
	FELabelPair (GraphicsInteractionManager *gim, std::string caption1="Key", std::string caption2="Value", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Green, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultColumnWidths=Ogre::Vector2(100, 200), int columnHeight=DEFAULT_LABEL_SIZE.y, std::string materialName=DEFAULT_PANEL_MATERIAL, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabelPair ()
virtual void	show ()
virtual void	hide ()
void	setLeft (std::string val)
void	setRight (std::string val)
	FELabelPair (GraphicsInteractionManager *gim, std::string caption1="Key", std::string caption2="Value", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Green, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultColumnWidths=Ogre::Vector2(100, 200), int columnHeight=DEFAULT_LABEL_SIZE.y, std::string materialName=DEFAULT_PANEL_MATERIAL, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabelPair ()
virtual void	show ()
virtual void	hide ()
void	setLeft (std::string val)
void	setRight (std::string val)
	FELabelPair (GraphicsInteractionManager *gim, std::string caption1="Key", std::string caption2="Value", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Green, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultColumnWidths=Ogre::Vector2(100, 200), int columnHeight=DEFAULT_LABEL_SIZE.y, std::string materialName=DEFAULT_PANEL_MATERIAL, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabelPair ()
virtual void	show ()
virtual void	hide ()
void	setLeft (std::string val)
void	setRight (std::string val)
	FELabelPair (GraphicsInteractionManager *gim, std::string caption1="Key", std::string caption2="Value", Widget *aParent=0, Ogre::ColourValue color=Ogre::ColourValue::Green, Ogre::Vector2 defaultPos=Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultColumnWidths=Ogre::Vector2(100, 200), int columnHeight=DEFAULT_LABEL_SIZE.y, std::string materialName=DEFAULT_PANEL_MATERIAL, Ogre::GuiMetricsMode defaultMode=Ogre::GMM_RELATIVE)
	~FELabelPair ()
virtual void	show ()
virtual void	hide ()
void	setLeft (std::string val)
void	setRight (std::string val)
Public Attributes
FELabel *	left
FELabel *	right
FELabel *	left
FELabel *	left
FELabel *	left
FELabel *	left

---

Detailed Description

A widget which can display text or an image, and detects when a mouse click occurs inside its area. If a mouse event does occur in its area, a function associated with that button is called. Buttons consume the mouse click, so the mouse click doesn't get passed on to any units that might exist beneath the overlay.

Constructor for a Button widget, which displays some text. Clicking on the text causes a function to be called to perform some task.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	modifierKeys	Pointer to a configuration of keyboard keys that must all be pressed for the button handler to be called.
	oisMouseButtonId	The ID of the mouse button that must be pressed for the button handler to be called.
	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.
	pClickFunction	Pointer to a function, which is called when the button handler is called.

See also:

~FEButton()

Mouse handler called when a mouse event occurs.

Parameters:

args

Information about the mouse state (mouse button, cursor position, etc).

Returns:

void

A Button widget that creates an SCV near the currently selected unit.

Constructor for a SCV button, which builds an SCV near the selected structure.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	modifierKeys	Pointer to a configuration of keyboard keys that must all be pressed for the button handler to be called.
	oisMouseButtonId	The ID of the mouse button that must be pressed for the button handler to be called.
	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:

~FESCVButton()

A Button widget that creates a Marine near the currently selected unit.

Constructor for a Marine button, which builds an Marine near the selected structure.

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	modifierKeys	Pointer to a configuration of keyboard keys that must all be pressed for the button handler to be called.
	oisMouseButtonId	The ID of the mouse button that must be pressed for the button handler to be called.
	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:

~FEMarineButton()

A Panel widget specialized to display two labels horizontally adjacent. Made up to two label widgets.

A Panel widget specialized to display two labels horizontally adjacent. Made up to two label widgets.

Definition at line 438 of file widgets.h.

---

Constructor & Destructor Documentation

OgreGFX::FELabelPair::FELabelPair	(	GraphicsInteractionManager *	gim,
		std::string	caption1 = "Key",
		std::string	caption2 = "Value",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Green,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultColumnWidths = Ogre::Vector2(100, 200),
		int	columnHeight = DEFAULT_LABEL_SIZE.y,
		std::string	materialName = DEFAULT_PANEL_MATERIAL,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a pair of labels, displayed side by side

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption1	The left-most text to display.
	caption2	The right-most text to display.
	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 green.
	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.
	defaultColumnWidths	default width of the panel containing both labels
	columnHeight	default height of the panel containing both labels

See also:

~FEMarineButton()

Definition at line 556 of file widgets.cpp.

References OgreGFX::FEPanel::addItem(), OgreGFX::Below, left, OgreGFX::Right, and right.

OgreGFX::FELabelPair::~FELabelPair

(

)

[inline]

Definition at line 461 of file widgets.h.

OgreGFX::FELabelPair::FELabelPair	(	GraphicsInteractionManager *	gim,
		std::string	caption1 = "Key",
		std::string	caption2 = "Value",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Green,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultColumnWidths = Ogre::Vector2(100, 200),
		int	columnHeight = DEFAULT_LABEL_SIZE.y,
		std::string	materialName = DEFAULT_PANEL_MATERIAL,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a pair of labels, displayed side by side

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption1	The left-most text to display.
	caption2	The right-most text to display.
	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 green.
	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.
	defaultColumnWidths	default width of the panel containing both labels
	columnHeight	default height of the panel containing both labels

See also:

~FEMarineButton()

OgreGFX::FELabelPair::~FELabelPair

(

)

[inline]

Definition at line 365 of file widgets.h.

OgreGFX::FELabelPair::FELabelPair	(	GraphicsInteractionManager *	gim,
		std::string	caption1 = "Key",
		std::string	caption2 = "Value",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Green,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultColumnWidths = Ogre::Vector2(100, 200),
		int	columnHeight = DEFAULT_LABEL_SIZE.y,
		std::string	materialName = DEFAULT_PANEL_MATERIAL,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a pair of labels, displayed side by side

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption1	The left-most text to display.
	caption2	The right-most text to display.
	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 green.
	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.
	defaultColumnWidths	default width of the panel containing both labels
	columnHeight	default height of the panel containing both labels

See also:

~FEMarineButton()

OgreGFX::FELabelPair::~FELabelPair

(

)

[inline]

Definition at line 365 of file widgets.h.

OgreGFX::FELabelPair::FELabelPair	(	GraphicsInteractionManager *	gim,
		std::string	caption1 = "Key",
		std::string	caption2 = "Value",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Green,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultColumnWidths = Ogre::Vector2(100, 200),
		int	columnHeight = DEFAULT_LABEL_SIZE.y,
		std::string	materialName = DEFAULT_PANEL_MATERIAL,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a pair of labels, displayed side by side

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption1	The left-most text to display.
	caption2	The right-most text to display.
	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 green.
	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.
	defaultColumnWidths	default width of the panel containing both labels
	columnHeight	default height of the panel containing both labels

See also:

~FEMarineButton()

OgreGFX::FELabelPair::~FELabelPair

(

)

[inline]

Definition at line 365 of file widgets.h.

OgreGFX::FELabelPair::FELabelPair	(	GraphicsInteractionManager *	gim,
		std::string	caption1 = "Key",
		std::string	caption2 = "Value",
		Widget *	aParent = 0,
		Ogre::ColourValue	color = Ogre::ColourValue::Green,
		Ogre::Vector2	defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
		Ogre::Vector2	defaultColumnWidths = Ogre::Vector2(100, 200),
		int	columnHeight = DEFAULT_LABEL_SIZE.y,
		std::string	materialName = DEFAULT_PANEL_MATERIAL,
		Ogre::GuiMetricsMode	defaultMode = Ogre::GMM_RELATIVE
	)

Constructor for a pair of labels, displayed side by side

Parameters:

	gim	a pointer to the global Graphics Interaction Manager, to display widget.
	caption1	The left-most text to display.
	caption2	The right-most text to display.
	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 green.
	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.
	defaultColumnWidths	default width of the panel containing both labels
	columnHeight	default height of the panel containing both labels

See also:

~FEMarineButton()

OgreGFX::FELabelPair::~FELabelPair

(

)

[inline]

Definition at line 365 of file widgets.h.

---

Member Function Documentation

void OgreGFX::FELabelPair::show

(

)

[virtual]

the height of each separator element

Reimplemented from OgreGFX::FEPanel.

Definition at line 577 of file widgets.cpp.

References DEBUG, left, right, and OgreGFX::FELabel::show().

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

void OgreGFX::FELabelPair::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::FEPanel.

Definition at line 584 of file widgets.cpp.

References OgreGFX::FELabel::hide(), left, OgreGFX::FEPanel::panel, and right.

void OgreGFX::FELabelPair::setLeft

(

std::string

val

)

Sets the string to display for the left-most label.

Parameters:

val

The string to display

Returns:

void

Definition at line 567 of file widgets.cpp.

References left, and OgreGFX::FELabel::setCaption().

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

void OgreGFX::FELabelPair::setRight

(

std::string

val

)

Sets the string to display for the right-most label.

Parameters:

val

The string to display

Returns:

void

Definition at line 572 of file widgets.cpp.

References right, and OgreGFX::FELabel::setCaption().

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

virtual void OgreGFX::FELabelPair::show

(

)

[virtual]

the height of each separator element

Reimplemented from OgreGFX::FEPanel.

virtual void OgreGFX::FELabelPair::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::FEPanel.

void OgreGFX::FELabelPair::setLeft

(

std::string

val

)

Sets the string to display for the left-most label.

Parameters:

val

The string to display

Returns:

void

void OgreGFX::FELabelPair::setRight

(

std::string

val

)

Sets the string to display for the right-most label.

Parameters:

val

The string to display

Returns:

void

virtual void OgreGFX::FELabelPair::show

(

)

[virtual]

the height of each separator element

Reimplemented from OgreGFX::FEPanel.

virtual void OgreGFX::FELabelPair::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::FEPanel.

void OgreGFX::FELabelPair::setLeft

(

std::string

val

)

Sets the string to display for the left-most label.

Parameters:

val

The string to display

Returns:

void

void OgreGFX::FELabelPair::setRight

(

std::string

val

)

Sets the string to display for the right-most label.

Parameters:

val

The string to display

Returns:

void

virtual void OgreGFX::FELabelPair::show

(

)

[virtual]

the height of each separator element

Reimplemented from OgreGFX::FEPanel.

virtual void OgreGFX::FELabelPair::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::FEPanel.

void OgreGFX::FELabelPair::setLeft

(

std::string

val

)

Sets the string to display for the left-most label.

Parameters:

val

The string to display

Returns:

void

void OgreGFX::FELabelPair::setRight

(

std::string

val

)

Sets the string to display for the right-most label.

Parameters:

val

The string to display

Returns:

void

virtual void OgreGFX::FELabelPair::show

(

)

[virtual]

the height of each separator element

Reimplemented from OgreGFX::FEPanel.

virtual void OgreGFX::FELabelPair::hide

(

)

[virtual]

Hides the widget and all sub-elements.

See also:

show()

Reimplemented from OgreGFX::FEPanel.

void OgreGFX::FELabelPair::setLeft

(

std::string

val

)

Sets the string to display for the left-most label.

Parameters:

val

The string to display

Returns:

void

void OgreGFX::FELabelPair::setRight

(

std::string

val

)

Sets the string to display for the right-most label.

Parameters:

val

The string to display

Returns:

void

---

Member Data Documentation

FELabel* OgreGFX::FELabelPair::left

Definition at line 463 of file widgets.h.

Referenced by FELabelPair(), OgreGFX::WidgetMgr::frameRenderingQueued(), hide(), setLeft(), and show().

FELabel * OgreGFX::FELabelPair::right

Definition at line 463 of file widgets.h.

Referenced by FELabelPair(), OgreGFX::WidgetMgr::frameRenderingQueued(), hide(), setRight(), and show().

FELabel* OgreGFX::FELabelPair::left

Definition at line 367 of file widgets.h.

FELabel* OgreGFX::FELabelPair::left

Definition at line 367 of file widgets.h.

FELabel* OgreGFX::FELabelPair::left

Definition at line 367 of file widgets.h.

FELabel* OgreGFX::FELabelPair::left

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

---