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#include <math/box2.h>
36#include <geometry/eda_angle.h>
37
44
53int GetArcToSegmentCount( int aRadius, int aErrorMax, const EDA_ANGLE& aArcAngle );
54
63int CircleToEndSegmentDeltaRadius( int aInnerCircleRadius, int aSegCount );
64
76{
77public:
80};
81
91int GetCircleToPolyCorrection( int aMaxError );
92
104template<typename T>
105VECTOR2<T> GetVectorSnapped45( const VECTOR2<T>& aVec, bool only45 = false )
106{
107 using ext_type = typename VECTOR2<T>::extended_type;
108
109 auto newVec = aVec;
110 const VECTOR2<T> absVec{ std::abs( aVec.x ), std::abs( aVec.y ) };
111
112 if( !only45 && absVec.x > ext_type( absVec.y ) * 2 )
113 {
114 // snap along x-axis
115 newVec.y = 0;
116 }
117 else if( !only45 && absVec.y > ext_type( 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 }
127 else
128 {
129 // snap away from y-axis towards 45
130 newVec.x = std::copysign( aVec.y, aVec.x );
131 }
132
133 return newVec;
134}
135
136
149template <typename in_type, typename ret_type = in_type, typename pad_type = unsigned int,
150 typename = typename std::enable_if<std::is_unsigned<pad_type>::value>::type>
151VECTOR2<ret_type> GetClampedCoords( const VECTOR2<in_type>& aCoords, pad_type aPadding = 1u )
152{
153 typedef std::numeric_limits<int32_t> coord_limits;
154
155 long long max = static_cast<long long>( coord_limits::max() ) - aPadding;
156 long long min = -max;
157
158 in_type x = aCoords.x;
159 in_type y = aCoords.y;
160
161 if( x < min )
162 x = in_type( min );
163 else if( x > max )
164 x = in_type( max );
165
166 if( y < min )
167 y = in_type( min );
168 else if( y > max )
169 y = in_type( max );
170
171 if( !std::is_integral<in_type>() && std::is_integral<ret_type>() )
172 return VECTOR2<ret_type>( KiROUND( x ), KiROUND( y ) );
173
174 return VECTOR2<ret_type>( x, y );
175}
176
177
191bool ClipLine( const BOX2I *aClipBox, int &x1, int &y1, int &x2, int &y2 );
192
193
194#endif // #ifndef GEOMETRY_UTILS_H
195
When creating polygons to create a clearance polygonal area, the polygon must be same or bigger than ...
Define a general 2D-vector/point.
Definition: vector2d.h:74
VECTOR2_TRAITS< T >::extended_type extended_type
Definition: vector2d.h:76
int GetCircleToPolyCorrection(int aMaxError)
int CircleToEndSegmentDeltaRadius(int aInnerCircleRadius, int aSegCount)
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
@ ERROR_OUTSIDE
@ ERROR_INSIDE
VECTOR2< T > GetVectorSnapped45(const VECTOR2< T > &aVec, bool only45=false)
Snap a vector onto the nearest 0, 45 or 90 degree line.
bool ClipLine(const BOX2I *aClipBox, int &x1, int &y1, int &x2, int &y2)
Test if any part of a line falls within the bounds of a rectangle.
int GetArcToSegmentCount(int aRadius, int aErrorMax, const EDA_ANGLE &aArcAngle)
VECTOR2< ret_type > GetClampedCoords(const VECTOR2< in_type > &aCoords, pad_type aPadding=1u)
Clamps a vector to values that can be negated, respecting numeric limits of coordinates data type wit...
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition: eda_angle.h:412
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:85