OpenMesh
OpenMesh/Core/Mesh/Handles.hh
00001 /*===========================================================================*\
00002  *                                                                           *
00003  *                               OpenMesh                                    *
00004  *      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen      *
00005  *                           www.openmesh.org                                *
00006  *                                                                           *
00007  *---------------------------------------------------------------------------* 
00008  *  This file is part of OpenMesh.                                           *
00009  *                                                                           *
00010  *  OpenMesh is free software: you can redistribute it and/or modify         * 
00011  *  it under the terms of the GNU Lesser General Public License as           *
00012  *  published by the Free Software Foundation, either version 3 of           *
00013  *  the License, or (at your option) any later version with the              *
00014  *  following exceptions:                                                    *
00015  *                                                                           *
00016  *  If other files instantiate templates or use macros                       *
00017  *  or inline functions from this file, or you compile this file and         *
00018  *  link it with other files to produce an executable, this file does        *
00019  *  not by itself cause the resulting executable to be covered by the        *
00020  *  GNU Lesser General Public License. This exception does not however       *
00021  *  invalidate any other reasons why the executable file might be            *
00022  *  covered by the GNU Lesser General Public License.                        *
00023  *                                                                           *
00024  *  OpenMesh is distributed in the hope that it will be useful,              *
00025  *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
00026  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
00027  *  GNU Lesser General Public License for more details.                      *
00028  *                                                                           *
00029  *  You should have received a copy of the GNU LesserGeneral Public          *
00030  *  License along with OpenMesh.  If not,                                    *
00031  *  see <http://www.gnu.org/licenses/>.                                      *
00032  *                                                                           *
00033 \*===========================================================================*/ 
00034 
00035 /*===========================================================================*\
00036  *                                                                           *             
00037  *   $Revision: 409 $                                                         *
00038  *   $Date: 2011-09-08 10:18:36 +0200 (Do, 08 Sep 2011) $                   *
00039  *                                                                           *
00040 \*===========================================================================*/
00041 
00042 #ifndef OPENMESH_HANDLES_HH
00043 #define OPENMESH_HANDLES_HH
00044 
00045 
00046 //== INCLUDES =================================================================
00047 
00048 #include <OpenMesh/Core/System/config.h>
00049 #include <iostream>
00050 
00051 
00052 //== NAMESPACES ===============================================================
00053 
00054 namespace OpenMesh {
00055 
00056 //== CLASS DEFINITION =========================================================
00057 
00058 
00060 class BaseHandle
00061 { 
00062 public:
00063   
00064   explicit BaseHandle(int _idx=-1) : idx_(_idx) {}
00065 
00067   int idx() const { return idx_; }
00068 
00070   bool is_valid() const { return idx_ != -1; }
00071 
00073   void reset() { idx_=-1; }
00075   void invalidate() { idx_ = -1; }
00076 
00077   bool operator==(const BaseHandle& _rhs) const { 
00078     return (this->idx_ == _rhs.idx_); 
00079   }
00080 
00081   bool operator!=(const BaseHandle& _rhs) const { 
00082     return (this->idx_ != _rhs.idx_); 
00083   }
00084 
00085   bool operator<(const BaseHandle& _rhs) const { 
00086     return (this->idx_ < _rhs.idx_); 
00087   }
00088 
00089 
00090   // this is to be used only by the iterators
00091   void __increment() { ++idx_; }
00092   void __decrement() { --idx_; }
00093 
00094 
00095 private:
00096 
00097   int idx_; 
00098 };
00099 
00100 
00101 //-----------------------------------------------------------------------------
00102 
00104 inline std::ostream& operator<<(std::ostream& _os, const BaseHandle& _hnd) 
00105 {
00106   return (_os << _hnd.idx());
00107 }
00108 
00109 
00110 //-----------------------------------------------------------------------------
00111 
00112 
00114 struct VertexHandle : public BaseHandle
00115 {
00116   explicit VertexHandle(int _idx=-1) : BaseHandle(_idx) {}
00117 };
00118 
00119 
00121 struct HalfedgeHandle : public BaseHandle
00122 {
00123   explicit HalfedgeHandle(int _idx=-1) : BaseHandle(_idx) {}
00124 };
00125 
00126 
00128 struct EdgeHandle : public BaseHandle
00129 {
00130   explicit EdgeHandle(int _idx=-1) : BaseHandle(_idx) {}
00131 };
00132 
00133 
00135 struct FaceHandle : public BaseHandle
00136 {
00137   explicit FaceHandle(int _idx=-1) : BaseHandle(_idx) {}
00138 };
00139 
00140 
00141 //=============================================================================
00142 } // namespace OpenMesh
00143 //=============================================================================
00144 #endif // OPENMESH_HANDLES_HH
00145 //=============================================================================
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines