PropertyManager.hh 33 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
/* ========================================================================= *
2
3
 *                                                                           *
 *                               OpenMesh                                    *
Jan Möbius's avatar
Jan Möbius committed
4
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
Jan Möbius's avatar
Typo    
Jan Möbius committed
5
 *           Department of Computer Graphics and Multimedia                  *
Jan Möbius's avatar
Jan Möbius committed
6
7
 *                          All rights reserved.                             *
 *                            www.openmesh.org                               *
8
9
 *                                                                           *
 *---------------------------------------------------------------------------*
Jan Möbius's avatar
Jan Möbius committed
10
11
 * This file is part of OpenMesh.                                            *
 *---------------------------------------------------------------------------*
12
 *                                                                           *
Jan Möbius's avatar
Jan Möbius committed
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
Jan Möbius's avatar
Jan Möbius committed
39
40
 *                                                                           *
 * ========================================================================= */
41
42
43
44

#ifndef PROPERTYMANAGER_HH_
#define PROPERTYMANAGER_HH_

45
46
#include <OpenMesh/Core/System/config.h>
#include <OpenMesh/Core/Utils/HandleToPropHandle.hh>
47
#include <OpenMesh/Core/Mesh/PolyConnectivity.hh>
48
#include <sstream>
49
#include <stdexcept>
50
#include <string>
51
52
53
54
55
56
57
58

namespace OpenMesh {

/**
 * This class is intended to manage the lifecycle of properties.
 * It also defines convenience operators to access the encapsulated
 * property's value.
 *
59
60
61
 * It is recommended to use the factory functions
 * makeTemporaryProperty(), getProperty(), and getOrMakeProperty()
 * to construct a PropertyManager, e.g.
62
 *
63
64
 * Note that the second template parameter is depcretated.
 *
65
 * \code
66
67
68
 * {
 *     TriMesh mesh;
 *     auto visited = makeTemporaryProperty<VertexHandle, bool>(mesh);
69
 *
70
71
72
73
 *     for (auto vh : mesh.vertices()) {
 *         if (!visited[vh]) {
 *             visitComponent(mesh, vh, visited);
 *         }
74
 *     }
75
 *     // The property is automatically removed at the end of the scope
76
77
 * }
 * \endcode
78
 */
79
template<typename PROPTYPE, typename MeshT = int>
80
81
82
class PropertyManager {

    public:
Max Lyon's avatar
Max Lyon committed
83
84
85
        using Value      = typename PROPTYPE::Value;
        using value_type = typename PROPTYPE::value_type;
        using Handle     = typename PROPTYPE::Handle;
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
        using Self       = PropertyManager<PROPTYPE, MeshT>;

    private:
        // Mesh properties (MPropHandleT<...>) are stored differently than the other properties.
        // This class implements different behavior when copying or swapping data from one
        // property manager to a another one.
        template <typename PropertyManager2, typename PropHandleT>
        struct StorageT;

        // specialization for Mesh Properties
        template <typename PropertyManager2>
        struct StorageT<PropertyManager2, MPropHandleT<Value>> {
          static void copy(const PropertyManager<PROPTYPE, MeshT>& from, PropertyManager2& to) {
            *to = *from;
          }
          static void swap(PropertyManager<PROPTYPE, MeshT>& from, PropertyManager2& to) {
            std::swap(*to, *from);
          }
        };

        // definition for other Mesh Properties
        template <typename PropertyManager2, typename PropHandleT>
        struct StorageT {
          static void copy(const PropertyManager<PROPTYPE, MeshT>& from, PropertyManager2& to) {
            from.copy_to(from.mesh_.template all_elements<Handle>(), to, to.mesh_.template all_elements<Handle>());
          }
          static void swap(PropertyManager<PROPTYPE, MeshT>& lhs, PropertyManager2& rhs) {
            std::swap(lhs.mesh_.property(lhs.prop_).data_vector(), rhs.mesh_.property(rhs.prop_).data_vector());
            // resize the property to the correct size
            lhs.mesh_.property(lhs.prop_).resize(lhs.mesh_.template n_elements<Handle>());
            rhs.mesh_.property(rhs.prop_).resize(rhs.mesh_.template n_elements<Handle>());
          }
        };

        using Storage = StorageT<Self, PROPTYPE>;

