GUI parent node base class thats supporting child nodes. More...

#include <tdme/gui/nodes/GUIParentNode.h>

Inheritance diagram for GUIParentNode:

Collaboration diagram for GUIParentNode:

Public Member Functions
void	clearSubNodes ()
	Clear sub nodes. More...

void	replaceSubNodes (const string &xml, bool resetScrollOffsets)
	Replace sub nodes with given XML. More...

void	addSubNodes (const string &xml, bool resetScrollOffsets)
	Add sub nodes with given XML. More...

void	addSubNode (GUINode *node)
	Add sub node. More...

void	moveNodes (GUIParentNode *otherParentNode)
	Move children nodes from other parent node into this parent node. More...

GUIParentNode_Overflow *	getOverflowX ()

GUIParentNode_Overflow *	getOverflowY ()

float	getChildrenRenderOffsetX ()

void	setChildrenRenderOffsetX (float childrenRenderOffSetX)
	Set children render offset x. More...

float	getChildrenRenderOffsetY ()

void	setChildrenRenderOffsetY (float childrenRenderOffSetY)
	Set children render offset y. More...

void	getChildControllerNodes (vector< GUINode * > &childControllerNodes, bool requireConditionsMet=false)
	Get child controller nodes. More...

void	dispose () override
	Dispose node. More...

void	setConditionsMet () override
	Set conditions met for this node and its subnodes. More...

void	render (GUIRenderer *guiRenderer) override
	Render. More...

void	determineMouseEventNodes (GUIMouseEvent *event, bool floatingNode, unordered_set< string > &eventNodeIds, unordered_set< string > &eventFloatingNodeIds) override
	Determine mouse event nodes. More...

void	invalidateRenderCaches ()
	Invalidate render caches. More...

Public Member Functions inherited from GUINode
GUIScreenNode *	getScreenNode ()

GUIParentNode *	getParentNode ()

const string &	getId ()

const string	getHierarchicalId ()

virtual const string	getNodeType ()=0

virtual int	getContentWidth ()=0

virtual int	getContentHeight ()=0

virtual int	getAutoWidth ()

virtual int	getAutoHeight ()

GUINode_Border &	getBorder ()

GUINode_Padding &	getPadding ()

GUINode_RequestedConstraints &	getRequestsConstraints ()

GUINode_ComputedConstraints &	getComputedConstraints ()

GUIColor &	getBackgroundColor ()

virtual void	dispose ()
	Dispose node. More...

bool	isConditionsMet ()
	Determine if conditions are set. More...

virtual void	setConditionsMet ()
	Set conditions met for this node and its subnodes. More...

virtual void	layoutOnDemand ()
	Layout on demand. More...

bool	hasEffects ()

virtual void	applyEffects (GUIRenderer *guiRenderer)
	Apply effects. More...

virtual void	undoEffects (GUIRenderer *guiRenderer)
	Undo effects. More...

virtual void	render (GUIRenderer *guiRenderer)
	Render. More...

float	computeParentChildrenRenderOffsetXTotal ()

float	computeParentChildrenRenderOffsetYTotal ()

bool	isEventBelongingToNode (GUIMouseEvent *event, Vector2 &position)
	Is event belonging to node. More...

bool	isEventBelongingToNode (GUIMouseEvent *event)
	Is event belonging to node. More...

void	getEventOffNodeRelativePosition (GUIMouseEvent *event, Vector2 &position)
	Get event off node relative position TODO: use Vector2 instead of array<float, 2> More...

void	getEventNodePosition (GUIMouseEvent *event, Vector2 &position)
	Get event position clamped to node constraints TODO: use Vector2 instead of array<float, 2> More...

GUIParentNode *	getParentControllerNode ()

virtual void	determineMouseEventNodes (GUIMouseEvent *event, bool floatingNode, unordered_set< string > &eventNodeIds, unordered_set< string > &eventFloatingNodeIds)
	Determine mouse event nodes. More...

GUINodeController *	getController ()

void	setController (GUINodeController *controller)
	Set up node controller. More...

void	scrollToNodeY (GUIParentNode *toNode=nullptr)
	Scroll to node Y. More...

