Box.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_BOX_HPP
#define CUBBYFLOW_BOX_HPP
 
#include <Core/Geometry/Surface.hpp>
 
namespace CubbyFlow
{
template <size_t N>
class Box final : public Surface<N>
{
 public:
    class Builder;
 
    BoundingBox<double, N> bound = BoundingBox<double, N>(
        Vector<double, N>{}, Vector<double, N>::MakeConstant(1.0));
 
    Box() : Box(Transform<N>{})
    {
        // Do nothing
    }
 
    explicit Box(const Transform<N>& _transform, bool _isNormalFlipped = false);
 
    Box(const Vector<double, N>& lowerCorner,
        const Vector<double, N>& upperCorner,
        const Transform<N>& _transform = Transform<N>{},
        bool _isNormalFlipped = false);
 
    explicit Box(const BoundingBox<double, N>& boundingBox,
                 const Transform<N>& _transform = Transform<N>{},
                 bool _isNormalFlipped = false);
 
    ~Box() override = default;
 
    Box(const Box& other);
 
    Box(Box&& other) noexcept;
 
    Box& operator=(const Box& other);
 
    Box& operator=(Box&& other) noexcept;
 
    static Builder GetBuilder();
 
 protected:
    [[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 Box2 = Box<2>;
 
using Box3 = Box<3>;
 
using Box2Ptr = std::shared_ptr<Box2>;
 
using Box3Ptr = std::shared_ptr<Box3>;
 
template <size_t N>
class Box<N>::Builder final
    : public SurfaceBuilderBase<N, typename Box<N>::Builder>
{
 public:
    Builder& WithLowerCorner(const Vector<double, N>& pt);
 
    Builder& WithUpperCorner(const Vector<double, N>& pt);
 
    Builder& WithBoundingBox(const BoundingBox<double, N>& bbox);
 
    Box Build() const;
 
    std::shared_ptr<Box<N>> MakeShared() const;
 
 private:
    using Base = SurfaceBuilderBase<N, typename Box<N>::Builder>;
    using Base::m_isNormalFlipped;
    using Base::m_transform;
 
    Vector<double, N> m_lowerCorner;
    Vector<double, N> m_upperCorner = Vector<double, N>::MakeConstant(1.0);
};
}  // namespace CubbyFlow
 
#endif