QCAD
Open Source 2D CAD
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
RSpatialIndexNavel Class Reference

Spatial index class. More...

#include <RSpatialIndexNavel.h>

Inheritance diagram for RSpatialIndexNavel:
RSpatialIndex RRequireHeap

List of all members.

Classes

class  RSiPoint
 Internal representation of a point. More...
class  RSiRegion
 Internal representation of a rectangular region. More...
class  Visitor
 Internal node and data visitor. More...

Public Member Functions

virtual void addToIndex (int id, int pos, double x1, double y1, double z1, double x2, double y2, double z2)
 Adds an item to the index.
virtual void addToIndex (int id, int pos, const RBox &bb)
 Adds a new entry into this spatial index.
virtual void clear ()
virtual QMap< int, QSet< int > > queryContained (double x1, double y1, double z1, double x2, double y2, double z2, RSpatialIndexVisitor *dataVisitor=NULL)
 Queries the index for all items that are completely inside the given box x1,y1,z1,x2,y2,z2.
virtual QMap< int, QSet< int > > queryIntersected (double x1, double y1, double z1, double x2, double y2, double z2, RSpatialIndexVisitor *dataVisitor=NULL)
 Removes the item with the given ID from this spatial index.
virtual QMap< int, QSet< int > > queryNearestNeighbor (unsigned int k, double x, double y, double z, RSpatialIndexVisitor *dataVisitor=NULL)
 Queries the index for closest neighbor items.
virtual QPair< int, int > queryNearestNeighbor (double x, double y, double z)
 Convenience implementation for scripts.
virtual bool removeFromIndex (int id, const QList< RBox > &bb)
 Removes the entry with the given ID from this spatial index.
virtual bool removeFromIndex (int id, int pos, const RBox &bb)
 Removes the entry with the given ID from this spatial index.
virtual bool removeFromIndex (int id, int pos, double x1, double y1, double z1, double x2, double y2, double z2)
 Removes the entry with the given ID from this spatial index.
 RSpatialIndexNavel ()
 Creates a 2d spatial index in memory (r-tree, star shape).
 ~RSpatialIndexNavel ()
- Public Member Functions inherited from RSpatialIndex
virtual void addToIndex (int id, const QList< RBox > &bbs)
 Adds a new entry at multiple positions into this spatial index.
virtual QMap< int, QSet< int > > queryContained (const RBox &b, RSpatialIndexVisitor *dataVisitor=NULL)
 Queries the index for all items that are completely inside the given box.
virtual QMap< int, QSet< int > > queryIntersected (const RBox &b, RSpatialIndexVisitor *dataVisitor=NULL)
 Queries the index for all items that are completely inside or intersect with the given box.
 RSpatialIndex ()
virtual ~RSpatialIndex ()
- Public Member Functions inherited from RRequireHeap
void doDelete ()

Protected Member Functions

void addToIndex (int id, int pos, const RSiRegion &region, size_t dataLength=0, const uint8_t *data=NULL)
 Internal.
void init ()
QMap< int, QSet< int > > queryContained (const RSiRegion &region, RSpatialIndexVisitor *dataVisitor=NULL)
 Internal.
QMap< int, QSet< int > > queryIntersected (const RSiRegion &region, RSpatialIndexVisitor *dataVisitor=NULL)
 Internal.
QMap< int, QSet< int > > queryNearestNeighbor (unsigned int k, const RSiPoint &point, RSpatialIndexVisitor *dataVisitor=NULL)
 Internal.
void uninit ()

Protected Attributes

SpatialIndex::IStorageManager * buff
SpatialIndex::ISpatialIndex * tree
- Protected Attributes inherited from RSpatialIndex
int idCounter

Additional Inherited Members

- Static Public Member Functions inherited from RSpatialIndex
static int getId (qint64 siid)
static int getPos (qint64 siid)
static qint64 getSIId (int id, int pos)

Detailed Description

Spatial index class.

Each instance of this class offers a spatial index. This class wraps the API of the "spatial index" library.

Scriptable:
This class is wrapped for script environments.

Constructor & Destructor Documentation

RSpatialIndexNavel::RSpatialIndexNavel ( )

Creates a 2d spatial index in memory (r-tree, star shape).

RSpatialIndexNavel::~RSpatialIndexNavel ( )

Member Function Documentation

void RSpatialIndexNavel::addToIndex ( int  id,
int  pos,
double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2 
)
virtual

Adds an item to the index.

