Point Cloud Library (PCL)  1.14.0-dev
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
pcl::visualization::PointCloudColorHandlerHSVField< pcl::PCLPointCloud2 > Class Reference

HSV handler class for colors. More...

#include <pcl/visualization/point_cloud_color_handlers.h>

+ Inheritance diagram for pcl::visualization::PointCloudColorHandlerHSVField< pcl::PCLPointCloud2 >:
+ Collaboration diagram for pcl::visualization::PointCloudColorHandlerHSVField< pcl::PCLPointCloud2 >:

Public Types

using Ptr = shared_ptr< PointCloudColorHandlerHSVField< PointCloud > >
 
using ConstPtr = shared_ptr< const PointCloudColorHandlerHSVField< PointCloud > >
 
- Public Types inherited from pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >
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

 PointCloudColorHandlerHSVField (const PointCloudConstPtr &cloud)
 Constructor. More...
 
vtkSmartPointer< vtkDataArray > getColor () const override
 Obtain the actual color for the input dataset as a VTK data array. More...
 
- Public Member Functions inherited from pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >
 PointCloudColorHandler (const PointCloudConstPtr &cloud)
 Constructor. More...
 
virtual ~PointCloudColorHandler ()=default
 Destructor. More...
 
bool isCapable () const
 Return whether this handler is capable of handling the input data or not. More...
 
void setInputCloud (const PointCloudConstPtr &cloud)
 Set the input cloud to be used. More...
 

Protected Member Functions

virtual std::string getName () const
 Get the name of the class. More...
 
virtual std::string getFieldName () const
 Get the name of the field used. More...
 

Protected Attributes

int s_field_idx_
 The field index for "S". More...
 
int v_field_idx_
 The field index for "V". More...
 
- Protected Attributes inherited from pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >
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

HSV handler class for colors.

Uses the data present in the "h", "s", "v" fields as the color at each point.

Definition at line 699 of file point_cloud_color_handlers.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 707 of file point_cloud_color_handlers.h.

◆ Ptr

Definition at line 706 of file point_cloud_color_handlers.h.

Constructor & Destructor Documentation

◆ PointCloudColorHandlerHSVField()

Constructor.

Member Function Documentation

◆ getColor()

vtkSmartPointer<vtkDataArray> pcl::visualization::PointCloudColorHandlerHSVField< pcl::PCLPointCloud2 >::getColor ( ) const
overridevirtual

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

Implements pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >.

◆ getFieldName()

virtual std::string pcl::visualization::PointCloudColorHandlerHSVField< pcl::PCLPointCloud2 >::getFieldName ( ) const
inlineprotectedvirtual

Get the name of the field used.

Implements pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >.

Definition at line 722 of file point_cloud_color_handlers.h.

◆ getName()

virtual std::string pcl::visualization::PointCloudColorHandlerHSVField< pcl::PCLPointCloud2 >::getName ( ) const
inlineprotectedvirtual

Get the name of the class.

Implements pcl::visualization::PointCloudColorHandler< pcl::PCLPointCloud2 >.

Definition at line 718 of file point_cloud_color_handlers.h.

Member Data Documentation

◆ s_field_idx_

The field index for "S".

Definition at line 725 of file point_cloud_color_handlers.h.

◆ v_field_idx_

The field index for "V".

Definition at line 728 of file point_cloud_color_handlers.h.


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