qgstiledsceneindex.h

Go to the documentation of this file.

/***************************************************************************
                         qgstiledsceneindex.h
                         --------------------
    begin                : June 2023
    copyright            : (C) 2023 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ******************************************************************
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSTILEDSCENEINDEX_H
#define QGSTILEDSCENEINDEX_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QCache>
#include <QMutex>
 
class QgsTiledSceneTile;
class QgsFeedback;
class QgsTiledSceneRequest;
 
#ifndef SIP_RUN

class CORE_EXPORT QgsAbstractTiledSceneIndex
{
  public:
 
    QgsAbstractTiledSceneIndex();
    virtual ~QgsAbstractTiledSceneIndex();
 
    QgsAbstractTiledSceneIndex( const QgsAbstractTiledSceneIndex &other ) = delete;
    QgsAbstractTiledSceneIndex &operator=( const QgsAbstractTiledSceneIndex &other ) = delete;

    virtual QgsTiledSceneTile rootTile() const = 0;

    virtual long long parentTileId( long long id ) const = 0;

    virtual QVector< long long > childTileIds( long long id ) const = 0;

    virtual QgsTiledSceneTile getTile( long long id ) = 0;

    virtual QVector< long long > getTiles( const QgsTiledSceneRequest &request ) = 0;

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

    virtual Qgis::TileChildrenAvailability childAvailability( long long id ) const = 0;

    virtual bool fetchHierarchy( long long id, QgsFeedback *feedback = nullptr ) = 0;
 
  protected:

    virtual QByteArray fetchContent( const QString &uri, QgsFeedback *feedback = nullptr ) = 0;
 
  private:
 
    // we have to use a mutex to protect a QCache, not a read/write lock
    // see https://bugreports.qt.io/browse/QTBUG-19794
    mutable QMutex mCacheMutex;
    QCache< QString, QByteArray > mContentCache;
 
};
#endif

class CORE_EXPORT QgsTiledSceneIndex
{
  public:

    explicit QgsTiledSceneIndex( QgsAbstractTiledSceneIndex *index SIP_TRANSFER = nullptr ) SIP_SKIP;
 
    ~QgsTiledSceneIndex();
 
    QgsTiledSceneIndex( const QgsTiledSceneIndex &other );
    SIP_SKIP QgsTiledSceneIndex( QgsTiledSceneIndex &&other );
    QgsTiledSceneIndex &operator=( const QgsTiledSceneIndex &other );
    QgsTiledSceneIndex &operator=( QgsTiledSceneIndex &&other );

    bool isValid() const;

    QgsTiledSceneTile rootTile() const;

    QgsTiledSceneTile getTile( long long id );

    long long parentTileId( long long id ) const;

    QVector< long long > childTileIds( long long id ) const;

    QVector< long long > getTiles( const QgsTiledSceneRequest &request );

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

    bool fetchHierarchy( long long id, QgsFeedback *feedback = nullptr );

    QByteArray retrieveContent( const QString &uri, QgsFeedback *feedback = nullptr );
 
  private:
 
    std::shared_ptr<QgsAbstractTiledSceneIndex> mIndex;
};
 
 
#endif // QGSTILEDSCENEINDEX_H