KiCad PCB EDA Suite
ARRAY_CREATOR Class Reference

#include <array_creator.h>

Public Member Functions

 ARRAY_CREATOR (PCB_BASE_FRAME &aParent, bool editModules, const PCBNEW_SELECTION &aSelection)
 
virtual ~ARRAY_CREATOR ()
 
void Invoke ()
 

Private Attributes

PCB_BASE_FRAMEm_parent
 
bool m_editModules
 
const PCBNEW_SELECTIONm_selection
 

Detailed Description

Class that performs array creation by producing a dialog to gather parameters and then creating and laying out the items.

Definition at line 39 of file array_creator.h.

Constructor & Destructor Documentation

◆ ARRAY_CREATOR()

ARRAY_CREATOR::ARRAY_CREATOR ( PCB_BASE_FRAME aParent,
bool  editModules,
const PCBNEW_SELECTION aSelection 
)
inline

Definition at line 42 of file array_creator.h.

42  :
43  m_parent( aParent ),
44  m_editModules( editModules ),
45  m_selection( aSelection )
46  {}
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:56
const PCBNEW_SELECTION & m_selection
Definition: array_creator.h:58

◆ ~ARRAY_CREATOR()

virtual ARRAY_CREATOR::~ARRAY_CREATOR ( )
inlinevirtual

Definition at line 48 of file array_creator.h.

48 {}

Member Function Documentation

◆ Invoke()

void ARRAY_CREATOR::Invoke ( )

Open the dialog, gather parameters and create the array

Definition at line 49 of file array_creator.cpp.

50 {
51  // bail out if no items
52  if( m_selection.Size() == 0 )
53  return;
54 
55  MODULE* const module = m_editModules ? m_parent.GetBoard()->GetFirstModule() : nullptr;
56 
57  const bool enableArrayNumbering = m_editModules;
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( module, *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_editModules )
78  {
79  // If it is not the module editor, then duplicate the parent module instead
80  item = static_cast<MODULE*>( 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 
99  if( m_editModules )
100  {
101  // Don't bother incrementing pads: the module won't update
102  // until commit, so we can only do this once
103  new_item = module->DuplicateItem( item );
104  }
105  else
106  {
107  switch( item->Type() )
108  {
109  case PCB_MODULE_T:
110  case PCB_TEXT_T:
111  case PCB_LINE_T:
112  case PCB_TRACE_T:
113  case PCB_VIA_T:
114  case PCB_ZONE_AREA_T:
115  case PCB_TARGET_T:
116  case PCB_DIMENSION_T:
117  new_item = item->Duplicate();
118  break;
119 
120  default:
121  // Silently drop other items (such as footprint texts) from duplication
122  break;
123  }
124 
125  // PCB items keep the same numbering
126 
127  // @TODO: renumber modules if asked. This needs UI to enable.
128  // something like this, but needs a "block offset" to prevent
129  // multiple selections overlapping.
130  // if( new_item->Type() == PCB_MODULE_T )
131  // static_cast<MODULE&>( *new_item ).IncrementReference( ptN );
132 
133  // @TODO: we should merge zones. This is a bit tricky, because
134  // the undo command needs saving old area, if it is merged.
135  }
136 
137  this_item = new_item;
138 
139  if( new_item )
140  {
141  // Because aItem is/can be created from a selected item, and inherits from
142  // it this state, reset the selected stated of aItem:
143  this_item->ClearSelected();
144 
145  if( this_item->Type() == PCB_MODULE_T )
146  {
147  static_cast<MODULE*>( this_item )->RunOnChildren( [&] ( BOARD_ITEM* aItem )
148  {
149  aItem->ClearSelected();
150  });
151  }
152 
153  commit.Add( new_item );
154  }
155  }
156 
157  // always transform the item
158  if( this_item )
159  {
160  commit.Modify( this_item );
161  TransformItem( *array_opts, ptN, *this_item );
162  }
163 
164  // attempt to renumber items if the array parameters define
165  // a complete numbering scheme to number by (as opposed to
166  // implicit numbering by incrementing the items during creation
167  if( this_item && array_opts->ShouldNumberItems() )
168  {
169  // Renumber non-aperture pads.
170  if( this_item->Type() == PCB_PAD_T )
171  {
172  auto& pad = static_cast<D_PAD&>( *this_item );
173 
174  if( PAD_NAMING::PadCanHaveName( pad ) )
175  {
176  wxString newName = pad_name_provider.GetNextPadName();
177  pad.SetName( newName );
178  }
179  }
180  }
181  }
182  }
183 
184  commit.Push( _( "Create an array" ) );
185 }
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
void ClearSelected()
Definition: base_struct.h:211
virtual VECTOR2I GetCenter() const
Returns the center point of the selection area bounding box.
Definition: selection.h:138
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:56
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
bool PadCanHaveName(const D_PAD &aPad)
Check if a pad should be named.
Definition: pad_naming.cpp:26
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
Simple class that sequentially provides names from an ARRAY_OPTIONS object, making sure that they do ...
class MODULE, a footprint
Definition: typeinfo.h:89
#define NULL
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:330
BOARD_ITEM * DuplicateItem(const BOARD_ITEM *aItem, bool aAddToModule=false)
Function DuplicateItem Duplicate a given item within the module, optionally adding it to the board.
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 DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:100
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:101
#define _(s)
Definition: 3d_actions.cpp:33
int Size() const
Returns the number of selected parts.
Definition: selection.h:127
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
BOARD * GetBoard() const
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
BOARD_ITEM_CONTAINER * GetParent() const
BOARD_ITEM * Duplicate() const
Function Duplicate creates a copy of a BOARD_ITEM.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193
const PCBNEW_SELECTION & m_selection
Definition: array_creator.h:58

References _, COMMIT::Add(), EDA_ITEM::ClearSelected(), BOARD_ITEM::Duplicate(), MODULE::DuplicateItem(), PCB_BASE_FRAME::GetBoard(), SELECTION::GetCenter(), BOARD::GetFirstModule(), ARRAY_PAD_NAME_PROVIDER::GetNextPadName(), BOARD_ITEM::GetParent(), m_editModules, m_parent, m_selection, COMMIT::Modify(), NULL, PAD_NAMING::PadCanHaveName(), PCB_DIMENSION_T, PCB_LINE_T, PCB_MODULE_T, PCB_PAD_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, BOARD_COMMIT::Push(), SELECTION::Size(), TransformItem(), and EDA_ITEM::Type().

Referenced by EDIT_TOOL::CreateArray().

Member Data Documentation

◆ m_editModules

bool ARRAY_CREATOR::m_editModules
private

Definition at line 57 of file array_creator.h.

Referenced by Invoke().

◆ m_parent

PCB_BASE_FRAME& ARRAY_CREATOR::m_parent
private

Definition at line 56 of file array_creator.h.

Referenced by Invoke().

◆ m_selection

const PCBNEW_SELECTION& ARRAY_CREATOR::m_selection
private

Definition at line 58 of file array_creator.h.

Referenced by Invoke().


The documentation for this class was generated from the following files: