Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Types | Public Member Functions | Protected Attributes
pcl::visualization::PointCloudColorHandler< PointT > Class Template Referenceabstract

Base Handler class for PointCloud colors. More...

#include <pcl/visualization/point_cloud_color_handlers.h>

+ Inheritance diagram for pcl::visualization::PointCloudColorHandler< PointT >:

Public Types

using PointCloud = pcl::PointCloud< PointT >
 
using PointCloudPtr = typename PointCloud::Ptr
 
using PointCloudConstPtr = typename PointCloud::ConstPtr
 
using Ptr = boost::shared_ptr< PointCloudColorHandler< PointT > >
 
using ConstPtr = boost::shared_ptr< const PointCloudColorHandler< PointT > >
 

Public Member Functions

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

Protected Attributes

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

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>
using pcl::visualization::PointCloudColorHandler< PointT >::ConstPtr = boost::shared_ptr<const PointCloudColorHandler<PointT> >

Definition at line 72 of file point_cloud_color_handlers.h.

Definition at line 67 of file point_cloud_color_handlers.h.

Definition at line 69 of file point_cloud_color_handlers.h.

template<typename PointT>
using pcl::visualization::PointCloudColorHandler< PointT >::PointCloudPtr = typename PointCloud::Ptr

Definition at line 68 of file point_cloud_color_handlers.h.

template<typename PointT>
using pcl::visualization::PointCloudColorHandler< PointT >::Ptr = boost::shared_ptr<PointCloudColorHandler<PointT> >

Definition at line 71 of file point_cloud_color_handlers.h.

Constructor & Destructor Documentation

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 ( )
inlinevirtual

Destructor.

Definition at line 85 of file point_cloud_color_handlers.h.

Member Function Documentation

template<typename PointT>
virtual vtkSmartPointer<vtkDataArray> pcl::visualization::PointCloudColorHandler< PointT >::getColor ( ) const
inlinevirtual

Obtain the actual color for the input dataset as a VTK data array.

Deriving handlers should override this method. The default implementation is provided only for backwards compatibility with handlers that were written before PCL 1.10.0 and will be removed in future.

Returns
smart pointer to VTK array if the operation was successful (the handler is capable and the input cloud was given), a null pointer otherwise

Reimplemented in pcl::visualization::PointCloudColorHandlerLabelField< PointT >, pcl::visualization::PointCloudColorHandlerRGBAField< PointT >, pcl::visualization::PointCloudColorHandlerGenericField< PointT >, pcl::visualization::PointCloudColorHandlerHSVField< PointT >, pcl::visualization::PointCloudColorHandlerRGBField< PointT >, pcl::visualization::PointCloudColorHandlerCustom< PointT >, and pcl::visualization::PointCloudColorHandlerRandom< PointT >.

Definition at line 106 of file point_cloud_color_handlers.h.

Referenced by pcl::visualization::PointCloudColorHandler< PointT >::getColor(), pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >::getColor(), pcl::visualization::PointCloudColorHandlerRandom< PointT >::getFieldName(), pcl::visualization::PointCloudColorHandlerCustom< PointT >::getFieldName(), pcl::visualization::PointCloudColorHandlerRGBField< PointT >::getFieldName(), pcl::visualization::PointCloudColorHandlerHSVField< PointT >::getFieldName(), pcl::visualization::PointCloudColorHandlerGenericField< PointT >::getFieldName(), pcl::visualization::PointCloudColorHandlerRGBAField< PointT >::getFieldName(), pcl::visualization::PointCloudColorHandlerLabelField< PointT >::getFieldName(), pcl::visualization::PointCloudColorHandlerRandom< pcl::PCLPointCloud2 >::getFieldName(), pcl::visualization::PointCloudColorHandlerCustom< pcl::PCLPointCloud2 >::getFieldName(), pcl::visualization::PCLVisualizer::updateCorrespondences(), pcl::visualization::PCLVisualizer::updatePointCloud(), pcl::visualization::PointCloudColorHandlerGenericField< pcl::PCLPointCloud2 >::~PointCloudColorHandlerGenericField(), pcl::visualization::PointCloudColorHandlerHSVField< pcl::PCLPointCloud2 >::~PointCloudColorHandlerHSVField(), pcl::visualization::PointCloudColorHandlerLabelField< pcl::PCLPointCloud2 >::~PointCloudColorHandlerLabelField(), pcl::visualization::PointCloudColorHandlerRGBAField< pcl::PCLPointCloud2 >::~PointCloudColorHandlerRGBAField(), and pcl::visualization::PointCloudColorHandlerRGBField< pcl::PCLPointCloud2 >::~PointCloudColorHandlerRGBField().

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

