qgschunknode_p.h

Go to the documentation of this file.

/***************************************************************************
  qgschunknode_p.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 QGSCHUNKNODE_P_H
#define QGSCHUNKNODE_P_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 "qgsaabb.h"

#include <QTime>

namespace Qt3DCore
{
  class QEntity;
}

struct QgsChunkListEntry;
class QgsChunkLoader;
class QgsChunkQueueJob;
class QgsChunkQueueJobFactory;


struct QgsChunkNodeId
{
  QgsChunkNodeId( int _x = -1, int _y = -1, int _z = -1 )
    : x( _x ), y( _y ), z( _z ) {}

  int x, y, z;

  QString text() const { return QStringLiteral( "%1/%2/%3" ).arg( z ).arg( x ).arg( y ); }
};

class QgsChunkNode
{
  public:
    QgsChunkNode( int tileX, int tileY, int tileZ, const QgsAABB &bbox, float error, QgsChunkNode *parent = nullptr );

    ~QgsChunkNode();

    enum State
    {
      Skeleton,         
      QueuedForLoad,    
      Loading,          
      Loaded,           
      QueuedForUpdate,  
      Updating,         
    };

    QgsAABB bbox() const { return mBbox; }
    float error() const { return mError; }
    int tileX() const { return mTileX; }
    int tileY() const { return mTileY; }
    int tileZ() const { return mTileZ; }
    QgsChunkNodeId tileId() const { return QgsChunkNodeId( mTileX, mTileY, mTileZ ); }
    QgsChunkNode *parent() const { return mParent; }
    QgsChunkNode *const *children() const { return mChildren; }
    State state() const { return mState; }

    QgsChunkListEntry *loaderQueueEntry() const { return mLoaderQueueEntry; }
    QgsChunkListEntry *replacementQueueEntry() const { return mReplacementQueueEntry; }
    QgsChunkLoader *loader() const { return mLoader; }
    Qt3DCore::QEntity *entity() const { return mEntity; }
    QgsChunkQueueJob *updater() const { return mUpdater; }

    bool allChildChunksResident( QTime currentTime ) const;

    void ensureAllChildrenExist();

    int level() const;

    QList<QgsChunkNode *> descendants();

    //
    // changes of states in the state machine (see State enum)
    //

    void setQueuedForLoad( QgsChunkListEntry *entry );

    void cancelQueuedForLoad();

    void setLoading( QgsChunkLoader *chunkLoader );

    void cancelLoading();

    void setLoaded( Qt3DCore::QEntity *mEntity );

    void unloadChunk();

    void setQueuedForUpdate( QgsChunkListEntry *entry, QgsChunkQueueJobFactory *updateJobFactory );

    void cancelQueuedForUpdate();

    void setUpdating();

    void cancelUpdating();

    void setUpdated();

    void setExactBbox( const QgsAABB &box );

    void setHasData( bool hasData ) { mHasData = hasData; }
    bool hasData() const { return mHasData; }

  private:
    QgsAABB mBbox;      
    float mError;    

    int mTileX, mTileY, mTileZ;  

    QgsChunkNode *mParent;        
    QgsChunkNode *mChildren[4];   

    State mState;  

    QgsChunkListEntry *mLoaderQueueEntry;       
    QgsChunkListEntry *mReplacementQueueEntry;  

    QgsChunkLoader *mLoader;         
    Qt3DCore::QEntity *mEntity;   

    QgsChunkQueueJobFactory *mUpdaterFactory;  
    QgsChunkQueueJob *mUpdater;                

    QTime mEntityCreatedTime;
    bool mHasData = true;   
};


#endif // CHUNKNODE_H