GUI module class. More...

#include <tdme/gui/GUI.h>

Inheritance diagram for GUI:

Collaboration diagram for GUI:

Public Member Functions
	GUI (Engine engine, GUIRenderer guiRenderer)
	Public constructor. More...

	~GUI ()
	Destructor. More...

int	getWidth ()

int	getHeight ()

void	initialize ()
	Init. More...

void	reshape (int width, int height)
	Reshape. More...

void	dispose ()
	Dispose. More...

vector< GUIMouseEvent > &	getMouseEvents ()

vector< GUIKeyboardEvent > &	getKeyboardEvents ()

GUIScreenNode *	getScreen (const string &id)
	Get screen. More...

void	addScreen (const string &id, GUIScreenNode *screen)
	Add screen. More...

void	removeScreen (const string &id)
	Removes an screen. More...

void	reset ()
	Removes all screens and caches. More...

void	resetRenderScreens ()
	Reset render screens. More...

bool	hasRenderScreen (const string &screenId)
	Returns if given screen is beeing rendered. More...

void	addRenderScreen (const string &screenId)
	Add render screen. More...

void	removeRenderScreen (const string &screenId)
	Remove render screen. More...

GUIColor &	getFoccussedBorderColor ()

void	invalidateFocussedNode ()
	Invalidate focussed node. More...

GUIElementNode *	getFocussedNode ()

void	unfocusNode ()
	Unfocus current focussed node. More...

void	focusNode ()
	Focus current focussed node. More...

void	setFoccussedNode (GUIElementNode *newFoccussedNode)
	Set focussed node. More...

void	focusNextNode ()
	Focus next node. More...

void	focusPreviousNode ()
	Focus next node. More...

void	render ()
	Render GUIs. More...

bool	isHavingMouseInteraction (GUINode *node)
	Reports if node has currently mouse interaction like dragging or pressing. More...

void	onChar (unsigned int key, int x, int y) override
	On char. More...

void	onKeyDown (unsigned char key, int keyCode, int x, int y) override
	On key down. More...

void	onKeyUp (unsigned char key, int keyCode, int x, int y) override
	On key up. More...

void	onMouseDragged (int x, int y) override
	On mouse dragged. More...

void	onMouseMoved (int x, int y) override
	On mouse moved. More...

void	onMouseButton (int button, int state, int x, int y) override
	On mouse moved. More...

void	onMouseWheel (int button, int direction, int x, int y) override
	On mouse wheel. More...

void	handleEvents ()
	Handle screen events. More...

Public Member Functions inherited from InputEventHandler
virtual	~InputEventHandler ()
	Destructor. More...

virtual void	onChar (unsigned int key, int x, int y)=0
	On char. More...

virtual void	onKeyDown (unsigned char key, int keyCode, int x, int y)=0
	On key down. More...

virtual void	onKeyUp (unsigned char key, int keyCode, int x, int y)=0
	On key up. More...

virtual void	onMouseDragged (int x, int y)=0
	On mouse dragged. More...

virtual void	onMouseMoved (int x, int y)=0
	On mouse moved. More...

virtual void	onMouseButton (int button, int state, int x, int y)=0
	On mouse moved. More...

virtual void	onMouseWheel (int button, int direction, int x, int y)=0
	On mouse wheen. More...

Static Public Member Functions
static GUIFont *	getFont (const string &applicationRootPath, const string &fileName)
	Get font. More...

static Texture *	getImage (const string &applicationRootPath, const string &fileName)
	Get image. More...

Private Member Functions
void	addMouseOutCandidateElementNode (GUINode *node)
	Add node that is a possible mouse out candidate as it received a mouse over. More...

void	addMouseOutClickCandidateElementNode (GUINode *node)
	Add node that is a possible mouse click out candidate as it received a mouse click. More...

void	determineFocussedNodes ()
	Determine focussed nodes. More...

void	handleMouseEvent (GUINode node, GUIMouseEvent event, const unordered_set< string > &mouseOutCandidateEventNodeIds, const unordered_set< string > &mouseOutClickCandidateEventNodeIds, unordered_set< string > &mousePressedEventNodeIds, bool floatingNodes)
	Handle mouse event for given node. More...

void	handleKeyboardEvent (GUIKeyboardEvent *event)
	Handle mouse event for given node. More...

void	reshapeScreen (GUIScreenNode *screenNode)
	Reshape screen. More...

void	fakeMouseMovedEvent ()
	Fake mouse moved event. More...

void	fakeKeyboardModifierEvent ()
	Fake a keyboard modifier event. More...

void	applyRenderScreensChange ()
	Render screens change. More...

