qgscadutils.h

Go to the documentation of this file.

/***************************************************************************
                              qgscadutils.h
                             -------------------
    begin                : September 2017
    copyright            : (C) 2017 by Martin Dobias
    email                : wonder dot sk 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 QGSCADUTILS_H
#define QGSCADUTILS_H

#include "qgis_core.h"

#include "qgspointlocator.h"

class QgsSnappingUtils;

class CORE_EXPORT QgsCadUtils
{
  public:

    struct AlignMapPointConstraint
    {
      AlignMapPointConstraint( bool locked = false, bool relative = false, double value = 0 )
        : locked( locked )
        , relative( relative )
        , value( value )
      {}

      bool locked;
      bool relative;
      double value;
    };

    struct AlignMapPointContext
    {
      QgsSnappingUtils *snappingUtils = nullptr;
      double mapUnitsPerPixel;

      QgsCadUtils::AlignMapPointConstraint xConstraint;
      QgsCadUtils::AlignMapPointConstraint yConstraint;
      QgsCadUtils::AlignMapPointConstraint distanceConstraint;
      QgsCadUtils::AlignMapPointConstraint angleConstraint;
      QgsCadUtils::AlignMapPointConstraint commonAngleConstraint;

      QList<QgsPointXY> cadPointList;

      SIP_SKIP void dump() const;
    };

    struct AlignMapPointOutput
    {
      bool valid;

      QgsPointXY finalMapPoint;

      QgsPointLocator::Match edgeMatch;

      int softLockCommonAngle;
    };

    static QgsCadUtils::AlignMapPointOutput alignMapPoint( const QgsPointXY &originalMapPoint, const QgsCadUtils::AlignMapPointContext &ctx );

};

#endif // QGSCADUTILS_H