1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
|
/************************************************************************
* 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 *
************************************************************************/
|