hyperplane.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2023  Christopher J. Howard
 *
 * This file is part of Antkeeper source code.
 *
 * Antkeeper source code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Antkeeper source code 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
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Antkeeper source code.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef ANTKEEPER_GEOM_PRIMITIVES_HYPERPLANE_HPP
#define ANTKEEPER_GEOM_PRIMITIVES_HYPERPLANE_HPP
 
#include <engine/math/vector.hpp>
 
namespace geom {
namespace primitives {
 
template <class T, std::size_t N>
struct hyperplane
{
    using vector_type = math::vector<T, N>;
    
    vector_type normal;
    
    T constant;
    
    constexpr hyperplane() noexcept = default;
    
    inline constexpr hyperplane(const vector_type& normal, float constant) noexcept:
        normal{normal},
        constant{constant}
    {}
    
    inline constexpr hyperplane(const vector_type& normal, const vector_type& offset) noexcept:
        normal{normal},
        constant{-math::dot(normal, offset)}
    {}
    
    [[nodiscard]] inline constexpr T distance(const vector_type& point) const noexcept
    {
        return math::dot(normal, point) + constant;
    }
};
 
} // namespace primitives
 
using namespace primitives;
 
} // namespace geom
 
#endif // ANTKEEPER_GEOM_PRIMITIVES_HYPERPLANE_HPP