KiCad PCB EDA Suite
Loading...
Searching...
No Matches
array_tool.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
24#include "tools/array_tool.h"
25
26#include <array_options.h>
29#include <pad.h>
30#include <pcb_generator.h>
31#include <pcb_group.h>
34
35
43static void TransformItem( const ARRAY_OPTIONS& aArrOpts, int aIndex, BOARD_ITEM& aItem )
44{
45 const ARRAY_OPTIONS::TRANSFORM transform = aArrOpts.GetTransform( aIndex, aItem.GetPosition() );
46
47 aItem.Move( transform.m_offset );
48 aItem.Rotate( aItem.GetPosition(), transform.m_rotation );
49}
50
51
53 m_dialog( nullptr )
54{
55}
56
57
61
62
64{
65}
66
67
69{
70 return true;
71}
72
73
75{
76 PCB_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
77
78 // Be sure that there is at least one item that we can modify
79 const PCB_SELECTION& selection = selectionTool->RequestSelection(
80 []( const VECTOR2I&, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
81 {
82 sTool->FilterCollectorForMarkers( aCollector );
83 sTool->FilterCollectorForHierarchy( aCollector, true );
84 } );
85
86 if( selection.Empty() )
87 return 0;
88
89 m_selection = std::make_unique<PCB_SELECTION>( selection );
90
91 // we have a selection to work on now, so start the tool process
93
94 const bool enableArrayNumbering = m_isFootprintEditor;
95 VECTOR2I origin;
96
97 if( m_selection->Size() == 1 )
98 origin = m_selection->Items()[0]->GetPosition();
99 else
100 origin = m_selection->GetCenter();
101
102 m_array_opts.reset();
103 m_dialog = new DIALOG_CREATE_ARRAY( editFrame, m_array_opts, enableArrayNumbering, origin );
104
105 m_dialog->Bind( wxEVT_CLOSE_WINDOW, &ARRAY_TOOL::onDialogClosed, this );
106
107 // Show the dialog, but it's not modal - the user might ask to select a point, in which case
108 // we'll exit and do to that.
109 m_dialog->Show( true );
110
111 return 0;
112}
113
114void ARRAY_TOOL::onDialogClosed( wxCloseEvent& aEvent )
115{
116 // Now that the dialog has served it's purpose, we can get rid of it
117 m_dialog->Destroy();
118
119 // This means the dialog failed somehow
120 if( m_array_opts == nullptr )
121 return;
122
123 wxCHECK( m_selection, /* void */ );
124
127 BOARD_COMMIT commit( editFrame );
128
129 const int arraySize = m_array_opts->GetArraySize();
130
131 if( m_array_opts->ShouldArrangeSelection() )
132 {
133 std::set<FOOTPRINT*> fpDeDupe;
134
135 EDA_ITEMS sortedSelection = selection.GetItemsSortedBySelectionOrder();
136 int selectionIndex = 0;
137
138 BOARD_ITEM* firstItem = nullptr;
139
140 for( int arrayIndex = 0; arrayIndex < arraySize; ++arrayIndex )
141 {
142 BOARD_ITEM* item = nullptr;
143
144 // Get the next valid item to arrange
145 for( ; selectionIndex < (int) sortedSelection.size(); selectionIndex++ )
146 {
147 item = nullptr;
148
149 if( !sortedSelection[selectionIndex]->IsBOARD_ITEM() )
150 continue;
151
152 item = static_cast<BOARD_ITEM*>( sortedSelection[selectionIndex] );
153
154 FOOTPRINT* parentFootprint = item->GetParentFootprint();
155
156 // If it is not the footprint editor, then move the parent footprint instead.
157 if( !m_isFootprintEditor && parentFootprint )
158 {
159 // It is possible to select multiple footprint child objects in the board editor.
160 // Do not create multiple copies of the same footprint when this occurs.
161 if( fpDeDupe.count( parentFootprint ) == 0 )
162 {
163 fpDeDupe.emplace( parentFootprint );
164 item = parentFootprint;
165 }
166 else
167 {
168 item = nullptr;
169 continue;
170 }
171 }
172
173 // Found a valid item
174 selectionIndex++;
175 break;
176 }
177
178 // Must be out of items to arrange, we're done
179 if( item == nullptr )
180 break;
181
182 commit.Modify( item, nullptr, RECURSE_MODE::RECURSE );
183
184 // Transform is a relative move, so when arranging the transform needs to start from
185 // the same point for each item, e.g. the first item's position
186 if( firstItem == nullptr )
187 firstItem = item;
188 else
189 item->SetPosition( firstItem->GetPosition() );
190
191 TransformItem( *m_array_opts, arrayIndex, *item );
192 }
193
194 // Make sure we did something...
195 if( firstItem != nullptr )
196 commit.Push( _( "Arrange selection" ) );
197
198 return;
199 }
200
201 FOOTPRINT* const fp = m_isFootprintEditor ? editFrame->GetBoard()->GetFirstFootprint()
202 : nullptr;
203
204 // Collect a list of pad numbers that will _not_ be counted as "used"
205 // when finding the next pad numbers.
206 // Things that are selected are fair game, as they'll give up their numbers.
207 // Keeps numbers used by both selected and unselected pads as "reserved".
208 std::set<wxString> unchangingPadNumbers;
209 if( fp )
210 {
211 for( PAD* pad : fp->Pads() )
212 {
213 if( !pad->IsSelected() )
214 unchangingPadNumbers.insert( pad->GetNumber() );
215 }
216 }
217
218 ARRAY_PAD_NUMBER_PROVIDER pad_number_provider( unchangingPadNumbers, *m_array_opts );
219
220 const bool will_reannotate = !m_isFootprintEditor && m_array_opts->ShouldReannotateFootprints();
221 EDA_ITEMS all_added_items;
222
223 // Iterate in reverse so the original items go last, and we can
224 // use them for the positions of the clones.
225 for( int ptN = arraySize - 1; ptN >= 0; --ptN )
226 {
227 PCB_SELECTION items_for_this_block;
228 std::set<FOOTPRINT*> fpDeDupe;
229
230 for( EDA_ITEM* eda_item : selection )
231
232 {
233 if( !eda_item->IsBOARD_ITEM() )
234 continue;
235
236 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( eda_item );
237
238 FOOTPRINT* parentFootprint = item->GetParentFootprint();
239
240 // If it is not the footprint editor, then duplicate the parent footprint instead.
241 // This check assumes that the footprint child objects are correctly parented, if
242 // they are not, this will segfault.
243 if( !m_isFootprintEditor && parentFootprint )
244 {
245 // It is possible to select multiple footprint child objects in the board editor.
246 // Do not create multiple copies of the same footprint when this occurs.
247 if( fpDeDupe.count( parentFootprint ) == 0 )
248 {
249 fpDeDupe.emplace( parentFootprint );
250 item = parentFootprint;
251 }
252 else
253 {
254 continue;
255 }
256 }
257
258 BOARD_ITEM* this_item = nullptr;
259
260 if( ptN == 0 )
261 {
262 // the first point: we don't own this or add it, but
263 // we might still modify it (position or label)
264 this_item = item;
265
266 commit.Modify( this_item, nullptr, RECURSE_MODE::RECURSE );
267
268 TransformItem( *m_array_opts, arraySize - 1, *this_item );
269 }
270 else
271 {
273 {
274 // Fields cannot be duplicated, especially mandatory fields.
275 // A given field is unique for the footprint
276 if( item->Type() == PCB_FIELD_T )
277 continue;
278
279 // Don't bother incrementing pads: the footprint won't update until commit,
280 // so we can only do this once
281 this_item = fp->DuplicateItem( true, &commit, item );
282 }
283 else
284 {
285 switch( item->Type() )
286 {
287 case PCB_FOOTPRINT_T:
288 case PCB_SHAPE_T:
290 case PCB_TEXT_T:
291 case PCB_TEXTBOX_T:
292 case PCB_TABLE_T:
293 case PCB_TRACE_T:
294 case PCB_ARC_T:
295 case PCB_VIA_T:
297 case PCB_DIM_CENTER_T:
298 case PCB_DIM_RADIAL_T:
300 case PCB_DIM_LEADER_T:
301 case PCB_POINT_T:
302 case PCB_TARGET_T:
303 case PCB_ZONE_T:
304 this_item = item->Duplicate( true, &commit );
305 break;
306
307 case PCB_GENERATOR_T:
308 this_item = static_cast<PCB_GENERATOR*>( item )->DeepClone();
309 break;
310
311 case PCB_GROUP_T:
312 this_item = static_cast<PCB_GROUP*>( item )->DeepDuplicate( true, &commit );
313 break;
314
315 default:
316 // Silently drop other items (such as footprint texts) from duplication
317 break;
318 }
319 }
320
321 if( this_item )
322 {
323 // Because aItem is/can be created from a selected item, and inherits from
324 // it this state, reset the selected stated of aItem:
325 this_item->ClearSelected();
326
327 this_item->RunOnChildren(
328 []( BOARD_ITEM* aItem )
329 {
330 aItem->ClearSelected();
331 },
333
334 // We're iterating backwards, so the first item is the last in the array
335 TransformItem( *m_array_opts, arraySize - ptN - 1, *this_item );
336
337 // If a group is duplicated, add also created members to the board
338 if( this_item->Type() == PCB_GROUP_T ||
339 this_item->Type() == PCB_GENERATOR_T )
340 {
341 this_item->RunOnChildren(
342 [&]( BOARD_ITEM* aItem )
343 {
344 commit.Add( aItem );
345 },
347 }
348
349 commit.Add( this_item );
350 }
351 }
352
353 // Add new items to selection (footprints in the selection will be reannotated)
354 if( this_item )
355 items_for_this_block.Add( this_item );
356
357 // attempt to renumber items if the array parameters define
358 // a complete numbering scheme to number by (as opposed to
359 // implicit numbering by incrementing the items during creation
360 if( this_item && m_array_opts->ShouldNumberItems() )
361 {
362 // Renumber non-aperture pads.
363 if( this_item->Type() == PCB_PAD_T )
364 {
365 PAD& pad = static_cast<PAD&>( *this_item );
366
367 if( pad.CanHaveNumber() )
368 {
369 wxString newNumber = pad_number_provider.GetNextPadNumber();
370 pad.SetNumber( newNumber );
371 }
372 }
373 }
374 }
375
376 // Do not reannotate the first item, or it will skip its own numbering and
377 // the array annotations will shift by one cell.
378 if( will_reannotate && ptN != arraySize - 1 )
379 {
380 m_toolMgr->GetTool<BOARD_REANNOTATE_TOOL>()->ReannotateDuplicates( items_for_this_block,
381 all_added_items );
382 }
383
384 for( EDA_ITEM* item : items_for_this_block )
385 all_added_items.push_back( item );
386 }
387
388 // Make sure original items are selected (e.g. interactive point select may clear it)
389 for( EDA_ITEM* eda_item : selection )
390 {
391 all_added_items.push_back( eda_item );
392 }
393
395 m_toolMgr->RunAction<EDA_ITEMS*>( ACTIONS::selectItems, &all_added_items );
396
397 commit.Push( _( "Create Array" ) );
398
399 m_selection.reset();
400}
401
402
404{
405 // clang-format off
407 // clang-format on
408}
static void TransformItem(const ARRAY_OPTIONS &aArrOpts, int aIndex, BOARD_ITEM &aItem)
Transform a BOARD_ITEM from the given ARRAY_OPTIONS and an index into the array.
static TOOL_ACTION selectionClear
Clear the current selection.
Definition actions.h:223
static TOOL_ACTION selectItems
Select a list of items (specified as the event parameter)
Definition actions.h:231
Options that govern the setup of an "array" of multiple item.
virtual TRANSFORM GetTransform(int aN, const VECTOR2I &aPos) const =0
Get the transform of the n-th point in the array.
Simple class that sequentially provides numbers from an ARRAY_OPTIONS object, making sure that they d...
wxString GetNextPadNumber()
Get the next available pad name.
void onDialogClosed(wxCloseEvent &aEvent)
int CreateArray(const TOOL_EVENT &aEvent)
Invoke a dialog box to allow positioning of the item relative to another by an exact amount.
bool Init() override
Init() is called once upon a registration of the tool.
std::unique_ptr< ARRAY_OPTIONS > m_array_opts
Definition array_tool.h:76
DIALOG_CREATE_ARRAY * m_dialog
Definition array_tool.h:75
std::unique_ptr< PCB_SELECTION > m_selection
Definition array_tool.h:77
void setTransitions() override
Position the m_position_relative_selection selection relative to anchor position using the given tran...
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Execute the changes.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:79
virtual BOARD_ITEM * Duplicate(bool addToParentGroup, BOARD_COMMIT *aCommit=nullptr) const
Create a copy of this BOARD_ITEM.
virtual void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle)
Rotate this object.
virtual void Move(const VECTOR2I &aMoveVector)
Move this object.
Definition board_item.h:339
FOOTPRINT * GetParentFootprint() const
virtual void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction, RECURSE_MODE aMode) const
Invoke a function on all children.
Definition board_item.h:208
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition board.h:488
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
Definition commit.h:106
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Add a new item to the model.
Definition commit.h:78
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
virtual VECTOR2I GetPosition() const
Definition eda_item.h:272
virtual void SetPosition(const VECTOR2I &aPos)
Definition eda_item.h:273
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
void ClearSelected()
Definition eda_item.h:137
std::deque< PAD * > & Pads()
Definition footprint.h:224
BOARD_ITEM * DuplicateItem(bool addToParentGroup, BOARD_COMMIT *aCommit, const BOARD_ITEM *aItem, bool addToFootprint=false)
Duplicate a given item within the footprint, optionally adding it to the board.
Used when the right click button is pressed, or when the select tool is in effect.
Definition collectors.h:207
Definition pad.h:54
static TOOL_ACTION createArray
Tool for creating an array of objects.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
BOARD * GetBoard() const
A set of BOARD_ITEMs (i.e., without duplicates).
Definition pcb_group.h:53
The selection tool: currently supports:
void FilterCollectorForMarkers(GENERAL_COLLECTOR &aCollector) const
Drop any PCB_MARKERs from the collector.
PCB_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter)
Return the current selection, filtered according to aClientFilter.
void FilterCollectorForHierarchy(GENERAL_COLLECTOR &aCollector, bool aMultiselect) const
In general we don't want to select both a parent and any of it's children.
PCB_TOOL_BASE(TOOL_ID aId, const std::string &aName)
Constructor.
const PCB_SELECTION & selection() const
virtual void Add(EDA_ITEM *aItem)
Definition selection.cpp:42
T * getEditFrame() const
Return the application window object, casted to requested user type.
Definition tool_base.h:186
TOOL_MANAGER * m_toolMgr
Definition tool_base.h:220
RESET_REASON
Determine the reason of reset for a tool.
Definition tool_base.h:78
Generic, UI-independent tool event.
Definition tool_event.h:171
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Define which state (aStateFunc) to go when a certain event arrives (aConditions).
#define _(s)
@ RECURSE
Definition eda_item.h:51
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition eda_item.h:566
Class to handle a set of BOARD_ITEMs.
Transform applied to an object by this array.
@ 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
@ 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_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition typeinfo.h:90
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition typeinfo.h:106
@ 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_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
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695