GUI element node. More...

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

Inheritance diagram for GUIElementNode:

Collaboration diagram for GUIElementNode:

Public Member Functions
bool	isFocusable ()

const string &	getName ()

const string &	getValue ()

bool	isSelected ()

bool	isDisabled ()

const string &	getOnInitializeExpression ()

const string &	getOnMouseClickExpression ()

const string &	getOnMouseDoubleClickExpression ()

const string &	getOnMouseOverExpression ()

const string &	getOnMouseOutExpression ()

const string &	getOnChangeExpression ()

void	executeOnChangeExpression ()
	Execute on change expression. More...

const string &	getParentElementNodeId ()

bool	hasOption (const string &option)

const string	getOptionValue (const string &option)

GUINodeConditions &	getActiveConditions ()

void	handleKeyboardEvent (GUIKeyboardEvent *event)
	Handle keyboard event. More...

Public Member Functions inherited from GUILayerNode
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 void	executeExpression (GUIScreenNode *screenNode, const string &expression)
	Execute expression. 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...

Static Public Attributes
static STATIC_DLL_IMPEXT string	CONDITION_FOCUS = "focus"

static STATIC_DLL_IMPEXT string	CONDITION_ALWAYS = "always"

static STATIC_DLL_IMPEXT string	CONDITION_ONMOUSEOVER = "mouseover"

static STATIC_DLL_IMPEXT string	CONDITION_CLICK = "click"

Protected Member Functions
const string	getNodeType () override

bool	isContentNode () override

	GUIElementNode (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, const string &name, const string &value, bool selected, bool disabled, bool focusable, bool ignoreEvents, const string &onInitialize, const string &onMouseClick, const string &onMouseDoubleClickExpression, const string &onMouseOver, const string &onMouseOut, const string &onChangeExpression, const string &parentElementId, const string &options)
	Constructor. More...

Protected Member Functions inherited from GUILayerNode
const string	getNodeType () override

bool	isContentNode () override

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

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

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

void	layout () override
	Layout. More...

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

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
string	name

string	value

bool	selected

bool	disabled

GUINodeConditions	activeConditions

bool	focusable

bool	ignoreEvents

string	onInitializeExpression

string	onMouseClickExpression

string	onMouseDoubleClickExpression

string	onMouseOverExpression

string	onMouseOutExpression

string	onChangeExpression

string	parentElementId

vector< string >	options

Friends
class	tdme::gui::GUIParser

class	GUINode

class	GUIScreenNode

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

Author: Andreas Drewke

Version: $Id$

Definition at line 37 of file GUIElementNode.h.

Constructor & Destructor Documentation

◆ GUIElementNode()

GUIElementNode	(	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,
		const string &	name,
		const string &	value,
		bool	selected,
		bool	disabled,
		bool	focusable,
		bool	ignoreEvents,
		const string &	onInitialize,
		const string &	onMouseClick,
		const string &	onMouseDoubleClickExpression,
		const string &	onMouseOver,
		const string &	onMouseOut,
		const string &	onChangeExpression,
		const string &	parentElementId,
		const string &	options
	)

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
name	name
value	value
selected	selected
disabled	disabled
focusable	focusable
ignoreEvents	ignore events
onInitialize	on initialize expression
onMouseClick	on mouse click expression
onMouseDoubleClickExpression	on mouse double click expression
onMouseOver	on mouse over expression
onMouseOut	on mouse out expression
onChangeExpression	on change expression
parentElementId	parent element id
options	options

Definition at line 71 of file GUIElementNode.cpp.

Member Function Documentation

◆ executeExpression()

void executeExpression	(	GUIScreenNode *	screenNode,
		const string &	expression
	)

static

Execute expression.

Parameters

screenNode	screen node
expression	expression

Definition at line 189 of file GUIElementNode.cpp.

◆ executeOnChangeExpression()

void executeOnChangeExpression ( )

Execute on change expression.

Definition at line 326 of file GUIElementNode.cpp.

◆ getActiveConditions()

GUINodeConditions & getActiveConditions ( )

Returns: active conditions

Definition at line 351 of file GUIElementNode.cpp.

◆ getName()

const string & getName ( )

Returns: name

Definition at line 145 of file GUIElementNode.cpp.

◆ getNodeType()

const string getNodeType ( )

overrideprotectedvirtual

Returns: node type

Implements GUINode.

Definition at line 130 of file GUIElementNode.cpp.

◆ getOnChangeExpression()

const string & getOnChangeExpression ( )

Returns: on change expression

Definition at line 185 of file GUIElementNode.cpp.

◆ getOnInitializeExpression()

const string & getOnInitializeExpression ( )

Returns: on initialize expression

Definition at line 165 of file GUIElementNode.cpp.

◆ getOnMouseClickExpression()

const string & getOnMouseClickExpression ( )

Returns: on mouse click expression

Definition at line 169 of file GUIElementNode.cpp.

◆ getOnMouseDoubleClickExpression()

const string & getOnMouseDoubleClickExpression ( )

Returns: on mouse double click expression

Definition at line 173 of file GUIElementNode.cpp.

◆ getOnMouseOutExpression()

const string & getOnMouseOutExpression ( )

Returns: on mouse out expression

Definition at line 181 of file GUIElementNode.cpp.

◆ getOnMouseOverExpression()

const string & getOnMouseOverExpression ( )

Returns: on mouse over expression

