qgssymbolrendercontext.h

Go to the documentation of this file.

/***************************************************************************
 qgssymbolrendercontext.h
 ---------------------
 begin                : November 2009
 copyright            : (C) 2009 by Martin Dobias
 email                : wonder dot sk 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 QGSSYMBOLRENDERCONTEXT_H
#define QGSSYMBOLRENDERCONTEXT_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsfields.h"
#include "qgsmapunitscale.h"
 
class QgsRenderContext;
class QgsFeature;
class QgsLegendPatchShape;
class QgsExpressionContextScope;

class CORE_EXPORT QgsSymbolRenderContext
{
  public:
    //TODO QGIS 5.0 - remove mapUnitScale and renderunit

    QgsSymbolRenderContext(
      QgsRenderContext &c,
      Qgis::RenderUnit u,
      qreal opacity = 1.0,
      bool selected = false,
      Qgis::SymbolRenderHints renderHints = Qgis::SymbolRenderHints(),
      const QgsFeature *f = nullptr,
      const QgsFields &fields = QgsFields(),
      const QgsMapUnitScale &mapUnitScale = QgsMapUnitScale()
    );
 
    ~QgsSymbolRenderContext();
 
    QgsSymbolRenderContext( const QgsSymbolRenderContext &rh ) = delete;

    QgsRenderContext &renderContext() { return mRenderContext; }

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

    void setOriginalValueVariable( const QVariant &value );

    Q_DECL_DEPRECATED Qgis::RenderUnit outputUnit() const SIP_DEPRECATED { return mOutputUnit; }

    Q_DECL_DEPRECATED void setOutputUnit( Qgis::RenderUnit u ) SIP_DEPRECATED { mOutputUnit = u; }

    Q_DECL_DEPRECATED QgsMapUnitScale mapUnitScale() const SIP_DEPRECATED { return mMapUnitScale; }

    Q_DECL_DEPRECATED void setMapUnitScale( const QgsMapUnitScale &scale ) SIP_DEPRECATED { mMapUnitScale = scale; }

    qreal opacity() const { return mOpacity; }

    void setOpacity( qreal opacity ) { mOpacity = opacity; }

    bool selected() const { return mSelected; }

    void setSelected( bool selected ) { mSelected = selected; }

    Qgis::SymbolRenderHints renderHints() const { return mRenderHints; }

    bool forceVectorRendering() const;

    void setRenderHints( Qgis::SymbolRenderHints hints ) { mRenderHints = hints; }

    void setRenderHint( Qgis::SymbolRenderHint hint, bool enabled = true ) { mRenderHints.setFlag( hint, enabled ); }
 
    void setFeature( const QgsFeature *f ) { mFeature = f; }

    const QgsFeature *feature() const { return mFeature; }

    void setOriginalGeometryType( Qgis::GeometryType type ) { mOriginalGeometryType = type; }

    Qgis::GeometryType originalGeometryType() const { return mOriginalGeometryType; }

    QgsFields fields() const { return mFields; }

    int geometryPartCount() const { return mGeometryPartCount; }

    void setGeometryPartCount( int count ) { mGeometryPartCount = count; }

    int geometryPartNum() const { return mGeometryPartNum; }

    void setGeometryPartNum( int num ) { mGeometryPartNum = num; }

    Q_DECL_DEPRECATED double outputLineWidth( double width ) const SIP_DEPRECATED;

    Q_DECL_DEPRECATED double outputPixelSize( double size ) const SIP_DEPRECATED;
 
    // workaround for sip 4.7. Don't use assignment - will fail with assertion error
    QgsSymbolRenderContext &operator=( const QgsSymbolRenderContext & );

    QgsExpressionContextScope *expressionContextScope();

    void setExpressionContextScope( QgsExpressionContextScope *contextScope SIP_TRANSFER );

    const QgsLegendPatchShape *patchShape() const;

    void setPatchShape( const QgsLegendPatchShape &shape );
 
  private:
#ifdef SIP_RUN
    QgsSymbolRenderContext( const QgsSymbolRenderContext &rh ) SIP_FORCE;
#endif
 
    QgsRenderContext &mRenderContext;
    std::unique_ptr< QgsExpressionContextScope > mExpressionContextScope;
    Qgis::RenderUnit mOutputUnit;
    QgsMapUnitScale mMapUnitScale;
    qreal mOpacity = 1.0;
    bool mSelected;
    Qgis::SymbolRenderHints mRenderHints;
    const QgsFeature *mFeature; //current feature
    QgsFields mFields;
    int mGeometryPartCount = 0;
    int mGeometryPartNum = 0;
    Qgis::GeometryType mOriginalGeometryType = Qgis::GeometryType::Unknown;
    std::unique_ptr< QgsLegendPatchShape > mPatchShape;
};
 
 
#endif // QGSSYMBOLRENDERCONTEXT_H