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-2021 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 
65 int CircleToEndSegmentDeltaRadius( int aInnerCircleRadius, int aSegCount );
66 
78 {
79 public:
82 };
83 
93 int GetCircleToPolyCorrection( int aMaxError );
94 
106 template<typename T>
107 VECTOR2<T> GetVectorSnapped45( const VECTOR2<T>& aVec, bool only45 = false )
108 {
109  auto newVec = aVec;
110  const VECTOR2<T> absVec { std::abs( aVec.x ), std::abs( aVec.y ) };
111 
112  if ( !only45 && absVec.x > absVec.y * 2 )
113  {
114  // snap along x-axis
115  newVec.y = 0;
116  }
117  else if ( !only45 && absVec.y > absVec.x * 2 )
118  {
119  // snap onto y-axis
120  newVec.x = 0;
121  }
122  else if ( absVec.x > absVec.y )
123  {
124  // snap away from x-axis towards 45
125  newVec.y = std::copysign( aVec.x, aVec.y );
126  } else
127  {
128  // snap away from y-axis towards 45
129  newVec.x = std::copysign( aVec.y, aVec.x );
130  }
131 
132  return newVec;
133 }
134 
135 
148 template <typename in_type, typename ret_type = in_type, typename pad_type = unsigned int,
149  typename = typename std::enable_if<std::is_unsigned<pad_type>::value>::type>
150 VECTOR2<ret_type> GetClampedCoords( const VECTOR2<in_type>& aCoords, pad_type aPadding = 0u )
151 {
152  typedef std::numeric_limits<int> coord_limits;
153 
154  long max = coord_limits::max() - aPadding;
155  long min = -max;
156 
157  in_type x = aCoords.x;
158  in_type y = aCoords.y;
159 
160  if( x < min )
161  x = min;
162  else if( x > max )
163  x = max;
164 
165  if( y < min )
166  y = min;
167  else if( y > max )
168  y = max;
169 
170  if( !std::is_integral<in_type>() && std::is_integral<ret_type>() )
171  return VECTOR2<ret_type>( KiROUND( x ), KiROUND( y ) );
172 
173  return VECTOR2<ret_type>( x, y );
174 }
175 
176 
190 bool ClipLine( const EDA_RECT *aClipBox, int &x1, int &y1, int &x2, int &y2 );
191 
192 
197 constexpr double dot_mark_len( double aLineWidth )
198 {
199  return std::max( 1.0, aLineWidth );
200 }
201 
202 constexpr double dash_gap_len( double aLineWidth )
203 {
204  return 3.0 * dot_mark_len( aLineWidth ) + ( 2.0 * aLineWidth );
205 }
206 
207 constexpr double dash_mark_len( double aLineWidth )
208 {
209  return std::max( dash_gap_len( aLineWidth ), 5.0 * dot_mark_len( aLineWidth ) );
210 }
211 
212 #endif // #ifndef GEOMETRY_UTILS_H
213 
VECTOR2< T > GetVectorSnapped45(const VECTOR2< T > &aVec, bool only45=false)
Snap a vector onto the nearest 0, 45 or 90 degree line.
int CircleToEndSegmentDeltaRadius(int aInnerCircleRadius, int aSegCount)
Define 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...
VECTOR2< ret_type > GetClampedCoords(const VECTOR2< in_type > &aCoords, pad_type aPadding=0u)
Clamps a vector to values that can be negated, respecting numeric limits of coordinates data type wit...
constexpr double dot_mark_len(double aLineWidth)
Dashed and dotted line patterns.
int GetCircleToPolyCorrection(int aMaxError)
constexpr double dash_gap_len(double aLineWidth)
When creating polygons to create a clearance polygonal area, the polygon must be same or bigger than ...
Handle the component boundary box.
Definition: eda_rect.h:42
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:73
int GetArcToSegmentCount(int aRadius, int aErrorMax, double aArcAngleDegree)
constexpr double dash_mark_len(double aLineWidth)