qgslayoutpoint.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutpoint.h
                         ----------------
    begin                : June 2017
    copyright            : (C) 2017 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 QGSLAYOUTPOINT_H
#define QGSLAYOUTPOINT_H
 
#include "qgsconfig.h"
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QPointF>
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsLayoutPoint
{
  public:
    QgsLayoutPoint( double x, double y, Qgis::LayoutUnit units = Qgis::LayoutUnit::Millimeters );

    explicit QgsLayoutPoint( QPointF point, Qgis::LayoutUnit units = Qgis::LayoutUnit::Millimeters );

    explicit QgsLayoutPoint( Qgis::LayoutUnit units = Qgis::LayoutUnit::Millimeters );

    void setPoint( const double x, const double y )
    {
      mX = x;
      mY = y;
    }

    double x() const { return mX; }

    void setX( const double x )
    {
#ifdef QGISDEBUG
      Q_ASSERT_X( !std::isnan( x ), "QgsLayoutPoint", "Layout point with NaN coordinates created" );
#endif
      mX = x;
    }

    double y() const { return mY; }

    void setY( const double y )
    {
#ifdef QGISDEBUG
      Q_ASSERT_X( !std::isnan( y ), "QgsLayoutPoint", "Layout point with NaN coordinates created" );
#endif
      mY = y;
    }

    Qgis::LayoutUnit units() const { return mUnits; }

    void setUnits( const Qgis::LayoutUnit units ) { mUnits = units; }

    bool isNull() const;

    QPointF toQPointF() const;

    QString encodePoint() const;

    static QgsLayoutPoint decodePoint( const QString &string );
 
    bool operator==( const QgsLayoutPoint &other ) const;
    bool operator!=( const QgsLayoutPoint &other ) const;

    QgsLayoutPoint operator*( double v ) const;

    QgsLayoutPoint operator*=( double v );

    QgsLayoutPoint operator/( double v ) const;

    QgsLayoutPoint operator/=( double v );
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsLayoutPoint: %1, %2 %3 >"_s.arg( sipCpp->x() ).arg( sipCpp->y() ).arg( QgsUnitTypes::toAbbreviatedString( sipCpp->units() ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
 
    double mX
    = 0.0;
    double mY = 0.0;
    Qgis::LayoutUnit mUnits = Qgis::LayoutUnit::Millimeters;
};
 
#endif // QGSLAYOUTPOINT_H