custom_components.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_CUSTOM_COMPONENTS_H
#define VCL_MESH_COMPONENTS_CUSTOM_COMPONENTS_H
 
#include "base/base.h"
#include "detail/custom_components_data.h"
 
#include <vclib/base.h>
 
#include <any>
#include <string>
#include <vector>
 
namespace vcl::comp {
 
template<typename ParentElemType = void>
class CustomComponents
{
    static const bool IS_VERTICAL = !std::is_same_v<ParentElemType, void>;
 
    detail::CustomComponentsData<ParentElemType, IS_VERTICAL> mData;
 
public:
    static const uint COMPONENT_ID = CompId::CUSTOM_COMPONENTS;
 
    /* Constructors */
 
    CustomComponents() = default;
 
    /* Member functions */
 
    bool hasCustomComponent(const std::string& compName) const
    {
        return mData.componentExists(
            compName, static_cast<const ParentElemType*>(this));
    }
 
    template<typename CompType>
    bool isCustomComponentOfType(const std::string& compName) const
    {
        return mData.template isComponentOfType<CompType>(
            compName, static_cast<const ParentElemType*>(this));
    }
 
    std::type_index customComponentType(const std::string& compName) const
    {
        return mData.componentType(
            compName, static_cast<const ParentElemType*>(this));
    }
 
    template<typename CompType>
    std::vector<std::string> customComponentNamesOfType() const
    {
        return mData.template componentNamesOfType<CompType>(
            static_cast<const ParentElemType*>(this));
    }
 
    template<typename CompType>
    const CompType& customComponent(const std::string& compName) const
    {
        return mData.template get<CompType>(
            compName, static_cast<const ParentElemType*>(this));
    }
 
    template<typename CompType>
    CompType& customComponent(const std::string& compName)
    {
        return mData.template get<CompType>(
            compName, static_cast<ParentElemType*>(this));
    }
 
    template<typename CompType>
    void addCustomComponent(
        const std::string& compName,
        const CompType&    value = CompType()) requires (!IS_VERTICAL)
    {
        return mData.template addCustomComponent<CompType>(compName, value);
    }
 
    void deleteCustomComponent(const std::string& compName)
        requires (!IS_VERTICAL)
    {
        return mData.deleteCustomComponent(compName);
    }
 
    template<typename CompType>
    void serializeCustomComponentsOfType(std::ostream& os) const
        requires (!IS_VERTICAL)
    {
        std::vector<std::string> compNames =
            customComponentNamesOfType<CompType>();
        vcl::serialize(os, compNames);
        for (const auto& name : compNames) {
            const CompType& c = customComponent<CompType>(name);
            vcl::serialize(os, c);
        }
    }
 
    template<typename CompType>
    void deserializeCustomComponentsOfType(std::istream& is)
        requires (!IS_VERTICAL)
    {
        std::vector<std::string> compNames;
        vcl::deserialize(is, compNames);
        for (const auto& name : compNames) {
            CompType c;
            vcl::deserialize(is, c);
            addCustomComponent<CompType>(name, c);
        }
    }
 
protected:
    template<typename Element>
    void importFrom(const Element& e, bool = true);
 
    void serialize(std::ostream& os) const
    {
        // todo
    }
 
    void deserialize(std::istream& is)
    {
        // todo
    }
};
 
/* concept */
 
template<typename T>
concept HasCustomComponents =
    IsDerivedFromSpecializationOfV<T, CustomComponents>;
 
/* importFrom function */
 
template<typename ParentElemType>
template<typename Element>
void CustomComponents<ParentElemType>::importFrom(const Element& e, bool)
{
    // if the component is vertical, the import is managed by the container.
    // if is horizontal, it must be managed by the component itself.
    if constexpr (!IS_VERTICAL && HasCustomComponents<Element>) {
        mData = e.CustomComponents::mData;
    }
}
 
} // namespace vcl::comp
 
#endif // VCL_MESH_COMPONENTS_CUSTOM_COMPONENTS_H