IntersectionQueryEngine.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_INTERSECTION_QUERY_ENGINE_HPP
#define CUBBYFLOW_INTERSECTION_QUERY_ENGINE_HPP

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

#include <functional>
#include <limits>

namespace CubbyFlow
{
template <typename T, size_t N>
struct ClosestIntersectionQueryResult
{
    const T* item = nullptr;
    double distance = std::numeric_limits<double>::max();
};

template <typename T>
using ClosestIntersectionQueryResult2 = ClosestIntersectionQueryResult<T, 2>;

template <typename T>
using ClosestIntersectionQueryResult3 = ClosestIntersectionQueryResult<T, 3>;

template <typename T, size_t N>
using ClosestIntersectionDistanceFunc =
    std::function<double(const T&, const Vector<double, N>&)>;

template <typename T>
using ClosestIntersectionDistanceFunc2 = ClosestIntersectionDistanceFunc<T, 2>;

template <typename T>
using ClosestIntersectionDistanceFunc3 = ClosestIntersectionDistanceFunc<T, 3>;

template <typename T, size_t N>
using BoxIntersectionTestFunc =
    std::function<bool(const T&, const BoundingBox<double, N>&)>;

template <typename T>
using BoxIntersectionTestFunc2 = BoxIntersectionTestFunc<T, 2>;

template <typename T>
using BoxIntersectionTestFunc3 = BoxIntersectionTestFunc<T, 3>;

template <typename T, size_t N>
using RayIntersectionTestFunc =
    std::function<bool(const T&, const Ray<double, N>&)>;

template <typename T>
using RayIntersectionTestFunc2 = RayIntersectionTestFunc<T, 2>;

template <typename T>
using RayIntersectionTestFunc3 = RayIntersectionTestFunc<T, 3>;

template <typename T, size_t N>
using GetRayIntersectionFunc =
    std::function<double(const T&, const Ray<double, N>&)>;

template <typename T>
using GetRayIntersectionFunc2 = GetRayIntersectionFunc<T, 2>;

template <typename T>
using GetRayIntersectionFunc3 = GetRayIntersectionFunc<T, 3>;

template <typename T>
using IntersectionVisitorFunc = std::function<void(const T&)>;

template <typename T, size_t N>
class IntersectionQueryEngine
{
 public:
    IntersectionQueryEngine() = default;

    virtual ~IntersectionQueryEngine() = default;

    IntersectionQueryEngine(const IntersectionQueryEngine& other) = default;

    IntersectionQueryEngine(IntersectionQueryEngine&& other) noexcept = default;

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

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

    [[nodiscard]] virtual bool Intersects(
        const BoundingBox<double, N>& box,
        const BoxIntersectionTestFunc<T, N>& testFunc) const = 0;

    [[nodiscard]] virtual bool Intersects(
        const Ray<double, N>& ray,
        const RayIntersectionTestFunc<T, N>& testFunc) const = 0;

    virtual void ForEachIntersectingItem(
        const BoundingBox<double, N>& box,
        const BoxIntersectionTestFunc<T, N>& testFunc,
        const IntersectionVisitorFunc<T>& visitorFunc) const = 0;

    virtual void ForEachIntersectingItem(
        const Ray<double, N>& ray,
        const RayIntersectionTestFunc<T, N>& testFunc,
        const IntersectionVisitorFunc<T>& visitorFunc) const = 0;

    [[nodiscard]] virtual ClosestIntersectionQueryResult<T, N>
    ClosestIntersection(const Ray<double, N>& ray,
                        const GetRayIntersectionFunc<T, N>& testFunc) const = 0;
};

template <typename T>
using IntersectionQueryEngine2 = IntersectionQueryEngine<T, 2>;

template <typename T>
using IntersectionQueryEngine3 = IntersectionQueryEngine<T, 3>;

}  // namespace CubbyFlow

#endif