mesh_circulators.h

Go to the documentation of this file.

/*
 * 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$
 *
 */

// NOTE: This file has been created with 'pcl_src/geometry/include/pcl/geometry/mesh_circulators.py'

#ifndef PCL_GEOMETRY_MESH_CIRCULATORS_H
#define PCL_GEOMETRY_MESH_CIRCULATORS_H

#include <pcl/geometry/boost.h>
#include <pcl/geometry/mesh_indices.h>

// VertexAroundVertexCirculator

namespace pcl
{
  namespace geometry
  {
    template <class MeshT>
    class VertexAroundVertexCirculator
        : boost::equality_comparable <pcl::geometry::VertexAroundVertexCirculator <MeshT>
        , boost::unit_steppable      <pcl::geometry::VertexAroundVertexCirculator <MeshT>
        > >
    {
      public:

        typedef boost::equality_comparable <pcl::geometry::VertexAroundVertexCirculator <MeshT>
              , boost::unit_steppable      <pcl::geometry::VertexAroundVertexCirculator <MeshT> > > Base;
        typedef pcl::geometry::VertexAroundVertexCirculator <MeshT> Self;

        typedef MeshT Mesh;
        typedef typename Mesh::VertexIndex VertexIndex;
        typedef typename Mesh::HalfEdgeIndex HalfEdgeIndex;

        VertexAroundVertexCirculator ()
          : mesh_                   (NULL),
            idx_outgoing_half_edge_ ()
        {
        }

        VertexAroundVertexCirculator (const VertexIndex& idx_vertex,
                                      Mesh*const         mesh)
          : mesh_                   (mesh),
            idx_outgoing_half_edge_ (mesh->getOutgoingHalfEdgeIndex (idx_vertex))
        {
        }

        VertexAroundVertexCirculator (const HalfEdgeIndex& idx_outgoing_half_edge,
                                      Mesh*const           mesh)
          : mesh_                   (mesh),
            idx_outgoing_half_edge_ (idx_outgoing_half_edge)
        {
        }

        inline bool
        isValid () const
        {
          return (idx_outgoing_half_edge_.isValid ());
        }

        inline bool
        operator == (const Self& other) const
        {
          return (idx_outgoing_half_edge_ == other.idx_outgoing_half_edge_);
        }

        inline Self&
        operator ++ ()
        {
          idx_outgoing_half_edge_ = mesh_->getNextHalfEdgeIndex (mesh_->getOppositeHalfEdgeIndex (idx_outgoing_half_edge_));
          return (*this);
        }

        inline Self&
        operator -- ()
        {
          idx_outgoing_half_edge_ = mesh_->getOppositeHalfEdgeIndex (mesh_->getPrevHalfEdgeIndex (idx_outgoing_half_edge_));
          return (*this);
        }

        inline VertexIndex
        getTargetIndex () const
        {
          return (mesh_->getTerminatingVertexIndex (idx_outgoing_half_edge_));
        }

        inline HalfEdgeIndex
        getCurrentHalfEdgeIndex () const
        {
          return (idx_outgoing_half_edge_);
        }

        Mesh* mesh_;

        HalfEdgeIndex idx_outgoing_half_edge_;
    };
  } // End namespace geometry
} // End namespace pcl

// OutgoingHalfEdgeAroundVertexCirculator

