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

Abstract base class for spatial index implementations. More...

#include <RSpatialIndex.h>

Inheritance diagram for RSpatialIndex:
RRequireHeap RSpatialIndexNavel RSpatialIndexSimple

List of all members.

Public Member Functions

virtual void addToIndex (int id, int pos, double x1, double y1, double z1, double x2, double y2, double z2)=0
 Adds a new entry into this spatial index.
virtual void addToIndex (int id, int pos, const RBox &bb)
 Adds a new entry into this spatial index.
virtual void addToIndex (int id, const QList< RBox > &bbs)
 Adds a new entry at multiple positions into this spatial index.
virtual void clear ()=0
virtual QMap< int, QSet< int > > queryContained (double x1, double y1, double z1, double x2, double y2, double z2, RSpatialIndexVisitor *dataVisitor=NULL)=0
 Queries the index for all items that are completely inside the given box x1,y1,z1,x2,y2,z2.
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 (double x1, double y1, double z1, double x2, double y2, double z2, RSpatialIndexVisitor *dataVisitor=NULL)=0
 Queries the index for all items that are completely inside or intersect with the given box x1,y1,z1,x2,y2,z2.
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.
virtual QMap< int, QSet< int > > queryNearestNeighbor (unsigned int k, double x, double y, double z, RSpatialIndexVisitor *dataVisitor=NULL)=0
 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, int pos, double x1, double y1, double z1, double x2, double y2, double z2)=0
 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, const QList< RBox > &bb)
 Removes the entry with the given ID from this spatial index.
 RSpatialIndex ()
virtual ~RSpatialIndex ()
- Public Member Functions inherited from RRequireHeap
void doDelete ()

Static Public Member Functions

static int getId (qint64 siid)
static int getPos (qint64 siid)
static qint64 getSIId (int id, int pos)

Protected Attributes

int idCounter

Additional Inherited Members

- Protected Member Functions inherited from RRequireHeap
virtual ~RRequireHeap ()

Detailed Description

Abstract base class for spatial index implementations.

Scriptable:
This class is wrapped for script environments.

Constructor & Destructor Documentation

RSpatialIndex::RSpatialIndex ( )
inline
virtual RSpatialIndex::~RSpatialIndex ( )
inlinevirtual

Member Function Documentation

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

Adds a new entry into this spatial index.

Implemented in RSpatialIndexNavel, and RSpatialIndexSimple.

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

Adds a new entry into this spatial index.

Reimplemented in RSpatialIndexNavel.

void RSpatialIndex::addToIndex ( int  id,
const QList< RBox > &  bbs 
)
virtual

Adds a new entry at multiple positions into this spatial index.

virtual void RSpatialIndex::clear ( )
pure virtual
int RSpatialIndex::getId ( qint64  siid)
static
int RSpatialIndex::getPos ( qint64  siid)
static
qint64 RSpatialIndex::getSIId ( int  id,
int  pos 
)
static
virtual QMap<int, QSet<int> > RSpatialIndex::queryContained ( double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2,
RSpatialIndexVisitor dataVisitor = NULL 
)
pure 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).

Implemented in RSpatialIndexNavel, and RSpatialIndexSimple.

QMap< int, QSet< int > > RSpatialIndex::queryContained ( const RBox b,
RSpatialIndexVisitor dataVisitor = NULL 
)
virtual

Queries the index for all items that are completely inside the given box.

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

Queries the index for all items that are completely inside or intersect with 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).
Returns:
map with IDs as keys and positions as values

Implemented in RSpatialIndexNavel, and RSpatialIndexSimple.

QMap< int, QSet< int > > RSpatialIndex::queryIntersected ( const RBox b,
RSpatialIndexVisitor dataVisitor = NULL 
)
virtual

Queries the index for all items that are completely inside or intersect with the given box.

virtual QMap<int, QSet<int> > RSpatialIndex::queryNearestNeighbor ( unsigned int  k,
double  x,
double  y,
double  z,
RSpatialIndexVisitor dataVisitor = NULL 
)
pure 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).

Implemented in RSpatialIndexNavel.

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

Convenience implementation for scripts.

Reimplemented in RSpatialIndexNavel.

virtual bool RSpatialIndex::removeFromIndex ( int  id,
int  pos,
double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2 
)
pure 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.

Implemented in RSpatialIndexNavel, and RSpatialIndexSimple.

bool RSpatialIndex::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 in RSpatialIndexNavel.

bool RSpatialIndex::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 in RSpatialIndexNavel, and RSpatialIndexSimple.


Member Data Documentation

int RSpatialIndex::idCounter
protected

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