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 #ifndef OPENMESH_ARRAY_ITEMS_HH
45 #define OPENMESH_ARRAY_ITEMS_HH
46 
47 
48 //== INCLUDES =================================================================
49 
50 
52 #include <OpenMesh/Core/Utils/GenProg.hh>
53 #include <OpenMesh/Core/Mesh/Handles.hh>
54 
55 
56 //== NAMESPACES ===============================================================
57 
58 namespace OpenMesh {
59 
60 
61 //== CLASS DEFINITION =========================================================
62 
63 
65 struct ArrayItems
66 {
67 
68  //------------------------------------------------------ internal vertex type
69 
71  class Vertex
72  {
73  friend class ArrayKernel;
74  HalfedgeHandle halfedge_handle_;
75  };
76 
77 
78  //---------------------------------------------------- internal halfedge type
79 
80 #ifndef DOXY_IGNORE_THIS
81  class Halfedge_without_prev
82  {
83  friend class ArrayKernel;
84  FaceHandle face_handle_;
85  VertexHandle vertex_handle_;
86  HalfedgeHandle next_halfedge_handle_;
87  };
88 #endif
89 
90 #ifndef DOXY_IGNORE_THIS
91  class Halfedge_with_prev : public Halfedge_without_prev
92  {
93  friend class ArrayKernel;
94  HalfedgeHandle prev_halfedge_handle_;
95  };
96 #endif
97 
98  //TODO: should be selected with config.h define
99  typedef Halfedge_with_prev Halfedge;
100  typedef GenProg::Bool2Type<true> HasPrevHalfedge;
101 
102  //-------------------------------------------------------- internal edge type
103 #ifndef DOXY_IGNORE_THIS
104  class Edge
105  {
106  friend class ArrayKernel;
107  Halfedge halfedges_[2];
108  };
109 #endif
110 
111  //-------------------------------------------------------- internal face type
112 #ifndef DOXY_IGNORE_THIS
113  class Face
114  {
115  friend class ArrayKernel;
116  HalfedgeHandle halfedge_handle_;
117  };
118 };
119 #endif
120 
121 //=============================================================================
122 } // namespace OpenMesh
123 //=============================================================================
124 #endif // OPENMESH_ITEMS_HH defined
125 //=============================================================================