Private Attributes
GUIRenderer *	guiRenderer { nullptr }

Engine *	engine { nullptr }

unordered_map< string, GUIScreenNode * >	screens

GUIColor	foccussedBorderColor

vector< GUIElementNode * >	focusableNodes

vector< GUIScreenNode * >	focusableScreenNodes

string	focussedNodeScreenId

string	focussedNodeNodeId

GUIColor	unfocussedNodeBorderLeftColor

GUIColor	unfocussedNodeBorderRightColor

GUIColor	unfocussedNodeBorderTopColor

GUIColor	unfocussedNodeBorderBottomColor

vector< GUIMouseEvent >	mouseEvents

vector< GUIKeyboardEvent >	keyboardEvents

vector< GUIScreenNode * >	renderScreens

int	width

int	height

int	mouseButtonLast

unordered_map< string, unordered_set< string > >	mouseOutCandidateEventNodeIds

unordered_map< string, unordered_set< string > >	mouseOutClickCandidateEventNodeIds

unordered_map< string, unordered_set< string > >	mousePressedEventNodeIds

unordered_map< string, unordered_set< string > >	mouseDraggingEventNodeIds

unordered_map< string, bool >	mouseIsDragging

bool	altDown { false }

bool	controlDown { false }

bool	shiftDown { false }

Static Private Attributes
static STATIC_DLL_IMPEXT unordered_map< string, GUIFont * > *	fontCache = new unordered_map<string, GUIFont*>()

static STATIC_DLL_IMPEXT unordered_map< string, Texture * > *	imageCache = new unordered_map<string, Texture*>()

Friends
class	tdme::gui::elements::GUIDropDownController

class	tdme::gui::elements::GUIMenuHeaderItemController

class	tdme::gui::nodes::GUIElementController

class	tdme::gui::nodes::GUIHorizontalScrollbarInternalController

class	tdme::gui::nodes::GUIScreenNode

class	tdme::gui::nodes::GUIVerticalScrollbarInternalController

Detailed Description

GUI module class.

Author: Andreas Drewke

Version: $Id$

Definition at line 65 of file GUI.h.

Constructor & Destructor Documentation

◆ GUI()

GUI	(	Engine *	engine,
		GUIRenderer *	guiRenderer
	)

Public constructor.

Parameters

engine	engine
guiRenderer	gui renderer

Definition at line 71 of file GUI.cpp.

◆ ~GUI()

~GUI ( )

Destructor.

Definition at line 86 of file GUI.cpp.

Member Function Documentation

◆ addMouseOutCandidateElementNode()

void addMouseOutCandidateElementNode ( GUINode * node )

inlineprivate

Add node that is a possible mouse out candidate as it received a mouse over.

Parameters

node	element node

Definition at line 110 of file GUI.h.

◆ addMouseOutClickCandidateElementNode()

void addMouseOutClickCandidateElementNode ( GUINode * node )

inlineprivate

Add node that is a possible mouse click out candidate as it received a mouse click.

Parameters

node	element node

Definition at line 118 of file GUI.h.

◆ addRenderScreen()

void addRenderScreen ( const string & screenId )

Add render screen.

Parameters

screenId screenId

Definition at line 254 of file GUI.cpp.

◆ addScreen()

void addScreen	(	const string &	id,
		GUIScreenNode *	screen
	)

Add screen.

Parameters

id	id
screen	gui

Definition at line 186 of file GUI.cpp.

◆ applyRenderScreensChange()

void applyRenderScreensChange ( )

private

Render screens change.

Definition at line 921 of file GUI.cpp.

◆ determineFocussedNodes()

void determineFocussedNodes ( )

private

Determine focussed nodes.

Definition at line 296 of file GUI.cpp.

◆ dispose()

void dispose ( )

Dispose.

Definition at line 103 of file GUI.cpp.

◆ fakeKeyboardModifierEvent()

void fakeKeyboardModifierEvent ( )

private

Fake a keyboard modifier event.

Definition at line 846 of file GUI.cpp.

◆ fakeMouseMovedEvent()

void fakeMouseMovedEvent ( )

private

Fake mouse moved event.

Definition at line 829 of file GUI.cpp.

◆ focusNextNode()

void focusNextNode ( )

Focus next node.

Definition at line 371 of file GUI.cpp.

◆ focusNode()

void focusNode ( )

Focus current focussed node.

Definition at line 340 of file GUI.cpp.

◆ focusPreviousNode()

void focusPreviousNode ( )

Focus next node.

Definition at line 392 of file GUI.cpp.

◆ getFoccussedBorderColor()

