qgsmesh3dsymbol.h

Go to the documentation of this file.

/***************************************************************************
  qgsmesh3dsymbol.h
  -----------------
  Date                 : January 2019
  Copyright            : (C) 2019 by Peter Petrik
  Email                : zilolv 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 QGSMESH3DSYMBOL_H
#define QGSMESH3DSYMBOL_H
 
#include "qgis_3d.h"
#include "qgs3dtypes.h"
#include "qgsabstract3dsymbol.h"
#include "qgscolorrampshader.h"
 
#include <Qt3DRender/QCullFace>
 
class QgsAbstractMaterialSettings;

class _3D_EXPORT QgsMesh3DSymbol : public QgsAbstract3DSymbol
{
  public:
    enum class RenderingStyle : int
    {
      SingleColor = 0,      
      ColorRamp,            
      ColorRamp2DRendering, 
    };

    enum class ZValueType : int
    {
      VerticesZValue = 0,  
      ScalarDatasetZvalue, 
    };

    QgsMesh3DSymbol();
    ~QgsMesh3DSymbol() override;
 
    QString type() const override { return "mesh"; }
    QgsMesh3DSymbol *clone() const override SIP_FACTORY;
 
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;

    bool isEnabled() const;

    void setEnabled( bool enabled );

    Qgs3DTypes::CullingMode cullingMode() const;

    void setCullingMode( const Qgs3DTypes::CullingMode &mode );

    Qgis::AltitudeClamping altitudeClamping() const { return mAltClamping; }
    void setAltitudeClamping( Qgis::AltitudeClamping altClamping ) { mAltClamping = altClamping; }

    float height() const { return mHeight; }
    void setHeight( float height ) { mHeight = height; }

    QgsAbstractMaterialSettings *materialSettings() const;

    void setMaterialSettings( QgsAbstractMaterialSettings *materialSettings SIP_TRANSFER );

    bool addBackFaces() const { return mAddBackFaces; }

    void setAddBackFaces( bool add ) { mAddBackFaces = add; }

    bool smoothedTriangles() const;

    void setSmoothedTriangles( bool smoothTriangles );

    bool wireframeEnabled() const;

    void setWireframeEnabled( bool wireframeEnabled );

    double wireframeLineWidth() const;

    void setWireframeLineWidth( double wireframeLineWidth );

    QColor wireframeLineColor() const;

    void setWireframeLineColor( const QColor &wireframeLineColor );

    double verticalScale() const;

    void setVerticalScale( double verticalScale );

    QgsColorRampShader colorRampShader() const;

    void setColorRampShader( const QgsColorRampShader &colorRampShader );

    QColor singleMeshColor() const;

    void setSingleMeshColor( const QColor &singleMeshColor );

    QgsMesh3DSymbol::RenderingStyle renderingStyle() const;

    void setRenderingStyle( const QgsMesh3DSymbol::RenderingStyle &textureType );

    int verticalDatasetGroupIndex() const;

    void setVerticalDatasetGroupIndex( int verticalDatasetGroupIndex );

    bool isVerticalMagnitudeRelative() const;

    void setIsVerticalMagnitudeRelative( bool isVerticalMagnitudeRelative );

    bool arrowsEnabled() const;

    void setArrowsEnabled( bool arrowsEnabled );

    double arrowsSpacing() const;

    void setArrowsSpacing( double arrowsSpacing );

    int maximumTextureSize() const;

    void setMaximumTextureSize( int maximumTextureSize );

    bool arrowsFixedSize() const;

    void setArrowsFixedSize( bool arrowsFixedSize );

    int levelOfDetailIndex() const;

    void setLevelOfDetailIndex( int lod );
 
    bool operator==( const QgsMesh3DSymbol &other ) const;
    bool operator!=( const QgsMesh3DSymbol &other ) const;
 
  private:
#ifdef SIP_RUN
    QgsMesh3DSymbol( const QgsMesh3DSymbol & );
#endif

    Qgis::AltitudeClamping mAltClamping = Qgis::AltitudeClamping::Absolute;
    float mHeight = 0.0f;                                           
    std::unique_ptr<QgsAbstractMaterialSettings> mMaterialSettings; 
    bool mAddBackFaces = false;
 
    bool mEnabled = true;
 
    Qgs3DTypes::CullingMode mCullingMode = Qgs3DTypes::NoCulling;

    bool mSmoothedTriangles = false;
    bool mWireframeEnabled = false;
    double mWireframeLineWidth = 1.0;
    QColor mWireframeLineColor = Qt::darkGray;
    int mLevelOfDetailIndex = 0;

    double mVerticalScale = 1.0;
    int mVerticalDatasetGroupIndex = -1;
    bool mIsVerticalMagnitudeRelative = false;

    QgsMesh3DSymbol::RenderingStyle mRenderingStyle = QgsMesh3DSymbol::RenderingStyle::SingleColor;
    QgsColorRampShader mColorRampShader;
    QColor mSingleColor = Qt::darkGreen;

    bool mArrowsEnabled = false;
    double mArrowsSpacing = 25;
    bool mArrowsFixedSize = false;
    QColor mArrowsColor = Qt::yellow;
    int mMaximumTextureSize = 1024;
};
 
#endif // QGSMESH3DSYMBOL_H