    public:
Max Lyon's avatar
Max Lyon committed
123

124
        /**
Max Lyon's avatar
Max Lyon committed
125
126
         * @deprecated Use a constructor without \p existing and check existance with hasProperty() instead.
         *
127
128
129
130
131
132
133
134
135
136
137
138
         * Constructor.
         *
         * Throws an \p std::runtime_error if \p existing is true and
         * no property named \p propname of the appropriate property type
         * exists.
         *
         * @param mesh The mesh on which to create the property.
         * @param propname The name of the property.
         * @param existing If false, a new property is created and its lifecycle is managed (i.e.
         * the property is deleted upon destruction of the PropertyManager instance). If true,
         * the instance merely acts as a convenience wrapper around an existing property with no
         * lifecycle management whatsoever.
139
         *
Max Lyon's avatar
Max Lyon committed
140
141
         * @see PropertyManager::getOrMakeProperty, PropertyManager::getProperty,
         * PropertyManager::makeTemporaryProperty
142
         */
143
        OM_DEPRECATED("Use the constructor without parameter 'existing' instead. Check for existance with hasProperty") // As long as this overload exists, initial value must be first parameter due to ambiguity for properties of type bool
Max Lyon's avatar
Max Lyon committed
144
        PropertyManager(PolyConnectivity& mesh, const char *propname, bool existing) : mesh_(mesh), retain_(existing), name_(propname) {
145
            if (existing) {
Max Lyon's avatar
Max Lyon committed
146
                if (!mesh_.get_property_handle(prop_, propname)) {
147
148
149
150
151
                    std::ostringstream oss;
                    oss << "Requested property handle \"" << propname << "\" does not exist.";
                    throw std::runtime_error(oss.str());
                }
            } else {
Max Lyon's avatar
Max Lyon committed
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
                mesh_.add_property(prop_, propname);
            }
        }

        /**
         * Constructor.
         *
         * Asks for a property with name propname and creates one if none exists. Lifetime is not managed.
         *
         * @param mesh The mesh on which to create the property.
         * @param propname The name of the property.
         */
        PropertyManager(PolyConnectivity& mesh, const char *propname) : mesh_(mesh), retain_(true), name_(propname) {
            if (!mesh_.get_property_handle(prop_, propname)) {
              mesh_.add_property(prop_, propname);
167
168
169
            }
        }

Max Lyon's avatar
Max Lyon committed
170
171
172
173
174
        /**
         * Constructor.
         *
         * Asks for a property with name propname and creates one if none exists. Lifetime is not managed.
         *
175
176
         * @param initial_value If the proeprty is newly created, it will be initialized with intial_value.
         *        If the property already existed, nothing is changes.
Max Lyon's avatar
Max Lyon committed
177
178
179
         * @param mesh The mesh on which to create the property.
         * @param propname The name of the property.
         */
180
        PropertyManager(const Value& intial_value, PolyConnectivity& mesh, const char *propname) : mesh_(mesh), retain_(true), name_(propname) {
Max Lyon's avatar
Max Lyon committed
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
            if (!mesh_.get_property_handle(prop_, propname)) {
              mesh_.add_property(prop_, propname);
              set_range(mesh_.all_elements<Handle>(), intial_value);
            }
        }

        /**
         * Constructor.
         *
         * Create an anonymous property. Lifetime is managed.
         *
         * @param mesh The mesh on which to create the property.
         */
        PropertyManager(PolyConnectivity& mesh) : mesh_(mesh), retain_(false), name_("") {
            mesh_.add_property(prop_, name_);
        }

        /**
         * Constructor.
         *
         * Create an anonymous property. Lifetime is managed.
         *
203
         * @param initial_value The property will be initialized with intial_value.
Max Lyon's avatar
Max Lyon committed
204
205
         * @param mesh The mesh on which to create the property.
         */
206
        PropertyManager(const Value& intial_value, PolyConnectivity& mesh) : mesh_(mesh), retain_(false), name_("") {
Max Lyon's avatar
Max Lyon committed
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
            mesh_.add_property(prop_, name_);
            set_range(mesh_.all_elements<Handle>(), intial_value);
        }

        /**
         * Constructor.
         *
         * Create a wrapper around an existing property. Lifetime is not managed.
         *
         * @param mesh The mesh on which to create the property.
         */
        PropertyManager(PolyConnectivity& mesh, PROPTYPE property_handle) : mesh_(mesh), prop_(property_handle), retain_(true), name_() {
        }

