OpenVolumeMeshHandle.hh

/*===========================================================================*\
 *                                                                           *
 *                            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/>.                                      *
 *                                                                           *
\*===========================================================================*/

#pragma once

#include <algorithm>
#include <iosfwd>
#include <vector>
#include <cassert>
#include <limits>

#include "Entities.hh"
#include "../System/FunctionalInclude.hh"
#include "../System/Deprecation.hh"
#include "OpenVolumeMesh/Config/Export.hh"

namespace OpenVolumeMesh {

// Define handle types in order to distinguish different entities by their indices
class OVM_EXPORT OpenVolumeMeshHandle {
public:
    // Default constructor
    explicit constexpr OpenVolumeMeshHandle(int _idx) : idx_(_idx) {}

        OpenVolumeMeshHandle& operator=(int _idx) {
                idx_ = _idx;
                return *this;
        }

    OpenVolumeMeshHandle(const OpenVolumeMeshHandle& _idx) = default;
    OpenVolumeMeshHandle& operator=(const OpenVolumeMeshHandle& _idx) = default;

        inline bool is_valid() const { return idx_ != -1; }

        inline bool operator<(const OpenVolumeMeshHandle& _idx) const { return (this->idx_ < _idx.idx_); }

        inline bool operator<(int _idx) const { return idx_ < _idx; }

        inline bool operator>(const OpenVolumeMeshHandle& _idx) const { return (this->idx_ > _idx.idx_); }

    inline bool operator>(int _idx) const { return idx_ > _idx; }

        inline bool operator==(const OpenVolumeMeshHandle& _h) const { return _h.idx_ == this->idx_; }

        inline bool operator!=(const OpenVolumeMeshHandle& _h) const { return _h.idx_ != this->idx_; }

        inline const int& idx() const { return idx_; }

    inline size_t uidx() const { assert(is_valid()); return static_cast<size_t>(idx_); }

        void idx(const int& _idx) { idx_ = _idx; }

#if OVM_ENABLE_DEPRECATED_APIS
    OVM_DEPRECATED("use explicit .idx() instead")
    inline operator int() const { return idx_; }
#endif

        void reset() { idx_ = -1; }

private:
        int idx_;
};

template<typename EntityTag,
    typename = typename std::enable_if<is_entity<EntityTag>::value>::type>
class PropHandleTag {};

template <typename T> struct is_prop_handle_tag : std::false_type {};
template<typename T>
struct is_prop_handle_tag<PropHandleTag<T>> : std::true_type {};

template<typename T>
using is_handle_tag = std::enable_if<is_entity<T>::value || is_prop_handle_tag<T>::value>;


template<typename EntityTag, typename = typename is_handle_tag<EntityTag>::type>
class HandleT : public OpenVolumeMeshHandle
{
public:
    using Entity = EntityTag;
    explicit constexpr HandleT(int _idx = -1) : OpenVolumeMeshHandle(_idx) {}

    static HandleT<EntityTag>
    from_unsigned(size_t _idx)
    {
        if (_idx <= static_cast<size_t>(std::numeric_limits<int>::max())) {
            return HandleT<EntityTag>(static_cast<int>(_idx));
        } else {
            assert(false);
            return HandleT<EntityTag>(-1);
        }
    }
};

// Default entity handles
//
template class OVM_EXPORT HandleT<Entity::Vertex>;
template class OVM_EXPORT HandleT<Entity::HalfEdge>;
template class OVM_EXPORT HandleT<Entity::Edge>;
template class OVM_EXPORT HandleT<Entity::HalfFace>;
template class OVM_EXPORT HandleT<Entity::Face>;
template class OVM_EXPORT HandleT<Entity::Cell>;
template class OVM_EXPORT HandleT<Entity::Mesh>;

using VertexHandle   = HandleT<Entity::Vertex>;
using HalfEdgeHandle = HandleT<Entity::HalfEdge>;
using EdgeHandle     = HandleT<Entity::Edge>;
using HalfFaceHandle = HandleT<Entity::HalfFace>;
using FaceHandle     = HandleT<Entity::Face>;
using CellHandle     = HandleT<Entity::Cell>;
using MeshHandle     = HandleT<Entity::Mesh>;

// Helper class that is used to decrease all handles
// exceeding a certain threshold

class VHandleCorrection {
public:
    explicit VHandleCorrection(VertexHandle _thld) : thld_(_thld) {}
    void correctValue(VertexHandle& _h) {
        if(_h > thld_) _h.idx(_h.idx() - 1);
    }
private:
    VertexHandle thld_;
};
class HEHandleCorrection {
public:
    explicit HEHandleCorrection(HalfEdgeHandle _thld) : thld_(_thld) {}
    void correctVecValue(std::vector<HalfEdgeHandle>& _vec) {
#if defined(__clang_major__) && (__clang_major__ >= 5)
        for(std::vector<HalfEdgeHandle>::iterator it = _vec.begin(), end = _vec.end(); it != end; ++it) {
            correctValue(*it);
        }
#else
        std::for_each(_vec.begin(), _vec.end(), fun::bind(&HEHandleCorrection::correctValue, this, fun::placeholders::_1));
#endif
    }
    void correctValue(HalfEdgeHandle& _h) {
        if(_h > thld_) _h.idx(_h.idx() - 2);
    }
private:
    HalfEdgeHandle thld_;
};
class HFHandleCorrection {
public:
    explicit HFHandleCorrection(HalfFaceHandle _thld) : thld_(_thld) {}
    void correctVecValue(std::vector<HalfFaceHandle>& _vec) {
#if defined(__clang_major__) && (__clang_major__ >= 5)
        for(std::vector<HalfFaceHandle>::iterator it = _vec.begin(), end = _vec.end(); it != end; ++it) {
            correctValue(*it);
        }
#else
        std::for_each(_vec.begin(), _vec.end(), fun::bind(&HFHandleCorrection::correctValue, this, fun::placeholders::_1));
#endif
    }
    void correctValue(HalfFaceHandle& _h) {
        if(_h > thld_) _h.idx(_h.idx() - 2);
    }
private:
    HalfFaceHandle thld_;
};
class CHandleCorrection {
public:
    explicit CHandleCorrection(CellHandle _thld) : thld_(_thld) {}
    void correctValue(CellHandle& _h) {
        if(_h > thld_) _h.idx(_h.idx() - 1);
    }
private:
    CellHandle thld_;
};

OVM_EXPORT
bool operator==(const int& _lhs, const OpenVolumeMeshHandle& _rhs);

OVM_EXPORT
bool operator==(const unsigned int& _lhs, const OpenVolumeMeshHandle& _rhs);

OVM_EXPORT
bool operator!=(const int& _lhs, const OpenVolumeMeshHandle& _rhs);

OVM_EXPORT
bool operator!=(const unsigned int& _lhs, const OpenVolumeMeshHandle& _rhs);

OVM_EXPORT
std::ostream& operator<<(std::ostream& _ostr, const OpenVolumeMeshHandle& _handle);

OVM_EXPORT
std::istream& operator>>(std::istream& _istr, OpenVolumeMeshHandle& _handle);

} // Namespace OpenVolumeMesh