Octree.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <IJsonConvertible.h>
 
#include <cstddef>
#include <memory>
#include <vector>
 
#include "CV_db.h"
#include "ecvHObject.h"
 
class ccBBox;
class ccPointCloud;
class ecvOrientedBBox;
 
namespace cloudViewer {
namespace geometry {
 
class VoxelGrid;
 
class CV_DB_LIB_API OctreeNodeInfo {
public:
    OctreeNodeInfo() : origin_(0, 0, 0), size_(0), depth_(0), child_index_(0) {}
 
    OctreeNodeInfo(const Eigen::Vector3d& origin,
                   const double& size,
                   const size_t& depth,
                   const size_t& child_index)
        : origin_(origin),
          size_(size),
          depth_(depth),
          child_index_(child_index) {}
    ~OctreeNodeInfo() {}
 
public:
    Eigen::Vector3d origin_;
    double size_;
    size_t depth_;
    size_t child_index_;
};
 
class CV_DB_LIB_API OctreeNode : public cloudViewer::utility::IJsonConvertible {
public:
    OctreeNode() {}
    virtual ~OctreeNode() {}
 
    static std::shared_ptr<OctreeNode> ConstructFromJsonValue(
            const Json::Value& value);
};
 
class CV_DB_LIB_API OctreeInternalNode : public OctreeNode {
public:
    OctreeInternalNode() : children_(8) {}
    static std::shared_ptr<OctreeNodeInfo> GetInsertionNodeInfo(
            const std::shared_ptr<OctreeNodeInfo>& node_info,
            const Eigen::Vector3d& point);
 
    static std::function<std::shared_ptr<OctreeInternalNode>()>
    GetInitFunction();
 
    static std::function<void(std::shared_ptr<OctreeInternalNode>)>
    GetUpdateFunction();
 
    bool ConvertToJsonValue(Json::Value& value) const override;
    bool ConvertFromJsonValue(const Json::Value& value) override;
 
public:
    std::vector<std::shared_ptr<OctreeNode>> children_;
};
 
class CV_DB_LIB_API OctreeInternalPointNode : public OctreeInternalNode {
public:
    OctreeInternalPointNode() : OctreeInternalNode() {}
 
    static std::function<std::shared_ptr<OctreeInternalNode>()>
    GetInitFunction();
 
    static std::function<void(std::shared_ptr<OctreeInternalNode>)>
    GetUpdateFunction(size_t idx);
 
    bool ConvertToJsonValue(Json::Value& value) const override;
    bool ConvertFromJsonValue(const Json::Value& value) override;
 
public:
    std::vector<size_t> indices_;
};
 
class CV_DB_LIB_API OctreeLeafNode : public OctreeNode {
public:
    virtual bool operator==(const OctreeLeafNode& other) const = 0;
    virtual std::shared_ptr<OctreeLeafNode> Clone() const = 0;
};
 
class CV_DB_LIB_API OctreeColorLeafNode : public OctreeLeafNode {
public:
    bool operator==(const OctreeLeafNode& other) const override;
 
    std::shared_ptr<OctreeLeafNode> Clone() const override;
 
    static std::function<std::shared_ptr<OctreeLeafNode>()> GetInitFunction();
 
    static std::function<void(std::shared_ptr<OctreeLeafNode>)>
    GetUpdateFunction(const Eigen::Vector3d& color);
 
    bool ConvertToJsonValue(Json::Value& value) const override;
    bool ConvertFromJsonValue(const Json::Value& value) override;
    Eigen::Vector3d color_ = Eigen::Vector3d(0, 0, 0);
};
 
class CV_DB_LIB_API OctreePointColorLeafNode : public OctreeColorLeafNode {
public:
    bool operator==(const OctreeLeafNode& other) const override;
    std::shared_ptr<OctreeLeafNode> Clone() const override;
 
    static std::function<std::shared_ptr<OctreeLeafNode>()> GetInitFunction();
 
    static std::function<void(std::shared_ptr<OctreeLeafNode>)>
    GetUpdateFunction(size_t index, const Eigen::Vector3d& color);
 
    bool ConvertToJsonValue(Json::Value& value) const override;
    bool ConvertFromJsonValue(const Json::Value& value) override;
 