GUIColor & getFoccussedBorderColor ( )

inline

Returns: focussed border color

Definition at line 303 of file GUI.h.

◆ getFocussedNode()

GUIElementNode * getFocussedNode ( )

Returns: focussed node

Definition at line 316 of file GUI.cpp.

◆ getFont()

GUIFont * getFont	(	const string &	applicationRootPath,
		const string &	fileName
	)

static

Get font.

Parameters

applicationRootPath	application root path
fileName	file name

Exceptions

tdme::os::filesystem::FileSystemException

Returns: font

Definition at line 108 of file GUI.cpp.

◆ getHeight()

int getHeight ( )

inline

Returns: height

Definition at line 188 of file GUI.h.

◆ getImage()

Texture * getImage	(	const string &	applicationRootPath,
		const string &	fileName
	)

static

Get image.

Parameters

applicationRootPath	application root path
fileName	file name

Exceptions

tdme::os::filesystem::FileSystemException

Returns: texture

Definition at line 145 of file GUI.cpp.

◆ getKeyboardEvents()

vector< GUIKeyboardEvent > & getKeyboardEvents ( )

inline

Returns: keyboard events

Definition at line 219 of file GUI.h.

◆ getMouseEvents()

vector< GUIMouseEvent > & getMouseEvents ( )

inline

Returns: mouse events

Definition at line 212 of file GUI.h.

◆ getScreen()

GUIScreenNode * getScreen ( const string & id )

inline

Get screen.

Parameters

id id

Returns: screen

Definition at line 246 of file GUI.h.

◆ getWidth()

int getWidth ( )

inline

Returns: width

Definition at line 181 of file GUI.h.

◆ handleEvents()

void handleEvents ( )

Handle screen events.

Definition at line 588 of file GUI.cpp.

◆ handleKeyboardEvent()

void handleKeyboardEvent ( GUIKeyboardEvent * event )

private

Handle mouse event for given node.

Parameters

event event

Definition at line 531 of file GUI.cpp.

◆ handleMouseEvent()

void handleMouseEvent	(	GUINode *	node,
		GUIMouseEvent *	event,
		const unordered_set< string > &	mouseOutCandidateEventNodeIds,
		const unordered_set< string > &	mouseOutClickCandidateEventNodeIds,
		unordered_set< string > &	mousePressedEventNodeIds,
		bool	floatingNodes
	)

private

Handle mouse event for given node.

Parameters

node	node
event	event
mouseOutCandidateEventNodeIds	mouse out candidate event node ids
mouseOutClickCandidateEventNodeIds	mouse out click candidate event node ids
mousePressedEventNodeIds	mouse pressed event node ids
floatingNodes	check if to gather floating nodes only

Definition at line 463 of file GUI.cpp.

◆ hasRenderScreen()

bool hasRenderScreen ( const string & screenId )

inline

Returns if given screen is beeing rendered.

Parameters

screenId screenId

Definition at line 281 of file GUI.h.

◆ initialize()

void initialize ( )

Init.

Definition at line 89 of file GUI.cpp.

◆ invalidateFocussedNode()

void invalidateFocussedNode ( )

Invalidate focussed node.

Definition at line 289 of file GUI.cpp.

◆ isHavingMouseInteraction()

bool isHavingMouseInteraction ( GUINode * node )

Reports if node has currently mouse interaction like dragging or pressing.

Parameters

node node

Returns: if node has currently mouse interaction

Definition at line 455 of file GUI.cpp.

◆ onChar()

void onChar	(	unsigned int	key,
		int	x,
		int	y
	)

overridevirtual

On char.

Parameters

key	key
x	x
y	y

Implements InputEventHandler.

Definition at line 698 of file GUI.cpp.

◆ onKeyDown()

void onKeyDown	(	unsigned char	key,
		int	keyCode,
		int	x,
		int	y
	)

overridevirtual

On key down.

Parameters

key	key
keyCode	key code
x	x
y	y

Implements InputEventHandler.

Definition at line 713 of file GUI.cpp.

◆ onKeyUp()

void onKeyUp	(	unsigned char	key,
		int	keyCode,
		int	x,
		int	y
	)

overridevirtual

On key up.

Parameters

key	key
keyCode	key code
x	x
y	y

Implements InputEventHandler.

Definition at line 728 of file GUI.cpp.

◆ onMouseButton()

void onMouseButton	(	int	button,
		int	state,
		int	x,
		int	y
	)

overridevirtual

On mouse moved.

Parameters

button	button
state	state
x	x
y	y

Implements InputEventHandler.

Definition at line 785 of file GUI.cpp.

◆ onMouseDragged()

