PointHashGridSearcher2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: PointHashGridSearcher2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Hash grid-based 2-D point searcher.
> Created Time: 2017/05/22
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_POINT_HASH_GRID_SEARCHER2_H
#define CUBBYFLOW_POINT_HASH_GRID_SEARCHER2_H

#include <Core/Searcher/PointNeighborSearcher2.h>
#include <Core/Size/Size2.h>

#include <vector>

namespace CubbyFlow
{
    class PointHashGridSearcher2 final : public PointNeighborSearcher2
    {
    public:
        CUBBYFLOW_NEIGHBOR_SEARCHER2_TYPE_NAME(PointHashGridSearcher2)

        class Builder;

        PointHashGridSearcher2(const Size2& resolution, double gridSpacing);

        PointHashGridSearcher2(size_t resolutionX, size_t resolutionY, double gridSpacing);

        PointHashGridSearcher2(const PointHashGridSearcher2& other);

        void Build(const ConstArrayAccessor1<Vector2D>& points) override;

        void ForEachNearbyPoint(
            const Vector2D& origin,
            double radius,
            const ForEachNearbyPointFunc& callback) const override;

        bool HasNearbyPoint(const Vector2D& origin, double radius) const override;

        void Add(const Vector2D& point);

        const std::vector<std::vector<size_t>>& GetBuckets() const;

        size_t GetHashKeyFromBucketIndex(const Point2I& bucketIndex) const;

        Point2I GetBucketIndex(const Vector2D& position) const;

        PointNeighborSearcher2Ptr Clone() const override;

        PointHashGridSearcher2& operator=(const PointHashGridSearcher2& other);

        void Set(const PointHashGridSearcher2& other);

        void Serialize(std::vector<uint8_t>* buffer) const override;

        void Deserialize(const std::vector<uint8_t>& buffer) override;

        static Builder GetBuilder();

    private:
        double m_gridSpacing = 1.0;
        Point2I m_resolution = Point2I(1, 1);
        std::vector<Vector2D> m_points;
        std::vector<std::vector<size_t>> m_buckets;

        size_t GetHashKeyFromPosition(const Vector2D& position) const;

        void GetNearbyKeys(const Vector2D& position, size_t* nearbyKeys) const;
    };

    using PointHashGridSearcher2Ptr = std::shared_ptr<PointHashGridSearcher2>;

    class PointHashGridSearcher2::Builder final : public PointNeighborSearcherBuilder2
    {
    public:
        Builder& WithResolution(const Size2& resolution);

        Builder& WithGridSpacing(double gridSpacing);

        PointHashGridSearcher2 Build() const;

        PointHashGridSearcher2Ptr MakeShared() const;

        PointNeighborSearcher2Ptr BuildPointNeighborSearcher() const override;

    private:
        Size2 m_resolution{ 64, 64 };
        double m_gridSpacing = 1.0;
    };
}

#endif