Public Member Functions
pcl::Clipper3D< PointT > Class Template Reference

Base class for 3D clipper objects. More...

#include <clipper3D.h>

Inheritance diagram for pcl::Clipper3D< PointT >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool clipLineSegment3D (PointT &pt1, PointT &pt2) const =0
 interface to clip a line segment given by two end points. The order of the end points is unimportant and will sty the same after clipping. This means basically, that the direction of the line will not flip after clipping.
virtual void clipPlanarPolygon3D (std::vector< PointT > &polygon) const =0
 interface to clip a planar polygon given by an ordered list of points
virtual void clipPlanarPolygon3D (const std::vector< PointT > &polygon, std::vector< PointT > &clipped_polygon) const =0
 interface to clip a planar polygon given by an ordered list of points
virtual bool clipPoint3D (const PointT &point) const =0
 interface to clip a single point
virtual void clipPointCloud3D (const pcl::PointCloud< PointT > &cloud_in, std::vector< int > &clipped, const std::vector< int > &indices=std::vector< int >()) const =0
 interface to clip a point cloud
virtual Clipper3D< PointT > * clone () const =0
 polymorphic method to clone the underlying clipper with its parameters.
virtual ~Clipper3D () throw ()
 virtual destructor. Never throws an exception.

Detailed Description

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

Base class for 3D clipper objects.

Author:
Suat Gedikli <gedikli@willowgarage.com>

Definition at line 50 of file clipper3D.h.


Constructor & Destructor Documentation

template<typename PointT>
virtual pcl::Clipper3D< PointT >::~Clipper3D ( ) throw () [inline, virtual]

virtual destructor. Never throws an exception.

Definition at line 56 of file clipper3D.h.


Member Function Documentation

template<typename PointT>
virtual bool pcl::Clipper3D< PointT >::clipLineSegment3D ( PointT pt1,
PointT pt2 
) const [pure virtual]

interface to clip a line segment given by two end points. The order of the end points is unimportant and will sty the same after clipping. This means basically, that the direction of the line will not flip after clipping.

Parameters:
[in,out]pt1start point of the line
[in,out]pt2end point of the line
Returns:
true if the clipped line is not empty, thus the parameters are still valid, false if line completely outside clipping space

Implemented in pcl::PlaneClipper3D< PointT >.

template<typename PointT>
virtual void pcl::Clipper3D< PointT >::clipPlanarPolygon3D ( std::vector< PointT > &  polygon) const [pure virtual]

interface to clip a planar polygon given by an ordered list of points

Parameters:
[in,out]polygonthe polygon in any direction (ccw or cw) but ordered, thus two neighboring points define an edge of the polygon
template<typename PointT>
virtual void pcl::Clipper3D< PointT >::clipPlanarPolygon3D ( const std::vector< PointT > &  polygon,
std::vector< PointT > &  clipped_polygon 
) const [pure virtual]

interface to clip a planar polygon given by an ordered list of points

Parameters:
[in]polygonthe polygon in any direction (ccw or cw) but ordered, thus two neighboring points define an edge of the polygon
[out]clipped_polygonthe clipped polygon

Implemented in pcl::PlaneClipper3D< PointT >.

template<typename PointT>
virtual bool pcl::Clipper3D< PointT >::clipPoint3D ( const PointT point) const [pure virtual]

interface to clip a single point

Parameters:
[in]pointthe point to check against
Returns:
true, it point still exists, false if its clipped

Implemented in pcl::PlaneClipper3D< PointT >.

template<typename PointT>
virtual void pcl::Clipper3D< PointT >::clipPointCloud3D ( const pcl::PointCloud< PointT > &  cloud_in,
std::vector< int > &  clipped,
const std::vector< int > &  indices = std::vector< int >() 
) const [pure virtual]

interface to clip a point cloud

Parameters:
[in]cloud_ininput point cloud
[out]clippedindices of points that remain after clipping the input cloud
[in]indicesthe indices of points in the point cloud to be clipped.
Returns:
list of indices of remaining points after clipping.

Implemented in pcl::PlaneClipper3D< PointT >.

template<typename PointT>
virtual Clipper3D<PointT>* pcl::Clipper3D< PointT >::clone ( ) const [pure virtual]

polymorphic method to clone the underlying clipper with its parameters.

Returns:
the new clipper object from the specific subclass with all its parameters.

Implemented in pcl::PlaneClipper3D< PointT >.


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


pcl
Author(s): Open Perception
autogenerated on Mon Oct 6 2014 03:19:17