Horizon
Loading...
Searching...
No Matches
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
38class EDA_RECT;
39
45enum ERROR_LOC { ERROR_OUTSIDE, ERROR_INSIDE };
46
55int GetArcToSegmentCount( int aRadius, int aErrorMax, double aArcAngleDegree );
56
65int CircleToEndSegmentDeltaRadius( int aInnerCircleRadius, int aSegCount );
66
83
93int GetCircleToPolyCorrection( int aMaxError );
94
106template<typename T>
107VECTOR2<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
149bool ClipLine( const EDA_RECT *aClipBox, int &x1, int &y1, int &x2, int &y2 );
150
151
156constexpr double dot_mark_len( double aLineWidth )
157{
158 return std::max( 1.0, aLineWidth );
159}
160
161constexpr double dash_gap_len( double aLineWidth )
162{
163 return 3.0 * dot_mark_len( aLineWidth ) + ( 2.0 * aLineWidth );
164}
165
166constexpr double dash_mark_len( double aLineWidth )
167{
168 return std::max( dash_gap_len( aLineWidth ), 5.0 * dot_mark_len( aLineWidth ) );
169}
170
171#endif // #ifndef GEOMETRY_UTILS_H
172
When creating polygons to create a clearance polygonal area, the polygon must be same or bigger than ...
Definition geometry_utils.h:78
Define a general 2D-vector/point.
Definition vector2d.h:72
int GetCircleToPolyCorrection(int aMaxError)
Definition geometry_utils.cpp:106
int CircleToEndSegmentDeltaRadius(int aInnerCircleRadius, int aSegCount)
Definition geometry_utils.cpp:67
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
Definition geometry_utils.h:45
constexpr double dot_mark_len(double aLineWidth)
Dashed and dotted line patterns.
Definition geometry_utils.h:156
VECTOR2< T > GetVectorSnapped45(const VECTOR2< T > &aVec, bool only45=false)
Snap a vector onto the nearest 0, 45 or 90 degree line.
Definition geometry_utils.h:107
int GetArcToSegmentCount(int aRadius, int aErrorMax, double aArcAngleDegree)
Definition geometry_utils.cpp:43
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.