pcl::visualization::Window Class Reference

#include <pcl/visualization/window.h>

List of all members.

Classes
struct	ExitCallback
struct	ExitMainLoopTimerCallback
Public Member Functions
	Window (const std::string &window_name="")
virtual	~Window ()
void	spin ()
	Spin method.
void	spinOnce (int time=1, bool force_redraw=false)
	Spin once method.
bool	wasStopped () const
	Returns true when the user tried to close the window.
boost::signals2::connection	registerKeyboardCallback (void(*callback)(const pcl::visualization::KeyboardEvent &, void *), void *cookie=NULL)
	registering a callback function for keyboard events
template<typename T >
boost::signals2::connection	registerKeyboardCallback (void(T::*callback)(const pcl::visualization::KeyboardEvent &, void *), T &instance, void *cookie=NULL)
	registering a callback function for keyboard events
boost::signals2::connection	registerMouseCallback (void(*callback)(const pcl::visualization::MouseEvent &, void *), void *cookie=NULL)
template<typename T >
boost::signals2::connection	registerMouseCallback (void(T::*callback)(const pcl::visualization::MouseEvent &, void *), T &instance, void *cookie=NULL)
	registering a callback function for mouse events

---

Detailed Description

Definition at line 56 of file window.h.

---

Constructor & Destructor Documentation

pcl::visualization::Window::Window

(

const std::string &

window_name = ""

)

virtual pcl::visualization::Window::~Window

(

)

[virtual]

---

Member Function Documentation

boost::signals2::connection pcl::visualization::Window::registerKeyboardCallback	(	void(*)(const pcl::visualization::KeyboardEvent &, void *)	callback,
		void *	cookie = NULL
	)		[inline]

registering a callback function for keyboard events

Parameters:

callback	the function that will be registered as a callback for a keyboard event
cookie	user data that is passed to the callback

Returns:

connection object that allows to disconnect the callback function.

Definition at line 86 of file window.h.

template<typename T >

boost::signals2::connection pcl::visualization::Window::registerKeyboardCallback	(	void(T::*)(const pcl::visualization::KeyboardEvent &, void *)	callback,
		T &	instance,
		void *	cookie = NULL
	)		[inline]

registering a callback function for keyboard events

Parameters:

callback	the member function that will be registered as a callback for a keyboard event
instance	instance to the class that implements the callback function
cookie	user data that is passed to the callback

Returns:

connection object that allows to disconnect the callback function.

Definition at line 100 of file window.h.

template<typename T >

boost::signals2::connection pcl::visualization::Window::registerMouseCallback	(	void(T::*)(const pcl::visualization::MouseEvent &, void *)	callback,
		T &	instance,
		void *	cookie = NULL
	)		[inline]

registering a callback function for mouse events

Parameters:

callback	the member function that will be registered as a callback for a mouse event
instance	instance to the class that implements the callback function
cookie	user data that is passed to the callback

Returns:

connection object that allows to disconnect the callback function.

Definition at line 127 of file window.h.

boost::signals2::connection pcl::visualization::Window::registerMouseCallback	(	void(*)(const pcl::visualization::MouseEvent &, void *)	callback,
		void *	cookie = NULL
	)		[inline]

Parameters:

callback	the function that will be registered as a callback for a mouse event
cookie	user data that is passed to the callback

Returns:

connection object that allows to disconnect the callback function.

Definition at line 113 of file window.h.

void pcl::visualization::Window::spin

(

)

Spin method.

Calls the interactor and runs an internal loop.

void pcl::visualization::Window::spinOnce	(	int	time = 1,
		bool	force_redraw = false
	)

Spin once method.

Calls the interactor and updates the screen once.

Parameters:

time	- How long (in ms) should the visualization loop be allowed to run.
force_redraw	- if false it might return without doing anything if the interactor's framerate does not require a redraw yet.

bool pcl::visualization::Window::wasStopped

(

)

const [inline]

Returns true when the user tried to close the window.

Definition at line 77 of file window.h.

---

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

• /builddir/build/BUILD/PCL-1.3.1-Source/visualization/include/pcl/visualization/window.h