OpenMesh

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Handles.hh
1 /*===========================================================================*\
2 * *
3 * OpenMesh *
4 * Copyright (C) 2001-2014 by Computer Graphics Group, RWTH Aachen *
5 * www.openmesh.org *
6 * *
7 *---------------------------------------------------------------------------*
8 * This file is part of OpenMesh. *
9 * *
10 * OpenMesh is free software: you can redistribute it and/or modify *
11 * it under the terms of the GNU Lesser General Public License as *
12 * published by the Free Software Foundation, either version 3 of *
13 * the License, or (at your option) any later version with the *
14 * following exceptions: *
15 * *
16 * If other files instantiate templates or use macros *
17 * or inline functions from this file, or you compile this file and *
18 * link it with other files to produce an executable, this file does *
19 * not by itself cause the resulting executable to be covered by the *
20 * GNU Lesser General Public License. This exception does not however *
21 * invalidate any other reasons why the executable file might be *
22 * covered by the GNU Lesser General Public License. *
23 * *
24 * OpenMesh is distributed in the hope that it will be useful, *
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
27 * GNU Lesser General Public License for more details. *
28 * *
29 * You should have received a copy of the GNU LesserGeneral Public *
30 * License along with OpenMesh. If not, *
31 * see <http://www.gnu.org/licenses/>. *
32 * *
33 \*===========================================================================*/
34
35 /*===========================================================================*\
36 * *
37 * $Revision: 990 $ *
38 * $Date: 2014-02-05 10:01:07 +0100 (Mi, 05. Feb 2014) $ *
39 * *
40 \*===========================================================================*/
41
42 #ifndef OPENMESH_HANDLES_HH
43 #define OPENMESH_HANDLES_HH
44
45
46 //== INCLUDES =================================================================
47
48 #include <OpenMesh/Core/System/config.h>
49 #include <iostream>
50
51
52 //== NAMESPACES ===============================================================
53
54 namespace OpenMesh {
55
56 //== CLASS DEFINITION =========================================================
57
58
60 class BaseHandle
61 {
62 public:
63
64 explicit BaseHandle(int _idx=-1) : idx_(_idx) {}
65
67 int idx() const { return idx_; }
68
70 bool is_valid() const { return idx_ != -1; }
71
73 void reset() { idx_=-1; }
75 void invalidate() { idx_ = -1; }
76
77 bool operator==(const BaseHandle& _rhs) const {
78 return (this->idx_ == _rhs.idx_);
79 }
80
81 bool operator!=(const BaseHandle& _rhs) const {
82 return (this->idx_ != _rhs.idx_);
83 }
84
85 bool operator<(const BaseHandle& _rhs) const {
86 return (this->idx_ < _rhs.idx_);
87 }
88
89
90 // this is to be used only by the iterators
91 void __increment() { ++idx_; }
92 void __decrement() { --idx_; }
93
94
95 private:
96
97 int idx_;
98 };
99
100
101 //-----------------------------------------------------------------------------
102
104 inline std::ostream& operator<<(std::ostream& _os, const BaseHandle& _hnd)
105 {
106 return (_os << _hnd.idx());
107 }
108
109
110 //-----------------------------------------------------------------------------
111
112
114 struct VertexHandle : public BaseHandle
115 {
116 explicit VertexHandle(int _idx=-1) : BaseHandle(_idx) {}
117 };
118
119
121 struct HalfedgeHandle : public BaseHandle
122 {
123 explicit HalfedgeHandle(int _idx=-1) : BaseHandle(_idx) {}
124 };
125
126
128 struct EdgeHandle : public BaseHandle
129 {
130 explicit EdgeHandle(int _idx=-1) : BaseHandle(_idx) {}
131 };
132
133
135 struct FaceHandle : public BaseHandle
136 {
137 explicit FaceHandle(int _idx=-1) : BaseHandle(_idx) {}
138 };
139
140
141 //=============================================================================
142 } // namespace OpenMesh
143 //=============================================================================
144 #endif // OPENMESH_HANDLES_HH
145 //=============================================================================
OpenMesh::EdgeHandle
Handle for a edge entity.
Definition: Handles.hh:128
OpenMesh::BaseHandle::idx
int idx() const
Get the underlying index of this handle.
Definition: Handles.hh:67
OpenMesh::BaseHandle::is_valid
bool is_valid() const
The handle is valid iff the index is not equal to -1.
Definition: Handles.hh:70
OpenMesh::BaseHandle::reset
void reset()
reset handle to be invalid
Definition: Handles.hh:73
OpenMesh::FaceHandle
Handle for a face entity.
Definition: Handles.hh:135
OpenMesh::operator<<
std::ostream & operator<<(std::ostream &_os, const BaseHandle &_hnd)
Write handle _hnd to stream _os.
Definition: Handles.hh:104
OpenMesh::VertexHandle
Handle for a vertex entity.
Definition: Handles.hh:114
OpenMesh::BaseHandle
Base class for all handle types.
Definition: Handles.hh:60
OpenMesh::BaseHandle::invalidate
void invalidate()
reset handle to be invalid
Definition: Handles.hh:75
OpenMesh::HalfedgeHandle
Handle for a halfedge entity.
Definition: Handles.hh:121