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 The 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#include <pcb_board_outline.h>
47
49{
50public:
53 std::shared_ptr<DRC_ITEM> m_drcItem;
55
57 m_board(),
60 m_text( &m_board )
61 {
62 }
63
65 {
66 m_text.SetParentGroup( nullptr );
67 }
68
70 {
71 if( !IsPcbnewType( aType ) )
72 return nullptr;
73
74 if( !IsInstantiableType( aType ) )
75 return nullptr;
76
77 switch( aType )
78 {
79 case PCB_FOOTPRINT_T: return new FOOTPRINT( &m_board );
80 case PCB_PAD_T: return new PAD( &m_footprint );
81 case PCB_FIELD_T: return new PCB_FIELD( &m_footprint, FIELD_T::USER );
82 case PCB_SHAPE_T: return new PCB_SHAPE( &m_board );
83 case PCB_TEXT_T: return new PCB_TEXT( &m_board );
84 case PCB_TEXTBOX_T: return new PCB_TEXTBOX( &m_board );
85 case PCB_TABLECELL_T: return new PCB_TABLECELL( &m_board );
86 case PCB_TABLE_T:
87 {
89
90 table->SetColCount( 2 );
91
92 for( int ii = 0; ii < 4; ++ii )
93 {
94 PCB_TABLECELL* cell = new PCB_TABLECELL( &m_board );
95 cell->SetRectangleHeight( 0 );
96 cell->SetRectangleWidth( 0 );
97 table->InsertCell( ii, cell );
98 }
99
100 return table;
101 }
102
104 case PCB_TRACE_T: return new PCB_TRACK( &m_board );
105 case PCB_VIA_T: return new PCB_VIA( &m_board );
106 case PCB_ARC_T: return new PCB_ARC( &m_board );
107 case PCB_MARKER_T: return new PCB_MARKER( m_drcItem, VECTOR2I( 0, 0 ) );
109 case PCB_DIM_LEADER_T: return new PCB_DIM_LEADER( &m_board );
110 case PCB_DIM_CENTER_T: return new PCB_DIM_CENTER( &m_board );
111 case PCB_DIM_RADIAL_T: return new PCB_DIM_RADIAL( &m_board );
113 case PCB_TARGET_T: return new PCB_TARGET( &m_board );
114
115 case PCB_ZONE_T:
116 {
117 ZONE* zone = new ZONE( &m_board );
118
119 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( -100 ), pcbIUScale.mmToIU( -50 ) ), -1 );
120 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( -100 ), pcbIUScale.mmToIU( 50 ) ), -1 );
121 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( 100 ), pcbIUScale.mmToIU( 50 ) ), -1 );
122 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( 100 ), pcbIUScale.mmToIU( -50 ) ), -1 );
123
124 return zone;
125 }
126
127 case PCB_GROUP_T:
128 {
129 PCB_GROUP* group = new PCB_GROUP( &m_board );
130
131 // Group position only makes sense if there's at least one item in the group.
132 group->AddItem( &m_text );
133
134 return group;
135 }
136
137 case PCB_T:
138 case PCB_ITEM_LIST_T:
139 case PCB_NETINFO_T:
140 case PCB_GENERATOR_T:
142 return nullptr;
143
144 default:
145 BOOST_FAIL( wxString::Format(
146 "Unhandled type: %d "
147 "(if you created a new type you need to handle it in this switch statement)",
148 aType ) );
149 return nullptr;
150 }
151 }
152
153 static void CompareItems( BOARD_ITEM* aItem, BOARD_ITEM* aOriginalItem )
154 {
155 BOOST_CHECK_EQUAL( aItem->GetPosition(), aOriginalItem->GetPosition() );
157 aOriginalItem->GetBoundingBox().GetTop() );
159 aOriginalItem->GetBoundingBox().GetLeft() );
161 aOriginalItem->GetBoundingBox().GetBottom() );
163 aOriginalItem->GetBoundingBox().GetRight() );
164 }
165};
166
167
168BOOST_FIXTURE_TEST_SUITE( PcbItem, TEST_BOARD_ITEM_FIXTURE )
169
170
172{
173 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
174 {
175 KICAD_T type = static_cast<KICAD_T>( i );
176
177 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
178
179 if( item == nullptr )
180 continue;
181
182 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
183 {
184 IterateOverPositionsAndReferences<BOARD_ITEM>(
185 item.get(),
186 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
187 {
188 // FIXME: Update() has to be called after SetPosition() to update dimension
189 // shapes.
190 PCB_DIMENSION_BASE* originalDimension =
191 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
192
193 if( originalDimension != nullptr )
194 originalDimension->Update();
195
196 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate( IGNORE_PARENT_GROUP ) );
197 VECTOR2I originalPos = item->GetPosition();
198
199 // Move to a point, then go back.
200 // This has to be an identity transformation.
201
202 item->Move( aRef );
203 BOOST_CHECK_EQUAL( item->GetPosition(), originalPos + aRef );
204
205 item->Move( -aRef );
206 CompareItems( item.get(), aOriginalItem );
207 } );
208 }
209 }
210}
211
212
214{
215 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
216 {
217 KICAD_T type = static_cast<KICAD_T>( i );
218
219 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
220
221 if( item == nullptr )
222 continue;
223
224 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
225 {
226 // Four same 90 degree rotations are an identity.
227
228 IterateOverPositionsAndReferences<BOARD_ITEM>(
229 item.get(),
230 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
231 {
232 // FIXME: Update() has to be called after SetPosition() to update dimension
233 // shapes.
234 PCB_DIMENSION_BASE* originalDimension =
235 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
236
237 if( originalDimension != nullptr )
238 originalDimension->Update();
239
240 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate( IGNORE_PARENT_GROUP ) );
241
242 // Four equivalent 90 degree rotations are an identity.
243
244 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
245 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
246 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
247 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
248
249 CompareItems( item.get(), aOriginalItem );
250 } );
251 }
252 }
253}
254
255
256BOOST_AUTO_TEST_CASE( FlipLeftRight )
257{
258 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
259 {
260 KICAD_T type = static_cast<KICAD_T>( i );
261
262 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
263
264 if( item == nullptr )
265 continue;
266
267 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
268 {
269 IterateOverPositionsAndReferences<BOARD_ITEM>(
270 item.get(),
271 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
272 {
273 // FIXME: Update() has to be called after SetPosition() to update dimension
274 // shapes.
275 PCB_DIMENSION_BASE* originalDimension =
276 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
277
278 if( originalDimension != nullptr )
279 originalDimension->Update();
280
281 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate( IGNORE_PARENT_GROUP ) );
282
283 // Two equivalent flips are an identity.
284
285 item->Flip( aRef, FLIP_DIRECTION::LEFT_RIGHT );
286 item->Flip( aRef, FLIP_DIRECTION::LEFT_RIGHT );
287
288 CompareItems( item.get(), aOriginalItem );
289 } );
290 }
291 }
292}
293
294
296{
297 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
298 {
299 KICAD_T type = static_cast<KICAD_T>( i );
300
301 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
302
303 if( item == nullptr )
304 continue;
305
306 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
307 {
308 IterateOverPositionsAndReferences<BOARD_ITEM>(
309 item.get(),
310 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
311 {
312 // FIXME: Update() has to be called after SetPosition() to update dimension
313 // shapes.
314 PCB_DIMENSION_BASE* originalDimension =
315 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
316
317 if( originalDimension != nullptr )
318 originalDimension->Update();
319
320 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate( IGNORE_PARENT_GROUP ) );
321
322 // Two equivalent flips are an identity.
323
324 item->Flip( aRef, FLIP_DIRECTION::TOP_BOTTOM );
325 item->Flip( aRef, FLIP_DIRECTION::TOP_BOTTOM );
326
327 CompareItems( item.get(), aOriginalItem );
328 } );
329 }
330 }
331}
332
333
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:112
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:317
constexpr coord_type GetLeft() const
Definition: box2.h:228
constexpr coord_type GetRight() const
Definition: box2.h:217
constexpr coord_type GetTop() const
Definition: box2.h:229
constexpr coord_type GetBottom() const
Definition: box2.h:222
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:272
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:110
virtual void SetParentGroup(EDA_GROUP *aGroup)
Definition: eda_item.h:115
void SetRectangleHeight(const int &aHeight)
Definition: eda_shape.cpp:450
void SetRectangleWidth(const int &aWidth)
Definition: eda_shape.cpp:465
Definition: pad.h:54
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:53
Object to handle a bitmap image that can be inserted in a PCB.
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:74
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:1134
@ DRCE_MALFORMED_COURTYARD
Definition: drc_item.h:67
Class to handle a set of BOARD_ITEMs.
constexpr int mmToIU(double mm) const
Definition: base_units.h:92
BOOST_AUTO_TEST_CASE(Move)
BOOST_CHECK_EQUAL(ret, c.m_exp_result)
BOOST_AUTO_TEST_SUITE_END()
BOOST_TEST_CONTEXT("Test Clearance")
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:239
@ 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_BOARD_OUTLINE_T
class PCB_BOARD_OUTLINE_T, a pcb board outline item
Definition: typeinfo.h:111
@ 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:424
constexpr bool IsInstantiableType(const KICAD_T aType)
Definition: typeinfo.h:310
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:695