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_point.h>
45#include <pcb_target.h>
46#include <pcb_group.h>
47#include <pcb_board_outline.h>
48
50{
51public:
54 std::shared_ptr<DRC_ITEM> m_drcItem;
56
64
66 {
67 m_text.SetParentGroup( nullptr );
68 }
69
71 {
72 if( !IsPcbnewType( aType ) )
73 return nullptr;
74
75 if( !IsInstantiableType( aType ) )
76 return nullptr;
77
78 switch( aType )
79 {
80 case PCB_FOOTPRINT_T: return new FOOTPRINT( &m_board );
81 case PCB_PAD_T: return new PAD( &m_footprint );
82 case PCB_FIELD_T: return new PCB_FIELD( &m_footprint, FIELD_T::USER );
83 case PCB_SHAPE_T: return new PCB_SHAPE( &m_board );
84 case PCB_TEXT_T: return new PCB_TEXT( &m_board );
85 case PCB_TEXTBOX_T: return new PCB_TEXTBOX( &m_board );
86 case PCB_TABLECELL_T: return new PCB_TABLECELL( &m_board );
87 case PCB_TABLE_T:
88 {
89 PCB_TABLE* table = new PCB_TABLE( &m_board, pcbIUScale.mmToIU( 0.1 ) );
90
91 table->SetColCount( 2 );
92
93 for( int ii = 0; ii < 4; ++ii )
94 {
95 PCB_TABLECELL* cell = new PCB_TABLECELL( &m_board );
96 cell->SetRectangleHeight( 0 );
97 cell->SetRectangleWidth( 0 );
98 table->InsertCell( ii, cell );
99 }
100
101 return table;
102 }
103
105 case PCB_TRACE_T: return new PCB_TRACK( &m_board );
106 case PCB_VIA_T: return new PCB_VIA( &m_board );
107 case PCB_ARC_T: return new PCB_ARC( &m_board );
108 case PCB_MARKER_T: return new PCB_MARKER( m_drcItem, VECTOR2I( 0, 0 ) );
110 case PCB_DIM_LEADER_T: return new PCB_DIM_LEADER( &m_board );
111 case PCB_DIM_CENTER_T: return new PCB_DIM_CENTER( &m_board );
112 case PCB_DIM_RADIAL_T: return new PCB_DIM_RADIAL( &m_board );
114 case PCB_TARGET_T: return new PCB_TARGET( &m_board );
115 case PCB_POINT_T: return new PCB_POINT( &m_board );
116
117 case PCB_ZONE_T:
118 {
119 ZONE* zone = new ZONE( &m_board );
120
121 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( -100 ), pcbIUScale.mmToIU( -50 ) ), -1 );
122 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( -100 ), pcbIUScale.mmToIU( 50 ) ), -1 );
123 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( 100 ), pcbIUScale.mmToIU( 50 ) ), -1 );
124 zone->AppendCorner( VECTOR2I( pcbIUScale.mmToIU( 100 ), pcbIUScale.mmToIU( -50 ) ), -1 );
125
126 return zone;
127 }
128
129 case PCB_GROUP_T:
130 {
131 PCB_GROUP* group = new PCB_GROUP( &m_board );
132
133 // Group position only makes sense if there's at least one item in the group.
134 group->AddItem( &m_text );
135
136 return group;
137 }
138
139 case PCB_T:
140 case PCB_ITEM_LIST_T:
141 case PCB_NETINFO_T:
142 case PCB_GENERATOR_T:
144 return nullptr;
145
146 default:
147 BOOST_FAIL( wxString::Format(
148 "Unhandled type: %d "
149 "(if you created a new type you need to handle it in this switch statement)",
150 aType ) );
151 return nullptr;
152 }
153 }
154
155 static void CompareItems( BOARD_ITEM* aItem, BOARD_ITEM* aOriginalItem )
156 {
157 BOOST_CHECK_EQUAL( aItem->GetPosition(), aOriginalItem->GetPosition() );
159 aOriginalItem->GetBoundingBox().GetTop() );
161 aOriginalItem->GetBoundingBox().GetLeft() );
163 aOriginalItem->GetBoundingBox().GetBottom() );
165 aOriginalItem->GetBoundingBox().GetRight() );
166 }
167};
168
169
170BOOST_FIXTURE_TEST_SUITE( PcbItem, TEST_BOARD_ITEM_FIXTURE )
171
172
174{
175 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
176 {
177 KICAD_T type = static_cast<KICAD_T>( i );
178
179 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
180
181 if( item == nullptr )
182 continue;
183
184 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
185 {
187 item.get(),
188 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
189 {
190 // FIXME: Update() has to be called after SetPosition() to update dimension
191 // shapes.
192 PCB_DIMENSION_BASE* originalDimension =
193 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
194
195 if( originalDimension != nullptr )
196 originalDimension->Update();
197
198 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate( IGNORE_PARENT_GROUP ) );
199 VECTOR2I originalPos = item->GetPosition();
200
201 // Move to a point, then go back.
202 // This has to be an identity transformation.
203
204 item->Move( aRef );
205 BOOST_CHECK_EQUAL( item->GetPosition(), originalPos + aRef );
206
207 item->Move( -aRef );
208 CompareItems( item.get(), aOriginalItem );
209 } );
210 }
211 }
212}
213
214
216{
217 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
218 {
219 KICAD_T type = static_cast<KICAD_T>( i );
220
221 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
222
223 if( item == nullptr )
224 continue;
225
226 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
227 {
228 // Four same 90 degree rotations are an identity.
229
231 item.get(),
232 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
233 {
234 // FIXME: Update() has to be called after SetPosition() to update dimension
235 // shapes.
236 PCB_DIMENSION_BASE* originalDimension =
237 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
238
239 if( originalDimension != nullptr )
240 originalDimension->Update();
241
242 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate( IGNORE_PARENT_GROUP ) );
243
244 // Four equivalent 90 degree rotations are an identity.
245
246 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
247 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
248 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
249 item->Rotate( aRef, EDA_ANGLE( 90.0, DEGREES_T ) );
250
251 CompareItems( item.get(), aOriginalItem );
252 } );
253 }
254 }
255}
256
257
258BOOST_AUTO_TEST_CASE( FlipLeftRight )
259{
260 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
261 {
262 KICAD_T type = static_cast<KICAD_T>( i );
263
264 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
265
266 if( item == nullptr )
267 continue;
268
269 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
270 {
272 item.get(),
273 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
274 {
275 // FIXME: Update() has to be called after SetPosition() to update dimension
276 // shapes.
277 PCB_DIMENSION_BASE* originalDimension =
278 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
279
280 if( originalDimension != nullptr )
281 originalDimension->Update();
282
283 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate( IGNORE_PARENT_GROUP ) );
284
285 // Two equivalent flips are an identity.
286
287 item->Flip( aRef, FLIP_DIRECTION::LEFT_RIGHT );
288 item->Flip( aRef, FLIP_DIRECTION::LEFT_RIGHT );
289
290 CompareItems( item.get(), aOriginalItem );
291 } );
292 }
293 }
294}
295
296
298{
299 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
300 {
301 KICAD_T type = static_cast<KICAD_T>( i );
302
303 auto item = std::unique_ptr<BOARD_ITEM>( Instantiate( type ) );
304
305 if( item == nullptr )
306 continue;
307
308 BOOST_TEST_CONTEXT( "Class: " << item->GetClass() )
309 {
311 item.get(),
312 []( BOARD_ITEM* aOriginalItem, VECTOR2I aRef )
313 {
314 // FIXME: Update() has to be called after SetPosition() to update dimension
315 // shapes.
316 PCB_DIMENSION_BASE* originalDimension =
317 dynamic_cast<PCB_DIMENSION_BASE*>( aOriginalItem );
318
319 if( originalDimension != nullptr )
320 originalDimension->Update();
321
322 auto item = std::unique_ptr<BOARD_ITEM>( aOriginalItem->Duplicate( IGNORE_PARENT_GROUP ) );
323
324 // Two equivalent flips are an identity.
325
326 item->Flip( aRef, FLIP_DIRECTION::TOP_BOTTOM );
327 item->Flip( aRef, FLIP_DIRECTION::TOP_BOTTOM );
328
329 CompareItems( item.get(), aOriginalItem );
330 } );
331 }
332 }
333}
334
335
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
void SetRectangleHeight(const int &aHeight)
void SetRectangleWidth(const int &aWidth)
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
A PCB_POINT is a 0-dimensional point that is used to mark a position on a PCB, or more usually a foot...
Definition pcb_point.h:43
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
static void IterateOverPositionsAndReferences(T *aItem, void(*aCallback)(T *, VECTOR2I))
Class to handle a set of BOARD_ITEMs.
@ USER
The field ID hasn't been set yet; field is invalid.
BOOST_AUTO_TEST_CASE(HorizontalAlignment)
BOOST_AUTO_TEST_CASE(Move)
BOOST_AUTO_TEST_SUITE_END()
BOOST_TEST_CONTEXT("Test Clearance")
BOOST_CHECK_EQUAL(result, "25.4")
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:240
@ 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_POINT_T
class PCB_POINT, a 0-dimensional point
Definition typeinfo.h:112
@ 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:425
constexpr bool IsInstantiableType(const KICAD_T aType)
Definition typeinfo.h:311
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695