BOARD_COMMIT Class Reference

#include <board_commit.h>

Inheritance diagram for BOARD_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...
COMMIT &	Stage (EDA_ITEM *aItem, CHANGE_TYPE aChangeType) override
	Adds a change of the item aItem of type aChangeType to the change list. More...
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
bool	HasRemoveEntry (EDA_ITEM *aItem)
COMMIT &	Add (EDA_ITEM *aItem)
	Adds a new item to the model More...
COMMIT &	Added (EDA_ITEM *aItem)
	Notifies observers that aItem has been added More...
COMMIT &	Remove (EDA_ITEM *aItem)
	Removes a new item from the model More...
COMMIT &	Removed (EDA_ITEM *aItem)
	Notifies observers that aItem has been removed More...
COMMIT &	Modify (EDA_ITEM *aItem)
	Modifies a given item in the model. More...
COMMIT &	Modified (EDA_ITEM *aItem, EDA_ITEM *aCopy)
	Creates an undo entry for an item that has been already modified. More...
template<class Range >
COMMIT &	StageItems (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 ()
COMMIT &	createModified (EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
virtual void	makeEntry (EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=NULL)
COMMIT_LINE *	findEntry (EDA_ITEM *aItem)
	Searches 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
virtual EDA_ITEM *	parentObject (EDA_ITEM *aItem) const override

Private Attributes
TOOL_MANAGER *	m_toolMgr
bool	m_isFootprintEditor

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.

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

References FRAME_FOOTPRINT_EDITOR, TOOLS_HOLDER::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.

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

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

~BOARD_COMMIT()

BOARD_COMMIT::~BOARD_COMMIT ( )

virtual

Definition at line 55 of file board_commit.cpp.

{
}

Member Function Documentation

Add()

COMMIT& COMMIT::Add ( EDA_ITEM *  aItem )

inlineinherited

Adds a new item to the model

Definition at line 78 of file commit.h.

    {
        return Stage( aItem, CHT_ADD );
    }

References CHT_ADD, and COMMIT::Stage().

Referenced by PCB_GROUP::AddChildrenToCommit(), POINT_EDITOR::addCorner(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createInductorBetween(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), ARRAY_CREATOR::Invoke(), CONVERT_TOOL::LinesToPoly(), GRAPHICS_CLEANER::mergeRects(), ZONE_CREATE_HELPER::performZoneCutout(), DRAWING_TOOL::PlaceImportedGraphics(), INTERACTIVE_PLACER_BASE::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), CONVERT_TOOL::PolyToLines(), PCB_EDIT_FRAME::ResolveDRCExclusions(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CONVERT_TOOL::SegmentToArc(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and PCB_EDITOR_CONTROL::ZoneDuplicate().

Added()

COMMIT& COMMIT::Added ( EDA_ITEM *  aItem )

inlineinherited

Notifies observers that aItem has been added

Definition at line 84 of file commit.h.

    {
        return Stage( aItem, CHT_ADD | CHT_DONE );
    }

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

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.

convert()

CHANGE_TYPE COMMIT::convert ( UNDO_REDO  aType ) const

protectedinherited

Definition at line 202 of file commit.cpp.

{
    switch( aType )
    {
    case UNDO_REDO::NEWITEM:
        return CHT_ADD;

    case UNDO_REDO::DELETED:
        return CHT_REMOVE;

    default:
        assert( false );
        // fall through

    case UNDO_REDO::CHANGED:
    case UNDO_REDO::MOVED:
    case UNDO_REDO::MIRRORED_X:
    case UNDO_REDO::MIRRORED_Y:
    case UNDO_REDO::ROTATED:
    case UNDO_REDO::ROTATED_CLOCKWISE:
    case UNDO_REDO::FLIPPED:
        return CHT_MODIFY;
    }
}

References CHANGED, CHT_ADD, CHT_MODIFY, CHT_REMOVE, DELETED, FLIPPED, MIRRORED_X, MIRRORED_Y, MOVED, NEWITEM, ROTATED, and 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.

{
    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().

Empty()

bool COMMIT::Empty ( ) const

inlineinherited

Definition at line 139 of file commit.h.

    {
        return m_changes.empty();
    }

References COMMIT::m_changes.

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

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.

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

    return nullptr;
}

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.

{
    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::updateComponentParameters().

HasRemoveEntry()

bool BOARD_COMMIT::HasRemoveEntry

(

EDA_ITEM *

aItem

)

Definition at line 452 of file board_commit.cpp.

{
    COMMIT::COMMIT_LINE* line = findEntry( aItem );
    return line != nullptr && line->m_type == CHT_REMOVE;
}

References CHT_REMOVE, and COMMIT::COMMIT_LINE::m_type.

makeEntry()

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

protectedvirtualinherited

Definition at line 167 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() )
    {
        eraseIf( 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, 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.

    {
        return createModified( aItem, aCopy );
    }

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.

    {
        return Stage( aItem, CHT_MODIFY );
    }

References CHT_MODIFY, and COMMIT::Stage().

Referenced by 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(), PCB_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(), POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), DRAWING_TOOL::SetAnchor(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_UNUSED_PAD_LAYERS::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::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 366 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_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_SHAPE_T, PCB_FP_TEXT_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"), bool  aCreateUndoEntry = true, bool  aSetDirtyBit = true  )

overridevirtual

Executes the changes.

Implements COMMIT.

Definition at line 84 of file board_commit.cpp.

{
    // Objects potentially interested in changes:
    PICKED_ITEMS_LIST   undoList;
    KIGFX::VIEW*        view = m_toolMgr->GetView();
    BOARD*              board = (BOARD*) m_toolMgr->GetModel();
    PCB_BASE_FRAME*     frame = (PCB_BASE_FRAME*) m_toolMgr->GetToolHolder();
    auto                connectivity = board->GetConnectivity();
    std::set<EDA_ITEM*> savedModules;
    SELECTION_TOOL*     selTool = m_toolMgr->GetTool<SELECTION_TOOL>();
    bool                itemsDeselected = false;

    if( Empty() )
        return;

    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 );

        // 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();

            // 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 = ent.m_item->Clone();
                }

                wxASSERT( ent.m_item->Type() == PCB_FOOTPRINT_T );
                wxASSERT( ent.m_copy->Type() == PCB_FOOTPRINT_T );

                if( aCreateUndoEntry )
                {
                    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 );
                static_cast<FOOTPRINT*>( ent.m_item )->SetLastEditTime();
            }
        }

        switch( changeType )
        {
            case CHT_ADD:
            {
                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_FP_TEXT_T ||
                         boardItem->Type() == PCB_FP_SHAPE_T ||
                         boardItem->Type() == PCB_FP_ZONE_T )
                {
                    wxASSERT( boardItem->GetParent() &&
                              boardItem->GetParent()->Type() == PCB_FOOTPRINT_T );
                }
                else
                {
                    if( aCreateUndoEntry )
                        undoList.PushItem( ITEM_PICKER( nullptr, boardItem, UNDO_REDO::NEWITEM ) );

                    if( !( changeFlags & CHT_DONE ) )
                        board->Add( boardItem );        // handles connectivity
                }

                if( boardItem->Type() != PCB_NETINFO_T && boardItem->Type() != PCB_GROUP_T )
                    view->Add( boardItem );

                break;
            }

            case CHT_REMOVE:
            {
                if( !m_isFootprintEditor && aCreateUndoEntry )
                    undoList.PushItem( ITEM_PICKER( nullptr, boardItem, UNDO_REDO::DELETED ) );

                if( boardItem->IsSelected() )
                {
                    selTool->RemoveItemFromSel( boardItem, true /* quiet mode */ );
                    itemsDeselected = true;
                }

                switch( boardItem->Type() )
                {
                // Module items
                case PCB_PAD_T:
                case PCB_FP_SHAPE_T:
                case PCB_FP_TEXT_T:
                case PCB_FP_ZONE_T:
                    // This level can only handle footprint children when editing footprints
                    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;
                    }

                    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_TEXT_T:                // a 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_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:
                    view->Remove( boardItem );

                    if( !( changeFlags & CHT_DONE ) )
                        board->Remove( boardItem );

                    break;

                case PCB_FOOTPRINT_T:
                {
                    // No support for nested footprints (yet)
                    wxASSERT( !m_isFootprintEditor );

                    FOOTPRINT* footprint = static_cast<FOOTPRINT*>( boardItem );
                    view->Remove( footprint );
                    footprint->ClearFlags();

                    if( !( changeFlags & CHT_DONE ) )
                        board->Remove( footprint );        // handles connectivity
                }
                break;

                case PCB_GROUP_T:
                    if( !( changeFlags & CHT_DONE ) )
                    {
                        if( m_isFootprintEditor )
                            board->GetFirstFootprint()->Remove( boardItem );
                        else
                            board->Remove( boardItem );
                    }
                    break;

                // Metadata items
                case PCB_NETINFO_T:
                    board->Remove( boardItem );
                    break;

                default:                        // other types do not need to (or should not) be handled
                    wxASSERT( false );
                    break;
                }

                break;
            }

            case CHT_MODIFY:
            {
                if( !m_isFootprintEditor && aCreateUndoEntry )
                {
                    ITEM_PICKER itemWrapper( nullptr, boardItem, UNDO_REDO::CHANGED );
                    wxASSERT( ent.m_copy );
                    itemWrapper.SetLink( ent.m_copy );
                    undoList.PushItem( itemWrapper );
                }

                if( ent.m_copy )
                    connectivity->MarkItemNetAsDirty( static_cast<BOARD_ITEM*>( ent.m_copy ) );

                connectivity->Update( boardItem );
                view->Update( boardItem );

                if( m_isFootprintEditor )
                {
                    static_cast<FOOTPRINT*>( boardItem )->RunOnChildren(
                            [&]( BOARD_ITEM* aChild )
                            {
                                view->Update( aChild );
                            });
                }

                board->OnItemChanged( boardItem );

                // if no undo entry is needed, the copy would create a memory leak
                if( !aCreateUndoEntry )
                    delete ent.m_copy;

                break;
            }

            default:
                wxASSERT( false );
                break;
        }
    }

    if ( !m_isFootprintEditor )
    {
        size_t num_changes = m_changes.size();

        connectivity->RecalculateRatsnest( this );
        connectivity->ClearDynamicRatsnest();
        frame->GetCanvas()->RedrawRatsnest();

        if( m_changes.size() > num_changes )
        {
            for( size_t i = num_changes; i < m_changes.size(); ++i )
            {
                COMMIT_LINE& ent = m_changes[i];

                // This should only be modifications from the connectivity algo
                wxASSERT( ( ent.m_type & CHT_TYPE ) == CHT_MODIFY );

                auto boardItem = static_cast<BOARD_ITEM*>( ent.m_item );

                if( aCreateUndoEntry )
                {
                    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;
                }

                view->Update( boardItem );
            }
        }
    }

    if( !m_isFootprintEditor && aCreateUndoEntry )
        frame->SaveCopyInUndoList( undoList, UNDO_REDO::UNSPECIFIED );

    m_toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );

    if( itemsDeselected )
        m_toolMgr->PostEvent( EVENTS::UnselectedEvent );

    if( aSetDirtyBit )
        frame->OnModify();
    else
        frame->Update3DView( false );

    frame->UpdateMsgPanel();

    clear();
}

