qgstiledscenerenderer.h

Go to the documentation of this file.

/***************************************************************************
                         qgstiledscenerenderer.h
                         --------------------
    begin                : August 2023
    copyright            : (C) 2023 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 QGSTILEDSCENERENDERER_H
#define QGSTILEDSCENERENDERER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrendercontext.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsLayerTreeLayer;
class QgsLayerTreeModelLegendNode;

class CORE_EXPORT QgsTiledSceneRenderContext
{
  public:

    QgsTiledSceneRenderContext( QgsRenderContext &context, QgsFeedback *feedback = nullptr );
 
    QgsTiledSceneRenderContext( const QgsTiledSceneRenderContext &rh ) = delete;
    QgsTiledSceneRenderContext &operator=( const QgsTiledSceneRenderContext & ) = delete;

    QgsRenderContext &renderContext() { return mRenderContext; }

    const QgsRenderContext &renderContext() const SIP_SKIP { return mRenderContext; }

    QgsFeedback *feedback() const { return mFeedback; }

    QImage textureImage() const;

    void setTextureImage( const QImage &image );

    void setTextureCoordinates(
      float textureX1, float textureY1,
      float textureX2, float textureY2,
      float textureX3, float textureY3
    );

    void textureCoordinates( float &textureX1 SIP_OUT, float &textureY1 SIP_OUT, float &textureX2 SIP_OUT, float &textureY2 SIP_OUT, float &textureX3 SIP_OUT, float &textureY3 SIP_OUT ) const;
 
  private:
#ifdef SIP_RUN
    QgsTiledSceneRenderContext( const QgsTiledSceneRenderContext &rh );
#endif
 
    QgsRenderContext &mRenderContext;
    QgsFeedback *mFeedback = nullptr;
    QImage mTextureImage;
    float mTextureCoordinates[6] { 0, 0, 0, 0, 0, 0 };
 
};

class CORE_EXPORT QgsTiledSceneRenderer
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
 
    const QString type = sipCpp->type();
    if ( type == "texture"_L1 )
      sipType = sipType_QgsTiledSceneTextureRenderer;
    else if ( type == "wireframe"_L1 )
      sipType = sipType_QgsTiledSceneWireframeRenderer;
    else
      sipType = 0;
 
    SIP_END
#endif
 
  public:
 
    QgsTiledSceneRenderer() = default;
 
    virtual ~QgsTiledSceneRenderer() = default;

    virtual QString type() const = 0;

    virtual QgsTiledSceneRenderer *clone() const = 0 SIP_FACTORY;

    QgsTiledSceneRenderer( const QgsTiledSceneRenderer &other ) = delete;

    QgsTiledSceneRenderer &operator=( const QgsTiledSceneRenderer &other ) = delete;

    virtual Qgis::TiledSceneRendererFlags flags() const;

    static QgsTiledSceneRenderer *load( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;

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

    double maximumScreenError() const;

    void setMaximumScreenError( double error );

    Qgis::RenderUnit maximumScreenErrorUnit() const;

    void setMaximumScreenErrorUnit( Qgis::RenderUnit unit );

    void setTileBorderRenderingEnabled( bool enabled ) { mTileBorderRendering = enabled; }

    bool isTileBorderRenderingEnabled() const { return mTileBorderRendering; }

    virtual void startRender( QgsTiledSceneRenderContext &context );

    virtual void stopRender( QgsTiledSceneRenderContext &context );

    virtual QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY;

    virtual QStringList legendRuleKeys() const;

    virtual void renderTriangle( QgsTiledSceneRenderContext &context, const QPolygonF &triangle ) = 0;

    virtual void renderLine( QgsTiledSceneRenderContext &context, const QPolygonF &line ) = 0;
 
  protected:

    void copyCommonProperties( QgsTiledSceneRenderer *destination ) const;

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

    void saveCommonProperties( QDomElement &element, const QgsReadWriteContext &context ) const;
 
  private:
#ifdef SIP_RUN
    QgsTiledSceneRenderer( const QgsTiledSceneRenderer &other );
#endif
 
#ifdef QGISDEBUG
    QThread *mThread = nullptr;
#endif
 
    double mMaximumScreenError = 3;
    Qgis::RenderUnit mMaximumScreenErrorUnit = Qgis::RenderUnit::Millimeters;
    bool mTileBorderRendering = false;
 
};
 
#endif // QGSTILEDSCENERENDERER_H