QGIS API Documentation  2.12.0-Lyon
Public Member Functions | Static Protected Member Functions | Friends | List of all members
QgsSpatialIndex Class Reference

#include <qgsspatialindex.h>

Public Member Functions

 QgsSpatialIndex ()
 Constructor - creates R-tree. More...
 
 QgsSpatialIndex (const QgsFeatureIterator &fi)
 Constructor - creates R-tree and bulk loads it with features from the iterator. More...
 
 QgsSpatialIndex (const QgsSpatialIndex &other)
 Copy constructor. More...
 
 ~QgsSpatialIndex ()
 Destructor finalizes work with spatial index. More...
 
bool deleteFeature (const QgsFeature &f)
 Remove feature from index. More...
 
bool insertFeature (const QgsFeature &f)
 Add feature to index. More...
 
QList< QgsFeatureIdintersects (const QgsRectangle &rect) const
 Returns features that intersect the specified rectangle. More...
 
QList< QgsFeatureIdnearestNeighbor (const QgsPoint &point, int neighbors) const
 Returns nearest neighbors (their count is specified by second parameter) More...
 
QgsSpatialIndexoperator= (const QgsSpatialIndex &other)
 Implement assignment operator. More...
 
QAtomicInt refs () const
 get reference count - just for debugging! More...
 

Static Protected Member Functions

static bool featureInfo (const QgsFeature &f, SpatialIndex::Region &r, QgsFeatureId &id)
 
static SpatialIndex::Region rectToRegion (const QgsRectangle &rect)
 

Friends

class QgsFeatureIteratorDataStream
 

Detailed Description

Definition at line 45 of file qgsspatialindex.h.

Constructor & Destructor Documentation

QgsSpatialIndex::QgsSpatialIndex ( )

Constructor - creates R-tree.

Definition at line 201 of file qgsspatialindex.cpp.

QgsSpatialIndex::QgsSpatialIndex ( const QgsFeatureIterator fi)
explicit

Constructor - creates R-tree and bulk loads it with features from the iterator.

This is much faster approach than creating an empty index and then inserting features one by one.

Note
added in 2.8

Definition at line 206 of file qgsspatialindex.cpp.

QgsSpatialIndex::QgsSpatialIndex ( const QgsSpatialIndex other)

Copy constructor.

Definition at line 211 of file qgsspatialindex.cpp.

QgsSpatialIndex::~QgsSpatialIndex ( )

Destructor finalizes work with spatial index.

Definition at line 216 of file qgsspatialindex.cpp.

Member Function Documentation

bool QgsSpatialIndex::deleteFeature ( const QgsFeature f)

Remove feature from index.

Definition at line 281 of file qgsspatialindex.cpp.

bool QgsSpatialIndex::featureInfo ( const QgsFeature f,
SpatialIndex::Region &  r,
QgsFeatureId id 
)
staticprotected

Definition at line 237 of file qgsspatialindex.cpp.

bool QgsSpatialIndex::insertFeature ( const QgsFeature f)

Add feature to index.

Definition at line 250 of file qgsspatialindex.cpp.

QList< QgsFeatureId > QgsSpatialIndex::intersects ( const QgsRectangle rect) const

Returns features that intersect the specified rectangle.

Definition at line 292 of file qgsspatialindex.cpp.

QList< QgsFeatureId > QgsSpatialIndex::nearestNeighbor ( const QgsPoint point,
int  neighbors 
) const

Returns nearest neighbors (their count is specified by second parameter)

Definition at line 304 of file qgsspatialindex.cpp.

QgsSpatialIndex & QgsSpatialIndex::operator= ( const QgsSpatialIndex other)

Implement assignment operator.

Definition at line 220 of file qgsspatialindex.cpp.

Region QgsSpatialIndex::rectToRegion ( const QgsRectangle rect)
staticprotected

Definition at line 227 of file qgsspatialindex.cpp.

QAtomicInt QgsSpatialIndex::refs ( ) const

get reference count - just for debugging!

Definition at line 319 of file qgsspatialindex.cpp.

Friends And Related Function Documentation

friend class QgsFeatureIteratorDataStream
friend

Definition at line 99 of file qgsspatialindex.h.


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