Parameters:
idID of the item.
x1lower value of the first dimension.
y1lower value of the second dimension.
z1lower value of the third dimension.
x2higher value of the first dimension.
y2higher value of the second dimension.
z2higher value of the third dimension.
dataLengthLegth of the data in bytes or 0.
dataPointer to the data associated with the item. The index makes a deep copy of the data, the caller is responsible for deleting the data. NULL indicates that the item data is stored externally (e.g. in a map or list).

Implements RSpatialIndex.

void RSpatialIndexNavel::addToIndex ( int  id,
int  pos,
const RBox bb 
)
virtual

Adds a new entry into this spatial index.

Reimplemented from RSpatialIndex.

void RSpatialIndexNavel::addToIndex ( int  id,
int  pos,
const RSiRegion region,
size_t  dataLength = 0,
const uint8_t *  data = NULL 
)
protected

Internal.

   \par Non-Scriptable:

This function is not available in script environments.

void RSpatialIndexNavel::clear ( )
virtual

Implements RSpatialIndex.

void RSpatialIndexNavel::init ( )
protected
QMap< int, QSet< int > > RSpatialIndexNavel::queryContained ( double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2,
RSpatialIndexVisitor dataVisitor = NULL 
)
virtual

Queries the index for all items that are completely inside the given box x1,y1,z1,x2,y2,z2.

Parameters:
x1lower region boundary of the first dimension.
y1lower region boundary of the second dimension.
z1lower region boundary of the third dimension.
x2higher region boundary of the first dimension.
y2higher region boundary of the second dimension.
z2higher region boundary of the third dimension.
dataVisitorThe item data is handed back to the caller over this object (visitor pattern).

Implements RSpatialIndex.

QMap< int, QSet< int > > RSpatialIndexNavel::queryContained ( const RSiRegion region,
RSpatialIndexVisitor dataVisitor = NULL 
)
protected

Internal.

   \par Non-Scriptable:

This function is not available in script environments.

QMap< int, QSet< int > > RSpatialIndexNavel::queryIntersected ( double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2,
RSpatialIndexVisitor dataVisitor = NULL 
)
virtual

Removes the item with the given ID from this spatial index.

Implements RSpatialIndex.

QMap< int, QSet< int > > RSpatialIndexNavel::queryIntersected ( const RSiRegion region,
RSpatialIndexVisitor dataVisitor = NULL 
)
protected

Internal.

   \par Non-Scriptable:

This function is not available in script environments.

QMap< int, QSet< int > > RSpatialIndexNavel::queryNearestNeighbor ( unsigned int  k,
double  x,
double  y,
double  z,
RSpatialIndexVisitor dataVisitor = NULL 
)
virtual

Queries the index for closest neighbor items.

Parameters:
x1position of the first dimension.
y1position of the second dimension.
z1position of the third dimension.
dataVisitorThe item data is handed back to the caller over this object (visitor pattern).

Implements RSpatialIndex.

QPair< int, int > RSpatialIndexNavel::queryNearestNeighbor ( double  x,
double  y,
double  z 
)
virtual

Convenience implementation for scripts.

Reimplemented from RSpatialIndex.

QMap< int, QSet< int > > RSpatialIndexNavel::queryNearestNeighbor ( unsigned int  k,
const RSiPoint point,
RSpatialIndexVisitor dataVisitor = NULL 
)
protected

Internal.

   \par Non-Scriptable:

This function is not available in script environments.

bool RSpatialIndexNavel::removeFromIndex ( int  id,
const QList< RBox > &  bb 
)
virtual

Removes the entry with the given ID from this spatial index.

the bounding boxes are provided for faster lookup.

Reimplemented from RSpatialIndex.

bool RSpatialIndexNavel::removeFromIndex ( int  id,
int  pos,
const RBox bb 
)
virtual

Removes the entry with the given ID from this spatial index.

the bounding box is provided for faster lookup.

Reimplemented from RSpatialIndex.

bool RSpatialIndexNavel::removeFromIndex ( int  id,
int  pos,
double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2 
)
virtual

Removes the entry with the given ID from this spatial index.

Removes the entry with the given ID from this spatial index. the bounding box is provided for fast lookup.

Implements RSpatialIndex.

void RSpatialIndexNavel::uninit ( )
protected

Member Data Documentation

SpatialIndex::IStorageManager* RSpatialIndexNavel::buff
protected
SpatialIndex::ISpatialIndex* RSpatialIndexNavel::tree
protected

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