CustomImplicitSurface3.h

Go to the documentation of this file.

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

#include <Core/Surface/ImplicitSurface3.h>

#include <functional>

namespace CubbyFlow
{
    class CustomImplicitSurface3 final : public ImplicitSurface3
    {
    public:
        class Builder;

        CustomImplicitSurface3(
            const std::function<double(const Vector3D&)>& func,
            const BoundingBox3D& domain = BoundingBox3D(),
            double resolution = 1e-3,
            double rayMarchingResolution = 1e-6,
            unsigned int maxNumberOfIterations = 5,
            const Transform3& transform = Transform3(),
            bool isNormalFlipped = false);

        virtual ~CustomImplicitSurface3();

        static Builder GetBuilder();

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

        Vector3D ClosestPointLocal(const Vector3D& otherPoint) const override;

        bool IntersectsLocal(const Ray3D& ray) const override;

        BoundingBox3D BoundingBoxLocal() const override;

        Vector3D ClosestNormalLocal(const Vector3D& otherPoint) const override;

        double SignedDistanceLocal(const Vector3D& otherPoint) const override;

        SurfaceRayIntersection3 ClosestIntersectionLocal(const Ray3D& ray) const override;

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

    using CustomImplicitSurface3Ptr = std::shared_ptr<CustomImplicitSurface3>;
    
    class CustomImplicitSurface3::Builder final : public SurfaceBuilderBase3<CustomImplicitSurface3::Builder>
    {
    public:
        Builder& WithSignedDistanceFunction(const std::function<double(const Vector3D&)>& func);

        Builder& WithDomain(const BoundingBox3D& domain);

        Builder& WithResolution(double resolution);

        Builder& WithRayMarchingResolution(double rayMarchingResolution);

        Builder& WithMaxNumberOfIterations(unsigned int numIter);

        CustomImplicitSurface3 Build() const;

        CustomImplicitSurface3Ptr MakeShared() const;

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

#endif