OgreGFX::FESCVButton Class Reference

#include <widgets.h>

Inheritance diagram for OgreGFX::FESCVButton:

List of all members.

Public Member Functions
	FESCVButton (GraphicsInteractionManager *gim, const std::set< OIS::KeyCode > *modifierKeys, const OIS::MouseButtonID oisMouseButtonId, std::string caption="FEButton", 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)
	~FESCVButton ()
virtual void	handleMouseEvent (const OIS::MouseEvent &args)
	FESCVButton (GraphicsInteractionManager *gim, const std::set< OIS::KeyCode > *modifierKeys, const OIS::MouseButtonID oisMouseButtonId, std::string caption="FEButton", 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)
	~FESCVButton ()
virtual void	handleMouseEvent (const OIS::MouseEvent &args)
	FESCVButton (GraphicsInteractionManager *gim, const std::set< OIS::KeyCode > *modifierKeys, const OIS::MouseButtonID oisMouseButtonId, std::string caption="FEButton", 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)
	~FESCVButton ()
virtual void	handleMouseEvent (const OIS::MouseEvent &args)
	FESCVButton (GraphicsInteractionManager *gim, const std::set< OIS::KeyCode > *modifierKeys, const OIS::MouseButtonID oisMouseButtonId, std::string caption="FEButton", 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)
	~FESCVButton ()
virtual void	handleMouseEvent (const OIS::MouseEvent &args)

---

Detailed Description

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

Definition at line 285 of file widgets.h.

---

Constructor & Destructor Documentation

OgreGFX::FESCVButton::FESCVButton	(	GraphicsInteractionManager *	gim,
		const std::set< OIS::KeyCode > *	modifierKeys,
		const OIS::MouseButtonID	oisMouseButtonId,
		std::string	caption = "FEButton",
		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 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()

Definition at line 333 of file widgets.cpp.

OgreGFX::FESCVButton::~FESCVButton

(

)

Definition at line 345 of file widgets.cpp.

OgreGFX::FESCVButton::FESCVButton	(	GraphicsInteractionManager *	gim,
		const std::set< OIS::KeyCode > *	modifierKeys,
		const OIS::MouseButtonID	oisMouseButtonId,
		std::string	caption = "FEButton",
		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 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()

OgreGFX::FESCVButton::~FESCVButton

(

)

OgreGFX::FESCVButton::FESCVButton	(	GraphicsInteractionManager *	gim,
		const std::set< OIS::KeyCode > *	modifierKeys,
		const OIS::MouseButtonID	oisMouseButtonId,
		std::string	caption = "FEButton",
		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 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()

OgreGFX::FESCVButton::~FESCVButton

(

)

OgreGFX::FESCVButton::FESCVButton	(	GraphicsInteractionManager *	gim,
		const std::set< OIS::KeyCode > *	modifierKeys,
		const OIS::MouseButtonID	oisMouseButtonId,
		std::string	caption = "FEButton",
		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 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()

OgreGFX::FESCVButton::~FESCVButton

(

)

---

Member Function Documentation

void OgreGFX::FESCVButton::handleMouseEvent

(

const OIS::MouseEvent &

args

)

[virtual]

Stores if the button is available to be clicked or not. If false, clicking the button does not result in the associated function being called.

Mouse handler called when a mouse event occurs.

Parameters:

args

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

Returns:

void

Reimplemented from OgreGFX::FEButton.

Definition at line 350 of file widgets.cpp.

References OgreGFX::Widget::cursonInMe(), DEBUG, FastEcslent::Entity::desiredHeading, FastEcslent::Entity::desiredSpeed, OgreGFX::FEButton::enabled, OgreGFX::GraphicsInteractionManager::engine, FastEcslent::Engine::entityMgr, OgreGFX::Widget::gfx, FastEcslent::Entity::heading, FastEcslent::Entity::init(), OgreGFX::GraphicsInteractionManager::makeNode(), OgreGFX::GraphicsInteractionManager::nGFXNodes, FastEcslent::Entity::pos, FastEcslent::SCV, FastEcslent::Engine::selectionMgr, and FastEcslent::Entity::yaw.

virtual void OgreGFX::FESCVButton::handleMouseEvent

(

const OIS::MouseEvent &

args

)

[virtual]

Stores if the button is available to be clicked or not. If false, clicking the button does not result in the associated function being called.

Mouse handler called when a mouse event occurs.

Parameters:

args

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

Returns:

void

Reimplemented from OgreGFX::FEButton.

virtual void OgreGFX::FESCVButton::handleMouseEvent

(

const OIS::MouseEvent &

args

)

[virtual]

Stores if the button is available to be clicked or not. If false, clicking the button does not result in the associated function being called.

Mouse handler called when a mouse event occurs.

Parameters:

args

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

Returns:

void

Reimplemented from OgreGFX::FEButton.

virtual void OgreGFX::FESCVButton::handleMouseEvent

(

const OIS::MouseEvent &

args

)

[virtual]

Stores if the button is available to be clicked or not. If false, clicking the button does not result in the associated function being called.

Mouse handler called when a mouse event occurs.

Parameters:

args

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

Returns:

void

Reimplemented from OgreGFX::FEButton.

---

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

• /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/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

---