KiCad PCB EDA Suite
sch_drawing_tools.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 "sch_drawing_tools.h"
26 #include "ee_selection_tool.h"
27 #include "ee_point_editor.h"
28 #include <ee_actions.h>
29 #include <sch_edit_frame.h>
30 #include <sch_view.h>
31 #include <class_draw_panel_gal.h>
32 #include <project.h>
33 #include <id.h>
34 #include <eeschema_id.h>
35 #include <confirm.h>
36 #include <view/view_controls.h>
37 #include <view/view.h>
38 #include <sch_component.h>
39 #include <sch_no_connect.h>
40 #include <sch_line.h>
41 #include <sch_junction.h>
42 #include <sch_bus_entry.h>
43 #include <sch_text.h>
44 #include <sch_sheet.h>
45 #include <sch_bitmap.h>
46 #include <class_library.h>
47 
48 
50  EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.InteractiveDrawing" )
51 {
52 }
53 
54 
56 {
58 
59  auto belowRootSheetCondition = [] ( const SELECTION& aSel ) {
60  return g_CurrentSheet->Last() != g_RootSheet;
61  };
62 
63  auto& ctxMenu = m_menu.GetMenu();
64  ctxMenu.AddItem( EE_ACTIONS::leaveSheet, belowRootSheetCondition, 2 );
65 
66  return true;
67 }
68 
69 
70 // History lists for PlaceComponent()
73 
74 
76 {
77  SCH_COMPONENT* component = aEvent.Parameter<SCH_COMPONENT*>();
78  SCHLIB_FILTER filter;
79  SCH_BASE_FRAME::HISTORY_LIST* historyList = nullptr;
80 
81  if( aEvent.IsAction( &EE_ACTIONS::placeSymbol ) )
82  historyList = &s_SymbolHistoryList;
83  else if (aEvent.IsAction( &EE_ACTIONS::placePower ) )
84  {
85  historyList = &s_PowerHistoryList;
86  filter.FilterPowerParts( true );
87  }
88  else
89  wxFAIL_MSG( "PlaceCompontent(): unexpected request" );
90 
91  getViewControls()->ShowCursor( true );
92 
93  // If a component was passed in get it ready for placement.
94  if( component )
95  {
96  component->SetFlags( IS_NEW | IS_MOVED );
97 
99  m_selectionTool->AddItemToSel( component );
100  }
101 
102  std::string tool = aEvent.GetCommandStr().get();
103  m_frame->PushTool( tool );
104  Activate();
105 
106  // Prime the pump
107  if( component )
108  {
109  getViewControls()->WarpCursor( getViewControls()->GetMousePosition( false ) );
111  }
112  else if( aEvent.HasPosition() )
114 
115  // Main loop: keep receiving events
116  while( TOOL_EVENT* evt = Wait() )
117  {
118  m_frame->GetCanvas()->SetCurrentCursor( component ? wxCURSOR_ARROW : wxCURSOR_PENCIL );
119  VECTOR2I cursorPos = getViewControls()->GetCursorPosition( !evt->Modifier( MD_ALT ) );
120 
121  auto cleanup = [&] () {
123  m_view->ClearPreview();
124  delete component;
125  component = nullptr;
126  };
127 
128  if( evt->IsCancelInteractive() )
129  {
130  if( component )
131  cleanup();
132  else
133  {
134  m_frame->PopTool( tool );
135  break;
136  }
137  }
138  else if( evt->IsActivate() )
139  {
140  if( component )
141  cleanup();
142 
143  if( evt->IsMoveTool() )
144  {
145  // leave ourselves on the stack so we come back after the move
146  break;
147  }
148  else
149  {
150  m_frame->PopTool( tool );
151  break;
152  }
153  }
154  else if( evt->IsClick( BUT_LEFT ) )
155  {
156  if( !component )
157  {
159 
160  // Pick the module to be placed
161  auto sel = m_frame->SelectCompFromLibTree( &filter, *historyList, true, 1, 1,
163 
164  // Restore cursor after dialog
165  getViewControls()->WarpCursor( getViewControls()->GetCursorPosition(), true );
166 
167  LIB_PART* part = sel.LibId.IsValid() ? m_frame->GetLibPart( sel.LibId ) : nullptr;
168 
169  if( !part )
170  continue;
171 
172  component = new SCH_COMPONENT( *part, g_CurrentSheet, sel, (wxPoint) cursorPos );
173  component->SetFlags( IS_NEW | IS_MOVED );
174 
175  // Be sure the link to the corresponding LIB_PART is OK:
176  component->Resolve( *m_frame->Prj().SchSymbolLibTable() );
177 
178  if( m_frame->GetAutoplaceFields() )
179  component->AutoplaceFields( /* aScreen */ NULL, /* aManual */ false );
180 
181  m_frame->SaveCopyForRepeatItem( component );
182 
183  m_view->ClearPreview();
184  m_view->AddToPreview( component->Clone() );
185  m_selectionTool->AddItemToSel( component );
186  }
187  else
188  {
189  SCH_COMPONENT* next_comp = nullptr;
190 
191  m_view->ClearPreview();
192  m_frame->AddItemToScreenAndUndoList( component );
193 
194  EE_SELECTION new_sel;
195  new_sel.Add( component );
196 
198  m_frame->OnModify();
199 
201  {
202  int new_unit = component->GetUnit();
203 
204  if( m_frame->GetUseAllUnits()
205  && component->GetUnit() < component->GetUnitCount() )
206  new_unit++;
207  else
208  new_unit = 1;
209 
210  // We are either stepping to the next unit or next component
211  if( m_frame->GetRepeatComponent() || new_unit > 1 )
212  {
213  next_comp = static_cast<SCH_COMPONENT*>( component->Duplicate() );
214  next_comp->SetFlags( IS_NEW | IS_MOVED );
215  next_comp->SetUnit( new_unit );
216  next_comp->SetUnitSelection( g_CurrentSheet, new_unit );
217  next_comp->SetTimeStamp( GetNewTimeStamp() );
218 
219  if( m_frame->GetAutoplaceFields() )
220  component->AutoplaceFields( /* aScreen */ NULL, /* aManual */ false );
221 
222  m_frame->SaveCopyForRepeatItem( next_comp );
223  m_view->AddToPreview( next_comp->Clone() );
224  m_selectionTool->AddItemToSel( next_comp );
225  }
226  }
227 
228  component = next_comp;
229  }
230  }
231  else if( evt->IsClick( BUT_RIGHT ) )
232  {
233  // Warp after context menu only if dragging...
234  if( !component )
236 
238  }
239  else if( evt->Category() == TC_COMMAND && evt->Action() == TA_CHOICE_MENU_CHOICE )
240  {
241  if( evt->GetCommandId().get() >= ID_POPUP_SCH_SELECT_UNIT_CMP
242  && evt->GetCommandId().get() <= ID_POPUP_SCH_SELECT_UNIT_CMP_MAX )
243  {
244  int unit = evt->GetCommandId().get() - ID_POPUP_SCH_SELECT_UNIT_CMP;
245 
246  if( component )
247  {
248  m_frame->SelectUnit( component, unit );
250  }
251  }
252  }
253  else if( component && ( evt->IsAction( &ACTIONS::refreshPreview ) || evt->IsMotion() ) )
254  {
255  component->SetPosition( (wxPoint)cursorPos );
256  m_view->ClearPreview();
257  m_view->AddToPreview( component->Clone() );
258  }
259  else
260  evt->SetPassEvent();
261 
262  // Enable autopanning and cursor capture only when there is a module to be placed
263  getViewControls()->SetAutoPan( component != nullptr );
264  getViewControls()->CaptureCursor( component != nullptr );
265  }
266 
267  return 0;
268 }
269 
270 
272 {
273  SCH_BITMAP* image = aEvent.Parameter<SCH_BITMAP*>();
274  bool immediateMode = image;
275  VECTOR2I cursorPos = getViewControls()->GetCursorPosition();
276 
278  getViewControls()->ShowCursor( true );
279 
280  // Add all the drawable parts to preview
281  if( image )
282  {
283  image->SetPosition( (wxPoint)cursorPos );
284  m_view->ClearPreview();
285  m_view->AddToPreview( image->Clone() );
286  }
287 
288  std::string tool = aEvent.GetCommandStr().get();
289  m_frame->PushTool( tool );
290  Activate();
291 
292  // Prime the pump
293  if( image )
295  else if( aEvent.HasPosition() )
297 
298  // Main loop: keep receiving events
299  while( TOOL_EVENT* evt = Wait() )
300  {
301  m_frame->GetCanvas()->SetCurrentCursor( image ? wxCURSOR_ARROW : wxCURSOR_PENCIL );
302  cursorPos = getViewControls()->GetCursorPosition( !evt->Modifier( MD_ALT ) );
303 
304  auto cleanup = [&] () {
306  m_view->ClearPreview();
307  delete image;
308  image = nullptr;
309  };
310 
311  if( evt->IsCancelInteractive() )
312  {
313  if( image )
314  cleanup();
315  else
316  {
317  m_frame->PopTool( tool );
318  break;
319  }
320 
321  if( immediateMode )
322  {
323  m_frame->PopTool( tool );
324  break;
325  }
326  }
327  else if( evt->IsActivate() )
328  {
329  if( image )
330  cleanup();
331 
332  if( evt->IsMoveTool() )
333  {
334  // leave ourselves on the stack so we come back after the move
335  break;
336  }
337  else
338  {
339  m_frame->PopTool( tool );
340  break;
341  }
342  }
343  else if( evt->IsClick( BUT_LEFT ) )
344  {
345  if( !image )
346  {
348  wxFileDialog dlg( m_frame, _( "Choose Image" ), wxEmptyString, wxEmptyString,
349  _( "Image Files " ) + wxImage::GetImageExtWildcard(), wxFD_OPEN );
350 
351  if( dlg.ShowModal() != wxID_OK )
352  continue;
353 
354  // Restore cursor after dialog
355  getViewControls()->WarpCursor( getViewControls()->GetCursorPosition(), true );
356 
357  wxString fullFilename = dlg.GetPath();
358 
359  if( wxFileExists( fullFilename ) )
360  image = new SCH_BITMAP( (wxPoint)cursorPos );
361 
362  if( !image || !image->ReadImageFile( fullFilename ) )
363  {
364  wxMessageBox( _( "Couldn't load image from \"%s\"" ), fullFilename );
365  delete image;
366  image = nullptr;
367  continue;
368  }
369 
370  image->SetFlags( IS_NEW | IS_MOVED );
371 
372  m_frame->SaveCopyForRepeatItem( image );
373 
374  m_view->ClearPreview();
375  m_view->AddToPreview( image->Clone() );
376  m_view->RecacheAllItems(); // Bitmaps are cached in Opengl
377 
378  m_selectionTool->AddItemToSel( image );
379 
380  getViewControls()->SetCursorPosition( cursorPos, false );
381  }
382  else
383  {
385  image = nullptr;
387 
388  m_view->ClearPreview();
389 
390  if( immediateMode )
391  {
392  m_frame->PopTool( tool );
393  break;
394  }
395  }
396  }
397  else if( evt->IsClick( BUT_RIGHT ) )
398  {
399  // Warp after context menu only if dragging...
400  if( !image )
402 
404  }
405  else if( image && ( evt->IsAction( &ACTIONS::refreshPreview ) || evt->IsMotion() ) )
406  {
407  image->SetPosition( (wxPoint)cursorPos );
408  m_view->ClearPreview();
409  m_view->AddToPreview( image->Clone() );
410  m_view->RecacheAllItems(); // Bitmaps are cached in Opengl
411  }
412  else
413  evt->SetPassEvent();
414 
415  // Enable autopanning and cursor capture only when there is a module to be placed
416  getViewControls()->SetAutoPan( image != nullptr );
417  getViewControls()->CaptureCursor( image != nullptr );
418  }
419 
420  return 0;
421 }
422 
423 
425 {
426  wxPoint cursorPos;
427  KICAD_T type = aEvent.Parameter<KICAD_T>();
428 
429  if( type == SCH_JUNCTION_T && aEvent.HasPosition() )
430  {
431  EE_SELECTION& selection = m_selectionTool->GetSelection();
432  SCH_LINE* wire = dynamic_cast<SCH_LINE*>( selection.Front() );
433 
434  if( wire )
435  {
436  SEG seg( wire->GetStartPoint(), wire->GetEndPoint() );
437  VECTOR2I nearest = seg.NearestPoint( getViewControls()->GetCursorPosition() );
438  getViewControls()->SetCrossHairCursorPosition( nearest, false );
439  getViewControls()->WarpCursor( getViewControls()->GetCursorPosition(), true );
440  }
441  }
442 
444  getViewControls()->ShowCursor( true );
445  getViewControls()->SetSnapping( true );
446 
447  SCH_ITEM* previewItem;
448  switch( type )
449  {
450  case SCH_NO_CONNECT_T:
451  previewItem = new SCH_NO_CONNECT( cursorPos );
452  break;
453  case SCH_JUNCTION_T:
454  previewItem = new SCH_JUNCTION( cursorPos );
455  break;
457  previewItem = new SCH_BUS_WIRE_ENTRY( cursorPos, g_lastBusEntryShape );
458  break;
459  case SCH_BUS_BUS_ENTRY_T:
460  previewItem = new SCH_BUS_BUS_ENTRY( cursorPos, g_lastBusEntryShape );
461  break;
462  default:
463  wxASSERT_MSG( false, "Unknown item type in SCH_DRAWING_TOOLS::SingleClickPlace" );
464  return 0;
465  }
466 
467  m_view->ClearPreview();
468  m_view->AddToPreview( previewItem->Clone() );
469 
470  std::string tool = aEvent.GetCommandStr().get();
471  m_frame->PushTool( tool );
472  Activate();
473 
474  // Prime the pump
475  if( aEvent.HasPosition() )
477 
478  // Main loop: keep receiving events
479  while( TOOL_EVENT* evt = Wait() )
480  {
481  m_frame->GetCanvas()->SetCurrentCursor( wxCURSOR_ARROW );
482  cursorPos = (wxPoint) getViewControls()->GetCursorPosition( !evt->Modifier( MD_ALT ) );
483 
484  if( evt->IsCancelInteractive() )
485  {
486  m_frame->PopTool( tool );
487  break;
488  }
489  else if( evt->IsActivate() )
490  {
491  if( evt->IsMoveTool() )
492  {
493  // leave ourselves on the stack so we come back after the move
494  break;
495  }
496  else
497  {
498  m_frame->PopTool( tool );
499  break;
500  }
501  }
502  else if( evt->IsClick( BUT_LEFT ) )
503  {
504  if( !m_frame->GetScreen()->GetItem( cursorPos, 0, type ) )
505  {
506  if( type == SCH_JUNCTION_T )
507  m_frame->AddJunction( cursorPos );
508  else
509  {
510  SCH_ITEM* newItem = static_cast<SCH_ITEM*>( previewItem->Clone() );
511  newItem->SetPosition( cursorPos );
512  newItem->SetFlags( IS_NEW );
513 
515  m_frame->SaveCopyForRepeatItem( newItem );
516 
519  m_frame->OnModify();
520  }
521  }
522  }
523  else if( evt->IsClick( BUT_RIGHT ) )
524  {
526  }
527  else if( evt->IsAction( &ACTIONS::refreshPreview ) || evt->IsMotion() )
528  {
529  previewItem->SetPosition( (wxPoint)cursorPos );
530  m_view->ClearPreview();
531  m_view->AddToPreview( previewItem->Clone() );
532  }
533  else if( evt->Category() == TC_COMMAND )
534  {
535  if( ( type == SCH_BUS_BUS_ENTRY_T || type == SCH_BUS_WIRE_ENTRY_T )
536  && ( evt->IsAction( &EE_ACTIONS::rotateCW )
537  || evt->IsAction( &EE_ACTIONS::rotateCCW )
538  || evt->IsAction( &EE_ACTIONS::mirrorX )
539  || evt->IsAction( &EE_ACTIONS::mirrorY )
540  || evt->IsAction( &EE_ACTIONS::toShapeBackslash )
541  || evt->IsAction( &EE_ACTIONS::toShapeSlash ) ) )
542  {
543  // Update the shape of the bus entry
544  if( evt->IsAction( &EE_ACTIONS::toShapeSlash ) )
545  g_lastBusEntryShape = '/';
546  else if( evt->IsAction( &EE_ACTIONS::toShapeBackslash ) )
547  g_lastBusEntryShape = '\\';
548 
549  SCH_BUS_ENTRY_BASE* busItem = static_cast<SCH_BUS_ENTRY_BASE*>( previewItem );
550 
551  // The bus entries only rotate in one direction
552  if( evt->IsAction( &EE_ACTIONS::rotateCW )
553  || evt->IsAction( &EE_ACTIONS::rotateCCW ) )
554  busItem->Rotate( busItem->GetPosition() );
555  else if( evt->IsAction( &EE_ACTIONS::mirrorX ) )
556  busItem->MirrorX( busItem->GetPosition().x );
557  else if( evt->IsAction( &EE_ACTIONS::mirrorY ) )
558  busItem->MirrorY( busItem->GetPosition().y );
559  else if( evt->IsAction( &EE_ACTIONS::toShapeBackslash )
560  || evt->IsAction( &EE_ACTIONS::toShapeSlash ) )
562 
563  m_view->ClearPreview();
564  m_view->AddToPreview( previewItem->Clone() );
565  }
566  }
567  else
568  evt->SetPassEvent();
569  }
570 
571  delete previewItem;
572  m_view->ClearPreview();
573 
574  return 0;
575 }
576 
577 
579 {
580  EDA_ITEM* item = nullptr;
581  bool importMode = aEvent.IsAction( &EE_ACTIONS::importSheetPin );
582  KICAD_T type = aEvent.Parameter<KICAD_T>();
583 
585  getViewControls()->ShowCursor( true );
586 
587  std::string tool = aEvent.GetCommandStr().get();
588  m_frame->PushTool( tool );
589  Activate();
590 
591  // Prime the pump
592  if( aEvent.HasPosition() )
594 
595  // Main loop: keep receiving events
596  while( TOOL_EVENT* evt = Wait() )
597  {
598  m_frame->GetCanvas()->SetCurrentCursor( item ? wxCURSOR_ARROW : wxCURSOR_PENCIL );
599  VECTOR2I cursorPos = getViewControls()->GetCursorPosition( !evt->Modifier( MD_ALT ) );
600 
601  auto cleanup = [&] () {
603  m_view->ClearPreview();
604  delete item;
605  item = nullptr;
606  };
607 
608  if( evt->IsCancelInteractive() )
609  {
610  if( item )
611  cleanup();
612  else
613  {
614  m_frame->PopTool( tool );
615  break;
616  }
617  }
618  else if( evt->IsActivate() )
619  {
620  if( item )
621  cleanup();
622 
623  if( evt->IsPointEditor() )
624  {
625  // don't exit (the point editor runs in the background)
626  }
627  else if( evt->IsMoveTool() )
628  {
629  // leave ourselves on the stack so we come back after the move
630  break;
631  }
632  else
633  {
634  m_frame->PopTool( tool );
635  break;
636  }
637  }
638  else if( evt->IsClick( BUT_LEFT ) )
639  {
640  // First click creates...
641  if( !item )
642  {
644 
645  switch( type )
646  {
647  case SCH_LABEL_T:
649  break;
650  case SCH_HIER_LABEL_T:
652  break;
653  case SCH_GLOBAL_LABEL_T:
655  break;
656  case SCH_TEXT_T:
657  item = m_frame->CreateNewText( LAYER_NOTES );
658  break;
659  case SCH_SHEET_PIN_T:
660  {
661  SCH_HIERLABEL* label = nullptr;
662  SCH_SHEET* sheet = (SCH_SHEET*) m_selectionTool->SelectPoint( cursorPos,
664  if( !sheet )
665  {
666  m_statusPopup.reset( new STATUS_TEXT_POPUP( m_frame ) );
667  m_statusPopup->SetText( _( "Click over a sheet." ) );
668  m_statusPopup->Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
669  m_statusPopup->PopupFor( 2000 );
670  break;
671  }
672 
673  if( importMode )
674  {
675  label = m_frame->ImportHierLabel( sheet );
676 
677  if( !label )
678  {
679  m_statusPopup.reset( new STATUS_TEXT_POPUP( m_frame ) );
680  m_statusPopup->SetText( _( "No new hierarchical labels found." ) );
681  m_statusPopup->Move( wxGetMousePosition() + wxPoint( 20, 20 ) );
682  m_statusPopup->PopupFor( 2000 );
683  break;
684  }
685  }
686 
687  item = m_frame->CreateSheetPin( sheet, label );
688  break;
689  }
690  default:
691  break;
692  }
693 
694  // Restore cursor after dialog
695  getViewControls()->WarpCursor( getViewControls()->GetCursorPosition(), true );
696 
697  if( item )
698  {
699  item->SetFlags( IS_NEW | IS_MOVED );
700  m_view->ClearPreview();
701  m_view->AddToPreview( item->Clone() );
702  m_selectionTool->AddItemToSel( item );
703  }
704 
705  getViewControls()->SetCursorPosition( cursorPos, false );
706  }
707 
708  // ... and second click places:
709  else
710  {
711  item->ClearFlags( IS_MOVED );
713  item = m_frame->GetNextNewText();
714 
715  if( item )
716  {
718  item->SetFlags( IS_NEW | IS_MOVED );
719  m_view->ClearPreview();
720  m_view->AddToPreview( item->Clone() );
721  m_selectionTool->AddItemToSel( item );
722  }
723  else
724  {
725  m_view->ClearPreview();
726  }
727  }
728  }
729  else if( evt->IsClick( BUT_RIGHT ) )
730  {
731  // Warp after context menu only if dragging...
732  if( !item )
734 
736  }
737  else if( item && evt->IsSelectionEvent() )
738  {
739  // This happens if our text was replaced out from under us by ConvertTextType()
740  EE_SELECTION& selection = m_selectionTool->GetSelection();
741 
742  if( selection.GetSize() == 1 )
743  {
744  item = (SCH_ITEM*) selection.Front();
745  m_view->ClearPreview();
746  m_view->AddToPreview( item->Clone() );
747  }
748  else
749  item = nullptr;
750  }
751  else if( item && ( evt->IsAction( &ACTIONS::refreshPreview ) || evt->IsMotion() ) )
752  {
753  static_cast<SCH_ITEM*>( item )->SetPosition( (wxPoint) cursorPos );
754  m_view->ClearPreview();
755  m_view->AddToPreview( item->Clone() );
756  }
757  else
758  evt->SetPassEvent();
759 
760  // Enable autopanning and cursor capture only when there is a module to be placed
761  getViewControls()->SetAutoPan( item != nullptr );
762  getViewControls()->CaptureCursor( item != nullptr );
763  }
764 
765  return 0;
766 }
767 
768 
770 {
772  SCH_SHEET* sheet = nullptr;
773 
775  getViewControls()->ShowCursor( true );
776 
777  std::string tool = aEvent.GetCommandStr().get();
778  m_frame->PushTool( tool );
779  Activate();
780 
781  // Prime the pump
782  if( aEvent.HasPosition() )
784 
785  // Main loop: keep receiving events
786  while( TOOL_EVENT* evt = Wait() )
787  {
788  if( !pointEditor->HasPoint() )
789  m_frame->GetCanvas()->SetCurrentCursor( wxCURSOR_PENCIL );
790 
791  VECTOR2I cursorPos = getViewControls()->GetCursorPosition( !evt->Modifier( MD_ALT ) );
792 
793  auto cleanup = [&] () {
795  m_view->ClearPreview();
796  delete sheet;
797  sheet = nullptr;
798  };
799 
800  if( evt->IsCancelInteractive() )
801  {
802  if( sheet )
803  cleanup();
804  else
805  {
806  m_frame->PopTool( tool );
807  break;
808  }
809  }
810  else if( evt->IsActivate() )
811  {
812  if( sheet )
813  cleanup();
814 
815  if( evt->IsPointEditor() )
816  {
817  // don't exit (the point editor runs in the background)
818  }
819  else if( evt->IsMoveTool() )
820  {
821  // leave ourselves on the stack so we come back after the move
822  break;
823  }
824  else
825  {
826  m_frame->PopTool( tool );
827  break;
828  }
829  }
830 
831  else if( evt->IsClick( BUT_LEFT ) && !sheet )
832  {
834 
835  sheet = new SCH_SHEET( (wxPoint) cursorPos );
836  sheet->SetFlags( IS_NEW | IS_RESIZED );
837  sheet->SetTimeStamp( GetNewTimeStamp() );
838  sheet->SetParent( m_frame->GetScreen() );
839  sheet->SetScreen( NULL );
840  sizeSheet( sheet, cursorPos );
841 
842  m_view->ClearPreview();
843  m_view->AddToPreview( sheet->Clone() );
844  }
845 
846  else if( sheet && ( evt->IsClick( BUT_LEFT )
847  || evt->IsAction( &EE_ACTIONS::finishSheet ) ) )
848  {
849  m_view->ClearPreview();
850  getViewControls()->SetAutoPan( false );
851  getViewControls()->CaptureCursor( false );
852 
853  if( m_frame->EditSheet( (SCH_SHEET*)sheet, g_CurrentSheet, nullptr ) )
854  {
856  m_selectionTool->AddItemToSel( sheet );
857  }
858  else
859  {
860  delete sheet;
861  }
862 
863  sheet = nullptr;
864  }
865 
866  else if( sheet && ( evt->IsAction( &ACTIONS::refreshPreview ) || evt->IsMotion() ) )
867  {
868  sizeSheet( sheet, cursorPos );
869  m_view->ClearPreview();
870  m_view->AddToPreview( sheet->Clone() );
871  }
872 
873  else if( evt->IsClick( BUT_RIGHT ) )
874  {
875  // Warp after context menu only if dragging...
876  if( !sheet )
878 
880  }
881  else
882  evt->SetPassEvent();
883 
884  // Enable autopanning and cursor capture only when there is a sheet to be placed
885  getViewControls()->SetAutoPan( sheet != nullptr );
886  getViewControls()->CaptureCursor( sheet != nullptr );
887  }
888 
889  return 0;
890 }
891 
892 
894 {
895  wxPoint pos = aSheet->GetPosition();
896  wxPoint size = (wxPoint) aPos - pos;
897 
898  size.x = std::max( size.x, MIN_SHEET_WIDTH );
899  size.y = std::max( size.y, MIN_SHEET_HEIGHT );
900 
901  wxPoint grid = m_frame->GetNearestGridPosition( pos + size );
902  aSheet->Resize( wxSize( grid.x - pos.x, grid.y - pos.y ) );
903 }
904 
905 
907 {
922 }
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
Class for a bus to bus entry.
void SetTimeStamp(timestamp_t aNewTimeStamp)
Change the time stamp to aNewTimeStamp and updates the reference path.
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 ...
int TwoClickPlace(const TOOL_EVENT &aEvent)
TOOL_MENU m_menu
functions below are not yet implemented - their interface may change
void AddToPreview(EDA_ITEM *aItem, bool aTakeOwnership=true)
Definition: sch_view.cpp:193
static TOOL_ACTION finishSheet
Definition: ee_actions.h:101
SCH_ITEM * Duplicate(bool doClone=false)
Routine to create a new copy of given item.
Definition: sch_item.cpp:75
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
int PlaceComponent(const TOOL_EVENT &aEvent)
SCH_TEXT * CreateNewText(int aType)
Definition: edit_label.cpp:62
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
static TOOL_ACTION activatePointEditor
Definition: actions.h:159
wxPoint GetStartPoint() const
Definition: sch_line.h:99
SCH_SHEET * Last() const
Function Last returns a pointer to the last sheet of the list One can see the others sheet as the "pa...
char g_lastBusEntryShape
This file is part of the common library.
static TOOL_ACTION toShapeBackslash
Definition: ee_actions.h:132
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.
VIEW_CONTROLS class definition.
bool HasPoint()
Indicates the cursor is over an edit point.
bool Resolve(PART_LIBS *aLibs)
Assigns the current LIB_PART from aLibs which this symbol is based on.
Class STATUS_TEXT_POPUP.
Definition: status_popup.h:79
bool GetShowFootprintPreviews() const
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION mirrorY
Definition: ee_actions.h:121
static TOOL_ACTION placeHierLabel
Definition: ee_actions.h:90
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
static TOOL_ACTION placeJunction
Definition: ee_actions.h:85
void RecacheAllItems()
Function RecacheAllItems() Rebuilds GAL display lists.
Definition: view.cpp:1402
int GetUnitCount() const
Return the number of units per package of the symbol.
void Rotate(wxPoint aPosition) override
Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.
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
std::vector< COMPONENT_SELECTION > HISTORY_LIST
void SetPosition(const wxPoint &aPosition) override
Function SetPosition set the schematic item position to aPosition.
static SCH_BASE_FRAME::HISTORY_LIST s_PowerHistoryList
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.
static TOOL_ACTION placeBusBusEntry
Definition: ee_actions.h:87
LIB_PART * GetLibPart(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load symbol from symbol library table.
static TOOL_ACTION placeBusWireEntry
Definition: ee_actions.h:86
bool TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
void SetUnitSelection(SCH_SHEET_PATH *aSheet, int aUnitSelection)
static const KICAD_T SheetsOnly[]
Definition: ee_collectors.h:45
wxPoint GetNearestGridPosition(const wxPoint &aPosition) const
Return the nearest aGridSize location to aPosition.
bool GetAutoplaceFields() const
int PlaceImage(const TOOL_EVENT &aEvent)
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Function Go()
bool EditSheet(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aClearAnnotationNewItems)
Edit an existing sheet or add a new sheet to the schematic.
Definition: sheet.cpp:518
const bool GetUseAllUnits()
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:42
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
static TOOL_ACTION rotateCW
Definition: ee_actions.h:118
virtual void Add(EDA_ITEM *aItem)
Definition: selection.h:74
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 leaveSheet
Definition: ee_actions.h:177
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:41
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
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
static TOOL_ACTION drawSheet
Definition: ee_actions.h:91
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
Function WarpCursor() If enabled (.
static TOOL_ACTION rotateCCW
Definition: ee_actions.h:119
int GetUnit() const
static TOOL_ACTION placePower
Definition: ee_actions.h:80
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:265
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:47
SCH_SHEET_PATH * g_CurrentSheet
With the new connectivity algorithm, many more places than before want to know what the current sheet...
COMPONENT_SELECTION SelectCompFromLibTree(const SCHLIB_FILTER *aFilter, std::vector< COMPONENT_SELECTION > &aHistoryList, bool aUseLibBrowser, int aUnit, int aConvert, bool aShowFootprints, const LIB_ID *aHighlight=nullptr, bool aAllowFields=true)
Function SelectComponentFromLib Calls the library viewer to select component to import into schematic...
Definition: getpart.cpp:94
virtual void SetPosition(const wxPoint &aPosition)=0
Function SetPosition set the schematic item position to aPosition.
static TOOL_ACTION placeSheetPin
Definition: ee_actions.h:92
virtual void CaptureCursor(bool aEnabled)
Function CaptureCursor() Forces the cursor to stay within the drawing panel area.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
int SingleClickPlace(const TOOL_EVENT &aEvent)
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:435
static TOOL_ACTION placeSchematicText
Definition: ee_actions.h:94
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Class TOOL_EVENT.
Definition: tool_event.h:171
static TOOL_ACTION placeImage
Definition: ee_actions.h:96
void ClearPreview()
Definition: sch_view.cpp:181
SCH_ITEM * GetItem(const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=SCH_LOCATE_ANY_T) const
Check aPosition within a distance of aAccuracy for items of type aFilter.
Definition: sch_screen.cpp:235
Define a library symbol object.
void SaveCopyForRepeatItem(SCH_ITEM *aItem)
Clone aItem and owns that clone in this container.
SCH_JUNCTION * AddJunction(const wxPoint &aPos, bool aAppendToUndo=false, bool aFinal=true)
static TOOL_ACTION mirrorX
Definition: ee_actions.h:120
EE_SELECTION_TOOL * m_selectionTool
Definition: ee_tool_base.h:141
static TOOL_ACTION importSheetPin
Definition: ee_actions.h:93
void SetUnit(int aUnit)
Change the unit number to aUnit.
static TOOL_ACTION clearSelection
Clears the current selection.
Definition: ee_actions.h:58
static TOOL_ACTION placeSymbol
Definition: ee_actions.h:79
void SetBusEntryShape(char aShape)
function SetBusEntryShape
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.
SCH_TEXT * GetNextNewText()
Gets the next queued text item.
Definition: edit_label.cpp:50
static TOOL_ACTION addNeededJunctions
Definition: ee_actions.h:77
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_sheet.h:543
#define _(s)
Object to handle a bitmap image that can be inserted in a schematic.
Definition: sch_bitmap.h:42
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
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
virtual unsigned int GetSize() const override
Function GetSize() Returns the number of stored items.
Definition: selection.h:98
Definition: seg.h:36
static TOOL_ACTION placeLabel
Definition: ee_actions.h:88
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:463
const bool GetRepeatComponent()
SCH_HIERLABEL * ImportHierLabel(SCH_SHEET *aSheet)
Import a hierarchical label with no attached sheet pin.
Definition: sheet.cpp:821
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Automatically orient all the fields in the component.
int AddItemToSel(const TOOL_EVENT &aEvent)
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
#define max(a, b)
Definition: auxiliary.h:86
Class EE_POINT_EDITOR.
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
void VetoContextMenuMouseWarp()
Disables mouse warping after the current context menu is closed.
Definition: tool_manager.h:384
static TOOL_ACTION placeNoConnect
Definition: ee_actions.h:84
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_bitmap.cpp:87
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:43
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:121
virtual void PopTool(const std::string &actionName)
Class for a wire to bus entry.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:266
void Activate()
Function Activate() Runs the tool.
bool ReadImageFile(const wxString &aFullFilename)
Reads and stores an image file.
Definition: sch_bitmap.cpp:81
Class EE_TOOL_BASE.
Definition: ee_tool_base.h:50
bool HasPosition() const
Returns if it this event has a valid position (true for mouse events and context-menu or hotkey-based...
Definition: tool_event.h:260
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
Definition for part library class.
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
EDA_ITEM * SelectPoint(const VECTOR2I &aWhere, const KICAD_T *aFilterList=EE_COLLECTOR::AllItems, bool *aSelectionCancelledFlag=NULL, bool aCheckLocked=false, bool aAdd=false, bool aSubtract=false, bool aExclusiveOr=false)
Function selectPoint() Selects an item pointed by the parameter aWhere.
static TOOL_ACTION placeGlobalLabel
Definition: ee_actions.h:89
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Function AddItem()
void MirrorY(int aYaxis_position) override
Function MirrorY mirrors item relative to the Y axis about aYaxis_position.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
Definitions of the SCH_TEXT class and derivatives for Eeschema.
void ShowContextMenu(SELECTION &aSelection)
Function ShowContextMenu.
Definition: tool_menu.cpp:59
SCH_SHEET_PIN * CreateSheetPin(SCH_SHEET *aSheet, SCH_HIERLABEL *aLabel)
Create a new SCH_SHEET_PIN object and add it to aSheet at the current cursor position.
Definition: sheet.cpp:785
void SetPosition(const wxPoint &aPosition) override
Function SetPosition set the schematic item position to aPosition.
Definition: sch_bitmap.h:141
void setTransitions() override
Sets up handlers for various events.
static TOOL_ACTION toShapeSlash
Definition: ee_actions.h:131
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
int DrawSheet(const TOOL_EVENT &aEvent)
static TOOL_ACTION cursorClick
Definition: actions.h:115
static SCH_BASE_FRAME::HISTORY_LIST s_SymbolHistoryList
void Resize(const wxSize &aSize)
Resize this sheet to aSize and adjust all of the labels accordingly.
Definition: sch_sheet.cpp:736
void sizeSheet(SCH_SHEET *aSheet, VECTOR2I aPos)
wxPoint GetPosition() const override
Function GetPosition.
void AddItemToScreenAndUndoList(SCH_ITEM *aItem, bool aUndoAppend=false)
Add an item to the schematic and adds the changes to the undo/redo container.
#define IS_MOVED
Item being moved.
Definition: base_struct.h:119
wxPoint GetEndPoint() const
Definition: sch_line.h:102
std::unique_ptr< STATUS_TEXT_POPUP > m_statusPopup