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

RGB handler class for colors. More...

#include <pcl/visualization/point_cloud_color_handlers.h>

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

Public Types

using Ptr = boost::shared_ptr< PointCloudColorHandlerRGBField< PointT > >
 
using ConstPtr = boost::shared_ptr< const PointCloudColorHandlerRGBField< PointT > >
 
- Public Types inherited from pcl::visualization::PointCloudColorHandler< PointT >
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

 PointCloudColorHandlerRGBField ()
 Constructor. More...
 
 PointCloudColorHandlerRGBField (const PointCloudConstPtr &cloud)
 Constructor. More...
 
virtual ~PointCloudColorHandlerRGBField ()
 Destructor. More...
 
virtual std::string getFieldName () const
 Get the name of the field used. More...
 
vtkSmartPointer< vtkDataArray > getColor () const override
 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...
 
- Public Member Functions inherited from pcl::visualization::PointCloudColorHandler< PointT >
 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 bool getColor (vtkSmartPointer< vtkDataArray > &scalars) const
 Obtain the actual color for the input dataset as a VTK data array. More...
 

Protected Member Functions

virtual std::string getName () const
 Class getName method. More...
 

Additional Inherited Members

- Protected Attributes inherited from pcl::visualization::PointCloudColorHandler< PointT >
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::PointCloudColorHandlerRGBField< PointT >

RGB handler class for colors.

Uses the data present in the "rgb" or "rgba" fields as the color at each point.

Author
Radu B. Rusu

Definition at line 267 of file point_cloud_color_handlers.h.

Member Typedef Documentation

◆ ConstPtr

template<typename PointT>
using pcl::visualization::PointCloudColorHandlerRGBField< PointT >::ConstPtr = boost::shared_ptr<const PointCloudColorHandlerRGBField<PointT> >

Definition at line 275 of file point_cloud_color_handlers.h.

◆ Ptr

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

Definition at line 274 of file point_cloud_color_handlers.h.

Constructor & Destructor Documentation

◆ PointCloudColorHandlerRGBField() [1/2]

◆ PointCloudColorHandlerRGBField() [2/2]

◆ ~PointCloudColorHandlerRGBField()

template<typename PointT>
virtual pcl::visualization::PointCloudColorHandlerRGBField< PointT >::~PointCloudColorHandlerRGBField ( )
inlinevirtual

Destructor.

Definition at line 291 of file point_cloud_color_handlers.h.

Member Function Documentation

◆ getColor()

template<typename PointT >
vtkSmartPointer< vtkDataArray > pcl::visualization::PointCloudColorHandlerRGBField< PointT >::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

Reimplemented from pcl::visualization::PointCloudColorHandler< PointT >.

Definition at line 132 of file point_cloud_color_handlers.hpp.

◆ getFieldName()

template<typename PointT>
virtual std::string pcl::visualization::PointCloudColorHandlerRGBField< PointT >::getFieldName ( ) const
inlinevirtual

◆ getName()

template<typename PointT>
virtual std::string pcl::visualization::PointCloudColorHandlerRGBField< PointT >::getName ( ) const
inlineprotectedvirtual

Class getName method.

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

Definition at line 311 of file point_cloud_color_handlers.h.

◆ setInputCloud()

template<typename PointT >
void pcl::visualization::PointCloudColorHandlerRGBField< PointT >::setInputCloud ( const PointCloudConstPtr cloud)
virtual

Set the input cloud to be used.

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

Reimplemented from pcl::visualization::PointCloudColorHandler< PointT >.

Definition at line 109 of file point_cloud_color_handlers.hpp.


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