Point Cloud Library (PCL)  1.7.1
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
pcl::visualization::PCLVisualizerInteractorStyle Class Reference

PCLVisualizerInteractorStyle defines an unique, custom VTK based interactory style for PCL Visualizer applications. More...

#include <pcl/visualization/interactor_style.h>

+ Inheritance diagram for pcl::visualization::PCLVisualizerInteractorStyle:

Public Member Functions

 PCLVisualizerInteractorStyle ()
 Empty constructor. More...
 
virtual ~PCLVisualizerInteractorStyle ()
 Empty destructor. More...
 
 vtkTypeMacro (PCLVisualizerInteractorStyle, vtkInteractorStyleRubberBandPick)
 
virtual void Initialize ()
 Initialization routine. More...
 
void setCloudActorMap (const CloudActorMapPtr &actors)
 Pass a pointer to the actor map. More...
 
CloudActorMapPtr getCloudActorMap ()
 Get the cloud actor map pointer. More...
 
void setRendererCollection (vtkSmartPointer< vtkRendererCollection > &rens)
 Pass a set of renderers to the interactor style. More...
 
void setUseVbos (const bool use_vbos)
 Pass a pointer to the actor map. More...
 
boost::signals2::connection registerMouseCallback (boost::function< void(const pcl::visualization::MouseEvent &)> cb)
 Register a callback function for mouse events. More...
 
boost::signals2::connection registerKeyboardCallback (boost::function< void(const pcl::visualization::KeyboardEvent &)> cb)
 Register a callback boost::function for keyboard events. More...
 
boost::signals2::connection registerPointPickingCallback (boost::function< void(const pcl::visualization::PointPickingEvent &)> cb)
 Register a callback function for point picking events. More...
 
boost::signals2::connection registerAreaPickingCallback (boost::function< void(const pcl::visualization::AreaPickingEvent &)> cb)
 Register a callback function for area picking events. More...
 
void saveScreenshot (const std::string &file)
 Save the current rendered image to disk, as a PNG screenshot. More...
 
void setKeyboardModifier (const InteractorKeyboardModifier &modifier)
 Change the default keyboard modified from ALT to a different special key. More...
 

Static Public Member Functions

static
PCLVisualizerInteractorStyle
New ()
 

Protected Member Functions

virtual void OnChar ()
 Interactor style internal method. More...
 
virtual void OnKeyDown ()
 
virtual void OnKeyUp ()
 
virtual void OnMouseMove ()
 
virtual void OnLeftButtonDown ()
 
virtual void OnLeftButtonUp ()
 
virtual void OnMiddleButtonDown ()
 
virtual void OnMiddleButtonUp ()
 
virtual void OnRightButtonDown ()
 
virtual void OnRightButtonUp ()
 
virtual void OnMouseWheelForward ()
 
virtual void OnMouseWheelBackward ()
 
virtual void OnTimer ()
 Interactor style internal method. More...
 
void zoomIn ()
 Interactor style internal method. More...
 
void zoomOut ()
 Interactor style internal method. More...
 

Protected Attributes

bool init_
 Set to true after initialization is complete. More...
 
vtkSmartPointer
< vtkRendererCollection > 
rens_
 Collection of vtkRenderers stored internally. More...
 
CloudActorMapPtr actors_
 Actor map stored internally. More...
 
int win_height_
 The current window width/height. More...
 
int win_width_
 
int win_pos_x_
 The current window position x/y. More...
 
int win_pos_y_
 
int max_win_height_
 The maximum resizeable window width/height. More...
 
int max_win_width_
 
bool use_vbos_
 The maximum resizeable window width/height. More...
 
bool grid_enabled_
 Set to true if the grid actor is enabled. More...
 
vtkSmartPointer
< vtkLegendScaleActor > 
grid_actor_
 Actor for 2D grid on screen. More...
 
bool lut_enabled_
 Set to true if the LUT actor is enabled. More...
 
vtkSmartPointer
< vtkScalarBarActor > 
lut_actor_
 Actor for 2D lookup table on screen. More...
 
vtkSmartPointer< vtkPNGWriter > snapshot_writer_
 A PNG writer for screenshot captures. More...
 
vtkSmartPointer
< vtkWindowToImageFilter > 
wif_
 Internal window to image filter. More...
 
vtkSmartPointer< vtkPointPicker > point_picker_
 Stores the point picker when switching to an area picker. More...
 
boost::signals2::signal< void(const
pcl::visualization::MouseEvent &)> 
mouse_signal_
 
boost::signals2::signal< void(const
pcl::visualization::KeyboardEvent &)> 
keyboard_signal_
 
boost::signals2::signal< void(const
pcl::visualization::PointPickingEvent &)> 
point_picking_signal_
 
boost::signals2::signal< void(const
pcl::visualization::AreaPickingEvent &)> 
area_picking_signal_
 
bool stereo_anaglyph_mask_default_
 True if we're using red-blue colors for anaglyphic stereo, false if magenta-green. More...
 
