mark.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_MARK_H
#define VCL_MESH_COMPONENTS_MARK_H
 
#include "base/component.h"
#include "base/predicates.h"
 
#include <vclib/base.h>
 
namespace vcl::comp {
 
template<typename ParentElemType = void, bool OPT = false>
class Mark :
        public Component<
            Mark<ParentElemType, OPT>,
            CompId::MARK,
            int,
            ParentElemType,
            !std::is_same_v<ParentElemType, void>,
            OPT>
{
    using Base = Component<
        Mark<ParentElemType, OPT>,
        CompId::MARK,
        int,
        ParentElemType,
        !std::is_same_v<ParentElemType, void>,
        OPT>;
 
public:
    /* Constructors */
 
    Mark()
    {
        if constexpr (!Base::IS_VERTICAL) {
            init();
        }
    }
 
    void init() { markRef() = 0; }
 
    /* Member functions */
 
    int mark() const { return Base::data(); }
 
    void resetMark() { markRef() = 0; }
 
    template<typename E>
    bool hasSameMark(const E& e) const
    {
        if constexpr (std::is_pointer<E>::value) {
            return e->mark() == mark();
        }
        else {
            return e.mark() == mark();
        }
    }
 
    void incrementMark() { markRef()++; }
 
    void decrementMark() { markRef()--; }
 
protected:
    // Component interface function
    template<typename Element>
    void importFrom(const Element& e, bool = true);
 
    void serialize(std::ostream& os) const { vcl::serialize(os, mark()); }
 
    void deserialize(std::istream& is) { vcl::deserialize(is, markRef()); }
 
private:
    int& markRef() { return Base::data(); }
};
 
/* concepts */
 
template<typename T>
concept HasMark = TB::IsDerivedFromSpecializationOfV<T, Mark>;
 
template<typename T>
concept HasOptionalMark =
    HasMark<T> && IsOptionalComponent<typename RemoveRef<T>::Mark>;
 
/* importFrom function */
 
template<typename ParentElemType, bool OPT>
template<typename Element>
void Mark<ParentElemType, OPT>::importFrom(const Element& e, bool)
{
    if constexpr (HasMark<Element>) {
        if (isMarkAvailableOn(e)) {
            markRef() = e.mark();
        }
    }
}
 
/* Detector function to check if a class has Mark available */
 
bool isMarkAvailableOn(const auto& element)
{
    return isComponentAvailableOn<CompId::MARK>(element);
}
 
} // namespace vcl::comp
 
#endif // VCL_MESH_COMPONENTS_MARK_H