References KIGFX::VIEW::Add(), BOARD::Add(), AS_GLOBAL, CHANGED, CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, EDA_ITEM::ClearFlags(), BOARD_ITEM_CONTAINER::Delete(), DELETED, BOARD::Footprints(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetConnectivity(), BOARD::GetFirstFootprint(), BOARD_ITEM::GetParent(), FP_TEXT::GetType(), EDA_ITEM::IsSelected(), COMMIT::COMMIT_LINE::m_copy, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_type, TOOL_BASE::m_type, NEWITEM, BOARD::OnItemChanged(), PCB_BASE_FRAME::OnModify(), PCB_ARC_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_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_TRACE_T, PCB_VIA_T, PCB_ZONE_T, PICKED_ITEMS_LIST::PushItem(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), KIGFX::VIEW::Remove(), FOOTPRINT::Remove(), BOARD::Remove(), SELECTION_TOOL::RemoveItemFromSel(), PCB_BASE_FRAME::SaveCopyInUndoList(), ITEM_PICKER::SetLink(), EDA_ITEM::SetParent(), TA_MODEL_CHANGE, TC_MESSAGE, FP_TEXT::TEXT_is_DIVERS, EDA_ITEM::Type(), EVENTS::UnselectedEvent, UNSPECIFIED, KIGFX::VIEW::Update(), PCB_BASE_FRAME::Update3DView(), and EDA_DRAW_FRAME::UpdateMsgPanel().

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), 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(), 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(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawSegment(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EnumeratePads(), PAD_TOOL::explodePad(), ZONE_FILLER_TOOL::FillAllZones(), ARRAY_CREATOR::Invoke(), CONVERT_TOOL::LinesToPoly(), PCB_EDITOR_CONTROL::modifyLockSelected(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), POINT_EDITOR::OnSelectionChange(), PAD_TOOL::pastePadProperties(), ZONE_CREATE_HELPER::performZoneCutout(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), CONVERT_TOOL::PolyToLines(), PAD_TOOL::pushPadSettings(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), PAD_TOOL::recombinePad(), POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), PCB_EDIT_FRAME::ResolveDRCExclusions(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CONVERT_TOOL::SegmentToArc(), DRAWING_TOOL::SetAnchor(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::UpdateNetlist(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), PCB_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), 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.

    {
        return Stage( aItem, CHT_REMOVE );
    }

References CHT_REMOVE, and COMMIT::Stage().

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), BOARD_NETLIST_UPDATER::deleteUnusedComponents(), PCB_EDIT_FRAME::ExchangeFootprint(), GRAPHICS_CLEANER::mergeRects(), mergeZones(), ZONE_CREATE_HELPER::performZoneCutout(), PAD_TOOL::recombinePad(), 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.

    {
        return Stage( aItem, CHT_REMOVE | CHT_DONE );
    }

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

Referenced by GRAPHICS_CLEANER::cleanupSegments(), TRACKS_CLEANER::deleteDanglingTracks(), TRACKS_CLEANER::mergeCollinearSegments(), TRACKS_CLEANER::removeItems(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

Revert()

void BOARD_COMMIT::Revert ( )

overridevirtual

Revertes the commit by restoring the modifed items state.

Implements COMMIT.

Definition at line 388 of file board_commit.cpp.

{
    PICKED_ITEMS_LIST undoList;
    KIGFX::VIEW* view = m_toolMgr->GetView();
    BOARD* board = (BOARD*) m_toolMgr->GetModel();
    auto connectivity = board->GetConnectivity();

    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 );
            break;

        case CHT_REMOVE:
            if( !( changeFlags & CHT_DONE ) )
                break;

            view->Add( item );
            connectivity->Add( item );
            board->Add( item );
            break;

        case CHT_MODIFY:
        {
            view->Remove( item );
            connectivity->Remove( item );

            item->SwapData( copy );

            view->Add( item );
            connectivity->Add( item );
            board->OnItemChanged( item );
            delete copy;
            break;
        }

        default:
            wxASSERT( false );
            break;
        }
    }

    if ( !m_isFootprintEditor )
        connectivity->RecalculateRatsnest();

    SELECTION_TOOL* selTool = m_toolMgr->GetTool<SELECTION_TOOL>();
    selTool->RebuildSelection();

    clear();
}

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, BOARD::OnItemChanged(), SELECTION_TOOL::RebuildSelection(), KIGFX::VIEW::Remove(), BOARD::Remove(), and BOARD_ITEM::SwapData().