        PropertyManager() = delete;

        PropertyManager(const PropertyManager& rhs)
          :
            mesh_(rhs.mesh_),
            prop_(),
            retain_(rhs.retain_),
            name_(rhs.name_)
        {
          if (rhs.retain_) // named property -> create a property manager referring to the same
          {
            prop_ = rhs.prop_;
          }
          else // unnamed property -> create a property manager refering to a new property and copy the contents
          {
            mesh_.add_property(prop_, name_);
237
            Storage::copy(rhs, *this);
Max Lyon's avatar
Max Lyon committed
238
239
240
241
242
243
244
245
          }
        }

        PropertyManager& operator=(const PropertyManager& rhs)
        {
          if (&mesh_ == &rhs.mesh_ && prop_ == rhs.prop_)
            ; // nothing to do
          else
246
            Storage::copy(rhs, *this);
Max Lyon's avatar
Max Lyon committed
247
          return *this;
248
249
        }

250
251
252
253
        ~PropertyManager() {
            deleteProperty();
        }

254
255
256
257
        void swap(PropertyManager &rhs) {
            std::swap(mesh_, rhs.mesh_);
            std::swap(prop_, rhs.prop_);
            std::swap(retain_, rhs.retain_);
258
            std::swap(name_, rhs.name_);
259
260
        }

261
        static bool propertyExists(PolyConnectivity &mesh, const char *propname) {
262
263
264
265
            PROPTYPE dummy;
            return mesh.get_property_handle(dummy, propname);
        }

266
        bool isValid() const { return prop_.is_valid(); }
267
268
269
270
        operator bool() const { return isValid(); }

        const PROPTYPE &getRawProperty() const { return prop_; }

271
272
        const std::string &getName() const { return name_; }

273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
        /**
         * Get the mesh corresponding to the property.
         *
         * If you use PropertyManager without second template parameter (recommended)
         * you need to specify the actual mesh type when using this function, e.g.:
         * \code
         * {
         *     TriMesh mesh;
         *     auto visited = VProp<bool>(mesh);
         *     TriMesh& mesh_ref = visited.getMesh<TriMesh>();
         * }
         *
         */
        template <typename MeshType >
        MeshType& getMesh() const { return dynamic_cast<MeshType&>(mesh_); }

        MeshT& getMesh() const { return dynamic_cast<MeshT&>(mesh_); }
290

291
292
293
        /**
         * Move constructor. Transfers ownership (delete responsibility).
         */
Max Lyon's avatar
Max Lyon committed
294
295
296
297
298
299
300
301
302
        PropertyManager(PropertyManager &&rhs)
          :
            mesh_(rhs.mesh_),
            prop_(rhs.prop_),
            retain_(rhs.retain_),
            name_(rhs.name_)
        {
          if (!rhs.retain_)
            rhs.prop_.invalidate(); // only invalidate unnamed properties
303
304
305
306
307
        }

        /**
         * Move assignment. Transfers ownership (delete responsibility).
         */
Max Lyon's avatar
Max Lyon committed
308
309
310
311
312
313
314
        PropertyManager& operator=(PropertyManager&& rhs)
        {
            if ((&mesh_ != &rhs.mesh_) || (prop_ != rhs.prop_))
            {
              if (rhs.retain_)
              {
                // retained properties cannot be invalidated. Copy instead
315
                Storage::copy(rhs, *this);
Max Lyon's avatar
Max Lyon committed
316
317
318
319
              }
              else
              {
                // switch the data stored in the properties
320
                Storage::swap(rhs, *this);
Max Lyon's avatar
Max Lyon committed
321
322
323
324
325
                // remove the property from rhs
                rhs.mesh_.remove_property(rhs.prop_);
                // invalidate prop_
                rhs.prop_.invalidate();
              }
326
            }
327
328
            return *this;
        }
329
330
331
332
333

