GUI frame buffer node. More...

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

Inheritance diagram for GUIFrameBufferNode:

Collaboration diagram for GUIFrameBufferNode:

Public Member Functions
void	dispose () override
	Dispose node. More...

FrameBuffer *	getFrameBuffer ()

void	setFrameBuffer (FrameBuffer *frameBuffer)
	Set frame buffer. More...

Public Member Functions inherited from GUITextureBaseNode
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...

Protected Member Functions
	GUIFrameBufferNode (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, FrameBuffer frameBuffer, const RequestedDimensionConstraints &requestedDimensionConstraints, bool mirrorX, bool mirrorY, const GUIColor &effectColorMul, const GUIColor &effectColorAdd, const GUINode_Scale9Grid &scale9Grid, const GUINode_Clipping &clipping, const string &mask, float maskMaxValue)
	Constructor. More...

const string	getNodeType () override

Protected Member Functions inherited from GUITextureBaseNode
	GUITextureBaseNode (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 RequestedDimensionConstraints &requestedDimensionConstraints, bool mirrorX, bool mirrorY, const GUIColor &effectColorMul, const GUIColor &effectColorAdd, const GUINode_Scale9Grid &scale9Grid, const GUINode_Clipping &clipping, const string &mask, float maskMaxValue)
	Constructor. More...

const string	getNodeType () override=0

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
FrameBuffer *	frameBuffer { nullptr }

Friends
class	tdme::gui::GUIParser

Additional Inherited Members
Static Public Member Functions inherited from GUITextureBaseNode
static GUINode_Clipping	createClipping (const string &allClipping, const string &left, const string &top, const string &right, const string &bottom)
	Create clipping. More...

static RequestedDimensionConstraints	createRequestedDimensionConstraints (const string &width, const string &height)
	Create requested dimension 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 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 GUITextureBaseNode
int32_t	textureId { 0 }

int	textureWidth { 0 }

int	textureHeight { 0 }

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 frame buffer node.

Author: Andreas Drewke

Version: $Id$

Definition at line 38 of file GUIFrameBufferNode.h.

Constructor & Destructor Documentation

◆ GUIFrameBufferNode()

GUIFrameBufferNode	(	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,
		FrameBuffer *	frameBuffer,
		const RequestedDimensionConstraints &	requestedDimensionConstraints,
		bool	mirrorX,
		bool	mirrorY,
		const GUIColor &	effectColorMul,
		const GUIColor &	effectColorAdd,
		const GUINode_Scale9Grid &	scale9Grid,
		const GUINode_Clipping &	clipping,
		const string &	mask,
		float	maskMaxValue
	)

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
frameBuffer	frame buffer
requestedDimensionConstraints	requested dimension constraints
mirrorX	mirror X
mirrorY	mirror Y
effectColorMul	effect color mul
effectColorAdd	effect color add
scale9Grid	scale 9 grid
clipping	clipping
mask	mask image
maskMaxValue	maximum value of mask to display image

Exceptions

tdme::gui::GUIParserException

Definition at line 32 of file GUIFrameBufferNode.cpp.

Member Function Documentation

◆ dispose()

void dispose ( )

overridevirtual

Dispose node.

Reimplemented from GUINode.

Definition at line 93 of file GUIFrameBufferNode.cpp.

◆ getFrameBuffer()

FrameBuffer * getFrameBuffer ( )

Returns: frame buffer

Definition at line 98 of file GUIFrameBufferNode.cpp.

◆ getNodeType()

const string getNodeType ( )

overrideprotectedvirtual

Returns: node type

Implements GUITextureBaseNode.

Definition at line 88 of file GUIFrameBufferNode.cpp.

◆ setFrameBuffer()

void setFrameBuffer ( FrameBuffer * frameBuffer )

Set frame buffer.

Parameters

frameBuffer frame buffer

Definition at line 102 of file GUIFrameBufferNode.cpp.

Friends And Related Function Documentation

◆ tdme::gui::GUIParser

friend class tdme::gui::GUIParser

friend

Definition at line 41 of file GUIFrameBufferNode.h.

Member Data Documentation

◆ frameBuffer

FrameBuffer* frameBuffer { nullptr }

private

Definition at line 44 of file GUIFrameBufferNode.h.

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members