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
136bool TestSegmentHit( const VECTOR2I& aRefPoint, const VECTOR2I& aStart, const VECTOR2I& aEnd,
137 int aDist );
138
139// These are the usual degrees <-> radians conversion routines
140inline double DEG2RAD( double deg ) { return deg * M_PI / 180.0; }
141inline double RAD2DEG( double rad ) { return rad * 180.0 / M_PI; }
142
143// These are the same *but* work with the internal 'decidegrees' unit
144inline double RAD2DECIDEG( double rad ) { return rad * 1800.0 / M_PI; }
145
146/* These are templated over T (and not simply double) because Eeschema
147 is still using int for angles in some place */
148
152template <class T> inline T NormalizeAnglePos( T Angle )
153{
154 while( Angle < 0 )
155 Angle += 3600;
156 while( Angle >= 3600 )
157 Angle -= 3600;
158 return Angle;
159}
160
161template <class T> inline void NORMALIZE_ANGLE_POS( T& Angle )
162{
163 Angle = NormalizeAnglePos( Angle );
164}
165
166
170template <class T> inline T NormalizeAngle180( T Angle )
171{
172 while( Angle <= -1800 )
173 Angle += 3600;
174
175 while( Angle > 1800 )
176 Angle -= 3600;
177
178 return Angle;
179}
180
189inline bool InterceptsPositiveX( double aStartAngle, double aEndAngle )
190{
191 double end = aEndAngle;
192
193 if( aStartAngle > aEndAngle )
194 end += 360.0;
195
196 return aStartAngle < 360.0 && end > 360.0;
197}
198
207inline bool InterceptsNegativeX( double aStartAngle, double aEndAngle )
208{
209 double end = aEndAngle;
210
211 if( aStartAngle > aEndAngle )
212 end += 360.0;
213
214 return aStartAngle < 180.0 && end > 180.0;
215}
216
227template <class T>
228inline typename VECTOR2<T>::extended_type
229ParallelogramArea( const VECTOR2<T>& aPointA, const VECTOR2<T>& aPointB, const VECTOR2<T>& aPointC )
230{
231 VECTOR2<T> v1 = aPointB - aPointA;
232 VECTOR2<T> v2 = aPointC - aPointA;
233 return v1.Cross( v2 );
234}
235
240bool TestSegmentHitFast( const VECTOR2I& aRefPoint, const VECTOR2I& aStart, const VECTOR2I& aEnd,
241 int aDist );
242
243#endif
VECTOR2_TRAITS< T >::extended_type extended_type
Definition: vector2d.h:72
VECTOR3< T > Cross(const VECTOR3< T > &aVector) const
Compute cross product of self with aVector.
Definition: vector3.h:128
VECTOR3I v1(5, 5, 5)
VECTOR2I v2(1, 0)
Test suite for KiCad math code.
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
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:189
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:161
bool InterceptsNegativeX(double aStartAngle, double aEndAngle)
Test if an arc from aStartAngle to aEndAngle crosses the negative X axis (180 degrees).
Definition: trigo.h:207
T NormalizeAnglePos(T Angle)
Normalize angle to be in the 0.0 .
Definition: trigo.h:152
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
VECTOR2< T >::extended_type ParallelogramArea(const VECTOR2< T > &aPointA, const VECTOR2< T > &aPointB, const VECTOR2< T > &aPointC)
Calculate the area of a parallelogram defined by aPointA, aPointB, and aPointC.
Definition: trigo.h:229
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:141
double DEG2RAD(double deg)
Definition: trigo.h:140
T NormalizeAngle180(T Angle)
Normalize angle to be in the -180.0 .
Definition: trigo.h:170
bool TestSegmentHitFast(const VECTOR2I &aRefPoint, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aDist)
Test if a point hits a line segment within a given distance.
Definition: trigo.cpp:541
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 RAD2DECIDEG(double rad)
Definition: trigo.h:144