CLine2d.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QPair>
 
// ACF includes
#include <i2d/CObject2dBase.h>
#include <i2d/CVector2d.h>
 
 
namespace i2d
{
 
 
class CRectangle;
 
 
class CLine2d: public CObject2dBase
{
public:
       static QByteArray GetTypeName();
 
       CLine2d();
       CLine2d(const CVector2d& p1, const CVector2d& p2);
       CLine2d(double x1, double y1, double x2, double y2);
 
       bool operator==(const CLine2d& line) const;
       bool operator!=(const CLine2d& line) const;
 
       bool IsNull() const;
 
       const CVector2d& GetPoint1() const;
 
       CVector2d& GetPoint1Ref();
 
       void SetPoint1(const CVector2d& point);
 
       const CVector2d& GetPoint2() const;
 
       CVector2d& GetPoint2Ref();
 
       void SetPoint2(const CVector2d& point);
 
       double GetSlope() const;
 
       double GetIntercept() const;
 
       bool IsParallel(const CLine2d& line) const;
 
       bool IsIntersectedBy(const CLine2d& line) const;
 
       static bool Intersects(const CVector2d& lhsp1, const CVector2d& lhsp2,
                                             const CVector2d& rhsp1, const CVector2d& rhsp2);
 
       bool GetIntersection(const CLine2d& line, CVector2d& result) const;
 
       bool GetExtendedIntersection(const CLine2d& line, CVector2d& result) const;
 
       double GetDistance(const CVector2d& position) const;
 
       double GetMaxDistance(const CVector2d& position) const;
 
       double GetExtendedDistance(const CVector2d& position) const;
 
       CVector2d GetPositionFromAlpha(double alpha) const;
 
       CVector2d GetDiffVector() const;
 
       double GetLength() const;
 
       double GetLength2() const;
 
       double GetDirectionAngle() const;
 
       CLine2d GetClipped(const CRectangle& rect) const;
 
       CLine2d GetSwapped() const;
 
       double GetCutXPos(double linePosY) const;
 
       double GetCutYPos(double linePosX) const;
 
       void PushBeginPoint(const i2d::CVector2d& newBeginPoint);
 
       void PushEndPoint(const i2d::CVector2d& newEndPoint);
 
       void PushBeginPointQuiet(const i2d::CVector2d& newBeginPoint);
       void PushEndPointQuiet(const i2d::CVector2d& newEndPoint);
 
       void SetPoint1Quiet(const CVector2d& point);
       void SetPoint2Quiet(const CVector2d& point);
 
       double GetCutAlpha(const CLine2d& line) const;
 
       double GetCastAlpha(const i2d::CVector2d& point) const;
 
       QPair<double, double> GetAlphaAndCastDistance(const i2d::CVector2d& point) const;
 
       bool GetCutPoint(const CLine2d& otherLine, i2d::CVector2d& cutPoint) const;
 
       i2d::CVector2d GetNearestPoint(const i2d::CVector2d& point) const;
 
       i2d::CVector2d GetExtendedNearestPoint(const i2d::CVector2d& point) const;
 
       CLine2d GetShortestEndConnection(const CLine2d& line) const;
       
       CLine2d GetShortestConnectionToNext(const CLine2d& line) const;
       
       CLine2d GetShortestConnection(const i2d::CVector2d& point) const;
       
       CLine2d GetShortestConnection(const CLine2d& line) const;
 
       bool ApproxFromPoints(const QSet<i2d::CVector2d>& points);
 
       // reimplemented (i2d::IObject2d)
       virtual CVector2d GetCenter() const override;
       virtual void MoveCenterTo(const CVector2d& position) override;
       virtual CRectangle GetBoundingBox() const override;
       virtual bool Transform(
                            const ITransformation2d& transformation,
                            ITransformation2d::ExactnessMode mode = ITransformation2d::EM_NONE,
                            double* errorFactorPtr = NULL) override;
       virtual bool InvTransform(
                            const ITransformation2d& transformation,
                            ITransformation2d::ExactnessMode mode = ITransformation2d::EM_NONE,
                            double* errorFactorPtr = NULL) override;
       virtual bool GetTransformed(
                            const ITransformation2d& transformation,
                            IObject2d& result,
                            ITransformation2d::ExactnessMode mode = ITransformation2d::EM_NONE,
                            double* errorFactorPtr = NULL) const override;
       virtual bool GetInvTransformed(
                            const ITransformation2d& transformation,
                            IObject2d& result,
                            ITransformation2d::ExactnessMode mode = ITransformation2d::EM_NONE,
                            double* errorFactorPtr = NULL) const override;
 
