trigo.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef TRIGO_H
#define TRIGO_H
 
#include <cmath>
#include <math/vector2d.h>
#include <geometry/eda_angle.h>
 
bool IsPointOnSegment( const VECTOR2I& aSegStart, const VECTOR2I& aSegEnd,
 const VECTOR2I& aTestPoint );
 
bool SegmentIntersectsSegment( const VECTOR2I& a_p1_l1, const VECTOR2I& a_p2_l1,
 const VECTOR2I& a_p1_l2, const VECTOR2I& a_p2_l2,
 VECTOR2I* aIntersectionPoint = nullptr );
 
void RotatePoint( int *pX, int *pY, const EDA_ANGLE& aAngle );
 
inline void RotatePoint( VECTOR2I& point, const EDA_ANGLE& aAngle )
{
 RotatePoint( &point.x, &point.y, aAngle );
}
 
 
void RotatePoint( int *pX, int *pY, int cx, int cy, const EDA_ANGLE& aAngle );
 
inline void RotatePoint( VECTOR2I& point, const VECTOR2I& centre, const EDA_ANGLE& aAngle )
{
 RotatePoint( &point.x, &point.y, centre.x, centre.y, aAngle );
}
 
 
void RotatePoint( double* pX, double* pY, const EDA_ANGLE& aAngle );
 
inline void RotatePoint( VECTOR2D& point, const EDA_ANGLE& aAngle )
{
 RotatePoint( &point.x, &point.y, aAngle );
}
 
void RotatePoint( double* pX, double* pY, double cx, double cy, const EDA_ANGLE& aAngle );
 
inline void RotatePoint( VECTOR2D& point, const VECTOR2D& aCenter, const EDA_ANGLE& aAngle )
{
 RotatePoint( &point.x, &point.y, aCenter.x, aCenter.y, aAngle );
}
 
const VECTOR2I CalcArcCenter( const VECTOR2I& aStart, const VECTOR2I& aMid, const VECTOR2I& aEnd );
const VECTOR2D CalcArcCenter( const VECTOR2D& aStart, const VECTOR2D& aMid, const VECTOR2D& aEnd );
const VECTOR2D CalcArcCenter( const VECTOR2D& aStart, const VECTOR2D& aEnd,
 const EDA_ANGLE& aAngle );
 
const VECTOR2I CalcArcMid( const VECTOR2I& aStart, const VECTOR2I& aEnd, const VECTOR2I& aCenter,
 bool aMinArcAngle = true );
 
inline double EuclideanNorm( const VECTOR2I& vector )
{
 // this is working with doubles
 return hypot( vector.x, vector.y );
}
 
inline double DistanceLinePoint( const VECTOR2I& linePointA, const VECTOR2I& linePointB,
 const VECTOR2I& referencePoint )
{
 // Some of the multiple double casts are redundant. However in the previous definition
 // the cast was (implicitly) done too late, just before the division (EuclideanNorm gives
 // a double so from int it would be promoted); that means that the whole expression were
 // vulnerable to overflow during int multiplications
 return fabs( ( static_cast<double>( linePointB.x - linePointA.x ) *
 static_cast<double>( linePointA.y - referencePoint.y ) -
 static_cast<double>( linePointA.x - referencePoint.x ) *
 static_cast<double>( linePointB.y - linePointA.y) )
 / EuclideanNorm( linePointB - linePointA ) );
}
 
inline bool HitTestPoints( const VECTOR2I& pointA, const VECTOR2I& pointB, double threshold )
{
 VECTOR2I vectorAB = pointB - pointA;
 
 // Compare the distances squared. The double is needed to avoid overflow during int
 // multiplication
 double sqdistance = (double)vectorAB.x * vectorAB.x + (double)vectorAB.y * vectorAB.y;
 
 return sqdistance < threshold * threshold;
}
 
bool TestSegmentHit( const VECTOR2I& aRefPoint, const VECTOR2I& aStart, const VECTOR2I& aEnd,
 int aDist );
 
inline double GetLineLength( const VECTOR2I& aPointA, const VECTOR2I& aPointB )
{
 // Implicitly casted to double
 return hypot( aPointA.x - aPointB.x, aPointA.y - aPointB.y );
}
 
// These are the usual degrees <-> radians conversion routines
inline double DEG2RAD( double deg ) { return deg * M_PI / 180.0; }
inline double RAD2DEG( double rad ) { return rad * 180.0 / M_PI; }
 
// These are the same *but* work with the internal 'decidegrees' unit
inline double RAD2DECIDEG( double rad ) { return rad * 1800.0 / M_PI; }
 
/* These are templated over T (and not simply double) because Eeschema
 is still using int for angles in some place */
 
template <class T> inline T NormalizeAnglePos( T Angle )
{
 while( Angle < 0 )
 Angle += 3600;
 while( Angle >= 3600 )
 Angle -= 3600;
 return Angle;
}
 
template <class T> inline void NORMALIZE_ANGLE_POS( T& Angle )
{
 Angle = NormalizeAnglePos( Angle );
}
 
 
template <class T> inline T NormalizeAngle180( T Angle )
{
 while( Angle <= -1800 )
 Angle += 3600;
 
 while( Angle > 1800 )
 Angle -= 3600;
 
 return Angle;
}
 
inline bool InterceptsPositiveX( double aStartAngle, double aEndAngle )
{
 double end = aEndAngle;
 
 if( aStartAngle > aEndAngle )
 end += 360.0;
 
 return aStartAngle < 360.0 && end > 360.0;
}
 
inline bool InterceptsNegativeX( double aStartAngle, double aEndAngle )
{
 double end = aEndAngle;
 
 if( aStartAngle > aEndAngle )
 end += 360.0;
 
 return aStartAngle < 180.0 && end > 180.0;
}
 
#endif