KiCad PCB EDA Suite
array_creator.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  * Created on: 11 Mar 2016, author John Beard
5  * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #include "array_creator.h"
26 
28 #include <board_commit.h>
29 #include <pcb_group.h>
30 #include <pad.h>
32 #include <tool/tool_manager.h>
35 
43 static 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( (wxPoint) transform.m_offset );
48  aItem.Rotate( aItem.GetPosition(), transform.m_rotation * 10 );
49 }
50 
51 
53 {
54  // bail out if no items
55  if( m_selection.Size() == 0 )
56  return;
57 
59 
60  const bool enableArrayNumbering = m_isFootprintEditor;
61  const wxPoint rotPoint = (wxPoint) m_selection.GetCenter();
62 
63  std::unique_ptr<ARRAY_OPTIONS> array_opts;
64 
65  DIALOG_CREATE_ARRAY dialog( &m_parent, array_opts, enableArrayNumbering, rotPoint );
66 
67  int ret = dialog.ShowModal();
68 
69  if( ret != wxID_OK || array_opts == nullptr )
70  return;
71 
72  BOARD_COMMIT commit( &m_parent );
73 
74  ARRAY_PAD_NUMBER_PROVIDER pad_number_provider( fp, *array_opts );
75 
76  std::vector<EDA_ITEM*> all_added_items;
77 
78  // The first item in list is the original item. We do not modify it
79  for( int ptN = 0; ptN < array_opts->GetArraySize(); ptN++ )
80  {
81  PCB_SELECTION items_for_this_block;
82 
83  for ( int i = 0; i < m_selection.Size(); ++i )
84  {
85  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( m_selection[ i ] );
86 
87  if( item->Type() == PCB_PAD_T && !m_isFootprintEditor )
88  {
89  // If it is not the footprint editor, then duplicate the parent footprint instead
90  item = static_cast<FOOTPRINT*>( item )->GetParent();
91  }
92 
93  BOARD_ITEM* this_item = nullptr;
94 
95  if( ptN == 0 )
96  {
97  // the first point: we don't own this or add it, but
98  // we might still modify it (position or label)
99  this_item = item;
100  }
101  else
102  {
103  if( m_isFootprintEditor )
104  {
105  // Don't bother incrementing pads: the footprint won't update until commit,
106  // so we can only do this once
107  this_item = fp->DuplicateItem( item );
108  }
109  else
110  {
111  switch( item->Type() )
112  {
113  case PCB_FOOTPRINT_T:
114  case PCB_SHAPE_T:
115  case PCB_TEXT_T:
116  case PCB_TRACE_T:
117  case PCB_ARC_T:
118  case PCB_VIA_T:
119  case PCB_DIM_ALIGNED_T:
120  case PCB_DIM_CENTER_T:
122  case PCB_DIM_LEADER_T:
123  case PCB_TARGET_T:
124  case PCB_ZONE_T:
125  this_item = item->Duplicate();
126  break;
127 
128  case PCB_GROUP_T:
129  this_item = static_cast<PCB_GROUP*>( item )->DeepDuplicate();
130  break;
131 
132  default:
133  // Silently drop other items (such as footprint texts) from duplication
134  break;
135  }
136 
137  // @TODO: we should merge zones. This is a bit tricky, because
138  // the undo command needs saving old area, if it is merged.
139  }
140 
141  // Add new items to selection (footprints in the selection will be reannotated)
142  items_for_this_block.Add( this_item );
143 
144  if( this_item )
145  {
146  // Because aItem is/can be created from a selected item, and inherits from
147  // it this state, reset the selected stated of aItem:
148  this_item->ClearSelected();
149 
150  if( this_item->Type() == PCB_GROUP_T )
151  {
152  static_cast<PCB_GROUP*>( this_item )->RunOnDescendants(
153  [&]( BOARD_ITEM* aItem )
154  {
155  aItem->ClearSelected();
156  commit.Add( aItem );
157  });
158  }
159  else if( this_item->Type() == PCB_FOOTPRINT_T )
160  {
161  static_cast<FOOTPRINT*>( this_item )->RunOnChildren(
162  [&]( BOARD_ITEM* aItem )
163  {
164  aItem->ClearSelected();
165  });
166  }
167 
168  commit.Add( this_item );
169  }
170  }
171 
172  // always transform the item
173  if( this_item )
174  {
175  commit.Modify( this_item );
176  TransformItem( *array_opts, ptN, *this_item );
177  }
178 
179  // attempt to renumber items if the array parameters define
180  // a complete numbering scheme to number by (as opposed to
181  // implicit numbering by incrementing the items during creation
182  if( this_item && array_opts->ShouldNumberItems() )
183  {
184  // Renumber non-aperture pads.
185  if( this_item->Type() == PCB_PAD_T )
186  {
187  PAD& pad = static_cast<PAD&>( *this_item );
188 
189  if( pad.CanHaveNumber() )
190  {
191  wxString newNumber = pad_number_provider.GetNextPadNumber();
192  pad.SetNumber( newNumber );
193  }
194  }
195  }
196  }
197 
198  if( !m_isFootprintEditor && array_opts->ShouldReannotateFootprints() )
199  {
200  m_toolMgr->GetTool<BOARD_REANNOTATE_TOOL>()->ReannotateDuplicates( items_for_this_block,
201  all_added_items );
202  }
203 
204  for( EDA_ITEM* item : items_for_this_block )
205  all_added_items.push_back( item );
206  }
207 
209  m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &all_added_items );
210 
211  commit.Push( _( "Create an array" ) );
212 }
static TOOL_ACTION selectItems
Select a list of items (specified as the event parameter)
Definition: pcb_actions.h:66
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:59
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:1738
Transform applied to an object by this array.
Definition: array_options.h:58
COMMIT & Modify(EDA_ITEM *aItem)
Create an undo entry for an item that has been already modified.
Definition: commit.h:103
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition: typeinfo.h:100
virtual VECTOR2I GetCenter() const
Returns the center point of the selection area bounding box.
Definition: selection.cpp:71
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:101
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:49
virtual void Add(EDA_ITEM *aItem)
Definition: selection.cpp:32
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:108
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Rotate this object.
Definition: board_item.cpp:190
void ClearSelected()
Definition: eda_item.h:131
COMMIT & Add(EDA_ITEM *aItem)
Notify observers that aItem has been added.
Definition: commit.h:78
class PCB_DIM_CENTER, a center point marking (graphic item)
Definition: typeinfo.h:102
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:60
class PCB_TEXT, text on a layer
Definition: typeinfo.h:91
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:143
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:97
class PAD, a pad in a footprint
Definition: typeinfo.h:89
virtual wxPoint GetPosition() const
Definition: eda_item.h:251
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
Options that govern the setup of an "array" of multiple item.
Definition: array_options.h:36
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:318
bool m_isFootprintEditor
Definition: array_creator.h:61
virtual void Move(const wxPoint &aMoveVector)
Move this object.
Definition: board_item.h:238
Simple class that sequentially provides numbers from an ARRAY_OPTIONS object, making sure that they d...
#define _(s)
class ZONE, a copper pour area
Definition: typeinfo.h:105
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.
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:104
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
virtual TRANSFORM GetTransform(int aN, const VECTOR2I &aPos) const =0
Get the transform of the n-th point in the array.
wxString GetNextPadNumber()
Get the next available pad name.
int Size() const
Returns the number of selected parts.
Definition: selection.h:104
TOOL_MANAGER * m_toolMgr
Definition: array_creator.h:63
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:99
virtual void Push(const wxString &aMessage=wxT("A commit"), bool aCreateUndoEntry=true, bool aSetDirtyBit=true) override
Revert the commit by restoring the modified items state.
virtual BOARD_ITEM * Duplicate() const
Create a copy of this BOARD_ITEM.
Definition: board_item.h:171
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
Definition: typeinfo.h:103
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
const PCB_SELECTION m_selection
Definition: array_creator.h:62
BOARD * GetBoard() const
Definition: pad.h:57
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:135
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:90
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112