KiCad PCB EDA Suite
board_construction_utils.cpp
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) 2019 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 
25 
26 #include <class_edge_mod.h>
27 #include <class_module.h>
28 #include <drc/drc.h>
29 
30 #include <geometry/seg.h>
31 #include <math/vector2d.h>
32 
33 
34 namespace KI_TEST
35 {
36 
37 void DrawSegment( MODULE& aMod, const SEG& aSeg, int aWidth, PCB_LAYER_ID aLayer )
38 {
39  auto seg = std::make_unique<EDGE_MODULE>( &aMod, STROKE_T::S_SEGMENT );
40 
41  seg->SetStart0( (wxPoint) aSeg.A );
42  seg->SetEnd0( (wxPoint) aSeg.B );
43 
44  seg->SetWidth( aWidth );
45  seg->SetLayer( aLayer );
46 
47  aMod.Add( seg.release() );
48 }
49 
50 
52  MODULE& aMod, const std::vector<VECTOR2I>& aPts, int aWidth, PCB_LAYER_ID aLayer )
53 {
54  for( unsigned i = 0; i < aPts.size() - 1; ++i )
55  {
56  DrawSegment( aMod, { aPts[i], aPts[i + 1] }, aWidth, aLayer );
57  }
58 }
59 
60 
61 void DrawArc( MODULE& aMod, const VECTOR2I& aCentre, const VECTOR2I& aStart, double aAngle,
62  int aWidth, PCB_LAYER_ID aLayer )
63 {
64  auto seg = std::make_unique<EDGE_MODULE>( &aMod, STROKE_T::S_ARC );
65 
66  seg->SetStart0( (wxPoint) aCentre );
67  seg->SetEnd0( (wxPoint) aStart );
68  seg->SetAngle( aAngle * 10 );
69 
70  seg->SetWidth( aWidth );
71  seg->SetLayer( aLayer );
72 
73  aMod.Add( seg.release() );
74 }
75 
76 
77 void DrawRect( MODULE& aMod, const VECTOR2I& aPos, const VECTOR2I& aSize, int aRadius, int aWidth,
78  PCB_LAYER_ID aLayer )
79 {
80  const auto x_r = aPos.x + aSize.x / 2;
81  const auto x_l = aPos.x - aSize.x / 2;
82  const auto y_t = aPos.y + aSize.y / 2;
83  const auto y_b = aPos.y - aSize.y / 2;
84 
85  const auto xin_r = x_r - aRadius;
86  const auto xin_l = x_l + aRadius;
87  const auto yin_t = y_t - aRadius;
88  const auto yin_b = y_b + aRadius;
89 
90  // If non-zero (could be zero if it's a stadium shape)
91  if( xin_l != xin_r )
92  {
93  DrawSegment( aMod, { { xin_l, y_t }, { xin_r, y_t } }, aWidth, aLayer );
94  DrawSegment( aMod, { { xin_l, y_b }, { xin_r, y_b } }, aWidth, aLayer );
95  }
96 
97  if( yin_b != yin_t )
98  {
99  DrawSegment( aMod, { { x_l, yin_b }, { x_l, yin_t } }, aWidth, aLayer );
100  DrawSegment( aMod, { { x_r, yin_b }, { x_r, yin_t } }, aWidth, aLayer );
101  }
102 
103  if( aRadius > 0 )
104  {
105  DrawArc( aMod, { xin_r, yin_t }, { x_r, yin_t }, 90, aWidth, aLayer );
106  DrawArc( aMod, { xin_l, yin_t }, { xin_l, y_t }, 90, aWidth, aLayer );
107  DrawArc( aMod, { xin_l, yin_b }, { x_l, yin_b }, 90, aWidth, aLayer );
108  DrawArc( aMod, { xin_r, yin_b }, { xin_r, y_b }, 90, aWidth, aLayer );
109  }
110 }
111 
112 } // namespace KI_TEST
void DrawPolyline(MODULE &aMod, const std::vector< VECTOR2I > &aPts, int aWidth, PCB_LAYER_ID aLayer)
Draw a polyline - a set of linked segments.
usual segment : line with rounded ends
Construction utilities for PCB tests.
PCB_LAYER_ID
A quick note on layer IDs:
Arcs (with rounded ends)
void DrawRect(MODULE &aMod, const VECTOR2I &aPos, const VECTOR2I &aSize, int aRadius, int aWidth, PCB_LAYER_ID aLayer)
Draw a rectangle on a module.
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Definition: seg.h:39
VECTOR2I A
Definition: seg.h:47
void DrawArc(MODULE &aMod, const VECTOR2I &aCentre, const VECTOR2I &aStart, double aAngle, int aWidth, PCB_LAYER_ID aLayer)
Draw an arc on a module.
void DrawSegment(MODULE &aMod, const SEG &aSeg, int aWidth, PCB_LAYER_ID aLayer)
Draw a segment in the given module.
EDGE_MODULE class definition.
VECTOR2I B
Definition: seg.h:48