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) 1992-2020 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 <pad_naming.h>
30 
32 
40 static void TransformItem( const ARRAY_OPTIONS& aArrOpts, int aIndex, BOARD_ITEM& aItem )
41 {
42  const ARRAY_OPTIONS::TRANSFORM transform = aArrOpts.GetTransform( aIndex, aItem.GetPosition() );
43 
44  aItem.Move( (wxPoint) transform.m_offset );
45  aItem.Rotate( aItem.GetPosition(), transform.m_rotation * 10 );
46 }
47 
48 
50 {
51  // bail out if no items
52  if( m_selection.Size() == 0 )
53  return;
54 
56 
57  const bool enableArrayNumbering = m_isFootprintEditor;
58  const wxPoint rotPoint = (wxPoint) m_selection.GetCenter();
59 
60  std::unique_ptr<ARRAY_OPTIONS> array_opts;
61 
62  DIALOG_CREATE_ARRAY dialog( &m_parent, array_opts, enableArrayNumbering, rotPoint );
63 
64  int ret = dialog.ShowModal();
65 
66  if( ret != wxID_OK || array_opts == NULL )
67  return;
68 
69  BOARD_COMMIT commit( &m_parent );
70 
71  ARRAY_PAD_NAME_PROVIDER pad_name_provider( fp, *array_opts );
72 
73  for ( int i = 0; i < m_selection.Size(); ++i )
74  {
75  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( m_selection[ i ] );
76 
77  if( item->Type() == PCB_PAD_T && !m_isFootprintEditor )
78  {
79  // If it is not the footprint editor, then duplicate the parent footprint instead
80  item = static_cast<FOOTPRINT*>( item )->GetParent();
81  }
82 
83  // The first item in list is the original item. We do not modify it
84  for( int ptN = 0; ptN < array_opts->GetArraySize(); ptN++ )
85  {
86  BOARD_ITEM* this_item;
87 
88  if( ptN == 0 )
89  {
90  // the first point: we don't own this or add it, but
91  // we might still modify it (position or label)
92  this_item = item;
93  }
94  else
95  {
96  // Need to create a new item
97  BOARD_ITEM* new_item = nullptr;
98 
100  {
101  // Don't bother incrementing pads: the footprint won't update until commit,
102  // so we can only do this once
103  new_item = fp->DuplicateItem( item );
104  }
105  else
106  {
107  switch( item->Type() )
108  {
109  case PCB_FOOTPRINT_T:
110  case PCB_TEXT_T:
111  case PCB_SHAPE_T:
112  case PCB_TRACE_T:
113  case PCB_VIA_T:
114  case PCB_ZONE_T:
115  case PCB_TARGET_T:
116  case PCB_DIM_ALIGNED_T:
117  case PCB_DIM_CENTER_T:
119  case PCB_DIM_LEADER_T:
120  new_item = item->Duplicate();
121  break;
122 
123  default:
124  // Silently drop other items (such as footprint texts) from duplication
125  break;
126  }
127 
128  // PCB items keep the same numbering
129 
130  // @TODO: renumber footprints if asked. This needs UI to enable.
131  // something like this, but needs a "block offset" to prevent
132  // multiple selections overlapping.
133  // if( new_item->Type() == PCB_FOOTPRINT_T )
134  // static_cast<FOOTPRINT&>( *new_item ).IncrementReference( ptN );
135 
136  // @TODO: we should merge zones. This is a bit tricky, because
137  // the undo command needs saving old area, if it is merged.
138  }
139 
140  this_item = new_item;
141 
142  if( new_item )
143  {
144  // Because aItem is/can be created from a selected item, and inherits from
145  // it this state, reset the selected stated of aItem:
146  this_item->ClearSelected();
147 
148  if( this_item->Type() == PCB_FOOTPRINT_T )
149  {
150  static_cast<FOOTPRINT*>( this_item )->RunOnChildren(
151  [&]( BOARD_ITEM* aItem )
152  {
153  aItem->ClearSelected();
154  });
155  }
156 
157  commit.Add( new_item );
158  }
159  }
160 
161  // always transform the item
162  if( this_item )
163  {
164  commit.Modify( this_item );
165  TransformItem( *array_opts, ptN, *this_item );
166  }
167 
168  // attempt to renumber items if the array parameters define
169  // a complete numbering scheme to number by (as opposed to
170  // implicit numbering by incrementing the items during creation
171  if( this_item && array_opts->ShouldNumberItems() )
172  {
173  // Renumber non-aperture pads.
174  if( this_item->Type() == PCB_PAD_T )
175  {
176  PAD& pad = static_cast<PAD&>( *this_item );
177 
178  if( PAD_NAMING::PadCanHaveName( pad ) )
179  {
180  wxString newName = pad_name_provider.GetNextPadName();
181  pad.SetName( newName );
182  }
183  }
184  }
185  }
186  }
187 
188  commit.Push( _( "Create an array" ) );
189 }
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:1607
Transform applied to an object by this array.
Definition: array_options.h:55
COMMIT & Modify(EDA_ITEM *aItem)
Create an undo entry for an item that has been already modified.
Definition: commit.h:103
class ALIGNED_DIMENSION, a linear dimension (graphic item)
Definition: typeinfo.h:100
class 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:82
void ClearSelected()
Definition: eda_item.h:181
COMMIT & Add(EDA_ITEM *aItem)
Notify observers that aItem has been added.
Definition: commit.h:78
class CENTER_DIMENSION, a center point marking (graphic item)
Definition: typeinfo.h:102
virtual VECTOR2I GetCenter() const
Returns the center point of the selection area bounding box.
Definition: selection.h:139
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:57
const PCB_SELECTION & m_selection
Definition: array_creator.h:59
void SetName(const wxString &aName)
Set the pad name (sometimes called pad number, although it can be an array reference like AA12).
Definition: pad.h:132
class PCB_TEXT, text on a layer
Definition: typeinfo.h:91
class PAD, a pad in a footprint
Definition: typeinfo.h:89
virtual wxPoint GetPosition() const
Definition: eda_item.h:301
wxString GetNextPadName()
Get the next available pad name.
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
Simple class that sequentially provides names from an ARRAY_OPTIONS object, making sure that they do ...
Options that govern the setup of an "array" of multiple item.
Definition: array_options.h:36
FOOTPRINT * GetFirstFootprint() const
Gets the first footprint on the board or nullptr.
Definition: board.h:380
#define NULL
bool m_isFootprintEditor
Definition: array_creator.h:58
virtual void Move(const wxPoint &aMoveVector)
Move this object.
Definition: board_item.h:277
bool PadCanHaveName(const PAD &aPad)
Check if a pad should be named.
Definition: pad_naming.cpp:26
class ZONE, a copper pour area
Definition: typeinfo.h:105
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Rotate this object.
Definition: board_item.h:294
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.
#define _(s)
Definition: 3d_actions.cpp:33
int Size() const
Returns the number of selected parts.
Definition: selection.h:128
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 a of this BOARD_ITEM.
Definition: board_item.h:202
class ORTHOGONAL_DIMENSION, a linear dimension constrained to x/y
Definition: typeinfo.h:103
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
BOARD * GetBoard() const
Definition: pad.h:60
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:168
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:162