void	scrollToNodeX (GUIParentNode *toNode=nullptr)
	Scroll to node X. More...

void	setBackgroundImage (const string &backgroundImage)
	Set background image. More...

int	getGUIEffectOffsetX ()

void	setGUIEffectOffsetX (int guiEffectOffsetX)
	Set GUI effect offset X. More...

int	getGUIEffectOffsetY ()

void	setGUIEffectOffsetY (int guiEffectOffsetY)
	Set GUI effect offset Y. More...

GUIEffectState *	getEffectState ()

GUIEffect *	getEffect (const string &id)
	Get effect. More...

void	addEffect (const string &id, GUIEffect *effect)
	Add effect, effect already registered with the is will be removed. More...

void	removeEffect (const string &id)
	Remove effect. More...

Static Public Member Functions
static GUIParentNode_Overflow *	createOverflow (const string &overflow)
	Create over flow. More...

static GUINode_RequestedConstraints	createRequestedConstraints (const string &left, const string &top, const string &width, const string &height, int factor)
	Create requested constraints. More...

Static Public Member Functions inherited from GUINode
static GUINode_Alignments	createAlignments (const string &horizontal, const string &vertical)
	Create alignments. More...

static GUINode_RequestedConstraints	createRequestedConstraints (const string &left, const string &top, const string &width, const string &height, int factor)
	Create requested constraints. More...

static GUIColor	getRequestedColor (const string &color, const GUIColor &defaultColor)
	Get color. More...

static GUINode_Flow *	createFlow (const string &flow)
	Create flow. More...

static GUINode_Border	createBorder (const string &allBorder, const string &left, const string &top, const string &right, const string &bottom, const string &allBorderColor, const string &leftColor, const string &topColor, const string &rightColor, const string &bottomColor)
	Create border. More...

static GUINode_Padding	createPadding (const string &allPadding, const string &left, const string &top, const string &right, const string &bottom)
	Create padding. More...

static GUINode_Scale9Grid	createScale9Grid (const string &all, const string &left, const string &top, const string &right, const string &bottom)
	Create scale 9 grid. More...

static GUINodeConditions	createConditions (const string &conditions)
	Create conditions. More...

static void	dumpNode (GUINode *node, int depth=0, int indent=0, int depthIdx=0)
	Dump node. More...

static void	dumpParentNodes (GUINode *node, int indent=0)
	Dump parent nodes. More...

Protected Member Functions
	GUIParentNode (GUIScreenNode screenNode, GUIParentNode parentNode, const string &id, GUINode_Flow flow, GUIParentNode_Overflow overflowX, GUIParentNode_Overflow *overflowY, const GUINode_Alignments &alignments, const GUINode_RequestedConstraints &requestedConstraints, const GUIColor &backgroundColor, const string &backgroundImage, const GUINode_Scale9Grid &backgroundImageScale9Grid, const GUIColor &backgroundImageEffectColorMul, const GUIColor &backgroundImageEffectColorAdd, const GUINode_Border &border, const GUINode_Padding &padding, const GUINodeConditions &showOn, const GUINodeConditions &hideOn)
	Constructor. More...

void	layout () override
	Layout. More...

virtual void	layoutSubNodes ()
	Layout sub nodes. More...

virtual void	computeHorizontalChildrenAlignment ()
	Compute horizontal children alignment. More...

virtual void	computeVerticalChildrenAlignment ()
	Compute vertical children alignment. More...

vector< GUINode * >	detachSubNodes ()
	Detach sub nodes. More...

Protected Member Functions inherited from GUINode
	GUINode (GUIScreenNode screenNode, GUIParentNode parentNode, const string &id, GUINode_Flow *flow, const GUINode_Alignments &alignments, const GUINode_RequestedConstraints &requestedConstraints, const GUIColor &backgroundColor, const string &backgroundImage, const GUINode_Scale9Grid &backgroundImageScale9Grid, const GUIColor &backgroundImageEffectColorMul, const GUIColor &backgroundImageEffectColorAdd, const GUINode_Border &border, const GUINode_Padding &padding, const GUINodeConditions &showOn, const GUINodeConditions &hideOn)
	Public constructor. More...

virtual	~GUINode ()
	Destructor. More...

