qgslinesegment.h

Go to the documentation of this file.

/***************************************************************************
                         qgslinesegment.h
                         -----------------
    begin                : April 2018
    copyright            : (C) 2018 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 QGSLINESEGMENT_H
#define QGSLINESEGMENT_H
 
#include "qgis_core.h"
#include "qgspointxy.h"
 
class QgsLineString;

class CORE_EXPORT QgsLineSegment2D
{
  public:
    // clang-format off
    QgsLineSegment2D( const QgsPointXY &start, const QgsPointXY &end ) SIP_HOLDGIL
      // clang-format on
  : mStart( start )
    , mEnd( end )
    {}

    QgsLineSegment2D( double x1, double y1, double x2, double y2 ) SIP_HOLDGIL
  : mStart( QgsPointXY( x1, y1 ) )
    , mEnd( QgsPointXY( x2, y2 ) )
    {}

    double length() const SIP_HOLDGIL
    {
      return mStart.distance( mEnd );
    }

    double lengthSquared() const SIP_HOLDGIL
    {
      return mStart.sqrDist( mEnd );
    }

    double startX() const SIP_HOLDGIL
    {
      return mStart.x();
    }

    double startY() const SIP_HOLDGIL
    {
      return mStart.y();
    }

    double endX() const SIP_HOLDGIL
    {
      return mEnd.x();
    }

    double endY() const SIP_HOLDGIL
    {
      return mEnd.y();
    }

    QgsPointXY start() const SIP_HOLDGIL
    {
      return mStart;
    }

    QgsPointXY end() const SIP_HOLDGIL
    {
      return mEnd;
    }

    void setStartX( double x ) SIP_HOLDGIL
    {
      mStart.setX( x );
    }

    void setStartY( double y ) SIP_HOLDGIL
    {
      mStart.setY( y );
    }

    void setEndX( double x ) SIP_HOLDGIL
    {
      mEnd.setX( x );
    }

    void setEndY( double y ) SIP_HOLDGIL
    {
      mEnd.setY( y );
    }

    void setStart( const QgsPointXY &start ) SIP_HOLDGIL
    {
      mStart = start;
    }

    void setEnd( const QgsPointXY &end ) SIP_HOLDGIL
    {
      mEnd = end;
    }

    int pointLeftOfLine( const QgsPointXY &point ) const SIP_HOLDGIL;

    void reverse() SIP_HOLDGIL
    {
      std::swap( mStart, mEnd );
    }
 
    // TODO c++20 - replace with = default
 
    bool operator==( const QgsLineSegment2D &other ) const SIP_HOLDGIL
    {
      return mStart == other.mStart && mEnd == other.mEnd;
    }
 
    bool operator!=( const QgsLineSegment2D &other ) const SIP_HOLDGIL
    {
      return mStart != other.mStart || mEnd != other.mEnd;
    }
 
  private:
 
    QgsPointXY mStart;
    QgsPointXY mEnd;
 
};
 
#endif // QGSLINESEGMENT_H