OpenVolumeMeshProperty.hh 14.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
/*===========================================================================*\
 *                                                                           *
 *                            OpenVolumeMesh                                 *
 *        Copyright (C) 2011 by Computer Graphics Group, RWTH Aachen         *
 *                        www.openvolumemesh.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenVolumeMesh.                                     *
 *                                                                           *
 *  OpenVolumeMesh is free software: you can redistribute it and/or modify   *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenVolumeMesh is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenVolumeMesh.  If not,                              *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

35
#pragma once
36 37 38 39

//== INCLUDES =================================================================

#include <cassert>
40 41 42 43 44
#include <istream>
#include <ostream>
#include <numeric>
#include <string>
#include <vector>
45 46 47

#include "OpenVolumeMeshBaseProperty.hh"

48 49
#include "Serializers.hh"

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
namespace OpenVolumeMesh {

//== CLASS DEFINITION =========================================================

/** \class OpenVolumeMeshPropertyT
 *
 *  \brief Default property class for any type T.
 *
 *  The default property class for any type T.
 */

template<class T>
class OpenVolumeMeshPropertyT: public OpenVolumeMeshBaseProperty {
public:

65 66
    template <class PropT, class HandleT> friend class PropertyPtr;

67 68 69 70 71 72 73 74 75
	typedef T 										Value;
	typedef std::vector<T> 				            vector_type;
	typedef T 										value_type;
	typedef typename vector_type::reference 		reference;
	typedef typename vector_type::const_reference 	const_reference;

public:

	/// Default constructor
76 77 78
	OpenVolumeMeshPropertyT(const std::string& _name = "<unknown>", const T _def = T()) :
		OpenVolumeMeshBaseProperty(_name),
		def_(_def) {
79 80 81 82
	}

	/// Copy constructor
	OpenVolumeMeshPropertyT(const OpenVolumeMeshPropertyT& _rhs) :
83 84 85
		OpenVolumeMeshBaseProperty(_rhs),
		data_(_rhs.data_),
		def_(_rhs.def_) {
86 87 88 89 90 91 92 93
	}

public:
	// inherited from OpenVolumeMeshBaseProperty
	virtual void reserve(size_t _n) {
		data_.reserve(_n);
	}
	virtual void resize(size_t _n) {
94
                data_.resize(_n, def_);
95 96 97 98 99 100
	}
	virtual void clear() {
		data_.clear();
		vector_type().swap(data_);
	}
	virtual void push_back() {
101
		data_.push_back(def_);
102 103 104 105
	}
	virtual void swap(size_t _i0, size_t _i1) {
		std::swap(data_[_i0], data_[_i1]);
	}
106 107 108 109 110 111
	virtual void copy(size_t _src_idx, size_t _dst_idx) {
		data_[_dst_idx] = data_[_src_idx];
	}
	void delete_element(size_t _idx) {
		data_.erase(data_.begin() + _idx);
	}
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132

public:

	virtual size_t n_elements() const {
		return data_.size();
	}
	virtual size_t element_size() const {
		return sizeof(T);
	}

#ifndef DOXY_IGNORE_THIS
	struct plus {
		size_t operator ()(size_t _b, const T& /*_v*/) {
			return _b + sizeof(T);
		}
	};
#endif

	virtual size_t size_of() const {
		if (element_size() != OpenVolumeMeshBaseProperty::UnknownSize)
			return this->OpenVolumeMeshBaseProperty::size_of(n_elements());
Max Lyon's avatar
Max Lyon committed
133
    return std::accumulate(data_.begin(), data_.end(), size_t(0), plus());
134 135 136 137 138 139 140
	}

	virtual size_t size_of(size_t _n_elem) const {
		return this->OpenVolumeMeshBaseProperty::size_of(_n_elem);
	}

