qgs3drendercontext.h

Go to the documentation of this file.

/***************************************************************************
  qgs3drendercontext.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 QGS3DRENDERCONTEXT_H
#define QGS3DRENDERCONTEXT_H
 
#include "qgis_3d.h"
#include "qgsabstractterrainsettings.h"
#include "qgscoordinatereferencesystem.h"
#include "qgscoordinatetransformcontext.h"
#include "qgsexpressioncontext.h"
#include "qgsrange.h"
#include "qgsrectangle.h"
#include "qgsterraingenerator.h"
#include "qgsvector3d.h"
 
#include <QColor>
 
#define SIP_NO_FILE
 
class Qgs3DMapSettings;
 

class _3D_EXPORT Qgs3DRenderContext
{
  public:
    Qgs3DRenderContext() = default;
    ~Qgs3DRenderContext();
    Qgs3DRenderContext( const Qgs3DRenderContext &other );
    Qgs3DRenderContext &operator=( const Qgs3DRenderContext &other );

    static Qgs3DRenderContext fromMapSettings( const Qgs3DMapSettings *mapSettings );

    QgsCoordinateReferenceSystem crs() const { return mCrs; }

    QgsCoordinateTransformContext transformContext() const { return mTransformContext; }

    QgsRectangle extent() const { return mExtent; }

    QgsVector3D origin() const { return mOrigin; }

    const QgsDateTimeRange &temporalRange() const { return mTemporalRange; }

    QColor selectionColor() const { return mSelectionColor; }

    double outputDpi() const { return mDpi; }

    float fieldOfView() const { return mFieldOfView; }

    QgsVector3D mapToWorldCoordinates( const QgsVector3D &mapCoords ) const;

    QgsVector3D worldToMapCoordinates( const QgsVector3D &worldCoords ) const;

    bool terrainRenderingEnabled() const { return mTerrainRenderingEnabled; }

    const QgsAbstractTerrainSettings *terrainSettings() const;

    QgsTerrainGenerator *terrainGenerator() const { return mTerrainGenerator; }

    void setExpressionContext( const QgsExpressionContext &context ) { mExpressionContext = context; }

    QgsExpressionContext &expressionContext() { return mExpressionContext; }

    const QgsExpressionContext &expressionContext() const SIP_SKIP { return mExpressionContext; }
 
  private:
    QgsCoordinateReferenceSystem mCrs; 
    QgsCoordinateTransformContext mTransformContext;
    QgsVector3D mOrigin;
    QgsRectangle mExtent; 
    QgsDateTimeRange mTemporalRange;
    QColor mSelectionColor;     
    double mDpi = 96;           
    float mFieldOfView = 45.0f; 
    bool mTerrainRenderingEnabled = true;
    std::unique_ptr<QgsAbstractTerrainSettings> mTerrainSettings;
    QgsExpressionContext mExpressionContext;
 
    // not owned, currently a pointer to the Qgs3DMapSettings terrain generator.
    // TODO -- fix during implementation of https://github.com/qgis/QGIS-Enhancement-Proposals/issues/301
    QPointer<QgsTerrainGenerator> mTerrainGenerator; 
};
 
 
#endif // QGS3DRENDERCONTEXT_H