normal.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_NORMAL_H
#define VCL_MESH_COMPONENTS_NORMAL_H
 
#include "base/component.h"
#include "base/predicates.h"
 
#include <vclib/space/core.h>
 
namespace vcl::comp {
 
template<PointConcept P, typename ParentElemType = void, bool OPT = false>
class Normal :
        public Component<
            Normal<P, ParentElemType, OPT>,
            CompId::NORMAL,
            P,
            ParentElemType,
            !std::is_same_v<ParentElemType, void>,
            OPT>
{
    using Base = Component<
        Normal<P, ParentElemType, OPT>,
        CompId::NORMAL,
        P,
        ParentElemType,
        !std::is_same_v<ParentElemType, void>,
        OPT>;
 
public:
    using NormalType = P;
 
    /* Constructors */
 
    Normal() = default;
 
    /* Member functions */
 
    const P& normal() const { return Base::data(); }
 
    P& normal() { return Base::data(); }
 
protected:
    // Component interface functions
    template<typename Element>
    void importFrom(const Element& e, bool = true);
 
    void serialize(std::ostream& os) const { normal().serialize(os); }
 
    void deserialize(std::istream& is) { normal().deserialize(is); }
};
 
/* concepts */
 
template<typename T>
concept HasNormal = TTB::IsDerivedFromSpecializationOfV<T, Normal>;
 
template<typename T>
concept HasOptionalNormal =
    HasNormal<T> && IsOptionalComponent<typename RemoveRef<T>::Normal>;
 
/* importFrom function */
 
template<PointConcept P, typename ParentElemType, bool OPT>
template<typename Element>
void Normal<P, ParentElemType, OPT>::importFrom(const Element& e, bool)
{
    using ScalarType = NormalType::ScalarType;
    if constexpr (HasNormal<Element>) {
        if (isNormalAvailableOn(e)) {
            normal() = e.normal().template cast<ScalarType>();
        }
    }
}
 
/* Detector function to check if a class has Normal available */
 
bool isNormalAvailableOn(const auto& element)
{
    return isComponentAvailableOn<CompId::NORMAL>(element);
}
 
/* Specialization Aliases */
 
template<typename Scalar, typename ElementType = void, bool OPT = false>
using Normal3 = Normal<Point3<Scalar>, ElementType, OPT>;
 
template<typename ElementType = void, bool OPT = false>
using Normal3f = Normal3<float, ElementType, OPT>;
 
template<typename ElementType = void, bool OPT = false>
using Normal3d = Normal3<double, ElementType, OPT>;
 
} // namespace vcl::comp
 
#endif // VCL_MESH_COMPONENTS_NORMAL_H