CustomImplicitSurface2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: CustomImplicitSurface2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Custom 2-D implicit surface using arbitrary function.
> Created Time: 2017/09/07
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_CUSTOM_IMPLICIT_SURFACE2_H
#define CUBBYFLOW_CUSTOM_IMPLICIT_SURFACE2_H

#include <Core/Surface/ImplicitSurface2.h>

#include <functional>

namespace CubbyFlow
{
    class CustomImplicitSurface2 final : public ImplicitSurface2
    {
    public:
        class Builder;

        CustomImplicitSurface2(
            const std::function<double(const Vector2D&)>& func,
            const BoundingBox2D& domain = BoundingBox2D(),
            double resolution = 1e-3,
            double rayMarchingResolution = 1e-6,
            unsigned int maxNumberOfIterations = 5,
            const Transform2& transform = Transform2(),
            bool isNormalFlipped = false);

        virtual ~CustomImplicitSurface2();

        static Builder GetBuilder();

    private:
        std::function<double(const Vector2D&)> m_func;
        BoundingBox2D m_domain;
        double m_resolution = 1e-3;
        double m_rayMarchingResolution = 1e-6;
        unsigned int m_maxNumberOfIterations = 5;

        Vector2D ClosestPointLocal(const Vector2D& otherPoint) const override;

        bool IntersectsLocal(const Ray2D& ray) const override;

        BoundingBox2D BoundingBoxLocal() const override;

        Vector2D ClosestNormalLocal(const Vector2D& otherPoint) const override;

        double SignedDistanceLocal(const Vector2D& otherPoint) const override;

        SurfaceRayIntersection2 ClosestIntersectionLocal(const Ray2D& ray) const override;

        Vector2D GradientLocal(const Vector2D& x) const;
    };

    using CustomImplicitSurface2Ptr = std::shared_ptr<CustomImplicitSurface2>;
    
    class CustomImplicitSurface2::Builder final : public SurfaceBuilderBase2<CustomImplicitSurface2::Builder>
    {
    public:
        Builder& WithSignedDistanceFunction(const std::function<double(const Vector2D&)>& func);

        Builder& WithDomain(const BoundingBox2D& domain);

        Builder& WithResolution(double resolution);

        Builder& WithRayMarchingResolution(double rayMarchingResolution);

        Builder& WithMaxNumberOfIterations(unsigned int numIter);

        CustomImplicitSurface2 Build() const;

        CustomImplicitSurface2Ptr MakeShared() const;

    private:
        std::function<double(const Vector2D&)> m_func;
        BoundingBox2D m_domain;
        double m_resolution = 1e-3;
        double m_rayMarchingResolution = 1e-6;
        unsigned int m_maxNumberOfIterations = 5;
    };
}

#endif