namespace pcl
{
  namespace geometry
  {
    template <class MeshT>
    class OutgoingHalfEdgeAroundVertexCirculator
        : boost::equality_comparable <pcl::geometry::OutgoingHalfEdgeAroundVertexCirculator <MeshT>
        , boost::unit_steppable      <pcl::geometry::OutgoingHalfEdgeAroundVertexCirculator <MeshT>
        > >
    {
      public:

        typedef boost::equality_comparable <pcl::geometry::OutgoingHalfEdgeAroundVertexCirculator <MeshT>
              , boost::unit_steppable      <pcl::geometry::OutgoingHalfEdgeAroundVertexCirculator <MeshT> > > Base;
        typedef pcl::geometry::OutgoingHalfEdgeAroundVertexCirculator <MeshT> Self;

        typedef MeshT Mesh;
        typedef typename Mesh::VertexIndex VertexIndex;
        typedef typename Mesh::HalfEdgeIndex HalfEdgeIndex;

        OutgoingHalfEdgeAroundVertexCirculator ()
          : mesh_                   (NULL),
            idx_outgoing_half_edge_ ()
        {
        }

        OutgoingHalfEdgeAroundVertexCirculator (const VertexIndex& idx_vertex,
                                                Mesh*const         mesh)
          : mesh_                   (mesh),
            idx_outgoing_half_edge_ (mesh->getOutgoingHalfEdgeIndex (idx_vertex))
        {
        }

        OutgoingHalfEdgeAroundVertexCirculator (const HalfEdgeIndex& idx_outgoing_half_edge,
                                                Mesh*const           mesh)
          : mesh_                   (mesh),
            idx_outgoing_half_edge_ (idx_outgoing_half_edge)
        {
        }

        inline bool
        isValid () const
        {
          return (idx_outgoing_half_edge_.isValid ());
        }

        inline bool
        operator == (const Self& other) const
        {
          return (idx_outgoing_half_edge_ == other.idx_outgoing_half_edge_);
        }

        inline Self&
        operator ++ ()
        {
          idx_outgoing_half_edge_ = mesh_->getNextHalfEdgeIndex (mesh_->getOppositeHalfEdgeIndex (idx_outgoing_half_edge_));
          return (*this);
        }

        inline Self&
        operator -- ()
        {
          idx_outgoing_half_edge_ = mesh_->getOppositeHalfEdgeIndex (mesh_->getPrevHalfEdgeIndex (idx_outgoing_half_edge_));
          return (*this);
        }

        inline HalfEdgeIndex
        getTargetIndex () const
        {
          return (idx_outgoing_half_edge_);
        }

        inline HalfEdgeIndex
        getCurrentHalfEdgeIndex () const
        {
          return (idx_outgoing_half_edge_);
        }

        Mesh* mesh_;

        HalfEdgeIndex idx_outgoing_half_edge_;
    };
  } // End namespace geometry
} // End namespace pcl

// IncomingHalfEdgeAroundVertexCirculator

namespace pcl
{
  namespace geometry
  {
    template <class MeshT>
    class IncomingHalfEdgeAroundVertexCirculator
        : boost::equality_comparable <pcl::geometry::IncomingHalfEdgeAroundVertexCirculator <MeshT>
        , boost::unit_steppable      <pcl::geometry::IncomingHalfEdgeAroundVertexCirculator <MeshT>
        > >
    {
      public:

        typedef boost::equality_comparable <pcl::geometry::IncomingHalfEdgeAroundVertexCirculator <MeshT>
              , boost::unit_steppable      <pcl::geometry::IncomingHalfEdgeAroundVertexCirculator <MeshT> > > Base;
        typedef pcl::geometry::IncomingHalfEdgeAroundVertexCirculator <MeshT> Self;

        typedef MeshT Mesh;
        typedef typename Mesh::VertexIndex VertexIndex;
        typedef typename Mesh::HalfEdgeIndex HalfEdgeIndex;

        IncomingHalfEdgeAroundVertexCirculator ()
          : mesh_                   (NULL),
            idx_incoming_half_edge_ ()
        {
        }

        IncomingHalfEdgeAroundVertexCirculator (const VertexIndex& idx_vertex,
                                                Mesh*const         mesh)
          : mesh_                   (mesh),
            idx_incoming_half_edge_ (mesh->getIncomingHalfEdgeIndex (idx_vertex))
        {
        }

        IncomingHalfEdgeAroundVertexCirculator (const HalfEdgeIndex& idx_incoming_half_edge,
                                                Mesh*const           mesh)
          : mesh_                   (mesh),
            idx_incoming_half_edge_ (idx_incoming_half_edge)
        {
        }

        inline bool
        isValid () const
        {
          return (idx_incoming_half_edge_.isValid ());
        }

        inline bool
        operator == (const Self& other) const
        {
          return (idx_incoming_half_edge_ == other.idx_incoming_half_edge_);
        }

        inline Self&
        operator ++ ()
        {
          idx_incoming_half_edge_ = mesh_->getOppositeHalfEdgeIndex (mesh_->getNextHalfEdgeIndex (idx_incoming_half_edge_));
          return (*this);
        }

        inline Self&
        operator -- ()
        {
          idx_incoming_half_edge_ = mesh_->getPrevHalfEdgeIndex (mesh_->getOppositeHalfEdgeIndex (idx_incoming_half_edge_));
          return (*this);
        }

        inline HalfEdgeIndex
        getTargetIndex () const
        {
          return (idx_incoming_half_edge_);
        }

        inline HalfEdgeIndex
        getCurrentHalfEdgeIndex () const
        {
          return (idx_incoming_half_edge_);
        }

        Mesh* mesh_;

        HalfEdgeIndex idx_incoming_half_edge_;
    };
  } // End namespace geometry
} // End namespace pcl

