Detailed Description

Classes for creating GUI windows for 2D and 3D visualization.

Namespaces
	detail
	Auxiliary structures used internally to mrpt.

Classes
class	CBaseGUIWindow
	The base class for GUI window classes. More...

class	mrptEventWindowChar
	An event sent by a window upon a char pressed by the user. More...

class	mrptEventWindowResize
	An event sent by a window upon resize. More...

class	mrptEventMouseDown
	An event sent by a window upon a mouse click, giving the (x,y) pixel coordinates. More...

class	mrptEventMouseMove
	An event sent by a window when the mouse is moved over it. More...

class	mrptEventWindowClosed
	An event sent by a window upon when it's about to be closed, either manually by the user or programatically. More...

class	CDisplayWindow
	This class creates a window as a graphical user interface (GUI) for displaying images to the user. More...

class	CDisplayWindow3D
	A graphical user interface (GUI) for efficiently rendering 3D scenes in real-time. More...

class	mrptEvent3DWindowGrabImageFile
	An event sent by a CDisplayWindow3D window when an image is saved after enabling this feature with CDisplayWindow3D::grabImagesStart() More...

class	CDisplayWindow3DLocker
	Auxiliary class for safely claiming the 3DScene of a mrpt::gui::CDisplayWindow3D. More...

class	CDisplayWindowPlots
	Create a GUI window and display plots with MATLAB-like interfaces and commands. More...

class	WxSubsystem
	This class implements the GUI thread required for the wxWidgets-based GUI. More...

class	CWindowDialog
	The wx dialog for gui::CDisplayWindow. More...

class	C3DWindowDialog

class	CWindowDialogPlots
	The wx dialog for gui::CDisplayWindowPlots. More...

class	wxMRPTImageControl
	A custom control to display the bitmap and avoid flicker. More...

class	CPanelCameraSelection
	A panel to select the camera input from all the formats supported by MRPT. More...

Enumerations
enum	mrptKeyCode { MRPTK_BACK = 8 , MRPTK_TAB = 9 , MRPTK_RETURN = 13 , MRPTK_ESCAPE = 27 , MRPTK_SPACE = 32 , MRPTK_DELETE = 127 , MRPTK_START = 300 , MRPTK_LBUTTON , MRPTK_RBUTTON , MRPTK_CANCEL , MRPTK_MBUTTON , MRPTK_CLEAR , MRPTK_SHIFT , MRPTK_ALT , MRPTK_CONTROL , MRPTK_MENU , MRPTK_PAUSE , MRPTK_CAPITAL , MRPTK_END , MRPTK_HOME , MRPTK_LEFT , MRPTK_UP , MRPTK_RIGHT , MRPTK_DOWN , MRPTK_SELECT , MRPTK_PRINT , MRPTK_EXECUTE , MRPTK_SNAPSHOT , MRPTK_INSERT , MRPTK_HELP , MRPTK_NUMPAD0 , MRPTK_NUMPAD1 , MRPTK_NUMPAD2 , MRPTK_NUMPAD3 , MRPTK_NUMPAD4 , MRPTK_NUMPAD5 , MRPTK_NUMPAD6 , MRPTK_NUMPAD7 , MRPTK_NUMPAD8 , MRPTK_NUMPAD9 , MRPTK_MULTIPLY , MRPTK_ADD , MRPTK_SEPARATOR , MRPTK_SUBTRACT , MRPTK_DECIMAL , MRPTK_DIVIDE , MRPTK_F1 , MRPTK_F2 , MRPTK_F3 , MRPTK_F4 , MRPTK_F5 , MRPTK_F6 , MRPTK_F7 , MRPTK_F8 , MRPTK_F9 , MRPTK_F10 , MRPTK_F11 , MRPTK_F12 , MRPTK_F13 , MRPTK_F14 , MRPTK_F15 , MRPTK_F16 , MRPTK_F17 , MRPTK_F18 , MRPTK_F19 , MRPTK_F20 , MRPTK_F21 , MRPTK_F22 , MRPTK_F23 , MRPTK_F24 , MRPTK_NUMLOCK , MRPTK_SCROLL , MRPTK_PAGEUP , MRPTK_PAGEDOWN , MRPTK_NUMPAD_SPACE , MRPTK_NUMPAD_TAB , MRPTK_NUMPAD_ENTER , MRPTK_NUMPAD_F1 , MRPTK_NUMPAD_F2 , MRPTK_NUMPAD_F3 , MRPTK_NUMPAD_F4 , MRPTK_NUMPAD_HOME , MRPTK_NUMPAD_LEFT , MRPTK_NUMPAD_UP , MRPTK_NUMPAD_RIGHT , MRPTK_NUMPAD_DOWN , MRPTK_NUMPAD_PAGEUP , MRPTK_NUMPAD_PAGEDOWN , MRPTK_NUMPAD_END , MRPTK_NUMPAD_BEGIN , MRPTK_NUMPAD_INSERT , MRPTK_NUMPAD_DELETE , MRPTK_NUMPAD_EQUAL , MRPTK_NUMPAD_MULTIPLY , MRPTK_NUMPAD_ADD , MRPTK_NUMPAD_SEPARATOR , MRPTK_NUMPAD_SUBTRACT , MRPTK_NUMPAD_DECIMAL , MRPTK_NUMPAD_DIVIDE , MRPTK_WINDOWS_LEFT , MRPTK_WINDOWS_RIGHT , MRPTK_WINDOWS_MENU , MRPTK_COMMAND , MRPTK_SPECIAL1 = 193 , MRPTK_SPECIAL2 , MRPTK_SPECIAL3 , MRPTK_SPECIAL4 , MRPTK_SPECIAL5 , MRPTK_SPECIAL6 , MRPTK_SPECIAL7 , MRPTK_SPECIAL8 , MRPTK_SPECIAL9 , MRPTK_SPECIAL10 , MRPTK_SPECIAL11 , MRPTK_SPECIAL12 , MRPTK_SPECIAL13 , MRPTK_SPECIAL14 , MRPTK_SPECIAL15 , MRPTK_SPECIAL16 , MRPTK_SPECIAL17 , MRPTK_SPECIAL18 , MRPTK_SPECIAL19 , MRPTK_SPECIAL20 }