Definition at line 177 of file GUIElementNode.cpp.

◆ getOptionValue()

const string getOptionValue ( const string & option )

Returns: an option value, like <... options="type=float,min=0.0,max=1.0,step=0.1" /> or empty string if option does not exist

Definition at line 338 of file GUIElementNode.cpp.

◆ getParentElementNodeId()

const string & getParentElementNodeId ( )

Returns: parent element id

Definition at line 330 of file GUIElementNode.cpp.

◆ getValue()

const string & getValue ( )

Returns: value

Definition at line 150 of file GUIElementNode.cpp.

◆ handleKeyboardEvent()

void handleKeyboardEvent ( GUIKeyboardEvent * event )

Handle keyboard event.

Parameters

event keyboard event

Definition at line 356 of file GUIElementNode.cpp.

◆ hasOption()

bool hasOption ( const string & option )

Returns: if option is among given options

Definition at line 334 of file GUIElementNode.cpp.

◆ isContentNode()

bool isContentNode ( )

overrideprotectedvirtual

Returns: is content node

Implements GUINode.

Definition at line 135 of file GUIElementNode.cpp.

◆ isDisabled()

bool isDisabled ( )

Returns: is disabled

Definition at line 160 of file GUIElementNode.cpp.

◆ isFocusable()

bool isFocusable ( )

Returns: focusable

Definition at line 140 of file GUIElementNode.cpp.

◆ isSelected()

bool isSelected ( )

Returns: is selected

Definition at line 155 of file GUIElementNode.cpp.

Friends And Related Function Documentation

◆ GUINode

friend class GUINode

friend

Definition at line 40 of file GUIElementNode.h.

◆ GUIScreenNode

friend class GUIScreenNode

friend

Definition at line 41 of file GUIElementNode.h.

◆ tdme::gui::GUIParser

friend class tdme::gui::GUIParser

friend

Definition at line 39 of file GUIElementNode.h.

Member Data Documentation

◆ activeConditions

GUINodeConditions activeConditions

private

Definition at line 54 of file GUIElementNode.h.

◆ CONDITION_ALWAYS

string CONDITION_ALWAYS = "always"

static

Definition at line 45 of file GUIElementNode.h.

◆ CONDITION_CLICK

string CONDITION_CLICK = "click"

static

Definition at line 47 of file GUIElementNode.h.

◆ CONDITION_FOCUS

string CONDITION_FOCUS = "focus"

static

Definition at line 44 of file GUIElementNode.h.

◆ CONDITION_ONMOUSEOVER

string CONDITION_ONMOUSEOVER = "mouseover"

static

Definition at line 46 of file GUIElementNode.h.

◆ disabled

bool disabled

private

Definition at line 53 of file GUIElementNode.h.

◆ focusable

bool focusable

private

Definition at line 55 of file GUIElementNode.h.

◆ ignoreEvents

bool ignoreEvents

private

Definition at line 56 of file GUIElementNode.h.

◆ name

string name

private

Definition at line 50 of file GUIElementNode.h.

◆ onChangeExpression

string onChangeExpression

private

Definition at line 62 of file GUIElementNode.h.

◆ onInitializeExpression

string onInitializeExpression

private

Definition at line 57 of file GUIElementNode.h.

◆ onMouseClickExpression

string onMouseClickExpression

private

Definition at line 58 of file GUIElementNode.h.

◆ onMouseDoubleClickExpression

string onMouseDoubleClickExpression

private

Definition at line 59 of file GUIElementNode.h.

◆ onMouseOutExpression

string onMouseOutExpression

private

Definition at line 61 of file GUIElementNode.h.

◆ onMouseOverExpression

string onMouseOverExpression

private

Definition at line 60 of file GUIElementNode.h.

◆ options

vector<string> options

private

Definition at line 64 of file GUIElementNode.h.

◆ parentElementId

string parentElementId

private

Definition at line 63 of file GUIElementNode.h.

◆ selected

bool selected

private

Definition at line 52 of file GUIElementNode.h.

◆ value

string value

private

Definition at line 51 of file GUIElementNode.h.

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GUIElementNode()

Member Function Documentation

◆ executeExpression()

◆ executeOnChangeExpression()

◆ getActiveConditions()

◆ getName()

◆ getNodeType()

◆ getOnChangeExpression()

◆ getOnInitializeExpression()

◆ getOnMouseClickExpression()

◆ getOnMouseDoubleClickExpression()

◆ getOnMouseOutExpression()

◆ getOnMouseOverExpression()

◆ getOptionValue()

◆ getParentElementNodeId()

◆ getValue()

◆ handleKeyboardEvent()

◆ hasOption()

◆ isContentNode()

◆ isDisabled()

◆ isFocusable()

◆ isSelected()

Friends And Related Function Documentation

◆ GUINode

◆ GUIScreenNode

◆ tdme::gui::GUIParser

Member Data Documentation

◆ activeConditions

◆ CONDITION_ALWAYS

◆ CONDITION_CLICK

◆ CONDITION_FOCUS

◆ CONDITION_ONMOUSEOVER

◆ disabled

◆ focusable

◆ ignoreEvents

◆ name

◆ onChangeExpression

◆ onInitializeExpression

◆ onMouseClickExpression

◆ onMouseDoubleClickExpression

◆ onMouseOutExpression

◆ onMouseOverExpression

◆ options

◆ parentElementId

◆ selected

◆ value