virtual bool	isContentNode ()=0

virtual void	setLeft (int left)
	Set computed left. More...

virtual void	setTop (int top)
	Set computed top. More...

virtual void	layout ()
	Layout. More...

virtual void	computeContentAlignment ()
	Do content alignment. More...

int	layoutConstraintPixel (GUINode_RequestedConstraints_RequestedConstraintsType *type, int autoValue, int parentValue, int value)
	Layout constraint. More...

bool	checkConditions ()
	Check if conditions are met. More...

void	onSetConditions (const vector< string > &conditions)
	On set condition. More...

bool	haveActiveOutEffect ()
	Determine if we have a out effect active. More...

bool	shouldRender ()
	Determine if to render. More...

void	_scrollToNodeX (GUIParentNode *toNode=nullptr)
	Scroll to node X. More...

void	_scrollToNodeY (GUIParentNode *toNode=nullptr)
	Scroll to node Y. More...

Protected Attributes
vector< GUINode * >	subNodes

bool	computeViewportCache

vector< GUINode * >	vieportSubNodesCache

vector< GUINode * >	floatingNodesCache

GUIParentNode_Overflow *	overflowX

GUIParentNode_Overflow *	overflowY

Protected Attributes inherited from GUINode
GUIScreenNode *	screenNode { nullptr }

GUIParentNode *	parentNode { nullptr }

string	id

GUINode_Alignments	alignments

GUINode_RequestedConstraints	requestedConstraints

GUINode_ComputedConstraints	computedConstraints

GUIColor	backgroundColor

Texture *	backgroundTexture { nullptr }

int	backgroundTextureId

GUINode_Scale9Grid	backgroundImageScale9Grid

GUIColor	backgroundImageEffectColorMul

GUIColor	backgroundImageEffectColorAdd

GUINode_Padding	padding

GUINode_Border	border

GUINodeConditions	showOn

GUINodeConditions	hideOn

GUINodeController *	controller { nullptr }

unordered_map< string, GUIEffect * >	effects

int	guiEffectOffsetX

int	guiEffectOffsetY

bool	conditionsMet

bool	layouted

bool	haveOutEffect

vector< string >	lastConditions

GUIEffectState *	effectState { nullptr }

Private Member Functions
void	getChildControllerNodesInternal (vector< GUINode * > &childControllerNodes, bool requireConditionsMet=false)
	Get child controller nodes internal. More...

void	removeSubNode (GUINode *node, bool resetScrollOffsets)
	Remove sub node. More...

void	unsetMouseOver ()
	Unset mouse event condition on element nodes. More...

Private Attributes
float	childrenRenderOffsetX

float	childrenRenderOffsetY

Friends
class	tdme::gui::GUI

class	tdme::gui::GUIParser

class	GUIElementNode

class	GUILayerNode

class	GUILayoutNode

class	GUINode

class	GUINodeConditions

class	GUIScreenNode

class	GUITableNode

class	GUITableCellNode

class	GUITableRowNode

class	GUIHorizontalScrollbarInternalController

class	GUIVerticalScrollbarInternalController

class	GUIParentNode_Overflow

Additional Inherited Members
Static Protected Member Functions inherited from GUINode
static GUINode_RequestedConstraints_RequestedConstraintsType *	getRequestedConstraintsType (const string &constraint, GUINode_RequestedConstraints_RequestedConstraintsType *defaultConstraintsType)
	Get requested constraints type. More...

static int	getRequestedConstraintsValue (const string &constraint, int defaultConstraintsValue)
	Get requested constraints value. More...

static int	getRequestedPixelValue (const string &value, int defaultValue)
	Get requested pixel value. More...

Detailed Description

GUI parent node base class thats supporting child nodes.

Author: Andreas Drewke

Version: $Id$

Definition at line 41 of file GUIParentNode.h.

Constructor & Destructor Documentation

◆ GUIParentNode()