	// Function to serialize a property
141
    virtual void serialize(std::ostream& _ostr) const {
142 143
        for(typename vector_type::const_iterator it = data_.begin();
                it != data_.end(); ++it) {
144
            OpenVolumeMesh::serialize(_ostr, *it) << std::endl;
145 146 147
        }
    }

Mike Kremer's avatar
Mike Kremer committed
148
    // Function to deserialize a property
149
    virtual void deserialize(std::istream& _istr) {
Mike Kremer's avatar
Mike Kremer committed
150
        for(unsigned int i = 0; i < n_elements(); ++i) {
151
            OpenVolumeMesh::deserialize(_istr, data_[i]);
Mike Kremer's avatar
Mike Kremer committed
152 153 154
        }
    }

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
public:
	// data access interface

	/// Get pointer to array (does not work for T==bool)
	const T* data() const {

		if (data_.empty())
			return 0;

		return &data_[0];
	}

	/// Get reference to property vector (be careful, improper usage, e.g. resizing, may crash)
	vector_type& data_vector() {

		return data_;
	}

	/// Access the i'th element. No range check is performed!
Max Lyon's avatar
Max Lyon committed
174 175
  reference operator[](size_t _idx) {
    assert(_idx < data_.size());
176 177 178 179
		return data_[_idx];
	}

	/// Const access to the i'th element. No range check is performed!
Max Lyon's avatar
Max Lyon committed
180 181
  const_reference operator[](size_t _idx) const {
    assert(_idx < data_.size());
182 183 184 185 186
		return data_[_idx];
	}

	/// Make a copy of self.
	OpenVolumeMeshPropertyT<T>* clone() const {
187
		OpenVolumeMeshPropertyT<T>* p = new OpenVolumeMeshPropertyT<T>(*this);
188 189 190
		return p;
	}

191 192 193 194 195 196 197 198
	typename vector_type::const_iterator begin() const { return data_.begin(); }

	typename vector_type::iterator begin() { return data_.begin(); }

	typename vector_type::const_iterator end() const { return data_.end(); }

    typename vector_type::iterator end() { return data_.end(); }

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
protected:

    /// Delete multiple entries in list
    virtual void delete_multiple_entries(const std::vector<bool>& _tags) {

        assert(_tags.size() == data_.size());
        vector_type new_data;
        typename vector_type::iterator d_it = data_.begin();
        std::vector<bool>::const_iterator t_it = _tags.begin();
        std::vector<bool>::const_iterator t_end = _tags.end();
        for(; t_it != t_end; ++t_it, ++d_it) {
            if(!*t_it) {
                new_data.push_back(*d_it);
            }
        }
        data_.swap(new_data);
    }

217 218 219
private:

	vector_type data_;
220 221

	const T def_;
222 223 224 225 226
};

//-----------------------------------------------------------------------------


Mike Kremer's avatar
Mike Kremer committed
227 228
/**
 * Property specialization for bool type.
229 230 231 232 233
 */
