adjacent_faces.h

/*****************************************************************************
 * VCLib                                                                     *
 * Visual Computing Library                                                  *
 *                                                                           *
 * Copyright(C) 2021-2025                                                    *
 * Visual Computing Lab                                                      *
 * ISTI - Italian National Research Council                                  *
 *                                                                           *
 * All rights reserved.                                                      *
 *                                                                           *
 * This program is free software; you can redistribute it and/or modify      *
 * it under the terms of the Mozilla Public License Version 2.0 as published *
 * by the Mozilla Foundation; either version 2 of the License, or            *
 * (at your option) any later version.                                       *
 *                                                                           *
 * This program 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              *
 * Mozilla Public License Version 2.0                                        *
 * (https://www.mozilla.org/en-US/MPL/2.0/) for more details.                *
 ****************************************************************************/
 
#ifndef VCL_MESH_COMPONENTS_ADJACENT_FACES_H
#define VCL_MESH_COMPONENTS_ADJACENT_FACES_H
 
#include "base/predicates.h"
#include "base/reference_container_component.h"
 
#include <vclib/base.h>
 
namespace vcl::comp {
 
template<
    bool STORE_INDICES,
    typename Face,
    int  N,
    bool TTVN,
    typename ParentElemType = void,
    bool VERT               = false,
    bool OPT                = false>
class AdjacentFaces :
        public ReferenceContainerComponent<
            STORE_INDICES,
            AdjacentFaces<
                STORE_INDICES,
                Face,
                N,
                TTVN,
                ParentElemType,
                VERT,
                OPT>,
            CompId::ADJACENT_FACES,
            Face,
            N,
            ParentElemType,
            VERT,
            OPT,
            TTVN>
{
    using Base = ReferenceContainerComponent<
        STORE_INDICES,
        AdjacentFaces<STORE_INDICES, Face, N, TTVN, ParentElemType, VERT, OPT>,
        CompId::ADJACENT_FACES,
        Face,
        N,
        ParentElemType,
        VERT,
        OPT,
        TTVN>;
 
public:
    using AdjacentFaceType = Face;
 
    /* Iterator Types declaration */
 
    using AdjacentFaceIterator           = Base::Iterator;
    using ConstAdjacentFaceIterator      = Base::ConstIterator;
    using ConstAdjacentFaceIndexIterator = Base::ConstIndexIterator;
 
    static const int ADJ_FACE_NUMBER = Base::SIZE;
 
    /* Constructors */
 
    AdjacentFaces() = default;
 
    /* Member functions */
 
    uint adjFacesNumber() const { return Base::size(); }
 
    Face* adjFace(uint i) { return Base::element(i); }
 
    const Face* adjFace(uint i) const { return Base::element(i); }
 
    uint adjFaceIndex(uint i) const { return Base::elementIndex(i); }
 
    Face* adjFaceMod(int i) { return Base::elementMod(i); }
 
    const Face* adjFaceMod(int i) const { return Base::elementMod(i); }
 
    uint adjFaceIndexMod(int i) const { return Base::elementIndexMod(i); }
 
    void setAdjFace(uint i, Face* f) { Base::setElement(i, f); }
 
    void setAdjFace(uint i, uint fi) { Base::setElement(i, fi); }
 
    void setAdjFace(ConstAdjacentFaceIterator it, Face* f)
    {
        Base::setElement(it, f);
    }
 
    void setAdjFace(ConstAdjacentFaceIterator it, uint fi)
    {
        Base::setElement(it, fi);
    }
 
    void setAdjFace(ConstAdjacentFaceIndexIterator it, Face* f)
    {
        Base::setElement(it, f);
    }
 
    void setAdjFace(ConstAdjacentFaceIndexIterator it, uint fi)
    {
        Base::setElement(it, fi);
    }
 
    void setAdjFaceMod(int i, Face* f) { Base::setElementMod(i, f); }
 
    void setAdjFaceMod(int i, uint fi) { Base::setElementMod(i, fi); }
 
    template<Range Rng>
    void setAdjFaces(Rng&& r) requires InputRange<Rng, Face*>
    {
        Base::setElements(r);
    }
 
    template<Range Rng>
    void setAdjFaces(Rng&& r) requires InputRange<Rng, uint>
    {
        Base::setElements(r);
    }
 
    bool containsAdjFace(const Face* f) const
    {
        return Base::containsElement(f);
    }
 
    bool containsAdjFace(uint fi) const { return Base::containsElement(fi); }
 
    uint indexOfAdjFace(const Face* f) const { return Base::indexOfElement(f); }
 
    uint indexOfAdjFace(uint fi) const { return Base::indexOfElement(fi); }
 
    /* Member functions specific for dynamic vector adjacent faces */
 
    void resizeAdjFaces(uint n) requires (N < 0 && !TTVN) { Base::resize(n); }
 
    void pushAdjFace(Face* f) requires (N < 0 && !TTVN) { Base::pushBack(f); }
 
    void pushAdjFace(uint fi) requires (N < 0 && !TTVN) { Base::pushBack(fi); }
 
    void insertAdjFace(uint i, Face* f) requires (N < 0 && !TTVN)
    {
        Base::insert(i, f);
    }
 
    void insertAdjFace(uint i, uint fi) requires (N < 0 && !TTVN)
    {
        Base::insert(i, fi);
    }
 
    void eraseAdjFace(uint i) requires (N < 0 && !TTVN) { Base::erase(i); }
 
    void clearAdjFaces() requires (N < 0 && !TTVN) { Base::clear(); }
 
    /* Iterator Member functions */
 
    AdjacentFaceIterator adjFaceBegin() { return Base::elementBegin(); }
 
    AdjacentFaceIterator adjFaceEnd() { return Base::elementEnd(); }
 
    ConstAdjacentFaceIterator adjFaceBegin() const
    {
        return Base::elementBegin();
    }
 
    ConstAdjacentFaceIterator adjFaceEnd() const { return Base::elementEnd(); }
 
    ConstAdjacentFaceIndexIterator adjFaceIndexBegin() const
    {
        return Base::elementIndexBegin();
    }
 
    ConstAdjacentFaceIndexIterator adjFaceIndexEnd() const
    {
        return Base::elementIndexEnd();
    }
 
    View<AdjacentFaceIterator> adjFaces() { return Base::elements(); }
 
    View<ConstAdjacentFaceIterator> adjFaces() const
    {
        return Base::elements();
    }
 
    View<ConstAdjacentFaceIndexIterator> adjFaceIndices() const
    {
        return Base::elementIndices();
    }
 
    // dummy member to discriminate between AdjacentFaces and
    // FaceHalfEdgePointers
    void __adjacentFaces() const {}
 
protected:
    // Component interface functions
    template<typename Element>
    void importFrom(const Element& e, bool importRefs = true);
 
    void serialize(std::ostream& os) const
    {
        // regardless of the type of the container (indices or pointers), the
        // serialization is always done using the indices
        if constexpr (N < 0) {
            vcl::serialize(os, adjFacesNumber());
        }
        for (uint i = 0; i < adjFacesNumber(); ++i) {
            vcl::serialize(os, adjFaceIndex(i));
        }
    }
 
    void deserialize(std::istream& is)
    {
        if constexpr (N < 0) {
            uint n;
            vcl::deserialize(is, n);
            Base::resize(n);
        }
        for (uint i = 0; i < adjFacesNumber(); ++i) {
            uint afi;
            vcl::deserialize(is, afi);
            setAdjFace(i, afi);
        }
    }
 
private:
    template<typename Element>
    void importIndicesFrom(const Element& e)
    {
        for (uint i = 0; i < e.adjFacesNumber(); ++i) {
            setAdjFace(i, e.adjFaceIndex(i));
        }
    }
};
 
/* concepts */
 
template<typename T>
concept HasAdjacentFaces =
    BTIBTBB::IsDerivedFromSpecializationOfV<T, AdjacentFaces>;
 
template<typename T>
concept HasOptionalAdjacentFaces =
    HasAdjacentFaces<T> &&
    IsOptionalComponent<typename RemoveRef<T>::AdjacentFaces>;
 
template<typename T>
concept HasRightNumberOfAdjacentFaces =
    !comp::IsTiedToVertexNumber<typename RemoveRef<T>::AdjacentFaces> ||
    RemoveRef<T>::VERTEX_NUMBER == RemoveRef<T>::ADJ_FACE_NUMBER;
 
template<typename T>
concept SanityCheckAdjacentFaces =
    !HasAdjacentFaces<T> || HasRightNumberOfAdjacentFaces<T>;
 
/* importFrom function */
 
template<
    bool STORE_INDICES,
    typename Face,
    int  N,
    bool TTVN,
    typename ParentElemType,
    bool VERT,
    bool OPT>
template<typename Element>
void AdjacentFaces<STORE_INDICES, Face, N, TTVN, ParentElemType, VERT, OPT>::
    importFrom(const Element& e, bool importRefs)
{
    if (importRefs) {
        if constexpr (HasAdjacentFaces<Element>) {
            if (isAdjacentFacesAvailableOn(e)) {
                if constexpr (N > 0) {
                    // same static size
                    if constexpr (N == Element::ADJ_FACE_NUMBER) {
                        importIndicesFrom(e);
                    }
                    // from dynamic to static, but dynamic size == static
                    // size
                    else if constexpr (Element::ADJ_FACE_NUMBER < 0) {
                        if (e.adjFacesNumber() == N) {
                            importIndicesFrom(e);
                        }
                    }
                    else {
                        // do not import in this case: cannot import from
                        // dynamic size != static size
                    }
                }
                else {
                    // from static/dynamic to dynamic size: need to resize
                    // first, then import
                    Base::resize(e.adjFacesNumber());
                    importIndicesFrom(e);
                }
            }
        }
    }
}
 
/* Detector function to check if a class has AdjacentFaces available */
 
bool isAdjacentFacesAvailableOn(const auto& element)
{
    return isComponentAvailableOn<CompId::ADJACENT_FACES>(element);
}
 
} // namespace vcl::comp
 
#endif // VCL_MESH_COMPONENTS_ADJACENT_FACES_H