GUIParentNode	(	GUIScreenNode *	screenNode,
		GUIParentNode *	parentNode,
		const string &	id,
		GUINode_Flow *	flow,
		GUIParentNode_Overflow *	overflowX,
		GUIParentNode_Overflow *	overflowY,
		const GUINode_Alignments &	alignments,
		const GUINode_RequestedConstraints &	requestedConstraints,
		const GUIColor &	backgroundColor,
		const string &	backgroundImage,
		const GUINode_Scale9Grid &	backgroundImageScale9Grid,
		const GUIColor &	backgroundImageEffectColorMul,
		const GUIColor &	backgroundImageEffectColorAdd,
		const GUINode_Border &	border,
		const GUINode_Padding &	padding,
		const GUINodeConditions &	showOn,
		const GUINodeConditions &	hideOn
	)

protected

Constructor.

Parameters

screenNode	screen node
parentNode	parent node
id	id
flow	flow
overflowX	overflow x
overflowY	overflow y
alignments	alignments
requestedConstraints	requested constraints
backgroundColor	background color
backgroundImage	background image
backgroundImageScale9Grid	background image scale 9 grid
backgroundImageEffectColorMul	background image effect color mul
backgroundImageEffectColorAdd	background image effect color add
border	border
padding	padding
showOn	show on
hideOn	hide on

Exceptions

tdme::gui::GUIParserException

Definition at line 62 of file GUIParentNode.cpp.

Member Function Documentation

◆ addSubNode()

void addSubNode ( GUINode * node )

Add sub node.

Parameters

node node

Exceptions

tdme::gui::GUIParserException

Definition at line 255 of file GUIParentNode.cpp.

◆ addSubNodes()

void addSubNodes	(	const string &	xml,
		bool	resetScrollOffsets
	)

Add sub nodes with given XML.

Parameters

xml	xml
resetScrollOffsets	reset scroll offsets

Exceptions

tdme::gui::GUIParserException

Definition at line 207 of file GUIParentNode.cpp.

◆ clearSubNodes()

void clearSubNodes ( )

Clear sub nodes.

Definition at line 131 of file GUIParentNode.cpp.

◆ computeHorizontalChildrenAlignment()

void computeHorizontalChildrenAlignment ( )

protectedvirtual

Compute horizontal children alignment.

Definition at line 398 of file GUIParentNode.cpp.

◆ computeVerticalChildrenAlignment()

void computeVerticalChildrenAlignment ( )

protectedvirtual

Compute vertical children alignment.

Definition at line 425 of file GUIParentNode.cpp.

◆ createOverflow()

GUIParentNode_Overflow * createOverflow ( const string & overflow )

static

Create over flow.

Parameters

overflow over flow

Returns: over flow

Exceptions

tdme::gui::GUIParserException

Definition at line 318 of file GUIParentNode.cpp.

◆ createRequestedConstraints()

GUINode_RequestedConstraints createRequestedConstraints	(	const string &	left,
		const string &	top,
		const string &	width,
		const string &	height,
		int	factor
	)

static

Create requested constraints.

Parameters

left	left
top	top
width	width
height	height
factor	factor

Returns: requested constraints

Definition at line 362 of file GUIParentNode.cpp.

◆ detachSubNodes()

vector< GUINode * > detachSubNodes ( )

protected

Detach sub nodes.

Returns: sub nodes

Definition at line 90 of file GUIParentNode.cpp.

◆ determineMouseEventNodes()

void determineMouseEventNodes	(	GUIMouseEvent *	event,
		bool	floatingNode,
		unordered_set< string > &	eventNodeIds,
		unordered_set< string > &	eventFloatingNodeIds
	)

overridevirtual

Determine mouse event nodes.

Parameters

event	event
floatingNode	if node is floating node
eventNodeIds	event node ids
eventFloatingNodeIds	event floating node ids

Reimplemented from GUINode.

Reimplemented in GUIScreenNode.

Definition at line 608 of file GUIParentNode.cpp.

◆ dispose()

void dispose ( )

overridevirtual

Dispose node.

Reimplemented from GUINode.

Definition at line 472 of file GUIParentNode.cpp.

◆ getChildControllerNodes()

void getChildControllerNodes	(	vector< GUINode * > &	childControllerNodes,
		bool	requireConditionsMet = `false`
	)

Get child controller nodes.

Parameters

childControllerNodes	child controller nodes
requireConditionsMet	require conditions met

