qgsmodelsnapper.h

Go to the documentation of this file.

/***************************************************************************
                             qgsmodelsnapper.h
                             -------------------
    begin                : March 2020
    copyright            : (C) 2020 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 QGSMODELSNAPPER_H
#define QGSMODELSNAPPER_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QPen>
 
#define SIP_NO_FILE

class GUI_EXPORT QgsModelSnapper
{
  public:
    QgsModelSnapper();

    void setSnapTolerance( int snapTolerance );

    int snapTolerance() const { return mTolerance; }

    bool snapToGrid() const { return mSnapToGrid; }

    void setSnapToGrid( bool enabled );

    QPointF snapPoint( QPointF point, double scaleFactor, bool &snapped SIP_OUT, bool snapHorizontal = true, bool snapVertical = true ) const;

    QRectF snapRect( const QRectF &rect, double scaleFactor, bool &snapped SIP_OUT, bool snapHorizontal = true, bool snapVertical = true ) const;

    QRectF snapRectWithResize( const QRectF &rect, double scaleFactor, bool &snapped SIP_OUT, bool snapHorizontal = true, bool snapVertical = true ) const;

    QPointF snapPointToGrid( QPointF point, double scaleFactor, bool &snappedX SIP_OUT, bool &snappedY SIP_OUT ) const;

    QPointF snapPointsToGrid( const QList<QPointF> &points, double scaleFactor, bool &snappedX SIP_OUT, bool &snappedY SIP_OUT ) const;
 
  private:
    int mTolerance = 5;
    bool mSnapToGrid = false;
};
 
#endif //QGSMODELSNAPPER_H