qgsrendercontext.h

Go to the documentation of this file.

/***************************************************************************
                              qgsrendercontext.h
                              ------------------
  begin                : March 16, 2008
  copyright            : (C) 2008 by Marco Hugentobler
  email                : marco dot hugentobler at karto dot baug dot ethz dot ch
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSRENDERCONTEXT_H
#define QGSRENDERCONTEXT_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include <QColor>
#include <memory>

#include "qgscoordinatetransform.h"
#include "qgsexpressioncontext.h"
#include "qgsfeaturefilterprovider.h"
#include "qgsmaptopixel.h"
#include "qgsmapunitscale.h"
#include "qgsrectangle.h"
#include "qgsvectorsimplifymethod.h"
#include "qgsdistancearea.h"
#include "qgscoordinatetransformcontext.h"
#include "qgspathresolver.h"

class QPainter;
class QgsAbstractGeometry;
class QgsLabelingEngine;
class QgsMapSettings;


class CORE_EXPORT QgsRenderContext
{
  public:
    QgsRenderContext();

    QgsRenderContext( const QgsRenderContext &rh );
    QgsRenderContext &operator=( const QgsRenderContext &rh );

    enum Flag
    {
      DrawEditingInfo          = 0x01,  
      ForceVectorOutput        = 0x02,  
      UseAdvancedEffects       = 0x04,  
      UseRenderingOptimization = 0x08,  
      DrawSelection            = 0x10,  
      DrawSymbolBounds         = 0x20,  
      RenderMapTile            = 0x40,  
      Antialiasing             = 0x80,  
      RenderPartialOutput      = 0x100, 
      RenderPreviewJob         = 0x200, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )

    
    enum TextRenderFormat
    {
      // refs for below dox: https://github.com/qgis/QGIS/pull/1286#issuecomment-39806854
      // https://github.com/qgis/QGIS/pull/8573#issuecomment-445585826

      TextFormatAlwaysOutlines,

      TextFormatAlwaysText,
    };

    void setFlags( QgsRenderContext::Flags flags );

    void setFlag( Flag flag, bool on = true );

    Flags flags() const;

    bool testFlag( Flag flag ) const;

    static QgsRenderContext fromMapSettings( const QgsMapSettings &mapSettings );

    static QgsRenderContext fromQPainter( QPainter *painter );

    //getters

    QPainter *painter() {return mPainter;}

    QgsCoordinateTransform coordinateTransform() const {return mCoordTransform;}

    const QgsDistanceArea &distanceArea() const { return mDistanceArea; }

    QgsCoordinateTransformContext transformContext() const;

    void setTransformContext( const QgsCoordinateTransformContext &context );

    const QgsPathResolver &pathResolver() const { return mPathResolver; }

    void setPathResolver( const QgsPathResolver &resolver ) { mPathResolver = resolver; }

    const QgsRectangle &extent() const { return mExtent; }

    const QgsMapToPixel &mapToPixel() const {return mMapToPixel;}

    double scaleFactor() const {return mScaleFactor;}

    bool renderingStopped() const {return mRenderingStopped;}

    bool forceVectorOutput() const;

    bool useAdvancedEffects() const;

    void setUseAdvancedEffects( bool enabled );

    bool drawEditingInformation() const;

    double rendererScale() const {return mRendererScale;}

    QgsLabelingEngine *labelingEngine() const { return mLabelingEngine; } SIP_SKIP

    QColor selectionColor() const { return mSelectionColor; }

    bool showSelection() const;

    //setters

    void setCoordinateTransform( const QgsCoordinateTransform &t );

    void setMapToPixel( const QgsMapToPixel &mtp ) {mMapToPixel = mtp;}

    void setExtent( const QgsRectangle &extent ) {mExtent = extent;}

    void setDrawEditingInformation( bool b );

    void setRenderingStopped( bool stopped ) {mRenderingStopped = stopped;}

    void setDistanceArea( const QgsDistanceArea &distanceArea ) {mDistanceArea = distanceArea ;}

    void setScaleFactor( double factor ) {mScaleFactor = factor;}

    void setRendererScale( double scale ) {mRendererScale = scale;}

    void setPainter( QPainter *p ) {mPainter = p;}

    void setForceVectorOutput( bool force );

    void setLabelingEngine( QgsLabelingEngine *engine2 ) { mLabelingEngine = engine2; } SIP_SKIP
    void setSelectionColor( const QColor &color ) { mSelectionColor = color; }

    void setShowSelection( bool showSelection );

    bool useRenderingOptimization() const;

    void setUseRenderingOptimization( bool enabled );

    const QgsVectorSimplifyMethod &vectorSimplifyMethod() const { return mVectorSimplifyMethod; }
    void setVectorSimplifyMethod( const QgsVectorSimplifyMethod &simplifyMethod ) { mVectorSimplifyMethod = simplifyMethod; }

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

    QgsExpressionContext &expressionContext() { return mExpressionContext; }

    const QgsExpressionContext &expressionContext() const { return mExpressionContext; } SIP_SKIP

    const QgsAbstractGeometry *geometry() const { return mGeometry; }
    void setGeometry( const QgsAbstractGeometry *geometry ) { mGeometry = geometry; }

    void setFeatureFilterProvider( const QgsFeatureFilterProvider *ffp );

    const QgsFeatureFilterProvider *featureFilterProvider() const;

    void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; }
    double segmentationTolerance() const { return mSegmentationTolerance; }

    void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; }
    QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; }

    // Conversions

    double convertToPainterUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale = QgsMapUnitScale() ) const;

    double convertToMapUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale = QgsMapUnitScale() ) const;

    double convertFromMapUnits( double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit ) const;

    double convertMetersToMapUnits( double meters ) const;

    TextRenderFormat textRenderFormat() const
    {
      return mTextRenderFormat;
    }

    void setTextRenderFormat( TextRenderFormat format )
    {
      mTextRenderFormat = format;
    }

  private:

    Flags mFlags;

    QPainter *mPainter = nullptr;

    QgsCoordinateTransform mCoordTransform;

    QgsDistanceArea mDistanceArea;

    QgsRectangle mExtent;

    QgsMapToPixel mMapToPixel;

    bool mRenderingStopped = false;

    double mScaleFactor = 1.0;

    double mRendererScale = 1.0;

    QgsLabelingEngine *mLabelingEngine = nullptr;

    QColor mSelectionColor;

    QgsVectorSimplifyMethod mVectorSimplifyMethod;

    QgsExpressionContext mExpressionContext;

    const QgsAbstractGeometry *mGeometry = nullptr;

    std::unique_ptr< QgsFeatureFilterProvider > mFeatureFilterProvider;

    double mSegmentationTolerance = M_PI_2 / 90;

    QgsAbstractGeometry::SegmentationToleranceType mSegmentationToleranceType = QgsAbstractGeometry::MaximumAngle;

    QgsCoordinateTransformContext mTransformContext;

    QgsPathResolver mPathResolver;

    TextRenderFormat mTextRenderFormat = TextFormatAlwaysOutlines;

#ifdef QGISDEBUG
    bool mHasTransformContext = false;
#endif
};

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsRenderContext::Flags )

#endif