// FaceAroundVertexCirculator

namespace pcl
{
  namespace geometry
  {
    template <class MeshT>
    class FaceAroundVertexCirculator
        : boost::equality_comparable <pcl::geometry::FaceAroundVertexCirculator <MeshT>
        , boost::unit_steppable      <pcl::geometry::FaceAroundVertexCirculator <MeshT>
        > >
    {
      public:

        typedef boost::equality_comparable <pcl::geometry::FaceAroundVertexCirculator <MeshT>
              , boost::unit_steppable      <pcl::geometry::FaceAroundVertexCirculator <MeshT> > > Base;
        typedef pcl::geometry::FaceAroundVertexCirculator <MeshT> Self;

        typedef MeshT Mesh;
        typedef typename Mesh::FaceIndex FaceIndex;
        typedef typename Mesh::VertexIndex VertexIndex;
        typedef typename Mesh::HalfEdgeIndex HalfEdgeIndex;

        FaceAroundVertexCirculator ()
          : mesh_                   (NULL),
            idx_outgoing_half_edge_ ()
        {
        }

        FaceAroundVertexCirculator (const VertexIndex& idx_vertex,
                                    Mesh*const         mesh)
          : mesh_                   (mesh),
            idx_outgoing_half_edge_ (mesh->getOutgoingHalfEdgeIndex (idx_vertex))
        {
        }

        FaceAroundVertexCirculator (const HalfEdgeIndex& idx_outgoing_half_edge,
                                    Mesh*const           mesh)
          : mesh_                   (mesh),
            idx_outgoing_half_edge_ (idx_outgoing_half_edge)
        {
        }

        inline bool
        isValid () const
        {
          return (idx_outgoing_half_edge_.isValid ());
        }

        inline bool
        operator == (const Self& other) const
        {
          return (idx_outgoing_half_edge_ == other.idx_outgoing_half_edge_);
        }

        inline Self&
        operator ++ ()
        {
          idx_outgoing_half_edge_ = mesh_->getNextHalfEdgeIndex (mesh_->getOppositeHalfEdgeIndex (idx_outgoing_half_edge_));
          return (*this);
        }

        inline Self&
        operator -- ()
        {
          idx_outgoing_half_edge_ = mesh_->getOppositeHalfEdgeIndex (mesh_->getPrevHalfEdgeIndex (idx_outgoing_half_edge_));
          return (*this);
        }

        inline FaceIndex
        getTargetIndex () const
        {
          return (mesh_->getFaceIndex (idx_outgoing_half_edge_));
        }

        inline HalfEdgeIndex
        getCurrentHalfEdgeIndex () const
        {
          return (idx_outgoing_half_edge_);
        }

        Mesh* mesh_;

        HalfEdgeIndex idx_outgoing_half_edge_;
    };
  } // End namespace geometry
} // End namespace pcl

// VertexAroundFaceCirculator

namespace pcl
{
  namespace geometry
  {
    template <class MeshT>
    class VertexAroundFaceCirculator
        : boost::equality_comparable <pcl::geometry::VertexAroundFaceCirculator <MeshT>
        , boost::unit_steppable      <pcl::geometry::VertexAroundFaceCirculator <MeshT>
        > >
    {
      public:

        typedef boost::equality_comparable <pcl::geometry::VertexAroundFaceCirculator <MeshT>
              , boost::unit_steppable      <pcl::geometry::VertexAroundFaceCirculator <MeshT> > > Base;
        typedef pcl::geometry::VertexAroundFaceCirculator <MeshT> Self;

        typedef MeshT Mesh;
        typedef typename Mesh::VertexIndex VertexIndex;
        typedef typename Mesh::FaceIndex FaceIndex;
        typedef typename Mesh::HalfEdgeIndex HalfEdgeIndex;

        VertexAroundFaceCirculator ()
          : mesh_                (NULL),
            idx_inner_half_edge_ ()
        {
        }

        VertexAroundFaceCirculator (const FaceIndex& idx_face,
                                    Mesh*const       mesh)
          : mesh_                (mesh),
            idx_inner_half_edge_ (mesh->getInnerHalfEdgeIndex (idx_face))
        {
        }

        VertexAroundFaceCirculator (const HalfEdgeIndex& idx_inner_half_edge,
                                    Mesh*const           mesh)
          : mesh_                (mesh),
            idx_inner_half_edge_ (idx_inner_half_edge)
        {
        }

        inline bool
        isValid () const
        {
          return (idx_inner_half_edge_.isValid ());
        }

        inline bool
        operator == (const Self& other) const
        {
          return (idx_inner_half_edge_ == other.idx_inner_half_edge_);
        }

        inline Self&
        operator ++ ()
        {
          idx_inner_half_edge_ = mesh_->getNextHalfEdgeIndex (idx_inner_half_edge_);
          return (*this);
        }

        inline Self&
        operator -- ()
        {
          idx_inner_half_edge_ = mesh_->getPrevHalfEdgeIndex (idx_inner_half_edge_);
          return (*this);
        }

        inline VertexIndex
        getTargetIndex () const
        {
          return (mesh_->getTerminatingVertexIndex (idx_inner_half_edge_));
        }

        inline HalfEdgeIndex
        getCurrentHalfEdgeIndex () const
        {
          return (idx_inner_half_edge_);
        }

        Mesh* mesh_;

        HalfEdgeIndex idx_inner_half_edge_;
    };
  } // End namespace geometry
} // End namespace pcl

