The HUD class aims at providing, centralizing and managing information displayed in the scene, other than objects. More...

#include <HUD.h>

Public Member Functions
void	setDraw (bool enable)
	setDraw to enable or disable this HUD More...

void	setTextSize (double textSize)
	set global text size used for displaying 2d info on the screen

void	setTextSize3d (double textSize3d)
	set text size for drawing 3d text in the scene

void	setDrawAgentInfo (bool drawAgentInfo)
	enable the drawing of agents shortnames above their head

void	setDrawCost (bool drawCost)
	draw the cost of the currently scene (through global_costSpace)

void	setDrawAdvancedCost (bool drawAdvancedCost)
	enable the drawing of advanced cost information (throug HRICS::CostManager)

void	setDrawSearchStatus (bool drawSearchStatus)
	enable the drawing of planning status (through global_Move3DPlanner, RRT, T-RRT)

bool	isDraw ()

double	textSize () const

double	textSize3d () const

void	setAgentStaticInfoDefault ()

const std::map< Robot *, std::string > &	agentStaticInfo () const

void	setAgentStaticInfo (const std::map< Robot *, std::string > &agentStaticInfo)

bool	getDrawAgentInfo () const

bool	getDrawCost () const

bool	getDrawAdvancedCost () const

bool	getDrawSearchStatus () const

Static Public Member Functions
static HUD *	getHUD ()
	get the main HUD (acts like a singleton)

static void	initHUD ()
	initialize the HUD class so any existing or future HUD can be displayed (creates the interface with g3d)

static void	drawHUD (void)

static PlanningStatus	getPlanningStatus ()
	getPlanningStatus fetch information about the planner More...

Protected Member Functions
virtual void	draw ()
	draw this HUD taking into account its options

void	printAgentInfo ()

void	printCost ()

void	printAdvancedCost ()

void	printSearchStatus ()

Detailed Description

The HUD class aims at providing, centralizing and managing information displayed in the scene, other than objects.

Displayed data can be robot names, planning status, metadata about objects (text or geometry).

Member Function Documentation

PlanningStatus API::HUD::getPlanningStatus ( )

static

getPlanningStatus fetch information about the planner

Returns: get information about the planner (global_Move3DPlanner), according to its type (RRT, T-RRT,...).

void API::HUD::setDraw ( bool enable )

setDraw to enable or disable this HUD

Parameters

enable

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