       // reimplemented (iser::IObject)
       virtual QByteArray GetFactoryId() const override;
 
       // reimplemented (iser::ISerializable)
       virtual bool Serialize(iser::IArchive& archive) override;
 
       // reimplemented (istd::IChangeable)
       virtual int GetSupportedOperations() const override;
       virtual bool CopyFrom(const IChangeable& object, CompatibilityMode mode = CM_WITHOUT_REFS) override;
       virtual istd::TUniqueInterfacePtr<istd::IChangeable> CloneMe(CompatibilityMode mode = CM_WITHOUT_REFS) const override;
 
private:
       CVector2d m_point1;
       CVector2d m_point2;
};
 
 
// public inline methods
 
inline bool CLine2d::operator == (const CLine2d& line) const
{
       return ((m_point1 == line.m_point1) && (m_point2 == line.m_point2));
}
 
 
inline bool CLine2d::operator != (const CLine2d& line) const
{
       return !operator == (line);
}
 
 
inline bool CLine2d::IsNull() const
{
       return (m_point1 == m_point2);
}
 
 
inline CVector2d CLine2d::GetDiffVector() const
{
       return m_point2 - m_point1;
}
 
 
inline const CVector2d& CLine2d::GetPoint1() const
{
       return m_point1;
}
 
 
inline CVector2d& CLine2d::GetPoint1Ref()
{
       return m_point1;
}
 
 
inline const CVector2d& CLine2d::GetPoint2() const
{
       return m_point2;
}
 
 
inline CVector2d& CLine2d::GetPoint2Ref()
{
       return m_point2;
}
 
 
inline double CLine2d::GetCutXPos(double linePosY) const
{
       CVector2d diff = GetDiffVector();
 
       return (linePosY - m_point1.GetY()) * diff.GetX() / diff.GetY() + m_point1.GetX();
}
 
 
inline double CLine2d::GetCutYPos(double linePosX) const
{
       CVector2d diff = GetDiffVector();
 
       return (linePosX - m_point1.GetX()) * diff.GetY() / diff.GetX() + m_point1.GetY();
}
 
 
inline double CLine2d::GetCutAlpha(const CLine2d& line) const
{
       const i2d::CVector2d& delta = GetDiffVector();
       const i2d::CVector2d& lineDelta = line.GetDiffVector();
       const i2d::CVector2d& beginPoint = GetPoint1();
       const i2d::CVector2d& lineBeginPoint = line.GetPoint1();
 
       double crossProductZ = lineDelta.GetCrossProductZ(delta);
 
       return (beginPoint.GetCrossProductZ(delta) + delta.GetCrossProductZ(lineBeginPoint)) / crossProductZ;
}
 
 
inline double CLine2d::GetCastAlpha(const i2d::CVector2d& point) const
{
       i2d::CVector2d delta = GetDiffVector();
       i2d::CVector2d deltaToPoint = point - m_point1;
 
       double dotProduct = delta.GetDotProduct(deltaToPoint);
       return dotProduct / delta.GetLength2();
}
 
 
inline QPair<double, double> CLine2d::GetAlphaAndCastDistance(const i2d::CVector2d& point) const
{
       i2d::CVector2d delta = m_point2 - m_point1;
       i2d::CVector2d deltaToPoint = point - m_point1;
 
       double dotProduct = delta.GetDotProduct(deltaToPoint);
       double field = delta.GetCrossProductZ(deltaToPoint);
       double deltaLength2 = delta.GetLength2();
 
       return QPair<double, double>(dotProduct / deltaLength2, field / ::sqrt(deltaLength2));
}
 
 
inline void CLine2d::PushBeginPointQuiet(const i2d::CVector2d& newBeginPoint)
{
       m_point2 = m_point1;
       m_point1 = newBeginPoint;
}
 
 
inline void CLine2d::PushEndPointQuiet(const i2d::CVector2d& newEndPoint)
{
       m_point1 = m_point2;
       m_point2 = newEndPoint;
}
 
 
inline void CLine2d::SetPoint1Quiet(const CVector2d& point)
{
       m_point1 = point;
}
 
 
inline void CLine2d::SetPoint2Quiet(const CVector2d& point)
{
       m_point2 = point;
}
 
 
// related global functions
 
inline uint qHash(const CLine2d& key, uint seed = 0)
{
       return qHash(key.GetPoint1(), seed) ^ qHash(key.GetPoint2(), seed);
}
 
 
} // namespace i2d