pcl_visualization::CloudViewer Class Reference

Dead simple/easy to use class for a point cloud. More...

#include <cloud_viewer.h>

List of all members.

Classes
struct	CloudViewer_impl
Public Types
typedef pcl::PointCloud < pcl::PointXYZRGB >	ColorCloud
typedef pcl::PointCloud < pcl::PointXYZ >	GrayCloud
typedef boost::function1< void, pcl_visualization::PCLVisualizer & >	VizCallable
Public Member Functions
	CloudViewer (const std::string &window_name)
	Construct a cloud viewer, with a window name.
void	removeVisualizationCallable (const std::string &key="callable")
	Remove a previously added callable object, NOP if it doesn't exist.
void	runOnVisualizationThread (VizCallable x, const std::string &key="callable")
	Run a callbable object on the UI thread. Will persist until removed.
void	showCloud (const GrayCloud &cloud, const std::string &cloudname="cloud")
	Show a cloud, with an optional key for multiple clouds.
void	showCloud (const ColorCloud &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.
	~CloudViewer ()
	Will quit the window, and release all resources held by the viewer.
Private Member Functions
	CloudViewer (const CloudViewer &rhs)
void	operator= (const CloudViewer &rhs)
Private Attributes
CloudViewer_impl *	impl_

---

Detailed Description

Dead simple/easy to use class for a point cloud.

Definition at line 43 of file cloud_viewer.h.

---

Member Typedef Documentation

typedef pcl::PointCloud<pcl::PointXYZRGB> pcl_visualization::CloudViewer::ColorCloud

Definition at line 42 of file cloud_viewer.h.

typedef pcl::PointCloud<pcl::PointXYZ> pcl_visualization::CloudViewer::GrayCloud

Definition at line 43 of file cloud_viewer.h.

typedef boost::function1<void, pcl_visualization::PCLVisualizer&> pcl_visualization::CloudViewer::VizCallable

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

Definition at line 79 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

Definition at line 171 of file cloud_viewer.cpp.

pcl_visualization::CloudViewer::~CloudViewer

(

)

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

Returns:

Definition at line 177 of file cloud_viewer.cpp.

pcl_visualization::CloudViewer::CloudViewer

(

const CloudViewer &

rhs

)

[private]

---

Member Function Documentation

void pcl_visualization::CloudViewer::operator=

(

const CloudViewer &

rhs

)

[private]

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.

Definition at line 204 of file cloud_viewer.cpp.

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.

Definition at line 198 of file cloud_viewer.cpp.

void pcl_visualization::CloudViewer::showCloud	(	const GrayCloud &	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.

Definition at line 191 of file cloud_viewer.cpp.

void pcl_visualization::CloudViewer::showCloud	(	const ColorCloud &	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.

Definition at line 183 of file cloud_viewer.cpp.

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

Definition at line 210 of file cloud_viewer.cpp.

---

Member Data Documentation

CloudViewer_impl* pcl_visualization::CloudViewer::impl_ [private]

Definition at line 102 of file cloud_viewer.h.

---

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

• cloud_viewer.h
• cloud_viewer.cpp