KiCad PCB EDA Suite
BOARD_COMMIT Class Reference

#include <board_commit.h>

Inheritance diagram for BOARD_COMMIT:
COMMIT

Public Member Functions

 BOARD_COMMIT (EDA_DRAW_FRAME *aFrame)
 
 BOARD_COMMIT (PCB_TOOL_BASE *aTool)
 
virtual ~BOARD_COMMIT ()
 
virtual void Push (const wxString &aMessage=wxT("A commit"), bool aCreateUndoEntry=true, bool aSetDirtyBit=true) override
 

Executes the changes.

More...
 
virtual void Revert () override
 

Revertes the commit by restoring the modifed items state.

More...
 
COMMITStage (EDA_ITEM *aItem, CHANGE_TYPE aChangeType) override
 

Adds a change of the item aItem of type aChangeType to the change list.

More...
 
COMMITStage (std::vector< EDA_ITEM * > &container, CHANGE_TYPE aChangeType) override
 
COMMITStage (const PICKED_ITEMS_LIST &aItems, UNDO_REDO_T aModFlag=UR_UNSPECIFIED) override
 
COMMITAdd (EDA_ITEM *aItem)
 

Adds a new item to the model

More...
 
COMMITAdded (EDA_ITEM *aItem)
 

Notifies observers that aItem has been added

More...
 
COMMITRemove (EDA_ITEM *aItem)
 

Removes a new item from the model

More...
 
COMMITRemoved (EDA_ITEM *aItem)
 

Notifies observers that aItem has been removed

More...
 
COMMITModify (EDA_ITEM *aItem)
 

Modifies a given item in the model.

More...
 
COMMITModified (EDA_ITEM *aItem, EDA_ITEM *aCopy)
 

Creates an undo entry for an item that has been already modified.

More...
 
template<class Range >
COMMITStageItems (const Range &aRange, CHANGE_TYPE aChangeType)
 
bool Empty () const
 
int GetStatus (EDA_ITEM *aItem)
 

Returns status of an item.

More...
 

Protected Member Functions

void clear ()
 