Definition at line 466 of file GUIParentNode.cpp.

◆ getChildControllerNodesInternal()

void getChildControllerNodesInternal	(	vector< GUINode * > &	childControllerNodes,
		bool	requireConditionsMet = `false`
	)

private

Get child controller nodes internal.

Parameters

childControllerNodes	child controller nodes
requireConditionsMet	require conditions met

Definition at line 452 of file GUIParentNode.cpp.

◆ getChildrenRenderOffsetX()

float getChildrenRenderOffsetX ( )

Returns: children render offset x

Definition at line 340 of file GUIParentNode.cpp.

◆ getChildrenRenderOffsetY()

float getChildrenRenderOffsetY ( )

Returns: children render offset y

Definition at line 351 of file GUIParentNode.cpp.

◆ getOverflowX()

GUIParentNode_Overflow * getOverflowX ( )

Returns: overflow x

Definition at line 308 of file GUIParentNode.cpp.

◆ getOverflowY()

GUIParentNode_Overflow * getOverflowY ( )

Returns: overflow y

Definition at line 313 of file GUIParentNode.cpp.

◆ invalidateRenderCaches()

void invalidateRenderCaches ( )

Invalidate render caches.

Definition at line 655 of file GUIParentNode.cpp.

◆ layout()

void layout ( )

overrideprotectedvirtual

Layout.

Reimplemented from GUINode.

Reimplemented in GUIScreenNode.

Definition at line 380 of file GUIParentNode.cpp.

◆ layoutSubNodes()

void layoutSubNodes ( )

protectedvirtual

Layout sub nodes.

Reimplemented in GUILayerNode, GUILayoutNode, GUITableNode, and GUITableRowNode.

Definition at line 387 of file GUIParentNode.cpp.

◆ moveNodes()

void moveNodes ( GUIParentNode * otherParentNode )

Move children nodes from other parent node into this parent node.

Parameters

otherParentNode other parent node

Definition at line 272 of file GUIParentNode.cpp.

◆ removeSubNode()

void removeSubNode	(	GUINode *	node,
		bool	resetScrollOffsets
	)

private

Remove sub node.

Parameters

node	node
resetScrollOffsets	reset scroll offsets

Definition at line 664 of file GUIParentNode.cpp.

◆ render()

void render ( GUIRenderer * guiRenderer )

overridevirtual

Render.

Parameters

guiRenderer	gui renderer
floatingNodes	floating nodes

Reimplemented from GUINode.

Reimplemented in GUIScreenNode.

Definition at line 491 of file GUIParentNode.cpp.

◆ replaceSubNodes()

void replaceSubNodes	(	const string &	xml,
		bool	resetScrollOffsets
	)

Replace sub nodes with given XML.

Parameters

xml	xml
resetScrollOffsets	reset scroll offsets

Exceptions

tdme::gui::GUIParserException

Definition at line 143 of file GUIParentNode.cpp.

◆ setChildrenRenderOffsetX()

void setChildrenRenderOffsetX ( float childrenRenderOffSetX )

Set children render offset x.

Parameters

childrenRenderOffSetX children render offset x

Definition at line 345 of file GUIParentNode.cpp.

◆ setChildrenRenderOffsetY()

void setChildrenRenderOffsetY ( float childrenRenderOffSetY )

Set children render offset y.

Parameters

childrenRenderOffSetY children render offset y

Definition at line 356 of file GUIParentNode.cpp.

◆ setConditionsMet()

void setConditionsMet ( )

overridevirtual

Set conditions met for this node and its subnodes.

Reimplemented from GUINode.

Definition at line 480 of file GUIParentNode.cpp.

◆ unsetMouseOver()

void unsetMouseOver ( )

private

Unset mouse event condition on element nodes.

Definition at line 712 of file GUIParentNode.cpp.

Friends And Related Function Documentation

◆ GUIElementNode

friend class GUIElementNode

friend

Definition at line 46 of file GUIParentNode.h.

◆ GUIHorizontalScrollbarInternalController

friend class GUIHorizontalScrollbarInternalController

friend

Definition at line 55 of file GUIParentNode.h.

◆ GUILayerNode

friend class GUILayerNode

friend

