KiCad PCB EDA Suite
edit_tool.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013-2017 CERN
5  * @author Maciej Suminski <maciej.suminski@cern.ch>
6  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
7  * Copyright (C) 2017-2019 KiCad Developers, see AUTHORS.txt for contributors.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #include <limits>
28 #include <class_board.h>
29 #include <class_module.h>
30 #include <class_edge_mod.h>
31 #include <collectors.h>
32 #include <pcb_edit_frame.h>
33 #include <kiway.h>
34 #include <footprint_edit_frame.h>
35 #include <array_creator.h>
36 #include <pcbnew_id.h>
37 #include <status_popup.h>
38 #include <tool/tool_manager.h>
39 #include <tools/pcb_actions.h>
40 #include <tools/selection_tool.h>
41 #include <tools/edit_tool.h>
43 #include <tools/tool_event_utils.h>
44 #include <tools/grid_helper.h>
45 #include <view/view_controls.h>
47 #include <confirm.h>
48 #include <bitmaps.h>
49 #include <cassert>
50 #include <functional>
51 using namespace std::placeholders;
52 #include "kicad_clipboard.h"
53 #include <router/router_tool.h>
57 #include <board_commit.h>
58 
59 
60 void EditToolSelectionFilter( GENERAL_COLLECTOR& aCollector, int aFlags )
61 {
62  // Iterate from the back so we don't have to worry about removals.
63  for( int i = aCollector.GetCount() - 1; i >= 0; --i )
64  {
65  BOARD_ITEM* item = aCollector[ i ];
66 
67  if( ( aFlags & EXCLUDE_LOCKED ) && item->IsLocked() )
68  {
69  aCollector.Remove( item );
70  }
71  else if( item->Type() == PCB_PAD_T )
72  {
73  MODULE* mod = static_cast<MODULE*>( item->GetParent() );
74 
75  // case 1: handle locking
76  if( ( aFlags & EXCLUDE_LOCKED ) && mod && mod->IsLocked() )
77  {
78  aCollector.Remove( item );
79  }
80  else if( ( aFlags & EXCLUDE_LOCKED_PADS ) && mod && mod->PadsLocked() )
81  {
82  // Pad locking is considerably "softer" than item locking
83  aCollector.Remove( item );
84 
85  if( !mod->IsLocked() && !aCollector.HasItem( mod ) )
86  aCollector.Append( mod );
87  }
88 
89  // case 2: selection contains both the module and its pads - remove the pads
90  if( mod && aCollector.HasItem( mod ) )
91  aCollector.Remove( item );
92  }
93  else if( ( aFlags & EXCLUDE_TRANSIENTS ) && item->Type() == PCB_MARKER_T )
94  {
95  aCollector.Remove( item );
96  }
97  }
98 }
99 
100 
102  PCB_TOOL_BASE( "pcbnew.InteractiveEdit" ),
103  m_selectionTool( NULL ),
104  m_dragging( false ),
105  m_lockedSelected( false )
106 {
107 }
108 
109 
111 {
112  m_dragging = false;
113 
114  if( aReason != RUN )
115  m_commit.reset( new BOARD_COMMIT( this ) );
116 }
117 
118 
120 {
121  // Find the selection tool, so they can cooperate
122  m_selectionTool = static_cast<SELECTION_TOOL*>( m_toolMgr->FindTool( "pcbnew.InteractiveSelection" ) );
123  wxASSERT_MSG( m_selectionTool, "pcbnew.InteractiveSelection tool is not available" );
124 
125  auto editingModuleCondition = [ this ] ( const SELECTION& aSelection ) {
126  return m_editModules;
127  };
128 
129  auto singleModuleCondition = SELECTION_CONDITIONS::OnlyType( PCB_MODULE_T )
131 
132  auto noActiveToolCondition = [ this ] ( const SELECTION& aSelection ) {
133  return frame()->ToolStackIsEmpty();
134  };
135 
136  // Add context menu entries that are displayed when selection tool is active
138 
150 
155  menu.AddItem( PCB_ACTIONS::mirror, editingModuleCondition && SELECTION_CONDITIONS::NotEmpty );
156 
157  menu.AddSeparator();
160  // Selection tool handles the context menu for some other tools, such as the Picker.
161  // Don't add things like Paste when another tool is active.
162  menu.AddItem( ACTIONS::paste, noActiveToolCondition );
163 
164  // Footprint actions
165  menu.AddSeparator();
166  menu.AddItem( PCB_ACTIONS::editFootprintInFpEditor, singleModuleCondition );
167  menu.AddItem( PCB_ACTIONS::updateFootprint, singleModuleCondition );
168  menu.AddItem( PCB_ACTIONS::changeFootprint, singleModuleCondition );
169 
170  // Populate the context menu displayed during the edit tool (primarily the measure tool)
171  auto activeToolCondition = [ this ] ( const SELECTION& aSel ) {
172  return frame()->ToolStackIsEmpty();
173  };
174 
175  auto frame = getEditFrame<PCB_BASE_FRAME>();
176  auto& ctxMenu = m_menu.GetMenu();
177 
178  // "Cancel" goes at the top of the context menu when a tool is active
179  ctxMenu.AddItem( ACTIONS::cancelInteractive, activeToolCondition, 1 );
180  ctxMenu.AddSeparator( 1 );
181 
182  if( frame )
184 
185  return true;
186 }
187 
188 
189 int EDIT_TOOL::GetAndPlace( const TOOL_EVENT& aEvent )
190 {
191  SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<SELECTION_TOOL>();
192  MODULE* module = getEditFrame<PCB_BASE_FRAME>()->GetFootprintFromBoardByReference();
193 
194  if( module )
195  {
198 
199  selectionTool->GetSelection().SetReferencePoint( module->GetPosition() );
201  }
202 
203  return 0;
204 }
205 
206 
207 bool EDIT_TOOL::invokeInlineRouter( int aDragMode )
208 {
210 
211  if( !theRouter )
212  return false;
213 
214  // make sure we don't accidentally invoke inline routing mode while the router is already active!
215  if( theRouter->IsToolActive() )
216  return false;
217 
218  if( theRouter->CanInlineDrag() )
219  {
221  return true;
222  }
223 
224  return false;
225 }
226 
227 
229 {
230  auto theRouter = static_cast<ROUTER_TOOL*>( m_toolMgr->FindTool( "pcbnew.InteractiveRouter" ) );
231 
232  return theRouter ? theRouter->Router()->Settings().InlineDragEnabled() : false;
233 }
234 
235 
236 int EDIT_TOOL::Drag( const TOOL_EVENT& aEvent )
237 {
238  int mode = PNS::DM_ANY;
239 
240  if( aEvent.IsAction( &PCB_ACTIONS::dragFreeAngle ) )
241  mode |= PNS::DM_FREE_ANGLE;
242 
243  invokeInlineRouter( mode );
244 
245  return 0;
246 }
247 
248 int EDIT_TOOL::Move( const TOOL_EVENT& aEvent )
249 {
251  PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
252  VECTOR2I originalCursorPos = controls->GetCursorPosition();
253 
254  // Be sure that there is at least one item that we can modify. If nothing was selected before,
255  // try looking for the stuff under mouse cursor (i.e. Kicad old-style hover selection)
257  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
258  {
260  } );
261 
262  if( m_dragging || selection.Empty() )
263  return 0;
264 
265  LSET item_layers = selection.GetSelectionLayers();
266  bool unselect = selection.IsHover(); //N.B. This must be saved before the re-selection below
267 
268  // Now filter out locked pads. We cannot do this in the first RequestSelection() as we need
269  // the item_layers when a pad is the selection front (ie: will become curr_tiem).
271  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
272  {
274  } );
275 
276  if( selection.Empty() )
277  return 0;
278 
279  std::string tool = aEvent.GetCommandStr().get();
280  editFrame->PushTool( tool );
281  Activate();
282  controls->ShowCursor( true );
283  controls->SetAutoPan( true );
284 
285  std::vector<BOARD_ITEM*> sel_items;
286 
287  for( EDA_ITEM* item : selection )
288  {
289  BOARD_ITEM* boardItem = dynamic_cast<BOARD_ITEM*>( item );
290  MODULE* module = dynamic_cast<MODULE*>( item );
291 
292  if( boardItem )
293  sel_items.push_back( boardItem );
294 
295  if( module )
296  {
297  for( D_PAD* pad : module->Pads() )
298  sel_items.push_back( pad );
299  }
300  }
301 
302  bool restore_state = false;
303  VECTOR2I totalMovement;
304  GRID_HELPER grid( editFrame );
305  TOOL_EVENT* evt = const_cast<TOOL_EVENT*>( &aEvent );
306  VECTOR2I prevPos;
307 
308  // Prime the pump
310 
311  // Main loop: keep receiving events
312  do
313  {
314  editFrame->GetCanvas()->SetCurrentCursor( wxCURSOR_ARROW );
315  grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
316  grid.SetUseGrid( !evt->Modifier( MD_ALT ) );
317  controls->SetSnapping( !evt->Modifier( MD_ALT ) );
318 
319  if( evt->IsAction( &PCB_ACTIONS::move ) || evt->IsMotion() ||
320  evt->IsAction( &PCB_ACTIONS::drag ) || evt->IsDrag( BUT_LEFT ) ||
322  {
323  if( m_dragging && evt->Category() == TC_MOUSE )
324  {
325  VECTOR2I mousePos( controls->GetMousePosition() );
326  m_cursor = grid.BestSnapAnchor( mousePos, item_layers, sel_items );
329 
330  VECTOR2I movement( m_cursor - prevPos );
331  prevPos = m_cursor;
332  totalMovement += movement;
333 
334  // Drag items to the current cursor position
335  for( EDA_ITEM* item : sel_items )
336  {
337  // Don't double move footprint pads, fields, etc.
338  if( !item->GetParent() || !item->GetParent()->IsSelected() )
339  static_cast<BOARD_ITEM*>( item )->Move( movement );
340  }
341 
342  frame()->UpdateMsgPanel();
343  }
344  else if( !m_dragging ) // Prepare to start dragging
345  {
347  {
349  break;
350  }
351 
352  // deal with locked items (override lock or abort the operation)
354 
355  if( lockFlags == SELECTION_LOCKED )
356  break;
357 
358  m_dragging = true;
359 
360  // When editing modules, all items have the same parent
361  if( EditingModules() )
362  {
363  m_commit->Modify( selection.Front() );
364  }
365  else
366  {
367  // Save items, so changes can be undone
368  for( EDA_ITEM* item : selection )
369  {
370  // Don't double move footprint pads, fields, etc.
371  if( item->GetParent() && item->GetParent()->IsSelected() )
372  continue;
373 
374  m_commit->Modify( item );
375  }
376  }
377 
378  editFrame->UndoRedoBlock( true );
380 
382  {
383  // start moving with the reference point attached to the cursor
384  grid.SetAuxAxes( false );
385 
386  auto delta = m_cursor - selection.GetReferencePoint();
387 
388  // Drag items to the current cursor position
389  for( EDA_ITEM* item : selection )
390  {
391  // Don't double move footprint pads, fields, etc.
392  if( item->GetParent() && item->GetParent()->IsSelected() )
393  continue;
394 
395  static_cast<BOARD_ITEM*>( item )->Move( delta );
396  }
397 
399  }
400  else
401  {
402  std::vector<BOARD_ITEM*> items;
403 
404  for( EDA_ITEM* item : selection )
405  items.push_back( static_cast<BOARD_ITEM*>( item ) );
406 
407  // Set the current cursor position to the first dragged item origin, so the
408  // movement vector could be computed later
409  m_cursor = grid.BestDragOrigin( originalCursorPos, items );
411  grid.SetAuxAxes( true, m_cursor );
412  }
413 
415 
416  prevPos = m_cursor;
417  controls->SetAutoPan( true );
418  }
419 
422  }
423 
424  else if( evt->IsCancelInteractive() || evt->IsActivate() )
425  {
426  restore_state = true; // Canceling the tool means that items have to be restored
427  break; // Finish
428  }
429 
430  else if( evt->Action() == TA_UNDO_REDO_PRE )
431  {
432  unselect = true;
433  break;
434  }
435 
436  // Dispatch TOOL_ACTIONs
437  else if( evt->Category() == TC_COMMAND )
438  {
439  if( evt->IsAction( &ACTIONS::doDelete ) )
440  {
441  break; // finish -- there is no further processing for removed items
442  }
443  else if( evt->IsAction( &ACTIONS::duplicate ) )
444  {
445  break; // finish -- Duplicate tool will start a new Move with the dup'ed items
446  }
447  else if( evt->IsAction( &PCB_ACTIONS::moveExact ) )
448  {
449  // Reset positions so the Move Exactly is from the start.
450  for( EDA_ITEM* item : selection )
451  {
452  BOARD_ITEM* i = static_cast<BOARD_ITEM*>( item );
453  i->Move( -totalMovement );
454  }
455 
456  break; // finish -- we moved exactly, so we are finished
457  }
458  }
459 
460  else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) )
461  {
462  break; // finish
463  }
464 
465  else
466  {
467  evt->SetPassEvent();
468  }
469 
470  } while( ( evt = Wait() ) ); // Assignment (instead of equality test) is intentional
471 
472  m_lockedSelected = false;
473  controls->ForceCursorPosition( false );
474  controls->ShowCursor( false );
475  controls->SetSnapping( false );
476  controls->SetAutoPan( false );
477 
478  m_dragging = false;
479  editFrame->UndoRedoBlock( false );
480 
481  // Discard reference point when selection is "dropped" onto the board (ie: not dragging anymore)
483 
484  if( unselect )
486 
487  // If canceled, we need to remove the dynamic ratsnest from the screen
488  if( restore_state )
489  {
491  m_commit->Revert();
492  }
493  else
494  {
495  m_commit->Push( _( "Drag" ) );
496  }
497 
498  editFrame->PopTool( tool );
499  return 0;
500 }
501 
503 {
505  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
506  { EditToolSelectionFilter( aCollector, EXCLUDE_TRANSIENTS ); } );
507 
508  for( EDA_ITEM* item : selection )
509  {
510  if( auto via = dyn_cast<VIA*>( item ) )
511  {
512  m_commit->Modify( item );
513 
514  int new_width;
515  int new_drill;
516 
517  if( via->GetViaType() == VIA_MICROVIA )
518  {
519  auto net = via->GetNet();
520 
521  new_width = net->GetMicroViaSize();
522  new_drill = net->GetMicroViaDrillSize();
523  }
524  else
525  {
526  new_width = board()->GetDesignSettings().GetCurrentViaSize();
527  new_drill = board()->GetDesignSettings().GetCurrentViaDrill();
528  }
529 
530  via->SetDrill( new_drill );
531  via->SetWidth( new_width );
532  }
533  else if ( auto track = dyn_cast<TRACK*>( item ) )
534  {
535  m_commit->Modify( item );
536 
537  int new_width = board()->GetDesignSettings().GetCurrentTrackWidth();
538  track->SetWidth( new_width );
539  }
540  }
541 
542  m_commit->Push( _("Edit track width/via size") );
543 
544  if( selection.IsHover() )
545  {
547 
548  // Notify other tools of the changes -- This updates the visual ratsnest
550  }
551 
552  return 0;
553 }
554 
555 
556 int EDIT_TOOL::Properties( const TOOL_EVENT& aEvent )
557 {
558  PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
559 
561  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
562  { EditToolSelectionFilter( aCollector, EXCLUDE_TRANSIENTS ); } );
563 
564  // Tracks & vias are treated in a special way:
566  {
567  DIALOG_TRACK_VIA_PROPERTIES dlg( editFrame, selection, *m_commit );
568  dlg.ShowQuasiModal(); // QuasiModal required for NET_SELECTOR
569  }
570  else if( selection.Size() == 1 ) // Properties are displayed when there is only one item selected
571  {
572  // Display properties dialog
573  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( selection.Front() );
574 
575  // Do not handle undo buffer, it is done by the properties dialogs
576  editFrame->OnEditItemRequest( item );
577 
578  // Notify other tools of the changes
580  }
581 
582  if( selection.IsHover() )
583  {
585 
586  // Notify other tools of the changes -- This updates the visual ratsnest
588  }
589 
590  return 0;
591 }
592 
593 
594 int EDIT_TOOL::Rotate( const TOOL_EVENT& aEvent )
595 {
596  PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
597 
599  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
600  { EditToolSelectionFilter( aCollector, EXCLUDE_LOCKED_PADS | EXCLUDE_TRANSIENTS ); }, nullptr, ! m_dragging );
601 
602  if( selection.Empty() )
603  return 0;
604 
606  auto refPt = selection.GetReferencePoint();
607  const int rotateAngle = TOOL_EVT_UTILS::GetEventRotationAngle( *editFrame, aEvent );
608 
609  // When editing modules, all items have the same parent
610  if( EditingModules() )
611  m_commit->Modify( selection.Front() );
612 
613  for( auto item : selection )
614  {
615  if( !item->IsNew() && !EditingModules() )
616  m_commit->Modify( item );
617 
618  static_cast<BOARD_ITEM*>( item )->Rotate( refPt, rotateAngle );
619  }
620 
621  if( !m_dragging )
622  m_commit->Push( _( "Rotate" ) );
623 
624  if( selection.IsHover() && !m_dragging )
626 
628 
629  if( m_dragging )
631 
632  return 0;
633 }
634 
635 
639 static wxPoint mirrorPointX( const wxPoint& aPoint, const wxPoint& aMirrorPoint )
640 {
641  wxPoint mirrored = aPoint;
642 
643  mirrored.x -= aMirrorPoint.x;
644  mirrored.x = -mirrored.x;
645  mirrored.x += aMirrorPoint.x;
646 
647  return mirrored;
648 }
649 
650 
654 static void mirrorPadX( D_PAD& aPad, const wxPoint& aMirrorPoint )
655 {
656  wxPoint tmpPt = mirrorPointX( aPad.GetPosition(), aMirrorPoint );
657 
658  if( aPad.GetShape() == PAD_SHAPE_CUSTOM )
659  aPad.MirrorXPrimitives( tmpPt.x );
660 
661  aPad.SetPosition( tmpPt );
662 
663  aPad.SetX0( aPad.GetPosition().x );
664 
665  tmpPt = aPad.GetOffset();
666  tmpPt.x = -tmpPt.x;
667  aPad.SetOffset( tmpPt );
668 
669  auto tmpz = aPad.GetDelta();
670  tmpz.x = -tmpz.x;
671  aPad.SetDelta( tmpz );
672 
673  aPad.SetOrientation( -aPad.GetOrientation() );
674 }
675 
676 
677 int EDIT_TOOL::Mirror( const TOOL_EVENT& aEvent )
678 {
680  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
681  { EditToolSelectionFilter( aCollector, EXCLUDE_LOCKED_PADS | EXCLUDE_TRANSIENTS ); }, nullptr, ! m_dragging );
682 
683  if( selection.Empty() )
684  return 0;
685 
687  auto refPoint = selection.GetReferencePoint();
688  wxPoint mirrorPoint( refPoint.x, refPoint.y );
689 
690  // When editing modules, all items have the same parent
691  if( EditingModules() )
692  m_commit->Modify( selection.Front() );
693 
694  for( EDA_ITEM* item : selection )
695  {
696  // only modify items we can mirror
697  switch( item->Type() )
698  {
699  case PCB_MODULE_EDGE_T:
700  case PCB_MODULE_TEXT_T:
701  case PCB_PAD_T:
702  // Only create undo entry for items on the board
703  if( !item->IsNew() && !EditingModules() )
704  m_commit->Modify( item );
705 
706  break;
707  default:
708  continue;
709  }
710 
711  // modify each object as necessary
712  switch( item->Type() )
713  {
714  case PCB_MODULE_EDGE_T:
715  {
716  auto& edge = static_cast<EDGE_MODULE&>( *item );
717  edge.Mirror( mirrorPoint, false );
718  break;
719  }
720 
721  case PCB_MODULE_TEXT_T:
722  {
723  auto& modText = static_cast<TEXTE_MODULE&>( *item );
724  modText.Mirror( mirrorPoint, false );
725  break;
726  }
727 
728  case PCB_PAD_T:
729  {
730  auto& pad = static_cast<D_PAD&>( *item );
731  mirrorPadX( pad, mirrorPoint );
732  break;
733  }
734 
735  default:
736  // it's likely the commit object is wrong if you get here
737  assert( false );
738  break;
739  }
740  }
741 
742  if( !m_dragging )
743  m_commit->Push( _( "Mirror" ) );
744 
745  if( selection.IsHover() && !m_dragging )
747 
749 
750  if( m_dragging )
752 
753  return 0;
754 }
755 
756 
757 int EDIT_TOOL::Flip( const TOOL_EVENT& aEvent )
758 {
760  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
762  nullptr, ! m_dragging );
763 
764  if( selection.Empty() )
765  return 0;
766 
768 
769  // Flip around the anchor for footprints, and the bounding box center for board items
770  VECTOR2I modPoint = EditingModules() ? VECTOR2I( 0, 0 ) : selection.GetCenter();
771 
772  // If only one item selected, flip around the item anchor point, instead
773  // of the bounding box center, to avoid moving the item anchor
774  if( selection.GetSize() == 1 )
775  modPoint = static_cast<BOARD_ITEM*>( selection.GetItem( 0 ) )->GetPosition();
776 
777  bool leftRight = frame()->Settings().m_FlipLeftRight;
778 
779  // When editing modules, all items have the same parent
780  if( EditingModules() )
781  m_commit->Modify( selection.Front() );
782 
783  for( EDA_ITEM* item : selection )
784  {
785  if( !item->IsNew() && !EditingModules() )
786  m_commit->Modify( item );
787 
788  static_cast<BOARD_ITEM*>( item )->Flip( modPoint, leftRight );
789  }
790 
791  if( !m_dragging )
792  m_commit->Push( _( "Flip" ) );
793 
794  if( selection.IsHover() && !m_dragging )
796 
798 
799  if( m_dragging )
801 
802  return 0;
803 }
804 
805 
806 int EDIT_TOOL::Remove( const TOOL_EVENT& aEvent )
807 {
808  ROUTER_TOOL* routerTool = static_cast<ROUTER_TOOL*>
809  ( m_toolMgr->FindTool( "pcbnew.InteractiveRouter" ) );
810 
811  // Do not delete items while actively routing.
812  if( routerTool && routerTool->Router() && routerTool->Router()->RoutingInProgress() )
813  return 1;
814 
815  std::vector<BOARD_ITEM*> lockedItems;
816  Activate();
817 
818  // get a copy instead of reference (as we're going to clear the selection before removing items)
819  PCBNEW_SELECTION selectionCopy;
822 
823  // If we are in a "Cut" operation, then the copied selection exists already
824  if( isCut )
825  {
826  selectionCopy = m_selectionTool->GetSelection();
827  }
828  else
829  {
830  selectionCopy = m_selectionTool->RequestSelection(
831  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
833  }
834 
835  bool isHover = selectionCopy.IsHover();
836 
837  // in "alternative" mode, deletion is not just a simple list of selected items,
838  // it removes whole tracks, not just segments
839  if( isAlt && isHover
840  && ( selectionCopy.HasType( PCB_TRACE_T ) || selectionCopy.HasType( PCB_VIA_T ) ) )
841  {
843  }
844 
845  if( selectionCopy.Empty() )
846  return 0;
847 
848  // N.B. Setting the CUT flag prevents lock filtering as we only want to delete the items that
849  // were copied to the clipboard, no more, no fewer. Filtering for locked item, if any will be done
850  // in the copyToClipboard() routine
851  if( !m_lockedSelected && !isCut )
852  {
853  // Second RequestSelection removes locked items but keeps a copy of their pointers
854  selectionCopy = m_selectionTool->RequestSelection(
855  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
856  { EditToolSelectionFilter( aCollector, EXCLUDE_LOCKED ); }, &lockedItems );
857  }
858 
859 
860  // As we are about to remove items, they have to be removed from the selection first
862 
863  for( EDA_ITEM* item : selectionCopy )
864  {
865  if( m_editModules )
866  {
867  m_commit->Remove( item );
868  continue;
869  }
870 
871  switch( item->Type() )
872  {
873  case PCB_MODULE_TEXT_T:
874  {
875  auto text = static_cast<TEXTE_MODULE*>( item );
876  auto parent = static_cast<MODULE*>( item->GetParent() );
877 
878  if( text->GetType() == TEXTE_MODULE::TEXT_is_DIVERS )
879  {
880  m_commit->Modify( text );
881  getView()->Remove( text );
882  parent->Remove( text );
883  }
884  }
885  break;
886 
887  default:
888  m_commit->Remove( item );
889  break;
890  }
891  }
892 
893  if( isCut )
894  m_commit->Push( _( "Cut" ) );
895  else
896  m_commit->Push( _( "Delete" ) );
897 
898  if( !m_lockedSelected && !lockedItems.empty() )
899  {
901  STATUS_TEXT_POPUP statusPopup( frame() );
902 
903  m_lockedSelected = true;
904  m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &lockedItems );
905  statusPopup.SetText( _( "Delete again to remove locked items" ) );
906  statusPopup.PopupFor( 2000 );
907  statusPopup.Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
908 
909  Activate();
910 
911  while( m_lockedSelected && statusPopup.IsShown() )
912  {
913  statusPopup.Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
914  Wait();
915  }
916  }
917 
918  m_lockedSelected = false;
919 
920  return 0;
921 }
922 
923 
924 int EDIT_TOOL::MoveExact( const TOOL_EVENT& aEvent )
925 {
927  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
929 
930  if( selection.Empty() )
931  return 0;
932 
933  PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>();
934  wxPoint translation;
935  double rotation;
936  ROTATION_ANCHOR rotationAnchor = selection.Size() > 1 ? ROTATE_AROUND_SEL_CENTER
938 
939  // TODO: Implement a visible bounding border at the edge
940  auto sel_box = selection.GetBoundingBox();
941 
942  DIALOG_MOVE_EXACT dialog( editFrame, translation, rotation, rotationAnchor, sel_box );
943  int ret = dialog.ShowModal();
944 
945  if( ret == wxID_OK )
946  {
948  wxPoint selCenter( rp.x, rp.y );
949 
950  // Make sure the rotation is from the right reference point
951  selCenter += translation;
952 
953  // When editing modules, all items have the same parent
954  if( EditingModules() )
955  m_commit->Modify( selection.Front() );
956 
957  for( EDA_ITEM* selItem : selection )
958  {
959  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( selItem );
960 
961  if( !item->IsNew() && !EditingModules() )
962  m_commit->Modify( item );
963 
964  item->Move( translation );
965 
966  switch( rotationAnchor )
967  {
969  item->Rotate( item->GetPosition(), rotation );
970  break;
972  item->Rotate( selCenter, rotation );
973  break;
975  item->Rotate( (wxPoint) editFrame->GetScreen()->m_LocalOrigin, rotation );
976  break;
978  item->Rotate( editFrame->GetAuxOrigin(), rotation );
979  break;
980  }
981 
982  if( !m_dragging )
983  getView()->Update( item );
984  }
985 
986  m_commit->Push( _( "Move exact" ) );
987 
988  if( selection.IsHover() )
990 
992 
993  if( m_dragging )
995  }
996 
997  return 0;
998 }
999 
1000 
1001 int EDIT_TOOL::Duplicate( const TOOL_EVENT& aEvent )
1002 {
1003  bool increment = aEvent.IsAction( &PCB_ACTIONS::duplicateIncrement );
1004 
1005  // Be sure that there is at least one item that we can modify
1007  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
1009 
1010  if( selection.Empty() )
1011  return 0;
1012 
1013  // we have a selection to work on now, so start the tool process
1014  PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
1015 
1016  // If the selection was given a hover, we do not keep the selection after completion
1017  bool is_hover = selection.IsHover();
1018 
1019  std::vector<BOARD_ITEM*> new_items;
1020  new_items.reserve( selection.Size() );
1021 
1022  BOARD_ITEM* orig_item = nullptr;
1023  BOARD_ITEM* dupe_item = nullptr;
1024 
1025  // Each selected item is duplicated and pushed to new_items list
1026  // Old selection is cleared, and new items are then selected.
1027  for( EDA_ITEM* item : selection )
1028  {
1029  orig_item = static_cast<BOARD_ITEM*>( item );
1030 
1031  if( m_editModules )
1032  dupe_item = editFrame->GetBoard()->GetFirstModule()->Duplicate( orig_item, increment );
1033  else
1034  dupe_item = editFrame->GetBoard()->Duplicate( orig_item );
1035 
1036  if( dupe_item )
1037  {
1038  // Clear the selection flag here, otherwise the SELECTION_TOOL
1039  // will not properly select it later on
1040  dupe_item->ClearSelected();
1041 
1042  new_items.push_back( dupe_item );
1043  m_commit->Add( dupe_item );
1044  }
1045  }
1046 
1047  // Clear the old selection first
1049 
1050  // Select the new items
1051  m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &new_items );
1052 
1053  // record the new items as added
1054  if( !selection.Empty() )
1055  {
1056  editFrame->DisplayToolMsg( wxString::Format( _( "Duplicated %d item(s)" ),
1057  (int) new_items.size() ) );
1058 
1059  // If items were duplicated, pick them up
1060  // this works well for "dropping" copies around and pushes the commit
1062  Move( evt );
1063 
1064  // After moving the new items, we need to refresh the group and view flags
1066 
1067  if( !is_hover )
1068  m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &new_items );
1069  }
1070 
1071  return 0;
1072 }
1073 
1074 
1076 {
1078  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
1080 
1081  if( selection.Empty() )
1082  return 0;
1083 
1084  // we have a selection to work on now, so start the tool process
1085  PCB_BASE_FRAME* editFrame = getEditFrame<PCB_BASE_FRAME>();
1086  ARRAY_CREATOR array_creator( *editFrame, m_editModules, selection );
1087  array_creator.Invoke();
1088 
1089  return 0;
1090 }
1091 
1092 
1094 {
1095  for( int i = aCollector.GetCount() - 1; i >= 0; i-- )
1096  {
1097  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( aCollector[i] );
1098 
1099  if( item->Type() != PCB_PAD_T )
1100  aCollector.Remove( i );
1101  }
1102 }
1103 
1104 
1106 {
1107  for( int i = aCollector.GetCount() - 1; i >= 0; i-- )
1108  {
1109  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( aCollector[i] );
1110 
1111  if( item->Type() != PCB_MODULE_T )
1112  aCollector.Remove( i );
1113  }
1114 }
1115 
1116 
1118 {
1119  if( EditingModules() && !frame()->GetModel())
1120  return 0;
1121 
1122  auto& view = *getView();
1123  auto& controls = *getViewControls();
1124 
1125  std::string tool = aEvent.GetCommandStr().get();
1126  frame()->PushTool( tool );
1127  Activate();
1128 
1129  EDA_UNITS_T units = frame()->GetUserUnits();
1131  KIGFX::PREVIEW::RULER_ITEM ruler( twoPtMgr, units );
1132 
1133  view.Add( &ruler );
1134  view.SetVisible( &ruler, false );
1135 
1136  GRID_HELPER grid( frame() );
1137 
1138  bool originSet = false;
1139 
1140  controls.ShowCursor( true );
1141  controls.SetAutoPan( false );
1142  controls.CaptureCursor( false );
1143 
1144  while( auto evt = Wait() )
1145  {
1146  frame()->GetCanvas()->SetCurrentCursor( wxCURSOR_ARROW );
1147  grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
1148  grid.SetUseGrid( !evt->Modifier( MD_ALT ) );
1149  controls.SetSnapping( !evt->Modifier( MD_ALT ) );
1150  const VECTOR2I cursorPos = grid.BestSnapAnchor( controls.GetMousePosition(), nullptr );
1151  controls.ForceCursorPosition(true, cursorPos );
1152 
1153  auto clearRuler = [&] () {
1154  view.SetVisible( &ruler, false );
1155  controls.SetAutoPan( false );
1156  controls.CaptureCursor( false );
1157  originSet = false;
1158  };
1159 
1160  if( evt->IsCancelInteractive() )
1161  {
1162  if( originSet )
1163  clearRuler();
1164  else
1165  {
1166  frame()->PopTool( tool );
1167  break;
1168  }
1169  }
1170 
1171  else if( evt->IsActivate() )
1172  {
1173  if( originSet )
1174  clearRuler();
1175 
1176  if( evt->IsMoveTool() )
1177  {
1178  // leave ourselves on the stack so we come back after the move
1179  break;
1180  }
1181  else
1182  {
1183  frame()->PopTool( tool );
1184  break;
1185  }
1186  }
1187 
1188  // click or drag starts
1189  else if( !originSet && ( evt->IsDrag( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) ) )
1190  {
1191  twoPtMgr.SetOrigin( cursorPos );
1192  twoPtMgr.SetEnd( cursorPos );
1193 
1194  controls.CaptureCursor( true );
1195  controls.SetAutoPan( true );
1196 
1197  originSet = true;
1198  }
1199 
1200  // second click or mouse up after drag ends
1201  else if( originSet && ( evt->IsClick( BUT_LEFT ) || evt->IsMouseUp( BUT_LEFT ) ) )
1202  {
1203  originSet = false;
1204 
1205  controls.SetAutoPan( false );
1206  controls.CaptureCursor( false );
1207  }
1208 
1209  // move or drag when origin set updates rules
1210  else if( originSet && ( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) ) )
1211  {
1212  twoPtMgr.SetAngleSnap( evt->Modifier( MD_CTRL ) );
1213  twoPtMgr.SetEnd( cursorPos );
1214 
1215  view.SetVisible( &ruler, true );
1216  view.Update( &ruler, KIGFX::GEOMETRY );
1217  }
1218 
1219  else if( evt->IsAction( &ACTIONS::toggleUnits )
1220  || evt->IsAction( &PCB_ACTIONS::updateUnits ) )
1221  {
1222  if( frame()->GetUserUnits() != units )
1223  {
1224  units = frame()->GetUserUnits();
1225  ruler.SwitchUnits();
1226  view.Update( &ruler, KIGFX::GEOMETRY );
1227  }
1228  }
1229 
1230  else if( evt->IsClick( BUT_RIGHT ) )
1231  {
1233  }
1234 
1235  else
1236  evt->SetPassEvent();
1237  }
1238 
1239  view.SetVisible( &ruler, false );
1240  view.Remove( &ruler );
1241  return 0;
1242 }
1243 
1244 
1246 {
1247  if( m_dragging && aSelection.HasReferencePoint() )
1248  return false;
1249 
1250  // When there is only one item selected, the reference point is its position...
1251  if( aSelection.Size() == 1 )
1252  {
1253  auto item = static_cast<BOARD_ITEM*>( aSelection.Front() );
1254  auto pos = item->GetPosition();
1255  aSelection.SetReferencePoint( VECTOR2I( pos.x, pos.y ) );
1256  }
1257  // ...otherwise modify items with regard to the grid-snapped cursor position
1258  else
1259  {
1261  aSelection.SetReferencePoint( m_cursor );
1262  }
1263 
1264  return true;
1265 }
1266 
1267 
1269 {
1271 
1272  if( selection.Empty() )
1273  return 0;
1274 
1276 
1277  if( !mod )
1278  return 0;
1279 
1280  PCB_BASE_EDIT_FRAME* editFrame = getEditFrame<PCB_BASE_EDIT_FRAME>();
1281 
1282  if( mod->GetTimeStamp() == 0 ) // Module Editor needs a non null timestamp
1283  {
1284  mod->SetTimeStamp( GetNewTimeStamp() );
1285  editFrame->OnModify();
1286  }
1287 
1288  auto editor = (FOOTPRINT_EDIT_FRAME*) editFrame->Kiway().Player( FRAME_FOOTPRINT_EDITOR, true );
1289 
1290  editor->Load_Module_From_BOARD( mod );
1291 
1292  editor->Show( true );
1293  editor->Raise(); // Iconize( false );
1294 
1295  if( selection.IsHover() )
1297 
1298  return 0;
1299 }
1300 
1301 
1303 {
1304  std::string tool = "pcbnew.InteractiveEdit.selectReferencePoint";
1305  STATUS_TEXT_POPUP statusPopup( frame() );
1307  OPT<VECTOR2I> pickedPoint;
1308  bool done = false;
1309 
1310  statusPopup.SetText( _( "Select reference point for the copy..." ) );
1311 
1312  picker->SetClickHandler(
1313  [&]( const VECTOR2D& aPoint ) -> bool
1314  {
1315  pickedPoint = aPoint;
1316  statusPopup.SetText( _( "Selection copied." ) );
1317  statusPopup.Expire( 800 );
1318  return false; // we don't need any more points
1319  } );
1320 
1321  picker->SetMotionHandler(
1322  [&] ( const VECTOR2D& aPos )
1323  {
1324  statusPopup.Move( wxGetMousePosition() + wxPoint( 20, -50 ) );
1325  } );
1326 
1327  picker->SetCancelHandler(
1328  [&]()
1329  {
1330  statusPopup.SetText( _( "Copy cancelled." ) );
1331  statusPopup.Expire( 800 );
1332  } );
1333 
1334  picker->SetFinalizeHandler(
1335  [&]( const int& aFinalState )
1336  {
1337  done = true;
1338  } );
1339 
1340  statusPopup.Move( wxGetMousePosition() + wxPoint( 20, -50 ) );
1341  statusPopup.Popup();
1342 
1343  m_toolMgr->RunAction( ACTIONS::pickerTool, true, &tool );
1344 
1345  while( !done )
1346  Wait();
1347 
1348  if( pickedPoint.is_initialized() )
1349  aReferencePoint = pickedPoint.get();
1350 
1351  return pickedPoint.is_initialized();
1352 }
1353 
1354 
1356 {
1357  CLIPBOARD_IO io;
1358 
1359  Activate();
1360 
1362  []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector )
1364 
1365  if( selection.Empty() )
1366  return 1;
1367 
1368  VECTOR2I refPoint;
1369  bool rv = pickCopyReferencePoint( refPoint );
1370  frame()->SetMsgPanel( board() );
1371 
1372  if( !rv )
1373  return 1;
1374 
1375  selection.SetReferencePoint( refPoint );
1376 
1377  io.SetBoard( board() );
1378  io.SaveSelection( selection );
1379 
1380  return 0;
1381 }
1382 
1383 
1385 {
1386  if( !copyToClipboard( aEvent ) )
1387  {
1388  // N.B. Setting the CUT flag prevents lock filtering as we only want to delete the items that
1389  // were copied to the clipboard, no more, no fewer. Filtering for locked item, if any will be done
1390  // in the copyToClipboard() routine
1391  TOOL_EVENT evt( aEvent.Category(), aEvent.Action(), TOOL_ACTION_SCOPE::AS_GLOBAL );
1393  Remove( evt );
1394  }
1395 
1396  return 0;
1397 }
1398 
1399 
1401 {
1403  Go( &EDIT_TOOL::Move, PCB_ACTIONS::move.MakeEvent() );
1404  Go( &EDIT_TOOL::Move, PCB_ACTIONS::drag.MakeEvent() );
1405  Go( &EDIT_TOOL::Drag, PCB_ACTIONS::drag45Degree.MakeEvent() );
1407  Go( &EDIT_TOOL::Rotate, PCB_ACTIONS::rotateCw.MakeEvent() );
1408  Go( &EDIT_TOOL::Rotate, PCB_ACTIONS::rotateCcw.MakeEvent() );
1409  Go( &EDIT_TOOL::Flip, PCB_ACTIONS::flip.MakeEvent() );
1410  Go( &EDIT_TOOL::Remove, ACTIONS::doDelete.MakeEvent() );
1411  Go( &EDIT_TOOL::Remove, PCB_ACTIONS::deleteFull.MakeEvent() );
1414  Go( &EDIT_TOOL::Duplicate, ACTIONS::duplicate.MakeEvent() );
1417  Go( &EDIT_TOOL::Mirror, PCB_ACTIONS::mirror.MakeEvent() );
1419 
1422 
1423  Go( &EDIT_TOOL::copyToClipboard, ACTIONS::copy.MakeEvent() );
1424  Go( &EDIT_TOOL::cutToClipboard, ACTIONS::cut.MakeEvent() );
1425 }
1426 
1427 
static TOOL_ACTION selectItems
Selects a list of items (specified as the event parameter)
Definition: pcb_actions.h:80
static TOOL_ACTION selectionClear
Clears the current selection.
Definition: pcb_actions.h:73
VECTOR2I GetReferencePoint() const
Definition: selection.h:238
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
void setTransitions() override
Sets up handlers for various events.
Definition: edit_tool.cpp:1400
VECTOR2I m_cursor
Definition: edit_tool.h:192
void ClearReferencePoint()
Definition: selection.h:248
void AddStandardSubMenus(TOOL_MENU &aMenu)
Function CreateBasicMenu.
virtual void PushTool(const std::string &actionName)
NB: the definition of "tool" is different at the user level.
TOOL_MENU m_menu
functions below are not yet implemented - their interface may change
int Properties(const TOOL_EVENT &aEvent)
Function Properties() Displays properties window for the selected object.
Definition: edit_tool.cpp:556
int Rotate(const TOOL_EVENT &aEvent)
Function Rotate() Rotates currently selected items.
Definition: edit_tool.cpp:594
static TOOL_ACTION move
move or drag an item
Definition: pcb_actions.h:108
static TOOL_ACTION deleteFull
Definition: pcb_actions.h:138
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
bool IsHover() const
Definition: selection.h:69
static const KICAD_T Tracks[]
A scan list for only TRACKS.
Definition: collectors.h:313
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Function GetMousePosition() Returns the current mouse pointer position.
BOARD * board() const
int GetCurrentViaDrill() const
Function GetCurrentViaDrill.
REMOVE_FLAGS
Remove event modifier flags
Definition: actions.h:185
int GetCurrentTrackWidth() const
Function GetCurrentTrackWidth.
static TOOL_ACTION changeTrackWidth
Updates selected tracks & vias to the current track & via dimensions.
Definition: pcb_actions.h:122
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags) override
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: pcb_view.cpp:91
This file is part of the common library.
static TOOL_ACTION doDelete
Definition: actions.h:74
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
bool HasType(KICAD_T aType) const
Checks if there is at least one item of requested kind.
Definition: selection.h:212
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:194
void ClearSelected()
Definition: base_struct.h:243
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.
VIEW_CONTROLS class definition.
TOOL_ACTIONS Action() const
Returns more specific information about the type of an event.
Definition: tool_event.h:250
static SELECTION_CONDITION OnlyTypes(const KICAD_T aTypes[])
Function OnlyTypes Creates a functor that tests if the selected items are only of given types.
bool IsClick(int aButtonMask=BUT_ANY) const
Definition: tool_event.cpp:178
Class SELECTION_TOOL.
int ChangeTrackWidth(const TOOL_EVENT &aEvent)
Definition: edit_tool.cpp:502
SELECTION_LOCK_FLAGS CheckLock()
Checks if the user has agreed to modify locked items for the given selection.
Class STATUS_TEXT_POPUP.
Definition: status_popup.h:79
virtual VECTOR2I GetCenter() const
Returns the center point of the selection area bounding box.
Definition: selection.h:136
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION dragFreeAngle
Definition: pcb_actions.h:149
Tool is invoked after being inactive.
Definition: tool_base.h:81
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
virtual void OnEditItemRequest(BOARD_ITEM *aItem)=0
Function OnEditItemRequest Install the corresponding dialog editor for the given item.
BOARD_ITEM * Duplicate(const BOARD_ITEM *aItem, bool aIncrementPadNumbers, bool aAddToModule=false)
Function Duplicate Duplicate a given item within the module, without adding to the board.
static TOOL_ACTION cancelInteractive
Definition: actions.h:65
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
static TOOL_ACTION properties
Activation of the edit tool.
Definition: pcb_actions.h:125
PADS & Pads()
Definition: class_module.h:176
TOOL_MENU & GetToolMenu()
bool IsMotion() const
Definition: tool_event.h:306
virtual void SetSnapping(bool aEnabled)
Function SetSnapping() Enables/disables snapping cursor to grid.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:109
static TOOL_ACTION getAndPlace
Find an item and start moving.
Definition: pcb_actions.h:428
void SetPosition(const wxPoint &aPos) override
Definition: class_pad.h:224
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:531
static TOOL_ACTION drag45Degree
Definition: pcb_actions.h:148
TOOL_EVENT_CATEGORY Category() const
Returns the category (eg. mouse/keyboard/action) of an event..
Definition: tool_event.h:247
static TOOL_ACTION mirror
Mirroring of selected items.
Definition: pcb_actions.h:119
static TOOL_ACTION changeFootprint
Definition: pcb_actions.h:310
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
static TOOL_ACTION updateFootprint
Definition: pcb_actions.h:308
VECTOR2I BestSnapAnchor(const VECTOR2I &aOrigin, BOARD_ITEM *aDraggedItem)
static TOOL_ACTION updateUnits
Definition: pcb_actions.h:407
void UndoRedoBlock(bool aBlock=true)
Function UndoRedoBlock Enables/disable undo and redo operations.
TOOL_BASE * FindTool(int aId) const
Function FindTool() Searches for a tool with given ID.
SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:189
static SELECTION_CONDITION Count(int aNumber)
Function Count Creates a functor that tests if the number of selected items is equal to the value giv...
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
void SetBoard(BOARD *aBoard)
static bool NotEmpty(const SELECTION &aSelection)
Function NotEmpty Tests if there are any items selected.
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Function Go()
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
void SetFinalizeHandler(FINALIZE_HANDLER aHandler)
Function SetFinalizeHandler() Sets a handler for the finalize event.
void Remove(int aIndex)
Function Remove removes the item at aIndex (first position is 0);.
Definition: collector.h:142
virtual void Remove(VIEW_ITEM *aItem) override
Function Remove() Removes a VIEW_ITEM from the view.
Definition: pcb_view.cpp:74
const wxPoint & GetAuxOrigin() const override
Return the origin of the axis used for plotting and various exports.
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:201
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
int Mirror(const TOOL_EVENT &aEvent)
Function Mirror Mirrors the current selection.
Definition: edit_tool.cpp:677
bool IsNew() const
Definition: base_struct.h:228
bool IsAction(const TOOL_ACTION *aAction) const
Function IsAction() Tests if the event contains an action issued upon activation of the given TOOL_AC...
Definition: tool_event.cpp:67
static TOOL_ACTION moveExact
Activation of the exact move tool.
Definition: pcb_actions.h:128
int cutToClipboard(const TOOL_EVENT &aEvent)
Function cutToClipboard() Cuts the current selection to the clipboard by formatting it as a fake pcb ...
Definition: edit_tool.cpp:1384
PCBNEW_SELECTION & GetSelection()
Function GetSelection()
static TOOL_ACTION pickerTool
Definition: actions.h:145
void Append(EDA_ITEM *item)
Function Append adds an item to the end of the list.
Definition: collector.h:132
const LSET GetSelectionLayers()
PCB_BASE_EDIT_FRAME * frame() const
int EditFpInFpEditor(const TOOL_EVENT &aEvent)
Definition: edit_tool.cpp:1268
bool m_lockedSelected
Definition: edit_tool.h:191
void SetParameter(T aParam)
Function SetParameter() Sets a non-standard parameter assigned to the event.
Definition: tool_event.h:453
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:113
static TOOL_ACTION measureTool
Definition: actions.h:144
class MODULE, a footprint
Definition: typeinfo.h:89
static TOOL_ACTION copy
Definition: actions.h:70
int Flip(const TOOL_EVENT &aEvent)
Function Flip() Rotates currently selected items.
Definition: edit_tool.cpp:757
void SetReferencePoint(const VECTOR2I &aP)
Definition: selection.h:243
static TOOL_ACTION duplicateIncrement
Activation of the duplication tool with incrementing (e.g. pad number)
Definition: pcb_actions.h:134
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
bool isInteractiveDragEnabled() const
Definition: edit_tool.cpp:228
void SetAuxAxes(bool aEnable, const VECTOR2I &aOrigin=VECTOR2I(0, 0))
Definition: grid_helper.cpp:93
bool IsDrag(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:296
int GetAndPlace(const TOOL_EVENT &aEvent)
Find an item and start moving.
Definition: edit_tool.cpp:189
Generic tool for picking a point.
static TOOL_ACTION rotateCw
Rotation of selected objects.
Definition: pcb_actions.h:112
VECTOR2I BestDragOrigin(const VECTOR2I &aMousePos, std::vector< BOARD_ITEM * > &aItem)
Class LSET is a set of PCB_LAYER_IDs.
const PCBNEW_SELECTION & selection() const
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:328
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
bool m_dragging
Definition: edit_tool.h:190
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
virtual void Move(const wxPoint &aMoveVector)
Function Move move this object.
virtual void CaptureCursor(bool aEnabled)
Function CaptureCursor() Forces the cursor to stay within the drawing panel area.
PCB_GENERAL_SETTINGS & Settings()
int ShowQuasiModal()
SELECTION_LOCK_FLAGS
Definition: selection.h:263
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:435
const wxPoint & GetOffset() const
Definition: class_pad.h:293
Class TOOL_EVENT.
Definition: tool_event.h:171
static TOOL_ACTION createArray
Tool for creating an array of objects.
Definition: pcb_actions.h:371
void SetOrigin(const VECTOR2I &aOrigin)
Set the origin of the ruler (the fixed end)
static TOOL_ACTION cut
Definition: actions.h:69
KIGFX::PCB_VIEW * view() const
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:276
bool HasItem(const EDA_ITEM *aItem) const
Function HasItem tests if aItem has already been collected.
Definition: collector.h:196
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
Definition: edit_tool.cpp:119
void SetPassEvent()
Definition: tool_event.h:256
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
virtual void Popup(wxWindow *aFocus=nullptr)
int Drag(const TOOL_EVENT &aEvent)
Function Drag() Invoke the PNS router to drag tracks.
Definition: edit_tool.cpp:236
Class RULER_ITEM.
Definition: ruler_item.h:43
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Function Rotate Rotate this object.
virtual void Move(const wxPoint &aWhere)
const wxSize & GetDelta() const
Definition: class_pad.h:287
All active tools
Definition: tool_event.h:147
bool IsMouseUp(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:301
virtual KIGFX::VIEW_ITEM * GetItem(unsigned int aIdx) const override
Definition: selection.h:103
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1540
void Expire(int aMsecs)
Hides the popup after a specified time.
bool IsCancelInteractive()
Function IsCancelInteractive()
Definition: tool_event.cpp:190
virtual void PopupFor(int aMsecs)
ROTATION_ANCHOR
#define _(s)
static TOOL_ACTION routerInlineDrag
Activation of the Push and Shove router (inline dragging mode)
Definition: pcb_actions.h:203
static TOOL_ACTION hideDynamicRatsnest
Definition: pcb_actions.h:421
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:36
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg.
int Move(const TOOL_EVENT &aEvent)
Function Move() Main loop in which events are handled.
Definition: edit_tool.cpp:248
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:119
static TOOL_ACTION inlineBreakTrack
Breaks track when router is not activated.
Definition: pcb_actions.h:146
virtual const wxPoint GetPosition() const =0
static TOOL_ACTION drag
Definition: pcb_actions.h:109
void SetSnap(bool aSnap)
Definition: grid_helper.h:66
void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
Definition: edit_tool.cpp:110
static TOOL_ACTION expandSelectedConnection
Expands the current selection to select a connection between two junctions.
Definition: pcb_actions.h:90
bool EditingModules() const
void AddSeparator(int aOrder=ANY_ORDER)
Function AddSeparator()
virtual unsigned int GetSize() const override
Function GetSize() Returns the number of stored items.
Definition: selection.h:98
static TOOL_ACTION rotateCcw
Definition: pcb_actions.h:113
static void PadFilter(const VECTOR2I &, GENERAL_COLLECTOR &aCollector)
Function PadFilter() A selection filter which prunes the selection to contain only items of type PCB_...
Definition: edit_tool.cpp:1093
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:342
int MoveExact(const TOOL_EVENT &aEvent)
Function MoveExact() Invokes a dialog box to allow moving of the item by an exact amount.
Definition: edit_tool.cpp:924
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:463
int Remove(const TOOL_EVENT &aEvent)
Function Remove() Deletes currently selected items.
Definition: edit_tool.cpp:806
static ROUTER * theRouter
Definition: pns_router.cpp:57
static TOOL_ACTION flip
Flipping of selected objects.
Definition: pcb_actions.h:116
virtual void OnModify()
Function OnModify Virtual Must be called after a change in order to set the "modify" flag of the curr...
int GetCurrentViaSize() const
Function GetCurrentViaSize.
void SaveSelection(const PCBNEW_SELECTION &selected)
bool IsActivate() const
Definition: tool_event.h:321
virtual bool IsLocked() const
Function IsLocked.
bool invokeInlineRouter(int aDragMode)
Definition: edit_tool.cpp:207
bool HasReferencePoint() const
Definition: selection.h:233
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:98
int CreateArray(const TOOL_EVENT &aEvent)
Function CreateArray() Creates an array of the selected items, invoking the array editor dialog to se...
Definition: edit_tool.cpp:1075
PCBNEW_SELECTION & RequestSelection(CLIENT_SELECTION_FILTER aClientFilter, std::vector< BOARD_ITEM * > *aFiltered=nullptr, bool aConfirmLockedItems=false)
Function RequestSelection()
KIGFX::VIEW_CONTROLS * controls() const
bool ToolStackIsEmpty()
Common, abstract interface for edit frames.
int MeasureTool(const TOOL_EVENT &aEvent)
Launches a tool to measure between points
Definition: edit_tool.cpp:1117
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
EDA_UNITS_T GetUserUnits() const
Return the user units currently in use.
MODULE * module() const
static TOOL_ACTION editFootprintInFpEditor
Definition: pcb_actions.h:329
double GetOrientation() const
Function GetOrientation returns the rotation angle of the pad in tenths of degrees,...
Definition: class_pad.h:406
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:240
size_t i
Definition: json11.cpp:649
static TOOL_ACTION selectItem
Selects an item (specified as the event parameter).
Definition: pcb_actions.h:76
static SELECTION_CONDITION OnlyType(KICAD_T aType)
Function OnlyType Creates a functor that tests if the selected items are only of given type.
TOOL_EVENT MakeEvent() const
Function MakeEvent() Returns the event associated with the action (i.e.
Definition: tool_action.h:107
int Size() const
Returns the number of selected parts.
Definition: selection.h:125
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
static wxPoint mirrorPointX(const wxPoint &aPoint, const wxPoint &aMirrorPoint)
Definition: edit_tool.cpp:639
void SetMotionHandler(MOTION_HANDLER aHandler)
Function SetMotionHandler() Sets a handler for mouse motion.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
static TOOL_ACTION positionRelative
Activation of the position relative tool.
Definition: pcb_actions.h:224
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:79
boost::optional< T > OPT
Definition: optional.h:7
T * FirstOfKind() const
Definition: selection.h:193
void SetOrientation(double aAngle)
Function SetOrientation sets the rotation angle of the pad.
Definition: class_pad.cpp:430
virtual void PopTool(const std::string &actionName)
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Sets the item visibility.
Definition: view.cpp:1486
void Activate()
Function Activate() Runs the tool.
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Function Add() Adds a VIEW_ITEM to the view.
Definition: pcb_view.cpp:58
void SetUseGrid(bool aGrid=true)
Definition: grid_helper.h:71
void SetX0(int x)
Definition: class_pad.h:281
#define EXCLUDE_LOCKED
Function EditToolSelectionFilter.
Definition: edit_tool.h:53
int copyToClipboard(const TOOL_EVENT &aEvent)
Function copyToClipboard() Sends the current selection to the clipboard by formatting it as a fake pc...
Definition: edit_tool.cpp:1355
PAD_SHAPE_T GetShape() const
Function GetShape.
Definition: class_pad.h:221
static TOOL_ACTION updateLocalRatsnest
Definition: pcb_actions.h:422
Module description (excepted pads)
static void FootprintFilter(const VECTOR2I &, GENERAL_COLLECTOR &aCollector)
Function FootprintFilter() A selection filter which prunes the selection to contain only items of typ...
Definition: edit_tool.cpp:1105
BOARD * GetBoard() const
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
bool RoutingInProgress() const
Definition: pns_router.cpp:110
SGLIB_API S3DMODEL * GetModel(SCENEGRAPH *aNode)
Function GetModel creates an S3DMODEL representation of aNode (raw data, no transforms)
Definition: ifsg_api.cpp:471
ROUTER * Router() const
const wxPoint GetPosition() const override
Definition: class_pad.h:225
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
EDGE_MODULE class definition.
BOARD_ITEM_CONTAINER * GetParent() const
int GetEventRotationAngle(const PCB_BASE_EDIT_FRAME &aFrame, const TOOL_EVENT &aEvt)
Function getEventRotationAngle()
void SetOffset(const wxPoint &aOffset)
Definition: class_pad.h:292
bool updateModificationPoint(PCBNEW_SELECTION &aSelection)
Returns the right modification point (e.g.
Definition: edit_tool.cpp:1245
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags)
Definition: edit_tool.cpp:60
void SetCancelHandler(CANCEL_HANDLER aHandler)
Function SetCancelHandler() Sets a handler for cancel events (ESC or context-menu Cancel).
void PostEvent(const TOOL_EVENT &aEvent)
Puts an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:237
int Duplicate(const TOOL_EVENT &aEvent)
Function Duplicate() Duplicates the current selection and starts a move action.
Definition: edit_tool.cpp:1001
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Function AddItem()
static TOOL_ACTION toggleUnits
Definition: actions.h:138
EDA_RECT GetBoundingBox() const
Definition: selection.h:154
void ShowContextMenu(SELECTION &aSelection)
Function ShowContextMenu.
Definition: tool_menu.cpp:59
const wxPoint GetPosition() const override
Definition: class_module.h:213
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:190
static void mirrorPadX(D_PAD &aPad, const wxPoint &aMirrorPoint)
Mirror a pad in the vertical axis passing through a point.
Definition: edit_tool.cpp:654
void MirrorXPrimitives(int aX)
Mirror the primitives about a coordinate.
Definition: class_pad.cpp:504
#define mod(a, n)
Definition: greymap.cpp:24
static TOOL_ACTION paste
Definition: actions.h:71
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
EDA_UNITS_T
Definition: common.h:133
static TOOL_ACTION duplicate
Definition: actions.h:73
void SetText(const wxString &aText)
Display a text.
static TOOL_ACTION refreshPreview
Definition: actions.h:101
void SetDelta(const wxSize &aSize)
Definition: class_pad.h:286
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false)=0
Moves cursor to the requested position expressed in world coordinates.
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
EDA_ITEM * Front() const
Definition: selection.h:182
bool pickCopyReferencePoint(VECTOR2I &aReferencePoint)
Definition: edit_tool.cpp:1302
VECTOR2D m_LocalOrigin
Relative Screen cursor coordinate (on grid) in user units.
Definition: base_screen.h:114
void DisplayToolMsg(const wxString &msg) override
void SetEnd(const VECTOR2I &aEnd)
Set the current end of the rectangle (the end that moves with the cursor.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
Color has changed.
Definition: view_item.h:57
virtual void UpdateMsgPanel()
Redraw the message panel.
void SetClickHandler(CLICK_HANDLER aHandler)
Function SetClickHandler() Sets a handler for mouse click event.
BOARD_ITEM * Duplicate(const BOARD_ITEM *aItem, bool aAddToBoard=false)