QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsTiledSceneIndex Class Reference

An index for tiled scene data providers. More...

#include <qgstiledsceneindex.h>

Public Member Functions

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

Detailed Description

An index for tiled scene data providers.

This is a shallow copy, implicitly shared container for an underlying QgsAbstractTiledSceneIndex implementation.

The class is thread safe and can be used safely across multiple threads or transferred between threads.

Since
QGIS 3.34

Definition at line 146 of file qgstiledsceneindex.h.

Constructor & Destructor Documentation

◆ QgsTiledSceneIndex() [1/2]

QgsTiledSceneIndex::QgsTiledSceneIndex ( QgsAbstractTiledSceneIndex index = nullptr)
explicit

Constructor for QgsTiledSceneIndex.

The specified index implementation will be transferred to the index.

Note
Not available in Python bindings.

Definition at line 55 of file qgstiledsceneindex.cpp.

◆ ~QgsTiledSceneIndex()

QgsTiledSceneIndex::~QgsTiledSceneIndex ( )
default

◆ QgsTiledSceneIndex() [2/2]

QgsTiledSceneIndex::QgsTiledSceneIndex ( const QgsTiledSceneIndex other)

Definition at line 63 of file qgstiledsceneindex.cpp.

Member Function Documentation

◆ childAvailability()

Qgis::TileChildrenAvailability QgsTiledSceneIndex::childAvailability ( long long  id) const

Returns the availability for a tile's children.

See also
fetchHierarchy()

Definition at line 123 of file qgstiledsceneindex.cpp.

◆ childTileIds()

QVector< long long > QgsTiledSceneIndex::childTileIds ( long long  id) const

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

See also
parentTileId()

Definition at line 107 of file qgstiledsceneindex.cpp.

◆ fetchHierarchy()

bool QgsTiledSceneIndex::fetchHierarchy ( long long  id,
QgsFeedback feedback = nullptr 
)

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()

Definition at line 131 of file qgstiledsceneindex.cpp.

◆ getTile()

QgsTiledSceneTile QgsTiledSceneIndex::getTile ( long long  id)

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

Definition at line 91 of file qgstiledsceneindex.cpp.

◆ getTiles()

QVector< long long > QgsTiledSceneIndex::getTiles ( const QgsTiledSceneRequest request)

Returns the list of tile IDs which match the given request.

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

Definition at line 115 of file qgstiledsceneindex.cpp.

◆ isValid()

bool QgsTiledSceneIndex::isValid ( ) const

Returns true if the index is valid.

Definition at line 78 of file qgstiledsceneindex.cpp.

◆ operator=()

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

Definition at line 69 of file qgstiledsceneindex.cpp.

◆ parentTileId()

long long QgsTiledSceneIndex::parentTileId ( long long  id) const

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()

Definition at line 99 of file qgstiledsceneindex.cpp.

◆ retrieveContent()

QByteArray QgsTiledSceneIndex::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 139 of file qgstiledsceneindex.cpp.

◆ rootTile()

QgsTiledSceneTile QgsTiledSceneIndex::rootTile ( ) const

Returns the root tile for the index.

Definition at line 83 of file qgstiledsceneindex.cpp.


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