mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-16 00:05:45 -04:00
118 lines
3.3 KiB
Plaintext
118 lines
3.3 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/tiledscene/qgstiledsceneindex.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsTiledSceneIndex
|
|
{
|
|
%Docstring(signature="appended")
|
|
An index for tiled scene data providers.
|
|
|
|
This is a shallow copy, implicitly shared container for an underlying
|
|
:py:class:`QgsAbstractTiledSceneIndex` implementation.
|
|
|
|
The class is thread safe and can be used safely across multiple threads
|
|
or transferred between threads.
|
|
|
|
.. versionadded:: 3.34
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgstiledsceneindex.h"
|
|
%End
|
|
public:
|
|
|
|
|
|
~QgsTiledSceneIndex();
|
|
|
|
QgsTiledSceneIndex( const QgsTiledSceneIndex &other );
|
|
|
|
bool isValid() const;
|
|
%Docstring
|
|
Returns ``True`` if the index is valid.
|
|
%End
|
|
|
|
QgsTiledSceneTile rootTile() const;
|
|
%Docstring
|
|
Returns the root tile for the index.
|
|
%End
|
|
|
|
QgsTiledSceneTile getTile( long long id );
|
|
%Docstring
|
|
Returns the tile with matching ``id``, or an invalid tile if the
|
|
matching tile is not available.
|
|
%End
|
|
|
|
long long parentTileId( long long id ) const;
|
|
%Docstring
|
|
Returns the tile ID of the parent tile of the tile with matching ``id``,
|
|
or -1 if the tile has no parent.
|
|
|
|
.. seealso:: :py:func:`childTileIds`
|
|
%End
|
|
|
|
QVector< long long > childTileIds( long long id ) const;
|
|
%Docstring
|
|
Returns a list of the tile IDs of any children for the tile with
|
|
matching ``id``.
|
|
|
|
.. seealso:: :py:func:`parentTileId`
|
|
%End
|
|
|
|
QVector< long long > getTiles( const QgsTiledSceneRequest &request );
|
|
%Docstring
|
|
Returns the list of tile IDs which match the given ``request``.
|
|
|
|
May return an empty list if no data satisfies the request.
|
|
%End
|
|
|
|
Qgis::TileChildrenAvailability childAvailability( long long id ) const;
|
|
%Docstring
|
|
Returns the availability for a tile's children.
|
|
|
|
.. seealso:: :py:func:`fetchHierarchy`
|
|
%End
|
|
|
|
bool fetchHierarchy( long long id, QgsFeedback *feedback = 0 );
|
|
%Docstring
|
|
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.
|
|
|
|
.. seealso:: :py:func:`childAvailability`
|
|
%End
|
|
|
|
QByteArray retrieveContent( const QString &uri, QgsFeedback *feedback = 0 );
|
|
%Docstring
|
|
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.
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/tiledscene/qgstiledsceneindex.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|