qgslinearreferencingsymbollayer.h

Go to the documentation of this file.

/***************************************************************************
    qgslinearreferencingsymbollayer.h
    ---------------------
    begin                : 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 QGSLINEARREFERENCINGSYMBOLLAYER_H
#define QGSLINEARREFERENCINGSYMBOLLAYER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgssymbollayer.h"
#include "qgstextformat.h"
 
class QgsNumericFormat;

class CORE_EXPORT QgsLinearReferencingSymbolLayer : public QgsLineSymbolLayer
{
  public:
    QgsLinearReferencingSymbolLayer();
    ~QgsLinearReferencingSymbolLayer() override;

    static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
 
    QgsLinearReferencingSymbolLayer *clone() const override SIP_FACTORY;
    QVariantMap properties() const override;
    QString layerType() const override;
    Qgis::SymbolLayerFlags flags() const override;
    QgsSymbol *subSymbol() override;
    bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override;
    void startRender( QgsSymbolRenderContext &context ) override;
    void stopRender( QgsSymbolRenderContext &context ) override;
    void renderPolyline( const QPolygonF &points, QgsSymbolRenderContext &context ) override;

    QgsTextFormat textFormat() const;

    void setTextFormat( const QgsTextFormat &format );

    QgsNumericFormat *numericFormat() const;

    void setNumericFormat( QgsNumericFormat *format SIP_TRANSFER );

    double interval() const;

    void setInterval( double interval );

    double skipMultiplesOf() const;

    void setSkipMultiplesOf( double multiple );

    bool rotateLabels() const { return mRotateLabels; }

    void setRotateLabels( bool rotate ) { mRotateLabels = rotate; }

    QPointF labelOffset() const { return mLabelOffset; }

    void setLabelOffset( const QPointF &offset ) { mLabelOffset = offset; }

    Qgis::RenderUnit labelOffsetUnit() const { return mLabelOffsetUnit; }

    void setLabelOffsetUnit( Qgis::RenderUnit unit ) { mLabelOffsetUnit = unit; }

    const QgsMapUnitScale &labelOffsetMapUnitScale() const { return mLabelOffsetMapUnitScale; }

    void setLabelOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mLabelOffsetMapUnitScale = scale; }

    bool showMarker() const;

    void setShowMarker( bool show );

    Qgis::LinearReferencingPlacement placement() const;

    void setPlacement( Qgis::LinearReferencingPlacement placement );

    Qgis::LinearReferencingLabelSource labelSource() const;

    void setLabelSource( Qgis::LinearReferencingLabelSource source );

    double averageAngleLength() const { return mAverageAngleLength; }

    void setAverageAngleLength( double length ) { mAverageAngleLength = length; }

    void setAverageAngleUnit( Qgis::RenderUnit unit ) { mAverageAngleLengthUnit = unit; }

    Qgis::RenderUnit averageAngleUnit() const { return mAverageAngleLengthUnit; }

    void setAverageAngleMapUnitScale( const QgsMapUnitScale &scale ) { mAverageAngleLengthMapUnitScale = scale; }

    const QgsMapUnitScale &averageAngleMapUnitScale() const { return mAverageAngleLengthMapUnitScale; }
 
  private:
    void renderPolylineInterval( const QgsLineString *line, QgsSymbolRenderContext &context, double skipMultiples, const QPointF &labelOffsetPainterUnits, double averageAngleLengthPainterUnits, bool showMarker );
    void renderPolylineVertex( const QgsLineString *line, QgsSymbolRenderContext &context, double skipMultiples, const QPointF &labelOffsetPainterUnits, double averageAngleLengthPainterUnits, bool showMarker );
    void renderGeometryPart( QgsSymbolRenderContext &context, const QgsAbstractGeometry *geometry, double labelOffsetPainterUnitsX, double labelOffsetPainterUnitsY, double skipMultiples, double averageAngleDistancePainterUnits, bool showMarker );
    void renderLineString( QgsSymbolRenderContext &context, const QgsLineString *line, double labelOffsetPainterUnitsX, double labelOffsetPainterUnitsY, double skipMultiples, double averageAngleDistancePainterUnits, bool showMarker );
 
    static QPointF pointToPainter( QgsSymbolRenderContext &context, double x, double y, double z );
 
    Qgis::LinearReferencingPlacement mPlacement = Qgis::LinearReferencingPlacement::IntervalCartesian2D;
    Qgis::LinearReferencingLabelSource mLabelSource = Qgis::LinearReferencingLabelSource::CartesianDistance2D;
 
    double mInterval = 1000;
    double mSkipMultiplesOf = 0;
    bool mRotateLabels = true;
 
    QPointF mLabelOffset{ 1, 0 };
    Qgis::RenderUnit mLabelOffsetUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mLabelOffsetMapUnitScale;
 
    QgsTextFormat mTextFormat;
    std::unique_ptr<QgsNumericFormat> mNumericFormat;
 
    bool mShowMarker = false;
    std::unique_ptr<QgsMarkerSymbol> mMarkerSymbol;
 
    double mAverageAngleLength = 4;
    Qgis::RenderUnit mAverageAngleLengthUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mAverageAngleLengthMapUnitScale;
 
    QString mLabelProviderId;
 
};
 
#endif // QGSLINEARREFERENCINGSYMBOLLAYER_H