    std::vector<size_t> indices_;
};
 
class CV_DB_LIB_API Octree : public ccHObject,
                             public cloudViewer::utility::IJsonConvertible {
public:
    Octree(const char* name = "Octree2")
        : ccHObject(name), origin_(0, 0, 0), size_(0), max_depth_(0) {}
    Octree(const size_t& max_depth, const char* name = "Octree2")
        : ccHObject(name), origin_(0, 0, 0), size_(0), max_depth_(max_depth) {}
    Octree(const size_t& max_depth,
           const Eigen::Vector3d& origin,
           const double& size,
           const char* name = "Octree2")
        : ccHObject(name),
          origin_(origin),
          size_(size),
          max_depth_(max_depth) {}
    Octree(const Octree& src_octree, const char* name = "Octree2");
    ~Octree() override {}
 
    // inherited methods (ccHObject)
    virtual bool isSerializable() const override { return true; }
 
    virtual CV_CLASS_ENUM getClassID() const override {
        return CV_TYPES::POINT_OCTREE2;
    }
 
    virtual ccBBox getOwnBB(bool withGLFeatures = false) override;
 
public:
    Octree& Clear();
    inline virtual bool IsEmpty() const override {
        return root_node_ == nullptr;
    }
    virtual Eigen::Vector3d GetMinBound() const override;
    virtual Eigen::Vector3d GetMaxBound() const override;
    virtual Eigen::Vector3d GetCenter() const override;
    virtual ccBBox GetAxisAlignedBoundingBox() const override;
    virtual ecvOrientedBBox GetOrientedBoundingBox() const override;
    virtual Octree& Transform(const Eigen::Matrix4d& transformation) override;
    virtual Octree& Translate(const Eigen::Vector3d& translation,
                              bool relative = true) override;
    virtual Octree& Scale(const double s,
                          const Eigen::Vector3d& center) override;
    virtual Octree& Rotate(const Eigen::Matrix3d& R,
                           const Eigen::Vector3d& center) override;
    bool ConvertToJsonValue(Json::Value& value) const override;
    bool ConvertFromJsonValue(const Json::Value& value) override;
 
public:
    void ConvertFromPointCloud(const ccPointCloud& point_cloud,
                               double size_expand = 0.01);
 
    std::shared_ptr<OctreeNode> root_node_ = nullptr;
 
    Eigen::Vector3d origin_;
 
    double size_;
 
    size_t max_depth_;
 
    void InsertPoint(
            const Eigen::Vector3d& point,
            const std::function<std::shared_ptr<OctreeLeafNode>()>& fl_init,
            const std::function<void(std::shared_ptr<OctreeLeafNode>)>&
                    fl_update,
            const std::function<std::shared_ptr<OctreeInternalNode>()>&
                    fi_init = nullptr,
            const std::function<void(std::shared_ptr<OctreeInternalNode>)>&
                    fi_update = nullptr);
 
    void Traverse(
            const std::function<bool(const std::shared_ptr<OctreeNode>&,
                                     const std::shared_ptr<OctreeNodeInfo>&)>&
                    f);
 
    void Traverse(
            const std::function<bool(const std::shared_ptr<OctreeNode>&,
                                     const std::shared_ptr<OctreeNodeInfo>&)>&
                    f) const;
 
    std::pair<std::shared_ptr<OctreeLeafNode>, std::shared_ptr<OctreeNodeInfo>>
 
    LocateLeafNode(const Eigen::Vector3d& point) const;
 
    static bool IsPointInBound(const Eigen::Vector3d& point,
                               const Eigen::Vector3d& origin,
                               const double& size);
 
    bool operator==(const Octree& other) const;
 
    std::shared_ptr<geometry::VoxelGrid> ToVoxelGrid() const;
 
    void CreateFromVoxelGrid(const geometry::VoxelGrid& voxel_grid);
 
private:
    static void TraverseRecurse(
            const std::shared_ptr<OctreeNode>& node,
            const std::shared_ptr<OctreeNodeInfo>& node_info,
            const std::function<bool(const std::shared_ptr<OctreeNode>&,
                                     const std::shared_ptr<OctreeNodeInfo>&)>&
                    f);
 
    void InsertPointRecurse(
            const std::shared_ptr<OctreeNode>& node,
            const std::shared_ptr<OctreeNodeInfo>& node_info,
            const Eigen::Vector3d& point,
            const std::function<std::shared_ptr<OctreeLeafNode>()>& f_l_init,
            const std::function<void(std::shared_ptr<OctreeLeafNode>)>&
                    f_l_update,
            const std::function<std::shared_ptr<OctreeInternalNode>()>&
                    f_i_init,
            const std::function<void(std::shared_ptr<OctreeInternalNode>)>&
                    f_i_update);
};
 
}  // namespace geometry
}  // namespace cloudViewer