PointNeighborSearcher.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_POINT_NEIGHBOR_SEARCHER_HPP
#define CUBBYFLOW_POINT_NEIGHBOR_SEARCHER_HPP

#include <Core/Matrix/Matrix.hpp>
#include <Core/Utils/Serialization.hpp>

#include <functional>
#include <memory>
#include <string>

namespace CubbyFlow
{
template <size_t N>
class PointNeighborSearcher : public Serializable
{
 public:
    using ForEachNearbyPointFunc =
        std::function<void(size_t, const Vector<double, N>&)>;

    PointNeighborSearcher() = default;

    ~PointNeighborSearcher() override = default;

    PointNeighborSearcher(const PointNeighborSearcher& other) = default;

    PointNeighborSearcher(PointNeighborSearcher&& other) noexcept = default;

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

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

    [[nodiscard]] virtual std::string TypeName() const = 0;

    virtual void Build(const ConstArrayView1<Vector<double, N>>& points);

    virtual void Build(const ConstArrayView1<Vector<double, N>>& points,
                       double maxSearchRadius) = 0;

    virtual void ForEachNearbyPoint(
        const Vector<double, N>& origin, double radius,
        const ForEachNearbyPointFunc& callback) const = 0;

    [[nodiscard]] virtual bool HasNearbyPoint(const Vector<double, N>& origin,
                                              double radius) const = 0;

    [[nodiscard]] virtual std::shared_ptr<PointNeighborSearcher> Clone()
        const = 0;
};

using PointNeighborSearcher2 = PointNeighborSearcher<2>;

using PointNeighborSearcher3 = PointNeighborSearcher<3>;

using PointNeighborSearcher2Ptr = std::shared_ptr<PointNeighborSearcher2>;

using PointNeighborSearcher3Ptr = std::shared_ptr<PointNeighborSearcher3>;

template <size_t N>
class PointNeighborSearcherBuilder
{
 public:
    PointNeighborSearcherBuilder() = default;

    virtual ~PointNeighborSearcherBuilder() = default;

    PointNeighborSearcherBuilder(const PointNeighborSearcherBuilder& other) =
        delete;

    PointNeighborSearcherBuilder(
        PointNeighborSearcherBuilder&& other) noexcept = delete;

    PointNeighborSearcherBuilder& operator=(
        const PointNeighborSearcherBuilder& other) = delete;

    PointNeighborSearcherBuilder& operator=(
        PointNeighborSearcherBuilder&& other) noexcept = delete;

    [[nodiscard]] virtual std::shared_ptr<PointNeighborSearcher<N>>
    BuildPointNeighborSearcher() const = 0;
};

using PointNeighborSearcherBuilder2 = PointNeighborSearcherBuilder<2>;

using PointNeighborSearcherBuilder3 = PointNeighborSearcherBuilder<3>;

using PointNeighborSearcherBuilder2Ptr =
    std::shared_ptr<PointNeighborSearcherBuilder2>;

using PointNeighborSearcherBuilder3Ptr =
    std::shared_ptr<PointNeighborSearcherBuilder3>;

#define CUBBYFLOW_NEIGHBOR_SEARCHER_TYPE_NAME(DerivedClassName, N) \
    [[nodiscard]] std::string TypeName() const override            \
    {                                                              \
        return #DerivedClassName + std::to_string(N);              \
    }
}  // namespace CubbyFlow

#endif