mrpt::graphslam::CWindowManager Class Reference

Detailed Description

Class acts as a container for storing pointers to mrpt::gui::CDisplayWindow3D, mrpt::graphslam::CWindowObserver instances.

CWindowManager also provides methods for adding/positioning textMessages and viewports in the CDisplayWindow in a compact and consistent way.

Definition at line 31 of file CWindowManager.h.

#include <mrpt/graphslam/misc/CWindowManager.h>

Inheritance diagram for mrpt::graphslam::CWindowManager:

Public Member Functions
	CWindowManager ()
	Default class constructor. More...
	CWindowManager (mrpt::gui::CDisplayWindow3D *win_in)
	Class constructor. More...
	CWindowManager (mrpt::gui::CDisplayWindow3D *win_in, mrpt::graphslam::CWindowObserver *observer_in)
	Class constructor. More...
	~CWindowManager ()
	Class destructor. More...
void	setCDisplayWindow3DPtr (mrpt::gui::CDisplayWindow3D *win_in)
	Store the CDisplayWindow3D pointer in the CWindowManager instance. More...
void	setWindowObserverPtr (mrpt::graphslam::CWindowObserver *obsever_in)
	Store the CWindowObserver pointer in the CWindowManager instance. More...
void	assignTextMessageParameters (double *offset_y, int *text_index)
	Assign the next available offset_y and text_index for the textMessage under construction. More...
bool	isOpen ()
	Wrapper call around the CWindowDisplay3D. More...
void	addTextMessage (const double x, const double y, const std::string &text, const mrpt::utils::TColorf &color=mrpt::utils::TColorf(1.0, 1.0, 1.0), const size_t unique_index=0)
	Wrapper around the CDisplayWindow3D::addTextMessage method, so that the user does not have to specify the font name and size. More...
void	assignViewportParameters (double *x, double *y, double *width, double *height)
	Assign position and size values for the placement of the next viewport. More...

Public Attributes
mrpt::gui::CDisplayWindow3D *	win
	CDisplayWindow instance. More...
mrpt::graphslam::CWindowObserver *	observer
	CWindowObserver instance. More...

Private Member Functions
void	initCWindowManager ()
	Initialization method, to be called from the various Constructors. More...

Private Attributes
bool	m_fetched_observer_pointer
bool	m_fetched_displaywindow_pointer
double	m_offset_y_step
int	m_index_text_step
double	m_curr_offset_y
int	m_curr_text_index
std::string	m_font_name
int	m_font_size
double	m_viewp_width
double	m_viewp_height
double	m_viewp_x
double	m_viewp_y
	vertical layout of the viewports More...
double	m_viewp_margin

Constructor & Destructor Documentation

CWindowManager() [1/3]

mrpt::graphslam::CWindowManager::CWindowManager ( )

inline

Default class constructor.

Definition at line 35 of file CWindowManager.h.

References initCWindowManager().

Here is the call graph for this function:

CWindowManager() [2/3]

mrpt::graphslam::CWindowManager::CWindowManager ( mrpt::gui::CDisplayWindow3D *  win_in )

inline

Class constructor.

Definition at line 37 of file CWindowManager.h.

References initCWindowManager(), and setCDisplayWindow3DPtr().

Here is the call graph for this function:

CWindowManager() [3/3]

mrpt::graphslam::CWindowManager::CWindowManager ( mrpt::gui::CDisplayWindow3D *  win_in, mrpt::graphslam::CWindowObserver *  observer_in  )

inline

Class constructor.

Definition at line 43 of file CWindowManager.h.

References initCWindowManager(), setCDisplayWindow3DPtr(), and setWindowObserverPtr().

Here is the call graph for this function:

~CWindowManager()

mrpt::graphslam::CWindowManager::~CWindowManager ( )

inline

Class destructor.

Definition at line 53 of file CWindowManager.h.

Member Function Documentation

addTextMessage()

void mrpt::graphslam::CWindowManager::addTextMessage ( const double  x, const double  y, const std::string &  text, const mrpt::utils::TColorf &  color = mrpt::utils::TColorf(1.0, 1.0, 1.0), const size_t  unique_index = 0  )

inline

Wrapper around the CDisplayWindow3D::addTextMessage method, so that the user does not have to specify the font name and size.

Note

see initCWindowManager method for the default fontName and fontSize used.

Definition at line 115 of file CWindowManager.h.

References mrpt::gui::CDisplayWindow3D::addTextMessage(), m_font_name, m_font_size, mrpt::opengl::NICE, and win.