void onMouseDragged	(	int	x,
		int	y
	)

overridevirtual

On mouse dragged.

Parameters

x	x
y	y

Implements InputEventHandler.

Definition at line 743 of file GUI.cpp.

◆ onMouseMoved()

void onMouseMoved	(	int	x,
		int	y
	)

overridevirtual

On mouse moved.

Parameters

x	x
y	y

Implements InputEventHandler.

Definition at line 764 of file GUI.cpp.

◆ onMouseWheel()

void onMouseWheel	(	int	button,
		int	direction,
		int	x,
		int	y
	)

overridevirtual

On mouse wheel.

Parameters

button	button
direction	direction
x	x
y	y

Implements InputEventHandler.

Definition at line 807 of file GUI.cpp.

◆ removeRenderScreen()

void removeRenderScreen ( const string & screenId )

Remove render screen.

Parameters

screenId screenId

Definition at line 274 of file GUI.cpp.

◆ removeScreen()

void removeScreen ( const string & id )

Removes an screen.

Parameters

id id

Definition at line 196 of file GUI.cpp.

◆ render()

void render ( )

Render GUIs.

Definition at line 414 of file GUI.cpp.

◆ reset()

void reset ( )

Removes all screens and caches.

Definition at line 212 of file GUI.cpp.

◆ resetRenderScreens()

void resetRenderScreens ( )

Reset render screens.

Definition at line 235 of file GUI.cpp.

◆ reshape()

void reshape	(	int	width,
		int	height
	)

Reshape.

Parameters

width	width
height	height

Definition at line 93 of file GUI.cpp.

◆ reshapeScreen()

void reshapeScreen ( GUIScreenNode * screenNode )

private

Reshape screen.

Parameters

screenNode screen node

Definition at line 883 of file GUI.cpp.

◆ setFoccussedNode()

void setFoccussedNode ( GUIElementNode * newFoccussedNode )

Set focussed node.

Parameters

newFoccussedNode foccussed node

Definition at line 359 of file GUI.cpp.

◆ unfocusNode()

void unfocusNode ( )

Unfocus current focussed node.

Definition at line 324 of file GUI.cpp.

Friends And Related Function Documentation

◆ tdme::gui::elements::GUIDropDownController

friend class tdme::gui::elements::GUIDropDownController

friend

Definition at line 67 of file GUI.h.

◆ tdme::gui::elements::GUIMenuHeaderItemController

friend class tdme::gui::elements::GUIMenuHeaderItemController

friend

Definition at line 68 of file GUI.h.

◆ tdme::gui::nodes::GUIElementController

friend class tdme::gui::nodes::GUIElementController

friend

Definition at line 69 of file GUI.h.

◆ tdme::gui::nodes::GUIHorizontalScrollbarInternalController

friend class tdme::gui::nodes::GUIHorizontalScrollbarInternalController

friend

Definition at line 70 of file GUI.h.

◆ tdme::gui::nodes::GUIScreenNode

friend class tdme::gui::nodes::GUIScreenNode

friend

Definition at line 71 of file GUI.h.

◆ tdme::gui::nodes::GUIVerticalScrollbarInternalController

friend class tdme::gui::nodes::GUIVerticalScrollbarInternalController

friend

Definition at line 72 of file GUI.h.

Member Data Documentation

◆ altDown

bool altDown { false }

private

Definition at line 102 of file GUI.h.

◆ controlDown

bool controlDown { false }

private

Definition at line 103 of file GUI.h.

◆ engine

Engine* engine { nullptr }

private

Definition at line 79 of file GUI.h.

◆ foccussedBorderColor

GUIColor foccussedBorderColor

private

Definition at line 81 of file GUI.h.

◆ focusableNodes

vector<GUIElementNode*> focusableNodes

private

Definition at line 82 of file GUI.h.

◆ focusableScreenNodes

vector<GUIScreenNode*> focusableScreenNodes

private

Definition at line 83 of file GUI.h.

◆ focussedNodeNodeId

string focussedNodeNodeId

private

Definition at line 85 of file GUI.h.

◆ focussedNodeScreenId

string focussedNodeScreenId

private

Definition at line 84 of file GUI.h.

◆ fontCache

unordered_map< string, GUIFont * > * fontCache = new unordered_map<string, GUIFont*>()

staticprivate

Definition at line 75 of file GUI.h.

◆ guiRenderer

GUIRenderer* guiRenderer { nullptr }

private

Definition at line 78 of file GUI.h.

◆ height

int height

private

Definition at line 94 of file GUI.h.

◆ imageCache

unordered_map< string, Texture * > * imageCache = new unordered_map<string, Texture*>()

