ui_draw.cpp File Reference

#include "ui_main.h"
#include "ui_nodes.h"
#include "ui_internal.h"
#include "ui_draw.h"
#include "ui_actions.h"
#include "ui_input.h"
#include "ui_node.h"
#include "ui_timer.h"
#include "ui_dragndrop.h"
#include "ui_tooltip.h"
#include "ui_render.h"
#include "node/ui_node_abstractnode.h"
#include "../client.h"
#include "../renderer/r_draw.h"
#include "../renderer/r_misc.h"

Go to the source code of this file.

Functions
void	UI_CaptureDrawOver (uiNode_t *node)
	Capture a node we will draw over all nodes (per window) More...
static void	UI_CheckTooltipDelay (uiNode_t *node, uiTimer_t *timer)
static void	UI_DrawNode (uiNode_t *node)
static void	UI_DrawNotice (void)
	Generic notice function that renders a message to the screen. More...
void	UI_Draw (void)
	Draws the window stack. More...
void	UI_DrawCursor (void)
void	UI_DisplayNotice (const char *text, int time, const char *windowName)
	Displays a message over all windows. More...
void	UI_InitDraw (void)

Variables
static const int	TOOLTIP_DELAY = 500
static cvar_t *	ui_show_tooltips
static bool	tooltipVisible = false
static uiTimer_t *	tooltipTimer
static int	noticeTime
static char	noticeText [256]
static uiNode_t *	noticeWindow
static uiNode_t *	drawOverNode
	Node we will draw over. More...

Function Documentation

void UI_CaptureDrawOver

(

uiNode_t *

node

)

Capture a node we will draw over all nodes (per window)

Note

The node must be captured every frames

Todo:

it can be better to capture the draw over only one time (need new event like mouseEnter, mouseLeave)

Definition at line 64 of file ui_draw.cpp.

Referenced by uiEditorNode::draw(), uiSelectBoxNode::draw(), and uiVideoNode::draw().

static void UI_CheckTooltipDelay ( uiNode_t *  node, uiTimer_t *  timer  )

static

Definition at line 201 of file ui_draw.cpp.

References tooltipVisible, and UI_TimerStop().

Referenced by UI_InitDraw().

void UI_DisplayNotice	(	const char *	text,
		int	time,
		const char *	windowName
	)

Displays a message over all windows.

See also

HUD_DisplayMessage

Parameters

[in]	time	is a ms values
[in]	text	text is already translated here
[in]	windowName	Window name where we must display the notice; else nullptr to use the current active window

Definition at line 411 of file ui_draw.cpp.

References CL_Milliseconds(), Com_Printf(), noticeText, noticeTime, Q_strncpyz(), UI_GetActiveWindow(), and UI_GetWindow().

Referenced by CL_RContextCvarChange(), CL_RImagesCvarChange(), GAME_GetImportData(), and HUD_DisplayMessage().

void UI_Draw

(

void

)

Draws the window stack.

See also

SCR_UpdateScreen

Definition at line 341 of file ui_draw.cpp.

References CL_Milliseconds(), cvar_s::integer, uiTimer_s::isRunning, mousePosX, mousePosY, noticeTime, tooltipVisible, UI_CheckMouseMove(), UI_DebugMode(), UI_DNDIsDragging(), UI_DrawNode(), UI_DrawNotice(), UI_GetHoveredNode(), UI_GetLastFullScreenWindow(), ui_global, UI_HandleTimers(), UI_Node_DrawOverWindow(), UI_Node_DrawTooltip(), UI_TimerStart(), UI_TimerStop(), uiGlobal_s::windowStack, and uiGlobal_s::windowStackPos.

Referenced by SCR_DrawLoading(), and SCR_UpdateScreen().

void UI_DrawCursor

(

void

)

Definition at line 399 of file ui_draw.cpp.

References mousePosX, mousePosY, and UI_DrawDragAndDrop().

Referenced by SCR_DrawCursor().

static void UI_DrawNode ( uiNode_t *  node )

static

Todo:

remove it when its possible: we can create a 'box' node with this properties, but we often don't need it

Todo:

move it at the right position

Todo:

we can skip nodes outside visible rect

Todo:

move it at the right position

Definition at line 207 of file ui_draw.cpp.

References uiNode_t::bgcolor, uiNode_t::border, uiNode_t::bordercolor, uiNode_t::box, CL_Milliseconds(), uiNode_t::deleteTime, uiNode_t::firstChild, uiNode_t::invis, uiNode_t::next, R_Transform(), viddef_t::rx, viddef_t::ry, uiBox_t::size, UI_CheckVisibility(), UI_DeleteNode(), UI_DrawFill(), UI_DrawRect(), UI_GetNodeAbsPos(), UI_Node_Draw(), UI_Node_GetClientPosition(), UI_Node_IsDrawable(), UI_Node_IsDrawItselfChild(), UI_Node_IsScrollableContainer(), UI_Node_IsVirtual(), UI_PopClipRect(), UI_PushClipRect(), UI_Validate(), Vector2NotEmpty, and viddef.

Referenced by UI_Draw().

static void UI_DrawNotice ( void  )

static

Generic notice function that renders a message to the screen.

Todo:

Move it into Window node, and/or convert it in a reserved named string node and update the protocol

< Delta-x position. Relative to original x position.

Definition at line 296 of file ui_draw.cpp.

References ALIGN_CC, uiNode_t::box, LONGLINES_WRAP, noticeText, uiBox_t::pos, R_Color(), R_FontTextSize(), UI_DrawFill(), UI_DrawString(), UI_WindowNodeGetNoticePosition(), VID_NORM_WIDTH, viddef, and viddef_t::virtualWidth.

Referenced by UI_Draw().

void UI_InitDraw

(

void

)

Definition at line 427 of file ui_draw.cpp.

References CVAR_ARCHIVE, Cvar_Get(), TOOLTIP_DELAY, UI_AllocTimer(), and UI_CheckTooltipDelay().

Referenced by UI_Init().

Variable Documentation

uiNode_t* drawOverNode

static

Node we will draw over.

See also

UI_CaptureDrawOver

uiBehaviour_t.drawOverWindow

Definition at line 57 of file ui_draw.cpp.

char noticeText[256]

static

Definition at line 49 of file ui_draw.cpp.

Referenced by UI_DisplayNotice(), and UI_DrawNotice().

int noticeTime

static

Definition at line 48 of file ui_draw.cpp.

Referenced by UI_DisplayNotice(), and UI_Draw().

uiNode_t* noticeWindow

static

Definition at line 50 of file ui_draw.cpp.

const int TOOLTIP_DELAY = 500

static

Definition at line 42 of file ui_draw.cpp.

Referenced by UI_InitDraw().

uiTimer_t* tooltipTimer

static

Definition at line 46 of file ui_draw.cpp.

bool tooltipVisible = false

static

Definition at line 45 of file ui_draw.cpp.

Referenced by UI_CheckTooltipDelay(), and UI_Draw().

cvar_t* ui_show_tooltips

static

Definition at line 44 of file ui_draw.cpp.