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 (C) 2017-2022 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_group.h>
33
34
42static void TransformItem( const ARRAY_OPTIONS& aArrOpts, int aIndex, BOARD_ITEM& aItem )
43{
44 const ARRAY_OPTIONS::TRANSFORM transform = aArrOpts.GetTransform( aIndex, aItem.GetPosition() );
45
46 aItem.Move( transform.m_offset );
47 aItem.Rotate( aItem.GetPosition(), transform.m_rotation );
48}
49
50
52{
53}
54
55
57{
58}
59
60
62{
63}
64
65
67{
68 return true;
69}
70
71
73{
75
76 // Be sure that there is at least one item that we can modify
77 const PCB_SELECTION& selection = selectionTool->RequestSelection(
78 []( const VECTOR2I&, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
79 {
80 sTool->FilterCollectorForMarkers( aCollector );
81 sTool->FilterCollectorForHierarchy( aCollector, true );
82 } );
83
84 if( selection.Empty() )
85 return 0;
86
87 m_selection = std::make_unique<PCB_SELECTION>( selection );
88
89 // we have a selection to work on now, so start the tool process
90 PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>();
91
92 const bool enableArrayNumbering = m_isFootprintEditor;
93 VECTOR2I origin;
94
95 if( m_selection->Size() == 1 )
96 origin = m_selection->Items()[0]->GetPosition();
97 else
98 origin = m_selection->GetCenter();
99
100 m_array_opts.reset();
101 m_dialog = new DIALOG_CREATE_ARRAY( editFrame, m_array_opts, enableArrayNumbering, origin );
102
103 m_dialog->Bind( wxEVT_CLOSE_WINDOW, &ARRAY_TOOL::onDialogClosed, this );
104
105 // Show the dialog, but it's not modal - the user might ask to select a point, in which case
106 // we'll exit and do to that.
107 m_dialog->Show( true );
108
109 return 0;
110}
111
112void ARRAY_TOOL::onDialogClosed( wxCloseEvent& aEvent )
113{
114 // Now that the dialog has served it's purpose, we can get rid of it
115 m_dialog->Destroy();
116
117 // This means the dialog failed somehow
118 if( m_array_opts == nullptr )
119 return;
120
121 wxCHECK( m_selection, /* void */ );
122
124
125 PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>();
126
127 BOARD_COMMIT commit( editFrame );
128
129 FOOTPRINT* const fp =
130 m_isFootprintEditor ? editFrame->GetBoard()->GetFirstFootprint() : nullptr;
131
132 ARRAY_PAD_NUMBER_PROVIDER pad_number_provider( fp, *m_array_opts );
133
134 EDA_ITEMS all_added_items;
135
136 int arraySize = m_array_opts->GetArraySize();
137 // Iterate in reverse so the original items go last, and we can
138 // use them for the positions of the clones.
139 for( int ptN = arraySize - 1; ptN >= 0; --ptN )
140 {
141 PCB_SELECTION items_for_this_block;
142 std::set<FOOTPRINT*> fpDeDupe;
143
144 for( int i = 0; i < m_selection->Size(); ++i )
145 {
146 if( !selection[i]->IsBOARD_ITEM() )
147 continue;
148
149 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( selection[i] );
150
151 FOOTPRINT* parentFootprint = item->GetParentFootprint();
152
153 // If it is not the footprint editor, then duplicate the parent footprint instead.
154 // This check assumes that the footprint child objects are correctly parented, if
155 // they are not, this will segfault.
156 if( !m_isFootprintEditor && parentFootprint )
157 {
158 // It is possible to select multiple footprint child objects in the board editor.
159 // Do not create multiple copies of the same footprint when this occurs.
160 if( fpDeDupe.count( parentFootprint ) == 0 )
161 {
162 fpDeDupe.emplace( parentFootprint );
163 item = parentFootprint;
164 }
165 else
166 {
167 continue;
168 }
169 }
170
171 BOARD_ITEM* this_item = nullptr;
172
173 if( ptN == 0 )
174 {
175 // the first point: we don't own this or add it, but
176 // we might still modify it (position or label)
177 this_item = item;
178
179 commit.Modify( this_item );
180
181 TransformItem( *m_array_opts, arraySize - 1, *this_item );
182 }
183 else
184 {
186 {
187 // Fields cannot be duplicated, especially mandatory fields.
188 // A given field is unique for the footprint
189 if( item->Type() == PCB_FIELD_T )
190 continue;
191
192 // Don't bother incrementing pads: the footprint won't update until commit,
193 // so we can only do this once
194 this_item = fp->DuplicateItem( item );
195 }
196 else
197 {
198 switch( item->Type() )
199 {
200 case PCB_FOOTPRINT_T:
201 case PCB_SHAPE_T:
203 case PCB_GENERATOR_T:
204 case PCB_TEXT_T:
205 case PCB_TEXTBOX_T:
206 case PCB_TABLE_T:
207 case PCB_TRACE_T:
208 case PCB_ARC_T:
209 case PCB_VIA_T:
211 case PCB_DIM_CENTER_T:
212 case PCB_DIM_RADIAL_T:
214 case PCB_DIM_LEADER_T:
215 case PCB_TARGET_T:
216 case PCB_ZONE_T: this_item = item->Duplicate(); break;
217
218 case PCB_GROUP_T:
219 this_item = static_cast<PCB_GROUP*>( item )->DeepDuplicate();
220 break;
221
222 default:
223 // Silently drop other items (such as footprint texts) from duplication
224 break;
225 }
226 }
227
228 // Add new items to selection (footprints in the selection will be reannotated)
229 items_for_this_block.Add( this_item );
230
231 if( this_item )
232 {
233 // Because aItem is/can be created from a selected item, and inherits from
234 // it this state, reset the selected stated of aItem:
235 this_item->ClearSelected();
236
237 this_item->RunOnDescendants(
238 []( BOARD_ITEM* aItem )
239 {
240 aItem->ClearSelected();
241 } );
242
243 // We're iterating backwards, so the first item is the last in the array
244 TransformItem( *m_array_opts, arraySize - ptN - 1, *this_item );
245
246 // If a group is duplicated, add also created members to the board
247 if( this_item->Type() == PCB_GROUP_T )
248 {
249 this_item->RunOnDescendants(
250 [&]( BOARD_ITEM* aItem )
251 {
252 commit.Add( aItem );
253 } );
254 }
255
256 commit.Add( this_item );
257 }
258 }
259
260 // attempt to renumber items if the array parameters define
261 // a complete numbering scheme to number by (as opposed to
262 // implicit numbering by incrementing the items during creation
263 if( this_item && m_array_opts->ShouldNumberItems() )
264 {
265 // Renumber non-aperture pads.
266 if( this_item->Type() == PCB_PAD_T )
267 {
268 PAD& pad = static_cast<PAD&>( *this_item );
269
270 if( pad.CanHaveNumber() )
271 {
272 wxString newNumber = pad_number_provider.GetNextPadNumber();
273 pad.SetNumber( newNumber );
274 }
275 }
276 }
277 }
278
279 if( !m_isFootprintEditor && m_array_opts->ShouldReannotateFootprints() )
280 {
281 m_toolMgr->GetTool<BOARD_REANNOTATE_TOOL>()->ReannotateDuplicates( items_for_this_block,
282 all_added_items );
283 }
284
285 for( EDA_ITEM* item : items_for_this_block )
286 all_added_items.push_back( item );
287 }
288
291
292 commit.Push( _( "Create Array" ) );
293
294 m_selection.reset();
295}
296
297
299{
300 // clang-format off
302 // clang-format on
303}
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.
Definition: array_tool.cpp:42
Options that govern the setup of an "array" of multiple item.
Definition: array_options.h:38
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)
Definition: array_tool.cpp:112
int CreateArray(const TOOL_EVENT &aEvent)
Invoke a dialog box to allow positioning of the item relative to another by an exact amount.
Definition: array_tool.cpp:72
bool Init() override
Init() is called once upon a registration of the tool.
Definition: array_tool.cpp:66
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...
Definition: array_tool.cpp:298
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
Definition: array_tool.cpp:61
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
virtual void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle)
Rotate this object.
Definition: board_item.cpp:355
virtual BOARD_ITEM * Duplicate() const
Create a copy of this BOARD_ITEM.
Definition: board_item.cpp:243
virtual void Move(const VECTOR2I &aMoveVector)
Move this object.
Definition: board_item.h:342
FOOTPRINT * GetParentFootprint() const
Definition: board_item.cpp:298
virtual void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction, int aDepth=0) const
Invoke a function on all descendants.
Definition: board_item.h:212
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:448
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Create an undo entry for an item that has been already modified.
Definition: commit.h:105
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
Definition: commit.h:80
bool Show(bool show) override
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:243
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
void ClearSelected()
Definition: eda_item.h:122
BOARD_ITEM * DuplicateItem(const BOARD_ITEM *aItem, bool aAddToFootprint=false)
Duplicate a given item within the footprint, optionally adding it to the board.
Definition: footprint.cpp:2496
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:202
Definition: pad.h:54
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:68
static TOOL_ACTION selectItems
Select a list of items (specified as the event parameter)
Definition: pcb_actions.h:76
static TOOL_ACTION createArray
Tool for creating an array of objects.
Definition: pcb_actions.h:493
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:52
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, bool aConfirmLockedItems=false)
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.
bool m_isFootprintEditor
const PCB_SELECTION & selection() const
virtual void Add(EDA_ITEM *aItem)
Definition: selection.cpp:42
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:110
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:218
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:167
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).
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
Definition: tool_manager.h:150
#define _(s)
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: eda_item.h:536
Class to handle a set of BOARD_ITEMs.
Transform applied to an object by this array.
Definition: array_options.h:60
@ 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_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