KiCad PCB EDA Suite
LEGACY_ARRAY_CREATOR Class Reference
Inheritance diagram for LEGACY_ARRAY_CREATOR:
ARRAY_CREATOR

Public Member Functions

 LEGACY_ARRAY_CREATOR (PCB_BASE_EDIT_FRAME &editFrame)
 
void Invoke ()
 

Protected Attributes

PCB_BASE_FRAMEm_parent
 

Private Member Functions

int getNumberOfItemsToArray () const override
 
BOARD_ITEMgetNthItemToArray (int n) const override
 
BOARDgetBoard () const override
 
MODULEgetModule () const override
 
wxPoint getRotationCentre () const override
 
void finalise () override
 

Private Attributes

BOARD_ITEMm_item
 

Detailed Description

Definition at line 1656 of file edit.cpp.

Constructor & Destructor Documentation

LEGACY_ARRAY_CREATOR::LEGACY_ARRAY_CREATOR ( PCB_BASE_EDIT_FRAME editFrame)
inline

Definition at line 1660 of file edit.cpp.

1660  :
1661  ARRAY_CREATOR( editFrame ),
1663  {}
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:61
BOARD_ITEM * GetCurItem() const
Function GetCurItem returns the currently selected BOARD_ITEM, overriding BASE_SCREEN::GetCurItem().
BOARD_ITEM * m_item
Definition: edit.cpp:1699
ARRAY_CREATOR(PCB_BASE_FRAME &parent)
Definition: array_creator.h:49
PCB_SCREEN * GetScreen() const override
Function GetScreen returns a pointer to a BASE_SCREEN or one of its derivatives.

Member Function Documentation

void LEGACY_ARRAY_CREATOR::finalise ( )
inlineoverrideprivatevirtual

Actions to perform after the array process is complete

Implements ARRAY_CREATOR.

Definition at line 1694 of file edit.cpp.

References EDA_DRAW_FRAME::GetCanvas(), ARRAY_CREATOR::m_parent, and EDA_DRAW_PANEL::Refresh().

1695  {
1696  m_parent.GetCanvas()->Refresh();
1697  }
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
Definition: draw_panel.cpp:325
EDA_DRAW_PANEL * GetCanvas()
Definition: draw_frame.h:324
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:61
BOARD* LEGACY_ARRAY_CREATOR::getBoard ( ) const
inlineoverrideprivatevirtual

Get the BOARD that is currently being edited.

Implements ARRAY_CREATOR.

Definition at line 1679 of file edit.cpp.

References PCB_BASE_FRAME::GetBoard(), and ARRAY_CREATOR::m_parent.

1680  {
1681  return m_parent.GetBoard();
1682  }
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:61
BOARD * GetBoard() const
MODULE* LEGACY_ARRAY_CREATOR::getModule ( ) const
inlineoverrideprivatevirtual

If editing a footprint, returns the relevant MODULE, else NULL

Implements ARRAY_CREATOR.

Definition at line 1684 of file edit.cpp.

References BOARD_ITEM::GetParent(), and m_item.

1685  {
1686  return dynamic_cast<MODULE*>( m_item->GetParent() );
1687  }
BOARD_ITEM_CONTAINER * GetParent() const
BOARD_ITEM * m_item
Definition: edit.cpp:1699
BOARD_ITEM* LEGACY_ARRAY_CREATOR::getNthItemToArray ( int  n) const
inlineoverrideprivatevirtual
Returns
the n'th original item to be arrayed

Implements ARRAY_CREATOR.

Definition at line 1673 of file edit.cpp.

References m_item.

1674  {
1675  wxASSERT_MSG( n == 0, "Legacy array tool can only handle a single item" );
1676  return m_item;
1677  }
BOARD_ITEM * m_item
Definition: edit.cpp:1699
int LEGACY_ARRAY_CREATOR::getNumberOfItemsToArray ( ) const
inlineoverrideprivatevirtual
Returns
number of original items to put into an array (eg size of the selection)

Implements ARRAY_CREATOR.

Definition at line 1667 of file edit.cpp.

References m_item.

1668  {
1669  // only handle single items
1670  return (m_item != NULL) ? 1 : 0;
1671  }
BOARD_ITEM * m_item
Definition: edit.cpp:1699
wxPoint LEGACY_ARRAY_CREATOR::getRotationCentre ( ) const
inlineoverrideprivatevirtual
Returns
the rotation centre of all the items to be arrayed, when taken together

Implements ARRAY_CREATOR.

Definition at line 1689 of file edit.cpp.

References BOARD_ITEM::GetCenter(), and m_item.

1690  {
1691  return m_item->GetCenter();
1692  }
virtual const wxPoint GetCenter() const
Function GetCenter()
BOARD_ITEM * m_item
Definition: edit.cpp:1699
void ARRAY_CREATOR::Invoke ( )
inherited

Open the dialog, gather parameters and create the array

Definition at line 35 of file array_creator.cpp.

