SO3::SWidgetManager Class Reference

#include <SO3WidgetManager.h>

Inheritance diagram for SO3::SWidgetManager:

Public Types
typedef std::map< std::string, SWidget * >	WidgetList

Public Member Functions
	SWidgetManager ()
	~SWidgetManager ()
WidgetList	GetWidgetList ()
void	AddWidgetFactory (SWidgetFactory *newWidgetFactory)
void	RemoveWidgetFactory (SWidgetFactory *existingWidgetFactory)
void	RemoveWidgetFactory (const std::string &existingWidgetFactoryName)
SWidget *	CreateWidget (SScene *targetScene, const std::string &widgetName, const int &xPos, const int &yPos, const unsigned short &width, const unsigned short &height, SViewPort *targetViewport, const unsigned int &widgetZOrder, const std::string &widgetType)
SWidget *	CreateWidget (SScene *targetScene, const std::string &widgetName, const int &xPos, const int &yPos, const unsigned short &width, const unsigned short &height, SViewPort *targetViewport, const std::string &widgetType)
SWidget *	CreateWidget (SScene *targetScene, const std::string &widgetName, const unsigned short &width, const unsigned short &height, SMaterial *targetMaterial, const unsigned short &targetTechnique, const unsigned short &targetPass, const unsigned short &targetTextureUnit, const std::string &widgetType)
void	DeleteWidget (SWidget *existingWidget)
void	AddWidgetListener (SWidgetListener *newWidgetListener)
void	RemoveWidgetListener (SWidgetListener *existingWidgetListener)
void	InjectMouseMove (SWindow *originWindow, const int &xPos, const int &yPos, const MouseButtonId &button)
void	InjectMouseWheel (SWindow *originWindow, const int &scrollX, const int &scrollY, const int &relativeScroll)
void	InjectMouseDown (SWindow *originWindow, const int &xPos, const int &yPos, const MouseButtonId &button)
void	InjectTouchAdd (SWindow *originWindow, const int &xPos, const int &yPos, const int &touchid)
void	InjectTouchRemove (SWindow *originWindow, const int &touchid)
void	InjectTouchUpdate (SWindow *originWindow, const int &xPos, const int &yPos, const int &vx, const int &vy, const int &touchid)
void	InjectMouseUp (SWindow *originWindow, const int &xPos, const int &yPos, const MouseButtonId &button)
void	InjectMouseMove (SWidget *widget, const SRaycastResult &raycast, const MouseButtonId &button, const int &id=0)
void	InjectMouseDown (SWidget *widget, const SRaycastResult &raycast, const MouseButtonId &button, const int &id=0)
void	InjectMouseUp (const SRaycastResult &raycast, const MouseButtonId &button, const int &id=0)
void	InjectMouseWheel (SWidget *widget, const SRaycastResult &raycast, const int &relativeScroll, const int &id=0)
void	InjectTouchAdd (SWidget *widget, const SRaycastResult &raycast, const int &touchid)
void	InjectTouchRemove (SWidget *widget, const SRaycastResult &raycast, const int &touchid)
void	InjectTouchUpdate (SWidget *widget, const SRaycastResult &raycast, const int &touchid)
void	InjectKeyEvent (const UINT &msg, const ScolWindowHandle &hwnd, const WPARAM &wParam, const LPARAM &lParam)
void	InjectTextEvent (const std::string &text)
void	UpdateWidgetsZOrder ()
void	UpdateFocusedWidget (SWidget *focusTargetedWidget)
SWidget *	GetFocusedWidget ()
void	_FireScriptWidgetEvent (SWidget *targetedWidget, const SScriptFunction &functionCalled)
void	_FireOnLoadStart (SWidget *targetedWidget)
void	_FireOnLoadEnd (SWidget *targetedWidget)
void	_FireOnLoadError (SWidget *targetedWidget, const int &errorCode, const std::string &failedUrl)

Static Public Member Functions
static SWidgetManager &	getSingleton ()
static SWidgetManager *	getSingletonPtr ()

Detailed Description

Definition at line 97 of file SO3WidgetManager.h.

Member Typedef Documentation

WidgetList

typedef std::map<std::string, SWidget*> SO3::SWidgetManager::WidgetList