        /**
         * Create a property manager for the supplied property and mesh.
         * If the property doesn't exist, it is created. In any case,
         * lifecycle management is disabled.
334
335
         *
         * @see makePropertyManagerFromExistingOrNew
336
         */
337
        static PropertyManager createIfNotExists(PolyConnectivity &mesh, const char *propname) {
Max Lyon's avatar
Max Lyon committed
338
            return PropertyManager(mesh, propname);
339
        }
340

341
342
343
344
345
346
347
348
349
350
        /**
         * Like createIfNotExists() with two parameters except, if the property
         * doesn't exist, it is initialized with the supplied value over
         * the supplied range after creation. If the property already exists,
         * this method has the exact same effect as the two parameter version.
         * Lifecycle management is disabled in any case.
         *
         * @see makePropertyManagerFromExistingOrNew
         */
        template<typename PROP_VALUE, typename ITERATOR_TYPE>
351
        static PropertyManager createIfNotExists(PolyConnectivity &mesh, const char *propname,
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
                const ITERATOR_TYPE &begin, const ITERATOR_TYPE &end,
                const PROP_VALUE &init_value) {
            const bool exists = propertyExists(mesh, propname);
            PropertyManager pm(mesh, propname, exists);
            pm.retain();
            if (!exists)
                pm.set_range(begin, end, init_value);
            return std::move(pm);
        }

        /**
         * Like createIfNotExists() with two parameters except, if the property
         * doesn't exist, it is initialized with the supplied value over
         * the supplied range after creation. If the property already exists,
         * this method has the exact same effect as the two parameter version.
         * Lifecycle management is disabled in any case.
         *
         * @see makePropertyManagerFromExistingOrNew
         */
        template<typename PROP_VALUE, typename ITERATOR_RANGE>
372
        static PropertyManager createIfNotExists(PolyConnectivity &mesh, const char *propname,
373
374
375
376
                const ITERATOR_RANGE &range, const PROP_VALUE &init_value) {
            return createIfNotExists(
                    mesh, propname, range.begin(), range.end(), init_value);
        }
377
378

        PropertyManager duplicate(const char *clone_name) {
Max Lyon's avatar
Max Lyon committed
379
380
            PropertyManager pm(mesh_, clone_name, false);
            pm.mesh_.property(pm.prop_) = mesh_.property(prop_);
381
            return pm;
382
383
        }

384
385
386
387
388
389
390
        /**
         * Included for backwards compatibility with non-C++11 version.
         */
        PropertyManager move() {
            return std::move(*this);
        }

391
        /**
392
393
394
395
396
397
398
399
400
401
         * Access the value of the encapsulated mesh property.
         *
         * Example:
         * @code
         * PolyMesh m;
         * auto description = getOrMakeProperty<void, std::string>(m, "description");
         * *description = "This is a very nice mesh.";
         * @endcode
         *
         * @note This method is only used for mesh properties.
402
         */
403
        typename PROPTYPE::reference& operator*() {
Max Lyon's avatar
Max Lyon committed
404
            return mesh_.mproperty(prop_)[0];
405
406
407
        }

        /**
408
409
410
411
412
413
414
415
416
417
         * Access the value of the encapsulated mesh property.
         *
         * Example:
         * @code
         * PolyMesh m;
         * auto description = getProperty<void, std::string>(m, "description");
         * std::cout << *description << std::endl;
         * @endcode
         *
         * @note This method is only used for mesh properties.
418
         */
419
        typename PROPTYPE::const_reference& operator*() const {
Max Lyon's avatar
Max Lyon committed
420
            return mesh_.mproperty(prop_)[0];
421
422
423
424
425
426
427
428
429
430
431
        }

        /**
         * Enables convenient access to the encapsulated property.
         *
         * For a usage example see this class' documentation.
         *
         * @param handle A handle of the appropriate handle type. (I.e. \p VertexHandle for \p VPropHandleT, etc.)
         */
        template<typename HandleType>
        inline typename PROPTYPE::reference operator[] (const HandleType &handle) {
Max Lyon's avatar
Max Lyon committed
432
            return mesh_.property(prop_, handle);
433
434
435
436
437
438
439
440
441
442
443
        }

