KiCad PCB EDA Suite
sch_move_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) 2019 CERN
5  * Copyright (C) 2019 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #include <tool/tool_manager.h>
28 #include <ee_actions.h>
29 #include <bitmaps.h>
30 #include <base_struct.h>
31 #include <sch_item.h>
32 #include <sch_component.h>
33 #include <sch_sheet.h>
34 #include <sch_view.h>
35 #include <sch_line.h>
36 #include <sch_edit_frame.h>
37 #include <eeschema_id.h>
38 #include "sch_move_tool.h"
39 
40 
41 // For adding to or removing from selections
42 #define QUIET_MODE true
43 
44 
46  EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.InteractiveMove" ),
47  m_moveInProgress( false ),
48  m_isDragOperation( false ),
49  m_moveOffset( 0, 0 )
50 {
51 }
52 
53 
55 {
57 
58  auto moveCondition = [] ( const SELECTION& aSel ) {
59  if( aSel.Empty() )
60  return false;
61 
63  return false;
64 
65  return true;
66  };
67 
68  // Add move actions to the selection tool menu
69  //
71 
72  selToolMenu.AddItem( EE_ACTIONS::move, moveCondition, 150 );
73  selToolMenu.AddItem( EE_ACTIONS::drag, moveCondition, 150 );
74 
75  return true;
76 }
77 
78 
79 /* TODO - Tom/Jeff
80  - add preferences option "Move origin: always cursor / item origin"
81  - add preferences option "Default drag action: drag items / move"
82  - add preferences option "Drag always selects"
83  */
84 
85 
86 int SCH_MOVE_TOOL::Main( const TOOL_EVENT& aEvent )
87 {
88  const KICAD_T movableItems[] =
89  {
95  SCH_LINE_T,
97  SCH_TEXT_T,
101  SCH_FIELD_T,
104  SCH_SHEET_T,
105  EOT
106  };
107 
109  controls->SetSnapping( true );
110 
111  m_anchorPos.reset();
112 
113  if( aEvent.IsAction( &EE_ACTIONS::move ) )
114  m_isDragOperation = false;
115  else if( aEvent.IsAction( &EE_ACTIONS::drag ) )
116  m_isDragOperation = true;
117  else if( aEvent.IsAction( &EE_ACTIONS::moveActivate ) )
119  else
120  return 0;
121 
122  if( m_moveInProgress )
123  {
124  auto sel = m_selectionTool->GetSelection().Front();
125 
126  if( sel && !sel->IsNew() )
127  {
128  // User must have switched from move to drag or vice-versa. Reset the selected
129  // items so we can start again with the current m_isDragOperation.
133  m_moveInProgress = false;
134  controls->SetAutoPan( false );
135 
136  // And give it a kick so it doesn't have to wait for the first mouse movement to
137  // refresh.
139  }
140 
141  return 0;
142  }
143 
144  // Be sure that there is at least one item that we can move. If there's no selection try
145  // looking for the stuff under mouse cursor (i.e. Kicad old-style hover selection).
146  EE_SELECTION& selection = m_selectionTool->RequestSelection( movableItems );
147  bool unselect = selection.IsHover();
148 
149  // Keep an original copy of the starting points for cleanup after the move
150  std::vector<DANGLING_END_ITEM> internalPoints;
151 
152  if( selection.Empty() )
153  return 0;
154 
155  Activate();
156  controls->ShowCursor( true );
157 
158  bool restore_state = false;
159  bool chain_commands = false;
160  TOOL_EVENT* evt = const_cast<TOOL_EVENT*>( &aEvent );
161  VECTOR2I prevPos;
162 
163  std::string tool = aEvent.GetCommandStr().get();
164  m_frame->PushTool( tool );
165  m_cursor = controls->GetCursorPosition();
166 
167  // Main loop: keep receiving events
168  do
169  {
170  m_frame->GetCanvas()->SetCurrentCursor( wxCURSOR_ARROW );
171  controls->SetSnapping( !evt->Modifier( MD_ALT ) );
172 
174  || evt->IsAction( &EE_ACTIONS::move ) || evt->IsAction( &EE_ACTIONS::drag )
175  || evt->IsMotion() || evt->IsDrag( BUT_LEFT )
176  || evt->IsAction( &ACTIONS::refreshPreview ) )
177  {
178  if( !m_moveInProgress ) // Prepare to start moving/dragging
179  {
180  SCH_ITEM* sch_item = (SCH_ITEM*) selection.Front();
181  bool appendUndo = sch_item && sch_item->IsNew();
182 
183  //------------------------------------------------------------------------
184  // Setup a drag or a move
185  //
186  m_dragAdditions.clear();
187  internalPoints.clear();
188 
189  for( SCH_ITEM* it = m_frame->GetScreen()->GetDrawItems(); it; it = it->Next() )
190  {
191  it->ClearFlags(TEMP_SELECTED );
192 
193  if( !it->IsSelected() )
194  it->ClearFlags( STARTPOINT | ENDPOINT );
195 
196  if( !selection.IsHover() && it->IsSelected() )
197  it->SetFlags( STARTPOINT | ENDPOINT );
198  }
199 
200  if( m_isDragOperation )
201  {
202  // Add connections to the selection for a drag.
203  //
204  for( EDA_ITEM* item : selection )
205  {
206  if( static_cast<SCH_ITEM*>( item )->IsConnectable() )
207  {
208  std::vector<wxPoint> connections;
209 
210  if( item->Type() == SCH_LINE_T )
211  static_cast<SCH_LINE*>( item )->GetSelectedPoints( connections );
212  else
213  static_cast<SCH_ITEM*>( item )->GetConnectionPoints( connections );
214 
215  for( wxPoint point : connections )
217  }
218  }
219 
221  }
222  else
223  {
224  // Mark the edges of the block with dangling flags for a move.
225  for( EDA_ITEM* item : selection )
226  static_cast<SCH_ITEM*>( item )->GetEndPoints( internalPoints );
227 
228  for( EDA_ITEM* item : selection )
229  static_cast<SCH_ITEM*>( item )->UpdateDanglingState( internalPoints );
230  }
231  // Generic setup
232  //
233  for( EDA_ITEM* item : selection )
234  {
235  if( item->IsNew() )
236  {
237  if( item->HasFlag(TEMP_SELECTED ) && m_isDragOperation )
238  {
239  // Item was added in getConnectedDragItems
240  saveCopyInUndoList( (SCH_ITEM*) item, UR_NEW, appendUndo );
241  appendUndo = true;
242  }
243  else
244  {
245  // Item was added in a previous command (and saved to undo by
246  // that command)
247  }
248  }
249  else if( item->GetParent() && item->GetParent()->IsSelected() )
250  {
251  // Item will be (or has been) saved to undo by parent
252  }
253  else
254  {
255  saveCopyInUndoList( (SCH_ITEM*) item, UR_CHANGED, appendUndo );
256  appendUndo = true;
257  }
258 
259  SCH_ITEM* schItem = (SCH_ITEM*) item;
260  schItem->SetStoredPos( schItem->GetPosition() );
261  }
262 
263  // Set up the starting position and move/drag offset
264  //
265  m_cursor = controls->GetCursorPosition();
266 
267  if( evt->IsAction( &EE_ACTIONS::restartMove ) )
268  {
269  wxASSERT_MSG( m_anchorPos, "Should be already set from previous cmd" );
270  }
271  else if( selection.Front()->HasFlag( IS_NEW ) )
272  {
273  m_anchorPos = selection.GetReferencePoint();
274  }
275 
276  if( m_anchorPos )
277  {
278  VECTOR2I delta = m_cursor - (*m_anchorPos);
279 
280  // Drag items to the current cursor position
281  for( EDA_ITEM* item : selection )
282  {
283  // Don't double move pins, fields, etc.
284  if( item->GetParent() && item->GetParent()->IsSelected() )
285  continue;
286 
287  moveItem( item, delta, m_isDragOperation );
288  updateView( item );
289  }
290 
292  }
293  // For some items, moving the cursor to anchor is not good (for instance large
294  // hierarchical sheets or components can have the anchor outside the view)
295  else if( selection.Size() == 1 && sch_item->IsMovableFromAnchorPoint()
297  {
298  if( sch_item->Type() == SCH_LINE_T && !sch_item->HasFlag( STARTPOINT ) )
299  m_anchorPos = static_cast<SCH_LINE*>( sch_item )->GetEndPoint();
300  else
301  m_anchorPos = sch_item->GetPosition();
302 
303  getViewControls()->WarpCursor( *m_anchorPos, true, true );
305  }
306  // ...otherwise modify items with regard to the grid-snapped cursor position
307  else
308  {
311  }
312 
313  controls->SetCursorPosition( m_cursor, false );
315 
316  prevPos = m_cursor;
317  controls->SetAutoPan( true );
318  m_moveInProgress = true;
319  }
320 
321  //------------------------------------------------------------------------
322  // Follow the mouse
323  //
324  m_cursor = controls->GetCursorPosition();
325  VECTOR2I delta( m_cursor - prevPos );
327 
328  m_moveOffset += delta;
329  prevPos = m_cursor;
330 
331  for( EDA_ITEM* item : selection )
332  {
333  // Don't double move pins, fields, etc.
334  if( item->GetParent() && item->GetParent()->IsSelected() )
335  continue;
336 
337  moveItem( item, delta, m_isDragOperation );
338  updateView( item );
339  }
340 
343  }
344  //------------------------------------------------------------------------
345  // Handle cancel
346  //
347  else if( evt->IsCancelInteractive() )
348  {
349  if( m_moveInProgress )
350  restore_state = true;
351 
352  break;
353  }
354  //------------------------------------------------------------------------
355  // Handle TOOL_ACTION special cases
356  //
357  else if( evt->Action() == TA_UNDO_REDO_PRE )
358  {
359  unselect = true;
360  break;
361  }
362  else if( evt->Category() == TC_COMMAND )
363  {
364  if( evt->IsAction( &ACTIONS::doDelete ) )
365  {
366  // Exit on a remove operation; there is no further processing for removed items.
367  break;
368  }
369  else if( evt->IsAction( &ACTIONS::duplicate ) )
370  {
371  if( selection.Front()->IsNew() )
372  {
373  // This doesn't really make sense; we'll just end up dragging a stack of
374  // objects so Duplicate() is going to ignore this and we'll just carry on.
375  continue;
376  }
377 
378  // Move original back and exit. The duplicate will run in its own loop.
379  restore_state = true;
380  unselect = false;
381  chain_commands = true;
382  break;
383  }
384  else if( evt->Action() == TA_CHOICE_MENU_CHOICE )
385  {
386  if( evt->GetCommandId().get() >= ID_POPUP_SCH_SELECT_UNIT_CMP
388  {
389  SCH_COMPONENT* component = dynamic_cast<SCH_COMPONENT*>( selection.Front() );
390  int unit = evt->GetCommandId().get() - ID_POPUP_SCH_SELECT_UNIT_CMP;
391 
392  if( component )
393  {
394  m_frame->SelectUnit( component, unit );
396  }
397  }
398  }
399  }
400  //------------------------------------------------------------------------
401  // Handle context menu
402  //
403  else if( evt->IsClick( BUT_RIGHT ) )
404  {
406  }
407  //------------------------------------------------------------------------
408  // Handle drop
409  //
410  else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) )
411  {
412  break; // Finish
413  }
414  else
415  evt->SetPassEvent();
416 
417  controls->SetAutoPan( m_moveInProgress );
418 
419  } while( ( evt = Wait() ) ); //Should be assignment not equality test
420 
421  controls->ForceCursorPosition( false );
422  controls->ShowCursor( false );
423  controls->SetSnapping( false );
424  controls->SetAutoPan( false );
425 
426  if( !chain_commands )
427  m_moveOffset = { 0, 0 };
428 
429  m_anchorPos.reset();
430 
431  for( EDA_ITEM* item : selection )
432  item->ClearEditFlags();
433 
434  if( restore_state )
435  {
437  }
438  else
439  {
440  // If we move items away from a junction, we _may_ want to add a junction there
441  // to denote the state.
442  for( auto it : internalPoints )
443  {
444  if( m_frame->GetScreen()->IsJunctionNeeded( it.GetPosition(), true ) )
445  m_frame->AddJunction( it.GetPosition(), true, false );
446  }
447 
448  m_toolMgr->RunAction( EE_ACTIONS::addNeededJunctions, true, &selection );
449 
452 
453  m_frame->OnModify();
454  }
455 
456  if( unselect )
458  else
459  m_selectionTool->RebuildSelection(); // Schematic cleanup might have merged lines, etc.
460 
461  m_dragAdditions.clear();
462  m_moveInProgress = false;
463  m_frame->PopTool( tool );
464  return 0;
465 }
466 
467 
468 void SCH_MOVE_TOOL::getConnectedDragItems( SCH_ITEM* aOriginalItem, wxPoint aPoint,
469  EDA_ITEMS& aList )
470 {
471  for( SCH_ITEM* test = m_frame->GetScreen()->GetDrawItems(); test; test = test->Next() )
472  {
473  if( test->IsSelected() || !test->IsConnectable() || !test->CanConnect( aOriginalItem ) )
474  continue;
475 
476  KICAD_T testType = test->Type();
477 
478  switch( testType )
479  {
480  case SCH_LINE_T:
481  {
482  // Select the connected end of wires/bus connections.
483  SCH_LINE* testLine = (SCH_LINE*) test;
484 
485  if( testLine->GetStartPoint() == aPoint )
486  {
487  if( !testLine->HasFlag( TEMP_SELECTED ) )
488  aList.push_back( testLine );
489 
490  testLine->SetFlags( STARTPOINT | TEMP_SELECTED );
491  }
492  else if( testLine->GetEndPoint() == aPoint )
493  {
494  if( !testLine->HasFlag( TEMP_SELECTED ) )
495  aList.push_back( testLine );
496 
497  testLine->SetFlags( ENDPOINT | TEMP_SELECTED );
498  }
499  break;
500  }
501 
502  case SCH_SHEET_T:
503  // Dragging a sheet just because it's connected to something else feels a bit like
504  // the tail wagging the dog, but this could be moved down to the next case.
505  break;
506 
507  case SCH_COMPONENT_T:
508  if( test->IsConnected( aPoint ) )
509  {
510  // Add a new wire between the component and the selected item so the selected
511  // item can be dragged.
512  SCH_LINE* newWire = new SCH_LINE( aPoint, LAYER_WIRE );
513  newWire->SetFlags( IS_NEW );
514  m_frame->AddToScreen( newWire, m_frame->GetScreen() );
515 
516  newWire->SetFlags( TEMP_SELECTED | STARTPOINT );
517  aList.push_back( newWire );
518  }
519  break;
520 
521  case SCH_NO_CONNECT_T:
522  case SCH_JUNCTION_T:
523  // Select no-connects and junctions that are connected to items being moved.
524  if( !test->HasFlag( TEMP_SELECTED ) && test->IsConnected( aPoint ) )
525  {
526  aList.push_back( test );
527  test->SetFlags( TEMP_SELECTED );
528  }
529 
530  break;
531 
532  case SCH_LABEL_T:
533  case SCH_GLOBAL_LABEL_T:
534  case SCH_HIER_LABEL_T:
536  case SCH_BUS_BUS_ENTRY_T:
537  // Performance optimization:
538  if( test->HasFlag( TEMP_SELECTED ) )
539  break;
540 
541  // Select labels and bus entries that are connected to a wire being moved.
542  if( aOriginalItem->Type() == SCH_LINE_T )
543  {
544  std::vector<wxPoint> connections;
545  test->GetConnectionPoints( connections );
546 
547  for( wxPoint& point : connections )
548  {
549  if( aOriginalItem->HitTest( point ) )
550  {
551  test->SetFlags( TEMP_SELECTED );
552  aList.push_back( test );
553 
554  // A bus entry needs its wire & label as well
555  if( testType == SCH_BUS_WIRE_ENTRY_T || testType == SCH_BUS_BUS_ENTRY_T )
556  {
557  std::vector<wxPoint> ends;
558  wxPoint otherEnd;
559 
560  test->GetConnectionPoints( ends );
561 
562  if( ends[0] == point )
563  otherEnd = ends[1];
564  else
565  otherEnd = ends[0];
566 
567  getConnectedDragItems( (SCH_ITEM*) test, otherEnd, m_dragAdditions );
568  }
569  break;
570  }
571  }
572  }
573 
574  break;
575 
576  default:
577  break;
578  }
579  }
580 }
581 
582 
583 void SCH_MOVE_TOOL::moveItem( EDA_ITEM* aItem, VECTOR2I aDelta, bool isDrag )
584 {
585  switch( aItem->Type() )
586  {
587  case SCH_LINE_T:
588  if( aItem->HasFlag( STARTPOINT ) )
589  static_cast<SCH_LINE*>( aItem )->MoveStart( (wxPoint) aDelta );
590 
591  if( aItem->HasFlag( ENDPOINT ) )
592  static_cast<SCH_LINE*>( aItem )->MoveEnd( (wxPoint) aDelta );
593 
594  break;
595 
596  case SCH_PIN_T:
597  case SCH_FIELD_T:
598  {
599  SCH_COMPONENT* component = (SCH_COMPONENT*) aItem->GetParent();
600  TRANSFORM transform = component->GetTransform().InverseTransform();
601  wxPoint transformedDelta = transform.TransformCoordinate( (wxPoint) aDelta );
602 
603  static_cast<SCH_ITEM*>( aItem )->Move( transformedDelta );
604 
605  // If we're moving a field with respect to its parent then it's no longer auto-placed
606  if( aItem->Type() == SCH_FIELD_T && !component->IsSelected() )
607  component->ClearFieldsAutoplaced();
608 
609  break;
610  }
611  case SCH_SHEET_PIN_T:
612  {
613  SCH_SHEET_PIN* pin = (SCH_SHEET_PIN*) aItem;
614  pin->SetStoredPos( pin->GetStoredPos() + (wxPoint) aDelta );
615  pin->ConstrainOnEdge( pin->GetStoredPos() );
616  break;
617  }
618  default:
619  static_cast<SCH_ITEM*>( aItem )->Move( (wxPoint) aDelta );
620  break;
621  }
622 
623  getView()->Hide( aItem, false );
624  aItem->SetFlags( IS_MOVED );
625 }
626 
627 
629 {
631  Go( &SCH_MOVE_TOOL::Main, EE_ACTIONS::move.MakeEvent() );
632  Go( &SCH_MOVE_TOOL::Main, EE_ACTIONS::drag.MakeEvent() );
633 }
static TOOL_ACTION moveActivate
Definition: ee_actions.h:114
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
void Hide(VIEW_ITEM *aItem, bool aHide=true)
Temporarily hides the item in the view (e.g.
Definition: view.cpp:1507
OPT< int > GetCommandId() const
Definition: tool_event.h:458
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:128
virtual void PushTool(const std::string &actionName)
NB: the definition of "tool" is different at the user level.
bool SchematicCleanUp(SCH_SCREEN *aScreen=nullptr)
Performs routine schematic cleaning including breaking wire and buses and deleting identical objects ...
TOOL_MENU m_menu
functions below are not yet implemented - their interface may change
bool IsHover() const
Definition: selection.h:69
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
void getConnectedDragItems(SCH_ITEM *aOriginalItem, wxPoint aPoint, EDA_ITEMS &aList)
Finds additional items for a drag operation.
wxPoint GetStartPoint() const
Definition: sch_line.h:99
bool IsSelected() const
Definition: base_struct.h:233
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen=nullptr)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
virtual bool IsMovableFromAnchorPoint()
Virtual function IsMovableFromAnchorPoint.
Definition: sch_item.h:172
static TOOL_ACTION doDelete
Definition: actions.h:74
bool IsJunctionNeeded(const wxPoint &aPosition, bool aNew=false)
Test if a junction is required for the items at aPosition on the screen.
Definition: sch_screen.cpp:348
SCH_ITEM * Next() const
Definition: sch_item.h:153
int Main(const TOOL_EVENT &aEvent)
Function Main()
VECTOR2I m_cursor
Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point).
Definition: sch_move_tool.h:76
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.
TOOL_ACTIONS Action() const
Returns more specific information about the type of an event.
Definition: tool_event.h:250
bool IsClick(int aButtonMask=BUT_ANY) const
Definition: tool_event.cpp:178
VECTOR2I m_moveOffset
Used for chaining commands
Definition: sch_move_tool.h:72
static TOOL_ACTION restartMove
Definition: ee_actions.h:185
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
TRANSFORM InverseTransform() const
Calculate the Inverse mirror/rotation transform.
Definition: transform.cpp:58
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
int AddItemsToSel(const TOOL_EVENT &aEvent)
TOOL_EVENT_CATEGORY Category() const
Returns the category (eg. mouse/keyboard/action) of an event..
Definition: tool_event.h:247
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false, long aArrowCommand=0)=0
Moves cursor to the requested position expressed in world coordinates.
Schematic editor (Eeschema) main window.
bool TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
bool m_moveInProgress
Flag determining if anything is being dragged right now
Definition: sch_move_tool.h:65
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Function Go()
EDA_ITEMS m_dragAdditions
Items (such as wires) which were added to the selection for a drag
Definition: sch_move_tool.h:69
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
static const TOOL_EVENT SelectedItemsModified
Definition: actions.h:201
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
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
void ClearFieldsAutoplaced()
Set fields automatically placed flag false.
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
Definition: ee_tool_base.h:69
EE_SELECTION & GetSelection()
Function GetSelection()
#define IS_NEW
New item, just created.
Definition: base_struct.h:120
EE_SELECTION & RequestSelection(const KICAD_T *aFilterList=EE_COLLECTOR::AllItems)
Function RequestSelection()
virtual bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: base_struct.h:340
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
wxPoint & GetStoredPos()
Definition: sch_item.h:174
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
Function WarpCursor() If enabled (.
virtual wxPoint GetPosition() const =0
Function GetPosition.
bool IsDrag(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:296
Class for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:265
bool GetDragActionIsMove() const
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: base_struct.h:642
TRANSFORM & GetTransform() const
boost::optional< VECTOR2I > m_anchorPos
Definition: sch_move_tool.h:78
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Class TOOL_EVENT.
Definition: tool_event.h:171
SCH_JUNCTION * AddJunction(const wxPoint &aPos, bool aAppendToUndo=false, bool aFinal=true)
EDA_ITEM * GetParent() const
Definition: base_struct.h:220
void SetPassEvent()
Definition: tool_event.h:256
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
EE_SELECTION_TOOL * m_selectionTool
Definition: ee_tool_base.h:141
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
static TOOL_ACTION clearSelection
Clears the current selection.
Definition: ee_actions.h:58
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
bool m_isDragOperation
Definition: sch_move_tool.h:66
static TOOL_ACTION addNeededJunctions
Definition: ee_actions.h:77
bool IsMouseUp(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:301
void ConstrainOnEdge(wxPoint Pos)
Adjust label position to edge based on proximity to vertical or horizontal edge of the parent sheet.
bool IsCancelInteractive()
Function IsCancelInteractive()
Definition: tool_event.cpp:190
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.
void SelectUnit(SCH_COMPONENT *aComponent, int aUnit)
Definition: getpart.cpp:210
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:119
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:342
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:463
static bool IsDrawingLineWireOrBus(const SELECTION &aSelection)
void updateView(EDA_ITEM *aItem) const
Similar to getView()->Update(), but handles items that are redrawn by their parents.
Definition: ee_tool_base.h:104
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
void moveItem(EDA_ITEM *aItem, VECTOR2I aDelta, bool isDrag)
static TOOL_ACTION drag
Definition: ee_actions.h:116
void RollbackSchematicFromUndo()
Performs an undo of the last edit WITHOUT logging a corresponding redo.
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
void RebuildSelection()
Rebuilds the selection from the EDA_ITEMs' selection flags.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
void saveCopyInUndoList(EDA_ITEM *aItem, UNDO_REDO_T aType, bool aAppend=false)
Similar to m_frame->SaveCopyInUndoList(), but handles items that are owned by their parents.
Definition: ee_tool_base.h:117
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
bool GetMoveWarpsCursor() const
Indicates that a move operation should warp the mouse pointer to the origin of the move object.
virtual void PopTool(const std::string &actionName)
void Activate()
Function Activate() Runs the tool.
static TOOL_ACTION move
Definition: ee_actions.h:115
Class EE_TOOL_BASE.
Definition: ee_tool_base.h:50
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
bool HasFlag(STATUS_FLAGS aFlag)
Definition: base_struct.h:268
#define QUIET_MODE
int RemoveItemsFromSel(const TOOL_EVENT &aEvent)
void setTransitions() override
Sets up handlers for various events.
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
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Function AddItem()
void SetStoredPos(wxPoint aPos)
Definition: sch_item.h:175
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
void ShowContextMenu(SELECTION &aSelection)
Function ShowContextMenu.
Definition: tool_menu.cpp:59
static TOOL_ACTION duplicate
Definition: actions.h:73
static TOOL_ACTION refreshPreview
Definition: actions.h:101
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
EDA_ITEM * Front() const
Definition: selection.h:182
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
virtual void UpdateMsgPanel()
Redraw the message panel.
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125
#define IS_MOVED
Item being moved.
Definition: base_struct.h:119
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:152
wxPoint GetEndPoint() const
Definition: sch_line.h:102