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"
 
#include <QQueue>
 
class QgsSnappingUtils;

class CORE_EXPORT QgsCadUtils
{
  public:
    class AlignMapPointConstraint
    {
      public:
        AlignMapPointConstraint( bool locked = false, bool relative = false, double value = 0 )
          : locked( locked )
          , relative( relative )
          , value( value )
        {}

        bool locked;
        bool relative;
        double value;
    };

    class AlignMapPointOutput
    {
      public:
        bool valid;

        QgsPointXY finalMapPoint;

        QgsPointLocator::Match snapMatch;

        QgsPointLocator::Match edgeMatch;

        double softLockCommonAngle;
 
        Qgis::LineExtensionSide softLockLineExtension;
        double softLockX;
        double softLockY;
    };

    class AlignMapPointContext
    {
      public:
        QgsSnappingUtils *snappingUtils = nullptr;
        double mapUnitsPerPixel = 1;

        QgsCadUtils::AlignMapPointConstraint xConstraint;
        QgsCadUtils::AlignMapPointConstraint yConstraint;

        QgsCadUtils::AlignMapPointConstraint zConstraint;

        QgsCadUtils::AlignMapPointConstraint mConstraint;
        QgsCadUtils::AlignMapPointConstraint distanceConstraint;
        QgsCadUtils::AlignMapPointConstraint angleConstraint;
        QgsCadUtils::AlignMapPointConstraint commonAngleConstraint;
 
        QgsCadUtils::AlignMapPointConstraint lineExtensionConstraint;
        QgsCadUtils::AlignMapPointConstraint xyVertexConstraint;

        bool snappingToFeaturesOverridesCommonAngle = false;

        SIP_SKIP void dump() const;

        QList< QgsPoint > cadPoints() const { return mCadPointList; };

        void setCadPoints( const QList< QgsPoint > &points ) { mCadPointList = points; };

        void setCadPoint( int index, const QgsPoint &point ) { mCadPointList[index] = point; };

        QgsPoint cadPoint( int index ) const { return mCadPointList[index]; };

        void setLockedSnapVertices( const QQueue< QgsPointLocator::Match > &lockedSnapVertices ) { mLockedSnapVertices = lockedSnapVertices; }
        SIP_SKIP;

        QQueue< QgsPointLocator::Match > lockedSnapVertices() const { return mLockedSnapVertices; }
        SIP_SKIP;
 
#ifdef SIP_RUN
        SIP_PROPERTY( name = cadPointList, get = _cadPointList, set = _setCadPointList )
#endif
        void _setCadPointList( const QList< QgsPointXY > &list )
        {
          mCadPointList.clear();
          for ( const auto &pointxy : list )
          {
            mCadPointList.append( QgsPoint( pointxy ) );
          }
        }
        QList< QgsPointXY > _cadPointList() const
        {
          QList< QgsPointXY> list;
          for ( const auto &point : mCadPointList )
          {
            list.append( QgsPointXY( point.x(), point.y() ) );
          };
          return list;
        }
 
      private:
        QList<QgsPoint> mCadPointList;
        QQueue< QgsPointLocator::Match > mLockedSnapVertices;
    };

    static QgsCadUtils::AlignMapPointOutput alignMapPoint( const QgsPointXY &originalMapPoint, const QgsCadUtils::AlignMapPointContext &ctx );
};
 
#endif // QGSCADUTILS_H