KiCad PCB EDA Suite
Loading...
Searching...
No Matches
test_board_item.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) 2022-2023 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#include <eda_item_test_utils.h>
26#include <core/typeinfo.h>
27#include <drc/drc_item.h>
28
29// Code under test
30#include <board.h>
31#include <board_item.h>
32#include <footprint.h>
33#include <pad.h>
34#include <pcb_shape.h>
35#include <pcb_text.h>
36#include <pcb_textbox.h>
37#include <pcb_table.h>
38#include <pcb_tablecell.h>
39#include <pcb_reference_image.h>
40#include <zone.h>
41#include <pcb_track.h>
42#include <pcb_marker.h>
43#include <pcb_dimension.h>
44#include <pcb_target.h>
45#include <pcb_group.h>
46
48{
49public:
52 std::shared_ptr<DRC_ITEM> m_drcItem;
54
56 m_board(),
59 m_text( &m_board )
60 {
61 }
62
64 {
65 m_text.SetParentGroup( nullptr );
66 }
67
69 {
70 if( !IsPcbnewType( aType ) )
71 return nullptr;
72
73 if( !IsInstantiableType( aType ) )
74 return nullptr;
75
76 switch( aType )
77 {
78 case PCB_FOOTPRINT_T: return new FOOTPRINT( &m_board );
79 case PCB_PAD_T: return new PAD( &m_footprint );
81 case PCB_SHAPE_T: return new PCB_SHAPE( &m_board );
82 case PCB_TEXT_T: return new PCB_TEXT( &m_board );
83 case PCB_TEXTBOX_T: return new PCB_TEXTBOX( &m_board );
84 case PCB_TABLECELL_T: return new PCB_TABLECELL( &m_board );
85 case PCB_TABLE_T:
86 {
87 PCB_TABLE* table = new PCB_TABLE( &m_board, pcbIUScale.mmToIU( 0.1 ) );
88
89 table->SetColCount( 2 );
90
91 for( int ii = 0; ii < 4; ++ii )
92 table->InsertCell( ii, new PCB_TABLECELL( &m_board ) );
93
94 return table;
95 }
97 case PCB_TRACE_T: return new PCB_TRACK( &m_board );
98 case PCB_VIA_T: return new PCB_VIA( &m_board );
99 case PCB_ARC_T: return new PCB_ARC( &m_board );
100 case PCB_MARKER_T: return new PCB_MARKER( m_drcItem, VECTOR2I( 0, 0 ) );
102 case PCB_DIM_LEADER_T: return new PCB_DIM_LEADER( &m_board );
103 case PCB_DIM_CENTER_T: return new PCB_DIM_CENTER( &m_board );
104 case PCB_DIM_RADIAL_T: return new PCB_DIM_RADIAL( &m_board );
106 case PCB_TARGET_T: return new PCB_TARGET( &m_board );
107 case PCB_ZONE_T:
108 {
109 ZONE* zone = new ZONE( &m_board );
110
111 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( -100 ), pcbIUScale.mmToIU( -50 ) ), -1 );
112 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( -100 ), pcbIUScale.mmToIU( 50 ) ), -1 );
113 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( 100 ), pcbIUScale.mmToIU( 50 ) ), -1 );
114 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( 100 ), pcbIUScale.mmToIU( -50 ) ), -1 );
115
116 return zone;
117 }
118 case PCB_GROUP_T:
119 {
120 PCB_GROUP* group = new PCB_GROUP( &m_board );
121
122 // Group position only makes sense if there's at least one item in the group.
123 group->AddItem( &m_text );
124
125 return group;
126 }
127
128 case PCB_T:
129 case PCB_ITEM_LIST_T:
130 case PCB_NETINFO_T:
131 case PCB_GENERATOR_T:
132 return nullptr;
133
134 default:
135 BOOST_FAIL( wxString::Format(
136 "Unhandled type: %d "
137 "(if you created a new type you need to handle it in this switch statement)",
138 aType ) );
139 return nullptr;
140 }
141 }
142
143 static void CompareItems( BOARD_ITEM* aItem, BOARD_ITEM* aOriginalItem )
144 {
145 BOOST_CHECK_EQUAL( aItem->GetPosition(), aOriginalItem->GetPosition() );
146 BOOST_CHECK_EQUAL( aItem->GetBoundingBox().GetTop(),
147 aOriginalItem->GetBoundingBox().GetTop() );
148 BOOST_CHECK_EQUAL( aItem->GetBoundingBox().GetLeft(),
149 aOriginalItem->GetBoundingBox().GetLeft() );
150 BOOST_CHECK_EQUAL( aItem->GetBoundingBox().GetBottom(),
151 aOriginalItem->GetBoundingBox().GetBottom() );
152 BOOST_CHECK_EQUAL( aItem->GetBoundingBox().GetRight(),
153 aOriginalItem->GetBoundingBox().GetRight() );
154 }
155};
156
157
158BOOST_FIXTURE_TEST_SUITE( PcbItem, TEST_BOARD_ITEM_FIXTURE )
159
160
162{
163 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
164 {
165 KICAD_T type = static_cast<KICAD_T>( i );
166
167 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
168
169 if( item == nullptr )
170 continue;
171
172 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
173 {
174 IterateOverPositionsAndReferences<BOARD_ITEM>(
175 item.get(),
176 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
177 {
178 // FIXME: Update() has to be called after SetPosition() to update dimension
179 // shapes.
180 PCB_DIMENSION_BASE* originalDimension =
181 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
182
183 if( originalDimension != nullptr )
184 originalDimension->Update();
185
186 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate() );
187 VECTOR2I originalPos = item->GetPosition();
188
189 // Move to a point, then go back.
190 // This has to be an identity transformation.
191
192 item->Move( aRef );
193 BOOST_CHECK_EQUAL( item->GetPosition(), originalPos + aRef );
194
195 item->Move( -aRef );
196 CompareItems( item.get(), aOriginalItem );
197 } );
198 }
199 }
200}
201
202
204{
205 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
206 {
207 KICAD_T type = static_cast<KICAD_T>( i );
208
209 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
210
211 if( item == nullptr )
212 continue;
213
214 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
215 {
216 // Four same 90 degree rotations are an identity.
217
218 IterateOverPositionsAndReferences<BOARD_ITEM>(
219 item.get(),
220 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
221 {
222 // FIXME: Update() has to be called after SetPosition() to update dimension
223 // shapes.
224 PCB_DIMENSION_BASE* originalDimension =
225 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
226
227 if( originalDimension != nullptr )
228 originalDimension->Update();
229
230 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate() );
231
232 // Four equivalent 90 degree rotations are an identity.
233
234 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
235 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
236 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
237 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
238
239 CompareItems( item.get(), aOriginalItem );
240 } );
241 }
242 }
243}
244
245
246BOOST_AUTO_TEST_CASE( FlipLeftRight )
247{
248 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
249 {
250 KICAD_T type = static_cast<KICAD_T>( i );
251
252 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
253
254 if( item == nullptr )
255 continue;
256
257 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
258 {
259 IterateOverPositionsAndReferences<BOARD_ITEM>(
260 item.get(),
261 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
262 {
263 // FIXME: Update() has to be called after SetPosition() to update dimension
264 // shapes.
265 PCB_DIMENSION_BASE* originalDimension =
266 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
267
268 if( originalDimension != nullptr )
269 originalDimension->Update();
270
271 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate() );
272
273 // Two equivalent flips are an identity.
274
275 item->Flip( aRef, true );
276 item->Flip( aRef, true );
277
278 CompareItems( item.get(), aOriginalItem );
279 } );
280 }
281 }
282}
283
284
286{
287 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
288 {
289 KICAD_T type = static_cast<KICAD_T>( i );
290
291 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
292
293 if( item == nullptr )
294 continue;
295
296 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
297 {
298 IterateOverPositionsAndReferences<BOARD_ITEM>(
299 item.get(),
300 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
301 {
302 // FIXME: Update() has to be called after SetPosition() to update dimension
303 // shapes.
304 PCB_DIMENSION_BASE* originalDimension =
305 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
306
307 if( originalDimension != nullptr )
308 originalDimension->Update();
309
310 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate() );
311
312 // Two equivalent flips are an identity.
313
314 item->Flip( aRef, false );
315 item->Flip( aRef, false );
316
317 CompareItems( item.get(), aOriginalItem );
318 } );
319 }
320 }
321}
322
323
324BOOST_AUTO_TEST_SUITE_END()
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
void SetParentGroup(PCB_GROUP *aGroup)
Definition: board_item.h:90
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:281
coord_type GetTop() const
Definition: box2.h:195
coord_type GetRight() const
Definition: box2.h:190
coord_type GetLeft() const
Definition: box2.h:194
coord_type GetBottom() const
Definition: box2.h:191
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:242
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:74
int GetFieldCount() const
Return the number of fields in this symbol.
Definition: footprint.h:706
Definition: pad.h:59
For better understanding of the points that make a dimension:
Mark the center of a circle or arc with a cross shape.
A leader is a dimension-like object pointing to a specific point.
An orthogonal dimension is like an aligned dimension, but the extension lines are locked to the X or ...
A radial dimension indicates either the radius or diameter of an arc or circle.
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:51
Object to handle a bitmap image that can be inserted in a PCB.
void InsertCell(int aIdx, PCB_TABLECELL *aCell)
Definition: pcb_table.h:149
void SetColCount(int aCount)
Definition: pcb_table.h:99
BOARD_ITEM * Instantiate(KICAD_T aType)
static void CompareItems(BOARD_ITEM *aItem, BOARD_ITEM *aOriginalItem)
std::shared_ptr< DRC_ITEM > m_drcItem
Handle a list of polygons defining a copper zone.
Definition: zone.h:72
bool AppendCorner(VECTOR2I aPosition, int aHoleIdx, bool aAllowDuplication=false)
Add a new corner to the zone outline (to the main outline or a hole)
Definition: zone.cpp:801
@ DRCE_MALFORMED_COURTYARD
Definition: drc_item.h:63
Class to handle a set of BOARD_ITEMs.
constexpr int mmToIU(double mm) const
Definition: base_units.h:88
BOOST_AUTO_TEST_CASE(Move)
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ PCB_T
Definition: typeinfo.h:82
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:88
@ PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
Definition: typeinfo.h:105
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:102
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
Definition: typeinfo.h:91
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
@ MAX_STRUCT_TYPE_ID
Definition: typeinfo.h:235
@ PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
Definition: typeinfo.h:103
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:110
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition: typeinfo.h:93
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition: typeinfo.h:107
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
Definition: typeinfo.h:89
@ PCB_ITEM_LIST_T
class BOARD_ITEM_LIST, a list of board items
Definition: typeinfo.h:108
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition: typeinfo.h:90
@ PCB_MARKER_T
class PCB_MARKER, a marker used to show something
Definition: typeinfo.h:99
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:106
@ PCB_TABLECELL_T
class PCB_TABLECELL, PCB_TEXTBOX for use in tables
Definition: typeinfo.h:95
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition: typeinfo.h:86
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition: typeinfo.h:101
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:87
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
@ PCB_TABLE_T
class PCB_TABLE, table of PCB_TABLECELLs
Definition: typeinfo.h:94
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
Definition: typeinfo.h:109
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
Definition: typeinfo.h:104
constexpr bool IsPcbnewType(const KICAD_T aType)
Definition: typeinfo.h:418
constexpr bool IsInstantiableType(const KICAD_T aType)
Definition: typeinfo.h:306
#define BOOST_TEST_CONTEXT(A)
VECTOR2< int > VECTOR2I
Definition: vector2d.h:588