Public Types | Public Member Functions

pcl::visualization::CloudViewer Class Reference
[Module visualization]

Simple point cloud visualization class. More...

#include <pcl/visualization/cloud_viewer.h>

List of all members.

Public Types

typedef pcl::PointCloud
< pcl::PointXYZRGB
ColorCloud
typedef pcl::PointCloud
< pcl::PointXYZ
GrayCloud
typedef boost::function1< void,
pcl::visualization::PCLVisualizer & > 
VizCallable
 Visualization callable function, may be used for running things on the UI thread.

Public Member Functions

 CloudViewer (const std::string &window_name)
 Construct a cloud viewer, with a window name.
 ~CloudViewer ()
 Will quit the window, and release all resources held by the viewer.
void showCloud (const ColorCloud::ConstPtr &cloud, const std::string &cloudname="cloud")
 Show a cloud, with an optional key for multiple clouds.
void showCloud (const GrayCloud::ConstPtr &cloud, const std::string &cloudname="cloud")
 Show a cloud, with an optional key for multiple clouds.
bool wasStopped (int millis_to_wait=1)
 Check if the gui was quit, you should quit also.
void runOnVisualizationThread (VizCallable x, const std::string &key="callable")
 Run a callbable object on the UI thread.
void runOnVisualizationThreadOnce (VizCallable x)
 Run a callbable object on the UI thread.
void removeVisualizationCallable (const std::string &key="callable")
 Remove a previously added callable object, NOP if it doesn't exist.

Detailed Description

Simple point cloud visualization class.

Author:
Ethan Rublee

Definition at line 55 of file cloud_viewer.h.


Member Typedef Documentation

Definition at line 58 of file cloud_viewer.h.

Definition at line 59 of file cloud_viewer.h.

Visualization callable function, may be used for running things on the UI thread.

Definition at line 96 of file cloud_viewer.h.


Constructor & Destructor Documentation

pcl::visualization::CloudViewer::CloudViewer ( const std::string &  window_name  ) 

Construct a cloud viewer, with a window name.

Parameters:
window_name This is displayed at the top of the window
pcl::visualization::CloudViewer::~CloudViewer (  ) 

Will quit the window, and release all resources held by the viewer.

Returns:

Member Function Documentation

void pcl::visualization::CloudViewer::removeVisualizationCallable ( const std::string &  key = "callable"  ) 

Remove a previously added callable object, NOP if it doesn't exist.

Parameters:
key the key that was registered with the callable object.
void pcl::visualization::CloudViewer::runOnVisualizationThread ( VizCallable  x,
const std::string &  key = "callable" 
)

Run a callbable object on the UI thread.

Will persist until removed

Parameters:
x Use boost::ref(x) for a function object that you would like to not copy
key The key for the callable -- use the same key to overwrite.
void pcl::visualization::CloudViewer::runOnVisualizationThreadOnce ( VizCallable  x  ) 

Run a callbable object on the UI thread.

This will run once and be removed

Parameters:
x Use boost::ref(x) for a function object that you would like to not copy
void pcl::visualization::CloudViewer::showCloud ( const GrayCloud::ConstPtr cloud,
const std::string &  cloudname = "cloud" 
)

Show a cloud, with an optional key for multiple clouds.

Parameters:
cloud XYZ point cloud
cloudname a key for the point cloud, use the same name if you would like to overwrite the existing cloud.
void pcl::visualization::CloudViewer::showCloud ( const ColorCloud::ConstPtr cloud,
const std::string &  cloudname = "cloud" 
)

Show a cloud, with an optional key for multiple clouds.

Parameters:
cloud RGB point cloud
cloudname a key for the point cloud, use the same name if you would like to overwrite the existing cloud.
bool pcl::visualization::CloudViewer::wasStopped ( int  millis_to_wait = 1  ) 

Check if the gui was quit, you should quit also.

Parameters:
millis_to_wait This will request to "spin" for the number of milliseconds, before exiting.
Returns:
true if the user signaled the gui to stop

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