plane.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_SPACE_CORE_PLANE_H
#define VCL_SPACE_CORE_PLANE_H
 
#include "point.h"
 
namespace vcl {
 
template<typename Scalar, bool NORM = true>
class Plane
{
    Point3<Scalar> mDir;
    Scalar         mOffset;
 
public:
    using ScalarType = Scalar;
    using PointType  = Point3<Scalar>;
 
    static constexpr bool NORMED = NORM;
 
    Plane() {}
 
    Plane(const Point3<Scalar>& direction, Scalar offset) :
            mDir(direction), mOffset(offset)
    {
        if constexpr (NORM) {
            Scalar n = mDir.norm();
            mDir /= n;
            mOffset /= n;
        }
    }
 
    Plane(const Point3<Scalar>& p0, const Point3<Scalar>& normal)
    {
        mDir = normal;
        if constexpr (NORM) {
            mDir.normalize();
        }
        mOffset = p0.dot(mDir);
    }
 
    Plane(
        const Point3<Scalar>& p0,
        const Point3<Scalar>& p1,
        const Point3<Scalar>& p2) :
            Plane<Scalar, NORM>(p0, (p2 - p0).cross(p1 - p0))
    {
    }
 
    template<typename S>
    auto cast() const
    {
        if constexpr (std::is_same<Scalar, S>::value) {
            return *this;
        }
        else {
            return Plane<S, NORM>(mDir.template cast<S>(), mOffset);
        }
    }
 
    const Point3<Scalar>& direction() const { return mDir; }
 
    Scalar offset() const { return mOffset; }
 
    Point3<Scalar> projectPoint(const Point3<Scalar>& p) const
    {
        Scalar k = p.dot(mDir) - mOffset;
        return p - mDir * k;
    }
 
    Point3<Scalar> mirrorPoint(const Point3<Scalar>& p) const
    {
        Point3<Scalar> mirr = projectPoint(p);
        mirr += mirr - p;
        return mirr;
    }
 
    void serialize(std::ostream& os) const
    {
        mDir.serialize(os);
        vcl::serialize(os, mOffset);
    }
 
    void deserialize(std::istream& is)
    {
        mDir.deserialize(is);
        vcl::deserialize(is, mOffset);
    }
 
    bool operator==(const Plane& p) const
    {
        return mOffset == p.mOffset && mDir == p.mDir;
    }
 
    bool operator!=(const Plane& p) const { return !(*this == p); }
};
 
/* Specialization Aliases */
 
using Planef = Plane<float>;
using Planed = Plane<double>;
 
/* Concepts */
 
template<typename T>
concept PlaneConcept = std::derived_from< // same type or derived type
    std::remove_cvref_t<T>,
    Plane<typename RemoveRef<T>::ScalarType, RemoveRef<T>::NORMED>>;
 
} // namespace vcl
 
#endif // VCL_SPACE_CORE_PLANE_H