// InnerHalfEdgeAroundFaceCirculator

namespace pcl
{
  namespace geometry
  {
    template <class MeshT>
    class InnerHalfEdgeAroundFaceCirculator
        : boost::equality_comparable <pcl::geometry::InnerHalfEdgeAroundFaceCirculator <MeshT>
        , boost::unit_steppable      <pcl::geometry::InnerHalfEdgeAroundFaceCirculator <MeshT>
        > >
    {
      public:

        typedef boost::equality_comparable <pcl::geometry::InnerHalfEdgeAroundFaceCirculator <MeshT>
              , boost::unit_steppable      <pcl::geometry::InnerHalfEdgeAroundFaceCirculator <MeshT> > > Base;
        typedef pcl::geometry::InnerHalfEdgeAroundFaceCirculator <MeshT> Self;

        typedef MeshT Mesh;
        typedef typename Mesh::FaceIndex FaceIndex;
        typedef typename Mesh::HalfEdgeIndex HalfEdgeIndex;

        InnerHalfEdgeAroundFaceCirculator ()
          : mesh_                (NULL),
            idx_inner_half_edge_ ()
        {
        }

        InnerHalfEdgeAroundFaceCirculator (const FaceIndex& idx_face,
                                           Mesh*const       mesh)
          : mesh_                (mesh),
            idx_inner_half_edge_ (mesh->getInnerHalfEdgeIndex (idx_face))
        {
        }

        InnerHalfEdgeAroundFaceCirculator (const HalfEdgeIndex& idx_inner_half_edge,
                                           Mesh*const           mesh)
          : mesh_                (mesh),
            idx_inner_half_edge_ (idx_inner_half_edge)
        {
        }

        inline bool
        isValid () const
        {
          return (idx_inner_half_edge_.isValid ());
        }

        inline bool
        operator == (const Self& other) const
        {
          return (idx_inner_half_edge_ == other.idx_inner_half_edge_);
        }

        inline Self&
        operator ++ ()
        {
          idx_inner_half_edge_ = mesh_->getNextHalfEdgeIndex (idx_inner_half_edge_);
          return (*this);
        }

        inline Self&
        operator -- ()
        {
          idx_inner_half_edge_ = mesh_->getPrevHalfEdgeIndex (idx_inner_half_edge_);
          return (*this);
        }

        inline HalfEdgeIndex
        getTargetIndex () const
        {
          return (idx_inner_half_edge_);
        }

        inline HalfEdgeIndex
        getCurrentHalfEdgeIndex () const
        {
          return (idx_inner_half_edge_);
        }

        Mesh* mesh_;

        HalfEdgeIndex idx_inner_half_edge_;
    };
  } // End namespace geometry
} // End namespace pcl

// OuterHalfEdgeAroundFaceCirculator

