QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Protected Member Functions | List of all members
QgsAbstractTiledSceneIndex Class Referenceabstract
core library

An abstract base class for tiled scene data provider indices. More...

#include <qgstiledsceneindex.h>

Public Member Functions

 QgsAbstractTiledSceneIndex ()
 
 QgsAbstractTiledSceneIndex (const QgsAbstractTiledSceneIndex &other)=delete
 QgsAbstractTiledSceneIndex cannot be copied. More...
 
virtual ~QgsAbstractTiledSceneIndex ()
 
virtual Qgis::TileChildrenAvailability childAvailability (long long id) const =0
 Returns the availability for a tile's children. More...
 
virtual QVector< long long > childTileIds (long long id) const =0
 Returns a list of the tile IDs of any children for the tile with matching id. More...
 
virtual bool fetchHierarchy (long long id, QgsFeedback *feedback=nullptr)=0
 Populates the tile with the given id by fetching any sub datasets attached to the tile. More...
 
virtual QgsTiledSceneTile getTile (long long id)=0
 Returns the tile with matching id, or an invalid tile if the matching tile is not available. More...
 
virtual QVector< long long > getTiles (const QgsTiledSceneRequest &request)=0
 Returns the tile IDs which match the given request. More...
 
QgsAbstractTiledSceneIndex & operator= (const QgsAbstractTiledSceneIndex &other)=delete
 QgsAbstractTiledSceneIndex cannot be copied. More...
 
virtual long long parentTileId (long long id) const =0
 Returns the tile ID of the parent tile of the tile with matching id, or -1 if the tile has no parent. More...
 
QByteArray retrieveContent (const QString &uri, QgsFeedback *feedback=nullptr)
 Retrieves index content for the specified uri. More...
 
virtual QgsTiledSceneTile rootTile () const =0
 Returns the root tile for the index. More...
 

Protected Member Functions

virtual QByteArray fetchContent (const QString &uri, QgsFeedback *feedback=nullptr)=0
 Fetches index content for the specified uri. More...
 

Detailed Description

An abstract base class for tiled scene data provider indices.

Warning
Subclasses must take care to ensure that their operation is thread safe, as the same index object will potentially be used by multiple threads concurrently.
Since
QGIS 3.34

Definition at line 43 of file qgstiledsceneindex.h.

Constructor & Destructor Documentation

◆ QgsAbstractTiledSceneIndex() [1/2]

QgsAbstractTiledSceneIndex::QgsAbstractTiledSceneIndex ( )

Definition at line 26 of file qgstiledsceneindex.cpp.

◆ ~QgsAbstractTiledSceneIndex()

QgsAbstractTiledSceneIndex::~QgsAbstractTiledSceneIndex ( )
virtualdefault

◆ QgsAbstractTiledSceneIndex() [2/2]

QgsAbstractTiledSceneIndex::QgsAbstractTiledSceneIndex ( const QgsAbstractTiledSceneIndex &  other)
delete

QgsAbstractTiledSceneIndex cannot be copied.

Member Function Documentation

◆ childAvailability()

virtual Qgis::TileChildrenAvailability QgsAbstractTiledSceneIndex::childAvailability ( long long  id) const
pure virtual

Returns the availability for a tile's children.

See also
fetchHierarchy()

◆ childTileIds()

virtual QVector< long long > QgsAbstractTiledSceneIndex::childTileIds ( long long  id) const
pure virtual

Returns a list of the tile IDs of any children for the tile with matching id.

See also
parentTileId()

◆ fetchContent()

virtual QByteArray QgsAbstractTiledSceneIndex::fetchContent ( const QString &  uri,
QgsFeedback *  feedback = nullptr 
)
protectedpure virtual

Fetches index content for the specified uri.

This must be implemented in subclasses to retrieve the corresponding binary content, including performing any necessary network requests.

The optional feedback argument can be used the cancel the request early.

◆ fetchHierarchy()

virtual bool QgsAbstractTiledSceneIndex::fetchHierarchy ( long long  id,
QgsFeedback *  feedback = nullptr 
)
pure virtual

Populates the tile with the given id by fetching any sub datasets attached to the tile.

Blocks while the child fetching is in progress.

Returns true if the population was successful.

See also
childAvailability()

◆ getTile()

virtual QgsTiledSceneTile QgsAbstractTiledSceneIndex::getTile ( long long  id)
pure virtual

Returns the tile with matching id, or an invalid tile if the matching tile is not available.

◆ getTiles()

virtual QVector< long long > QgsAbstractTiledSceneIndex::getTiles ( const QgsTiledSceneRequest &  request)
pure virtual

Returns the tile IDs which match the given request.

May return an empty list if no data satisfies the request.

◆ operator=()

QgsAbstractTiledSceneIndex & QgsAbstractTiledSceneIndex::operator= ( const QgsAbstractTiledSceneIndex &  other)
delete

QgsAbstractTiledSceneIndex cannot be copied.

◆ parentTileId()

virtual long long QgsAbstractTiledSceneIndex::parentTileId ( long long  id) const
pure virtual

Returns the tile ID of the parent tile of the tile with matching id, or -1 if the tile has no parent.

See also
childTileIds()

◆ retrieveContent()

QByteArray QgsAbstractTiledSceneIndex::retrieveContent ( const QString &  uri,
QgsFeedback *  feedback = nullptr 
)

Retrieves index content for the specified uri.

The content is cached within the index, so multiple calls are potentially cost-free.

The optional feedback argument can be used the cancel the request early.

Definition at line 33 of file qgstiledsceneindex.cpp.

◆ rootTile()

virtual QgsTiledSceneTile QgsAbstractTiledSceneIndex::rootTile ( ) const
pure virtual

Returns the root tile for the index.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.4