CN_RTREE< T > Class Template Reference

CN_RTREE - Implements an R-tree for fast spatial indexing of connectivity items. More...

#include <connectivity_rtree.h>

Public Types
using	TREE = KIRTREE::DYNAMIC_RTREE<T, int, 3>
	Entry type accepted by BulkLoad().
using	BULK_ENTRY = typename TREE::BULK_ENTRY

Public Member Functions
	CN_RTREE ()=default
	~CN_RTREE ()=default
	CN_RTREE (CN_RTREE &&aOther) noexcept=default
CN_RTREE &	operator= (CN_RTREE &&aOther) noexcept=default
	CN_RTREE (const CN_RTREE &)=delete
CN_RTREE &	operator= (const CN_RTREE &)=delete
void	Insert (T aItem)
	Function Insert() Inserts an item into the tree.
void	Remove (T aItem)
	Function Remove() Removes an item from the tree.
void	RemoveAll ()
	Function RemoveAll() Removes all items from the RTree.
void	BulkLoad (std::vector< BULK_ENTRY > &aEntries)
	Function BulkLoad() Replaces the tree contents with aEntries, packed bottom-up.
template<class Visitor>
void	Query (const BOX2I &aBounds, int aStartLayer, int aEndLayer, Visitor &aVisitor) const
	Function Query() Executes a function object aVisitor for each item whose bounding box intersects with aBounds.

Private Attributes
TREE	m_tree

Detailed Description

template<class T>
class CN_RTREE< T >

CN_RTREE - Implements an R-tree for fast spatial indexing of connectivity items.

Non-owning.

Definition at line 36 of file connectivity_rtree.h.

Member Typedef Documentation

BULK_ENTRY

template<class T>

using CN_RTREE< T >::BULK_ENTRY = typename TREE::BULK_ENTRY

Definition at line 42 of file connectivity_rtree.h.

TREE

template<class T>

using CN_RTREE< T >::TREE = KIRTREE::DYNAMIC_RTREE<T, int, 3>

Entry type accepted by BulkLoad().

Definition at line 39 of file connectivity_rtree.h.

Constructor & Destructor Documentation

CN_RTREE() [1/3]

template<class T>

CN_RTREE< T >::CN_RTREE ( )

default

Referenced by CN_RTREE(), CN_RTREE(), operator=(), and operator=().

~CN_RTREE()

template<class T>

CN_RTREE< T >::~CN_RTREE ( )

default

CN_RTREE() [2/3]

template<class T>

CN_RTREE< T >::CN_RTREE ( CN_RTREE< T > && aOther )

defaultnoexcept

References CN_RTREE().

CN_RTREE() [3/3]

template<class T>

CN_RTREE< T >::CN_RTREE ( const CN_RTREE< T > & )

delete

References CN_RTREE().

Member Function Documentation

BulkLoad()

template<class T>

void CN_RTREE< T >::BulkLoad ( std::vector< BULK_ENTRY > & aEntries )

inline

Function BulkLoad() Replaces the tree contents with aEntries, packed bottom-up.

Much cheaper than the same number of Insert() calls, which each pay for an R*-tree subtree choice and may cascade into forced reinsertion.

Definition at line 99 of file connectivity_rtree.h.

References m_tree.

Insert()

template<class T>

void CN_RTREE< T >::Insert ( T aItem )

inline

Function Insert() Inserts an item into the tree.

Item's bounding box is taken via its BBox() method.

Definition at line 57 of file connectivity_rtree.h.

References BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), m_tree, and T.

operator=() [1/2]

template<class T>

CN_RTREE & CN_RTREE< T >::operator= ( CN_RTREE< T > && aOther )

defaultnoexcept

References CN_RTREE().

operator=() [2/2]

template<class T>

CN_RTREE & CN_RTREE< T >::operator= ( const CN_RTREE< T > & )

delete

References CN_RTREE().

Query()

template<class T>

template<class Visitor>

void CN_RTREE< T >::Query ( const BOX2I & aBounds, int aStartLayer, int aEndLayer, Visitor & aVisitor ) const

inline

Function Query() Executes a function object aVisitor for each item whose bounding box intersects with aBounds.

Definition at line 110 of file connectivity_rtree.h.

References BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), and m_tree.

Remove()

template<class T>

void CN_RTREE< T >::Remove ( T aItem )

inline

Function Remove() Removes an item from the tree.

Removal is done by comparing pointers, attempting to remove a copy of the item will fail.

Definition at line 72 of file connectivity_rtree.h.

References BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), m_tree, and T.

RemoveAll()

template<class T>

void CN_RTREE< T >::RemoveAll ( )

inline

Function RemoveAll() Removes all items from the RTree.

Definition at line 88 of file connectivity_rtree.h.

References m_tree.

Member Data Documentation

m_tree

template<class T>

TREE CN_RTREE< T >::m_tree

private

Definition at line 120 of file connectivity_rtree.h.

Referenced by BulkLoad(), Insert(), Query(), Remove(), and RemoveAll().

---

The documentation for this class was generated from the following file:

• connectivity_rtree.h