Developer Documentation

TriangleBSPCoreT.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
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 // CLASS TriangleBSPCoreT
46 //
47 //=============================================================================
48
49 #ifndef TRIANGLEBSPCORET_HH
50 #define TRIANGLEBSPCORET_HH
51
52
53 //== INCLUDES =================================================================
54
55
56 #include <vector>
57 #include <ACG/Geometry/Types/PlaneT.hh>
58 #include <OpenMesh/Core/Geometry/VectorT.hh>
59
60 #include "TriangleBSPT.hh"
61
62
63 //== CLASS DEFINITION =========================================================
64
65
66 template <class BSPTraits>
67 class TriangleBSPCoreT
68 {
69 public: //---------------------------------------------------------------------
70
71 typedef BSPTraits Traits;
72 typedef typename BSPTraits::Point Point;
73 typedef typename BSPTraits::Handle Handle;
74 typedef typename BSPTraits::Node Node;
75 typedef typename Point::value_type Scalar;
76 typedef ACG::Geometry::PlaneT<Scalar> Plane;
77 typedef std::vector<Handle> Handles;
78 typedef typename Handles::iterator HandleIter;
79
80
81 public: //---------------------------------------------------------------------
82
83
86 explicit TriangleBSPCoreT(const BSPTraits& _traits) : traits_(_traits), root_(0), nodes(0), n_triangles(0) {}
87
89 ~TriangleBSPCoreT() {
90 delete root_;
91 }
92
93
95 void reserve(size_t _n) { handles_.reserve(_n); }
97 void push_back(Handle _h) { handles_.push_back(_h); ++n_triangles; }
98
102 bool empty() { return n_triangles == 0; }
103
107 size_t size() { return n_triangles; }
108
114 void build(unsigned int _max_handles, unsigned int _max_depth);
115
121 template <typename MeshT>
122 void visualizeTree(MeshT *_object, int _max_depth)
123 {
124 root_->visualizeTree(_object, _max_depth-1);
125 _object->update_normals();
126 }
127
128 private:
129 /*
130 * Noncopyable because of root_.
131 */
132 TriangleBSPCoreT(const TriangleBSPCoreT &rhs);
133 TriangleBSPCoreT &operator=(const TriangleBSPCoreT &rhs);
134
135
136 private: //---------------------------------------------------------------------
137
138
139 // Recursive part of build()
140 void _build(Node* _node,
141 unsigned int _max_handles,
142 unsigned int _depth);
143
144
145
146
147 protected: //-------------------------------------------------------------------
148
149
150 BSPTraits traits_;
151 Handles handles_;
152 Node* root_;
153 int nodes, n_triangles;
154
155 };
156
157
158 //=============================================================================
159 #if defined(OM_INCLUDE_TEMPLATES) && !defined(TRIANGLEBSPCORET_C)
160 # define TRIANGLEBSPCORET_TEMPLATES
161 # include "TriangleBSPCoreT_impl.hh"
162 #endif
163 //=============================================================================
164 #endif // TRIANGLEBSPCORET_HH defined
165 //=============================================================================
TriangleBSPCoreT
Definition: TriangleBSPCoreT.hh:67
TriangleBSPCoreT::TriangleBSPCoreT
TriangleBSPCoreT(const BSPTraits &_traits)
Definition: TriangleBSPCoreT.hh:86
TriangleBSPCoreT::size
size_t size()
Definition: TriangleBSPCoreT.hh:107
TriangleBSPCoreT::build
void build(unsigned int _max_handles, unsigned int _max_depth)
Definition: TriangleBSPCoreT_impl.hh:63
TriangleBSPCoreT::push_back
void push_back(Handle _h)
Add a handle to the BSP.
Definition: TriangleBSPCoreT.hh:97
TriangleBSPCoreT::~TriangleBSPCoreT
~TriangleBSPCoreT()
Destructor.
Definition: TriangleBSPCoreT.hh:89
TriangleBSPCoreT::reserve
void reserve(size_t _n)
Reserve memory for _n entries.
Definition: TriangleBSPCoreT.hh:95
TriangleBSPCoreT::empty
bool empty()
Definition: TriangleBSPCoreT.hh:102
TriangleBSPCoreT::visualizeTree
void visualizeTree(MeshT *_object, int _max_depth)
Create a PolyMesh object that visualizes the bounding boxes of the BSP tree.
Definition: TriangleBSPCoreT.hh:122
ACG::Geometry::PlaneT
Definition: PlaneT.hh:78