Referenced by AUTOPLACE_TOOL::autoplace(), ZONE_FILLER_TOOL::CheckAllZones(), ZONE_CREATE_HELPER::commitZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EnumeratePads(), PCB_EDIT_FRAME::ExportVRML_File(), ZONE_FILLER_TOOL::FillAllZones(), POINT_EDITOR::OnSelectionChange(), ZONE_CREATE_HELPER::performZoneCutout(), PCB_EDITOR_CONTROL::PlaceModule(), and ZONE_FILLER_TOOL::ZoneFill().

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.

{
    // if aItem belongs a footprint, the full footprint will be saved
    // because undo/redo does not handle "sub items" modifications
    if( aItem && aItem->Type() != PCB_FOOTPRINT_T && aChangeType == CHT_MODIFY )
    {
        EDA_ITEM* item = aItem->GetParent();

        if( item && item->Type() == PCB_FOOTPRINT_T )  // means aItem belongs a footprint
            aItem = item;
    }

    return COMMIT::Stage( aItem, aChangeType );
}

References CHT_MODIFY, EDA_ITEM::GetParent(), PCB_FOOTPRINT_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.

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

References COMMIT::Stage().

Stage() [3/3]

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

overridevirtual

Reimplemented from COMMIT.

Definition at line 79 of file board_commit.cpp.

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

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.

    {
        for( const auto& item : aRange )
            Stage( item, aChangeType );

        return *this;
    }

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 176 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 177 of file commit.h.

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

m_isFootprintEditor

bool BOARD_COMMIT::m_isFootprintEditor

private

Definition at line 64 of file board_commit.h.

m_toolMgr

TOOL_MANAGER* BOARD_COMMIT::m_toolMgr

private

Definition at line 63 of file board_commit.h.

---

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

• board_commit.h
• board_commit.cpp