Obtain the actual color for the input dataset as a VTK data array.

This virtual method should not be overriden or used. The default implementation is provided only for backwards compatibility with handlers that were written before PCL 1.10.0 and will be removed in future.

Reimplemented in pcl::visualization::PointCloudColorHandlerRGBHack< PointT >.

Definition at line 118 of file point_cloud_color_handlers.h.

References pcl::visualization::PointCloudColorHandler< PointT >::getColor().

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
template<typename PointT>
virtual void pcl::visualization::PointCloudColorHandler< PointT >::setInputCloud ( const PointCloudConstPtr cloud)
inlinevirtual

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 139 of file point_cloud_color_handlers.h.

Referenced by pcl::visualization::PointCloudColorHandlerRGBHack< PointT >::getColor(), pcl::visualization::PointCloudColorHandlerHSVField< PointT >::getColor(), pcl::visualization::PointCloudColorHandlerGenericField< PointT >::getColor(), pcl::visualization::PointCloudColorHandlerRGBAField< PointT >::getColor(), pcl::visualization::PointCloudColorHandlerLabelField< PointT >::getColor(), pcl::visualization::PointCloudColorHandler< PointT >::isCapable(), pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >::isCapable(), pcl::visualization::PointCloudColorHandlerCustom< PointT >::PointCloudColorHandlerCustom(), pcl::visualization::PointCloudColorHandlerCustom< pcl::PCLPointCloud2 >::PointCloudColorHandlerCustom(), pcl::visualization::PointCloudColorHandlerGenericField< PointT >::PointCloudColorHandlerGenericField(), pcl::visualization::PointCloudColorHandlerHSVField< PointT >::PointCloudColorHandlerHSVField(), pcl::visualization::PointCloudColorHandlerLabelField< PointT >::PointCloudColorHandlerLabelField(), pcl::visualization::PointCloudColorHandlerRandom< PointT >::PointCloudColorHandlerRandom(), pcl::visualization::PointCloudColorHandlerRandom< pcl::PCLPointCloud2 >::PointCloudColorHandlerRandom(), pcl::visualization::PointCloudColorHandlerRGBAField< PointT >::PointCloudColorHandlerRGBAField(), pcl::visualization::PointCloudColorHandlerRGBField< PointT >::PointCloudColorHandlerRGBField(), pcl::visualization::PointCloudColorHandlerRGBHack< PointT >::PointCloudColorHandlerRGBHack(), pcl::visualization::PointCloudColorHandlerGenericField< PointT >::setInputCloud(), pcl::visualization::PointCloudColorHandlerRGBAField< PointT >::setInputCloud(), and pcl::visualization::PointCloudColorHandlerLabelField< PointT >::setInputCloud().

template<typename PointT>
PointCloudConstPtr pcl::visualization::PointCloudColorHandler< PointT >::cloud_
protected
template<typename PointT>
int pcl::visualization::PointCloudColorHandler< PointT >::field_idx_
protected
template<typename PointT>
std::vector<pcl::PCLPointField> pcl::visualization::PointCloudColorHandler< PointT >::fields_
protected

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