Classes | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
pcl::visualization::Window Class Reference

#include <window.h>

List of all members.

Classes

struct  ExitCallback
struct  ExitMainLoopTimerCallback

Public Member Functions

Windowoperator= (const Window &src)
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
void spin ()
 Spin method. Calls the interactor and runs an internal loop.
void spinOnce (int time=1, bool force_redraw=false)
 Spin once method. Calls the interactor and updates the screen once.
bool wasStopped () const
 Returns true when the user tried to close the window.
 Window (const std::string &window_name="")
 Window (const Window &src)
virtual ~Window ()

Protected Member Functions

void emitKeyboardEvent (unsigned long event_id)
void emitMouseEvent (unsigned long event_id)
boost::signals2::connection registerKeyboardCallback (boost::function< void(const pcl::visualization::KeyboardEvent &)>)
 registering a callback boost::function for keyboard events
boost::signals2::connection registerMouseCallback (boost::function< void(const pcl::visualization::MouseEvent &)>)
 registering a callback function for mouse events
void resetStoppedFlag ()
 Set the stopped flag back to false.

Static Protected Member Functions

static void KeyboardCallback (vtkObject *, unsigned long eid, void *clientdata, void *calldata)
static void MouseCallback (vtkObject *, unsigned long eid, void *clientdata, void *calldata)

Protected Attributes

vtkSmartPointer< ExitCallbackexit_callback_
vtkSmartPointer
< ExitMainLoopTimerCallback
exit_main_loop_timer_callback_
vtkSmartPointer
< vtkRenderWindowInteractor > 
interactor_
vtkCallbackCommand * keyboard_command_
boost::signals2::signal< void(const
pcl::visualization::KeyboardEvent &)> 
keyboard_signal_
vtkCallbackCommand * mouse_command_
boost::signals2::signal< void(const
pcl::visualization::MouseEvent &)> 
mouse_signal_
vtkSmartPointer
< vtkRendererCollection > 
rens_
 The collection of renderers used.
bool stopped_
vtkSmartPointer
< PCLVisualizerInteractorStyle
style_
 The render window interactor style.
int timer_id_
vtkSmartPointer< vtkRenderWindow > win_

Detailed Description

Definition at line 62 of file window.h.


Constructor & Destructor Documentation

pcl::visualization::Window::Window ( const std::string window_name = "")

Definition at line 52 of file window.cpp.

Definition at line 120 of file window.cpp.

Definition at line 156 of file window.cpp.


Member Function Documentation

void pcl::visualization::Window::emitKeyboardEvent ( unsigned long  event_id) [protected]

Definition at line 309 of file window.cpp.

void pcl::visualization::Window::emitMouseEvent ( unsigned long  event_id) [protected]

Definition at line 234 of file window.cpp.

void pcl::visualization::Window::KeyboardCallback ( vtkObject *  ,
unsigned long  eid,
void *  clientdata,
void *  calldata 
) [static, protected]

Definition at line 325 of file window.cpp.

void pcl::visualization::Window::MouseCallback ( vtkObject *  ,
unsigned long  eid,
void *  clientdata,
void *  calldata 
) [static, protected]

Definition at line 317 of file window.cpp.

pcl::visualization::Window & pcl::visualization::Window::operator= ( const Window src)

Definition at line 138 of file window.cpp.

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:
callbackthe function that will be registered as a callback for a keyboard event
cookieuser data that is passed to the callback
Returns:
connection object that allows to disconnect the callback function.

Definition at line 94 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:
callbackthe member function that will be registered as a callback for a keyboard event
instanceinstance to the class that implements the callback function
cookieuser data that is passed to the callback
Returns:
connection object that allows to disconnect the callback function.

Definition at line 108 of file window.h.

boost::signals2::connection pcl::visualization::Window::registerKeyboardCallback ( boost::function< void(const pcl::visualization::KeyboardEvent &)>  callback) [protected]

registering a callback boost::function for keyboard events

Parameters:
theboost function that will be registered as a callback for a keyboard event
Returns:
connection object that allows to disconnect the callback function.

Definition at line 220 of file window.cpp.

boost::signals2::connection pcl::visualization::Window::registerMouseCallback ( void(*)(const pcl::visualization::MouseEvent &, void *)  callback,
void *  cookie = NULL 
) [inline]
Parameters:
callbackthe function that will be registered as a callback for a mouse event
cookieuser data that is passed to the callback
Returns:
connection object that allows to disconnect the callback function.

Definition at line 121 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:
callbackthe member function that will be registered as a callback for a mouse event
instanceinstance to the class that implements the callback function
cookieuser data that is passed to the callback
Returns:
connection object that allows to disconnect the callback function.

Definition at line 135 of file window.h.

boost::signals2::connection pcl::visualization::Window::registerMouseCallback ( boost::function< void(const pcl::visualization::MouseEvent &)>  callback) [protected]

registering a callback function for mouse events

Parameters:
theboost function that will be registered as a callback for a mouse event
Returns:
connection object that allows to disconnect the callback function.

Definition at line 200 of file window.cpp.

void pcl::visualization::Window::resetStoppedFlag ( ) [inline, protected]

Set the stopped flag back to false.

Definition at line 145 of file window.h.

Spin method. Calls the interactor and runs an internal loop.

Definition at line 164 of file window.cpp.

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.

Definition at line 174 of file window.cpp.

bool pcl::visualization::Window::wasStopped ( ) const [inline]

Returns true when the user tried to close the window.

Definition at line 85 of file window.h.


Member Data Documentation

Definition at line 227 of file window.h.

Definition at line 226 of file window.h.

vtkSmartPointer<vtkRenderWindowInteractor> pcl::visualization::Window::interactor_ [protected]

Definition at line 219 of file window.h.

vtkCallbackCommand* pcl::visualization::Window::keyboard_command_ [protected]

Definition at line 221 of file window.h.

boost::signals2::signal<void (const pcl::visualization::KeyboardEvent&)> pcl::visualization::Window::keyboard_signal_ [protected]

Definition at line 216 of file window.h.

vtkCallbackCommand* pcl::visualization::Window::mouse_command_ [protected]

Definition at line 220 of file window.h.

boost::signals2::signal<void (const pcl::visualization::MouseEvent&)> pcl::visualization::Window::mouse_signal_ [protected]

Definition at line 215 of file window.h.

vtkSmartPointer<vtkRendererCollection> pcl::visualization::Window::rens_ [protected]

The collection of renderers used.

Definition at line 225 of file window.h.

Definition at line 211 of file window.h.

The render window interactor style.

Definition at line 223 of file window.h.

Definition at line 212 of file window.h.

vtkSmartPointer<vtkRenderWindow> pcl::visualization::Window::win_ [protected]

Definition at line 218 of file window.h.


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


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:47:36