Point Cloud Library (PCL) 1.15.1
Loading...
Searching...
No Matches
pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 > Class 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 = shared_ptr<PointCloudColorHandler<PointCloud> >
using ConstPtr = shared_ptr<const PointCloudColorHandler<PointCloud> >

Public Member Functions

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

Protected Attributes

PointCloudConstPtr cloud_
 A pointer to the input dataset.
bool capable_
 True if this handler is capable of handling the input data, false otherwise.
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

Base Handler class for PointCloud colors.

Author
Radu B. Rusu

Definition at line 525 of file point_cloud_color_handlers.h.

Member Typedef Documentation

◆ ConstPtr

◆ PointCloud

◆ PointCloudConstPtr

◆ PointCloudPtr

◆ Ptr

Constructor & Destructor Documentation

◆ PointCloudColorHandler()

◆ ~PointCloudColorHandler()

Member Function Documentation

◆ getColor()

virtual vtkSmartPointer< vtkDataArray > pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >::getColor ( ) const
pure virtual

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

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

◆ getFieldName()

◆ getName()

◆ isCapable()

Return whether this handler is capable of handling the input data or not.

Definition at line 545 of file point_cloud_color_handlers.h.

References capable_.

◆ setInputCloud()

Set the input cloud to be used.

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

Definition at line 568 of file point_cloud_color_handlers.h.

References cloud_.

Member Data Documentation

◆ capable_

◆ cloud_

A pointer to the input dataset.

Definition at line 575 of file point_cloud_color_handlers.h.

Referenced by PointCloudColorHandler(), and setInputCloud().

◆ field_idx_

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

Definition at line 583 of file point_cloud_color_handlers.h.

Referenced by PointCloudColorHandler().

◆ fields_

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: