qgschunkedentity.h

Go to the documentation of this file.

/***************************************************************************
  qgschunkedentity.h
  --------------------------------------
  Date                 : July 2017
  Copyright            : (C) 2017 by Martin Dobias
  Email                : wonder dot sk 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 QGSCHUNKEDENTITY_H
#define QGSCHUNKEDENTITY_H

 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the QGIS API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
 
#include "qgs3dmapsceneentity.h"
#include "qgsraycasthit.h"
 
#include <QFuture>
#include <QMatrix4x4>
#include <QTime>
 
#define SIP_NO_FILE
 
class QgsAABB;
class QgsChunkNode;
class QgsChunkList;
class QgsChunkLoader;
class QgsChunkBoundsEntity;
class QgsRay3D;
class QgsRayCastContext;
struct QgsChunkLoaderResult;
 

struct QgsChunkQueueJob
{
    enum class Type
    {
      Load,
      Update,
      CreateChildren,
    };
 
    QgsChunkNode *node;
    Type type;
    QFuture<void> future;
};
 

class QgsChunkedEntity : public Qgs3DMapSceneEntity
{
    Q_OBJECT
  public:
    QgsChunkedEntity( Qgs3DMapSettings *mapSettings, float tau, QgsChunkLoader *loader, bool ownsLoader, int primitivesBudget = std::numeric_limits<int>::max(), Qt3DCore::QNode *parent = nullptr );
    ~QgsChunkedEntity() override;

    void handleSceneUpdate( const SceneContext &sceneContext ) override;

    int pendingJobsCount() const override;

    bool needsUpdate() const override { return mNeedsUpdate; }
 
    QgsRange<float> getNearFarPlaneRange( const QMatrix4x4 &viewMatrix ) const override;

    void setShowBoundingBoxes( bool enabled );

    void updateNodes( const QList<QgsChunkNode *> &nodes );

    QList<QgsChunkNode *> activeNodes() const { return mActiveNodes; }
    QgsChunkNode *rootNode() const { return mRootNode.get(); }

    virtual QList<QgsRayCastHit> rayIntersection( const QgsRay3D &ray, const QgsRayCastContext &context ) const;
 
  protected:
    void cancelActiveJob( QgsChunkQueueJob &job );
    void cancelActiveJobs();
    void setNeedsUpdate( bool needsUpdate ) { mNeedsUpdate = needsUpdate; }
 
  private:
    void update( QgsChunkNode *node, const SceneContext &sceneContext );

    void pruneLoaderQueue( const SceneContext &sceneContext );

    void requestResidency( QgsChunkNode *node );
 
    void startJobs();
    void startJob( QgsChunkNode *node );
 
    int unloadNodes();
 
    void eraseJobFromList( QgsChunkQueueJob &job );
 
    void onActiveLoadJobFinished( QgsChunkQueueJob &job, QgsChunkLoaderResult &result );
 
  protected:
    std::unique_ptr<QgsChunkNode> mRootNode;
    bool mNeedsUpdate = false;

    float mTau;
    QgsChunkLoader *mChunkLoader = nullptr;
    bool mOwnsLoader = true;
    std::unique_ptr<QgsChunkList> mChunkLoaderQueue;
    std::unique_ptr<QgsChunkList> mReplacementQueue;
    QList<QgsChunkNode *> mActiveNodes;
    int mFrustumCulled = 0;
 
    // TODO: max. length for loading queue
 
    QTime mCurrentTime;

    QgsChunkBoundsEntity *mBboxesEntity = nullptr;

    std::vector<std::unique_ptr<QgsChunkQueueJob>> mActiveJobs;
 
    bool mIsValid = true;
 
    int mPrimitivesBudget = std::numeric_limits<int>::max();
};

 
#endif // QGSCHUNKEDENTITY_H