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

Base Handler class for PointCloud colors. More...

#include <pcl/visualization/point_cloud_color_handlers.h>

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

Public Types

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

Public Member Functions

 PointCloudColorHandler (const PointCloudConstPtr &cloud)
 Constructor. More...
 
virtual ~PointCloudColorHandler ()
 Destructor. More...
 
bool isCapable () const
 Return whether 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...
 
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...
 

Detailed Description

template<>
class pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >

Base Handler class for PointCloud colors.

Author
Radu B. Rusu

Definition at line 571 of file point_cloud_color_handlers.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 579 of file point_cloud_color_handlers.h.

◆ PointCloud

Definition at line 574 of file point_cloud_color_handlers.h.

◆ PointCloudConstPtr

Definition at line 576 of file point_cloud_color_handlers.h.

◆ PointCloudPtr

Definition at line 575 of file point_cloud_color_handlers.h.

◆ Ptr

Definition at line 578 of file point_cloud_color_handlers.h.

Constructor & Destructor Documentation

◆ PointCloudColorHandler()

Constructor.

Definition at line 582 of file point_cloud_color_handlers.h.

◆ ~PointCloudColorHandler()

Destructor.

Definition at line 587 of file point_cloud_color_handlers.h.

Member Function Documentation

◆ getColor() [1/2]

virtual vtkSmartPointer<vtkDataArray> pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >::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< pcl::PCLPointCloud2 >, pcl::visualization::PointCloudColorHandlerRGBAField< pcl::PCLPointCloud2 >, pcl::visualization::PointCloudColorHandlerGenericField< pcl::PCLPointCloud2 >, pcl::visualization::PointCloudColorHandlerHSVField< pcl::PCLPointCloud2 >, pcl::visualization::PointCloudColorHandlerRGBField< pcl::PCLPointCloud2 >, pcl::visualization::PointCloudColorHandlerCustom< pcl::PCLPointCloud2 >, and pcl::visualization::PointCloudColorHandlerRandom< pcl::PCLPointCloud2 >.

Definition at line 608 of file point_cloud_color_handlers.h.

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

◆ getColor() [2/2]

virtual bool pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >::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.

Definition at line 620 of file point_cloud_color_handlers.h.

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

◆ getFieldName()

virtual std::string pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >::getFieldName ( ) const
pure virtual

◆ getName()

virtual std::string pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >::getName ( ) const
pure virtual

◆ isCapable()

◆ setInputCloud()

void pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >::setInputCloud ( const PointCloudConstPtr cloud)
inline

Set the input cloud to be used.

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

Definition at line 629 of file point_cloud_color_handlers.h.

References pcl::visualization::PointCloudColorHandler< PointT >::cloud_.

Member Data Documentation

◆ capable_

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

Definition at line 641 of file point_cloud_color_handlers.h.

◆ cloud_

A pointer to the input dataset.

Definition at line 636 of file point_cloud_color_handlers.h.

◆ field_idx_

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

Definition at line 644 of file point_cloud_color_handlers.h.


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