enum	mrptKeyModifier { MRPTKMOD_NONE = 0x0000 , MRPTKMOD_ALT = 0x1000 , MRPTKMOD_CONTROL = 0x2000 , MRPTKMOD_ALTGR = MRPTKMOD_ALT \| MRPTKMOD_CONTROL , MRPTKMOD_SHIFT = 0x4000 , MRPTKMOD_META = 0x8000 , MRPTKMOD_WIN = MRPTKMOD_META , MRPTKMOD_CMD = MRPTKMOD_CONTROL }

Functions
wxImage GUI_IMPEXP *	MRPTImage2wxImage (const mrpt::utils::CImage &img)
	Create a wxImage from a MRPT image. More...

wxBitmap GUI_IMPEXP *	MRPTImage2wxBitmap (const mrpt::utils::CImage &img)
	Create a wxBitmap from a MRPT image. More...

wxImage GUI_IMPEXP *	IplImage2wxImage (void *img)
	Create a wxImage from a IPL image. More...

mrpt::utils::CImage GUI_IMPEXP *	wxImage2MRPTImage (const wxImage &img)
	Create a MRPT image from a wxImage. More...

mrpt::utils::CImagePtr GUI_IMPEXP	wxImage2MRPTImagePtr (const wxImage &img)
	Create a MRPT image from a wxImage. More...

mrptKeyModifier	keyEventToMrptKeyModifier (const wxKeyEvent &ev)
	Extracts the key modifiers from a wxKeyEvent. More...

Enumeration Type Documentation

◆ mrptKeyCode

enum mrpt::gui::mrptKeyCode

