polygon_mesh.h
/*
* Software License Agreement (BSD License)
*
* Point Cloud Library (PCL) - www.pointclouds.org
* Copyright (c) 2009-2012, Willow Garage, Inc.
* Copyright (c) 2012-, Open Perception, Inc.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name of the copyright holder(s) nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* $Id$
*
*/
#pragma once
#include <pcl/pcl_macros.h>
#include <pcl/geometry/mesh_base.h>
namespace pcl
{
namespace geometry
{
/** \brief Tag describing the type of the mesh. */
struct PolygonMeshTag {};
/** \brief General half-edge mesh that can store any polygon with a minimum number of vertices of 3.
* \tparam MeshTraitsT Please have a look at pcl::geometry::DefaultMeshTraits.
* \author Martin Saelzle
* \ingroup geometry
*/
template <class MeshTraitsT>
class PolygonMesh : public pcl::geometry::MeshBase <PolygonMesh <MeshTraitsT>, MeshTraitsT, PolygonMeshTag>
{
public:
using Base = pcl::geometry::MeshBase <PolygonMesh <MeshTraitsT>, MeshTraitsT, PolygonMeshTag>;
using Self = PolygonMesh<MeshTraitsT>;
using Ptr = shared_ptr<Self>;
using ConstPtr = shared_ptr<const Self>;
using VertexData = typename Base::VertexData;
using HalfEdgeData = typename Base::HalfEdgeData;
using EdgeData = typename Base::EdgeData;
using FaceData = typename Base::FaceData;
using IsManifold = typename Base::IsManifold;
using MeshTag = typename Base::MeshTag;
using HasVertexData = typename Base::HasVertexData;
using HasHalfEdgeData = typename Base::HasHalfEdgeData;
using HasEdgeData = typename Base::HasEdgeData;
using HasFaceData = typename Base::HasFaceData;
using VertexDataCloud = typename Base::VertexDataCloud;
using HalfEdgeDataCloud = typename Base::HalfEdgeDataCloud;
using EdgeDataCloud = typename Base::EdgeDataCloud;
using FaceDataCloud = typename Base::FaceDataCloud;
// Indices
using VertexIndex = typename Base::VertexIndex;
using HalfEdgeIndex = typename Base::HalfEdgeIndex;
using EdgeIndex = typename Base::EdgeIndex;
using FaceIndex = typename Base::FaceIndex;
using VertexIndices = typename Base::VertexIndices;
using HalfEdgeIndices = typename Base::HalfEdgeIndices;
using EdgeIndices = typename Base::EdgeIndices;
using FaceIndices = typename Base::FaceIndices;
// Circulators
using VertexAroundVertexCirculator = typename Base::VertexAroundVertexCirculator;
using OutgoingHalfEdgeAroundVertexCirculator = typename Base::OutgoingHalfEdgeAroundVertexCirculator;
using IncomingHalfEdgeAroundVertexCirculator = typename Base::IncomingHalfEdgeAroundVertexCirculator;
using FaceAroundVertexCirculator = typename Base::FaceAroundVertexCirculator;
using VertexAroundFaceCirculator = typename Base::VertexAroundFaceCirculator;
using InnerHalfEdgeAroundFaceCirculator = typename Base::InnerHalfEdgeAroundFaceCirculator;
using OuterHalfEdgeAroundFaceCirculator = typename Base::OuterHalfEdgeAroundFaceCirculator;
using FaceAroundFaceCirculator = typename Base::FaceAroundFaceCirculator;
/** \brief Constructor. */
PolygonMesh ()
: Base (),
add_triangle_ (3),
add_quad_ (4)
{
}
/** \brief The base method of addFace is hidden because of the overloads in this class. */
using Base::addFace;
/** \brief Add a triangle to the mesh. Data is only added if it is associated with the elements. The last vertex is connected with the first one.
* \param[in] idx_v_0 Index to the first vertex.
* \param[in] idx_v_1 Index to the second vertex.
* \param[in] idx_v_2 Index to the third vertex.
* \param[in] face_data Data that is set for the face.
* \param[in] half_edge_data Data that is set for all added half-edges.
* \param[in] edge_data Data that is set for all added edges.
* \return Index to the new face. Failure is signaled by returning an invalid face index.
* \warning The vertices must be valid and unique (each vertex may be contained only once). Not complying with this requirement results in undefined behavior!
*/
inline FaceIndex
addFace (const VertexIndex& idx_v_0,
const VertexIndex& idx_v_1,
const VertexIndex& idx_v_2,
const FaceData& face_data = FaceData (),
const EdgeData& edge_data = EdgeData (),
const HalfEdgeData& half_edge_data = HalfEdgeData ())
{
add_triangle_ [0] = idx_v_0;
add_triangle_ [1] = idx_v_1;
add_triangle_ [2] = idx_v_2;
return (this->addFaceImplBase (add_triangle_, face_data, edge_data, half_edge_data));
}
/** \brief Add a quad to the mesh. Data is only added if it is associated with the elements. The last vertex is connected with the first one.
* \param[in] idx_v_0 Index to the first vertex.
* \param[in] idx_v_1 Index to the second vertex.
* \param[in] idx_v_2 Index to the third vertex.
* \param[in] idx_v_3 Index to the fourth vertex.
* \param[in] face_data Data that is set for the face.
* \param[in] half_edge_data Data that is set for all added half-edges.
* \param[in] edge_data Data that is set for all added edges.
* \return Index to the new face. Failure is signaled by returning an invalid face index.
* \warning The vertices must be valid and unique (each vertex may be contained only once). Not complying with this requirement results in undefined behavior!
*/
inline FaceIndex
addFace (const VertexIndex& idx_v_0,
const VertexIndex& idx_v_1,
const VertexIndex& idx_v_2,
const VertexIndex& idx_v_3,
const FaceData& face_data = FaceData (),
const EdgeData& edge_data = EdgeData (),
const HalfEdgeData& half_edge_data = HalfEdgeData ())
{
add_quad_ [0] = idx_v_0;
add_quad_ [1] = idx_v_1;
add_quad_ [2] = idx_v_2;
add_quad_ [3] = idx_v_3;
return (this->addFaceImplBase (add_quad_, face_data, edge_data, half_edge_data));
}
private:
// NOTE: Can't use the typedef of Base as a friend.
friend class pcl::geometry::MeshBase <PolygonMesh <MeshTraitsT>, MeshTraitsT, pcl::geometry::PolygonMeshTag>;
/** \brief addFace for the polygon mesh. */
inline FaceIndex
addFaceImpl (const VertexIndices& vertices,
const FaceData& face_data,
const EdgeData& edge_data,
const HalfEdgeData& half_edge_data)
{
return (this->addFaceImplBase (vertices, face_data, edge_data, half_edge_data));
}
////////////////////////////////////////////////////////////////////////
// Members
////////////////////////////////////////////////////////////////////////
/** \brief Storage for adding a triangle. */
VertexIndices add_triangle_;
/** \brief Storage for adding a quad. */
VertexIndices add_quad_;
public:
PCL_MAKE_ALIGNED_OPERATOR_NEW
};
} // End namespace geom
} // End namespace pcl
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::FaceIndex
pcl::geometry::FaceIndex FaceIndex
Definition: mesh_base.h:136
pcl_macros.h
Defines all the PCL and non-PCL macros used.
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::IncomingHalfEdgeAroundVertexCirculator
pcl::geometry::IncomingHalfEdgeAroundVertexCirculator< const Self > IncomingHalfEdgeAroundVertexCirculator
Definition: mesh_base.h:146
pcl
This file defines compatibility wrappers for low level I/O functions.
Definition: convolution.h:45
pcl::geometry::PolygonMesh::FaceDataCloud
typename Base::FaceDataCloud FaceDataCloud
Definition: polygon_mesh.h:84
pcl::geometry::PolygonMesh::HalfEdgeIndices
typename Base::HalfEdgeIndices HalfEdgeIndices
Definition: polygon_mesh.h:93
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::VertexIndex
pcl::geometry::VertexIndex VertexIndex
Definition: mesh_base.h:133
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::FaceAroundFaceCirculator
pcl::geometry::FaceAroundFaceCirculator< const Self > FaceAroundFaceCirculator
Definition: mesh_base.h:151
pcl::geometry::PolygonMesh::MeshTag
typename Base::MeshTag MeshTag
Definition: polygon_mesh.h:74
pcl::geometry::PolygonMesh::IsManifold
typename Base::IsManifold IsManifold
Definition: polygon_mesh.h:73
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::EdgeIndices
std::vector< EdgeIndex > EdgeIndices
Definition: mesh_base.h:140
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::OuterHalfEdgeAroundFaceCirculator
pcl::geometry::OuterHalfEdgeAroundFaceCirculator< const Self > OuterHalfEdgeAroundFaceCirculator
Definition: mesh_base.h:150
pcl::geometry::PolygonMesh::VertexAroundVertexCirculator
typename Base::VertexAroundVertexCirculator VertexAroundVertexCirculator
Definition: polygon_mesh.h:98
pcl::geometry::PolygonMesh::VertexIndex
typename Base::VertexIndex VertexIndex
Definition: polygon_mesh.h:87
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::VertexDataCloud
pcl::PointCloud< VertexData > VertexDataCloud
Definition: mesh_base.h:127
pcl::geometry::PolygonMesh::HasHalfEdgeData
typename Base::HasHalfEdgeData HasHalfEdgeData
Definition: polygon_mesh.h:77
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::VertexData
typename MeshTraitsT::VertexData VertexData
Definition: mesh_base.h:110
pcl::geometry::PolygonMesh::HalfEdgeIndex
typename Base::HalfEdgeIndex HalfEdgeIndex
Definition: polygon_mesh.h:88
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::IsManifold
typename MeshTraitsT::IsManifold IsManifold
Definition: mesh_base.h:114
pcl::geometry::PolygonMesh
General half-edge mesh that can store any polygon with a minimum number of vertices of 3.
Definition: polygon_mesh.h:59
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::VertexAroundFaceCirculator
pcl::geometry::VertexAroundFaceCirculator< const Self > VertexAroundFaceCirculator
Definition: mesh_base.h:148
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::MeshTag
PolygonMeshTag MeshTag
Definition: mesh_base.h:119
pcl::geometry::PolygonMesh::HalfEdgeDataCloud
typename Base::HalfEdgeDataCloud HalfEdgeDataCloud
Definition: polygon_mesh.h:82
pcl::geometry::PolygonMesh::VertexAroundFaceCirculator
typename Base::VertexAroundFaceCirculator VertexAroundFaceCirculator
Definition: polygon_mesh.h:102
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::FaceData
typename MeshTraitsT::FaceData FaceData
Definition: mesh_base.h:113
pcl::geometry::PolygonMesh::EdgeDataCloud
typename Base::EdgeDataCloud EdgeDataCloud
Definition: polygon_mesh.h:83
pcl::geometry::PolygonMesh::ConstPtr
shared_ptr< const Self > ConstPtr
Definition: polygon_mesh.h:67
pcl::geometry::PolygonMesh::IncomingHalfEdgeAroundVertexCirculator
typename Base::IncomingHalfEdgeAroundVertexCirculator IncomingHalfEdgeAroundVertexCirculator
Definition: polygon_mesh.h:100
pcl::geometry::PolygonMesh::HalfEdgeData
typename Base::HalfEdgeData HalfEdgeData
Definition: polygon_mesh.h:70
pcl::geometry::PolygonMesh::Ptr
shared_ptr< Self > Ptr
Definition: polygon_mesh.h:66
pcl::geometry::PolygonMesh::EdgeData
typename Base::EdgeData EdgeData
Definition: polygon_mesh.h:71
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::HalfEdgeData
typename MeshTraitsT::HalfEdgeData HalfEdgeData
Definition: mesh_base.h:111
pcl::geometry::PolygonMesh::VertexData
typename Base::VertexData VertexData
Definition: polygon_mesh.h:69
pcl::geometry::PolygonMesh::EdgeIndex
typename Base::EdgeIndex EdgeIndex
Definition: polygon_mesh.h:89
pcl::geometry::PolygonMesh::OutgoingHalfEdgeAroundVertexCirculator
typename Base::OutgoingHalfEdgeAroundVertexCirculator OutgoingHalfEdgeAroundVertexCirculator
Definition: polygon_mesh.h:99
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::HalfEdgeIndices
std::vector< HalfEdgeIndex > HalfEdgeIndices
Definition: mesh_base.h:139
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::addFaceImplBase
FaceIndex addFaceImplBase(const VertexIndices &vertices, const FaceData &face_data, const EdgeData &edge_data, const HalfEdgeData &half_edge_data)
General implementation of addFace.
Definition: mesh_base.h:1108
pcl::geometry::PolygonMesh::OuterHalfEdgeAroundFaceCirculator
typename Base::OuterHalfEdgeAroundFaceCirculator OuterHalfEdgeAroundFaceCirculator
Definition: polygon_mesh.h:104
pcl::geometry::PolygonMesh::FaceIndices
typename Base::FaceIndices FaceIndices
Definition: polygon_mesh.h:95
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::EdgeIndex
pcl::geometry::EdgeIndex EdgeIndex
Definition: mesh_base.h:135
pcl::geometry::PolygonMesh::PolygonMesh
PolygonMesh()
Constructor.
Definition: polygon_mesh.h:108
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::VertexAroundVertexCirculator
pcl::geometry::VertexAroundVertexCirculator< const Self > VertexAroundVertexCirculator
Definition: mesh_base.h:144
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::FaceDataCloud
pcl::PointCloud< FaceData > FaceDataCloud
Definition: mesh_base.h:130
PCL_MAKE_ALIGNED_OPERATOR_NEW
#define PCL_MAKE_ALIGNED_OPERATOR_NEW
Macro to signal a class requires a custom allocator.
Definition: pcl_macros.h:371
pcl::geometry::PolygonMesh::HasEdgeData
typename Base::HasEdgeData HasEdgeData
Definition: polygon_mesh.h:78
pcl::geometry::PolygonMesh::FaceAroundVertexCirculator
typename Base::FaceAroundVertexCirculator FaceAroundVertexCirculator
Definition: polygon_mesh.h:101
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::HasFaceData
std::integral_constant< bool, !std::is_same< FaceData, pcl::geometry::NoData >::value > HasFaceData
Definition: mesh_base.h:125
pcl::geometry::PolygonMesh::VertexIndices
typename Base::VertexIndices VertexIndices
Definition: polygon_mesh.h:92
pcl::geometry::PolygonMesh::VertexDataCloud
typename Base::VertexDataCloud VertexDataCloud
Definition: polygon_mesh.h:81
pcl::geometry::PolygonMesh::HasVertexData
typename Base::HasVertexData HasVertexData
Definition: polygon_mesh.h:76
pcl::geometry::PolygonMesh::EdgeIndices
typename Base::EdgeIndices EdgeIndices
Definition: polygon_mesh.h:94
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::FaceAroundVertexCirculator
pcl::geometry::FaceAroundVertexCirculator< const Self > FaceAroundVertexCirculator
Definition: mesh_base.h:147
pcl::geometry::PolygonMeshTag
Tag describing the type of the mesh.
Definition: polygon_mesh.h:51
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::HalfEdgeDataCloud
pcl::PointCloud< HalfEdgeData > HalfEdgeDataCloud
Definition: mesh_base.h:128
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::EdgeData
typename MeshTraitsT::EdgeData EdgeData
Definition: mesh_base.h:112
pcl::geometry::PolygonMesh::FaceIndex
typename Base::FaceIndex FaceIndex
Definition: polygon_mesh.h:90
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::HasVertexData
std::integral_constant< bool, !std::is_same< VertexData, pcl::geometry::NoData >::value > HasVertexData
Definition: mesh_base.h:122
pcl::geometry::FaceIndex
Index used to access elements in the half-edge mesh.
Definition: mesh_indices.h:478
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::EdgeDataCloud
pcl::PointCloud< EdgeData > EdgeDataCloud
Definition: mesh_base.h:129
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::OutgoingHalfEdgeAroundVertexCirculator
pcl::geometry::OutgoingHalfEdgeAroundVertexCirculator< const Self > OutgoingHalfEdgeAroundVertexCirculator
Definition: mesh_base.h:145
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::HasHalfEdgeData
std::integral_constant< bool, !std::is_same< HalfEdgeData, pcl::geometry::NoData >::value > HasHalfEdgeData
Definition: mesh_base.h:123
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::FaceIndices
std::vector< FaceIndex > FaceIndices
Definition: mesh_base.h:141
pcl::geometry::PolygonMesh::addFace
FaceIndex addFace(const VertexIndex &idx_v_0, const VertexIndex &idx_v_1, const VertexIndex &idx_v_2, const VertexIndex &idx_v_3, const FaceData &face_data=FaceData(), const EdgeData &edge_data=EdgeData(), const HalfEdgeData &half_edge_data=HalfEdgeData())
Add a quad to the mesh.
Definition: polygon_mesh.h:155
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::HasEdgeData
std::integral_constant< bool, !std::is_same< EdgeData, pcl::geometry::NoData >::value > HasEdgeData
Definition: mesh_base.h:124
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::addFace
FaceIndex addFace(const VertexIndices &vertices, const FaceData &face_data=FaceData(), const EdgeData &edge_data=EdgeData(), const HalfEdgeData &half_edge_data=HalfEdgeData())
Add a face to the mesh.
Definition: mesh_base.h:187
pcl::geometry::PolygonMesh::InnerHalfEdgeAroundFaceCirculator
typename Base::InnerHalfEdgeAroundFaceCirculator InnerHalfEdgeAroundFaceCirculator
Definition: polygon_mesh.h:103
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::HalfEdgeIndex
pcl::geometry::HalfEdgeIndex HalfEdgeIndex
Definition: mesh_base.h:134
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::InnerHalfEdgeAroundFaceCirculator
pcl::geometry::InnerHalfEdgeAroundFaceCirculator< const Self > InnerHalfEdgeAroundFaceCirculator
Definition: mesh_base.h:149
pcl::geometry::PolygonMesh::FaceData
typename Base::FaceData FaceData
Definition: polygon_mesh.h:72
pcl::geometry::PolygonMesh::FaceAroundFaceCirculator
typename Base::FaceAroundFaceCirculator FaceAroundFaceCirculator
Definition: polygon_mesh.h:105
pcl::shared_ptr
boost::shared_ptr< T > shared_ptr
Alias for boost::shared_ptr.
Definition: pcl_macros.h:90
pcl::geometry::PolygonMesh::addFace
FaceIndex addFace(const VertexIndex &idx_v_0, const VertexIndex &idx_v_1, const VertexIndex &idx_v_2, const FaceData &face_data=FaceData(), const EdgeData &edge_data=EdgeData(), const HalfEdgeData &half_edge_data=HalfEdgeData())
Add a triangle to the mesh.
Definition: polygon_mesh.h:129
pcl::geometry::MeshBase< PolygonMesh< MeshTraitsT >, MeshTraitsT, PolygonMeshTag >::VertexIndices
std::vector< VertexIndex > VertexIndices
Definition: mesh_base.h:138
pcl::geometry::PolygonMesh::HasFaceData
typename Base::HasFaceData HasFaceData
Definition: polygon_mesh.h:79
pcl::geometry::MeshBase
Base class for the half-edge mesh.
Definition: mesh_base.h:99