staticprivate

Definition at line 76 of file GUI.h.

◆ keyboardEvents

vector<GUIKeyboardEvent> keyboardEvents

private

Definition at line 91 of file GUI.h.

◆ mouseButtonLast

int mouseButtonLast

private

Definition at line 95 of file GUI.h.

◆ mouseDraggingEventNodeIds

unordered_map<string, unordered_set<string> > mouseDraggingEventNodeIds

private

Definition at line 99 of file GUI.h.

◆ mouseEvents

vector<GUIMouseEvent> mouseEvents

private

Definition at line 90 of file GUI.h.

◆ mouseIsDragging

unordered_map<string, bool> mouseIsDragging

private

Definition at line 100 of file GUI.h.

◆ mouseOutCandidateEventNodeIds

unordered_map<string, unordered_set<string> > mouseOutCandidateEventNodeIds

private

Definition at line 96 of file GUI.h.

◆ mouseOutClickCandidateEventNodeIds

unordered_map<string, unordered_set<string> > mouseOutClickCandidateEventNodeIds

private

Definition at line 97 of file GUI.h.

◆ mousePressedEventNodeIds

unordered_map<string, unordered_set<string> > mousePressedEventNodeIds

private

Definition at line 98 of file GUI.h.

◆ renderScreens

vector<GUIScreenNode*> renderScreens

private

Definition at line 92 of file GUI.h.

◆ screens

unordered_map<string, GUIScreenNode*> screens

private

Definition at line 80 of file GUI.h.

◆ shiftDown

bool shiftDown { false }

private

Definition at line 104 of file GUI.h.

◆ unfocussedNodeBorderBottomColor

GUIColor unfocussedNodeBorderBottomColor

private

Definition at line 89 of file GUI.h.

◆ unfocussedNodeBorderLeftColor

GUIColor unfocussedNodeBorderLeftColor

private

Definition at line 86 of file GUI.h.

◆ unfocussedNodeBorderRightColor

GUIColor unfocussedNodeBorderRightColor

private

Definition at line 87 of file GUI.h.

◆ unfocussedNodeBorderTopColor

GUIColor unfocussedNodeBorderTopColor

private

Definition at line 88 of file GUI.h.

◆ width

int width

private

Definition at line 93 of file GUI.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/GUI.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/GUI.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GUI()

◆ ~GUI()

Member Function Documentation

◆ addMouseOutCandidateElementNode()

◆ addMouseOutClickCandidateElementNode()

◆ addRenderScreen()

◆ addScreen()

◆ applyRenderScreensChange()

◆ determineFocussedNodes()

◆ dispose()

◆ fakeKeyboardModifierEvent()

◆ fakeMouseMovedEvent()

◆ focusNextNode()

◆ focusNode()

◆ focusPreviousNode()

◆ getFoccussedBorderColor()

◆ getFocussedNode()

◆ getFont()

◆ getHeight()

◆ getImage()

◆ getKeyboardEvents()

◆ getMouseEvents()

◆ getScreen()

◆ getWidth()

◆ handleEvents()

◆ handleKeyboardEvent()

◆ handleMouseEvent()

◆ hasRenderScreen()

◆ initialize()

◆ invalidateFocussedNode()

◆ isHavingMouseInteraction()

◆ onChar()

◆ onKeyDown()

◆ onKeyUp()

◆ onMouseButton()

◆ onMouseDragged()

◆ onMouseMoved()

◆ onMouseWheel()

◆ removeRenderScreen()

◆ removeScreen()

◆ render()

◆ reset()

◆ resetRenderScreens()

◆ reshape()

◆ reshapeScreen()

◆ setFoccussedNode()

◆ unfocusNode()

Friends And Related Function Documentation

◆ tdme::gui::elements::GUIDropDownController

◆ tdme::gui::elements::GUIMenuHeaderItemController

◆ tdme::gui::nodes::GUIElementController

◆ tdme::gui::nodes::GUIHorizontalScrollbarInternalController

◆ tdme::gui::nodes::GUIScreenNode

◆ tdme::gui::nodes::GUIVerticalScrollbarInternalController

Member Data Documentation

◆ altDown

◆ controlDown

◆ engine

◆ foccussedBorderColor

◆ focusableNodes

◆ focusableScreenNodes

◆ focussedNodeNodeId

◆ focussedNodeScreenId

◆ fontCache

◆ guiRenderer

◆ height

◆ imageCache

◆ keyboardEvents

◆ mouseButtonLast

◆ mouseDraggingEventNodeIds

◆ mouseEvents

◆ mouseIsDragging