OpenMesh
Loading...
Searching...
No Matches
SmartHandles.hh
1/* ========================================================================= *
2 * *
3 * OpenMesh *
4 * Copyright (c) 2001-2019, 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#ifndef OPENMESH_POLYCONNECTIVITY_INTERFACE_INCLUDE
43#error Do not include this directly, include instead PolyConnectivity.hh
44#endif//OPENMESH_POLYCONNECTIVITY_INTERFACE_INCLUDE
45
46#include <OpenMesh/Core/Mesh/PolyConnectivity.hh>
47
48//== NAMESPACES ===============================================================
49
50namespace OpenMesh {
51
52//== FORWARD DECLARATION ======================================================
53
54struct SmartVertexHandle;
55struct SmartHalfedgeHandle;
56struct SmartEdgeHandle;
57struct SmartFaceHandle;
58
59
60//== CLASS DEFINITION =========================================================
61
63class OPENMESHDLLEXPORT SmartBaseHandle
64{
65public:
66 explicit SmartBaseHandle(const PolyConnectivity* _mesh = nullptr) : mesh_(_mesh) {}
67
69 const PolyConnectivity* mesh() const { return mesh_; }
70
71 // TODO: should operators ==, !=, < look at mesh_?
72
73private:
74 const PolyConnectivity* mesh_;
75
76};
77
79template <typename HandleType>
81{
82public:
84 bool feature() const;
86 bool selected() const;
88 bool tagged() const;
90 bool tagged2() const;
92 bool locked() const;
94 bool hidden() const;
96 bool deleted() const;
97};
98
100template <typename HandleType>
102{
103public:
105 bool is_boundary() const;
106};
107
109struct OPENMESHDLLEXPORT SmartVertexHandle : public SmartBaseHandle, VertexHandle, SmartHandleStatusPredicates<SmartVertexHandle>, SmartHandleBoundaryPredicate<SmartVertexHandle>
110{
111 explicit SmartVertexHandle(int _idx=-1, const PolyConnectivity* _mesh = nullptr) : SmartBaseHandle(_mesh), VertexHandle(_idx) {}
112
114 SmartHalfedgeHandle out() const;
116 SmartHalfedgeHandle halfedge() const; // alias for out
118 SmartHalfedgeHandle in() const;
119
139 PolyConnectivity::ConstVertexIHalfedgeRange incoming_halfedges() const;
141 PolyConnectivity::ConstVertexIHalfedgeCWRange incoming_halfedges_cw() const;
143 PolyConnectivity::ConstVertexIHalfedgeCCWRange incoming_halfedges_ccw() const;
145 PolyConnectivity::ConstVertexIHalfedgeRange incoming_halfedges(HalfedgeHandle _heh) const;
147 PolyConnectivity::ConstVertexIHalfedgeCWRange incoming_halfedges_cw(HalfedgeHandle _heh) const;
149 PolyConnectivity::ConstVertexIHalfedgeCCWRange incoming_halfedges_ccw(HalfedgeHandle _heh) const;
151 PolyConnectivity::ConstVertexOHalfedgeRange outgoing_halfedges() const;
153 PolyConnectivity::ConstVertexOHalfedgeCWRange outgoing_halfedges_cw() const;
155 PolyConnectivity::ConstVertexOHalfedgeCCWRange outgoing_halfedges_ccw() const;
157 PolyConnectivity::ConstVertexOHalfedgeRange outgoing_halfedges(HalfedgeHandle _heh) const;
159 PolyConnectivity::ConstVertexOHalfedgeCWRange outgoing_halfedges_cw(HalfedgeHandle _heh) const;
161 PolyConnectivity::ConstVertexOHalfedgeCCWRange outgoing_halfedges_ccw(HalfedgeHandle _heh) const;
162
164 uint valence() const;
166 bool is_manifold() const;
167};
168
169struct OPENMESHDLLEXPORT SmartHalfedgeHandle : public SmartBaseHandle, HalfedgeHandle, SmartHandleStatusPredicates<SmartHalfedgeHandle>, SmartHandleBoundaryPredicate<SmartHalfedgeHandle>
170{
171 explicit SmartHalfedgeHandle(int _idx=-1, const PolyConnectivity* _mesh = nullptr) : SmartBaseHandle(_mesh), HalfedgeHandle(_idx) {}
172
174 SmartHalfedgeHandle next() const;
176 SmartHalfedgeHandle prev() const;
178 SmartHalfedgeHandle opp() const;
180 SmartVertexHandle to() const;
182 SmartVertexHandle from() const;
184 SmartEdgeHandle edge() const;
186 SmartFaceHandle face() const;
187
194};
195
196struct OPENMESHDLLEXPORT SmartEdgeHandle : public SmartBaseHandle, EdgeHandle, SmartHandleStatusPredicates<SmartEdgeHandle>, SmartHandleBoundaryPredicate<SmartEdgeHandle>
197{
198 explicit SmartEdgeHandle(int _idx=-1, const PolyConnectivity* _mesh = nullptr) : SmartBaseHandle(_mesh), EdgeHandle(_idx) {}
199
201 SmartHalfedgeHandle halfedge(unsigned int _i) const;
203 SmartHalfedgeHandle h(unsigned int _i) const;
205 SmartHalfedgeHandle h0() const;
207 SmartHalfedgeHandle h1() const;
209 SmartVertexHandle vertex(unsigned int _i) const;
211 SmartVertexHandle v(unsigned int _i) const;
213 SmartVertexHandle v0() const;
215 SmartVertexHandle v1() const;
216};
217
218struct OPENMESHDLLEXPORT SmartFaceHandle : public SmartBaseHandle, FaceHandle, SmartHandleStatusPredicates<SmartFaceHandle>, SmartHandleBoundaryPredicate<SmartFaceHandle>
219{
220 explicit SmartFaceHandle(int _idx=-1, const PolyConnectivity* _mesh = nullptr) : SmartBaseHandle(_mesh), FaceHandle(_idx) {}
221
223 SmartHalfedgeHandle halfedge() const;
224
249
251 uint valence() const;
252};
253
254
256inline SmartVertexHandle make_smart(VertexHandle _vh, const PolyConnectivity* _mesh) { return SmartVertexHandle (_vh.idx(), _mesh); }
258inline SmartHalfedgeHandle make_smart(HalfedgeHandle _hh, const PolyConnectivity* _mesh) { return SmartHalfedgeHandle(_hh.idx(), _mesh); }
260inline SmartEdgeHandle make_smart(EdgeHandle _eh, const PolyConnectivity* _mesh) { return SmartEdgeHandle (_eh.idx(), _mesh); }
262inline SmartFaceHandle make_smart(FaceHandle _fh, const PolyConnectivity* _mesh) { return SmartFaceHandle (_fh.idx(), _mesh); }
263
265inline SmartVertexHandle make_smart(VertexHandle _vh, const PolyConnectivity& _mesh) { return SmartVertexHandle (_vh.idx(), &_mesh); }
267inline SmartHalfedgeHandle make_smart(HalfedgeHandle _hh, const PolyConnectivity& _mesh) { return SmartHalfedgeHandle(_hh.idx(), &_mesh); }
269inline SmartEdgeHandle make_smart(EdgeHandle _eh, const PolyConnectivity& _mesh) { return SmartEdgeHandle (_eh.idx(), &_mesh); }
271inline SmartFaceHandle make_smart(FaceHandle _fh, const PolyConnectivity& _mesh) { return SmartFaceHandle (_fh.idx(), &_mesh); }
272
273
274// helper to convert Handle Types to Smarthandle Types
275template <typename HandleT>
277
278template <> struct SmartHandle<VertexHandle> { using type = SmartVertexHandle; };
279template <> struct SmartHandle<HalfedgeHandle> { using type = SmartHalfedgeHandle; };
280template <> struct SmartHandle<EdgeHandle> { using type = SmartEdgeHandle; };
281template <> struct SmartHandle<FaceHandle> { using type = SmartFaceHandle; };
282
283
284template <typename HandleType>
286{
287 const auto& handle = static_cast<const HandleType&>(*this);
288 assert(handle.mesh() != nullptr);
289 return handle.mesh()->status(handle).feature();
290}
291
292template <typename HandleType>
294{
295 const auto& handle = static_cast<const HandleType&>(*this);
296 assert(handle.mesh() != nullptr);
297 return handle.mesh()->status(handle).selected();
298}
299
300template <typename HandleType>
302{
303 const auto& handle = static_cast<const HandleType&>(*this);
304 assert(handle.mesh() != nullptr);
305 return handle.mesh()->status(handle).tagged();
306}
307
308template <typename HandleType>
310{
311 const auto& handle = static_cast<const HandleType&>(*this);
312 assert(handle.mesh() != nullptr);
313 return handle.mesh()->status(handle).tagged2();
314}
315
316template <typename HandleType>
318{
319 const auto& handle = static_cast<const HandleType&>(*this);
320 assert(handle.mesh() != nullptr);
321 return handle.mesh()->status(handle).locked();
322}
323
324template <typename HandleType>
326{
327 const auto& handle = static_cast<const HandleType&>(*this);
328 assert(handle.mesh() != nullptr);
329 return handle.mesh()->status(handle).hidden();
330}
331
332template <typename HandleType>
334{
335 const auto& handle = static_cast<const HandleType&>(*this);
336 assert(handle.mesh() != nullptr);
337 return handle.mesh()->status(handle).deleted();
338}
339
340template <typename HandleType>
342{
343 const auto& handle = static_cast<const HandleType&>(*this);
344 assert(handle.mesh() != nullptr);
345 return handle.mesh()->is_boundary(handle);
346}
347
349{
350 assert(mesh() != nullptr);
351 return make_smart(mesh()->halfedge_handle(*this), mesh());
352}
353
355{
356 return out();
357}
358
360{
361 return out().opp();
362}
363
364inline uint SmartVertexHandle::valence() const
365{
366 assert(mesh() != nullptr);
367 return mesh()->valence(*this);
368}
369
371{
372 assert(mesh() != nullptr);
373 return mesh()->is_manifold(*this);
374}
375
377{
378 assert(mesh() != nullptr);
379 return make_smart(mesh()->next_halfedge_handle(*this), mesh());
380}
381
383{
384 assert(mesh() != nullptr);
385 return make_smart(mesh()->prev_halfedge_handle(*this), mesh());
386}
387
389{
390 assert(mesh() != nullptr);
391 return make_smart(mesh()->opposite_halfedge_handle(*this), mesh());
392}
393
395{
396 assert(mesh() != nullptr);
397 return make_smart(mesh()->to_vertex_handle(*this), mesh());
398}
399
401{
402 assert(mesh() != nullptr);
403 return make_smart(mesh()->from_vertex_handle(*this), mesh());
404}
405
407{
408 assert(mesh() != nullptr);
409 return make_smart(mesh()->edge_handle(*this), mesh());
410}
411
413{
414 assert(mesh() != nullptr);
415 return make_smart(mesh()->face_handle(*this), mesh());
416}
417
419{
420 assert(mesh() != nullptr);
421 return make_smart(mesh()->halfedge_handle(*this, _i), mesh());
422}
423
424inline SmartHalfedgeHandle SmartEdgeHandle::h(unsigned int _i) const
425{
426 return halfedge(_i);
427}
428
430{
431 return h(0);
432}
433
435{
436 return h(1);
437}
438
439inline SmartVertexHandle SmartEdgeHandle::vertex(unsigned int _i) const
440{
441 return halfedge(_i).from();
442}
443
444inline SmartVertexHandle SmartEdgeHandle::v(unsigned int _i) const
445{
446 return vertex(_i);
447}
448
450{
451 return v(0);
452}
453
455{
456 return v(1);
457}
458
460{
461 assert(mesh() != nullptr);
462 return make_smart(mesh()->halfedge_handle(*this), mesh());
463}
464
465inline uint SmartFaceHandle::valence() const
466{
467 assert(mesh() != nullptr);
468 return mesh()->valence(*this);
469}
470
471//=============================================================================
472} // namespace OpenMesh
473//=============================================================================
474
475//=============================================================================
Contains all the mesh ingredients like the polygonal mesh, the triangle mesh, different mesh kernels ...
Definition MeshItems.hh:59
SmartVertexHandle make_smart(VertexHandle _vh, const PolyConnectivity *_mesh)
Creats a SmartVertexHandle from a VertexHandle and a Mesh.
Definition SmartHandles.hh:256
Generic class for iterator ranges.
Definition PolyConnectivity_inline_impl.hh:92
int idx() const
Get the underlying index of this handle.
Definition Handles.hh:69
Handle for a vertex entity.
Definition Handles.hh:121
Handle for a halfedge entity.
Definition Handles.hh:128
Handle for a edge entity.
Definition Handles.hh:135
Handle for a face entity.
Definition Handles.hh:142
Connectivity Class for polygonal meshes.
Definition PolyConnectivity.hh:115
uint valence(VertexHandle _vh) const
Vertex valence.
Definition PolyConnectivity.cc:1075
bool is_manifold(VertexHandle _vh) const
Is (the mesh at) vertex _vh two-manifold ?
Definition PolyConnectivity.cc:84
Base class for all smart handle types.
Definition SmartHandles.hh:64
const PolyConnectivity * mesh() const
Get the underlying mesh of this handle.
Definition SmartHandles.hh:69
Base class for all smart handle types that contains status related methods.
Definition SmartHandles.hh:81
bool selected() const
Returns true iff the handle is marked as selected.
Definition SmartHandles.hh:293
bool feature() const
Returns true iff the handle is marked as feature.
Definition SmartHandles.hh:285
bool locked() const
Returns true iff the handle is marked as locked.
Definition SmartHandles.hh:317
bool deleted() const
Returns true iff the handle is marked as deleted.
Definition SmartHandles.hh:333
bool tagged() const
Returns true iff the handle is marked as tagged.
Definition SmartHandles.hh:301
bool tagged2() const
Returns true iff the handle is marked as tagged2.
Definition SmartHandles.hh:309
bool hidden() const
Returns true iff the handle is marked as hidden.
Definition SmartHandles.hh:325
Base class for all smart handle types that contains status related methods.
Definition SmartHandles.hh:102
bool is_boundary() const
Returns true iff the handle is boundary.
Definition SmartHandles.hh:341
Smart version of VertexHandle contains a pointer to the corresponding mesh and allows easier access t...
Definition SmartHandles.hh:110
SmartHalfedgeHandle halfedge() const
Returns an outgoing halfedge.
Definition SmartHandles.hh:354
SmartHalfedgeHandle out() const
Returns an outgoing halfedge.
Definition SmartHandles.hh:348
bool is_manifold() const
Returns true iff (the mesh at) the vertex is two-manifold ?
Definition SmartHandles.hh:370
SmartHalfedgeHandle in() const
Returns an incoming halfedge.
Definition SmartHandles.hh:359
uint valence() const
Returns valence of the vertex.
Definition SmartHandles.hh:364
Definition SmartHandles.hh:170
SmartFaceHandle face() const
Returns incident face of halfedge.
Definition SmartHandles.hh:412
SmartVertexHandle from() const
Returns vertex at start of halfedge.
Definition SmartHandles.hh:400
SmartHalfedgeHandle next() const
Returns next halfedge handle.
Definition SmartHandles.hh:376
SmartHalfedgeHandle prev() const
Returns previous halfedge handle.
Definition SmartHandles.hh:382
SmartEdgeHandle edge() const
Returns incident edge of halfedge.
Definition SmartHandles.hh:406
SmartHalfedgeHandle opp() const
Returns opposite halfedge handle.
Definition SmartHandles.hh:388
SmartVertexHandle to() const
Returns vertex pointed to by halfedge.
Definition SmartHandles.hh:394
Definition SmartHandles.hh:197
SmartVertexHandle v(unsigned int _i) const
Shorthand for vertex()
Definition SmartHandles.hh:444
SmartVertexHandle v1() const
Shorthand for vertex(1)
Definition SmartHandles.hh:454
SmartHalfedgeHandle h(unsigned int _i) const
Shorthand for halfedge()
Definition SmartHandles.hh:424
SmartHalfedgeHandle h1() const
Shorthand for halfedge(1)
Definition SmartHandles.hh:434
SmartVertexHandle vertex(unsigned int _i) const
Returns one of the two incident vertices of the edge.
Definition SmartHandles.hh:439
SmartVertexHandle v0() const
Shorthand for vertex(0)
Definition SmartHandles.hh:449
SmartHalfedgeHandle halfedge(unsigned int _i) const
Returns one of the two halfedges of the edge.
Definition SmartHandles.hh:418
SmartHalfedgeHandle h0() const
Shorthand for halfedge(0)
Definition SmartHandles.hh:429
Definition SmartHandles.hh:219
uint valence() const
Returns the valence of the face.
Definition SmartHandles.hh:465
SmartHalfedgeHandle halfedge() const
Returns one of the halfedges of the face.
Definition SmartHandles.hh:459
Definition SmartHandles.hh:276

Project OpenMesh, ©  Visual Computing Institute, RWTH Aachen. Documentation generated using doxygen .