Point Cloud Library (PCL)  1.8.1-dev
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
List of all members | Public Types | Public Member Functions | Protected Attributes
pcl::PlanarPolygon< PointT > Class Template Reference

PlanarPolygon represents a planar (2D) polygon, potentially in a 3D space. More...

#include <pcl/geometry/planar_polygon.h>

+ Inheritance diagram for pcl::PlanarPolygon< PointT >:

Public Types

typedef boost::shared_ptr
< PlanarPolygon< PointT > > 
Ptr
 
typedef boost::shared_ptr
< const PlanarPolygon< PointT > > 
ConstPtr
 

Public Member Functions

 PlanarPolygon ()
 Empty constructor for PlanarPolygon. More...
 
 PlanarPolygon (typename pcl::PointCloud< PointT >::VectorType &contour, Eigen::Vector4f &coefficients)
 Constructor for PlanarPolygon. More...
 
virtual ~PlanarPolygon ()
 Destructor. More...
 
void setContour (const pcl::PointCloud< PointT > &contour)
 Set the internal contour. More...
 
pcl::PointCloud< PointT >
::VectorType & 
getContour ()
 Getter for the contour / boundary. More...
 
const pcl::PointCloud< PointT >
::VectorType & 
getContour () const
 Getter for the contour / boundary. More...
 
void setCoefficients (const Eigen::Vector4f &coefficients)
 Setr the internal coefficients. More...
 
void setCoefficients (const pcl::ModelCoefficients &coefficients)
 Set the internal coefficients. More...
 
Eigen::Vector4f & getCoefficients ()
 Getter for the coefficients. More...
 
const Eigen::Vector4f & getCoefficients () const
 Getter for the coefficients. More...
 

Protected Attributes

pcl::PointCloud< PointT >
::VectorType 
contour_
 A list of points on the boundary/contour of the planar region. More...
 
Eigen::Vector4f coefficients_
 A list of model coefficients (a,b,c,d). More...
 

Detailed Description

template<typename PointT>
class pcl::PlanarPolygon< PointT >

PlanarPolygon represents a planar (2D) polygon, potentially in a 3D space.

Author
Alex Trevor

Definition at line 54 of file planar_polygon.h.

Member Typedef Documentation

template<typename PointT>
typedef boost::shared_ptr<const PlanarPolygon<PointT> > pcl::PlanarPolygon< PointT >::ConstPtr

Definition at line 58 of file planar_polygon.h.

template<typename PointT>
typedef boost::shared_ptr<PlanarPolygon<PointT> > pcl::PlanarPolygon< PointT >::Ptr

Definition at line 57 of file planar_polygon.h.

Constructor & Destructor Documentation

template<typename PointT>
pcl::PlanarPolygon< PointT >::PlanarPolygon ( )
inline

Empty constructor for PlanarPolygon.

Definition at line 61 of file planar_polygon.h.

template<typename PointT>
pcl::PlanarPolygon< PointT >::PlanarPolygon ( typename pcl::PointCloud< PointT >::VectorType &  contour,
Eigen::Vector4f &  coefficients 
)
inline

Constructor for PlanarPolygon.

Parameters
[in]contoura vector of points bounding the polygon
[in]coefficientsa vector of the plane's coefficients (a,b,c,d)

Definition at line 68 of file planar_polygon.h.

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

Destructor.

Definition at line 74 of file planar_polygon.h.

Member Function Documentation

template<typename PointT>
Eigen::Vector4f& pcl::PlanarPolygon< PointT >::getCoefficients ( )
inline

Getter for the coefficients.

Definition at line 120 of file planar_polygon.h.

References pcl::PlanarPolygon< PointT >::coefficients_.

Referenced by pcl::approximatePolygon().

template<typename PointT>
const Eigen::Vector4f& pcl::PlanarPolygon< PointT >::getCoefficients ( ) const
inline

Getter for the coefficients.

Definition at line 127 of file planar_polygon.h.

References pcl::PlanarPolygon< PointT >::coefficients_.

template<typename PointT>
pcl::PointCloud<PointT>::VectorType& pcl::PlanarPolygon< PointT >::getContour ( )
inline
template<typename PointT>
const pcl::PointCloud<PointT>::VectorType& pcl::PlanarPolygon< PointT >::getContour ( ) const
inline

Getter for the contour / boundary.

Definition at line 94 of file planar_polygon.h.

References pcl::PlanarPolygon< PointT >::contour_.

template<typename PointT>
void pcl::PlanarPolygon< PointT >::setCoefficients ( const Eigen::Vector4f &  coefficients)
inline

Setr the internal coefficients.

Parameters
[in]coefficientsthe new coefficients to be set

Definition at line 103 of file planar_polygon.h.

References pcl::PlanarPolygon< PointT >::coefficients_.

template<typename PointT>
void pcl::PlanarPolygon< PointT >::setCoefficients ( const pcl::ModelCoefficients coefficients)
inline

Set the internal coefficients.

Parameters
[in]coefficientsthe new coefficients to be set

Definition at line 112 of file planar_polygon.h.

References pcl::PlanarPolygon< PointT >::coefficients_, and pcl::ModelCoefficients::values.

template<typename PointT>
void pcl::PlanarPolygon< PointT >::setContour ( const pcl::PointCloud< PointT > &  contour)
inline

Set the internal contour.

Parameters
[in]contourthe new planar polygonal contour

Definition at line 80 of file planar_polygon.h.

References pcl::PlanarPolygon< PointT >::contour_, and pcl::PointCloud< T >::points.

Member Data Documentation

template<typename PointT>
Eigen::Vector4f pcl::PlanarPolygon< PointT >::coefficients_
protected
template<typename PointT>
pcl::PointCloud<PointT>::VectorType pcl::PlanarPolygon< PointT >::contour_
protected

A list of points on the boundary/contour of the planar region.

Definition at line 134 of file planar_polygon.h.

Referenced by pcl::PlanarPolygon< PointT >::getContour(), pcl::PlanarRegion< PointT >::PlanarRegion(), and pcl::PlanarPolygon< PointT >::setContour().


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