/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2013-2017 CERN * Copyright (C) 2017-2023 KiCad Developers, see AUTHORS.txt for contributors. * @author Maciej Suminski * @author Tomasz Wlostowski * * 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 #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include 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]; if( item->Type() == PCB_TRACE_T ) aCollector.Remove( item ); } }, true /* prompt user regarding locked items */ ); if( selection.Size() < 2 ) return 0; BOARD_COMMIT localCommit( this ); BOARD_COMMIT* commit = dynamic_cast( aEvent.Commit() ); if( !commit ) commit = &localCommit; std::vector sorted = selection.GetItemsSortedBySelectionOrder(); // Save items, so changes can be undone for( EDA_ITEM* item : selection ) { if( !item->IsNew() && !item->IsMoving() ) { commit->Modify( item ); // If swapping a group, record position of all the descendants for undo if( item->Type() == PCB_GROUP_T ) { PCB_GROUP* group = static_cast( item ); group->RunOnDescendants( [&]( BOARD_ITEM* descendant ) { commit->Modify( descendant ); }); } } } for( size_t i = 0; i < sorted.size() - 1; i++ ) { BOARD_ITEM* a = dynamic_cast( sorted[i] ); BOARD_ITEM* b = dynamic_cast( sorted[( i + 1 ) % sorted.size()] ); wxCHECK2( a && b, continue ); // Swap X,Y position VECTOR2I aPos = a->GetPosition(), bPos = b->GetPosition(); std::swap( aPos, bPos ); a->SetPosition( aPos ); b->SetPosition( bPos ); // 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( a ); FOOTPRINT* bFP = static_cast( 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( !localCommit.Empty() ) localCommit.Push( _( "Swap" ) ); m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified ); return 0; } int EDIT_TOOL::PackAndMoveFootprints( const TOOL_EVENT& aEvent ) { if( isRouterActive() || m_dragging ) { wxBell(); return 0; } BOARD_COMMIT commit( this ); 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, true ); // 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( item ) ) aCollector.Remove( item ); } }, true /* prompt user regarding locked items */ ); std::vector footprintsToPack; for( EDA_ITEM* item : selection ) footprintsToPack.push_back( static_cast( item ) ); if( footprintsToPack.empty() ) return 0; BOX2I footprintsBbox; for( FOOTPRINT* item : footprintsToPack ) { commit.Modify( item ); item->SetFlags( IS_MOVING ); footprintsBbox.Merge( item->GetBoundingBox( false, false ) ); } SpreadFootprints( &footprintsToPack, footprintsBbox.Normalize().GetOrigin(), false ); if( doMoveSelection( aEvent, &commit ) ) commit.Push( _( "Pack footprints" ) ); else commit.Revert(); return 0; } int EDIT_TOOL::Move( const TOOL_EVENT& aEvent ) { if( isRouterActive() || m_dragging ) { wxBell(); return 0; } if( BOARD_COMMIT* commit = dynamic_cast( aEvent.Commit() ) ) { wxCHECK( aEvent.SynchronousState(), 0 ); aEvent.SynchronousState()->store( STS_RUNNING ); if( doMoveSelection( aEvent, commit ) ) aEvent.SynchronousState()->store( STS_FINISHED ); else aEvent.SynchronousState()->store( STS_CANCELLED ); } else { BOARD_COMMIT localCommit( this ); if( doMoveSelection( aEvent, &localCommit ) ) localCommit.Push( _( "Move" ) ); else localCommit.Revert(); } return 0; } VECTOR2I EDIT_TOOL::getSafeMovement( const VECTOR2I& aMovement, const BOX2I& aSourceBBox, const VECTOR2D& aBBoxOffset ) { typedef std::numeric_limits 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( tryMovement ); } bool EDIT_TOOL::doMoveSelection( const TOOL_EVENT& aEvent, BOARD_COMMIT* aCommit ) { bool moveWithReference = aEvent.IsAction( &PCB_ACTIONS::moveWithReference ); bool moveIndividually = aEvent.IsAction( &PCB_ACTIONS::moveIndividually ); PCB_BASE_EDIT_FRAME* editFrame = getEditFrame(); 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; // 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() ) return false; 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() ) return false; editFrame->PushTool( aEvent ); 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" ) : wxString( wxT( "" ) ) ); }; auto updateStatusPopup = [&]( EDA_ITEM* item, size_t ii, size_t count ) { wxString popuptext = _( "Click to place %s (item %zu of %zu)\n" "Press to cancel all; double-click to finish" ); wxString msg; if( item->Type() == PCB_FOOTPRINT_T ) { FOOTPRINT* fp = static_cast( item ); msg = fp->GetReference(); } else if( item->Type() == PCB_PAD_T ) { PAD* pad = static_cast( item ); FOOTPRINT* fp = 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 sel_items; // All the items operated on by the move below std::vector orig_items; // All the original items in the selection for( EDA_ITEM* item : selection ) { if( BOARD_ITEM* boardItem = dynamic_cast( item ) ) { if( !is_hover ) orig_items.push_back( boardItem ); sel_items.push_back( boardItem ); } if( FOOTPRINT* footprint = dynamic_cast( item ) ) { 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 ); editFrame->PopTool( aEvent ); return false; } if( moveIndividually ) { orig_items.clear(); for( EDA_ITEM* item : selection.GetItemsSortedBySelectionOrder() ) { if( BOARD_ITEM* boardItem = dynamic_cast( item ) ) orig_items.push_back( boardItem ); } updateStatusPopup( orig_items[ itemIdx ], itemIdx + 1, orig_items.size() ); statusPopup.Popup(); statusPopup.Move( KIPLATFORM::UI::GetMousePosition() + 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 = © VECTOR2I prevPos; bool hv45Mode = false; bool eatFirstMouseUp = true; bool allowRedraw3D = cfg->m_Display.m_Live3DRefresh; bool showCourtyardConflicts = !m_isFootprintEditor && cfg->m_ShowCourtyardCollisions; // Used to test courtyard overlaps std::unique_ptr drc_on_move = nullptr; if( showCourtyardConflicts ) { std::shared_ptr drcEngine = m_toolMgr->GetTool()->GetDRCEngine(); drc_on_move.reset( new DRC_INTERACTIVE_COURTYARD_CLEARANCE( drcEngine ) ); drc_on_move->Init( board ); } displayConstraintsMessage( hv45Mode ); // Prime the pump m_toolMgr->PostAction( 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, grid.GetSelectionGrid( selection ), 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( item )->Move( movement ); if( !redraw3D && item->Type() == PCB_FOOTPRINT_T ) redraw3D = true; } if( redraw3D && allowRedraw3D ) editFrame->Update3DView( false, 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; for( EDA_ITEM* item : selection ) { if( item->GetParent() && item->GetParent()->IsSelected() ) continue; if( !item->IsNew() && !item->IsMoving() ) { aCommit->Modify( item ); item->SetFlags( IS_MOVING ); // If moving a group, record position of all the descendants for undo if( item->Type() == PCB_GROUP_T ) { PCB_GROUP* group = static_cast( item ); group->RunOnDescendants( [&]( BOARD_ITEM* bItem ) { aCommit->Modify( bItem ); item->SetFlags( IS_MOVING ); }); } } } 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( 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( item ) ); } m_cursor = grid.BestDragOrigin( originalCursorPos, sel_items, grid.GetSelectionGrid( selection ), &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( KIPLATFORM::UI::GetMousePosition() + wxPoint( 20, 20 ) ); m_toolMgr->PostAction( PCB_ACTIONS::updateLocalRatsnest, 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 ) || evt->IsAction( &ACTIONS::doDelete ) ) { restore_state = true; // Perform undo locally break; // Finish } else if( evt->IsAction( &ACTIONS::duplicate ) || evt->IsAction( &ACTIONS::cut ) ) { } 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->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) || isSkip ) { // Eat mouse-up/-click events that leaked through from the lock dialog if( eatFirstMouseUp && evt->Parameter() != 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 aCommit->Modify( nextItem ); nextItem->Move( controls->GetCursorPosition( true ) - nextItem->GetPosition() ); 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 ) || evt->IsAction( &PCB_ACTIONS::moveExact ) || evt->IsAction( &PCB_ACTIONS::moveWithReference ) || evt->IsAction( &PCB_ACTIONS::copyWithReference ) || evt->IsAction( &PCB_ACTIONS::positionRelative ) || evt->IsAction( &ACTIONS::redo ) ) { 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; // 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. m_toolMgr->RunAction( PCB_ACTIONS::selectionClear ); if( !restore_state ) { EDA_ITEMS oItems( orig_items.begin(), orig_items.end() ); m_toolMgr->RunAction( PCB_ACTIONS::selectItems, &oItems ); } // Remove the dynamic ratsnest from the screen m_toolMgr->RunAction( PCB_ACTIONS::hideLocalRatsnest ); editFrame->PopTool( aEvent ); editFrame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW ); return !restore_state; }