Referenced by mrpt::graphslam::deciders::CICPCriteriaERD< GRAPH_T >::initializeVisuals(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::initOptDistanceVisualization(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::updateGraphVisualization(), and mrpt::graphslam::detail::CEdgeCounter::updateTextMessages().

Here is the call graph for this function:

Here is the caller graph for this function:

assignTextMessageParameters()

void mrpt::graphslam::CWindowManager::assignTextMessageParameters ( double *  offset_y, int *  text_index  )

inline

Assign the next available offset_y and text_index for the textMessage under construction.

Used for consistent positioning of textMessages in the CDisplayWindow3D.

See also

assignViewPortParameters

Definition at line 86 of file CWindowManager.h.

References m_curr_offset_y, m_curr_text_index, m_index_text_step, and m_offset_y_step.

Referenced by mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::initGraphVisualization(), mrpt::graphslam::deciders::CICPCriteriaERD< GRAPH_T >::initializeVisuals(), and mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::initOptDistanceVisualization().

Here is the caller graph for this function:

assignViewportParameters()

void mrpt::graphslam::CWindowManager::assignViewportParameters ( double *  x, double *  y, double *  width, double *  height  )

inline

Assign position and size values for the placement of the next viewport.

Used for consistent positioning of the Viewports in the CDisplayWindow3D

See also

assignTextMessageParameters

Definition at line 137 of file CWindowManager.h.

References m_viewp_height, m_viewp_margin, m_viewp_width, m_viewp_x, and m_viewp_y.

initCWindowManager()

void mrpt::graphslam::CWindowManager::initCWindowManager ( )

inlineprivate

Initialization method, to be called from the various Constructors.

Definition at line 154 of file CWindowManager.h.

References m_curr_offset_y, m_curr_text_index, m_fetched_displaywindow_pointer, m_fetched_observer_pointer, m_font_name, m_font_size, m_index_text_step, m_offset_y_step, m_viewp_height, m_viewp_margin, m_viewp_width, m_viewp_x, m_viewp_y, MRPT_LOG_DEBUG_STREAM, observer, and win.

Referenced by CWindowManager().

Here is the caller graph for this function:

isOpen()

bool mrpt::graphslam::CWindowManager::isOpen ( )

inline

Wrapper call around the CWindowDisplay3D.

Definition at line 96 of file CWindowManager.h.

References mrpt::gui::CBaseGUIWindow::isOpen(), and win.

Here is the call graph for this function:

setCDisplayWindow3DPtr()

void mrpt::graphslam::CWindowManager::setCDisplayWindow3DPtr ( mrpt::gui::CDisplayWindow3D *  win_in )

inline

Store the CDisplayWindow3D pointer in the CWindowManager instance.

See also

setWindowObserverPtr

Definition at line 59 of file CWindowManager.h.

References m_fetched_displaywindow_pointer, MRPT_LOG_DEBUG_STREAM, and win.

Referenced by CWindowManager(), and CGraphSlamHandler< GRAPH_T >::initVisualization().

Here is the caller graph for this function:

setWindowObserverPtr()

void mrpt::graphslam::CWindowManager::setWindowObserverPtr ( mrpt::graphslam::CWindowObserver *  obsever_in )

inline

Store the CWindowObserver pointer in the CWindowManager instance.

See also

setCDisplayWindow3DPtr

Definition at line 70 of file CWindowManager.h.

References m_fetched_observer_pointer, MRPT_LOG_DEBUG_STREAM, and observer.

Referenced by CWindowManager(), and CGraphSlamHandler< GRAPH_T >::initVisualization().

Here is the caller graph for this function:

Member Data Documentation

m_curr_offset_y

double mrpt::graphslam::CWindowManager::m_curr_offset_y

private

Definition at line 184 of file CWindowManager.h.

Referenced by assignTextMessageParameters(), and initCWindowManager().

m_curr_text_index

int mrpt::graphslam::CWindowManager::m_curr_text_index

private

Definition at line 185 of file CWindowManager.h.

Referenced by assignTextMessageParameters(), and initCWindowManager().

m_fetched_displaywindow_pointer

bool mrpt::graphslam::CWindowManager::m_fetched_displaywindow_pointer

private

Definition at line 180 of file CWindowManager.h.

Referenced by initCWindowManager(), and setCDisplayWindow3DPtr().

m_fetched_observer_pointer

bool mrpt::graphslam::CWindowManager::m_fetched_observer_pointer

private

Definition at line 179 of file CWindowManager.h.

Referenced by initCWindowManager(), and setWindowObserverPtr().

m_font_name

std::string mrpt::graphslam::CWindowManager::m_font_name

private

Definition at line 187 of file CWindowManager.h.

Referenced by addTextMessage(), and initCWindowManager().

m_font_size

int mrpt::graphslam::CWindowManager::m_font_size

private

Definition at line 188 of file CWindowManager.h.

Referenced by addTextMessage(), and initCWindowManager().

m_index_text_step

int mrpt::graphslam::CWindowManager::m_index_text_step

private

Definition at line 183 of file CWindowManager.h.

Referenced by assignTextMessageParameters(), and initCWindowManager().

m_offset_y_step

double mrpt::graphslam::CWindowManager::m_offset_y_step

private

Definition at line 182 of file CWindowManager.h.

Referenced by assignTextMessageParameters(), and initCWindowManager().

m_viewp_height

double mrpt::graphslam::CWindowManager::m_viewp_height

private

Definition at line 192 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

m_viewp_margin

double mrpt::graphslam::CWindowManager::m_viewp_margin

private

Definition at line 195 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

m_viewp_width

double mrpt::graphslam::CWindowManager::m_viewp_width

private

Definition at line 191 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

m_viewp_x

double mrpt::graphslam::CWindowManager::m_viewp_x

private

Definition at line 193 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

m_viewp_y

double mrpt::graphslam::CWindowManager::m_viewp_y

private

vertical layout of the viewports

Definition at line 194 of file CWindowManager.h.

Referenced by assignViewportParameters(), and initCWindowManager().

observer

mrpt::graphslam::CWindowObserver* mrpt::graphslam::CWindowManager::observer

CWindowObserver instance.

Definition at line 150 of file CWindowManager.h.

Referenced by initCWindowManager(), and setWindowObserverPtr().

win

mrpt::gui::CDisplayWindow3D* mrpt::graphslam::CWindowManager::win

CDisplayWindow instance.

Definition at line 149 of file CWindowManager.h.

Referenced by addTextMessage(), initCWindowManager(), isOpen(), setCDisplayWindow3DPtr(), mrpt::graphslam::detail::CEdgeCounter::setWindowManagerPtr(), and mrpt::graphslam::CRegistrationDeciderOrOptimizer< GRAPH_t >::setWindowManagerPtr().