edit_tool_move_fct.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2017 CERN
 * Copyright (C) 2017-2022 KiCad Developers, see AUTHORS.txt for contributors.
 * @author Maciej Suminski <[email protected]>
 * @author Tomasz Wlostowski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#include <advanced_config.h>
#include <limits>
#include <board.h>
#include <board_design_settings.h>
#include <footprint.h>
#include <fp_shape.h>
#include <collectors.h>
#include <pcb_edit_frame.h>
#include <drawing_sheet/ds_proxy_view_item.h>
#include <kiway.h>
#include <pcbnew_settings.h>
#include <spread_footprints.h>
#include <tools/pcb_actions.h>
#include <tools/pcb_selection_tool.h>
#include <tools/edit_tool.h>
#include <tools/pcb_grid_helper.h>
#include <tools/drc_tool.h>
#include <tools/drawing_tool.h>
#include <tools/zone_filler_tool.h>
#include <view/view_controls.h>
#include <connectivity/connectivity_algo.h>
#include <connectivity/connectivity_items.h>
#include <cassert>
#include <functional>
#include <wx/hyperlink.h>
#include <router/router_tool.h>
#include <dialogs/dialog_move_exact.h>
#include <dialogs/dialog_unit_entry.h>
#include <board_commit.h>
#include <pcb_group.h>
#include <pcb_target.h>
#include <zone_filler.h>
#include <drc/drc_engine.h>
#include <drc/drc_item.h>
#include <drc/drc_rule.h>
#include <pad.h>
#include <geometry/shape_segment.h>
#include <drc/drc_interactive_courtyard_clearance.h>
 
 
int EDIT_TOOL::Swap( const TOOL_EVENT& aEvent )
{
 if( isRouterActive() )
 {
 wxBell();
 return 0;
 }
 
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 sTool->FilterCollectorForFreePads( aCollector );
 
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 switch( item->Type() )
 {
 case PCB_TRACE_T: aCollector.Remove( item ); break;
 
 default: break;
 }
 }
 },
 true /* prompt user regarding locked items */ );
 
 if( selection.Size() < 2 )
 return 0;
 
 std::vector<EDA_ITEM*> sorted = selection.GetItemsSortedBySelectionOrder();
 
 // When editing footprints, all items have the same parent
 if( IsFootprintEditor() )
 {
 m_commit->Modify( selection.Front() );
 }
 else
 {
 // Save items, so changes can be undone
 for( EDA_ITEM* item : selection )
 {
 // Don't double move footprint pads, fields, etc.
 //
 // For PCB_GROUP_T, the parent is the board.
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 m_commit->Modify( item );
 
 // If moving a group, record position of all the descendants for undo
 if( item->Type() == PCB_GROUP_T )
 {
 PCB_GROUP* group = static_cast<PCB_GROUP*>( item );
 group->RunOnDescendants( [&]( BOARD_ITEM* bItem )
 {
 m_commit->Modify( bItem );
 });
 }
 }
 }
 
 for( size_t i = 0; i < sorted.size() - 1; i++ )
 {
 BOARD_ITEM* a = static_cast<BOARD_ITEM*>( sorted[i] );
 BOARD_ITEM* b = static_cast<BOARD_ITEM*>( sorted[( i + 1 ) % sorted.size()] );
 
 // Swap X,Y position
 VECTOR2I aPos = a->GetPosition(), bPos = b->GetPosition();
 std::swap( aPos, bPos );
 a->SetPosition( aPos );
 b->SetPosition( bPos );
 
 // Pads need special handling to keep their offset from their parent
 if( a->Type() == PCB_PAD_T )
 static_cast<PAD*>( a )->SetLocalCoord();
 
 if( b->Type() == PCB_PAD_T )
 static_cast<PAD*>( b )->SetLocalCoord();
 
 // Handle footprints specially. They can be flipped to the back of the board which
 // requires a special transformation.
 if( a->Type() == PCB_FOOTPRINT_T && b->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* aFP = static_cast<FOOTPRINT*>( a );
 FOOTPRINT* bFP = static_cast<FOOTPRINT*>( b );
 
 // Flip both if needed
 if( aFP->IsFlipped() != bFP->IsFlipped() )
 {
 aFP->Flip( aPos, false );
 bFP->Flip( bPos, false );
 }
 
 // Set orientation
 EDA_ANGLE aAngle = aFP->GetOrientation(), bAngle = bFP->GetOrientation();
 std::swap( aAngle, bAngle );
 aFP->SetOrientation( aAngle );
 bFP->SetOrientation( bAngle );
 }
 // We can also do a layer swap safely for two objects of the same type,
 // except groups which don't support layer swaps.
 else if( a->Type() == b->Type() && a->Type() != PCB_GROUP_T )
 {
 // Swap layers
 PCB_LAYER_ID aLayer = a->GetLayer(), bLayer = b->GetLayer();
 std::swap( aLayer, bLayer );
 a->SetLayer( aLayer );
 b->SetLayer( bLayer );
 }
 }
 
 if( !m_dragging )
 m_commit->Push( _( "Swap" ) );
 
 m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 
 return 0;
}
 
 
int EDIT_TOOL::PackAndMoveFootprints( const TOOL_EVENT& aEvent )
{
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 sTool->FilterCollectorForFreePads( aCollector );
 
 // Iterate from the back so we don't have to worry about removals.
 for( int i = aCollector.GetCount() - 1; i >= 0; --i )
 {
 BOARD_ITEM* item = aCollector[i];
 
 if( !dynamic_cast<FOOTPRINT*>( item ) )
 aCollector.Remove( item );
 }
 },
 true /* prompt user regarding locked items */ );
 
 std::vector<FOOTPRINT*> footprintsToPack;
 
 for( EDA_ITEM* item : selection )
 footprintsToPack.push_back( static_cast<FOOTPRINT*>( item ) );
 
 if( footprintsToPack.empty() )
 return 0;
 
 BOX2I footprintsBbox;
 
 for( FOOTPRINT* item : footprintsToPack )
 {
 m_commit->Modify( item );
 footprintsBbox.Merge( item->GetBoundingBox( false, false ) );
 }
 
 SpreadFootprints( &footprintsToPack, footprintsBbox.Normalize().GetOrigin(), false );
 
 return doMoveSelection( aEvent, _( "Pack footprints" ) );
}
 
 
int EDIT_TOOL::Move( const TOOL_EVENT& aEvent )
{
 if( isRouterActive() )
 {
 wxBell();
 return 0;
 }
 
 return doMoveSelection( aEvent, _( "Move" ) );
}
 
 
VECTOR2I EDIT_TOOL::getSafeMovement( const VECTOR2I& aMovement, const BOX2I& aSourceBBox,
 const VECTOR2D& aBBoxOffset )
{
 typedef std::numeric_limits<int> coord_limits;
 
 int max = coord_limits::max();
 int min = -max;
 
 double left = aBBoxOffset.x + aSourceBBox.GetPosition().x;
 double top = aBBoxOffset.y + aSourceBBox.GetPosition().y;
 
 double right = left + aSourceBBox.GetSize().x;
 double bottom = top + aSourceBBox.GetSize().y;
 
 // Do not restrict movement if bounding box is already out of bounds
 if( left < min || top < min || right > max || bottom > max )
 return aMovement;
 
 // Constrain moving bounding box to coordinates limits
 VECTOR2D tryMovement( aMovement );
 VECTOR2D bBoxOrigin( aSourceBBox.GetPosition() + aBBoxOffset );
 VECTOR2D clampedBBoxOrigin = GetClampedCoords( bBoxOrigin + tryMovement, COORDS_PADDING );
 
 tryMovement = clampedBBoxOrigin - bBoxOrigin;
 
 VECTOR2D bBoxEnd( aSourceBBox.GetEnd() + aBBoxOffset );
 VECTOR2D clampedBBoxEnd = GetClampedCoords( bBoxEnd + tryMovement, COORDS_PADDING );
 
 tryMovement = clampedBBoxEnd - bBoxEnd;
 
 return GetClampedCoords<double, int>( tryMovement );
}
 
 
int EDIT_TOOL::doMoveSelection( const TOOL_EVENT& aEvent, const wxString& aCommitMessage )
{
 bool moveWithReference = aEvent.IsAction( &PCB_ACTIONS::moveWithReference );
 bool moveIndividually = aEvent.IsAction( &PCB_ACTIONS::moveIndividually );
 
 PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
 PCBNEW_SETTINGS* cfg = editFrame->GetPcbNewSettings();
 BOARD* board = editFrame->GetBoard();
 KIGFX::VIEW_CONTROLS* controls = getViewControls();
 VECTOR2I originalCursorPos = controls->GetCursorPosition();
 STATUS_TEXT_POPUP statusPopup( frame() );
 wxString status;
 size_t itemIdx = 0;
 
 editFrame->PushTool( aEvent );
 
 // Be sure that there is at least one item that we can modify. If nothing was selected before,
 // try looking for the stuff under mouse cursor (i.e. KiCad old-style hover selection)
 PCB_SELECTION& selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 },
 // Prompt user regarding locked items if in board editor and in free-pad-mode (if
 // we're not in free-pad mode we delay this until the second RequestSelection()).
 !m_isFootprintEditor && cfg->m_AllowFreePads );
 
 if( m_dragging || selection.Empty() )
 {
 editFrame->PopTool( aEvent );
 return 0;
 }
 
 LSET item_layers = selection.GetSelectionLayers();
 bool is_hover = selection.IsHover(); // N.B. This must be saved before the second call
 // to RequestSelection() below
 VECTOR2I pickedReferencePoint;
 
 // Now filter out pads if not in free pads mode. We cannot do this in the first
 // RequestSelection() as we need the item_layers when a pad is the selection front.
 if( !m_isFootprintEditor && !cfg->m_AllowFreePads )
 {
 selection = m_selectionTool->RequestSelection(
 []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
 {
 sTool->FilterCollectorForMarkers( aCollector );
 sTool->FilterCollectorForHierarchy( aCollector, true );
 sTool->FilterCollectorForFreePads( aCollector );
 },
 true /* prompt user regarding locked items */ );
 }
 
 if( selection.Empty() )
 {
 editFrame->PopTool( aEvent );
 return 0;
 }
 
 Activate();
 // Must be done after Activate() so that it gets set into the correct context
 controls->ShowCursor( true );
 controls->SetAutoPan( true );
 controls->ForceCursorPosition( false );
 
 auto displayConstraintsMessage =
 [editFrame]( bool constrained )
 {
 editFrame->DisplayConstraintsMsg( constrained ? _( "Constrain to H, V, 45" )
 : wxT( "" ) );
 };
 
 auto updateStatusPopup =
 [&]( EDA_ITEM* item, size_t ii, size_t count )
 {
 wxString popuptext = _( "Click to place %s (item %ld of %ld)\n"
 "Press <esc> to cancel all; double-click to finish" );
 wxString msg;
 
 if( item->Type() == PCB_FOOTPRINT_T )
 {
 FOOTPRINT* fp = static_cast<FOOTPRINT*>( item );
 msg = fp->GetReference();
 }
 else if( item->Type() == PCB_PAD_T )
 {
 PAD* pad = static_cast<PAD*>( item );
 FOOTPRINT* fp = static_cast<FOOTPRINT*>( pad->GetParentFootprint() );
 msg = wxString::Format( _( "%s pad %s" ), fp->GetReference(), pad->GetNumber() );
 }
 else
 {
 msg = item->GetTypeDesc().Lower();
 }
 
 statusPopup.SetText( wxString::Format( popuptext, msg, ii, count ) );
 };
 
 std::vector<BOARD_ITEM*> sel_items; // All the items operated on by the move below
 std::vector<BOARD_ITEM*> orig_items; // All the original items in the selection
 
 for( EDA_ITEM* item : selection )
 {
 BOARD_ITEM* boardItem = dynamic_cast<BOARD_ITEM*>( item );
 FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( item );
 
 if( boardItem )
 {
 if( !is_hover )
 orig_items.push_back( boardItem );
 
 sel_items.push_back( boardItem );
 }
 
 if( footprint )
 {
 for( PAD* pad : footprint->Pads() )
 sel_items.push_back( pad );
 
 // Clear this flag here; it will be set by the netlist updater if the footprint is new
 // so that it was skipped in the initial connectivity update in OnNetlistChanged
 footprint->SetAttributes( footprint->GetAttributes() & ~FP_JUST_ADDED );
 }
 }
 
 if( moveWithReference && !pickReferencePoint( _( "Select reference point for move..." ), "", "",
  pickedReferencePoint ) )
 {
 if( is_hover )
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 editFrame->PopTool( aEvent );
 return 0;
 }
 
 if( moveIndividually )
 {
 orig_items.clear();
 
 for( EDA_ITEM* item : selection.GetItemsSortedBySelectionOrder() )
 orig_items.push_back( static_cast<BOARD_ITEM*>( item ) );
 
 updateStatusPopup( orig_items[ itemIdx ], itemIdx + 1, orig_items.size() );
 statusPopup.Popup();
 statusPopup.Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
 canvas()->SetStatusPopup( statusPopup.GetPanel() );
 
 m_selectionTool->ClearSelection();
 m_selectionTool->AddItemToSel( orig_items[ itemIdx ] );
 
 sel_items.clear();
 sel_items.push_back( orig_items[ itemIdx ] );
 }
 
 bool restore_state = false;
 VECTOR2I originalPos;
 VECTOR2I totalMovement;
 VECTOR2D bboxMovement;
 BOX2I originalBBox;
 bool updateBBox = true;
 PCB_GRID_HELPER grid( m_toolMgr, editFrame->GetMagneticItemsSettings() );
 TOOL_EVENT copy = aEvent;
 TOOL_EVENT* evt = &copy;
 VECTOR2I prevPos;
 
 bool hv45Mode = false;
 bool eatFirstMouseUp = true;
 bool hasRedrawn3D = false;
 bool allowRedraw3D = cfg->m_Display.m_Live3DRefresh;
 bool showCourtyardConflicts = !m_isFootprintEditor && cfg->m_ShowCourtyardCollisions;
 
 // Used to test courtyard overlaps
 std::unique_ptr<DRC_INTERACTIVE_COURTYARD_CLEARANCE> drc_on_move = nullptr;
 
 if( showCourtyardConflicts )
 {
 std::shared_ptr<DRC_ENGINE> drcEngine = m_toolMgr->GetTool<DRC_TOOL>()->GetDRCEngine();
 drc_on_move.reset( new DRC_INTERACTIVE_COURTYARD_CLEARANCE( drcEngine ) );
 drc_on_move->Init( board );
 }
 
 displayConstraintsMessage( hv45Mode );
 
 // Prime the pump
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 
 // Main loop: keep receiving events
 do
 {
 VECTOR2I movement;
 editFrame->GetCanvas()->SetCurrentCursor( KICURSOR::MOVING );
 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
 
 bool isSkip = evt->IsAction( &PCB_ACTIONS::skip ) && moveIndividually;
 
 if( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) )
 eatFirstMouseUp = false;
 
 if( evt->IsAction( &PCB_ACTIONS::move ) || evt->IsMotion() || evt->IsDrag( BUT_LEFT )
 || evt->IsAction( &ACTIONS::refreshPreview )
 || evt->IsAction( &PCB_ACTIONS::moveWithReference )
 || evt->IsAction( &PCB_ACTIONS::moveIndividually ) )
 {
 if( m_dragging && evt->Category() == TC_MOUSE )
 {
 bool redraw3D = false;
 
 VECTOR2I mousePos( controls->GetMousePosition() );
 
 m_cursor = grid.BestSnapAnchor( mousePos, item_layers, sel_items );
 
 if( controls->GetSettings().m_lastKeyboardCursorPositionValid )
 {
 long action = controls->GetSettings().m_lastKeyboardCursorCommand;
 
 // The arrow keys are by definition SINGLE AXIS. Do not allow the other
 // axis to be snapped to the grid.
 if( action == ACTIONS::CURSOR_LEFT || action == ACTIONS::CURSOR_RIGHT )
 m_cursor.y = prevPos.y;
 else if( action == ACTIONS::CURSOR_UP || action == ACTIONS::CURSOR_DOWN )
 m_cursor.x = prevPos.x;
 }
 
 if( !selection.HasReferencePoint() )
 originalPos = m_cursor;
 
 if( hv45Mode )
 {
 VECTOR2I moveVector = m_cursor - originalPos;
 m_cursor = originalPos + GetVectorSnapped45( moveVector );
 }
 
 if( updateBBox )
 {
 originalBBox = BOX2I();
 bboxMovement = VECTOR2D();
 
 for( EDA_ITEM* item : sel_items )
 {
 BOX2I viewBBOX = item->ViewBBox();
 
 if( originalBBox.GetWidth() == 0 && originalBBox.GetHeight() == 0 )
 originalBBox = viewBBOX;
 else
 originalBBox.Merge( viewBBOX );
 }
 
 updateBBox = false;
 }
 
 // Constrain selection bounding box to coordinates limits
 movement = getSafeMovement( m_cursor - prevPos, originalBBox, bboxMovement );
 
 // Apply constrained movement
 m_cursor = prevPos + movement;
 
 controls->ForceCursorPosition( true, m_cursor );
 selection.SetReferencePoint( m_cursor );
 
 prevPos = m_cursor;
 totalMovement += movement;
 bboxMovement += movement;
 
 // Drag items to the current cursor position
 for( EDA_ITEM* item : sel_items )
 {
 // Don't double move footprint pads, fields, etc.
 //
 // For PCB_GROUP_T, we make sure the selection includes only the top level
 // group and not its descendants.
 if( !item->GetParent() || !item->GetParent()->IsSelected() )
 static_cast<BOARD_ITEM*>( item )->Move( movement );
 
 if( !redraw3D && item->Type() == PCB_FOOTPRINT_T )
 redraw3D = true;
 }
 
 if( redraw3D && allowRedraw3D )
 {
 editFrame->Update3DView( false, true );
 hasRedrawn3D = true;
 }
 
 if( showCourtyardConflicts && drc_on_move->m_FpInMove.size() )
 {
 drc_on_move->Run();
 drc_on_move->UpdateConflicts( m_toolMgr->GetView(), true );
 }
 
 m_toolMgr->PostEvent( EVENTS::SelectedItemsMoved );
 }
 else if( !m_dragging && !evt->IsAction( &ACTIONS::refreshPreview ) )
 {
 // Prepare to start dragging
 editFrame->HideSolderMask();
 
 m_dragging = true;
 
 // When editing footprints, all items have the same parent
 if( IsFootprintEditor() )
 {
 m_commit->Modify( selection.Front() );
 }
 else
 {
 // Save items, so changes can be undone
 for( EDA_ITEM* item : selection )
 {
 // Don't double move footprint pads, fields, etc.
 //
 // For PCB_GROUP_T, the parent is the board.
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 m_commit->Modify( item );
 
 // If moving a group, record position of all the descendants for undo
 if( item->Type() == PCB_GROUP_T )
 {
 PCB_GROUP* group = static_cast<PCB_GROUP*>( item );
 group->RunOnDescendants( [&]( BOARD_ITEM* bItem )
 {
 m_commit->Modify( bItem );
 });
 }
 }
 }
 
 editFrame->UndoRedoBlock( true );
 m_cursor = controls->GetCursorPosition();
 
 if( selection.HasReferencePoint() )
 {
 // start moving with the reference point attached to the cursor
 grid.SetAuxAxes( false );
 
 if( hv45Mode )
 {
 VECTOR2I moveVector = m_cursor - originalPos;
 m_cursor = originalPos + GetVectorSnapped45( moveVector );
 }
 
 movement = m_cursor - selection.GetReferencePoint();
 
 // Drag items to the current cursor position
 for( EDA_ITEM* item : selection )
 {
 // Don't double move footprint pads, fields, etc.
 if( item->GetParent() && item->GetParent()->IsSelected() )
 continue;
 
 static_cast<BOARD_ITEM*>( item )->Move( movement );
 }
 
 selection.SetReferencePoint( m_cursor );
 }
 else
 {
 for( BOARD_ITEM* item : sel_items )
 {
 if( showCourtyardConflicts && item->Type() == PCB_FOOTPRINT_T )
 drc_on_move->m_FpInMove.push_back( static_cast<FOOTPRINT*>( item ) );
 }
 
 m_cursor = grid.BestDragOrigin( originalCursorPos, sel_items,
 &m_selectionTool->GetFilter() );
 
 // Set the current cursor position to the first dragged item origin, so the
 // movement vector could be computed later
 if( moveWithReference )
 {
 selection.SetReferencePoint( pickedReferencePoint );
 controls->ForceCursorPosition( true, pickedReferencePoint );
 m_cursor = pickedReferencePoint;
 }
 else
 {
 // Check if user wants to warp the mouse to origin of moved object
 if( !editFrame->GetMoveWarpsCursor() )
 m_cursor = originalCursorPos; // No, so use original mouse pos instead
 
 selection.SetReferencePoint( m_cursor );
 grid.SetAuxAxes( true, m_cursor );
 }
 
 originalPos = m_cursor;
 }
 
 // Update variables for bounding box collision calculations
 updateBBox = true;
 
 controls->SetCursorPosition( m_cursor, false );
 
 prevPos = m_cursor;
 controls->SetAutoPan( true );
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 }
 
 statusPopup.Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
 
 m_toolMgr->RunAction( PCB_ACTIONS::updateLocalRatsnest, false, new VECTOR2I( movement ) );
 }
 else if( evt->IsCancelInteractive() || evt->IsActivate() )
 {
 if( m_dragging && evt->IsCancelInteractive() )
 evt->SetPassEvent( false );
 
 restore_state = true; // Canceling the tool means that items have to be restored
 break; // Finish
 }
 else if( evt->IsAction( &ACTIONS::undo ) )
 {
 restore_state = true; // Perform undo locally
 break; // Finish
 }
 else if( evt->IsAction( &ACTIONS::doDelete ) || evt->IsAction( &ACTIONS::cut ) )
 {
 // Dispatch TOOL_ACTIONs
 evt->SetPassEvent();
 break; // finish -- there is no further processing for removed items
 }
 else if( evt->IsAction( &ACTIONS::duplicate ) )
 {
 evt->SetPassEvent();
 break; // finish -- Duplicate tool will start a new Move with the dup'ed items
 }
 else if( evt->IsAction( &PCB_ACTIONS::rotateCw )
 || evt->IsAction( &PCB_ACTIONS::rotateCcw )
 || evt->IsAction( &PCB_ACTIONS::flip )
 || evt->IsAction( &PCB_ACTIONS::mirrorH )
 || evt->IsAction( &PCB_ACTIONS::mirrorV ) )
 {
 updateBBox = true;
 eatFirstMouseUp = false;
 evt->SetPassEvent();
 }
 else if( evt->IsAction( &PCB_ACTIONS::moveExact ) )
 {
 // Reset positions so the Move Exactly is from the start.
 for( EDA_ITEM* item : selection )
 {
 BOARD_ITEM* i = static_cast<BOARD_ITEM*>( item );
 i->Move( -totalMovement );
 }
 
 break; // finish -- we moved exactly, so we are finished
 }
 else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) || isSkip )
 {
 // Eat mouse-up/-click events that leaked through from the lock dialog
 if( eatFirstMouseUp && evt->Parameter<intptr_t>() != ACTIONS::CURSOR_CLICK )
 {
 eatFirstMouseUp = false;
 continue;
 }
 else if( moveIndividually && m_dragging )
 {
 // Put skipped items back where they started
 if( isSkip )
 orig_items[itemIdx]->SetPosition( originalPos );
 
 rebuildConnectivity();
 
 if( ++itemIdx < orig_items.size() )
 {
 BOARD_ITEM* nextItem = orig_items[itemIdx];
 
 m_selectionTool->ClearSelection();
 
 originalPos = nextItem->GetPosition();
 m_selectionTool->AddItemToSel( nextItem );
 selection.SetReferencePoint( originalPos );
 
 sel_items.clear();
 sel_items.push_back( nextItem );
 updateStatusPopup( nextItem, itemIdx + 1, orig_items.size() );
 
 // Pick up new item
 m_commit->Modify( nextItem );
 nextItem->SetPosition( controls->GetMousePosition( true ) );
 
 continue;
 }
 }
 
 break; // finish
 }
 else if( evt->IsDblClick( BUT_LEFT ) )
 {
 // The first click will move the new item, so put it back
 if( moveIndividually )
 orig_items[itemIdx]->SetPosition( originalPos );
 
 break; // finish
 }
 else if( evt->IsAction( &PCB_ACTIONS::toggleHV45Mode ) )
 {
 hv45Mode = !hv45Mode;
 displayConstraintsMessage( hv45Mode );
 evt->SetPassEvent( false );
 }
 else if( ZONE_FILLER_TOOL::IsZoneFillAction( evt ) )
 {
 wxBell();
 }
 else
 {
 evt->SetPassEvent();
 }
 
 } while( ( evt = Wait() ) ); // Assignment (instead of equality test) is intentional
 
 // Clear temporary COURTYARD_CONFLICT flag and ensure the conflict shadow is cleared
 if( showCourtyardConflicts )
 drc_on_move->ClearConflicts( m_toolMgr->GetView() );
 
 controls->ForceCursorPosition( false );
 controls->ShowCursor( false );
 controls->SetAutoPan( false );
 
 m_dragging = false;
 editFrame->UndoRedoBlock( false );
 
 // Discard reference point when selection is "dropped" onto the board
 selection.ClearReferencePoint();
 
 // Unselect all items to clear selection flags and then re-select the originally selected
 // items (after the potential Revert()).
 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 
 // TODO: there's an encapsulation leak here: this commit often has more than just the move
 // in it; for instance it might have a paste, append board, etc. as well.
 if( restore_state )
 {
 m_commit->Revert();
 m_selectionTool->RebuildSelection();
 
 // Mainly for point editor, but there might be other clients that need to adjust to
 // reverted state.
 m_toolMgr->PostEvent( EVENTS::SelectedItemsMoved );
 
 // Property panel needs to know about the reselect
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 
 if( hasRedrawn3D )
 editFrame->Update3DView( false, true );
 }
 else
 {
 m_commit->Push( aCommitMessage );
 m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &orig_items );
 }
 
 m_toolMgr->GetTool<DRAWING_TOOL>()->UpdateStatusBar();
 // Remove the dynamic ratsnest from the screen
 m_toolMgr->RunAction( PCB_ACTIONS::hideLocalRatsnest, true );
 
 editFrame->PopTool( aEvent );
 editFrame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
 
 return restore_state ? -1 : 0;
}