        /**
         * Enables convenient access to the encapsulated property.
         *
         * For a usage example see this class' documentation.
         *
         * @param handle A handle of the appropriate handle type. (I.e. \p VertexHandle for \p VPropHandleT, etc.)
         */
        template<typename HandleType>
        inline typename PROPTYPE::const_reference operator[] (const HandleType &handle) const {
Max Lyon's avatar
Max Lyon committed
444
            return mesh_.property(prop_, handle);
445
446
        }

447
448
449
450
451
452
        /**
         * Conveniently set the property for an entire range of values.
         *
         * Examples:
         * \code
         * MeshT mesh;
453
         * PropertyManager<VPropHandleT<double>> distance(
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
         *     mesh, "distance.plugin-example.i8.informatik.rwth-aachen.de");
         * distance.set_range(
         *     mesh.vertices_begin(), mesh.vertices_end(),
         *     std::numeric_limits<double>::infinity());
         * \endcode
         * or
         * \code
         * MeshT::VertexHandle vh;
         * distance.set_range(
         *     mesh.vv_begin(vh), mesh.vv_end(vh),
         *     std::numeric_limits<double>::infinity());
         * \endcode
         *
         * @param begin Start iterator. Needs to dereference to HandleType.
         * @param end End iterator. (Exclusive.)
         * @param value The value the range will be set to.
         */
471
        template<typename HandleTypeIterator, typename PROP_VALUE>
472
        void set_range(HandleTypeIterator begin, HandleTypeIterator end,
473
                const PROP_VALUE &value) {
474
475
476
477
            for (; begin != end; ++begin)
                (*this)[*begin] = value;
        }

478
#if (defined(_MSC_VER) && (_MSC_VER >= 1800)) || __cplusplus > 199711L || defined(__GXX_EXPERIMENTAL_CXX0X__)
479
        template<typename HandleTypeIteratorRange, typename PROP_VALUE>
480
        void set_range(const HandleTypeIteratorRange &range,
481
482
483
484
485
                const PROP_VALUE &value) {
            set_range(range.begin(), range.end(), value);
        }
#endif

486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
        /**
         * Conveniently transfer the values managed by one property manager
         * onto the values managed by a different property manager.
         *
         * @param begin Start iterator. Needs to dereference to HandleType. Will
         * be used with this property manager.
         * @param end End iterator. (Exclusive.) Will be used with this property
         * manager.
         * @param dst_propmanager The destination property manager.
         * @param dst_begin Start iterator. Needs to dereference to the
         * HandleType of dst_propmanager. Will be used with dst_propmanager.
         * @param dst_end End iterator. (Exclusive.)
         * Will be used with dst_propmanager. Used to double check the bounds.
         */
        template<typename HandleTypeIterator, typename PROPTYPE_2,
501
                 typename HandleTypeIterator_2>
502
        void copy_to(HandleTypeIterator begin, HandleTypeIterator end,
503
                PropertyManager<PROPTYPE_2> &dst_propmanager,
504
505
506
                HandleTypeIterator_2 dst_begin, HandleTypeIterator_2 dst_end) const {

            for (; begin != end && dst_begin != dst_end; ++begin, ++dst_begin) {
507
                dst_propmanager[*dst_begin] = (*this)[*begin];
508
509
510
511
            }
        }

        template<typename RangeType, typename PROPTYPE_2,
512
                 typename RangeType_2>
513
        void copy_to(const RangeType &range,
514
                PropertyManager<PROPTYPE_2> &dst_propmanager,
515
                const RangeType_2 &dst_range) const {
516
517
518
519
            copy_to(range.begin(), range.end(), dst_propmanager,
                    dst_range.begin(), dst_range.end());
        }

520

521
522
523
524
525
526
527
528
529
530
531
532
533
534
        /**
         * Copy the values of a property from a source range to
         * a target range. The source range must not be smaller than the
         * target range.
         *
         * @param prop_name Name of the property to copy. Must exist on the
         * source mesh. Will be created on the target mesh if it doesn't exist.
         *
         * @param src_mesh Source mesh from which to copy.
         * @param src_range Source range which to copy. Must not be smaller than
         * dst_range.
         * @param dst_mesh Destination mesh on which to copy.
         * @param dst_range Destination range.
         */
535
        template<typename RangeType, typename RangeType_2>
536
        static void copy(const char *prop_name,
537
538
                PolyConnectivity &src_mesh, const RangeType &src_range,
                PolyConnectivity &dst_mesh, const RangeType_2 &dst_range) {
539

540
            typedef OpenMesh::PropertyManager<PROPTYPE> DstPM;
541
542
            DstPM dst(DstPM::createIfNotExists(dst_mesh, prop_name));

543
            typedef OpenMesh::PropertyManager<PROPTYPE> SrcPM;
544
545
546
547
548
            SrcPM src(src_mesh, prop_name, true);

            src.copy_to(src_range, dst, dst_range);
        }

549
550
    private:
        void deleteProperty() {
Max Lyon's avatar
Max Lyon committed
551
552
            if (!retain_ && prop_.is_valid())
                mesh_.remove_property(prop_);
553
554
555
        }

