KiCad PCB EDA Suite
Loading...
Searching...
No Matches
trigo.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef TRIGO_H
25#define TRIGO_H
26
27#include <cmath>
28#include <math/vector2d.h>
29#include <geometry/eda_angle.h>
30
43bool IsPointOnSegment( const VECTOR2I& aSegStart, const VECTOR2I& aSegEnd,
44 const VECTOR2I& aTestPoint );
45
57bool SegmentIntersectsSegment( const VECTOR2I& a_p1_l1, const VECTOR2I& a_p2_l1,
58 const VECTOR2I& a_p1_l2, const VECTOR2I& a_p2_l2,
59 VECTOR2I* aIntersectionPoint = nullptr );
60
64void RotatePoint( int *pX, int *pY, const EDA_ANGLE& aAngle );
65
66inline void RotatePoint( VECTOR2I& point, const EDA_ANGLE& aAngle )
67{
68 RotatePoint( &point.x, &point.y, aAngle );
69}
70
71
75void RotatePoint( int *pX, int *pY, int cx, int cy, const EDA_ANGLE& aAngle );
76
77inline void RotatePoint( VECTOR2I& point, const VECTOR2I& centre, const EDA_ANGLE& aAngle )
78{
79 RotatePoint( &point.x, &point.y, centre.x, centre.y, aAngle );
80}
81
82
86void RotatePoint( double* pX, double* pY, const EDA_ANGLE& aAngle );
87
88inline void RotatePoint( VECTOR2D& point, const EDA_ANGLE& aAngle )
89{
90 RotatePoint( &point.x, &point.y, aAngle );
91}
92
93void RotatePoint( double* pX, double* pY, double cx, double cy, const EDA_ANGLE& aAngle );
94
95inline void RotatePoint( VECTOR2D& point, const VECTOR2D& aCenter, const EDA_ANGLE& aAngle )
96{
97 RotatePoint( &point.x, &point.y, aCenter.x, aCenter.y, aAngle );
98}
99
108const VECTOR2I CalcArcCenter( const VECTOR2I& aStart, const VECTOR2I& aMid, const VECTOR2I& aEnd );
109const VECTOR2D CalcArcCenter( const VECTOR2D& aStart, const VECTOR2D& aMid, const VECTOR2D& aEnd );
110const VECTOR2D CalcArcCenter( const VECTOR2D& aStart, const VECTOR2D& aEnd,
111 const EDA_ANGLE& aAngle );
112
125const VECTOR2I CalcArcMid( const VECTOR2I& aStart, const VECTOR2I& aEnd, const VECTOR2I& aCenter,
126 bool aMinArcAngle = true );
127
128inline double EuclideanNorm( const VECTOR2I& vector )
129{
130 // this is working with doubles
131 return hypot( vector.x, vector.y );
132}
133
143inline double DistanceLinePoint( const VECTOR2I& linePointA, const VECTOR2I& linePointB,
144 const VECTOR2I& referencePoint )
145{
146 // Some of the multiple double casts are redundant. However in the previous definition
147 // the cast was (implicitly) done too late, just before the division (EuclideanNorm gives
148 // a double so from int it would be promoted); that means that the whole expression were
149 // vulnerable to overflow during int multiplications
150 return fabs( ( static_cast<double>( linePointB.x - linePointA.x ) *
151 static_cast<double>( linePointA.y - referencePoint.y ) -
152 static_cast<double>( linePointA.x - referencePoint.x ) *
153 static_cast<double>( linePointB.y - linePointA.y) )
154 / EuclideanNorm( linePointB - linePointA ) );
155}
156
165inline bool HitTestPoints( const VECTOR2I& pointA, const VECTOR2I& pointB, double threshold )
166{
167 VECTOR2I vectorAB = pointB - pointA;
168
169 // Compare the distances squared. The double is needed to avoid overflow during int
170 // multiplication
171 double sqdistance = (double)vectorAB.x * vectorAB.x + (double)vectorAB.y * vectorAB.y;
172
173 return sqdistance < threshold * threshold;
174}
175
184bool TestSegmentHit( const VECTOR2I& aRefPoint, const VECTOR2I& aStart, const VECTOR2I& aEnd,
185 int aDist );
186
194inline double GetLineLength( const VECTOR2I& aPointA, const VECTOR2I& aPointB )
195{
196 return hypot( (double) aPointA.x - aPointB.x, (double) aPointA.y - aPointB.y );
197}
198
199// These are the usual degrees <-> radians conversion routines
200inline double DEG2RAD( double deg ) { return deg * M_PI / 180.0; }
201inline double RAD2DEG( double rad ) { return rad * 180.0 / M_PI; }
202
203// These are the same *but* work with the internal 'decidegrees' unit
204inline double RAD2DECIDEG( double rad ) { return rad * 1800.0 / M_PI; }
205
206/* These are templated over T (and not simply double) because Eeschema
207 is still using int for angles in some place */
208
212template <class T> inline T NormalizeAnglePos( T Angle )
213{
214 while( Angle < 0 )
215 Angle += 3600;
216 while( Angle >= 3600 )
217 Angle -= 3600;
218 return Angle;
219}
220
221template <class T> inline void NORMALIZE_ANGLE_POS( T& Angle )
222{
223 Angle = NormalizeAnglePos( Angle );
224}
225
226
230template <class T> inline T NormalizeAngle180( T Angle )
231{
232 while( Angle <= -1800 )
233 Angle += 3600;
234
235 while( Angle > 1800 )
236 Angle -= 3600;
237
238 return Angle;
239}
240
249inline bool InterceptsPositiveX( double aStartAngle, double aEndAngle )
250{
251 double end = aEndAngle;
252
253 if( aStartAngle > aEndAngle )
254 end += 360.0;
255
256 return aStartAngle < 360.0 && end > 360.0;
257}
258
267inline bool InterceptsNegativeX( double aStartAngle, double aEndAngle )
268{
269 double end = aEndAngle;
270
271 if( aStartAngle > aEndAngle )
272 end += 360.0;
273
274 return aStartAngle < 180.0 && end > 180.0;
275}
276
277#endif
const VECTOR2I CalcArcMid(const VECTOR2I &aStart, const VECTOR2I &aEnd, const VECTOR2I &aCenter, bool aMinArcAngle=true)
Return the middle point of an arc, half-way between aStart and aEnd.
Definition: trigo.cpp:208
bool TestSegmentHit(const VECTOR2I &aRefPoint, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aDist)
Test if aRefPoint is with aDistance on the line defined by aStart and aEnd.
Definition: trigo.cpp:174
double DistanceLinePoint(const VECTOR2I &linePointA, const VECTOR2I &linePointB, const VECTOR2I &referencePoint)
Compute the distance between a line and a reference point.
Definition: trigo.h:143
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
Definition: trigo.cpp:228
bool InterceptsPositiveX(double aStartAngle, double aEndAngle)
Test if an arc from aStartAngle to aEndAngle crosses the positive X axis (0 degrees).
Definition: trigo.h:249
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:221
bool InterceptsNegativeX(double aStartAngle, double aEndAngle)
Test if an arc from aStartAngle to aEndAngle crosses the negative X axis (180 degrees).
Definition: trigo.h:267
T NormalizeAnglePos(T Angle)
Normalize angle to be in the 0.0 .
Definition: trigo.h:212
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)
Test if two lines intersect.
Definition: trigo.cpp:106
bool IsPointOnSegment(const VECTOR2I &aSegStart, const VECTOR2I &aSegEnd, const VECTOR2I &aTestPoint)
Test if aTestPoint is on line defined by aSegStart and aSegEnd.
Definition: trigo.cpp:88
double RAD2DEG(double rad)
Definition: trigo.h:201
bool HitTestPoints(const VECTOR2I &pointA, const VECTOR2I &pointB, double threshold)
Test if two points are near each other.
Definition: trigo.h:165
double DEG2RAD(double deg)
Definition: trigo.h:200
T NormalizeAngle180(T Angle)
Normalize angle to be in the -180.0 .
Definition: trigo.h:230
const VECTOR2I CalcArcCenter(const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd)
Determine the center of an arc or circle given three points on its circumference.
Definition: trigo.cpp:520
double GetLineLength(const VECTOR2I &aPointA, const VECTOR2I &aPointB)
Return the length of a line segment defined by aPointA and aPointB.
Definition: trigo.h:194
double RAD2DECIDEG(double rad)
Definition: trigo.h:204
double EuclideanNorm(const VECTOR2I &vector)
Definition: trigo.h:128