SO3::SWidgetManager Class Reference

#include <SO3WidgetManager.h>

Public Member Functions
	SWidgetManager ()
	~SWidgetManager ()
void	AddWidgetFactory (SWidgetFactory *newWidgetFactory)
void	RemoveWidgetFactory (SWidgetFactory *existingWidgetFactory)
void	RemoveWidgetFactory (std::string existingWidgetFactoryName)
SWidget *	CreateWidget (SScene targetScene, std::string widgetName, int xPos, int yPos, unsigned short width, unsigned short height, SViewPort targetViewport, unsigned int widgetZOrder, std::string widgetType)
SWidget *	CreateWidget (SScene targetScene, std::string widgetName, int xPos, int yPos, unsigned short width, unsigned short height, SViewPort targetViewport, std::string widgetType)
SWidget *	CreateWidget (SScene targetScene, std::string widgetName, unsigned short width, unsigned short height, SMaterial targetMaterial, unsigned short targetTechnique, unsigned short targetPass, unsigned short targetTextureUnit, std::string widgetType)
void	DeleteWidget (SWidget *existingWidget)
void	AddWidgetListener (SWidgetListener *newWidgetListener)
void	RemoveWidgetListener (SWidgetListener *existingWidgetListener)
void	InjectMouseMove (SWindow *originWindow, int xPos, int yPos, MouseButtonId button)
void	InjectMouseWheel (SWindow *originWindow, int scrollX, int scrollY, int relativeScroll)
void	InjectMouseDown (SWindow *originWindow, int xPos, int yPos, MouseButtonId button)
void	InjectMouseUp (SWindow *originWindow, int xPos, int yPos, MouseButtonId button)
void	InjectKeyEvent (UINT msg, WindowHandle hwnd, WPARAM wParam, LPARAM lParam)
void	InjectTextEvent (std::string text)
void	UpdateWidgetsZOrder ()
void	UpdateFocusedWidget (SWidget *focusTargetedWidget)
SWidget *	GetFocusedWidget ()
void	_FireScriptWidgetEvent (SWidget *targetedWidget, SWidget::WidgetScriptFunction functionCalled)
Static Public Member Functions
static SWidgetManager &	getSingleton ()
static SWidgetManager *	getSingletonPtr ()

Detailed Description

Definition at line 48 of file SO3WidgetManager.h.

Constructor & Destructor Documentation

SO3::SWidgetManager::SWidgetManager ( )

Constructor.

Definition at line 59 of file SO3WidgetManager.cpp.

SO3::SWidgetManager::~SWidgetManager ( )

Destructor.

Definition at line 64 of file SO3WidgetManager.cpp.

Member Function Documentation

void SO3::SWidgetManager::_FireScriptWidgetEvent	(	SWidget *	targetedWidget,
		SWidget::WidgetScriptFunction	functionCalled
	)

Remarks:: public cause it had to be called from SWidget derivated classes.

Definition at line 571 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::AddWidgetFactory ( SWidgetFactory * newWidgetFactory )

Definition at line 79 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::AddWidgetListener ( SWidgetListener * newWidgetListener )

Definition at line 493 of file SO3WidgetManager.cpp.

SWidget * SO3::SWidgetManager::CreateWidget	(	SScene *	targetScene,
		std::string	widgetName,
		unsigned short	width,
		unsigned short	height,
		SMaterial *	targetMaterial,
		unsigned short	targetTechnique,
		unsigned short	targetPass,
		unsigned short	targetTextureUnit,
		std::string	widgetType
	)

Construct a widget of the specified type on an existing SMaterial.

Definition at line 148 of file SO3WidgetManager.cpp.

SWidget * SO3::SWidgetManager::CreateWidget	(	SScene *	targetScene,
		std::string	widgetName,
		int	xPos,
		int	yPos,
		unsigned short	width,
		unsigned short	height,
		SViewPort *	targetViewport,
		std::string	widgetType
	)

Construct a widget of the specified type on a SViewport, using an 2D rect.

Definition at line 127 of file SO3WidgetManager.cpp.

SWidget * SO3::SWidgetManager::CreateWidget	(	SScene *	targetScene,
		std::string	widgetName,
		int	xPos,
		int	yPos,
		unsigned short	width,
		unsigned short	height,
		SViewPort *	targetViewport,
		unsigned int	widgetZOrder,
		std::string	widgetType
	)

Construct a widget of the specified type on a SViewport, using an overlay.

Definition at line 102 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::DeleteWidget ( SWidget * existingWidget )

Definition at line 169 of file SO3WidgetManager.cpp.

SWidget * SO3::SWidgetManager::GetFocusedWidget ( )

Definition at line 386 of file SO3WidgetManager.cpp.

SWidgetManager & SO3::SWidgetManager::getSingleton ( ) [static]

Definition at line 53 of file SO3WidgetManager.cpp.

SWidgetManager * SO3::SWidgetManager::getSingletonPtr ( ) [static]

Definition at line 48 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::InjectKeyEvent	(	UINT	msg,
		WindowHandle	hwnd,
		WPARAM	wParam,
		LPARAM	lParam
	)

Definition at line 285 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::InjectMouseDown	(	SWindow *	originWindow,
		int	xPos,
		int	yPos,
		MouseButtonId	button
	)

Injects mouse down events into all widgets.

Parameters:

	originWindow	window from which the injection is done.
	scrollX	x position from window left origin (pixels).
	scrollY	y position from window top origin (pixels).
	relativeScroll	relative movement of scrolling

Definition at line 240 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::InjectMouseMove	(	SWindow *	originWindow,
		int	xPos,
		int	yPos,
		MouseButtonId	button
	)

Injects the mouse's into all widgets.

Parameters:

	originWindow	window from which the injection is done.
	xPos	x position from window left origin (pixels).
	yPos	y position from window top origin (pixels).
	button	which mouse button is pressed.

Definition at line 199 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::InjectMouseUp	(	SWindow *	originWindow,
		int	xPos,
		int	yPos,
		MouseButtonId	button
	)

Injects mouse up events into all widgets.

Parameters:

	originWindow	window from which the injection is done.
	scrollX	x position from window left origin (pixels).
	scrollY	y position from window top origin (pixels).
	relativeScroll	relative movement of scrolling

Definition at line 264 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::InjectMouseWheel	(	SWindow *	originWindow,
		int	scrollX,
		int	scrollY,
		int	relativeScroll
	)

Injects mouse wheel events into all widgets.

Parameters:

	originWindow	window from which the injection is done.
	scrollX	x position from window left origin (pixels).
	scrollY	y position from window top origin (pixels).
	relativeScroll	relative movement of scrolling

Definition at line 230 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::InjectTextEvent ( std::string text )

Definition at line 292 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::RemoveWidgetFactory ( std::string existingWidgetFactoryName )

Definition at line 93 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::RemoveWidgetFactory ( SWidgetFactory * existingWidgetFactory )

Definition at line 88 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::RemoveWidgetListener ( SWidgetListener * existingWidgetListener )

Definition at line 501 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::UpdateFocusedWidget ( SWidget * focusTargetedWidget )

Definition at line 365 of file SO3WidgetManager.cpp.

void SO3::SWidgetManager::UpdateWidgetsZOrder ( )

Definition at line 298 of file SO3WidgetManager.cpp.

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

SO3Engine/SO3Renderer/SO3WidgetManager.h
SO3Engine/SO3Renderer/SO3WidgetManager.cpp

SO3::SWidgetManager Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation