Surface.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_SURFACE_HPP
#define CUBBYFLOW_SURFACE_HPP

#include <Core/Geometry/Ray.hpp>
#include <Core/Geometry/Transform.hpp>
#include <Core/Matrix/Matrix.hpp>

#include <limits>
#include <memory>

namespace CubbyFlow
{
template <size_t N>
struct SurfaceRayIntersection
{
    bool isIntersecting = false;
    double distance = std::numeric_limits<double>::max();
    Vector<double, N> point;
    Vector<double, N> normal;
};

using SurfaceRayIntersection2 = SurfaceRayIntersection<2>;
using SurfaceRayIntersection3 = SurfaceRayIntersection<3>;

template <size_t N>
class Surface
{
 public:
    Surface(const Transform<N>& transform = Transform<N>(),
            bool isNormalFlipped = false);

    virtual ~Surface() = default;

    Surface(const Surface& other);

    Surface(Surface&& other) noexcept;

    Surface& operator=(const Surface& other);

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

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

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

    [[nodiscard]] bool Intersects(const Ray<double, N>& ray) const;

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

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

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

    virtual void UpdateQueryEngine();

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

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

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

    Transform<N> transform;

    bool isNormalFlipped = false;

 protected:
    [[nodiscard]] virtual Vector<double, N> ClosestPointLocal(
        const Vector<double, N>& otherPoint) const = 0;

    [[nodiscard]] virtual BoundingBox<double, N> BoundingBoxLocal() const = 0;

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

    [[nodiscard]] virtual Vector<double, N> ClosestNormalLocal(
        const Vector<double, N>& otherPoint) const = 0;

    [[nodiscard]] virtual bool IntersectsLocal(const Ray<double, N>& ray) const;

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

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

using Surface2 = Surface<2>;

using Surface3 = Surface<3>;

using Surface2Ptr = std::shared_ptr<Surface2>;

using Surface3Ptr = std::shared_ptr<Surface3>;

template <size_t N, typename DerivedBuilder>
class SurfaceBuilderBase
{
 public:
    DerivedBuilder& WithIsNormalFlipped(bool isNormalFlipped);

    DerivedBuilder& WithTranslation(const Vector<double, N>& translation);

    DerivedBuilder& WithOrientation(const Orientation<N>& orientation);

    DerivedBuilder& WithTransform(const Transform<N>& transform);

 protected:
    bool m_isNormalFlipped = false;
    Transform<N> m_transform;
};

template <size_t N, typename T>
T& SurfaceBuilderBase<N, T>::WithIsNormalFlipped(bool isNormalFlipped)
{
    m_isNormalFlipped = isNormalFlipped;
    return static_cast<T&>(*this);
}

template <size_t N, typename T>
T& SurfaceBuilderBase<N, T>::WithTranslation(
    const Vector<double, N>& translation)
{
    m_transform.SetTranslation(translation);
    return static_cast<T&>(*this);
}

template <size_t N, typename T>
T& SurfaceBuilderBase<N, T>::WithOrientation(const Orientation<N>& orientation)
{
    m_transform.SetOrientation(orientation);
    return static_cast<T&>(*this);
}

template <size_t N, typename T>
T& SurfaceBuilderBase<N, T>::WithTransform(const Transform<N>& transform)
{
    m_transform = transform;
    return static_cast<T&>(*this);
}

template <typename T>
using SurfaceBuilderBase2 = SurfaceBuilderBase<2, T>;

template <typename T>
using SurfaceBuilderBase3 = SurfaceBuilderBase<3, T>;
}  // namespace CubbyFlow

#endif