Plane.hpp

Go to the documentation of this file.

// This code is based on Jet framework.
// Copyright (c) 2018 Doyub Kim
// CubbyFlow is voxel-based fluid simulation engine for computer games.
// Copyright (c) 2020 CubbyFlow Team
// Core Part: Chris Ohk, Junwoo Hwang, Jihong Sin, Seungwoo Yoo
// AI Part: Dongheon Cho, Minseo Kim
// We are making my contributions/submissions to this project solely in our
// personal capacity and are not conveying any rights to any intellectual
// property of any third parties.

#ifndef CUBBYFLOW_PLANE_HPP
#define CUBBYFLOW_PLANE_HPP

#include <Core/Geometry/Surface.hpp>

namespace CubbyFlow
{
template <size_t N>
class Plane final : public Surface<N>
{
 public:
    class Builder;

    Plane(const Transform<N>& _transform = Transform<N>{},
          bool _isNormalFlipped = false);

    Plane(const Vector<double, N>& normal, const Vector<double, N>& point,
          const Transform<N>& _transform = Transform<N>{},
          bool _isNormalFlipped = false);

    ~Plane() override = default;

    Plane(const Plane& other);

    Plane(Plane&& other) noexcept;

    Plane& operator=(const Plane& other);

    Plane& operator=(Plane&& other) noexcept;

    [[nodiscard]] bool IsBounded() const override;

    static Builder GetBuilder();

    Vector<double, N> normal = Vector<double, N>::MakeUnitY();

    Vector<double, N> point;

 private:
    [[nodiscard]] Vector<double, N> ClosestPointLocal(
        const Vector<double, N>& otherPoint) const override;

    [[nodiscard]] bool IntersectsLocal(
        const Ray<double, N>& ray) const override;

    [[nodiscard]] BoundingBox<double, N> BoundingBoxLocal() const override;

    [[nodiscard]] Vector<double, N> ClosestNormalLocal(
        const Vector<double, N>& otherPoint) const override;

    [[nodiscard]] SurfaceRayIntersection<N> ClosestIntersectionLocal(
        const Ray<double, N>& ray) const override;
};

using Plane2 = Plane<2>;

using Plane3 = Plane<3>;

using Plane2Ptr = std::shared_ptr<Plane2>;

using Plane3Ptr = std::shared_ptr<Plane3>;

template <size_t N>
class Plane<N>::Builder final
    : public SurfaceBuilderBase<N, typename Plane<N>::Builder>
{
 public:
    Builder& WithNormal(const Vector<double, N>& _normal);

    Builder& WithPoint(const Vector<double, N>& _point);

    Plane Build() const;

    std::shared_ptr<Plane<N>> MakeShared() const;

 private:
    using Base = SurfaceBuilderBase<N, typename Plane<N>::Builder>;
    using Base::m_isNormalFlipped;
    using Base::m_transform;

    Vector<double, N> m_normal = Vector<double, N>::MakeUnitY();
    Vector<double, N> m_point;
};
}  // namespace CubbyFlow

#endif