GUI gradient node. More...

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

Inheritance diagram for GUIGradientNode:

Collaboration diagram for GUIGradientNode:

Classes
struct	Gradient

Public Member Functions
int	getContentWidth () override

int	getContentHeight () override

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

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

void	setTextureMatrix (const Matrix2D3x3 &textureMatrix)
	Set texture matrix. More...

const GUIColor &	getEffectColorMul ()

void	setEffectColorMul (const GUIColor &effectColorMul)
	Set effect color mul. More...

const GUIColor &	getEffectColorAdd ()

void	setEffectColorAdd (const GUIColor &effectColorAdd)
	Set effect color add. More...

GUINode_Clipping &	getClipping ()

const string &	getMask ()

void	setMask (const string &mask)
	Set mask source. More...

float	getMaskMaxValue ()

void	setMaskMaxValue (float maskMaxValue)
	Set maximum value of mask to display image. 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 Gradient	createGradient (const string &colors, const string &rotation)
	Create gradient from string values. More...

static GUINode_Clipping	createClipping (const string &allClipping, const string &left, const string &top, const string &right, const string &bottom)
	Create clipping. 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
	GUIGradientNode (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, const GUIColor &effectColorMul, const GUIColor &effectColorAdd, const GUINode_Clipping &clipping, const string &mask, float maskMaxValue, const Gradient &gradient)
	Constructor. More...

const string	getNodeType () override

bool	isContentNode () override

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
GUIColor	effectColorMul

GUIColor	effectColorAdd

GUINode_Clipping	clipping

Texture *	maskTexture { nullptr }

float	maskMaxValue

int32_t	maskTextureId { 0 }

Matrix2D3x3	textureMatrix

string	mask

Gradient	gradient

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

Author: Andreas Drewke

Version: $Id$

Definition at line 39 of file GUIGradientNode.h.

Constructor & Destructor Documentation

◆ GUIGradientNode()

GUIGradientNode	(	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,
		const GUIColor &	effectColorMul,
		const GUIColor &	effectColorAdd,
		const GUINode_Clipping &	clipping,
		const string &	mask,
		float	maskMaxValue,
		const Gradient &	gradient
	)

protected

Constructor.

Parameters

screenNode	screen node
parentNode	parent node
id	id
flow	flow
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
effectColorMul	effect color mul
effectColorAdd	effect color add
clipping	clipping
mask	mask image
maskMaxValue	maximum value of mask to display image
gradient	gradient

Exceptions

tdme::gui::GUIParserException

Definition at line 70 of file GUIGradientNode.cpp.

Member Function Documentation

◆ createClipping()

GUINode_Clipping createClipping	(	const string &	allClipping,
		const string &	left,
		const string &	top,
		const string &	right,
		const string &	bottom
	)

static

Create clipping.

Parameters

allClipping	all sides
left	left
top	top
right	right
bottom	bottom

Definition at line 236 of file GUIGradientNode.cpp.

◆ createGradient()

GUIGradientNode::Gradient createGradient	(	const string &	colors,
		const string &	rotation
	)

static

Create gradient from string values.

Parameters

colors	colors
rotation	rotation

Definition at line 44 of file GUIGradientNode.cpp.

◆ dispose()

void dispose ( )

overridevirtual

Dispose node.

Reimplemented from GUINode.

Definition at line 131 of file GUIGradientNode.cpp.

◆ getClipping()

GUINode_Clipping & getClipping ( )

Returns: clipping

Definition at line 232 of file GUIGradientNode.cpp.

◆ getContentHeight()

int getContentHeight ( )

overridevirtual

Returns: content height including border, margin

Implements GUINode.

Definition at line 122 of file GUIGradientNode.cpp.

◆ getContentWidth()

int getContentWidth ( )

overridevirtual

Returns: content width including border, margin

Implements GUINode.

Definition at line 113 of file GUIGradientNode.cpp.

◆ getEffectColorAdd()

const GUIColor & getEffectColorAdd ( )

Returns: effect color add

Definition at line 224 of file GUIGradientNode.cpp.

◆ getEffectColorMul()

const GUIColor & getEffectColorMul ( )

Returns: effect color mul