template<>
class OpenVolumeMeshPropertyT<bool> : public OpenVolumeMeshBaseProperty {
public:

234 235
    template <class PropT, class HandleT> friend class PropertyPtr;

236 237 238 239
    typedef std::vector<bool> 				vector_type;
    typedef bool 							value_type;
    typedef vector_type::reference 			reference;
    typedef vector_type::const_reference 	const_reference;
240 241 242

public:

243 244 245 246
    OpenVolumeMeshPropertyT(const std::string& _name = "<unknown>", const bool _def = bool()) :
        OpenVolumeMeshBaseProperty(_name),
        def_(_def) {
    }
247 248

public:
249
    // inherited from OpenVolumeMeshBaseProperty
250

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
    virtual void reserve(size_t _n) {
        data_.reserve(_n);
    }
    virtual void resize(size_t _n) {
        data_.resize(_n, def_);
    }
    virtual void clear() {
        data_.clear();
        vector_type().swap(data_);
    }
    virtual void push_back() {
        data_.push_back(def_);
    }
    virtual void swap(size_t _i0, size_t _i1) {
        bool t(data_[_i0]);
        data_[_i0] = data_[_i1];
        data_[_i1] = t;
    }
269 270 271
    virtual void copy(size_t _src_idx, size_t _dst_idx) {
        data_[_dst_idx] = data_[_src_idx];
    }
272

273
    void delete_element(size_t _idx) {
274 275 276 277 278
        data_.erase(data_.begin() + _idx);
    }

public:

279 280 281 282 283 284 285 286 287 288 289 290
    virtual size_t n_elements() const {
        return data_.size();
    }
    virtual size_t element_size() const {
        return OpenVolumeMeshBaseProperty::UnknownSize;
    }
    virtual size_t size_of() const {
        return size_of(n_elements());
    }
    virtual size_t size_of(size_t _n_elem) const {
        return _n_elem / 8 + ((_n_elem % 8) != 0);
    }
291

292 293 294 295 296
    // Function to serialize a property
    virtual void serialize(std::ostream& _ostr) const {
        for(vector_type::const_iterator it = data_.begin();
                it != data_.end(); ++it) {
            OpenVolumeMesh::serialize(_ostr, *it) << std::endl;
297
        }
298
    }
299

300 301 302 303 304 305
    // Function to deserialize a property
    virtual void deserialize(std::istream& _istr) {
        for(unsigned int i = 0; i < n_elements(); ++i) {
            value_type val;
            OpenVolumeMesh::deserialize(_istr, val);
            data_[i] = val;
306
        }
307
    }
308

309 310
public:

311
    /// Access the i'th element. No range check is performed!
Max Lyon's avatar
Max Lyon committed
312 313
    reference operator[](size_t _idx) {
        assert(_idx < data_.size());
314 315
        return data_[_idx];
    }
316

317
    /// Const access to the i'th element. No range check is performed!
Max Lyon's avatar
Max Lyon committed
318 319
    const_reference operator[](size_t _idx) const {
        assert(_idx < data_.size());
320 321
        return data_[_idx];
    }
322

323 324 325 326 327 328
    /// Make a copy of self.
    OpenVolumeMeshPropertyT<bool>* clone() const {
        OpenVolumeMeshPropertyT<bool>* p = new OpenVolumeMeshPropertyT<bool> (
                *this);
        return p;
    }
329

330
    vector_type::const_iterator begin() const { return data_.begin(); }
331 332 333 334 335 336 337

    vector_type::iterator begin() { return data_.begin(); }

    vector_type::const_iterator end() const { return data_.end(); }

    vector_type::iterator end() { return data_.end(); }

338 339 340 341 342 343 344
protected:

    /// Delete multiple entries in list
    virtual void delete_multiple_entries(const std::vector<bool>& _tags) {

        assert(_tags.size() == data_.size());
        vector_type new_data;
345
        vector_type::iterator d_it = data_.begin();
346 347 348 349 350 351 352 353 354 355
        std::vector<bool>::const_iterator t_it = _tags.begin();
        std::vector<bool>::const_iterator t_end = _tags.end();
        for(; t_it != t_end; ++t_it, ++d_it) {
            if(!*t_it) {
                new_data.push_back(*d_it);
            }
        }
        data_.swap(new_data);
    }

356 357
private:

358
    vector_type data_;
359

360
    const bool def_;
361 362 363 364 365
};

//-----------------------------------------------------------------------------


Mike Kremer's avatar
Mike Kremer committed
366 367
/**
 * Property specialization for std::string type.
368 369 370 371 372
 */
