qgsabstractterrainsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgsabstractterrainsettings.h
  --------------------------------------
  Date                 : August 2024
  Copyright            : (C) 2024 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 QGSABSTRACTTERRAINSETTINGS_H
#define QGSABSTRACTTERRAINSETTINGS_H
 
#include <memory>
 
#include "qgis_3d.h"
#include "qgis_sip.h"
 
#include <QString>
 
class QDomElement;
class QgsReadWriteContext;
class QgsProject;
class QgsTerrainGenerator;
class Qgs3DRenderContext;

class _3D_EXPORT QgsAbstractTerrainSettings SIP_ABSTRACT
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( sipCpp->type() == "flat" )
      sipType = sipType_QgsFlatTerrainSettings;
    else if ( sipCpp->type() == "dem" )
      sipType = sipType_QgsDemTerrainSettings;
    else if ( sipCpp->type() == "online" )
      sipType = sipType_QgsOnlineDemTerrainSettings;
    else if ( sipCpp->type() == "mesh" )
      sipType = sipType_QgsMeshTerrainSettings;
    else if ( sipCpp->type() == "quantizedmesh" )
      sipType = sipType_QgsQuantizedMeshTerrainSettings;
    else
      sipType = 0;
    SIP_END
#endif
 
  public:
    virtual ~QgsAbstractTerrainSettings();

    virtual QgsAbstractTerrainSettings *clone() const = 0 SIP_FACTORY;

    virtual QString type() const = 0;

    virtual bool equals( const QgsAbstractTerrainSettings *other ) const = 0;

    virtual void readXml( const QDomElement &element, const QgsReadWriteContext &context ) = 0;

    virtual void writeXml( QDomElement &element, const QgsReadWriteContext &context ) const = 0;

    virtual void resolveReferences( const QgsProject *project );

    virtual std::unique_ptr<QgsTerrainGenerator> createTerrainGenerator( const Qgs3DRenderContext &context ) const = 0 SIP_SKIP;
 
    // common settings

    void setVerticalScale( double scale ) { mTerrainVerticalScale = scale; }

    double verticalScale() const { return mTerrainVerticalScale; }

    void setMapTileResolution( int resolution ) { mMapTileResolution = resolution; }

    int mapTileResolution() const { return mMapTileResolution; }

    void setMaximumScreenError( double error ) { mMaxTerrainScreenError = error; }

    double maximumScreenError() const { return mMaxTerrainScreenError; }

    void setMaximumGroundError( double error ) { mMaxTerrainGroundError = error; }

    double maximumGroundError() const { return mMaxTerrainGroundError; }

    void setElevationOffset( double offset ) { mTerrainElevationOffset = offset; }

    double elevationOffset() const { return mTerrainElevationOffset; }
 
  protected:

    void writeCommonProperties( QDomElement &element, const QgsReadWriteContext &context ) const;

    void readCommonProperties( const QDomElement &element, const QgsReadWriteContext &context );

    void copyCommonProperties( const QgsAbstractTerrainSettings *source );

    bool equalsCommon( const QgsAbstractTerrainSettings *other ) const;
 
  private:
    double mTerrainVerticalScale = 1;     
    int mMapTileResolution = 512;         
    double mMaxTerrainScreenError = 3.0;  
    double mMaxTerrainGroundError = 1.0;  
    double mTerrainElevationOffset = 0.0; 
};
 
 
#endif // QGSABSTRACTTERRAINSETTINGS_H