Definition at line 216 of file GUIGradientNode.cpp.

◆ getMask()

const string & getMask ( )

Returns: mask source

Definition at line 250 of file GUIGradientNode.cpp.

◆ getMaskMaxValue()

float getMaskMaxValue ( )

inline

Returns: maximum value of mask to display image

Definition at line 191 of file GUIGradientNode.h.

◆ getNodeType()

const string getNodeType ( )

overrideprotectedvirtual

Returns: node type

Implements GUINode.

Definition at line 103 of file GUIGradientNode.cpp.

◆ isContentNode()

bool isContentNode ( )

overrideprotectedvirtual

Returns: is content node

Implements GUINode.

Definition at line 108 of file GUIGradientNode.cpp.

◆ render()

void render ( GUIRenderer * guiRenderer )

overridevirtual

Render.

Parameters

guiRenderer	gui renderer
floatingNodes	floating nodes

Reimplemented from GUINode.

Definition at line 137 of file GUIGradientNode.cpp.

◆ setEffectColorAdd()

void setEffectColorAdd ( const GUIColor & effectColorAdd )

Set effect color add.

Parameters

effectColorAdd effect color add

Definition at line 228 of file GUIGradientNode.cpp.

◆ setEffectColorMul()

void setEffectColorMul ( const GUIColor & effectColorMul )

Set effect color mul.

Parameters

effectColorMul effect color mul

Definition at line 220 of file GUIGradientNode.cpp.

◆ setMask()

void setMask ( const string & mask )

Set mask source.

Parameters

mask	mask source

Definition at line 254 of file GUIGradientNode.cpp.

◆ setMaskMaxValue()

void setMaskMaxValue ( float maskMaxValue )

inline

Set maximum value of mask to display image.

Parameters

maskMinValue value of mask to display image

Definition at line 199 of file GUIGradientNode.h.

◆ setTextureMatrix()

void setTextureMatrix ( const Matrix2D3x3 & textureMatrix )

Set texture matrix.

Parameters

textureMatrix texture matrix

Definition at line 212 of file GUIGradientNode.cpp.

Friends And Related Function Documentation

◆ tdme::gui::GUIParser

friend class tdme::gui::GUIParser

friend

Definition at line 42 of file GUIGradientNode.h.

Member Data Documentation

◆ clipping

GUINode_Clipping clipping

private

Definition at line 62 of file GUIGradientNode.h.

◆ effectColorAdd

GUIColor effectColorAdd

private

Definition at line 61 of file GUIGradientNode.h.

◆ effectColorMul

GUIColor effectColorMul

private

Definition at line 60 of file GUIGradientNode.h.

◆ gradient

Gradient gradient

private

Definition at line 70 of file GUIGradientNode.h.

◆ mask

string mask

private

Definition at line 68 of file GUIGradientNode.h.

◆ maskMaxValue

float maskMaxValue

private

Definition at line 64 of file GUIGradientNode.h.

◆ maskTexture

Texture* maskTexture { nullptr }

private

Definition at line 63 of file GUIGradientNode.h.

◆ maskTextureId

int32_t maskTextureId { 0 }

private

Definition at line 65 of file GUIGradientNode.h.

◆ textureMatrix

Matrix2D3x3 textureMatrix

private

Definition at line 67 of file GUIGradientNode.h.

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

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GUIGradientNode()

Member Function Documentation

◆ createClipping()

◆ createGradient()

◆ dispose()

◆ getClipping()

◆ getContentHeight()

◆ getContentWidth()

◆ getEffectColorAdd()

◆ getEffectColorMul()

◆ getMask()

◆ getMaskMaxValue()

◆ getNodeType()

◆ isContentNode()

◆ render()

◆ setEffectColorAdd()

◆ setEffectColorMul()

◆ setMask()

◆ setMaskMaxValue()

◆ setTextureMatrix()

Friends And Related Function Documentation

◆ tdme::gui::GUIParser

Member Data Documentation

◆ clipping

◆ effectColorAdd

◆ effectColorMul

◆ gradient

◆ mask

◆ maskMaxValue

◆ maskTexture

◆ maskTextureId

◆ textureMatrix