Definition at line 100 of file SO3WidgetManager.h.

Constructor & Destructor Documentation

SWidgetManager()

SO3::SWidgetManager::SWidgetManager

(

)

Constructor.

Definition at line 59 of file SO3WidgetManager.cpp.

~SWidgetManager()

SO3::SWidgetManager::~SWidgetManager

(

)

Destructor.

Definition at line 64 of file SO3WidgetManager.cpp.

Member Function Documentation

_FireOnLoadEnd()

void SO3::SWidgetManager::_FireOnLoadEnd

(

SWidget *

targetedWidget

)

Remarks

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

Definition at line 1033 of file SO3WidgetManager.cpp.

_FireOnLoadError()

void SO3::SWidgetManager::_FireOnLoadError	(	SWidget *	targetedWidget,
		const int &	errorCode,
		const std::string &	failedUrl
	)

Remarks

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

Definition at line 1043 of file SO3WidgetManager.cpp.

_FireOnLoadStart()

void SO3::SWidgetManager::_FireOnLoadStart

(

SWidget *

targetedWidget

)

Remarks

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

Definition at line 1023 of file SO3WidgetManager.cpp.

_FireScriptWidgetEvent()

void SO3::SWidgetManager::_FireScriptWidgetEvent	(	SWidget *	targetedWidget,
		const SScriptFunction &	functionCalled
	)

Remarks

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

Definition at line 1013 of file SO3WidgetManager.cpp.

AddWidgetFactory()

void SO3::SWidgetManager::AddWidgetFactory

(

SWidgetFactory *

newWidgetFactory

)

Definition at line 84 of file SO3WidgetManager.cpp.

AddWidgetListener()

void SO3::SWidgetManager::AddWidgetListener

(

SWidgetListener *

newWidgetListener

)

Definition at line 860 of file SO3WidgetManager.cpp.

CreateWidget() [1/3]

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

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

Definition at line 132 of file SO3WidgetManager.cpp.

CreateWidget() [2/3]

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

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

Definition at line 107 of file SO3WidgetManager.cpp.

CreateWidget() [3/3]

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

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

Definition at line 153 of file SO3WidgetManager.cpp.

DeleteWidget()

void SO3::SWidgetManager::DeleteWidget

(

SWidget *

existingWidget

)

Definition at line 174 of file SO3WidgetManager.cpp.

GetFocusedWidget()

SWidget * SO3::SWidgetManager::GetFocusedWidget

(

)

Definition at line 746 of file SO3WidgetManager.cpp.

getSingleton()

SWidgetManager & SO3::SWidgetManager::getSingleton ( )

static

Definition at line 53 of file SO3WidgetManager.cpp.

getSingletonPtr()

SWidgetManager * SO3::SWidgetManager::getSingletonPtr ( )

static

Definition at line 48 of file SO3WidgetManager.cpp.

GetWidgetList()

SWidgetManager::WidgetList SO3::SWidgetManager::GetWidgetList

(

)

Definition at line 79 of file SO3WidgetManager.cpp.

InjectKeyEvent()

void SO3::SWidgetManager::InjectKeyEvent	(	const UINT &	msg,
		const ScolWindowHandle &	hwnd,
		const WPARAM &	wParam,
		const LPARAM &	lParam
	)

Definition at line 617 of file SO3WidgetManager.cpp.

InjectMouseDown() [1/2]

void SO3::SWidgetManager::InjectMouseDown	(	SWidget *	widget,
		const SRaycastResult &	raycast,
		const MouseButtonId &	button,
		const int &	id = 0
	)

Definition at line 492 of file SO3WidgetManager.cpp.

InjectMouseDown() [2/2]

