Public Types | Public Member Functions | Protected Attributes
pcl::visualization::PointCloudColorHandler< PointT > Class Template Reference

Base Handler class for PointCloud colors. More...

#include <point_cloud_color_handlers.h>

Inheritance diagram for pcl::visualization::PointCloudColorHandler< PointT >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef boost::shared_ptr
< const PointCloudColorHandler
< PointT > > 
ConstPtr
typedef pcl::PointCloud< PointTPointCloud
typedef PointCloud::ConstPtr PointCloudConstPtr
typedef PointCloud::Ptr PointCloudPtr
typedef boost::shared_ptr
< PointCloudColorHandler
< PointT > > 
Ptr

Public Member Functions

virtual bool getColor (vtkSmartPointer< vtkDataArray > &scalars) const =0
 Obtain the actual color for the input dataset as vtk scalars.
virtual std::string getFieldName () const =0
 Abstract getFieldName method.
virtual std::string getName () const =0
 Abstract getName method.
bool isCapable () const
 Check if this handler is capable of handling the input data or not.
 PointCloudColorHandler ()
 Constructor.
 PointCloudColorHandler (const PointCloudConstPtr &cloud)
 Constructor.
virtual void setInputCloud (const PointCloudConstPtr &cloud)
 Set the input cloud to be used.
virtual ~PointCloudColorHandler ()
 Destructor.

Protected Attributes

bool capable_
 True if this handler is capable of handling the input data, false otherwise.
PointCloudConstPtr cloud_
 A pointer to the input dataset.
int field_idx_
 The index of the field holding the data that represents the color.
std::vector< pcl::PCLPointFieldfields_
 The list of fields available for this PointCloud.

Detailed Description

template<typename PointT>
class pcl::visualization::PointCloudColorHandler< PointT >

Base Handler class for PointCloud colors.

Author:
Radu B. Rusu

Definition at line 64 of file point_cloud_color_handlers.h.


Member Typedef Documentation

template<typename PointT>
typedef boost::shared_ptr<const PointCloudColorHandler<PointT> > pcl::visualization::PointCloudColorHandler< PointT >::ConstPtr
template<typename PointT>
typedef boost::shared_ptr<PointCloudColorHandler<PointT> > pcl::visualization::PointCloudColorHandler< PointT >::Ptr

Constructor & Destructor Documentation

template<typename PointT>
pcl::visualization::PointCloudColorHandler< PointT >::PointCloudColorHandler ( ) [inline]

Constructor.

Definition at line 75 of file point_cloud_color_handlers.h.

template<typename PointT>
pcl::visualization::PointCloudColorHandler< PointT >::PointCloudColorHandler ( const PointCloudConstPtr cloud) [inline]

Constructor.

Definition at line 80 of file point_cloud_color_handlers.h.

template<typename PointT>
virtual pcl::visualization::PointCloudColorHandler< PointT >::~PointCloudColorHandler ( ) [inline, virtual]

Destructor.

Definition at line 85 of file point_cloud_color_handlers.h.


Member Function Documentation

template<typename PointT>
virtual bool pcl::visualization::PointCloudColorHandler< PointT >::getColor ( vtkSmartPointer< vtkDataArray > &  scalars) const [pure virtual]

Obtain the actual color for the input dataset as vtk scalars.

Parameters:
[out]scalarsthe output scalars containing the color for the dataset
Returns:
true if the operation was successful (the handler is capable and the input cloud was given as a valid pointer), false otherwise

Implemented in pcl::visualization::PointCloudColorHandlerGenericField< PointT >, pcl::visualization::PointCloudColorHandlerHSVField< PointT >, pcl::visualization::PointCloudColorHandlerRGBField< PointT >, pcl::visualization::PointCloudColorHandlerCustom< PointT >, pcl::visualization::PointCloudColorHandlerCustom< PointType >, and pcl::visualization::PointCloudColorHandlerRandom< PointT >.

template<typename PointT>
virtual std::string pcl::visualization::PointCloudColorHandler< PointT >::getFieldName ( ) const [pure virtual]
template<typename PointT>
virtual std::string pcl::visualization::PointCloudColorHandler< PointT >::getName ( ) const [pure virtual]
template<typename PointT>
bool pcl::visualization::PointCloudColorHandler< PointT >::isCapable ( ) const [inline]

Check if this handler is capable of handling the input data or not.

Definition at line 89 of file point_cloud_color_handlers.h.

template<typename PointT>
virtual void pcl::visualization::PointCloudColorHandler< PointT >::setInputCloud ( const PointCloudConstPtr cloud) [inline, virtual]

Set the input cloud to be used.

Parameters:
[in]cloudthe input cloud to be used by the handler

Reimplemented in pcl::visualization::PointCloudColorHandlerGenericField< PointT >, and pcl::visualization::PointCloudColorHandlerRGBField< PointT >.

Definition at line 111 of file point_cloud_color_handlers.h.


Member Data Documentation

template<typename PointT>
bool pcl::visualization::PointCloudColorHandler< PointT >::capable_ [protected]

True if this handler is capable of handling the input data, false otherwise.

Definition at line 123 of file point_cloud_color_handlers.h.

A pointer to the input dataset.

Definition at line 118 of file point_cloud_color_handlers.h.

template<typename PointT>
int pcl::visualization::PointCloudColorHandler< PointT >::field_idx_ [protected]

The index of the field holding the data that represents the color.

Definition at line 126 of file point_cloud_color_handlers.h.

template<typename PointT>
std::vector<pcl::PCLPointField> pcl::visualization::PointCloudColorHandler< PointT >::fields_ [protected]

The list of fields available for this PointCloud.

Definition at line 129 of file point_cloud_color_handlers.h.


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


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