pcl::Clipper3D< PointT > Class Template Reference

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

#include <pcl/filters/clipper3D.h>

Inheritance diagram for pcl::Clipper3D< PointT >:

List of all members.

Public Member Functions
virtual	~Clipper3D () throw ()
	virtual destructor.
virtual bool	clipPoint3D (const PointT &point) const =0
	interface to clip a single point
virtual bool	clipLineSegment3D (PointT &from, PointT &to) const =0
	interface to clip a line segment given by two end points.
virtual void	clipPlanarPolygon3D (std::vector< PointT > &polygon) const =0
	interface to clip a planar polygon given by an ordered list of points
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

---

Detailed Description

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

Base class for 3D clipper objects.

Author:

Suat Gedikli <gedikli@willowgarage.com>

Definition at line 49 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 53 of file clipper3D.h.

---

Member Function Documentation

template<typename PointT >

virtual bool pcl::Clipper3D< PointT >::clipLineSegment3D	(	PointT &	from,
		PointT &	to
	)		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]	from	start point of the line
[in,out]	to	end 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]

polygon

the polygon in any direction (ccw or cw) but ordered, thus two neighboring points define an edge of the 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]

point

the 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_in	input point cloud
[out]	clipped	the resultant list of indices of remaining points after clipping.
[in]	indices	the indices of points in the point cloud to be clipped.

Implemented in pcl::PlaneClipper3D< PointT >.

---

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

• /builddir/build/BUILD/PCL-1.4.0-Source/filters/include/pcl/filters/clipper3D.h