ImplicitSurfaceSet.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_IMPLICIT_SURFACE_SET_HPP
#define CUBBYFLOW_IMPLICIT_SURFACE_SET_HPP

#include <Core/Array/Array.hpp>
#include <Core/Geometry/BVH.hpp>
#include <Core/Geometry/ImplicitSurface.hpp>

namespace CubbyFlow
{
template <size_t N>
class ImplicitSurfaceSet final : public ImplicitSurface<N>
{
 public:
    class Builder;

    using ImplicitSurface<N>::transform;
    using ImplicitSurface<N>::isNormalFlipped;

    ImplicitSurfaceSet() = default;

    ImplicitSurfaceSet(
        ConstArrayView1<std::shared_ptr<ImplicitSurface<N>>> surfaces,
        const Transform<N>& _transform = Transform<N>{},
        bool _isNormalFlipped = false);

    ImplicitSurfaceSet(ConstArrayView1<std::shared_ptr<Surface<N>>> surfaces,
                       const Transform<N>& _transform = Transform<N>{},
                       bool _isNormalFlipped = false);

    ~ImplicitSurfaceSet() override = default;

    ImplicitSurfaceSet(const ImplicitSurfaceSet& other);

    ImplicitSurfaceSet(ImplicitSurfaceSet&& other) noexcept;

    ImplicitSurfaceSet& operator=(const ImplicitSurfaceSet& other);

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

    void UpdateQueryEngine() override;

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

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

    [[nodiscard]] size_t NumberOfSurfaces() const;

    [[nodiscard]] const std::shared_ptr<ImplicitSurface<N>>& SurfaceAt(
        size_t i) const;

    void AddExplicitSurface(const std::shared_ptr<Surface<N>>& surface);

    void AddSurface(const std::shared_ptr<ImplicitSurface<N>>& surface);

    static Builder GetBuilder();

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

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

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

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

    [[nodiscard]] bool IntersectsLocal(
        const Ray<double, N>& ray) 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;

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

    void InvalidateBVH() const;

    void BuildBVH() const;

    Array1<std::shared_ptr<ImplicitSurface<N>>> m_surfaces;
    Array1<std::shared_ptr<ImplicitSurface<N>>> m_unboundedSurfaces;
    mutable BVH<std::shared_ptr<ImplicitSurface<N>>, N> m_bvh;
    mutable bool m_bvhInvalidated = true;
};

using ImplicitSurfaceSet2 = ImplicitSurfaceSet<2>;

using ImplicitSurfaceSet3 = ImplicitSurfaceSet<3>;

using ImplicitSurfaceSet2Ptr = std::shared_ptr<ImplicitSurfaceSet2>;

using ImplicitSurfaceSet3Ptr = std::shared_ptr<ImplicitSurfaceSet3>;

template <size_t N>
class ImplicitSurfaceSet<N>::Builder final
    : public SurfaceBuilderBase<N, typename ImplicitSurfaceSet<N>::Builder>
{
 public:
    Builder& WithSurfaces(
        const ConstArrayView1<std::shared_ptr<ImplicitSurface<N>>>& surfaces);

    Builder& WithExplicitSurfaces(
        const ConstArrayView1<std::shared_ptr<Surface<N>>>& surfaces);

    ImplicitSurfaceSet<N> Build() const;

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

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

    Array1<std::shared_ptr<ImplicitSurface<N>>> m_surfaces;
};
}  // namespace CubbyFlow

#endif