vtkSmartPointer
< PointPickingCallback
mouse_callback_
 A VTK Mouse Callback object, used for point picking. More...
 
InteractorKeyboardModifier modifier_
 The keyboard modifier to use. More...
 

Friends

class PointPickingCallback
 

Detailed Description

PCLVisualizerInteractorStyle defines an unique, custom VTK based interactory style for PCL Visualizer applications.

Besides defining the rendering style, we also create a list of custom actions that are triggered on different keys being pressed:

Author
Radu B. Rusu

Definition at line 105 of file interactor_style.h.

Constructor & Destructor Documentation

pcl::visualization::PCLVisualizerInteractorStyle::PCLVisualizerInteractorStyle ( )
inline

Empty constructor.

Definition at line 113 of file interactor_style.h.

virtual pcl::visualization::PCLVisualizerInteractorStyle::~PCLVisualizerInteractorStyle ( )
inlinevirtual

Empty destructor.

Definition at line 122 of file interactor_style.h.

Member Function Documentation

CloudActorMapPtr pcl::visualization::PCLVisualizerInteractorStyle::getCloudActorMap ( )
inline

Get the cloud actor map pointer.

Definition at line 139 of file interactor_style.h.

virtual void pcl::visualization::PCLVisualizerInteractorStyle::Initialize ( )
virtual

Initialization routine.

Must be called before anything else.

static PCLVisualizerInteractorStyle* pcl::visualization::PCLVisualizerInteractorStyle::New ( )
static
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnChar ( )
protectedvirtual

Interactor style internal method.

Gets called whenever a key is pressed.

virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnKeyDown ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnKeyUp ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnLeftButtonDown ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnLeftButtonUp ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnMiddleButtonDown ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnMiddleButtonUp ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnMouseMove ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnMouseWheelBackward ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnMouseWheelForward ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnRightButtonDown ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnRightButtonUp ( )
protectedvirtual
virtual void pcl::visualization::PCLVisualizerInteractorStyle::OnTimer ( )
protectedvirtual

Interactor style internal method.

Gets called periodically if a timer is set.

boost::signals2::connection pcl::visualization::PCLVisualizerInteractorStyle::registerAreaPickingCallback ( boost::function< void(const pcl::visualization::AreaPickingEvent &)>  cb)

Register a callback function for area picking events.

Parameters
[in]cba boost function that will be registered as a callback for a area picking event
Returns
a connection object that allows to disconnect the callback function.
boost::signals2::connection pcl::visualization::PCLVisualizerInteractorStyle::registerKeyboardCallback ( boost::function< void(const pcl::visualization::KeyboardEvent &)>  cb)

Register a callback boost::function for keyboard events.

Parameters
[in]cba boost function that will be registered as a callback for a keyboard event
Returns
a connection object that allows to disconnect the callback function.
boost::signals2::connection pcl::visualization::PCLVisualizerInteractorStyle::registerMouseCallback ( boost::function< void(const pcl::visualization::MouseEvent &)>  cb)

Register a callback function for mouse events.

Parameters
[in]cba boost function that will be registered as a callback for a mouse event
Returns
a connection object that allows to disconnect the callback function.
boost::signals2::connection pcl::visualization::PCLVisualizerInteractorStyle::registerPointPickingCallback ( boost::function< void(const pcl::visualization::PointPickingEvent &)>  cb)

Register a callback function for point picking events.

Parameters
[in]cba boost function that will be registered as a callback for a point picking event
Returns
a connection object that allows to disconnect the callback function.
void pcl::visualization::PCLVisualizerInteractorStyle::saveScreenshot ( const std::string &  file)

Save the current rendered image to disk, as a PNG screenshot.

Parameters
[in]filethe name of the PNG file
void pcl::visualization::PCLVisualizerInteractorStyle::setCloudActorMap ( const CloudActorMapPtr &  actors)
inline

Pass a pointer to the actor map.

Parameters
[in]actorsthe actor map that will be used with this style

Definition at line 135 of file interactor_style.h.

void pcl::visualization::PCLVisualizerInteractorStyle::setKeyboardModifier ( const InteractorKeyboardModifier modifier)
inline

Change the default keyboard modified from ALT to a different special key.

Allowed values are:

  • INTERACTOR_KB_MOD_ALT
  • INTERACTOR_KB_MOD_CTRL
  • INTERACTOR_KB_MOD_SHIFT
    Parameters
    [in]modifierthe new keyboard modifier

Definition at line 195 of file interactor_style.h.

void pcl::visualization::PCLVisualizerInteractorStyle::setRendererCollection ( vtkSmartPointer< vtkRendererCollection > &  rens)
inline

Pass a set of renderers to the interactor style.

Parameters
[in]rensthe vtkRendererCollection to use

Definition at line 145 of file interactor_style.h.

void pcl::visualization::PCLVisualizerInteractorStyle::setUseVbos ( const bool  use_vbos)
inline

Pass a pointer to the actor map.

Parameters
[in]actorsthe actor map that will be used with this style