COMMITcreateModified (EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
 
virtual void makeEntry (EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=NULL)
 
COMMIT_LINEfindEntry (EDA_ITEM *aItem)
 Searches for an entry describing change for a particular item. More...
 
CHANGE_TYPE convert (UNDO_REDO_T aType) const
 

Protected Attributes

std::set< EDA_ITEM * > m_changedItems
 
std::vector< COMMIT_LINEm_changes
 

Private Member Functions

virtual EDA_ITEMparentObject (EDA_ITEM *aItem) const override
 

Private Attributes

TOOL_MANAGERm_toolMgr
 
bool m_editModules
 

Detailed Description

Definition at line 37 of file board_commit.h.

Constructor & Destructor Documentation

◆ BOARD_COMMIT() [1/2]

BOARD_COMMIT::BOARD_COMMIT ( EDA_DRAW_FRAME aFrame)

Definition at line 48 of file board_commit.cpp.

49 {
50  m_toolMgr = aFrame->GetToolManager();
52 }
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:55
bool IsType(FRAME_T aType) const
bool m_editModules
Definition: board_commit.h:56

References FRAME_FOOTPRINT_EDITOR, EDA_BASE_FRAME::GetToolManager(), and EDA_BASE_FRAME::IsType().

◆ BOARD_COMMIT() [2/2]

BOARD_COMMIT::BOARD_COMMIT ( PCB_TOOL_BASE aTool)

Definition at line 41 of file board_commit.cpp.

42 {
43  m_toolMgr = aTool->GetManager();
44  m_editModules = aTool->EditingModules();
45 }
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:55
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:142
bool EditingModules() const
bool m_editModules
Definition: board_commit.h:56

References PCB_TOOL_BASE::EditingModules(), and TOOL_BASE::GetManager().

◆ ~BOARD_COMMIT()

BOARD_COMMIT::~BOARD_COMMIT ( )
virtual

Definition at line 55 of file board_commit.cpp.

56 {
57 }

Member Function Documentation

◆ Add()

◆ Added()

COMMIT& COMMIT::Added ( EDA_ITEM aItem)
inlineinherited

Notifies observers that aItem has been added

Definition at line 84 of file commit.h.

85  {
86  return Stage( aItem, CHT_ADD | CHT_DONE );
87  }
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Adds a change of the item aItem of type aChangeType to the change list.
Definition: commit.cpp:46
Definition: commit.h:38
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45

References CHT_ADD, CHT_DONE, and COMMIT::Stage().

◆ clear()

void COMMIT::clear ( )
inlineprotectedinherited

Definition at line 161 of file commit.h.

162  {
163  m_changedItems.clear();
164  m_changes.clear();
165  }
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:181
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182

References COMMIT::m_changedItems, and COMMIT::m_changes.

Referenced by PCB_EDIT_FRAME::ResolveDRCExclusions().

◆ convert()

CHANGE_TYPE COMMIT::convert ( UNDO_REDO_T  aType) const
protectedinherited

Definition at line 202 of file commit.cpp.

203 {
204  switch( aType )
205  {
206  case UR_NEW:
207  return CHT_ADD;
208 
209  case UR_DELETED:
210  return CHT_REMOVE;
211 
212  default:
213  assert( false );
214  // fall through
215 
216  case UR_CHANGED:
217  case UR_MOVED:
218  case UR_MIRRORED_X:
219  case UR_MIRRORED_Y:
220  case UR_ROTATED:
222  case UR_FLIPPED:
223  return CHT_MODIFY;
224  }
225 }
Definition: commit.h:38

References CHT_ADD, CHT_MODIFY, CHT_REMOVE, UR_CHANGED, UR_DELETED, UR_FLIPPED, UR_MIRRORED_X, UR_MIRRORED_Y, UR_MOVED, UR_NEW, UR_ROTATED, and UR_ROTATED_CLOCKWISE.

Referenced by COMMIT::Stage().

◆ createModified()

COMMIT & COMMIT::createModified ( EDA_ITEM aItem,
EDA_ITEM aCopy,
int  aExtraFlags = 0 
)
protectedinherited

Definition at line 150 of file commit.cpp.

151 {
152  EDA_ITEM* parent = parentObject( aItem );
153  auto entryIt = m_changedItems.find( parent );
154 
155  if( entryIt != m_changedItems.end() )
156  {
157  delete aCopy;
158  return *this; // item has been already modified once
159  }
160 
161  makeEntry( parent, CHT_MODIFY | aExtraFlags, aCopy );
162 
163  return *this;
164 }
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:181
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
virtual EDA_ITEM * parentObject(EDA_ITEM *aItem) const =0
virtual void makeEntry(EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=NULL)
Definition: commit.cpp:167

References CHT_MODIFY, COMMIT::m_changedItems, COMMIT::makeEntry(), and COMMIT::parentObject().

Referenced by COMMIT::Modified(), and COMMIT::Stage().

◆ Empty()

bool COMMIT::Empty ( ) const
inlineinherited

Definition at line 139 of file commit.h.

140  {
141  return m_changes.empty();
142  }
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182

References COMMIT::m_changes.

◆ findEntry()

COMMIT::COMMIT_LINE * COMMIT::findEntry ( EDA_ITEM aItem)
protectedinherited

Searches for an entry describing change for a particular item.

Returns
null if there is no related entry.

Definition at line 190 of file commit.cpp.

191 {
192  for( COMMIT_LINE& change : m_changes )
193  {
194  if( change.m_item == aItem )
195  return &change;
196  }
197 
198  return nullptr;
199 }
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182

References COMMIT::m_changes.

Referenced by COMMIT::GetStatus().

◆ GetStatus()

int COMMIT::GetStatus ( EDA_ITEM aItem)
inherited

Returns status of an item.

Definition at line 132 of file commit.cpp.

133 {
134  COMMIT_LINE* entry = findEntry( parentObject( aItem ) );
135 
136  return entry ? entry->m_type : 0;
137 }
COMMIT_LINE * findEntry(EDA_ITEM *aItem)
Searches for an entry describing change for a particular item.
Definition: commit.cpp:190
virtual EDA_ITEM * parentObject(EDA_ITEM *aItem) const =0

References COMMIT::findEntry(), COMMIT::COMMIT_LINE::m_type, and COMMIT::parentObject().

Referenced by BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateComponentParameters().

◆ makeEntry()

void COMMIT::makeEntry ( EDA_ITEM aItem,
CHANGE_TYPE  aType,
EDA_ITEM aCopy = NULL 
)
protectedvirtualinherited

Definition at line 167 of file commit.cpp.

168 {
169  // Expect an item copy if it is going to be modified
170  wxASSERT( !!aCopy == ( ( aType & CHT_TYPE ) == CHT_MODIFY ) );
171 
172  if( m_changedItems.find( aItem ) != m_changedItems.end() )
173  {
174  eraseIf( m_changes, [aItem] ( const COMMIT_LINE& aEnt ) {
175  return aEnt.m_item == aItem;
176  } );
177  }
178 
179  COMMIT_LINE ent;
180 
181  ent.m_item = aItem;
182  ent.m_type = aType;
183  ent.m_copy = aCopy;
184 
185  m_changedItems.insert( aItem );
186  m_changes.push_back( ent );
187 }
void eraseIf(Container &c, F &&f)
Definition: commit.cpp:141
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:181
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182

References CHT_MODIFY, CHT_TYPE, eraseIf(), COMMIT::m_changedItems, COMMIT::m_changes, COMMIT::COMMIT_LINE::m_copy, COMMIT::COMMIT_LINE::m_item, and COMMIT::COMMIT_LINE::m_type.

Referenced by COMMIT::createModified(), and COMMIT::Stage().

◆ Modified()

COMMIT& COMMIT::Modified ( EDA_ITEM aItem,
EDA_ITEM aCopy 
)
inlineinherited

Creates an undo entry for an item that has been already modified.

Requires a copy done before the modification.

Definition at line 110 of file commit.h.

111  {
112  return createModified( aItem, aCopy );
113  }
COMMIT & createModified(EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
Definition: commit.cpp:150

References COMMIT::createModified().

Referenced by COMMIT::Stage(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateComponentParameters().

◆ Modify()

COMMIT& COMMIT::Modify ( EDA_ITEM aItem)
inlineinherited

Modifies a given item in the model.

Must be called before modification is performed.

Definition at line 103 of file commit.h.

104  {
105  return Stage( aItem, CHT_MODIFY );
106  }
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Adds a change of the item aItem of type aChangeType to the change list.
Definition: commit.cpp:46

References CHT_MODIFY, and COMMIT::Stage().

Referenced by POINT_EDITOR::addCorner(), AR_AUTOPLACER::AutoplaceModules(), doPushPadProperties(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EnumeratePads(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), ZONE_FILLER::Fill(), ARRAY_CREATOR::Invoke(), TRACKS_CLEANER::mergeCollinearSegments(), mergeZones(), PCB_EDITOR_CONTROL::modifyLockSelected(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PAD_TOOL::pastePadProperties(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), CN_CONNECTIVITY_ALGO::propagateConnections(), POINT_EDITOR::removeCorner(), DRAWING_TOOL::SetAnchor(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ parentObject()

EDA_ITEM * BOARD_COMMIT::parentObject ( EDA_ITEM aItem) const
overrideprivatevirtual

Implements COMMIT.

Definition at line 332 of file board_commit.cpp.

333 {
334  switch( aItem->Type() )
335  {
336  case PCB_PAD_T:
337  case PCB_MODULE_EDGE_T:
338  case PCB_MODULE_TEXT_T:
340  return aItem->GetParent();
341 
342  case PCB_ZONE_AREA_T:
343  wxASSERT( !dynamic_cast<MODULE*>( aItem->GetParent() ) );
344  return aItem;
345 
346  default:
347  break;
348  }
349 
350  return aItem;
351 }
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
EDA_ITEM * GetParent() const
Definition: base_struct.h:217
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
class ZONE_CONTAINER, managed by a footprint
Definition: typeinfo.h:95
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

References EDA_ITEM::GetParent(), PCB_MODULE_EDGE_T, PCB_MODULE_TEXT_T, PCB_MODULE_ZONE_AREA_T, PCB_PAD_T, PCB_ZONE_AREA_T, and EDA_ITEM::Type().

◆ Push()

void BOARD_COMMIT::Push ( const wxString &  aMessage = wxT("A commit"),
bool  aCreateUndoEntry = true,
bool  aSetDirtyBit = true 
)
overridevirtual

Executes the changes.

Implements COMMIT.

Definition at line 84 of file board_commit.cpp.

85 {
86  // Objects potentially interested in changes:
87  PICKED_ITEMS_LIST undoList;
88  KIGFX::VIEW* view = m_toolMgr->GetView();
89  BOARD* board = (BOARD*) m_toolMgr->GetModel();
91  auto connectivity = board->GetConnectivity();
92  std::set<EDA_ITEM*> savedModules;
94  bool itemsDeselected = false;
95 
96  if( Empty() )
97  return;
98 
99  for( COMMIT_LINE& ent : m_changes )
100  {
101  int changeType = ent.m_type & CHT_TYPE;
102  int changeFlags = ent.m_type & CHT_FLAGS;
103  BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
104 
105  // Module items need to be saved in the undo buffer before modification
106  if( m_editModules )
107  {
108  // Be sure that we are storing a module
109  if( ent.m_item->Type() != PCB_MODULE_T )
110  ent.m_item = ent.m_item->GetParent();
111 
112  // We have not saved the module yet, so let's create an entry
113  if( savedModules.count( ent.m_item ) == 0 )
114  {
115  if( !ent.m_copy )
116  {
117  wxASSERT( changeType != CHT_MODIFY ); // too late to make a copy..
118  ent.m_copy = ent.m_item->Clone();
119  }
120 
121  wxASSERT( ent.m_item->Type() == PCB_MODULE_T );
122  wxASSERT( ent.m_copy->Type() == PCB_MODULE_T );
123 
124  if( aCreateUndoEntry )
125  {
126  ITEM_PICKER itemWrapper( ent.m_item, UR_CHANGED );
127  itemWrapper.SetLink( ent.m_copy );
128  undoList.PushItem( itemWrapper );
129  frame->SaveCopyInUndoList( undoList, UR_CHANGED );
130  }
131 
132  savedModules.insert( ent.m_item );
133  static_cast<MODULE*>( ent.m_item )->SetLastEditTime();
134  }
135  }
136 
137  switch( changeType )
138  {
139  case CHT_ADD:
140  {
141  if( m_editModules )
142  {
143  // modules inside modules are not supported yet
144  wxASSERT( boardItem->Type() != PCB_MODULE_T );
145 
146  boardItem->SetParent( board->Modules().front() );
147 
148  if( !( changeFlags & CHT_DONE ) )
149  board->Modules().front()->Add( boardItem );
150  }
151  else if( boardItem->Type() == PCB_MODULE_TEXT_T ||
152  boardItem->Type() == PCB_MODULE_EDGE_T )
153  {
154  wxASSERT( boardItem->GetParent() &&
155  boardItem->GetParent()->Type() == PCB_MODULE_T );
156  }
157  else
158  {
159  if( aCreateUndoEntry )
160  undoList.PushItem( ITEM_PICKER( boardItem, UR_NEW ) );
161 
162  if( !( changeFlags & CHT_DONE ) )
163  board->Add( boardItem ); // handles connectivity
164  }
165 
166  view->Add( boardItem );
167  break;
168  }
169 
170  case CHT_REMOVE:
171  {
172  if( !m_editModules && aCreateUndoEntry )
173  undoList.PushItem( ITEM_PICKER( boardItem, UR_DELETED ) );
174 
175  if( boardItem->IsSelected() )
176  {
177  selTool->RemoveItemFromSel( boardItem, true /* quiet mode */ );
178  itemsDeselected = true;
179  }
180 
181  switch( boardItem->Type() )
182  {
183  // Module items
184  case PCB_PAD_T:
185  case PCB_MODULE_EDGE_T:
186  case PCB_MODULE_TEXT_T:
188  // This level can only handle module items when editing modules
189  wxASSERT( m_editModules );
190 
191  if( boardItem->Type() == PCB_MODULE_TEXT_T )
192  {
193  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( boardItem );
194 
195  // don't allow deletion of Reference or Value
196  if( text->GetType() != TEXTE_MODULE::TEXT_is_DIVERS )
197  break;
198  }
199 
200  view->Remove( boardItem );
201 
202  if( !( changeFlags & CHT_DONE ) )
203  {
204  MODULE* module = static_cast<MODULE*>( boardItem->GetParent() );
205  wxASSERT( module && module->Type() == PCB_MODULE_T );
206  module->Delete( boardItem );
207  }
208 
209  break;
210 
211  // Board items
212  case PCB_LINE_T: // a segment not on copper layers
213  case PCB_TEXT_T: // a text on a layer
214  case PCB_TRACE_T: // a track segment (segment on a copper layer)
215  case PCB_ARC_T: // an arced track segment (segment on a copper layer)
216  case PCB_VIA_T: // a via (like track segment on a copper layer)
217  case PCB_DIMENSION_T: // a dimension (graphic item)
218  case PCB_TARGET_T: // a target (graphic item)
219  case PCB_MARKER_T: // a marker used to show something
220  case PCB_ZONE_AREA_T:
221  view->Remove( boardItem );
222 
223  if( !( changeFlags & CHT_DONE ) )
224  board->Remove( boardItem );
225 
226  break;
227 
228  case PCB_MODULE_T:
229  {
230  // There are no modules inside a module yet
231  wxASSERT( !m_editModules );
232 
233  MODULE* module = static_cast<MODULE*>( boardItem );
234  view->Remove( module );
235  module->ClearFlags();
236 
237  if( !( changeFlags & CHT_DONE ) )
238  board->Remove( module ); // handles connectivity
239  }
240  break;
241 
242  default: // other types do not need to (or should not) be handled
243  wxASSERT( false );
244  break;
245  }
246 
247  break;
248  }
249 
250  case CHT_MODIFY:
251  {
252  if( !m_editModules && aCreateUndoEntry )
253  {
254  ITEM_PICKER itemWrapper( boardItem, UR_CHANGED );
255  wxASSERT( ent.m_copy );
256  itemWrapper.SetLink( ent.m_copy );
257  undoList.PushItem( itemWrapper );
258  }
259 
260  if( ent.m_copy )
261  connectivity->MarkItemNetAsDirty( static_cast<BOARD_ITEM*>( ent.m_copy ) );
262 
263  connectivity->Update( boardItem );
264  view->Update( boardItem );
265 
266  // if no undo entry is needed, the copy would create a memory leak
267  if( !aCreateUndoEntry )
268  delete ent.m_copy;
269 
270  break;
271  }
272 
273  default:
274  wxASSERT( false );
275  break;
276  }
277  }
278 
279  if ( !m_editModules )
280  {
281  size_t num_changes = m_changes.size();
282 
283  connectivity->RecalculateRatsnest( this );
284  connectivity->ClearDynamicRatsnest();
285  frame->GetCanvas()->RedrawRatsnest();
286 
287  if( m_changes.size() > num_changes )
288  {
289  for( size_t i = num_changes; i < m_changes.size(); ++i )
290  {
291  COMMIT_LINE& ent = m_changes[i];
292 
293  // This should only be modifications from the connectivity algo
294  wxASSERT( ( ent.m_type & CHT_TYPE ) == CHT_MODIFY );
295 
296  auto boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
297 
298  if( aCreateUndoEntry )
299  {
300  ITEM_PICKER itemWrapper( boardItem, UR_CHANGED );
301  wxASSERT( ent.m_copy );
302  itemWrapper.SetLink( ent.m_copy );
303  undoList.PushItem( itemWrapper );
304  }
305  else
306  {
307  delete ent.m_copy;
308  }
309 
310  view->Update( boardItem );
311  }
312  }
313  }
314 
315  if( !m_editModules && aCreateUndoEntry )
316  frame->SaveCopyInUndoList( undoList, UR_UNSPECIFIED );
317 
319 
320  if( itemsDeselected )
322 
323  if( aSetDirtyBit )
324  frame->OnModify();
325 
326  frame->UpdateMsgPanel();
327 
328  clear();
329 }
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:280
void clear()
Definition: commit.h:161
EDA_BASE_FRAME * GetEditFrame() const
Definition: tool_manager.h:298
bool IsSelected() const
Definition: base_struct.h:225
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:202
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
SELECTION_TOOL.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: commit.h:38
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
class ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:55
EDA_ITEM * GetModel() const
Definition: tool_manager.h:293
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
void RedrawRatsnest()
Forces refresh of the ratsnest visual representation
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
class MODULE, a footprint
Definition: typeinfo.h:89
MODULES & Modules()
Definition: class_board.h:229
TOOL_TYPE m_type
Stores the type of the tool.
Definition: tool_base.h:210
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:218
TEXT_TYPE GetType() const
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:306
void RemoveItemFromSel(BOARD_ITEM *aItem, bool aQuietMode=false)
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
All active tools
Definition: tool_event.h:147
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1540
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:100
bool Empty() const
Definition: commit.h:139
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:101
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
virtual void OnModify()
Function OnModify Virtual Must be called after a change in order to set the "modify" flag of the curr...
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:99
bool m_editModules
Definition: board_commit.h:56
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:163
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182
virtual void SaveCopyInUndoList(BOARD_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0))=0
Function SaveCopyInUndoList (virtual pure) Creates a new entry in undo list of commands.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:258
virtual void Delete(BOARD_ITEM *aItem)
Removes an item from the container and deletes it.
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
class ZONE_CONTAINER, managed by a footprint
Definition: typeinfo.h:95
VIEW.
Definition: view.h:61
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
BOARD_ITEM_CONTAINER * GetParent() const
void PostEvent(const TOOL_EVENT &aEvent)
Puts an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:267
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
void Remove(BOARD_ITEM *aBoardItem) override
Removes an item from the container.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
virtual void UpdateMsgPanel()
Redraw the message panel.

References KIGFX::VIEW::Add(), BOARD::Add(), AS_GLOBAL, CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, EDA_ITEM::ClearFlags(), BOARD_ITEM_CONTAINER::Delete(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetConnectivity(), BOARD_ITEM::GetParent(), TEXTE_MODULE::GetType(), EDA_ITEM::IsSelected(), COMMIT::COMMIT_LINE::m_copy, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_type, TOOL_BASE::m_type, BOARD::Modules(), PCB_BASE_FRAME::OnModify(), PCB_ARC_T, PCB_DIMENSION_T, PCB_LINE_T, PCB_MARKER_T, PCB_MODULE_EDGE_T, PCB_MODULE_T, PCB_MODULE_TEXT_T, PCB_MODULE_ZONE_AREA_T, PCB_PAD_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, PICKED_ITEMS_LIST::PushItem(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), KIGFX::VIEW::Remove(), BOARD::Remove(), SELECTION_TOOL::RemoveItemFromSel(), PCB_BASE_FRAME::SaveCopyInUndoList(), ITEM_PICKER::SetLink(), EDA_ITEM::SetParent(), TA_MODEL_CHANGE, TC_MESSAGE, TEXTE_MODULE::TEXT_is_DIVERS, EDA_ITEM::Type(), EVENTS::UnselectedEvent, KIGFX::VIEW::Update(), EDA_DRAW_FRAME::UpdateMsgPanel(), UR_CHANGED, UR_DELETED, UR_NEW, and UR_UNSPECIFIED.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), POINT_EDITOR::addCorner(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), DRC::addMarkerToPcb(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), AUTOPLACE_TOOL::autoplace(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createInductorBetween(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::drawSegment(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EnumeratePads(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), ARRAY_CREATOR::Invoke(), PCB_EDITOR_CONTROL::modifyLockSelected(), DIALOG_EXCHANGE_FOOTPRINTS::OnApplyClicked(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), POINT_EDITOR::OnSelectionChange(), PAD_TOOL::pastePadProperties(), ZONE_CREATE_HELPER::performZoneCutout(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), PAD_TOOL::pushPadSettings(), POINT_EDITOR::removeCorner(), PCB_EDIT_FRAME::ResolveDRCExclusions(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), DRAWING_TOOL::SetAnchor(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::UpdateNetlist(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), PCB_EDITOR_CONTROL::ZoneDuplicate(), PCB_EDITOR_CONTROL::ZoneMerge(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ Remove()

COMMIT& COMMIT::Remove ( EDA_ITEM aItem)
inlineinherited

Removes a new item from the model

Definition at line 90 of file commit.h.

91  {
92  return Stage( aItem, CHT_REMOVE );
93  }
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Adds a change of the item aItem of type aChangeType to the change list.
Definition: commit.cpp:46

References CHT_REMOVE, and COMMIT::Stage().

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), BOARD_NETLIST_UPDATER::deleteUnusedComponents(), PCB_EDIT_FRAME::Exchange_Module(), mergeZones(), ZONE_CREATE_HELPER::performZoneCutout(), and POINT_EDITOR::removeCorner().

◆ Removed()

COMMIT& COMMIT::Removed ( EDA_ITEM aItem)
inlineinherited

Notifies observers that aItem has been removed

Definition at line 96 of file commit.h.

97  {
98  return Stage( aItem, CHT_REMOVE | CHT_DONE );
99  }
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Adds a change of the item aItem of type aChangeType to the change list.
Definition: commit.cpp:46
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45

References CHT_DONE, CHT_REMOVE, and COMMIT::Stage().

Referenced by TRACKS_CLEANER::deleteDanglingTracks(), TRACKS_CLEANER::mergeCollinearSegments(), and TRACKS_CLEANER::removeItems().

◆ Revert()

void BOARD_COMMIT::Revert ( )
overridevirtual

Revertes the commit by restoring the modifed items state.

Implements COMMIT.

Definition at line 354 of file board_commit.cpp.

355 {
356  PICKED_ITEMS_LIST undoList;
357  KIGFX::VIEW* view = m_toolMgr->GetView();
358  BOARD* board = (BOARD*) m_toolMgr->GetModel();
359  auto connectivity = board->GetConnectivity();
360 
361  for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
362  {
363  COMMIT_LINE& ent = *it;
364  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
365  BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
366  int changeType = ent.m_type & CHT_TYPE;
367  int changeFlags = ent.m_type & CHT_FLAGS;
368 
369  switch( changeType )
370  {
371  case CHT_ADD:
372  if( !( changeFlags & CHT_DONE ) )
373  break;
374 
375  view->Remove( item );
376  connectivity->Remove( item );
377  board->Remove( item );
378  break;
379 
380  case CHT_REMOVE:
381  if( !( changeFlags & CHT_DONE ) )
382  break;
383 
384  view->Add( item );
385  connectivity->Add( item );
386  board->Add( item );
387  break;
388 
389  case CHT_MODIFY:
390  {
391  view->Remove( item );
392  connectivity->Remove( item );
393 
394  item->SwapData( copy );
395 
396  view->Add( item );
397  connectivity->Add( item );
398  delete copy;
399  break;
400  }
401 
402  default:
403  wxASSERT( false );
404  break;
405  }
406  }
407 
408  if ( !m_editModules )
409  connectivity->RecalculateRatsnest();
410 
412  selTool->RebuildSelection();
413 
414  clear();
415 }
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:280
void clear()
Definition: commit.h:161
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
SELECTION_TOOL.
Definition: commit.h:38
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:55
EDA_ITEM * GetModel() const
Definition: tool_manager.h:293
virtual void SwapData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:306
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
bool m_editModules
Definition: board_commit.h:56
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:163
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182
void RebuildSelection()
Rebuilds the selection from the EDA_ITEMs' selection flags.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
VIEW.
Definition: view.h:61
void Remove(BOARD_ITEM *aBoardItem) override
Removes an item from the container.

References KIGFX::VIEW::Add(), BOARD::Add(), CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, BOARD::GetConnectivity(), COMMIT::COMMIT_LINE::m_copy, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_type, SELECTION_TOOL::RebuildSelection(), KIGFX::VIEW::Remove(), BOARD::Remove(), and BOARD_ITEM::SwapData().

Referenced by AUTOPLACE_TOOL::autoplace(), PAD_TOOL::EnumeratePads(), POINT_EDITOR::OnSelectionChange(), and PCB_EDITOR_CONTROL::PlaceModule().

◆ Stage() [1/3]

COMMIT & BOARD_COMMIT::Stage ( EDA_ITEM aItem,
CHANGE_TYPE  aChangeType 
)
overridevirtual

Adds a change of the item aItem of type aChangeType to the change list.

Reimplemented from COMMIT.

Definition at line 59 of file board_commit.cpp.

60 {
61  // if aItem belongs a footprint, the full footprint will be saved
62  // because undo/redo does not handle "sub items" modifications
63  if( aItem && aItem->Type() != PCB_MODULE_T && aChangeType == CHT_MODIFY )
64  {
65  EDA_ITEM* item = aItem->GetParent();
66 
67  if( item && item->Type() == PCB_MODULE_T ) // means aItem belongs a footprint
68  aItem = item;
69  }
70 
71  return COMMIT::Stage( aItem, aChangeType );
72 }
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Adds a change of the item aItem of type aChangeType to the change list.
Definition: commit.cpp:46
class MODULE, a footprint
Definition: typeinfo.h:89
EDA_ITEM * GetParent() const
Definition: base_struct.h:217
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

References CHT_MODIFY, EDA_ITEM::GetParent(), PCB_MODULE_T, COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by PCB_EDIT_FRAME::Edit_Zone_Params().

◆ Stage() [2/3]

COMMIT & BOARD_COMMIT::Stage ( std::vector< EDA_ITEM * > &  container,
CHANGE_TYPE  aChangeType 
)
overridevirtual

Reimplemented from COMMIT.

Definition at line 74 of file board_commit.cpp.

75 {
76  return COMMIT::Stage( container, aChangeType );
77 }
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Adds a change of the item aItem of type aChangeType to the change list.
Definition: commit.cpp:46

References COMMIT::Stage().

◆ Stage() [3/3]

COMMIT & BOARD_COMMIT::Stage ( const PICKED_ITEMS_LIST aItems,
UNDO_REDO_T  aModFlag = UR_UNSPECIFIED 
)
overridevirtual

Reimplemented from COMMIT.

Definition at line 79 of file board_commit.cpp.

80 {
81  return COMMIT::Stage( aItems, aModFlag );
82 }
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Adds a change of the item aItem of type aChangeType to the change list.
Definition: commit.cpp:46

References COMMIT::Stage().

◆ StageItems()

template<class Range >
COMMIT& COMMIT::StageItems ( const Range &  aRange,
CHANGE_TYPE  aChangeType 
)
inlineinherited

Definition at line 116 of file commit.h.

117  {
118  for( const auto& item : aRange )
119  Stage( item, aChangeType );
120 
121  return *this;
122  }
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Adds a change of the item aItem of type aChangeType to the change list.
Definition: commit.cpp:46

References COMMIT::Stage().

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), and POINT_EDITOR::OnSelectionChange().

Member Data Documentation

◆ m_changedItems

std::set<EDA_ITEM*> COMMIT::m_changedItems
protectedinherited

Definition at line 181 of file commit.h.

Referenced by COMMIT::clear(), COMMIT::createModified(), COMMIT::makeEntry(), and COMMIT::Stage().

◆ m_changes

std::vector<COMMIT_LINE> COMMIT::m_changes
protectedinherited

◆ m_editModules

bool BOARD_COMMIT::m_editModules
private

Definition at line 56 of file board_commit.h.

◆ m_toolMgr

TOOL_MANAGER* BOARD_COMMIT::m_toolMgr
private

Definition at line 55 of file board_commit.h.


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