Developer Documentation
ArrayItems.hh
1 /* ========================================================================= *
2  * *
3  * OpenMesh *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openmesh.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenMesh. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39  * *
40  * ========================================================================= */
41 
42 /*===========================================================================*\
43  * *
44  * $Revision$ *
45  * $Date$ *
46  * *
47 \*===========================================================================*/
48 
49 #ifndef OPENMESH_ARRAY_ITEMS_HH
50 #define OPENMESH_ARRAY_ITEMS_HH
51 
52 
53 //== INCLUDES =================================================================
54 
55 
57 #include <OpenMesh/Core/Utils/GenProg.hh>
58 #include <OpenMesh/Core/Mesh/Handles.hh>
59 
60 
61 //== NAMESPACES ===============================================================
62 
63 namespace OpenMesh {
64 
65 
66 //== CLASS DEFINITION =========================================================
67 
68 
70 struct ArrayItems
71 {
72 
73  //------------------------------------------------------ internal vertex type
74 
76  class Vertex
77  {
78  friend class ArrayKernel;
79  HalfedgeHandle halfedge_handle_;
80  };
81 
82 
83  //---------------------------------------------------- internal halfedge type
84 
85 #ifndef DOXY_IGNORE_THIS
86  class Halfedge_without_prev
87  {
88  friend class ArrayKernel;
89  FaceHandle face_handle_;
90  VertexHandle vertex_handle_;
91  HalfedgeHandle next_halfedge_handle_;
92  };
93 #endif
94 
95 #ifndef DOXY_IGNORE_THIS
96  class Halfedge_with_prev : public Halfedge_without_prev
97  {
98  friend class ArrayKernel;
99  HalfedgeHandle prev_halfedge_handle_;
100  };
101 #endif
102 
103  //TODO: should be selected with config.h define
104  typedef Halfedge_with_prev Halfedge;
105  typedef GenProg::Bool2Type<true> HasPrevHalfedge;
106 
107  //-------------------------------------------------------- internal edge type
108 #ifndef DOXY_IGNORE_THIS
109  class Edge
110  {
111  friend class ArrayKernel;
112  Halfedge halfedges_[2];
113  };
114 #endif
115 
116  //-------------------------------------------------------- internal face type
117 #ifndef DOXY_IGNORE_THIS
118  class Face
119  {
120  friend class ArrayKernel;
121  HalfedgeHandle halfedge_handle_;
122  };
123 };
124 #endif
125 
126 //=============================================================================
127 } // namespace OpenMesh
128 //=============================================================================
129 #endif // OPENMESH_ITEMS_HH defined
130 //=============================================================================