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

Public Member Functions

 GAL_ARRAY_CREATOR (PCB_BASE_FRAME &editFrame, bool editModules, const SELECTION &selection)
 
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 prePushAction (BOARD_ITEM *aItem) override
 
void postPushAction (BOARD_ITEM *new_item) override
 
void finalise () override
 

Private Attributes

bool m_editModules
 
const SELECTIONm_selection
 

Detailed Description

Definition at line 998 of file edit_tool.cpp.

Constructor & Destructor Documentation

GAL_ARRAY_CREATOR::GAL_ARRAY_CREATOR ( PCB_BASE_FRAME editFrame,
bool  editModules,
const SELECTION selection 
)
inline

Definition at line 1002 of file edit_tool.cpp.

1003  :
1004  ARRAY_CREATOR( editFrame ),
1005  m_editModules( editModules ),
1006  m_selection( selection )
1007  {}
const SELECTION & m_selection
Definition: edit_tool.cpp:1065
ARRAY_CREATOR(PCB_BASE_FRAME &parent)
Definition: array_creator.h:49

Member Function Documentation

void GAL_ARRAY_CREATOR::finalise ( )
inlineoverrideprivatevirtual

Actions to perform after the array process is complete

Implements ARRAY_CREATOR.

Definition at line 1060 of file edit_tool.cpp.

1061  {
1062  }
BOARD* GAL_ARRAY_CREATOR::getBoard ( ) const
inlineoverrideprivatevirtual

Get the BOARD that is currently being edited.

Implements ARRAY_CREATOR.

Definition at line 1022 of file edit_tool.cpp.

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

1023  {
1024  return m_parent.GetBoard();
1025  }
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:61
BOARD * GetBoard() const
MODULE* GAL_ARRAY_CREATOR::getModule ( ) const
inlineoverrideprivatevirtual

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

Implements ARRAY_CREATOR.

Definition at line 1027 of file edit_tool.cpp.

References PCB_BASE_FRAME::GetBoard(), DLIST< T >::GetFirst(), m_editModules, BOARD::m_Modules, and ARRAY_CREATOR::m_parent.

1028  {
1029  // Remember this is valid and used only in the module editor.
1030  // in board editor, the parent of items is usually the board.
1031  return m_editModules ? m_parent.GetBoard()->m_Modules.GetFirst() : NULL;
1032  }
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:61
BOARD * GetBoard() const
T * GetFirst() const
Function GetFirst returns the first T* in the list without removing it, or NULL if the list is empty...
Definition: dlist.h:163
DLIST< MODULE > m_Modules
Definition: class_board.h:245
BOARD_ITEM* GAL_ARRAY_CREATOR::getNthItemToArray ( int  n) const
inlineoverrideprivatevirtual
Returns
the n'th original item to be arrayed

Implements ARRAY_CREATOR.

Definition at line 1017 of file edit_tool.cpp.

References m_selection.

1018  {
1019  return static_cast<BOARD_ITEM*>( m_selection[n] );
1020  }
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
const SELECTION & m_selection
Definition: edit_tool.cpp:1065
int GAL_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 1011 of file edit_tool.cpp.

References m_selection, and SELECTION::Size().

1012  {
1013  // only handle single items
1014  return m_selection.Size();
1015  }
const SELECTION & m_selection
Definition: edit_tool.cpp:1065
int Size() const
Returns the number of selected parts.
Definition: selection.h:112
wxPoint GAL_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 1034 of file edit_tool.cpp.

References SELECTION::GetCenter(), m_selection, VECTOR2< T >::x, and VECTOR2< T >::y.

1035  {
1036  const VECTOR2I rp = m_selection.GetCenter();
1037  return wxPoint( rp.x, rp.y );
1038  }
const SELECTION & m_selection
Definition: edit_tool.cpp:1065
VECTOR2I GetCenter() const
Returns the center point of the selection area bounding box.
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)
void GAL_ARRAY_CREATOR::postPushAction ( BOARD_ITEM new_item)
inlineoverrideprivatevirtual

Perform any actions needed after pushing an item to the BOARD

Reimplemented from ARRAY_CREATOR.

Definition at line 1056 of file edit_tool.cpp.

1057  {
1058  }
void GAL_ARRAY_CREATOR::prePushAction ( BOARD_ITEM new_item)
inlineoverrideprivatevirtual

Perform any relevant action before pushing a newly created array item to the BOARD

Reimplemented from ARRAY_CREATOR.

Definition at line 1040 of file edit_tool.cpp.

References EDA_ITEM::ClearSelected(), PCB_MODULE_T, and EDA_ITEM::Type().

1041  {
1042  // Because aItem is/can be created from a selected item, and inherits from
1043  // it this state, reset the selected stated of aItem:
1044  aItem->ClearSelected();
1045 
1046  if( aItem->Type() == PCB_MODULE_T )
1047  {
1048  static_cast<MODULE*>( aItem )->RunOnChildren( [&] ( BOARD_ITEM* item )
1049  {
1050  item->ClearSelected();
1051  }
1052  );
1053  }
1054  }
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
void ClearSelected()
Definition: base_struct.h:245
class MODULE, a footprint
Definition: typeinfo.h:101

Member Data Documentation

bool GAL_ARRAY_CREATOR::m_editModules
private

Definition at line 1064 of file edit_tool.cpp.

Referenced by getModule().

PCB_BASE_FRAME& ARRAY_CREATOR::m_parent
protectedinherited
const SELECTION& GAL_ARRAY_CREATOR::m_selection
private

Definition at line 1065 of file edit_tool.cpp.

Referenced by getNthItemToArray(), getNumberOfItemsToArray(), and getRotationCentre().


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