namespace pcl
{
  namespace geometry
  {
    template <class MeshT>
    class OuterHalfEdgeAroundFaceCirculator
        : boost::equality_comparable <pcl::geometry::OuterHalfEdgeAroundFaceCirculator <MeshT>
        , boost::unit_steppable      <pcl::geometry::OuterHalfEdgeAroundFaceCirculator <MeshT>
        > >
    {
      public:

        typedef boost::equality_comparable <pcl::geometry::OuterHalfEdgeAroundFaceCirculator <MeshT>
              , boost::unit_steppable      <pcl::geometry::OuterHalfEdgeAroundFaceCirculator <MeshT> > > Base;
        typedef pcl::geometry::OuterHalfEdgeAroundFaceCirculator <MeshT> Self;

        typedef MeshT Mesh;
        typedef typename Mesh::FaceIndex FaceIndex;
        typedef typename Mesh::HalfEdgeIndex HalfEdgeIndex;

        OuterHalfEdgeAroundFaceCirculator ()
          : mesh_                (NULL),
            idx_inner_half_edge_ ()
        {
        }

        OuterHalfEdgeAroundFaceCirculator (const FaceIndex& idx_face,
                                           Mesh*const       mesh)
          : mesh_                (mesh),
            idx_inner_half_edge_ (mesh->getInnerHalfEdgeIndex (idx_face))
        {
        }

        OuterHalfEdgeAroundFaceCirculator (const HalfEdgeIndex& idx_inner_half_edge,
                                           Mesh*const           mesh)
          : mesh_                (mesh),
            idx_inner_half_edge_ (idx_inner_half_edge)
        {
        }

        inline bool
        isValid () const
        {
          return (idx_inner_half_edge_.isValid ());
        }

        inline bool
        operator == (const Self& other) const
        {
          return (idx_inner_half_edge_ == other.idx_inner_half_edge_);
        }

        inline Self&
        operator ++ ()
        {
          idx_inner_half_edge_ = mesh_->getNextHalfEdgeIndex (idx_inner_half_edge_);
          return (*this);
        }

        inline Self&
        operator -- ()
        {
          idx_inner_half_edge_ = mesh_->getPrevHalfEdgeIndex (idx_inner_half_edge_);
          return (*this);
        }

        inline HalfEdgeIndex
        getTargetIndex () const
        {
          return (mesh_->getOppositeHalfEdgeIndex (idx_inner_half_edge_));
        }

        inline HalfEdgeIndex
        getCurrentHalfEdgeIndex () const
        {
          return (idx_inner_half_edge_);
        }

        Mesh* mesh_;

        HalfEdgeIndex idx_inner_half_edge_;
    };
  } // End namespace geometry
} // End namespace pcl

// FaceAroundFaceCirculator

namespace pcl
{
  namespace geometry
  {
    template <class MeshT>
    class FaceAroundFaceCirculator
        : boost::equality_comparable <pcl::geometry::FaceAroundFaceCirculator <MeshT>
        , boost::unit_steppable      <pcl::geometry::FaceAroundFaceCirculator <MeshT>
        > >
    {
      public:

        typedef boost::equality_comparable <pcl::geometry::FaceAroundFaceCirculator <MeshT>
              , boost::unit_steppable      <pcl::geometry::FaceAroundFaceCirculator <MeshT> > > Base;
        typedef pcl::geometry::FaceAroundFaceCirculator <MeshT> Self;

        typedef MeshT Mesh;
        typedef typename Mesh::FaceIndex FaceIndex;
        typedef typename Mesh::HalfEdgeIndex HalfEdgeIndex;

        FaceAroundFaceCirculator ()
          : mesh_                (NULL),
            idx_inner_half_edge_ ()
        {
        }

        FaceAroundFaceCirculator (const FaceIndex& idx_face,
                                  Mesh*const       mesh)
          : mesh_                (mesh),
            idx_inner_half_edge_ (mesh->getInnerHalfEdgeIndex (idx_face))
        {
        }

        FaceAroundFaceCirculator (const HalfEdgeIndex& idx_inner_half_edge,
                                  Mesh*const           mesh)
          : mesh_                (mesh),
            idx_inner_half_edge_ (idx_inner_half_edge)
        {
        }

        inline bool
        isValid () const
        {
          return (idx_inner_half_edge_.isValid ());
        }

        inline bool
        operator == (const Self& other) const
        {
          return (idx_inner_half_edge_ == other.idx_inner_half_edge_);
        }

        inline Self&
        operator ++ ()
        {
          idx_inner_half_edge_ = mesh_->getNextHalfEdgeIndex (idx_inner_half_edge_);
          return (*this);
        }

        inline Self&
        operator -- ()
        {
          idx_inner_half_edge_ = mesh_->getPrevHalfEdgeIndex (idx_inner_half_edge_);
          return (*this);
        }

        inline FaceIndex
        getTargetIndex () const
        {
          return (mesh_->getOppositeFaceIndex (idx_inner_half_edge_));
        }

        inline HalfEdgeIndex
        getCurrentHalfEdgeIndex () const
        {
          return (idx_inner_half_edge_);
        }

        Mesh* mesh_;

        HalfEdgeIndex idx_inner_half_edge_;
    };
  } // End namespace geometry
} // End namespace pcl

#endif // PCL_GEOMETRY_MESH_CIRCULATORS_H