void SO3::SWidgetManager::InjectMouseDown	(	SWindow *	originWindow,
		const int &	xPos,
		const int &	yPos,
		const 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 274 of file SO3WidgetManager.cpp.

InjectMouseMove() [1/2]

void SO3::SWidgetManager::InjectMouseMove	(	SWidget *	widget,
		const SRaycastResult &	raycast,
		const MouseButtonId &	button,
		const int &	id = 0
	)

Definition at line 450 of file SO3WidgetManager.cpp.

InjectMouseMove() [2/2]

void SO3::SWidgetManager::InjectMouseMove	(	SWindow *	originWindow,
		const int &	xPos,
		const int &	yPos,
		const 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 212 of file SO3WidgetManager.cpp.

InjectMouseUp() [1/2]

void SO3::SWidgetManager::InjectMouseUp	(	const SRaycastResult &	raycast,
		const MouseButtonId &	button,
		const int &	id = 0
	)

Definition at line 531 of file SO3WidgetManager.cpp.

InjectMouseUp() [2/2]

void SO3::SWidgetManager::InjectMouseUp	(	SWindow *	originWindow,
		const int &	xPos,
		const int &	yPos,
		const 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 309 of file SO3WidgetManager.cpp.

InjectMouseWheel() [1/2]

void SO3::SWidgetManager::InjectMouseWheel	(	SWidget *	widget,
		const SRaycastResult &	raycast,
		const int &	relativeScroll,
		const int &	id = 0
	)

Definition at line 517 of file SO3WidgetManager.cpp.

InjectMouseWheel() [2/2]

void SO3::SWidgetManager::InjectMouseWheel	(	SWindow *	originWindow,
		const int &	scrollX,
		const int &	scrollY,
		const 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 262 of file SO3WidgetManager.cpp.

InjectTextEvent()

void SO3::SWidgetManager::InjectTextEvent

(

const std::string &

text

)

Definition at line 627 of file SO3WidgetManager.cpp.

InjectTouchAdd() [1/2]

void SO3::SWidgetManager::InjectTouchAdd	(	SWidget *	widget,
		const SRaycastResult &	raycast,
		const int &	touchid
	)

Definition at line 550 of file SO3WidgetManager.cpp.

InjectTouchAdd() [2/2]

void SO3::SWidgetManager::InjectTouchAdd	(	SWindow *	originWindow,
		const int &	xPos,
		const int &	yPos,
		const int &	touchid
	)

Definition at line 339 of file SO3WidgetManager.cpp.

InjectTouchRemove() [1/2]

void SO3::SWidgetManager::InjectTouchRemove	(	SWidget *	widget,
		const SRaycastResult &	raycast,
		const int &	touchid
	)

Definition at line 564 of file SO3WidgetManager.cpp.

InjectTouchRemove() [2/2]

void SO3::SWidgetManager::InjectTouchRemove	(	SWindow *	originWindow,
		const int &	touchid
	)

Definition at line 380 of file SO3WidgetManager.cpp.

InjectTouchUpdate() [1/2]

void SO3::SWidgetManager::InjectTouchUpdate	(	SWidget *	widget,
		const SRaycastResult &	raycast,
		const int &	touchid
	)

Definition at line 575 of file SO3WidgetManager.cpp.

InjectTouchUpdate() [2/2]

void SO3::SWidgetManager::InjectTouchUpdate	(	SWindow *	originWindow,
		const int &	xPos,
		const int &	yPos,
		const int &	vx,
		const int &	vy,
		const int &	touchid
	)

Definition at line 412 of file SO3WidgetManager.cpp.

RemoveWidgetFactory() [1/2]

void SO3::SWidgetManager::RemoveWidgetFactory

(

const std::string &

existingWidgetFactoryName

)

Definition at line 98 of file SO3WidgetManager.cpp.

RemoveWidgetFactory() [2/2]

void SO3::SWidgetManager::RemoveWidgetFactory

(

SWidgetFactory *

existingWidgetFactory

)

Definition at line 93 of file SO3WidgetManager.cpp.

RemoveWidgetListener()

void SO3::SWidgetManager::RemoveWidgetListener

(

SWidgetListener *

existingWidgetListener

)

Definition at line 868 of file SO3WidgetManager.cpp.

UpdateFocusedWidget()

void SO3::SWidgetManager::UpdateFocusedWidget

(

SWidget *

focusTargetedWidget

)

Definition at line 723 of file SO3WidgetManager.cpp.

UpdateWidgetsZOrder()

void SO3::SWidgetManager::UpdateWidgetsZOrder

(

)

Definition at line 633 of file SO3WidgetManager.cpp.

---

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

• include/SO3Renderer/SO3WidgetManager.h
• src/SO3Renderer/SO3WidgetManager.cpp