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

Inheritance diagram for GUILayoutNode:

Collaboration diagram for GUILayoutNode:

Public Member Functions
int	getContentWidth () override

int	getContentHeight () override

Public Member Functions inherited from GUIParentNode
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 GUILayoutNode_Alignment *	createAlignment (const string &alignment)
	Create alignment. More...

Static Public Member Functions inherited from GUIParentNode
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
	GUILayoutNode (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, GUILayoutNode_Alignment alignment)
	Constructor. More...

const string	getNodeType () override

bool	isContentNode () override

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

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

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

Protected Member Functions inherited from 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)
	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...

Private Attributes
GUILayoutNode_Alignment *	alignment { nullptr }

Friends
class	tdme::gui::GUIParser

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...

Protected Attributes inherited from GUIParentNode
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 }

Detailed Description

GUI layout node.

Definition at line 24 of file GUILayoutNode.h.

Constructor & Destructor Documentation

◆ GUILayoutNode()

GUILayoutNode	(	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,
		GUILayoutNode_Alignment *	alignment
	)

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
alignment	alignment

Exceptions

tdme::gui::GUIParserException

Definition at line 42 of file GUILayoutNode.cpp.

Member Function Documentation

◆ createAlignment()

GUILayoutNode_Alignment * createAlignment ( const string & alignment )

static

Create alignment.

Parameters

alignment alignment

Returns: alignment

Definition at line 328 of file GUILayoutNode.cpp.

◆ getContentHeight()

int getContentHeight ( )

overridevirtual

Returns: content height including border, margin

Implements GUINode.

Definition at line 107 of file GUILayoutNode.cpp.

◆ getContentWidth()

int getContentWidth ( )

overridevirtual

Returns: content width including border, margin

Implements GUINode.

Definition at line 77 of file GUILayoutNode.cpp.

◆ getNodeType()

const string getNodeType ( )

overrideprotectedvirtual

Returns: node type

Implements GUINode.

Reimplemented in GUIPanelNode, and GUITableCellNode.

Definition at line 67 of file GUILayoutNode.cpp.

◆ isContentNode()

bool isContentNode ( )

overrideprotectedvirtual

Returns: is content node

Implements GUINode.

Definition at line 72 of file GUILayoutNode.cpp.

◆ layoutSubNodes()

void layoutSubNodes ( )

overrideprotectedvirtual

Layout sub nodes.

Reimplemented from GUIParentNode.

Definition at line 137 of file GUILayoutNode.cpp.

◆ setLeft()

void setLeft ( int left )

overrideprotectedvirtual

Set computed left.

Parameters

left left

Reimplemented from GUINode.

Definition at line 312 of file GUILayoutNode.cpp.

◆ setTop()

void setTop ( int top )

overrideprotectedvirtual

Set computed top.

Parameters

top top

Reimplemented from GUINode.

Definition at line 296 of file GUILayoutNode.cpp.

Friends And Related Function Documentation

◆ tdme::gui::GUIParser

friend class tdme::gui::GUIParser

friend

Definition at line 26 of file GUILayoutNode.h.

Member Data Documentation

◆ alignment

GUILayoutNode_Alignment* alignment { nullptr }

private

Definition at line 29 of file GUILayoutNode.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GUILayoutNode()

Member Function Documentation

◆ createAlignment()

◆ getContentHeight()

◆ getContentWidth()

◆ getNodeType()

◆ isContentNode()

◆ layoutSubNodes()

◆ setLeft()

◆ setTop()

Friends And Related Function Documentation

◆ tdme::gui::GUIParser

Member Data Documentation

◆ alignment