template<>
class OpenVolumeMeshPropertyT<std::string> : public OpenVolumeMeshBaseProperty {
public:

373 374
    template <class PropT, class HandleT> friend class PropertyPtr;

375 376 377 378 379
    typedef std::string 					Value;
    typedef std::vector<std::string> 		vector_type;
    typedef std::string 					value_type;
    typedef vector_type::reference 			reference;
    typedef vector_type::const_reference 	const_reference;
380 381 382

public:

383 384 385 386
    OpenVolumeMeshPropertyT(const std::string& _name = "<unknown>", const std::string& _def = "") :
        OpenVolumeMeshBaseProperty(_name),
        def_(_def) {
    }
387 388

public:
389
    // inherited from OpenVolumeMeshBaseProperty
390

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
    virtual void reserve(size_t _n) {
        data_.reserve(_n);
    }
    virtual void resize(size_t _n) {
        data_.resize(_n, def_);
    }
    virtual void clear() {
        data_.clear();
        vector_type().swap(data_);
    }
    virtual void push_back() {
        data_.push_back(def_);
    }
    virtual void swap(size_t _i0, size_t _i1) {
        std::swap(data_[_i0], data_[_i1]);
    }
407 408 409
    virtual void copy(size_t _src_idx, size_t _dst_idx) {
        data_[_dst_idx] = data_[_src_idx];
    }
410
    virtual void delete_element(size_t _idx) {
411 412 413 414 415
        data_.erase(data_.begin() + _idx);
    }

public:

416 417 418 419 420 421 422 423 424
    virtual size_t n_elements() const {
        return data_.size();
    }
    virtual size_t element_size() const {
        return OpenVolumeMeshBaseProperty::UnknownSize;
    }
    virtual size_t size_of() const {
        return sizeof(data_);
    }
425

426 427 428
    virtual size_t size_of(size_t /* _n_elem */) const {
        return OpenVolumeMeshBaseProperty::UnknownSize;
    }
429

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
    virtual void stats(std::ostream& _ostr) const {
        for(vector_type::const_iterator it = data_.begin();
            it != data_.end(); ++it) {
                _ostr << *it << " ";
        }
    }

    // Function to serialize a property
    virtual void serialize(std::ostream& _ostr) const {
        for(vector_type::const_iterator it = data_.begin();
                it != data_.end(); ++it) {
            OpenVolumeMesh::serialize(_ostr, *it) << std::endl;
        }
    }

    // Function to deserialize a property
    virtual void deserialize(std::istream& _istr) {
        for(unsigned int i = 0; i < n_elements(); ++i) {
            OpenVolumeMesh::deserialize(_istr, data_[i]);
        }
    }
451 452 453

public:

454 455 456
    const value_type* data() const {
        if (data_.empty())
            return 0;
457

458 459
        return (value_type*) &data_[0];
    }
460

461
    /// Access the i'th element. No range check is performed!
Max Lyon's avatar
Max Lyon committed
462 463
    reference operator[](size_t _idx) {
        assert(_idx < data_.size());
464 465
        return ((value_type*) &data_[0])[_idx];
    }
466

467
    /// Const access the i'th element. No range check is performed!
Max Lyon's avatar
Max Lyon committed
468 469
    const_reference operator[](size_t _idx) const {
        assert(_idx < data_.size());
470 471
        return ((value_type*) &data_[0])[_idx];
    }
472

473 474 475 476 477
    OpenVolumeMeshPropertyT<value_type>* clone() const {
        OpenVolumeMeshPropertyT<value_type>* p = new OpenVolumeMeshPropertyT<
                value_type> (*this);
        return p;
    }
478

479
    vector_type::const_iterator begin() const { return data_.begin(); }
480 481 482 483 484 485 486

    vector_type::iterator begin() { return data_.begin(); }

    vector_type::const_iterator end() const { return data_.end(); }

    vector_type::iterator end() { return data_.end(); }

487 488 489 490 491 492 493
protected:

    /// Delete multiple entries in list
    virtual void delete_multiple_entries(const std::vector<bool>& _tags) {

        assert(_tags.size() == data_.size());
        vector_type new_data;
494
        vector_type::iterator d_it = data_.begin();
495 496 497 498 499 500 501 502 503 504
        std::vector<bool>::const_iterator t_it = _tags.begin();
        std::vector<bool>::const_iterator t_end = _tags.end();
        for(; t_it != t_end; ++t_it, ++d_it) {
            if(!*t_it) {
                new_data.push_back(*d_it);
            }
        }
        data_.swap(new_data);
    }

505 506
private:

507
    vector_type data_;
508

509
    const std::string def_;
510 511 512 513
};

} // Namespace OpenVolumeMesh