Class: QgsTiledSceneIndex¶

class qgis.core.QgsTiledSceneIndex¶

Bases: sip.wrapper

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.

Added in version 3.34.

QgsTiledSceneIndex(other: QgsTiledSceneIndex) Copy constructor

Methods

childAvailability

Returns the availability for a tile's children.

childTileIds

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

fetchHierarchy

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

getTile

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

getTiles

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

isValid

Returns True if the index is valid.

parentTileId

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

retrieveContent

Retrieves index content for the specified uri.

rootTile

Returns the root tile for the index.

childAvailability(self, id: int) → Qgis.TileChildrenAvailability¶

Returns the availability for a tile’s children.

See also

fetchHierarchy()

Parameters:: id (int)
Return type:: Qgis.TileChildrenAvailability

childTileIds(self, id: int) → List[int]¶

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

See also

parentTileId()

Parameters:: id (int)
Return type:: List[int]

fetchHierarchy(self, id: int, feedback: QgsFeedback = None) → bool¶

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

Parameters:

id (int)
feedback (QgsFeedback = None)

Return type:

bool

getTile(self, id: int) → QgsTiledSceneTile¶

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

Parameters:: id (int)
Return type:: QgsTiledSceneTile

getTiles(self, request: QgsTiledSceneRequest) → List[int]¶

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

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

Parameters:: request (QgsTiledSceneRequest)
Return type:: List[int]

isValid(self) → bool¶

Returns True if the index is valid.

Return type:: bool

parentTileId(self, id: int) → int¶

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

Parameters:: id (int)
Return type:: int

retrieveContent(self, uri: str, feedback: QgsFeedback = None) → QByteArray¶

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.

Parameters:

uri (str)
feedback (QgsFeedback = None)

Return type:

QByteArray

rootTile(self) → QgsTiledSceneTile¶

Returns the root tile for the index.

Return type:: QgsTiledSceneTile