Developer Documentation

VHierarchyNodeIndex.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 //=============================================================================
45 //
46 // CLASS newClass
47 //
48 //=============================================================================
49
50 #ifndef OPENMESH_VDPROGMESH_VHIERARCHYNODEINDEX_HH
51 #define OPENMESH_VDPROGMESH_VHIERARCHYNODEINDEX_HH
52
53 //== INCLUDES =================================================================
54
55 #include <vector>
56 #include <cassert>
57
58 //== FORWARDDECLARATIONS ======================================================
59
60
61 //== NAMESPACES ===============================================================
62
63 namespace OpenMesh {
64 namespace VDPM {
65
66 //== CLASS DEFINITION =========================================================
67
68
73 class VHierarchyNodeIndex
74 {
75 private:
76 unsigned int value_;
77
78 public:
79
80 static const VHierarchyNodeIndex InvalidIndex;
81
82 public:
83
84 VHierarchyNodeIndex()
85 { value_ = 0; }
86
87 explicit VHierarchyNodeIndex(unsigned int _value)
88 { value_ = _value; }
89
90 VHierarchyNodeIndex(const VHierarchyNodeIndex &_other)
91 { value_ = _other.value_; }
92
93 VHierarchyNodeIndex(unsigned int _tree_id,
94 unsigned int _node_id,
95 unsigned short _tree_id_bits)
96 {
97 assert(_tree_id < ((unsigned int) 0x00000001 << _tree_id_bits));
98 assert(_node_id < ((unsigned int) 0x00000001 << (32 - _tree_id_bits)));
99 value_ = (_tree_id << (32 - _tree_id_bits)) | _node_id;
100 }
101
102 bool is_valid(unsigned short _tree_id_bits) const
103 { return node_id(_tree_id_bits) != 0 ? true : false; }
104
105 unsigned int tree_id(unsigned short _tree_id_bits) const
106 { return value_ >> (32 - _tree_id_bits); }
107
108 unsigned int node_id(unsigned short _tree_id_bits) const
109 { return value_ & ((unsigned int) 0xFFFFFFFF >> _tree_id_bits); }
110
111 bool operator< (const VHierarchyNodeIndex &other) const
112 { return (value_ < other.value_) ? true : false; }
113
114 unsigned int value() const
115 { return value_; }
116 };
117
118
120 typedef std::vector<VHierarchyNodeIndex> VHierarchyNodeIndexContainer;
121
122
123 //=============================================================================
124 } // namespace VDPM
125 } // namespace OpenMesh
126 //=============================================================================
127 #endif // OPENMESH_VDPROGMESH_VHIERARCHYNODEINDEX_HH defined
128 //=============================================================================
OpenMesh::VDPM::VHierarchyNodeIndexContainer
std::vector< VHierarchyNodeIndex > VHierarchyNodeIndexContainer
Container for vertex hierarchy node indices.
Definition: VHierarchyNodeIndex.hh:120
OpenMesh::VDPM::VHierarchyNodeIndex
Definition: VHierarchyNodeIndex.hh:73
OpenMesh
Definition: MeshItems.hh:59