Definition at line 151 of file interactor_style.h.

pcl::visualization::PCLVisualizerInteractorStyle::vtkTypeMacro ( PCLVisualizerInteractorStyle  ,
vtkInteractorStyleRubberBandPick   
)
void pcl::visualization::PCLVisualizerInteractorStyle::zoomIn ( )
protected

Interactor style internal method.

Zoom in.

void pcl::visualization::PCLVisualizerInteractorStyle::zoomOut ( )
protected

Interactor style internal method.

Zoom out.

Friends And Related Function Documentation

friend class PointPickingCallback
friend

Definition at line 296 of file interactor_style.h.

Member Data Documentation

CloudActorMapPtr pcl::visualization::PCLVisualizerInteractorStyle::actors_
protected

Actor map stored internally.

Definition at line 208 of file interactor_style.h.

boost::signals2::signal<void (const pcl::visualization::AreaPickingEvent&)> pcl::visualization::PCLVisualizerInteractorStyle::area_picking_signal_
protected

Definition at line 242 of file interactor_style.h.

vtkSmartPointer<vtkLegendScaleActor> pcl::visualization::PCLVisualizerInteractorStyle::grid_actor_
protected

Actor for 2D grid on screen.

Definition at line 225 of file interactor_style.h.

bool pcl::visualization::PCLVisualizerInteractorStyle::grid_enabled_
protected

Set to true if the grid actor is enabled.

Definition at line 223 of file interactor_style.h.

bool pcl::visualization::PCLVisualizerInteractorStyle::init_
protected

Set to true after initialization is complete.

Definition at line 202 of file interactor_style.h.

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

Definition at line 240 of file interactor_style.h.

vtkSmartPointer<vtkScalarBarActor> pcl::visualization::PCLVisualizerInteractorStyle::lut_actor_
protected

Actor for 2D lookup table on screen.

Definition at line 230 of file interactor_style.h.

bool pcl::visualization::PCLVisualizerInteractorStyle::lut_enabled_
protected

Set to true if the LUT actor is enabled.

Definition at line 228 of file interactor_style.h.

int pcl::visualization::PCLVisualizerInteractorStyle::max_win_height_
protected

The maximum resizeable window width/height.

Definition at line 217 of file interactor_style.h.

int pcl::visualization::PCLVisualizerInteractorStyle::max_win_width_
protected

Definition at line 217 of file interactor_style.h.

InteractorKeyboardModifier pcl::visualization::PCLVisualizerInteractorStyle::modifier_
protected

The keyboard modifier to use.

Default: Alt.

Definition at line 294 of file interactor_style.h.

vtkSmartPointer<PointPickingCallback> pcl::visualization::PCLVisualizerInteractorStyle::mouse_callback_
protected

A VTK Mouse Callback object, used for point picking.

Definition at line 291 of file interactor_style.h.

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

Definition at line 239 of file interactor_style.h.

vtkSmartPointer<vtkPointPicker> pcl::visualization::PCLVisualizerInteractorStyle::point_picker_
protected

Stores the point picker when switching to an area picker.

Definition at line 237 of file interactor_style.h.

boost::signals2::signal<void (const pcl::visualization::PointPickingEvent&)> pcl::visualization::PCLVisualizerInteractorStyle::point_picking_signal_
protected

Definition at line 241 of file interactor_style.h.

vtkSmartPointer<vtkRendererCollection> pcl::visualization::PCLVisualizerInteractorStyle::rens_
protected

Collection of vtkRenderers stored internally.

Definition at line 205 of file interactor_style.h.

vtkSmartPointer<vtkPNGWriter> pcl::visualization::PCLVisualizerInteractorStyle::snapshot_writer_
protected

A PNG writer for screenshot captures.

Definition at line 233 of file interactor_style.h.

bool pcl::visualization::PCLVisualizerInteractorStyle::stereo_anaglyph_mask_default_
protected

True if we're using red-blue colors for anaglyphic stereo, false if magenta-green.

Definition at line 288 of file interactor_style.h.

bool pcl::visualization::PCLVisualizerInteractorStyle::use_vbos_
protected

The maximum resizeable window width/height.

Definition at line 220 of file interactor_style.h.

vtkSmartPointer<vtkWindowToImageFilter> pcl::visualization::PCLVisualizerInteractorStyle::wif_
protected

Internal window to image filter.

Needed by snapshot_writer_.

Definition at line 235 of file interactor_style.h.

int pcl::visualization::PCLVisualizerInteractorStyle::win_height_
protected

The current window width/height.

Definition at line 211 of file interactor_style.h.

int pcl::visualization::PCLVisualizerInteractorStyle::win_pos_x_
protected

The current window position x/y.

Definition at line 214 of file interactor_style.h.

int pcl::visualization::PCLVisualizerInteractorStyle::win_pos_y_
protected

Definition at line 214 of file interactor_style.h.

int pcl::visualization::PCLVisualizerInteractorStyle::win_width_
protected

Definition at line 211 of file interactor_style.h.


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