18 #ifndef QGSLAYOUTITEMMAPGRID_H 19 #define QGSLAYOUTITEMMAPGRID_H 21 #include "qgis_core.h" 70 void removeGrid(
const QString &gridId );
78 void moveGridUp(
const QString &gridId );
86 void moveGridDown(
const QString &gridId );
110 QList< QgsLayoutItemMapGrid * >
asList()
const;
119 double maxGridExtension()
const;
127 void calculateMaxGridExtension(
double &top,
double &right,
double &bottom,
double &left )
const;
269 void draw( QPainter *painter )
override;
289 void setBlendMode(
const QPainter::CompositionMode mode ) { mBlendMode = mode; }
295 QPainter::CompositionMode
blendMode()
const {
return mBlendMode; }
303 double maxExtension()
const;
311 void calculateMaxExtension(
double &top,
double &right,
double &bottom,
double &left )
const;
337 void setIntervalX(
double interval );
353 void setIntervalY(
double interval );
369 void setOffsetX(
const double offset );
377 double offsetX()
const {
return mGridOffsetX; }
385 void setOffsetY(
const double offset );
393 double offsetY()
const {
return mGridOffsetY; }
434 void setGridLineWidth(
const double width );
443 void setGridLineColor(
const QColor &color );
638 void setAnnotationExpression(
const QString &expression ) { mGridAnnotationExpressionString = expression; mGridAnnotationExpression.reset(); }
682 void setFrameSideFlags( QgsLayoutItemMapGrid::FrameSideFlags flags );
701 QgsLayoutItemMapGrid::FrameSideFlags frameSideFlags()
const;
802 GridExtension() =
default;
810 mutable bool mTransformDirty =
true;
815 double mGridIntervalX = 0.0;
817 double mGridIntervalY = 0.0;
819 double mGridOffsetX = 0.0;
821 double mGridOffsetY = 0.0;
823 QFont mGridAnnotationFont;
825 QColor mGridAnnotationFontColor = Qt::black;
827 int mGridAnnotationPrecision = 3;
829 bool mShowGridAnnotation =
false;
850 double mAnnotationFrameDistance = 1.0;
862 QString mGridAnnotationExpressionString;
863 mutable std::unique_ptr< QgsExpression > mGridAnnotationExpression;
866 FrameSideFlags mGridFrameSides;
867 double mGridFrameWidth = 2.0;
868 double mGridFramePenThickness = 0.3;
869 QColor mGridFramePenColor = QColor( 0, 0, 0 );
870 QColor mGridFrameFillColor1 = Qt::white;
871 QColor mGridFrameFillColor2 = Qt::black;
872 double mCrossLength = 3.0;
883 std::unique_ptr< QgsLineSymbol > mGridLineSymbol;
884 std::unique_ptr< QgsMarkerSymbol > mGridMarkerSymbol;
890 QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;
892 mutable QList< QPair< double, QPolygonF > > mTransformedXLines;
893 mutable QList< QPair< double, QPolygonF > > mTransformedYLines;
894 mutable QList< QgsPointXY > mTransformedIntersections;
895 QRectF mPrevPaintRect;
896 mutable QPolygonF mPrevMapPolygon;
898 class QgsMapAnnotation
902 QPointF itemPosition;
910 void drawGridFrame( QPainter *p,
const QList< QPair< double, QLineF > > &hLines,
const QList< QPair< double, QLineF > > &vLines, GridExtension *extension =
nullptr )
const;
921 void drawCoordinateAnnotations( QPainter *p,
const QList< QPair< double, QLineF > > &hLines,
const QList< QPair< double, QLineF > > &vLines,
QgsExpressionContext &expressionContext, GridExtension *extension =
nullptr )
const;
927 void drawCoordinateAnnotation( QPainter *p, QPointF pos,
const QString &annotationString,
const AnnotationCoordinate coordinateType, GridExtension *extension =
nullptr )
const;
936 void drawAnnotation( QPainter *p, QPointF pos,
int rotation,
const QString &annotationText )
const;
943 int xGridLines( QList< QPair< double, QLineF > > &lines )
const;
948 int yGridLines( QList< QPair< double, QLineF > > &lines )
const;
956 void drawGridLine(
const QPolygonF &line,
QgsRenderContext &context )
const;
958 void sortGridLinesOnBorders(
const QList< QPair< double, QLineF > > &hLines,
const QList< QPair< double, QLineF > > &vLines, QMap< double, double > &leftFrameEntries,
959 QMap< double, double > &rightFrameEntries, QMap< double, double > &topFrameEntries, QMap< double, double > &bottomFrameEntries )
const;
965 void drawGridFrameBorder( QPainter *p,
const QMap< double, double > &borderPos,
BorderSide border,
double *extension =
nullptr )
const;
977 static QList<QPolygonF> trimLinesToMap(
const QPolygonF &line,
const QgsRectangle &rect );
979 QPolygonF scalePolygon(
const QPolygonF &polygon,
const double scale )
const;
982 void drawGridCrsTransform(
QgsRenderContext &context,
double dotsPerMM, QList< QPair< double, QLineF > > &horizontalLines,
983 QList< QPair< double, QLineF > > &verticalLines,
bool calculateLinesOnly =
false )
const;
985 void drawGridNoTransform(
QgsRenderContext &context,
double dotsPerMM, QList<QPair<double, QLineF> > &horizontalLines, QList<QPair<double, QLineF> > &verticalLines,
bool calculateLinesOnly =
false )
const;
987 void createDefaultGridLineSymbol();
989 void createDefaultGridMarkerSymbol();
993 void drawGridFrameZebraBorder( QPainter *p,
const QMap<double, double> &borderPos,
BorderSide border,
double *extension =
nullptr )
const;
995 void drawGridFrameTicks( QPainter *p,
const QMap<double, double> &borderPos,
BorderSide border,
double *extension =
nullptr )
const;
997 void drawGridFrameLineBorder( QPainter *p,
BorderSide border,
double *extension =
nullptr )
const;
999 void calculateCrsTransformLines()
const;
1004 friend class TestQgsLayoutMapGrid;
1008 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsLayoutItemMapGrid::FrameSideFlags )
1010 #endif // QGSLAYOUTITEMMAPGRID_H void setAnnotationExpression(const QString &expression)
Sets the expression used for drawing grid annotations.
void setFramePenSize(const double width)
Sets the width of the stroke drawn in the grid frame.
double offsetY() const
Returns the offset for grid lines in the y-direction.
The class is used as a container of context for various read/write operations on other objects...
A rectangle specified with double values.
double intervalX() const
Returns the interval between grid lines in the x-direction.
QgsExpressionContext createExpressionContext() const override
Creates an expression context relating to the objects' current state.
Degree/minutes/seconds, use NSEW suffix.
bool annotationEnabled() const
Returns whether annotations are shown for the grid.
void setAnnotationFontColor(const QColor &color)
Sets the font color used for drawing grid annotations.
void setFrameFillColor1(const QColor &color)
Sets the first fill color used for the grid frame.
QColor framePenColor() const
Retrieves the color of the stroke drawn in the grid frame.
QColor annotationFontColor() const
Returns the font color used for drawing grid annotations.
double framePenSize() const
Retrieves the width of the stroke drawn in the grid frame.
FrameSideFlag
Flags for controlling which side of the map a frame is drawn on.
An item which is drawn inside a QgsLayoutItemMap, e.g., a grid or map overview.
Draw annotations vertically, ascending.
A collection of map items which are drawn above the map content in a QgsLayoutItemMap.
FrameStyle
Style for grid frame.
DisplayMode
Display settings for grid annotations and frames.
double intervalY() const
Returns the interval between grid lines in the y-direction.
void setBlendMode(const QPainter::CompositionMode mode)
Sets the blending mode used for drawing the grid.
double crossLength() const
Retrieves the length (in layout units) of the cross segments drawn for the grid.
Grid units in millimeters.
Degree/minutes, use - for S/W coordinates.
double offsetX() const
Returns the offset for grid lines in the x-direction.
QFont annotationFont() const
Returns the font used for drawing grid annotations.
Degree/minutes, use NSEW suffix.
int annotationPrecision() const
Returns the coordinate precision for grid annotations, which is the number of decimal places shown wh...
QPainter::CompositionMode blendMode() const
Retrieves the blending mode used for drawing the grid.
void setFrameWidth(const double width)
Sets the grid frame width (in layout units).
void setAnnotationFont(const QFont &font)
Sets the font used for drawing grid annotations.
virtual bool usesAdvancedEffects() const
Returns true if the item is drawn using advanced effects, such as blend modes.
Draw line crosses at intersections of grid lines.
Tick markers drawn inside map frame.
Layout graphical items for displaying a map.
A collection of grids which is drawn above the map content in a QgsLayoutItemMap. ...
Draw annotations horizontally.
AnnotationFormat annotationFormat() const
Returns the format for drawing grid annotations.
void setFrameFillColor2(const QColor &color)
Sets the second fill color used for the grid frame.
virtual bool readXml(const QDomElement &element, const QDomDocument &doc, const QgsReadWriteContext &context)=0
Sets the item stack's state from a DOM document, where element is a DOM node corresponding to a 'Layo...
Decimal degrees, use - for S/W coordinates.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QColor frameFillColor1() const
Retrieves the first fill color for the grid frame.
QString annotationExpression() const
Returns the expression used for drawing grid annotations.
void setFramePenColor(const QColor &color)
Sets the color of the stroke drawn in the grid frame.
Decimal degrees, use NSEW suffix.
bool enabled() const
Returns whether the item will be drawn.
Show latitude/y annotations/divisions only.
void setAnnotationEnabled(const bool enabled)
Sets whether annotations should be shown for the grid.
void setFrameStyle(const FrameStyle style)
Sets the grid frame style.
virtual void draw(QPainter *painter)=0
Draws the item on to a destination painter.
AnnotationFormat
Format for displaying grid annotations.
double annotationFrameDistance() const
Returns the distance between the map frame and annotations.
QgsLayoutItemMapItem & operator[](int index)
Returns a reference to an item at the specified index within the stack.
An individual grid which is drawn above the map content in a QgsLayoutItemMap.
AnnotationDirection
Direction of grid annotations.
GridUnit
Unit for grid values.
Show both latitude and longitude annotations/divisions.
AnnotationPosition
Position for grid annotations.
virtual bool readXml(const QDomElement &element, const QDomDocument &doc, const QgsReadWriteContext &context)
Sets the map item state from a DOM document, where element is the DOM node corresponding to a 'Layout...
AnnotationCoordinate
Annotation coordinate type.
QList< QgsLayoutItemMapItem *> asList() const
Returns a list of QgsLayoutItemMapItems contained by the stack.
void setAnnotationPrecision(const int precision)
Sets the coordinate precision for grid annotations.
BorderSide
Border sides for annotations.
Contains information about the context of a rendering operation.
Degree/minutes/seconds, with minutes using leading zeros where required.
Draw annotations vertically, descending.
Show longitude/x annotations/divisions only.
void setCrossLength(const double length)
Sets the length (in layout units) of the cross segments drawn for the grid.
void setAnnotationFormat(const AnnotationFormat format)
Sets the format for drawing grid annotations.
Draw markers at intersections of grid lines.
FrameStyle frameStyle() const
Returns the grid frame style.
Degree/minutes, with minutes using leading zeros where required.
This class represents a coordinate reference system (CRS).
double frameWidth() const
Gets the grid frame width in layout units.
GridUnit units() const
Returns the units used for grid measurements such as the interval and offset for grid lines...
void setAnnotationFrameDistance(const double distance)
Sets the distance between the map frame and annotations.
GridStyle
Grid drawing style.
Tick markers drawn both inside and outside the map frame.
GridStyle style() const
Returns the grid's style, which controls how the grid is drawn over the map's contents.
Draw annotations outside the map frame.
QColor frameFillColor2() const
Retrieves the second fill color for the grid frame.
Grid units follow map units.
virtual bool writeXml(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
Stores map item state in a DOM element, where element is the DOM element corresponding to a 'LayoutMa...
QgsCoordinateReferenceSystem crs() const
Retrieves the CRS for the grid.
Degree/minutes/seconds, use - for S/W coordinates.
Tick markers drawn outside map frame.