Definition at line 47 of file GUIParentNode.h.

◆ GUILayoutNode

friend class GUILayoutNode

friend

Definition at line 48 of file GUIParentNode.h.

◆ GUINode

friend class GUINode

friend

Definition at line 49 of file GUIParentNode.h.

◆ GUINodeConditions

friend class GUINodeConditions

friend

Definition at line 50 of file GUIParentNode.h.

◆ GUIParentNode_Overflow

friend class GUIParentNode_Overflow

friend

Definition at line 57 of file GUIParentNode.h.

◆ GUIScreenNode

friend class GUIScreenNode

friend

Definition at line 51 of file GUIParentNode.h.

◆ GUITableCellNode

friend class GUITableCellNode

friend

Definition at line 53 of file GUIParentNode.h.

◆ GUITableNode

friend class GUITableNode

friend

Definition at line 52 of file GUIParentNode.h.

◆ GUITableRowNode

friend class GUITableRowNode

friend

Definition at line 54 of file GUIParentNode.h.

◆ GUIVerticalScrollbarInternalController

friend class GUIVerticalScrollbarInternalController

friend

Definition at line 56 of file GUIParentNode.h.

◆ tdme::gui::GUI

friend class tdme::gui::GUI

friend

Definition at line 44 of file GUIParentNode.h.

◆ tdme::gui::GUIParser

friend class tdme::gui::GUIParser

friend

Definition at line 45 of file GUIParentNode.h.

Member Data Documentation

◆ childrenRenderOffsetX

float childrenRenderOffsetX

private

Definition at line 59 of file GUIParentNode.h.

◆ childrenRenderOffsetY

float childrenRenderOffsetY

private

Definition at line 60 of file GUIParentNode.h.

◆ computeViewportCache

bool computeViewportCache

protected

Definition at line 64 of file GUIParentNode.h.

◆ floatingNodesCache

vector<GUINode*> floatingNodesCache

protected

Definition at line 66 of file GUIParentNode.h.

◆ overflowX

GUIParentNode_Overflow* overflowX

protected

Definition at line 67 of file GUIParentNode.h.

◆ overflowY

GUIParentNode_Overflow* overflowY

protected

Definition at line 68 of file GUIParentNode.h.

◆ subNodes

vector<GUINode*> subNodes

protected

Definition at line 63 of file GUIParentNode.h.

◆ vieportSubNodesCache

vector<GUINode*> vieportSubNodesCache

protected

Definition at line 65 of file GUIParentNode.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GUIParentNode()

Member Function Documentation

◆ addSubNode()

◆ addSubNodes()

◆ clearSubNodes()

◆ computeHorizontalChildrenAlignment()

◆ computeVerticalChildrenAlignment()

◆ createOverflow()

◆ createRequestedConstraints()

◆ detachSubNodes()

◆ determineMouseEventNodes()

◆ dispose()

◆ getChildControllerNodes()

◆ getChildControllerNodesInternal()

◆ getChildrenRenderOffsetX()

◆ getChildrenRenderOffsetY()

◆ getOverflowX()

◆ getOverflowY()

◆ invalidateRenderCaches()

◆ layout()

◆ layoutSubNodes()

◆ moveNodes()

◆ removeSubNode()

◆ render()

◆ replaceSubNodes()

◆ setChildrenRenderOffsetX()

◆ setChildrenRenderOffsetY()

◆ setConditionsMet()

◆ unsetMouseOver()

Friends And Related Function Documentation

◆ GUIElementNode

◆ GUIHorizontalScrollbarInternalController

◆ GUILayerNode

◆ GUILayoutNode

◆ GUINode

◆ GUINodeConditions

◆ GUIParentNode_Overflow

◆ GUIScreenNode

◆ GUITableCellNode

◆ GUITableNode

◆ GUITableRowNode

◆ GUIVerticalScrollbarInternalController

◆ tdme::gui::GUI

◆ tdme::gui::GUIParser

Member Data Documentation

◆ childrenRenderOffsetX

◆ childrenRenderOffsetY

◆ computeViewportCache

◆ floatingNodesCache

◆ overflowX

◆ overflowY

◆ subNodes

◆ vieportSubNodesCache