CustomImplicitSurface.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_CUSTOM_IMPLICIT_SURFACE_HPP
#define CUBBYFLOW_CUSTOM_IMPLICIT_SURFACE_HPP

#include <Core/Geometry/ImplicitSurface.hpp>

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

    CustomImplicitSurface(
        std::function<double(const Vector<double, N>&)> func,
        const BoundingBox<double, N>& domain = BoundingBox<double, N>{},
        double resolution = 1e-3, double rayMarchingResolution = 1e-6,
        unsigned int maxNumOfIterations = 5,
        const Transform<N>& _transform = Transform<N>{},
        bool _isNormalFlipped = false);

    ~CustomImplicitSurface() override = default;

    CustomImplicitSurface(const CustomImplicitSurface& other) = default;

    CustomImplicitSurface(CustomImplicitSurface&& other) noexcept = default;

    CustomImplicitSurface& operator=(const CustomImplicitSurface& other) =
        default;

    CustomImplicitSurface& operator=(CustomImplicitSurface&& other) noexcept =
        default;

    static Builder GetBuilder();

 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]] double SignedDistanceLocal(
        const Vector<double, N>& otherPoint) const override;

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

    [[nodiscard]] Vector<double, N> GradientLocal(
        const Vector<double, N>& x) const;

    std::function<double(const Vector<double, N>&)> m_func;
    BoundingBox<double, N> m_domain;
    double m_resolution = 1e-3;
    double m_rayMarchingResolution = 1e-6;
    unsigned int m_maxNumOfIterations = 5;
};

using CustomImplicitSurface2 = CustomImplicitSurface<2>;

using CustomImplicitSurface3 = CustomImplicitSurface<3>;

using CustomImplicitSurface2Ptr = std::shared_ptr<CustomImplicitSurface2>;

using CustomImplicitSurface3Ptr = std::shared_ptr<CustomImplicitSurface3>;

template <size_t N>
class CustomImplicitSurface<N>::Builder final
    : public SurfaceBuilderBase<N, typename CustomImplicitSurface<N>::Builder>
{
 public:
    Builder& WithSignedDistanceFunction(
        const std::function<double(const Vector<double, N>&)>& func);

    Builder& WithDomain(const BoundingBox<double, N>& domain);

    Builder& WithResolution(double resolution);

    Builder& WithRayMarchingResolution(double rayMarchingResolution);

    Builder& WithMaxNumberOfIterations(unsigned int numIter);

    CustomImplicitSurface<N> Build() const;

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

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

    std::function<double(const Vector<double, N>&)> m_func;
    BoundingBox<double, N> m_domain;
    double m_resolution = 1e-3;
    double m_rayMarchingResolution = 1e-6;
    unsigned int m_maxNumOfIterations = 5;
};
}  // namespace CubbyFlow

#endif