BOARD_COMMIT Class Reference

#include <board_commit.h>

Inheritance diagram for BOARD_COMMIT:

Public Member Functions
	BOARD_COMMIT (TOOL_MANAGER *aToolMgr)
	BOARD_COMMIT (EDA_DRAW_FRAME *aFrame)
	BOARD_COMMIT (PCB_TOOL_BASE *aTool)
virtual	~BOARD_COMMIT ()
BOARD *	GetBoard () const
virtual void	Push (const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
	Revert the commit by restoring the modified items state. More...
virtual void	Revert () override
COMMIT &	Stage (EDA_ITEM *aItem, CHANGE_TYPE aChangeType) override
COMMIT &	Stage (std::vector< EDA_ITEM * > &container, CHANGE_TYPE aChangeType) override
COMMIT &	Stage (const PICKED_ITEMS_LIST &aItems, UNDO_REDO aModFlag=UNDO_REDO::UNSPECIFIED) override
	Execute the changes. More...
COMMIT &	Add (EDA_ITEM *aItem)
	Notify observers that aItem has been added. More...
COMMIT &	Added (EDA_ITEM *aItem)
	Remove a new item from the model. More...
COMMIT &	Remove (EDA_ITEM *aItem)
	Notify observers that aItem has been removed. More...
COMMIT &	Removed (EDA_ITEM *aItem)
	Modify a given item in the model. More...
COMMIT &	Modify (EDA_ITEM *aItem)
	Create an undo entry for an item that has been already modified. More...
COMMIT &	Modified (EDA_ITEM *aItem, EDA_ITEM *aCopy)
template<class Range >
COMMIT &	StageItems (const Range &aRange, CHANGE_TYPE aChangeType)
	Add a change of the item aItem of type aChangeType to the change list. More...
bool	Empty () const
	Returns status of an item. More...
int	GetStatus (EDA_ITEM *aItem)

Protected Member Functions
void	clear ()
COMMIT &	createModified (EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
virtual void	makeEntry (EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=nullptr)
COMMIT_LINE *	findEntry (EDA_ITEM *aItem)
	Search for an entry describing change for a particular item. More...
CHANGE_TYPE	convert (UNDO_REDO aType) const

Protected Attributes
std::set< EDA_ITEM * >	m_changedItems
std::vector< COMMIT_LINE >	m_changes

Private Member Functions
EDA_ITEM *	parentObject (EDA_ITEM *aItem) const override
EDA_ITEM *	makeImage (EDA_ITEM *aItem) const override
void	dirtyIntersectingZones (BOARD_ITEM *item, int aChangeType)

Private Attributes
TOOL_MANAGER *	m_toolMgr
bool	m_isFootprintEditor
bool	m_isBoardEditor

Detailed Description

Definition at line 45 of file board_commit.h.

Constructor & Destructor Documentation

BOARD_COMMIT() [1/3]

BOARD_COMMIT::BOARD_COMMIT

(

TOOL_MANAGER *

aToolMgr

)

Definition at line 42 of file board_commit.cpp.

 :
 m_toolMgr( aToolMgr ),
 m_isFootprintEditor( false ),
 m_isBoardEditor( false )
{
}

BOARD_COMMIT() [2/3]

BOARD_COMMIT::BOARD_COMMIT

(

EDA_DRAW_FRAME *

aFrame

)

Definition at line 58 of file board_commit.cpp.

{
 m_toolMgr = aFrame->GetToolManager();
 m_isFootprintEditor = aFrame->IsType( FRAME_FOOTPRINT_EDITOR );
 m_isBoardEditor = aFrame->IsType( FRAME_PCB_EDITOR );
}

References FRAME_FOOTPRINT_EDITOR, FRAME_PCB_EDITOR, TOOLS_HOLDER::GetToolManager(), EDA_BASE_FRAME::IsType(), m_isBoardEditor, m_isFootprintEditor, and m_toolMgr.

BOARD_COMMIT() [3/3]

BOARD_COMMIT::BOARD_COMMIT

(

PCB_TOOL_BASE *

aTool

)

Definition at line 50 of file board_commit.cpp.

{
  m_toolMgr = aTool->GetManager();
 m_isFootprintEditor = aTool->IsFootprintEditor();
 m_isBoardEditor = aTool->IsBoardEditor();
}

References TOOL_BASE::GetManager(), PCB_TOOL_BASE::IsBoardEditor(), PCB_TOOL_BASE::IsFootprintEditor(), m_isBoardEditor, m_isFootprintEditor, and m_toolMgr.

~BOARD_COMMIT()

BOARD_COMMIT::~BOARD_COMMIT ( )

virtual

Definition at line 66 of file board_commit.cpp.

{
}

Member Function Documentation

Add()

COMMIT & COMMIT::Add ( EDA_ITEM *  aItem )

inlineinherited

Notify observers that aItem has been added.

Definition at line 78 of file commit.h.

References CHT_ADD, and COMMIT::Stage().

Referenced by PCB_GROUP::AddChildrenToCommit(), PCB_POINT_EDITOR::addCorner(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createInductorBetween(), CONVERT_TOOL::CreatePolys(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), DRAWING_TOOL::InteractivePlaceWithPreview(), ARRAY_CREATOR::Invoke(), GRAPHICS_CLEANER::mergeRects(), ZONE_CREATE_HELPER::performZoneCutout(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), INTERACTIVE_PLACER_BASE::PlaceItem(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), PCB_EDIT_FRAME::ResolveDRCExclusions(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_EDITOR_CONTROL::ZoneDuplicate().

Added()

COMMIT & COMMIT::Added ( EDA_ITEM *  aItem )

inlineinherited

Remove a new item from the model.

Definition at line 84 of file commit.h.

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

Referenced by TEARDROP_MANAGER::addTeardropsOnTracks(), PCB_EDIT_FRAME::RunActionPlugin(), and TEARDROP_MANAGER::SetTeardrops().

clear()

void COMMIT::clear ( )

inlineprotectedinherited

Definition at line 156 of file commit.h.

 {
 m_changedItems.clear();
 m_changes.clear();
 }

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

Referenced by Push(), and Revert().

convert()

CHANGE_TYPE COMMIT::convert ( UNDO_REDO  aType ) const

protectedinherited

Definition at line 184 of file commit.cpp.

{
 switch( aType )
 {
 case UNDO_REDO::NEWITEM:
 return CHT_ADD;
 
 case UNDO_REDO::DELETED:
 return CHT_REMOVE;
 
 default:
 assert( false );
 // Can't fall through if the assert fires, so quiet our warning
#ifdef NDEBUG
 KI_FALLTHROUGH;
#endif
 
 case UNDO_REDO::CHANGED:
 return CHT_MODIFY;
 }
}

References CHANGED, CHT_ADD, CHT_MODIFY, CHT_REMOVE, DELETED, KI_FALLTHROUGH, and NEWITEM.

Referenced by COMMIT::Stage().

createModified()

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

protectedinherited

Definition at line 131 of file commit.cpp.

{
 EDA_ITEM* parent = parentObject( aItem );
 auto entryIt = m_changedItems.find( parent );
 
 if( entryIt != m_changedItems.end() )
 {
 delete aCopy;
 return *this; // item has been already modified once
 }
 
 makeEntry( parent, CHT_MODIFY | aExtraFlags, aCopy );
 
 return *this;
}

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

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

dirtyIntersectingZones()

void BOARD_COMMIT::dirtyIntersectingZones ( BOARD_ITEM *  item, int  aChangeType  )

private

Definition at line 141 of file board_commit.cpp.

{
 wxCHECK( item, /* void */ );
 
 ZONE_FILLER_TOOL* zoneFillerTool = m_toolMgr->GetTool<ZONE_FILLER_TOOL>();
 
 if( item->Type() == PCB_ZONE_T || item->Type() == PCB_FP_ZONE_T )
 zoneFillerTool->DirtyZone( static_cast<ZONE*>( item ) );
 
 if( item->Type() == PCB_FOOTPRINT_T )
 {
 static_cast<FOOTPRINT*>( item )->RunOnChildren(
 [&]( BOARD_ITEM* child )
 {
 if( aChangeType != CHT_MODIFY || ( child->GetFlags() & IS_MODIFIED_CHILD ) )
 dirtyIntersectingZones( child, aChangeType );
 
 child->ClearFlags( IS_MODIFIED_CHILD );
 } );
 }
 else if( item->Type() == PCB_GROUP_T )
 {
 static_cast<PCB_GROUP*>( item )->RunOnChildren(
 [&]( BOARD_ITEM* child )
 {
 dirtyIntersectingZones( child, aChangeType );
 child->ClearFlags( IS_MODIFIED_CHILD );
 } );
 }
 else
 {
 BOARD* board = static_cast<BOARD*>( m_toolMgr->GetModel() );
 BOX2I bbox = item->GetBoundingBox();
 LSET layers = item->GetLayerSet();
 
 if( layers.test( Edge_Cuts ) || layers.test( Margin ) )
 layers = LSET::PhysicalLayersMask();
 else
 layers &= LSET::AllCuMask();
 
 if( layers.any() )
 {
 for( ZONE* zone : board->Zones() )
 {
 if( zone->GetIsRuleArea() )
 continue;
 
 if( ( zone->GetLayerSet() & layers ).any()
 && zone->GetBoundingBox().Intersects( bbox ) )
 {
 zoneFillerTool->DirtyZone( zone );
 }
 }
 }
 
 item->ClearFlags( IS_MODIFIED_CHILD );
 }
}

References LSET::AllCuMask(), CHT_MODIFY, EDA_ITEM::ClearFlags(), dirtyIntersectingZones(), ZONE_FILLER_TOOL::DirtyZone(), Edge_Cuts, EDA_ITEM::GetBoundingBox(), EDA_ITEM::GetFlags(), BOARD_ITEM::GetLayerSet(), TOOL_MANAGER::GetModel(), TOOL_MANAGER::GetTool(), IS_MODIFIED_CHILD, m_toolMgr, Margin, PCB_FOOTPRINT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_ZONE_T, LSET::PhysicalLayersMask(), EDA_ITEM::Type(), and BOARD::Zones().

Referenced by dirtyIntersectingZones(), and Push().

Empty()

bool COMMIT::Empty ( ) const

inlineinherited

Returns status of an item.

Definition at line 139 of file commit.h.

References COMMIT::m_changes.

Referenced by DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), and Push().

findEntry()

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

protectedinherited

Search for an entry describing change for a particular item.

Returns

null if there is no related entry.

Definition at line 172 of file commit.cpp.

{
 for( COMMIT_LINE& change : m_changes )
 {
 if( change.m_item == aItem )
 return &change;
 }
 
 return nullptr;
}

References COMMIT::m_changes.

Referenced by COMMIT::GetStatus().

GetBoard()

BOARD * BOARD_COMMIT::GetBoard

(

)

const

Definition at line 71 of file board_commit.cpp.

{
 return static_cast<BOARD*>( m_toolMgr->GetModel() );
}

References TOOL_MANAGER::GetModel(), and m_toolMgr.

Referenced by GRAPHICS_CLEANER::CleanupBoard().

GetStatus()

int COMMIT::GetStatus ( EDA_ITEM *  aItem )

inherited

Definition at line 123 of file commit.cpp.

{
 COMMIT_LINE* entry = findEntry( parentObject( aItem ) );
 
 return entry ? entry->m_type : 0;
}

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

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

makeEntry()

void COMMIT::makeEntry ( EDA_ITEM *  aItem, CHANGE_TYPE  aType, EDA_ITEM *  aCopy = nullptr  )

protectedvirtualinherited

Definition at line 148 of file commit.cpp.

{
 // Expect an item copy if it is going to be modified
 wxASSERT( !!aCopy == ( ( aType & CHT_TYPE ) == CHT_MODIFY ) );
 
  if( m_changedItems.find( aItem ) != m_changedItems.end() )
 {
 alg::delete_if( m_changes, [aItem]( const COMMIT_LINE& aEnt )
 {
 return aEnt.m_item == aItem;
 } );
 }
 
 COMMIT_LINE ent;
 
 ent.m_item = aItem;
 ent.m_type = aType;
 ent.m_copy = aCopy;
 
 m_changedItems.insert( aItem );
 m_changes.push_back( ent );
}

References CHT_MODIFY, CHT_TYPE, alg::delete_if(), 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().

makeImage()

EDA_ITEM * BOARD_COMMIT::makeImage ( EDA_ITEM *  aItem ) const

overrideprivatevirtual

Implements COMMIT.

Definition at line 667 of file board_commit.cpp.

{
 BOARD_ITEM* clone = static_cast<BOARD_ITEM*>( aItem->Clone() );
 
 clone->SetParentGroup( nullptr );
 return clone;
}

References EDA_ITEM::Clone(), and BOARD_ITEM::SetParentGroup().

Referenced by Push().

Modified()

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

inlineinherited

Definition at line 110 of file commit.h.

 {
 return createModified( aItem, aCopy );
 }

References COMMIT::createModified().

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

Modify()

COMMIT & COMMIT::Modify ( EDA_ITEM *  aItem )

inlineinherited

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

Requires a copy done before the modification.

Definition at line 103 of file commit.h.

References CHT_MODIFY, and COMMIT::Stage().

Referenced by PCB_POINT_EDITOR::addCorner(), AR_AUTOPLACER::AutoplaceFootprints(), doPushPadProperties(), DRAWING_TOOL::DrawVia(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), ZONE_FILLER::Fill(), ARRAY_CREATOR::Invoke(), TRACKS_CLEANER::mergeCollinearSegments(), mergeZones(), BOARD_EDITOR_CONTROL::modifyLockSelected(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PAD_TOOL::pastePadProperties(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), CN_CONNECTIVITY_ALGO::propagateConnections(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), PAD_TOOL::RecombinePad(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), DRAWING_TOOL::SetAnchor(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_UNUSED_PAD_LAYERS::updatePadsAndVias(), PCB_PROPERTIES_PANEL::valueChanged(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_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 639 of file board_commit.cpp.

{
 switch( aItem->Type() )
 {
 case PCB_PAD_T:
 case PCB_FP_SHAPE_T:
 case PCB_FP_TEXT_T:
 case PCB_FP_TEXTBOX_T:
 case PCB_FP_DIM_ALIGNED_T:
 case PCB_FP_DIM_LEADER_T:
 case PCB_FP_DIM_CENTER_T:
 case PCB_FP_DIM_RADIAL_T:
 case PCB_FP_DIM_ORTHOGONAL_T:
 case PCB_FP_ZONE_T:
 return aItem->GetParent();
 
 case PCB_ZONE_T:
 wxASSERT( !dynamic_cast<FOOTPRINT*>( aItem->GetParent() ) );
 return aItem;
 
 default:
 break;
 }
 
 return aItem;
}

References EDA_ITEM::GetParent(), PCB_FP_DIM_ALIGNED_T, PCB_FP_DIM_CENTER_T, PCB_FP_DIM_LEADER_T, PCB_FP_DIM_ORTHOGONAL_T, PCB_FP_DIM_RADIAL_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_FP_ZONE_T, PCB_PAD_T, PCB_ZONE_T, and EDA_ITEM::Type().

Push()

void BOARD_COMMIT::Push ( const wxString &  aMessage = wxT("A commit"), int  aFlags = 0  )

overridevirtual

Revert the commit by restoring the modified items state.

Implements COMMIT.

Definition at line 201 of file board_commit.cpp.

{
 // Objects potentially interested in changes:
 PICKED_ITEMS_LIST undoList;
 KIGFX::VIEW* view = m_toolMgr->GetView();
 BOARD* board = static_cast<BOARD*>( m_toolMgr->GetModel() );
 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
 std::set<EDA_ITEM*> savedModules;
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 bool itemsDeselected = false;
 bool solderMaskDirty = false;
 bool autofillZones = false;
 bool selectedModified = false;
 
 if( Empty() )
 return;
 
 std::shared_ptr<CONNECTIVITY_DATA> connectivity = board->GetConnectivity();
 
 // Note:
 // frame == nullptr happens in QA tests
 // in this case m_isBoardEditor and m_isFootprintEditor are set to false
 // But we also test frame == nullptr mainly to make Coverity happy
 
 std::vector<BOARD_ITEM*> bulkAddedItems;
 std::vector<BOARD_ITEM*> bulkRemovedItems;
 std::vector<BOARD_ITEM*> itemsChanged;
 
 if( m_isBoardEditor
 && !( aCommitFlags & ZONE_FILL_OP )
 && ( frame && frame->GetPcbNewSettings()->m_AutoRefillZones ) )
 {
 autofillZones = true;
 
 for( ZONE* zone : board->Zones() )
 zone->CacheBoundingBox();
 }
 
 for( COMMIT_LINE& ent : m_changes )
 {
 int changeType = ent.m_type & CHT_TYPE;
 int changeFlags = ent.m_type & CHT_FLAGS;
 BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
 
 wxASSERT( ent.m_item );
 
 // Module items need to be saved in the undo buffer before modification
 if( m_isFootprintEditor )
 {
 // Be sure that we are storing a footprint
 if( ent.m_item->Type() != PCB_FOOTPRINT_T )
 {
 ent.m_item = ent.m_item->GetParent();
 wxASSERT( ent.m_item );
 }
 
 // We have not saved the footprint yet, so let's create an entry
 if( savedModules.count( ent.m_item ) == 0 )
 {
 if( !ent.m_copy )
 {
 wxASSERT( changeType != CHT_MODIFY ); // too late to make a copy..
 ent.m_copy = makeImage( ent.m_item );
 }
 
 wxASSERT( ent.m_item->Type() == PCB_FOOTPRINT_T );
 wxASSERT( ent.m_copy->Type() == PCB_FOOTPRINT_T );
 
 if( !( aCommitFlags & SKIP_UNDO ) && frame )
 {
 ITEM_PICKER itemWrapper( nullptr, ent.m_item, UNDO_REDO::CHANGED );
 itemWrapper.SetLink( ent.m_copy );
 undoList.PushItem( itemWrapper );
 frame->SaveCopyInUndoList( undoList, UNDO_REDO::CHANGED );
 }
 
 savedModules.insert( ent.m_item );
 }
 }
 
 if( boardItem->Type() == PCB_VIA_T || boardItem->Type() == PCB_FOOTPRINT_T
 || boardItem->IsOnLayer( F_Mask ) || boardItem->IsOnLayer( B_Mask ) )
 {
 solderMaskDirty = true;
 }
 
 if( boardItem->IsSelected() )
 selectedModified = true;
 
 // If we're the footprint editor, the boardItem will always be the containing footprint
 if( m_isFootprintEditor && boardItem->Type() == PCB_FOOTPRINT_T )
 {
 static_cast<FOOTPRINT*>( boardItem )->RunOnChildren(
 [&selectedModified]( BOARD_ITEM* aItem )
 {
 if( aItem->HasFlag( IS_MODIFIED_CHILD ) )
 selectedModified = true;
 } );
 }
 
 switch( changeType )
 {
 case CHT_ADD:
  {
 if( selTool && selTool->GetEnteredGroup() && !boardItem->GetParentGroup()
 && PCB_GROUP::IsGroupableType( boardItem->Type() ) )
 {
 selTool->GetEnteredGroup()->AddItem( boardItem );
 }
 
 if( m_isFootprintEditor )
 {
 // footprints inside footprints are not supported yet
 wxASSERT( boardItem->Type() != PCB_FOOTPRINT_T );
 
 boardItem->SetParent( board->Footprints().front() );
 
 if( !( changeFlags & CHT_DONE ) )
 board->Footprints().front()->Add( boardItem );
 }
 else if( boardItem->Type() == PCB_PAD_T
 || boardItem->Type() == PCB_FP_TEXT_T
 || boardItem->Type() == PCB_FP_TEXTBOX_T
 || boardItem->Type() == PCB_FP_SHAPE_T
 || boardItem->Type() == PCB_FP_DIM_ALIGNED_T
 || boardItem->Type() == PCB_FP_DIM_LEADER_T
 || boardItem->Type() == PCB_FP_DIM_CENTER_T
 || boardItem->Type() == PCB_FP_DIM_RADIAL_T
 || boardItem->Type() == PCB_FP_DIM_ORTHOGONAL_T
 || boardItem->Type() == PCB_FP_ZONE_T )
 {
 wxASSERT( boardItem->GetParent() &&
 boardItem->GetParent()->Type() == PCB_FOOTPRINT_T );
 }
 else
 {
 if( !( aCommitFlags & SKIP_UNDO ) )
 undoList.PushItem( ITEM_PICKER( nullptr, boardItem, UNDO_REDO::NEWITEM ) );
 
 if( !( changeFlags & CHT_DONE ) )
 {
 board->Add( boardItem, ADD_MODE::BULK_INSERT ); // handles connectivity
 bulkAddedItems.push_back( boardItem );
 }
 }
 
 if( autofillZones && boardItem->Type() != PCB_MARKER_T )
 dirtyIntersectingZones( boardItem, changeType );
 
 if( view && boardItem->Type() != PCB_NETINFO_T )
 view->Add( boardItem );
 
 break;
 }
 
 case CHT_REMOVE:
 {
 PCB_GROUP* parentGroup = boardItem->GetParentGroup();
 
 if( !m_isFootprintEditor && !( aCommitFlags & SKIP_UNDO ) )
 undoList.PushItem( ITEM_PICKER( nullptr, boardItem, UNDO_REDO::DELETED ) );
 
 if( boardItem->IsSelected() )
 {
 if( selTool )
 selTool->RemoveItemFromSel( boardItem, true /* quiet mode */ );
 
 itemsDeselected = true;
 }
 
 if( parentGroup && !( parentGroup->GetFlags() & STRUCT_DELETED ) )
 parentGroup->RemoveItem( boardItem );
 
 if( autofillZones )
 dirtyIntersectingZones( boardItem, changeType );
 
 switch( boardItem->Type() )
 {
 // Footprint items
 case PCB_PAD_T:
 case PCB_FP_SHAPE_T:
 case PCB_FP_TEXT_T:
 case PCB_FP_TEXTBOX_T:
 case PCB_FP_DIM_ALIGNED_T:
 case PCB_FP_DIM_LEADER_T:
 case PCB_FP_DIM_CENTER_T:
 case PCB_FP_DIM_RADIAL_T:
 case PCB_FP_DIM_ORTHOGONAL_T:
 case PCB_FP_ZONE_T:
 // This level can only handle footprint children in the footprint editor as
 // only in that case has the entire footprint (and all its children) already
 // been saved for undo.
 wxASSERT( m_isFootprintEditor );
 
 if( boardItem->Type() == PCB_FP_TEXT_T )
 {
 FP_TEXT* text = static_cast<FP_TEXT*>( boardItem );
 
 // don't allow deletion of Reference or Value
 if( text->GetType() != FP_TEXT::TEXT_is_DIVERS )
 break;
 }
 
 if( view )
 view->Remove( boardItem );
 
 if( !( changeFlags & CHT_DONE ) )
 {
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( boardItem->GetParent() );
 wxASSERT( footprint && footprint->Type() == PCB_FOOTPRINT_T );
 footprint->Delete( boardItem );
 }
 
 break;
 
 // Board items
 case PCB_SHAPE_T: // a shape (normally not on copper layers)
 case PCB_BITMAP_T: // a bitmap on a user layer
 case PCB_TEXT_T: // a text on a layer
 case PCB_TEXTBOX_T: // a wrapped text on a layer
 case PCB_TRACE_T: // a track segment (segment on a copper layer)
 case PCB_ARC_T: // an arced track segment (segment on a copper layer)
 case PCB_VIA_T: // a via (like track segment on a copper layer)
 case PCB_DIM_ALIGNED_T: // a dimension (graphic item)
 case PCB_DIM_CENTER_T:
 case PCB_DIM_RADIAL_T:
 case PCB_DIM_ORTHOGONAL_T:
 case PCB_DIM_LEADER_T: // a leader dimension
 case PCB_TARGET_T: // a target (graphic item)
 case PCB_MARKER_T: // a marker used to show something
 case PCB_ZONE_T:
 if( view )
 view->Remove( boardItem );
 
 if( !( changeFlags & CHT_DONE ) )
 {
 board->Remove( boardItem, REMOVE_MODE::BULK );
 bulkRemovedItems.push_back( boardItem );
 }
 
 break;
 
 case PCB_FOOTPRINT_T:
 {
 // No support for nested footprints (yet)
 wxASSERT( !m_isFootprintEditor );
 
 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( boardItem );
 
 if( view )
 view->Remove( footprint );
 
 footprint->ClearFlags();
 
 if( !( changeFlags & CHT_DONE ) )
 {
 board->Remove( footprint, REMOVE_MODE::BULK ); // handles connectivity
 bulkRemovedItems.push_back( footprint );
 }
 }
 
 break;
 
 case PCB_GROUP_T:
 if( view )
 view->Remove( boardItem );
 
 if( !( changeFlags & CHT_DONE ) )
 {
 if( m_isFootprintEditor )
 board->GetFirstFootprint()->Remove( boardItem );
 else
 {
 board->Remove( boardItem, REMOVE_MODE::BULK );
 bulkRemovedItems.push_back( boardItem );
 }
 }
 
 break;
 
 // Metadata items
 case PCB_NETINFO_T:
 board->Remove( boardItem, REMOVE_MODE::BULK );
 bulkRemovedItems.push_back( boardItem );
 break;
 
 default: // other types do not need to (or should not) be handled
 wxASSERT( false );
 break;
 }
 
 break;
 }
 
 case CHT_MODIFY:
 {
 if( !m_isFootprintEditor && !( aCommitFlags & SKIP_UNDO ) )
 {
 ITEM_PICKER itemWrapper( nullptr, boardItem, UNDO_REDO::CHANGED );
 wxASSERT( ent.m_copy );
 itemWrapper.SetLink( ent.m_copy );
 undoList.PushItem( itemWrapper );
 }
 
 if( !( aCommitFlags & SKIP_CONNECTIVITY ) )
 {
 if( ent.m_copy )
 connectivity->MarkItemNetAsDirty( static_cast<BOARD_ITEM*>( ent.m_copy ) );
 
 connectivity->Update( boardItem );
 }
 
 if( autofillZones )
 {
 dirtyIntersectingZones( static_cast<BOARD_ITEM*>( ent.m_copy ), changeType ); // before
 dirtyIntersectingZones( boardItem, changeType ); // after
 }
 
 if( view )
 {
 view->Update( boardItem );
 
 if( m_isFootprintEditor )
 {
 static_cast<FOOTPRINT*>( boardItem )->RunOnChildren(
 [&]( BOARD_ITEM* aChild )
 {
 view->Update( aChild );
 });
 }
 }
 
 itemsChanged.push_back( boardItem );
 
 // if no undo entry is needed, the copy would create a memory leak
 if( aCommitFlags & SKIP_UNDO )
 delete ent.m_copy;
 
 break;
 }
 
 default:
 wxASSERT( false );
 break;
 }
 }
 
 if( bulkAddedItems.size() > 0 )
 board->FinalizeBulkAdd( bulkAddedItems );
 
 if( bulkRemovedItems.size() > 0 )
 board->FinalizeBulkRemove( bulkRemovedItems );
 
 if( itemsChanged.size() > 0 )
 board->OnItemsChanged( itemsChanged );
 
 if( m_isBoardEditor )
 {
 size_t num_changes = m_changes.size();
 
 if( aCommitFlags & SKIP_CONNECTIVITY )
 {
 connectivity->ClearRatsnest();
 connectivity->ClearLocalRatsnest();
 }
 else
 {
 connectivity->RecalculateRatsnest( this );
 board->UpdateRatsnestExclusions();
 connectivity->ClearLocalRatsnest();
 
 if( frame )
 frame->GetCanvas()->RedrawRatsnest();
 }
 
 if( solderMaskDirty )
 {
 if( frame )
 frame->HideSolderMask();
 }
 
 // Log undo items for any connectivity changes
 for( size_t i = num_changes; i < m_changes.size(); ++i )
 {
 COMMIT_LINE& ent = m_changes[i];
 
 wxASSERT( ( ent.m_type & CHT_TYPE ) == CHT_MODIFY );
 
 BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
 
 if( !( aCommitFlags & SKIP_UNDO ) )
 {
 ITEM_PICKER itemWrapper( nullptr, boardItem, UNDO_REDO::CHANGED );
 wxASSERT( ent.m_copy );
 itemWrapper.SetLink( ent.m_copy );
 undoList.PushItem( itemWrapper );
 }
 else
 {
 delete ent.m_copy;
 }
 
 if( view )
 view->Update( boardItem );
 }
 }
 
 if( m_isBoardEditor && !( aCommitFlags & SKIP_UNDO ) && frame )
 {
 if( aCommitFlags & APPEND_UNDO )
 frame->AppendCopyToUndoList( undoList, UNDO_REDO::UNSPECIFIED );
 else
 frame->SaveCopyInUndoList( undoList, UNDO_REDO::UNSPECIFIED );
 }
 
 m_toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
 
 if( itemsDeselected )
 m_toolMgr->PostEvent( EVENTS::UnselectedEvent );
 
 if( autofillZones )
 m_toolMgr->RunAction( PCB_ACTIONS::zoneFillDirty );
 
 if( selectedModified )
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 
 if( frame )
 {
 if( !( aCommitFlags & SKIP_SET_DIRTY ) )
 frame->OnModify();
 else
 frame->Update3DView( true, frame->GetPcbNewSettings()->m_Display.m_Live3DRefresh );
 }
 
 clear();
}

References BOARD::Add(), KIGFX::VIEW::Add(), PCB_GROUP::AddItem(), APPEND_UNDO, PCB_BASE_FRAME::AppendCopyToUndoList(), AS_GLOBAL, B_Mask, BULK, BULK_INSERT, CHANGED, CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, COMMIT::clear(), EDA_ITEM::ClearFlags(), BOARD_ITEM_CONTAINER::Delete(), DELETED, dirtyIntersectingZones(), COMMIT::Empty(), F_Mask, BOARD::FinalizeBulkAdd(), BOARD::FinalizeBulkRemove(), BOARD::Footprints(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetConnectivity(), PCB_SELECTION_TOOL::GetEnteredGroup(), BOARD::GetFirstFootprint(), EDA_ITEM::GetFlags(), TOOL_MANAGER::GetModel(), BOARD_ITEM::GetParent(), BOARD_ITEM::GetParentGroup(), PCB_BASE_FRAME::GetPcbNewSettings(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetToolHolder(), TOOL_MANAGER::GetView(), EDA_ITEM::HasFlag(), PCB_BASE_FRAME::HideSolderMask(), IS_MODIFIED_CHILD, PCB_GROUP::IsGroupableType(), BOARD_ITEM::IsOnLayer(), EDA_ITEM::IsSelected(), PCBNEW_SETTINGS::m_AutoRefillZones, COMMIT::m_changes, COMMIT::COMMIT_LINE::m_copy, PCBNEW_SETTINGS::m_Display, m_isBoardEditor, m_isFootprintEditor, COMMIT::COMMIT_LINE::m_item, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_Live3DRefresh, m_toolMgr, COMMIT::COMMIT_LINE::m_type, makeImage(), NEWITEM, BOARD::OnItemsChanged(), PCB_BASE_FRAME::OnModify(), PCB_ARC_T, PCB_BITMAP_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FOOTPRINT_T, PCB_FP_DIM_ALIGNED_T, PCB_FP_DIM_CENTER_T, PCB_FP_DIM_LEADER_T, PCB_FP_DIM_ORTHOGONAL_T, PCB_FP_DIM_RADIAL_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_MARKER_T, PCB_NETINFO_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, TOOL_MANAGER::PostEvent(), TOOL_MANAGER::ProcessEvent(), PICKED_ITEMS_LIST::PushItem(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), BOARD::Remove(), FOOTPRINT::Remove(), KIGFX::VIEW::Remove(), PCB_GROUP::RemoveItem(), SELECTION_TOOL::RemoveItemFromSel(), TOOL_MANAGER::RunAction(), PCB_BASE_FRAME::SaveCopyInUndoList(), EVENTS::SelectedItemsModified, ITEM_PICKER::SetLink(), EDA_ITEM::SetParent(), SKIP_CONNECTIVITY, SKIP_SET_DIRTY, SKIP_UNDO, STRUCT_DELETED, TA_MODEL_CHANGE, TC_MESSAGE, text, FP_TEXT::TEXT_is_DIVERS, EDA_ITEM::Type(), EVENTS::UnselectedEvent, UNSPECIFIED, KIGFX::VIEW::Update(), PCB_BASE_FRAME::Update3DView(), BOARD::UpdateRatsnestExclusions(), ZONE_FILL_OP, PCB_ACTIONS::zoneFillDirty, and BOARD::Zones().

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), AUTOPLACE_TOOL::autoplace(), ZONE_FILLER_TOOL::CheckAllZones(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createInductorBetween(), CONVERT_TOOL::CreatePolys(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), ZONE_FILLER_TOOL::FillAllZones(), KI_TEST::FillZones(), DRAWING_TOOL::InteractivePlaceWithPreview(), ARRAY_CREATOR::Invoke(), BOARD_EDITOR_CONTROL::modifyLockSelected(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_EDIT_FRAME::OpenProjectFiles(), PAD_TOOL::pastePadProperties(), ZONE_CREATE_HELPER::performZoneCutout(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), PAD_TOOL::pushPadSettings(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), TEARDROP_MANAGER::RemoveTeardrops(), PCB_EDIT_FRAME::ResolveDRCExclusions(), PCB_EDIT_FRAME::RunActionPlugin(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), DRAWING_TOOL::SetAnchor(), TEARDROP_MANAGER::SetTeardrops(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::UpdateNetlist(), PCB_PROPERTIES_PANEL::valueChanged(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillDirty(), BOARD_EDITOR_CONTROL::ZoneMerge(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

Remove()

COMMIT & COMMIT::Remove ( EDA_ITEM *  aItem )

inlineinherited

Notify observers that aItem has been removed.

Definition at line 90 of file commit.h.

References CHT_REMOVE, and COMMIT::Stage().

Referenced by GRAPHICS_CLEANER::cleanupShapes(), CONVERT_TOOL::CreatePolys(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_EDIT_FRAME::ExchangeFootprint(), GRAPHICS_CLEANER::mergeRects(), mergeZones(), ZONE_CREATE_HELPER::performZoneCutout(), PAD_TOOL::RecombinePad(), PCB_POINT_EDITOR::removeCorner(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

Removed()

COMMIT & COMMIT::Removed ( EDA_ITEM *  aItem )

inlineinherited

Modify a given item in the model.

Must be called before modification is performed.

Definition at line 96 of file commit.h.

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

Referenced by TRACKS_CLEANER::deleteDanglingTracks(), TRACKS_CLEANER::mergeCollinearSegments(), TRACKS_CLEANER::removeItems(), TEARDROP_MANAGER::RemoveTeardrops(), PCB_EDIT_FRAME::RunActionPlugin(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

Revert()

void BOARD_COMMIT::Revert ( )

overridevirtual

Implements COMMIT.

Definition at line 676 of file board_commit.cpp.

{
 PICKED_ITEMS_LIST undoList;
 KIGFX::VIEW* view = m_toolMgr->GetView();
 BOARD* board = (BOARD*) m_toolMgr->GetModel();
 std::shared_ptr<CONNECTIVITY_DATA> connectivity = board->GetConnectivity();
 
 board->IncrementTimeStamp(); // clear caches
 
 std::vector<BOARD_ITEM*> bulkAddedItems;
 std::vector<BOARD_ITEM*> bulkRemovedItems;
 std::vector<BOARD_ITEM*> itemsChanged;
 
 for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
 {
 COMMIT_LINE& ent = *it;
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
 BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
 int changeType = ent.m_type & CHT_TYPE;
 int changeFlags = ent.m_type & CHT_FLAGS;
 
 switch( changeType )
 {
 case CHT_ADD:
 if( !( changeFlags & CHT_DONE ) )
 break;
 
 view->Remove( item );
 connectivity->Remove( item );
 board->Remove( item, REMOVE_MODE::BULK );
 bulkRemovedItems.push_back( item );
 break;
 
 case CHT_REMOVE:
 if( !( changeFlags & CHT_DONE ) )
 break;
 
 view->Add( item );
 connectivity->Add( item );
 board->Add( item, ADD_MODE::INSERT );
 bulkAddedItems.push_back( item );
 break;
 
 case CHT_MODIFY:
 {
 view->Remove( item );
 connectivity->Remove( item );
 
 item->SwapItemData( copy );
 
 if( item->Type() == PCB_GROUP_T )
 {
 PCB_GROUP* group = static_cast<PCB_GROUP*>( item );
 
 group->RunOnChildren( [&]( BOARD_ITEM* child )
 {
 child->SetParentGroup( group );
 } );
 }
 
 view->Add( item );
 connectivity->Add( item );
 board->OnItemChanged( item );
 itemsChanged.push_back( item );
 
 delete copy;
 break;
 }
 
 default:
 wxASSERT( false );
 break;
 }
 }
 
 if( bulkAddedItems.size() > 0 )
 board->FinalizeBulkAdd( bulkAddedItems );
 
 if( bulkRemovedItems.size() > 0 )
 board->FinalizeBulkRemove( bulkRemovedItems );
 
 if( itemsChanged.size() > 0 )
 board->OnItemsChanged( itemsChanged );
 
 if ( !m_isFootprintEditor )
 {
 connectivity->RecalculateRatsnest();
 board->UpdateRatsnestExclusions();
 }
 
 PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 selTool->RebuildSelection();
 
 clear();
}

References BOARD::Add(), KIGFX::VIEW::Add(), BULK, CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, COMMIT::clear(), copy, BOARD::FinalizeBulkAdd(), BOARD::FinalizeBulkRemove(), BOARD::GetConnectivity(), TOOL_MANAGER::GetModel(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetView(), group, BOARD::IncrementTimeStamp(), INSERT, COMMIT::m_changes, COMMIT::COMMIT_LINE::m_copy, m_isFootprintEditor, COMMIT::COMMIT_LINE::m_item, m_toolMgr, COMMIT::COMMIT_LINE::m_type, BOARD::OnItemChanged(), BOARD::OnItemsChanged(), PCB_GROUP_T, PCB_SELECTION_TOOL::RebuildSelection(), BOARD::Remove(), KIGFX::VIEW::Remove(), BOARD_ITEM::SetParentGroup(), BOARD_ITEM::SwapItemData(), EDA_ITEM::Type(), and BOARD::UpdateRatsnestExclusions().

Referenced by AUTOPLACE_TOOL::autoplace(), ZONE_FILLER_TOOL::CheckAllZones(), PAD_TOOL::EnumeratePads(), ZONE_FILLER_TOOL::FillAllZones(), mergeZones(), PCB_POINT_EDITOR::OnSelectionChange(), BOARD_EDITOR_CONTROL::PlaceFootprint(), ZONE_FILLER_TOOL::ZoneFill(), and ZONE_FILLER_TOOL::ZoneFillDirty().

Stage() [1/3]

COMMIT & BOARD_COMMIT::Stage ( const PICKED_ITEMS_LIST &  aItems, UNDO_REDO  aModFlag = UNDO_REDO::UNSPECIFIED  )

overridevirtual

Execute the changes.

Reimplemented from COMMIT.

Definition at line 135 of file board_commit.cpp.

{
 return COMMIT::Stage( aItems, aModFlag );
}

References COMMIT::Stage().

Stage() [2/3]

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

overridevirtual

Reimplemented from COMMIT.

Definition at line 77 of file board_commit.cpp.

{
 wxCHECK( aItem, *this );
 
 aItem->ClearFlags( IS_MODIFIED_CHILD );
 
 // If aItem belongs a footprint, the full footprint will be saved because undo/redo does
 // not handle "sub items" modifications. This has implications for auto-zone-refill, so
 // we need to store a bit more information.
 if( aChangeType == CHT_MODIFY )
 {
 if( aItem->Type() == PCB_FOOTPRINT_T )
 {
 static_cast<FOOTPRINT*>( aItem )->RunOnChildren(
 [&]( BOARD_ITEM* child )
 {
 child->SetFlags( IS_MODIFIED_CHILD );
 } );
 }
 else if( aItem->GetParent() && aItem->GetParent()->Type() == PCB_FOOTPRINT_T )
 {
 if( aItem->Type() == PCB_GROUP_T )
 {
 static_cast<PCB_GROUP*>( aItem )->RunOnChildren(
 [&]( BOARD_ITEM* child )
 {
 child->SetFlags( IS_MODIFIED_CHILD );
 } );
 }
 else
 {
 aItem->SetFlags( IS_MODIFIED_CHILD );
 }
 
 aItem = aItem->GetParent();
 }
 else if( aItem->Type() == PCB_GROUP_T )
 {
 // Many operations on group (move, rotate, etc.) are applied directly to their
 // children, so it's the children that must be staged.
 static_cast<PCB_GROUP*>( aItem )->RunOnChildren(
 [&]( BOARD_ITEM* child )
 {
 COMMIT::Stage( child, aChangeType );
 } );
 }
 }
 
 return COMMIT::Stage( aItem, aChangeType );
}

References CHT_MODIFY, EDA_ITEM::ClearFlags(), EDA_ITEM::GetParent(), IS_MODIFIED_CHILD, PCB_FOOTPRINT_T, PCB_GROUP_T, EDA_ITEM::SetFlags(), COMMIT::Stage(), and EDA_ITEM::Type().

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), and PCB_EDIT_FRAME::Edit_Zone_Params().

Stage() [3/3]

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

overridevirtual

Reimplemented from COMMIT.

Definition at line 129 of file board_commit.cpp.

{
 return COMMIT::Stage( container, aChangeType );
}

References COMMIT::Stage().

StageItems()

template<class Range >

COMMIT & COMMIT::StageItems ( const Range &  aRange, CHANGE_TYPE  aChangeType  )

inlineinherited

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

Definition at line 117 of file commit.h.

References COMMIT::Stage().

Referenced by PCB_POINT_EDITOR::OnSelectionChange().

Member Data Documentation

m_changedItems

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

protectedinherited

Definition at line 179 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

Definition at line 180 of file commit.h.

Referenced by COMMIT::clear(), COMMIT::Empty(), COMMIT::findEntry(), COMMIT::makeEntry(), Push(), Revert(), and COMMIT::~COMMIT().

m_isBoardEditor

bool BOARD_COMMIT::m_isBoardEditor

private

Definition at line 75 of file board_commit.h.

Referenced by BOARD_COMMIT(), and Push().

m_isFootprintEditor

bool BOARD_COMMIT::m_isFootprintEditor

private

Definition at line 74 of file board_commit.h.

Referenced by BOARD_COMMIT(), Push(), and Revert().

m_toolMgr

TOOL_MANAGER* BOARD_COMMIT::m_toolMgr

private

Definition at line 73 of file board_commit.h.

Referenced by BOARD_COMMIT(), dirtyIntersectingZones(), GetBoard(), Push(), and Revert().

---

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

• board_commit.h
• board_commit.cpp