KiCad PCB EDA Suite
geometry_utils.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 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
30 #ifndef GEOMETRY_UTILS_H
31 #define GEOMETRY_UTILS_H
32 
33 #include <math.h> // for copysign
34 #include <stdlib.h> // for abs
35 
36 #include <math/vector2d.h>
37 
38 class EDA_RECT;
39 
46 
55 int GetArcToSegmentCount( int aRadius, int aErrorMax, double aArcAngleDegree );
56 
68 {
69 public:
72 };
73 
83 int GetCircleToPolyCorrection( int aMaxError );
84 
96 template<typename T>
97 VECTOR2<T> GetVectorSnapped45( const VECTOR2<T>& aVec, bool only45 = false )
98 {
99  auto newVec = aVec;
100  const VECTOR2<T> absVec { std::abs( aVec.x ), std::abs( aVec.y ) };
101 
102  if ( !only45 && absVec.x > absVec.y * 2 )
103  {
104  // snap along x-axis
105  newVec.y = 0;
106  }
107  else if ( !only45 && absVec.y > absVec.x * 2 )
108  {
109  // snap onto y-axis
110  newVec.x = 0;
111  }
112  else if ( absVec.x > absVec.y )
113  {
114  // snap away from x-axis towards 45
115  newVec.y = std::copysign( aVec.x, aVec.y );
116  } else
117  {
118  // snap away from y-axis towards 45
119  newVec.x = std::copysign( aVec.y, aVec.x );
120  }
121 
122  return newVec;
123 }
124 
125 
139 bool ClipLine( const EDA_RECT *aClipBox, int &x1, int &y1, int &x2, int &y2 );
140 
141 
149 #define DOT_WIDTH_MILS 0.0254
150 
151 #define DOT_MARK_LEN( aLineWidth ) \
152  ( std::max( 1.0, IU_PER_MILS * DOT_WIDTH_MILS - aLineWidth ) )
153 
154 #define DASH_GAP_LEN( aLineWidth ) \
155  ( 3.0 * DOT_MARK_LEN( aLineWidth ) + ( 2.0 * aLineWidth ) )
156 
157 #define DASH_MARK_LEN( aLineWidth ) \
158  ( std::max( DASH_GAP_LEN( aLineWidth ), 5.0 * DOT_MARK_LEN( aLineWidth ) ) )
159 
160 
161 
162 #endif // #ifndef GEOMETRY_UTILS_H
163 
VECTOR2< T > GetVectorSnapped45(const VECTOR2< T > &aVec, bool only45=false)
Snap a vector onto the nearest 0, 45 or 90 degree line.
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
bool ClipLine(const EDA_RECT *aClipBox, int &x1, int &y1, int &x2, int &y2)
Test if any part of a line falls within the bounds of a rectangle.
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
int GetCircleToPolyCorrection(int aMaxError)
When creating polygons to create a clearance polygonal area, the polygon must be same or bigger than ...
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetArcToSegmentCount(int aRadius, int aErrorMax, double aArcAngleDegree)