    private:
Max Lyon's avatar
Max Lyon committed
556
        PolyConnectivity& mesh_;
557
558
        PROPTYPE prop_;
        bool retain_;
559
        std::string name_;
560
561
};

562
/** @relates PropertyManager
563
564
 *
 * @deprecated Temporary properties should not have a name.
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 *
 * Creates a new property whose lifetime is limited to the current scope.
 *
 * Used for temporary properties. Shadows any existing properties of
 * matching name and type.
 *
 * Example:
 * @code
 * PolyMesh m;
 * {
 *     auto is_quad = makeTemporaryProperty<FaceHandle, bool>(m);
 *     for (auto& fh : m.faces()) {
 *         is_quad[fh] = (m.valence(fh) == 4);
 *     }
 *     // The property is automatically removed from the mesh at the end of the scope.
 * }
 * @endcode
 *
 * @param mesh The mesh on which the property is created
 * @param propname (optional) The name of the created property
 * @tparam ElementT Element type of the created property, e.g. VertexHandle, HalfedgeHandle, etc.
 * @tparam T Value type of the created property, e.g., \p double, \p int, etc.
 * @returns A PropertyManager handling the lifecycle of the property
 */
589
590
template<typename ElementT, typename T>
PropertyManager<typename HandleToPropHandle<ElementT, T>::type>
591
592
OM_DEPRECATED("Named temporary properties are deprecated. Either create a temporary without name or a non-temporary with name")
makeTemporaryProperty(PolyConnectivity &mesh, const char *propname) {
593
    return PropertyManager<typename HandleToPropHandle<ElementT, T>::type>(mesh, propname, false);
594
595
}

596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
/** @relates PropertyManager
 *
 * Creates a new property whose lifetime is limited to the current scope.
 *
 * Used for temporary properties. Shadows any existing properties of
 * matching name and type.
 *
 * Example:
 * @code
 * PolyMesh m;
 * {
 *     auto is_quad = makeTemporaryProperty<FaceHandle, bool>(m);
 *     for (auto& fh : m.faces()) {
 *         is_quad[fh] = (m.valence(fh) == 4);
 *     }
 *     // The property is automatically removed from the mesh at the end of the scope.
 * }
 * @endcode
 *
 * @param mesh The mesh on which the property is created
 * @tparam ElementT Element type of the created property, e.g. VertexHandle, HalfedgeHandle, etc.
 * @tparam T Value type of the created property, e.g., \p double, \p int, etc.
 * @returns A PropertyManager handling the lifecycle of the property
 */
template<typename ElementT, typename T>
PropertyManager<typename HandleToPropHandle<ElementT, T>::type>
makeTemporaryProperty(PolyConnectivity &mesh) {
    return PropertyManager<typename HandleToPropHandle<ElementT, T>::type>(mesh);
}
Max Lyon's avatar
Max Lyon committed
625
626


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
/** @relates PropertyManager
 *
 * Tests whether a property with the given element type, value type, and name is
 * present on the given mesh.
 *
 * * Example:
 * @code
 * PolyMesh m;
 * if (hasProperty<FaceHandle, bool>(m, "is_quad")) {
 *     // We now know the property exists: getProperty won't throw.
 *     auto is_quad = getProperty<FaceHandle, bool>(m, "is_quad");
 *     // Use is_quad here.
 * }
 * @endcode
 *
 * @param mesh The mesh in question
 * @param propname The property name of the expected property
 * @tparam ElementT Element type of the expected property, e.g. VertexHandle, HalfedgeHandle, etc.
 * @tparam T Value type of the expected property, e.g., \p double, \p int, etc.
 * @tparam MeshT Type of the mesh. Can often be inferred from \p mesh
 */
template<typename ElementT, typename T>
bool
hasProperty(const PolyConnectivity &mesh, const char *propname) {
    typename HandleToPropHandle<ElementT, T>::type ph;
    return mesh.get_property_handle(ph, propname);
}
Max Lyon's avatar
Max Lyon committed
654

655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
/** @relates PropertyManager
 *
 * Obtains a handle to a named property.
 *
 * Example:
 * @code
 * PolyMesh m;
 * {
 *     try {
 *         auto is_quad = getProperty<FaceHandle, bool>(m, "is_quad");
 *         // Use is_quad here.
 *     }
 *     catch (const std::runtime_error& e) {
 *         // There is no is_quad face property on the mesh.
 *     }
 * }
 * @endcode
 *
 * @pre Property with the name \p propname of matching type exists.
 * @throws std::runtime_error if no property with the name \p propname of
 * matching type exists.
 * @param mesh The mesh on which the property is created
 * @param propname The name of the created property
 * @tparam ElementT Element type of the created property, e.g. VertexHandle, HalfedgeHandle, etc.
 * @tparam T Value type of the created property, e.g., \p double, \p int, etc.
 * @returns A PropertyManager wrapping the property
 */
682
683
684
template<typename ElementT, typename T>
PropertyManager<typename HandleToPropHandle<ElementT, T>::type>
getProperty(PolyConnectivity &mesh, const char *propname) {
685
686
687
688
689
690
691
  if (!hasProperty<ElementT, T>(mesh, propname))
  {
    std::ostringstream oss;
    oss << "Requested property handle \"" << propname << "\" does not exist.";
    throw std::runtime_error(oss.str());
  }
  return PropertyManager<typename HandleToPropHandle<ElementT, T>::type>(mesh, propname);
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
}

/** @relates PropertyManager
 *
 * Obtains a handle to a named property if it exists or creates a new one otherwise.
 *
 * Used for creating or accessing permanent properties.
 *
 * Example:
 * @code
 * PolyMesh m;
 * {
 *     auto is_quad = getOrMakeProperty<FaceHandle, bool>(m, "is_quad");
 *     for (auto& fh : m.faces()) {
 *         is_quad[fh] = (m.valence(fh) == 4);
 *     }
 *     // The property remains on the mesh after the end of the scope.
 * }
 * {
 *     // Retrieve the property from the previous scope.
 *     auto is_quad = getOrMakeProperty<FaceHandle, bool>(m, "is_quad");
 *     // Use is_quad here.
 * }
 * @endcode
 *
 * @param mesh The mesh on which the property is created
 * @param propname The name of the created property
 * @tparam ElementT Element type of the created property, e.g. VertexHandle, HalfedgeHandle, etc.
 * @tparam T Value type of the created property, e.g., \p double, \p int, etc.
 * @returns A PropertyManager wrapping the property
 */
723
724
725
726
template<typename ElementT, typename T>
PropertyManager<typename HandleToPropHandle<ElementT, T>::type>
getOrMakeProperty(PolyConnectivity &mesh, const char *propname) {
    return PropertyManager<typename HandleToPropHandle<ElementT, T>::type>::createIfNotExists(mesh, propname);
727
728
729
730
731
}

/** @relates PropertyManager
 * @deprecated Use makeTemporaryProperty() instead.
 *
732
733
734
 * Creates a new property whose lifecycle is managed by the returned
 * PropertyManager.
 *
735
 * Intended for temporary properties. Shadows any existing properties of
736
737
 * matching name and type.
 */
738
template<typename PROPTYPE>
739
OM_DEPRECATED("Use makeTemporaryProperty instead.")
740
PropertyManager<PROPTYPE> makePropertyManagerFromNew(PolyConnectivity &mesh, const char *propname)
741
{
742
    return PropertyManager<PROPTYPE>(mesh, propname, false);
743
744
}

745
/** \relates PropertyManager
746
747
 * @deprecated Use getProperty() instead.
 *
748
749
750
751
752
753
754
755
756
 * Creates a non-owning wrapper for an existing mesh property (no lifecycle
 * management).
 *
 * Intended for convenient access.
 *
 * @pre Property with the name \p propname of matching type exists.
 * @throws std::runtime_error if no property with the name \p propname of
 * matching type exists.
 */
757
template<typename PROPTYPE>
758
OM_DEPRECATED("Use getProperty instead.")
759
PropertyManager<PROPTYPE> makePropertyManagerFromExisting(PolyConnectivity &mesh, const char *propname)
760
{
761
    return PropertyManager<PROPTYPE>(mesh, propname, true);
762
763
}

764
765
766
/** @relates PropertyManager
 * @deprecated Use getOrMakeProperty() instead.
 *
767
768
769
770
771
 * Creates a non-owning wrapper for a mesh property (no lifecycle management).
 * If the given property does not exist, it is created.
 *
 * Intended for creating or accessing persistent properties.
 */
772
template<typename PROPTYPE>
773
OM_DEPRECATED("Use getOrMakeProperty instead.")
774
PropertyManager<PROPTYPE> makePropertyManagerFromExistingOrNew(PolyConnectivity &mesh, const char *propname)
775
{
776
    return PropertyManager<PROPTYPE>::createIfNotExists(mesh, propname);
777
778
}

779
/** @relates PropertyManager
780
781
782
783
784
785
786
787
788
789
 * Like the two parameter version of makePropertyManagerFromExistingOrNew()
 * except it initializes the property with the specified value over the
 * specified range if it needs to be created. If the property already exists,
 * this function has the exact same effect as the two parameter version.
 *
 * Creates a non-owning wrapper for a mesh property (no lifecycle management).
 * If the given property does not exist, it is created.
 *
 * Intended for creating or accessing persistent properties.
 */
Max Lyon's avatar
Max Lyon committed
790
template<typename PROPTYPE,
791
    typename ITERATOR_TYPE, typename PROP_VALUE>
792
OM_DEPRECATED("Use getOrMakeProperty instead.")
Max Lyon's avatar
Max Lyon committed
793
794
PropertyManager<PROPTYPE> makePropertyManagerFromExistingOrNew(
        PolyConnectivity &mesh, const char *propname,
795
796
        const ITERATOR_TYPE &begin, const ITERATOR_TYPE &end,
        const PROP_VALUE &init_value) {
Max Lyon's avatar
Max Lyon committed
797
    return PropertyManager<PROPTYPE>::createIfNotExists(
798
799
800
            mesh, propname, begin, end, init_value);
}

801
/** @relates PropertyManager
802
803
804
805
806
807
808
809
810
811
 * Like the two parameter version of makePropertyManagerFromExistingOrNew()
 * except it initializes the property with the specified value over the
 * specified range if it needs to be created. If the property already exists,
 * this function has the exact same effect as the two parameter version.
 *
 * Creates a non-owning wrapper for a mesh property (no lifecycle management).
 * If the given property does not exist, it is created.
 *
 * Intended for creating or accessing persistent properties.
 */
812
template<typename PROPTYPE,
813
    typename ITERATOR_RANGE, typename PROP_VALUE>
814
OM_DEPRECATED("Use getOrMakeProperty instead.")
815
816
PropertyManager<PROPTYPE> makePropertyManagerFromExistingOrNew(
        PolyConnectivity &mesh, const char *propname,
817
818
        const ITERATOR_RANGE &range,
        const PROP_VALUE &init_value) {
819
    return makePropertyManagerFromExistingOrNew<PROPTYPE>(
820
821
822
            mesh, propname, range.begin(), range.end(), init_value);
}

Max Lyon's avatar
Max Lyon committed
823
824
825
826
827
828
829
830
831
832

/** @relates PropertyManager
 * Returns a convenience wrapper around the points property of a mesh.
 */
template<typename MeshT>
PropertyManager<OpenMesh::VPropHandleT<typename MeshT::Point>>
getPointsProperty(MeshT &mesh) {
  return PropertyManager<OpenMesh::VPropHandleT<typename MeshT::Point>>(mesh, mesh.points_property_handle());
}

833
834
template <typename HandleT, typename T>
using Prop = PropertyManager<typename PropHandle<HandleT>::template type<T>>;
Max Lyon's avatar
Max Lyon committed
835
836
837
838
839
840
841
842
843
844
845
846
847

template <typename T>
using VProp = PropertyManager<OpenMesh::VPropHandleT<T>>;

template <typename T>
using HProp = PropertyManager<OpenMesh::HPropHandleT<T>>;

template <typename T>
using EProp = PropertyManager<OpenMesh::EPropHandleT<T>>;

template <typename T>
using FProp = PropertyManager<OpenMesh::FPropHandleT<T>>;

848
849
850
template <typename T>
using MProp = PropertyManager<OpenMesh::MPropHandleT<T>>;

Max Lyon's avatar
Max Lyon committed
851

852
853
} /* namespace OpenMesh */
#endif /* PROPERTYMANAGER_HH_ */