qgsmaplayerelevationproperties.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmaplayerelevationproperties.h
                         ---------------
    begin                : November 2020
    copyright            : (C) 2020 by Nyall Dawson
    email                : nyall dot dawson 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 QGSMAPLAYERELEVATIONPROPERTIES_H
#define QGSMAPLAYERELEVATIONPROPERTIES_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgspropertycollection.h"
#include "qgsrange.h"
#include "qgsreadwritecontext.h"
 
#include <QDomElement>
#include <QObject>
 
class QgsMapLayer;
 

class CORE_EXPORT QgsMapLayerElevationProperties : public QObject
{
    //SIP_TYPEHEADER_INCLUDE( "qgspointcloudlayerelevationproperties.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsrasterlayerelevationproperties.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsvectorlayerelevationproperties.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgsmeshlayerelevationproperties.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgstiledscenelayerelevationproperties.h" );
    Q_OBJECT
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsPointCloudLayerElevationProperties *>( sipCpp ) )
    {
      sipType = sipType_QgsPointCloudLayerElevationProperties;
    }
    else if ( qobject_cast<QgsVectorLayerElevationProperties *>( sipCpp ) )
    {
      sipType = sipType_QgsVectorLayerElevationProperties;
    }
    else if ( qobject_cast<QgsRasterLayerElevationProperties *>( sipCpp ) )
    {
      sipType = sipType_QgsRasterLayerElevationProperties;
    }
    else if ( qobject_cast<QgsMeshLayerElevationProperties *>( sipCpp ) )
    {
      sipType = sipType_QgsMeshLayerElevationProperties;
    }
    else if ( qobject_cast<QgsTiledSceneLayerElevationProperties *>( sipCpp ) )
    {
      sipType = sipType_QgsTiledSceneLayerElevationProperties;
    }
    else
    {
      sipType = 0;
    }
    SIP_END
#endif
 
  public:
 
    // *INDENT-OFF*

    enum class Property SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsMapLayerElevationProperties, Property ) : int
      {
      ZOffset, 
      ExtrusionHeight, 
      RasterPerBandLowerElevation, 
      RasterPerBandUpperElevation, 
    };
    // *INDENT-ON*

    enum Flag SIP_ENUM_BASETYPE( IntFlag )
    {
      FlagDontInvalidateCachedRendersWhenRangeChanges = 1  
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    
    QgsMapLayerElevationProperties( QObject *parent SIP_TRANSFERTHIS );

    virtual bool hasElevation() const;

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

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

    virtual void setDefaultsFromLayer( QgsMapLayer *layer );

    virtual QString htmlSummary() const;

    virtual QgsMapLayerElevationProperties *clone() const = 0 SIP_FACTORY;

    virtual bool isVisibleInZRange( const QgsDoubleRange &range, QgsMapLayer *layer = nullptr ) const;

    virtual QgsMapLayerElevationProperties::Flags flags() const { return QgsMapLayerElevationProperties::Flags(); }

    virtual QgsDoubleRange calculateZRange( QgsMapLayer *layer ) const;

    virtual QList< double > significantZValues( QgsMapLayer *layer ) const;

    virtual bool showByDefaultInElevationProfilePlots() const;

    double zOffset() const { return mZOffset; }

    void setZOffset( double offset );

    double zScale() const { return mZScale; }

    void setZScale( double scale );

    QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }

    const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP { return mDataDefinedProperties; }

    void setDataDefinedProperties( const QgsPropertyCollection &collection );

    static QgsPropertiesDefinition propertyDefinitions();
 
  signals:

    void changed();

    void zOffsetChanged();

    void zScaleChanged();

    void profileRenderingPropertyChanged();

    void profileGenerationPropertyChanged();
 
  protected:
    double mZScale = 1.0;
    double mZOffset = 0.0;

    QgsPropertyCollection mDataDefinedProperties;

    static QgsPropertiesDefinition sPropertyDefinitions;

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

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

    void copyCommonProperties( const QgsMapLayerElevationProperties *other );
 
  private:

    static void initPropertyDefinitions();
 
};
 
#endif // QGSMAPLAYERELEVATIONPROPERTIES_H