IPointIndexLeaf.hpp

#pragma once
 
 
#include "DM/config.hpp"
#include "DM/Handle.hpp"
#include "DM/Iterator.hpp"
#include "DM/IPoint.hpp"
#include "DM/IPolygon.hpp"
#include "DM/IWindow.hpp"
#include "DM/IBox.hpp"
#include "DM/ICircle.hpp"
#include "DM/ISphere.hpp"
#include "DM/ICylinder.hpp"
#include "DM/ObjectBase.hpp"
#include "DM/IKnnQueryDescriptor.hpp"
#include "DM/IFilter.hpp"
#include "DM/IColBufferManagerWrite.hpp"
#include "DM/AutoLink.hpp" //enable autolink
 
DM_NAMESPACE_BEGIN
 
class IIndexMapSet;
class IIndexHelperSet;
class IClassificationMatrix;
 
/// \brief object representing a spatial leaf within a point index
/**  Whereas IPointIndexLeaf objects are fully kept in memory, IPointIndex objects may consists of multiple
     IPointIndexLeaf objects that can be swapped to disk. For details see \ref dm_structure  
*/
class DM_API IPointIndexLeaf : public ObjectBase
{
public:
  struct kd_tree_tag {};
  struct kd_tree_with_lazy_deletion_tag {};
  
  /// create a new kd tree object
  static IPointIndexLeaf* New(const kd_tree_tag &,                    int dimension, bool threadsafe);
  static IPointIndexLeaf* New(const kd_tree_with_lazy_deletion_tag &, int dimension, bool threadsafe);
 
 
  // Iterator typedefs ============================================================================
  typedef ConstIterator<IPoint>       const_iterator_point;     ///< Point iterator
  typedef InsertIterator<IPoint>      insert_iterator_point;    ///< Point insert iterator (used in searchPoint functions)
 
protected:
  virtual ~IPointIndexLeaf() {}
 
public: 
  // General memeber functions ====================================================================
  virtual BoxHandle getLimit() const = 0;       ///< get points based bounding box
  virtual BoxHandle getIndexLimit() const = 0;  ///< get index based bounding box (if no index bounding available the points based bounding box is returned)
 
  virtual int64_t sizePoint() const = 0;
  virtual int     indexDim()  const = 0;
 
  virtual int64_t id() const = 0;         ///< identifier for direct leaf access by the IPointIndex object
  virtual int64_t storageId() const = 0;  ///< get id of storage manager 
 
  virtual double  estimatePointDensity() const = 0;
 
  virtual IPointIndexLeaf* clone() const = 0;
 
  // Iterator function ============================================================================
  virtual const_iterator_point beginPoint() const = 0;
  virtual const_iterator_point endPoint() const = 0;
 
  // access functions ============================================================================
  virtual PointHandle getPoint(int64_t id) const = 0; ///< get point by id (if the id doesn't exist within the leaf an empty handle is returned)
 
  // modifier functions ==========================================================================
  virtual void addPoint(const IPoint &pt) = 0;
  virtual void addPoint(PointHandle pt) = 0;
 
  virtual void removePoint(int64_t id) = 0;
 
  virtual void build() = 0;
  virtual void clear() = 0;
 
  virtual void setChanged(bool changed) = 0;
  virtual bool isChanged() const = 0;
 
  // Spatial access functions =====================================================================
  virtual void searchPoint(const IWindow &win, insert_iterator_point &instIt,       bool includeRightBoundary = true) = 0;
  virtual void searchPoint(const IBox &box,    insert_iterator_point &instIt,       bool includeRightBoundary = true) = 0;
  virtual void searchPoint(const IPolygon &p,  insert_iterator_point &instIt) = 0;
  virtual void searchPoint(const ICircle &c,   insert_iterator_point &instIt) = 0;
  virtual void searchPoint(const ISphere &s,   insert_iterator_point &instIt) = 0;
  virtual void searchPoint(const ICylinder &c, insert_iterator_point &instIt) = 0;
 
  virtual void searchPoint(int nnCount, const IPoint &queryPt, insert_iterator_point &instIt, 
                        double maxDistance = -1, SelectionMode selectionMode = SelectionMode::nearest) = 0;
  virtual void searchPoint(int nnCount, const IPoint &queryPt, const IFilter &filter, insert_iterator_point &instIt,
                        double maxDistance = -1, SelectionMode selectionMode = SelectionMode::nearest) = 0;
 
  // Comparision operator =========================================================================
  virtual bool operator==(const IPointIndexLeaf &ref) const = 0;
  virtual bool operator!=(const IPointIndexLeaf &ref) const = 0;
 
};
typedef Handle< IPointIndexLeaf > PointIndexLeafHandle;
 
DM_NAMESPACE_END