References COMMIT::Add(), BOARD::Duplicate(), MODULE::Duplicate(), ARRAY_CREATOR::finalise(), DIALOG_CREATE_ARRAY::GetArrayOptions(), DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::GetArraySize(), ARRAY_CREATOR::getBoard(), DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::GetItemNumber(), ARRAY_CREATOR::getModule(), ARRAY_CREATOR::getNthItemToArray(), ARRAY_CREATOR::getNumberOfItemsToArray(), ARRAY_CREATOR::getRotationCentre(), ARRAY_CREATOR::m_parent, DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::NumberingStartIsSpecified(), PCB_PAD_T, ARRAY_CREATOR::postPushAction(), ARRAY_CREATOR::prePushAction(), BOARD_COMMIT::Push(), DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::ShouldNumberItems(), DIALOG_CREATE_ARRAY::ARRAY_OPTIONS::TransformItem(), and EDA_ITEM::Type().

Referenced by PCB_BASE_EDIT_FRAME::createArray().

36 {
37  const int numItems = getNumberOfItemsToArray();
38 
39  // bail out if no items
40  if( numItems == 0 )
41  return;
42 
43  MODULE* const module = getModule();
44  const bool isModuleEditor = module != NULL;
45 
46  const bool enableArrayNumbering = isModuleEditor;
47  const wxPoint rotPoint = getRotationCentre();
48 
49  DIALOG_CREATE_ARRAY dialog( &m_parent, enableArrayNumbering, rotPoint );
50  int ret = dialog.ShowModal();
51 
52  DIALOG_CREATE_ARRAY::ARRAY_OPTIONS* const array_opts = dialog.GetArrayOptions();
53 
54  if( ret != wxID_OK || array_opts == NULL )
55  return;
56 
57  BOARD_COMMIT commit( &m_parent );
58 
59  for ( int i = 0; i < numItems; ++i )
60  {
61  BOARD_ITEM* item = getNthItemToArray( i );
62 
63  if( item->Type() == PCB_PAD_T && !isModuleEditor )
64  {
65  // If it is not the module editor, then duplicate the parent module instead
66  item = static_cast<MODULE*>( item )->GetParent();
67  }
68 
69  // The first item in list is the original item. We do not modify it
70  for( int ptN = 1; ptN < array_opts->GetArraySize(); ptN++ )
71  {
72  BOARD_ITEM* new_item;
73 
74  if( isModuleEditor )
75  {
76  // increment pad numbers if do any renumbering
77  // (we will number again later according to the numbering scheme if set)
78  new_item = module->Duplicate( item, array_opts->ShouldNumberItems() );
79  }
80  else
81  {
82  // PCB items keep the same numbering
83  new_item = getBoard()->Duplicate( item );
84 
85  // @TODO: we should merge zones. This is a bit tricky, because
86  // the undo command needs saving old area, if it is merged.
87  }
88 
89  if( new_item )
90  {
91  array_opts->TransformItem( ptN, new_item, rotPoint );
92  prePushAction( new_item );
93  commit.Add( new_item );
94  postPushAction( new_item );
95  }
96 
97  // attempt to renumber items if the array parameters define
98  // a complete numbering scheme to number by (as opposed to
99  // implicit numbering by incrementing the items during creation
100  if( new_item && array_opts->NumberingStartIsSpecified() )
101  {
102  // Renumber pads. Only new pad number renumbering has meaning,
103  // in the footprint editor.
104  if( new_item->Type() == PCB_PAD_T )
105  {
106  const wxString padName = array_opts->GetItemNumber( ptN );
107  static_cast<D_PAD*>( new_item )->SetName( padName );
108  }
109  }
110  }
111  }
112 
113  commit.Push( _( "Create an array" ) );
114  finalise();
115 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
virtual wxString GetItemNumber(int n) const =0
BOARD_ITEM * Duplicate(const BOARD_ITEM *aItem, bool aIncrementPadNumbers, bool aAddToModule=false)
Function Duplicate Duplicate a given item within the module, without adding to the board...
virtual void postPushAction(BOARD_ITEM *new_item)
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:61
class D_PAD, a pad in a footprint
Definition: typeinfo.h:102
virtual MODULE * getModule() const =0
virtual void TransformItem(int n, BOARD_ITEM *item, const wxPoint &rotPoint) const =0
virtual wxPoint getRotationCentre() const =0
virtual BOARD * getBoard() const =0
virtual int getNumberOfItemsToArray() const =0
virtual void finalise()=0
virtual BOARD_ITEM * getNthItemToArray(int n) const =0
virtual int GetArraySize() const =0
virtual void prePushAction(BOARD_ITEM *new_item)
Definition: array_creator.h:96
BOARD_ITEM * Duplicate(const BOARD_ITEM *aItem, bool aAddToBoard=false)

Member Data Documentation

BOARD_ITEM* LEGACY_ARRAY_CREATOR::m_item
private
PCB_BASE_FRAME& ARRAY_CREATOR::m_parent
protectedinherited

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