Enumerator
MRPTK_BACK
MRPTK_TAB
MRPTK_RETURN
MRPTK_ESCAPE
MRPTK_SPACE
MRPTK_DELETE
MRPTK_START
MRPTK_LBUTTON
MRPTK_RBUTTON
MRPTK_CANCEL
MRPTK_MBUTTON
MRPTK_CLEAR
MRPTK_SHIFT
MRPTK_ALT
MRPTK_CONTROL
MRPTK_MENU
MRPTK_PAUSE
MRPTK_CAPITAL
MRPTK_END
MRPTK_HOME
MRPTK_LEFT
MRPTK_UP
MRPTK_RIGHT
MRPTK_DOWN
MRPTK_SELECT
MRPTK_PRINT
MRPTK_EXECUTE
MRPTK_SNAPSHOT
MRPTK_INSERT
MRPTK_HELP
MRPTK_NUMPAD0
MRPTK_NUMPAD1
MRPTK_NUMPAD2
MRPTK_NUMPAD3
MRPTK_NUMPAD4
MRPTK_NUMPAD5
MRPTK_NUMPAD6
MRPTK_NUMPAD7
MRPTK_NUMPAD8
MRPTK_NUMPAD9
MRPTK_MULTIPLY
MRPTK_ADD
MRPTK_SEPARATOR
MRPTK_SUBTRACT
MRPTK_DECIMAL
MRPTK_DIVIDE
MRPTK_F1
MRPTK_F2
MRPTK_F3
MRPTK_F4
MRPTK_F5
MRPTK_F6
MRPTK_F7
MRPTK_F8
MRPTK_F9
MRPTK_F10
MRPTK_F11
MRPTK_F12
MRPTK_F13
MRPTK_F14
MRPTK_F15
MRPTK_F16
MRPTK_F17
MRPTK_F18
MRPTK_F19
MRPTK_F20
MRPTK_F21
MRPTK_F22
MRPTK_F23
MRPTK_F24
MRPTK_NUMLOCK
MRPTK_SCROLL
MRPTK_PAGEUP
MRPTK_PAGEDOWN
MRPTK_NUMPAD_SPACE
MRPTK_NUMPAD_TAB
MRPTK_NUMPAD_ENTER
MRPTK_NUMPAD_F1
MRPTK_NUMPAD_F2
MRPTK_NUMPAD_F3
MRPTK_NUMPAD_F4
MRPTK_NUMPAD_HOME
MRPTK_NUMPAD_LEFT
MRPTK_NUMPAD_UP
MRPTK_NUMPAD_RIGHT
MRPTK_NUMPAD_DOWN
MRPTK_NUMPAD_PAGEUP
MRPTK_NUMPAD_PAGEDOWN
MRPTK_NUMPAD_END
MRPTK_NUMPAD_BEGIN
MRPTK_NUMPAD_INSERT
MRPTK_NUMPAD_DELETE
MRPTK_NUMPAD_EQUAL
MRPTK_NUMPAD_MULTIPLY
MRPTK_NUMPAD_ADD
MRPTK_NUMPAD_SEPARATOR
MRPTK_NUMPAD_SUBTRACT
MRPTK_NUMPAD_DECIMAL
MRPTK_NUMPAD_DIVIDE
MRPTK_WINDOWS_LEFT
MRPTK_WINDOWS_RIGHT
MRPTK_WINDOWS_MENU
MRPTK_COMMAND
MRPTK_SPECIAL1
MRPTK_SPECIAL2
MRPTK_SPECIAL3
MRPTK_SPECIAL4
MRPTK_SPECIAL5
MRPTK_SPECIAL6
MRPTK_SPECIAL7
MRPTK_SPECIAL8
MRPTK_SPECIAL9
MRPTK_SPECIAL10
MRPTK_SPECIAL11
MRPTK_SPECIAL12
MRPTK_SPECIAL13
MRPTK_SPECIAL14
MRPTK_SPECIAL15
MRPTK_SPECIAL16
MRPTK_SPECIAL17
MRPTK_SPECIAL18
MRPTK_SPECIAL19
MRPTK_SPECIAL20

Definition at line 24 of file keycodes.h.

◆ mrptKeyModifier

enum mrpt::gui::mrptKeyModifier

Enumerator
MRPTKMOD_NONE
MRPTKMOD_ALT
MRPTKMOD_CONTROL
MRPTKMOD_ALTGR
MRPTKMOD_SHIFT
MRPTKMOD_META
MRPTKMOD_WIN
MRPTKMOD_CMD

Definition at line 158 of file keycodes.h.

Function Documentation

◆ IplImage2wxImage()

wxImage * mrpt::gui::IplImage2wxImage ( void * img )

Create a wxImage from a IPL image.

The new object must be freed by the user when not required anymore.

See also: IplImage2wxImage

Definition at line 221 of file WxUtils.cpp.

References ASSERT_, and mrpt::system::os::memcpy().

◆ keyEventToMrptKeyModifier()

mrptKeyModifier mrpt::gui::keyEventToMrptKeyModifier ( const wxKeyEvent & ev )

Extracts the key modifiers from a wxKeyEvent.

Definition at line 944 of file WxUtils.cpp.

References MRPTKMOD_ALT, MRPTKMOD_CMD, MRPTKMOD_CONTROL, MRPTKMOD_META, MRPTKMOD_NONE, and MRPTKMOD_SHIFT.

Referenced by mrpt::gui::CWindowDialog::OnChar(), and mrpt::gui::CWindowDialogPlots::OnChar().

◆ MRPTImage2wxBitmap()

wxBitmap * mrpt::gui::MRPTImage2wxBitmap ( const mrpt::utils::CImage & img )

Create a wxBitmap from a MRPT image.

The new object must be freed by the user when not required anymore.

See also: MRPTImage2wxImage

Definition at line 158 of file WxUtils.cpp.

References mrpt::system::os::memcpy(), and THROW_EXCEPTION.

Referenced by mrpt::gui::wxMRPTImageControl::AssignImage().

◆ MRPTImage2wxImage()

wxImage * mrpt::gui::MRPTImage2wxImage ( const mrpt::utils::CImage & img )

Create a wxImage from a MRPT image.

The new object must be freed by the user when not required anymore.

See also: MRPTImage2wxImage

Definition at line 29 of file WxUtils.cpp.

References mrpt::system::os::memcpy().

Referenced by mrpt::gui::CDisplayWindowPlots::image(), and mrpt::gui::CDisplayWindow::showImage().

◆ wxImage2MRPTImage()

mrpt::utils::CImage * mrpt::gui::wxImage2MRPTImage ( const wxImage & img )

Create a MRPT image from a wxImage.

The new object must be freed by the user when not required anymore. It is recommended to use wxImage2MRPTImagePtr instead since smart pointers are safer to manage.