QGIS API Documentation 3.41.0-Master (d5b93354e9c)
Loading...
Searching...
No Matches
qgslayoutpoint.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutpoint.h
3 ----------------
4 begin : June 2017
5 copyright : (C) 2017 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSLAYOUTPOINT_H
19#define QGSLAYOUTPOINT_H
20
21#include "qgis_core.h"
22#include "qgis.h"
23#include "qgsconfig.h"
24#include <QPointF>
25
39class CORE_EXPORT QgsLayoutPoint
40{
41 public:
42
47
51 explicit QgsLayoutPoint( QPointF point, Qgis::LayoutUnit units = Qgis::LayoutUnit::Millimeters );
52
58
65 void setPoint( const double x, const double y ) { mX = x; mY = y; }
66
72 double x() const { return mX; }
73
79 void setX( const double x )
80 {
81#ifdef QGISDEBUG
82 Q_ASSERT_X( !std::isnan( x ), "QgsLayoutPoint", "Layout point with NaN coordinates created" );
83#endif
84 mX = x;
85 }
86
92 double y() const { return mY; }
93
99 void setY( const double y )
100 {
101#ifdef QGISDEBUG
102 Q_ASSERT_X( !std::isnan( y ), "QgsLayoutPoint", "Layout point with NaN coordinates created" );
103#endif
104 mY = y;
105 }
106
111 Qgis::LayoutUnit units() const { return mUnits; }
112
118 void setUnits( const Qgis::LayoutUnit units ) { mUnits = units; }
119
125 bool isNull() const;
126
132 QPointF toQPointF() const;
133
138 QString encodePoint() const;
139
144 static QgsLayoutPoint decodePoint( const QString &string );
145
146 bool operator==( const QgsLayoutPoint &other ) const;
147 bool operator!=( const QgsLayoutPoint &other ) const;
148
152 QgsLayoutPoint operator*( double v ) const;
153
157 QgsLayoutPoint operator*=( double v );
158
162 QgsLayoutPoint operator/( double v ) const;
163
167 QgsLayoutPoint operator/=( double v );
168
169#ifdef SIP_RUN
170 SIP_PYOBJECT __repr__();
171 % MethodCode
172 QString str = QStringLiteral( "<QgsLayoutPoint: %1, %2 %3 >" ).arg( sipCpp->x() ).arg( sipCpp->y() ).arg( QgsUnitTypes::toAbbreviatedString( sipCpp->units() ) );
173 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
174 % End
175#endif
176
177 private:
178
179 double mX = 0.0;
180 double mY = 0.0;
182
183};
184
185#endif // QGSLAYOUTPOINT_H
LayoutUnit
Layout measurement units.
Definition qgis.h:4912
@ Millimeters
Millimeters.
This class provides a method of storing points, consisting of an x and y coordinate,...
double x() const
Returns x coordinate of point.
void setX(const double x)
Sets the x coordinate of point.
void setUnits(const Qgis::LayoutUnit units)
Sets the units for the point.
double y() const
Returns y coordinate of point.
Qgis::LayoutUnit units() const
Returns the units for the point.
void setY(const double y)
Sets y coordinate of point.
void setPoint(const double x, const double y)
Sets new x and y coordinates for the point.
static Q_INVOKABLE QString toAbbreviatedString(Qgis::DistanceUnit unit)
Returns a translated abbreviation representing a distance unit.
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
bool operator!=(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
QgsMargins operator*(const QgsMargins &margins, double factor)
Returns a QgsMargins object that is formed by multiplying each component of the given margins by fact...
Definition qgsmargins.h:249
QgsMargins operator/(const QgsMargins &margins, double divisor)
Returns a QgsMargins object that is formed by dividing the components of the given margins by the giv...
Definition qgsmargins.h:269