KiCad PCB EDA Suite
sch_line_wire_bus_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 <sch_line_wire_bus_tool.h>
26 
27 #include <boost/optional/optional.hpp>
28 #include <wx/debug.h>
29 #include <wx/gdicmn.h>
30 #include <wx/menu.h>
31 #include <wx/string.h>
32 #include <wx/stringimpl.h>
33 #include <wx/translation.h>
34 #include <algorithm>
35 #include <cstdlib>
36 #include <deque>
37 #include <iterator>
38 #include <memory>
39 #include <string>
40 #include <utility>
41 #include <vector>
42 
43 #include <base_screen.h>
44 #include <base_struct.h>
45 #include <bitmaps.h>
46 #include <core/typeinfo.h>
47 #include <eda_text.h>
49 #include <math/vector2d.h>
50 #include <advanced_config.h>
51 #include <tool/actions.h>
52 #include <tool/conditional_menu.h>
53 #include <tool/selection.h>
55 #include <tool/tool_action.h>
56 #include <tool/tool_event.h>
57 #include <tool/tool_interactive.h>
58 #include <tool/tool_manager.h>
59 #include <trigo.h>
60 #include <undo_redo_container.h>
61 #include <view/view_controls.h>
62 
63 #include <connection_graph.h>
64 #include <eeschema_id.h>
65 #include <general.h>
66 #include <sch_bus_entry.h>
67 #include <sch_connection.h>
68 #include <sch_draw_panel.h>
69 #include <sch_edit_frame.h>
70 #include <sch_item.h>
71 #include <sch_line.h>
72 #include <sch_screen.h>
73 #include <sch_sheet.h>
74 #include <sch_sheet_path.h>
75 #include <sch_text.h>
76 #include <sch_view.h>
77 #include <schematic.h>
78 
79 #include <ee_actions.h>
80 #include <ee_point_editor.h>
81 #include <ee_selection.h>
82 #include <ee_selection_tool.h>
83 
85 {
86 public:
88  ACTION_MENU( true ),
89  m_showTitle( false )
90  {
92  SetTitle( _( "Unfold from Bus" ) );
93  }
94 
95  void SetShowTitle()
96  {
97  m_showTitle = true;
98  }
99 
100 
101 protected:
102  ACTION_MENU* create() const override
103  {
104  return new BUS_UNFOLD_MENU();
105  }
106 
107 private:
108  void update() override
109  {
112  KICAD_T busType[] = { SCH_LINE_LOCATE_BUS_T, EOT };
113  EE_SELECTION& selection = selTool->RequestSelection( busType );
114  SCH_LINE* bus = (SCH_LINE*) selection.Front();
115 
116  Clear();
117 
118  // TODO(JE) remove once real-time is enabled
119  if( !ADVANCED_CFG::GetCfg().m_realTimeConnectivity || !CONNECTION_GRAPH::m_allowRealTime )
120  {
122 
123  // Pick up the pointer again because it may have been changed by SchematicCleanUp
124  selection = selTool->RequestSelection( busType );
125  bus = (SCH_LINE*) selection.Front();
126  }
127 
128  if( !bus )
129  {
130  Append( ID_POPUP_SCH_UNFOLD_BUS, _( "No bus selected" ), wxEmptyString );
131  Enable( ID_POPUP_SCH_UNFOLD_BUS, false );
132  return;
133  }
134 
135  SCH_CONNECTION* connection = bus->Connection( frame->GetCurrentSheet() );
136 
137  if( !connection || !connection->IsBus() || connection->Members().empty() )
138  {
139  Append( ID_POPUP_SCH_UNFOLD_BUS, _( "Bus has no connections" ), wxEmptyString );
140  Enable( ID_POPUP_SCH_UNFOLD_BUS, false );
141  return;
142  }
143 
144  int idx = 0;
145 
146  if( m_showTitle )
147  {
148  Append( ID_POPUP_SCH_UNFOLD_BUS, _( "Unfold from Bus" ), wxEmptyString );
149  Enable( ID_POPUP_SCH_UNFOLD_BUS, false );
150  }
151 
152  for( const auto& member : connection->Members() )
153  {
154  int id = ID_POPUP_SCH_UNFOLD_BUS + ( idx++ );
155  wxString name = SCH_CONNECTION::PrintBusForUI( member->FullLocalName() );
156 
157  if( member->Type() == CONNECTION_TYPE::BUS )
158  {
159  ACTION_MENU* submenu = new ACTION_MENU( true );
160  submenu->SetTool( m_tool );
161  AppendSubMenu( submenu, name );
162 
163  for( const auto& sub_member : member->Members() )
164  {
165  id = ID_POPUP_SCH_UNFOLD_BUS + ( idx++ );
166  name = SCH_CONNECTION::PrintBusForUI( sub_member->FullLocalName() );
167  submenu->Append( id, name, wxEmptyString );
168  }
169  }
170  else
171  {
172  Append( id, name, wxEmptyString );
173  }
174  }
175  }
176 
178 };
179 
180 
182  EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.InteractiveDrawingLineWireBus" )
183 {
184  m_busUnfold = {};
185  m_wires.reserve( 16 );
186 }
187 
188 
190 {
191 }
192 
193 
195 {
197 
198  auto wireOrBusTool = [ this ] ( const SELECTION& aSel ) {
201  };
202 
203  auto lineTool = [ this ] ( const SELECTION& aSel ) {
205  };
206 
207  auto belowRootSheetCondition =
208  [&]( const SELECTION& aSel )
209  {
210  return m_frame->GetCurrentSheet().Last() != &m_frame->Schematic().Root();
211  };
212 
213  auto busSelection = EE_CONDITIONS::MoreThan( 0 )
215 
216  auto& ctxMenu = m_menu.GetMenu();
217 
218  // Build the tool menu
219  //
220  ctxMenu.AddItem( EE_ACTIONS::leaveSheet, belowRootSheetCondition, 2 );
221 
222  ctxMenu.AddSeparator( 10 );
223  ctxMenu.AddItem( EE_ACTIONS::drawWire, wireOrBusTool && EE_CONDITIONS::Idle, 10 );
224  ctxMenu.AddItem( EE_ACTIONS::drawBus, wireOrBusTool && EE_CONDITIONS::Idle, 10 );
225  ctxMenu.AddItem( EE_ACTIONS::drawLines, lineTool && EE_CONDITIONS::Idle, 10 );
226  ctxMenu.AddItem( EE_ACTIONS::finishWire, IsDrawingWire, 10 );
227  ctxMenu.AddItem( EE_ACTIONS::finishBus, IsDrawingBus, 10 );
228  ctxMenu.AddItem( EE_ACTIONS::finishLine, IsDrawingLine, 10 );
229 
230  std::shared_ptr<BUS_UNFOLD_MENU> busUnfoldMenu = std::make_shared<BUS_UNFOLD_MENU>();
231  busUnfoldMenu->SetTool( this );
232  m_menu.AddSubMenu( busUnfoldMenu );
233  ctxMenu.AddMenu( busUnfoldMenu.get(), EE_CONDITIONS::Idle, 10 );
234 
235  ctxMenu.AddSeparator( 100 );
236  ctxMenu.AddItem( EE_ACTIONS::placeJunction, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
237  ctxMenu.AddItem( EE_ACTIONS::placeLabel, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
238  ctxMenu.AddItem( EE_ACTIONS::placeGlobalLabel, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
239  ctxMenu.AddItem( EE_ACTIONS::placeHierLabel, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
240  ctxMenu.AddItem( EE_ACTIONS::breakWire, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
241  ctxMenu.AddItem( EE_ACTIONS::breakBus, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
242 
243  ctxMenu.AddSeparator( 200 );
244  ctxMenu.AddItem( EE_ACTIONS::selectNode, wireOrBusTool && EE_CONDITIONS::Idle, 200 );
245  ctxMenu.AddItem( EE_ACTIONS::selectConnection, wireOrBusTool && EE_CONDITIONS::Idle, 200 );
246 
247  // Add bus unfolding to the selection tool
248  //
250 
251  std::shared_ptr<BUS_UNFOLD_MENU> selBusUnfoldMenu = std::make_shared<BUS_UNFOLD_MENU>();
252  selBusUnfoldMenu->SetTool( m_selectionTool );
253  m_selectionTool->GetToolMenu().AddSubMenu( selBusUnfoldMenu );
254  selToolMenu.AddMenu( selBusUnfoldMenu.get(), busSelection && EE_CONDITIONS::Idle, 100 );
255 
256  return true;
257 }
258 
259 
261 {
262  static KICAD_T graphicLineType[] = { SCH_LINE_LOCATE_GRAPHIC_LINE_T, EOT };
263  return IsDrawingLineWireOrBus( aSelection ) && aSelection.Front()->IsType( graphicLineType );
264 }
265 
266 
268 {
269  static KICAD_T wireType[] = { SCH_LINE_LOCATE_WIRE_T, EOT };
270  return IsDrawingLineWireOrBus( aSelection ) && aSelection.Front()->IsType( wireType );
271 }
272 
273 
275 {
276  static KICAD_T busType[] = { SCH_LINE_LOCATE_BUS_T, EOT };
277  return IsDrawingLineWireOrBus( aSelection ) && aSelection.Front()->IsType( busType );
278 }
279 
280 
282 {
283  // NOTE: for immediate hotkeys, it is NOT required that the line, wire or bus tool
284  // be selected
285  SCH_ITEM* item = (SCH_ITEM*) aSelection.Front();
286  return item && item->IsNew() && item->Type() == SCH_LINE_T;
287 }
288 
289 
291 {
292  SCH_LAYER_ID layer = aEvent.Parameter<SCH_LAYER_ID>();
293 
294  if( aEvent.HasPosition() )
295  getViewControls()->WarpCursor( getViewControls()->GetCursorPosition(), true );
296 
297  std::string tool = aEvent.GetCommandStr().get();
298  m_frame->PushTool( tool );
299 
300  if( aEvent.HasPosition() )
301  {
302  VECTOR2D cursorPos = getViewControls()->GetCursorPosition( !aEvent.Modifier( MD_ALT ) );
303  startSegments( layer, cursorPos );
304  }
305 
306  return doDrawSegments( tool, layer );
307 }
308 
309 
311 {
312  wxString* netPtr = aEvent.Parameter<wxString*>();
313  wxString net;
314  SCH_LINE* segment = nullptr;
315 
316  std::string tool = aEvent.GetCommandStr().get();
317  m_frame->PushTool( tool );
318  Activate();
319 
320  if( netPtr )
321  {
322  net = *netPtr;
323  delete netPtr;
324  }
325  else
326  {
327  BUS_UNFOLD_MENU unfoldMenu;
328  unfoldMenu.SetTool( this );
329  unfoldMenu.SetShowTitle();
330 
331  SetContextMenu( &unfoldMenu, CMENU_NOW );
332 
333  while( TOOL_EVENT* evt = Wait() )
334  {
335  if( evt->Action() == TA_CHOICE_MENU_CHOICE )
336  {
337  OPT<int> id = evt->GetCommandId();
338 
339  if( id && ( *id > 0 ) )
340  net = *evt->Parameter<wxString*>();
341 
342  break;
343  }
344  else if( evt->Action() == TA_CHOICE_MENU_CLOSED )
345  {
346  break;
347  }
348  else
349  {
350  evt->SetPassEvent();
351  }
352  }
353  }
354 
355  // Break a wire for the given net out of the bus
356  if( !net.IsEmpty() )
357  segment = doUnfoldBus( net );
358 
359  // If we have an unfolded wire to draw, then draw it
360  if( segment )
361  return doDrawSegments( tool, LAYER_WIRE );
362  else
363  {
364  m_frame->PopTool( tool );
365  return 0;
366  }
367 }
368 
369 
371 {
372  SCHEMATIC_SETTINGS& cfg = getModel<SCHEMATIC>()->Settings();
374 
376 
377  m_busUnfold.entry = new SCH_BUS_WIRE_ENTRY( pos, '\\' );
380 
381  m_busUnfold.label = new SCH_LABEL( m_busUnfold.entry->m_End(), aNet );
386 
387  m_busUnfold.in_progress = true;
388  m_busUnfold.origin = pos;
389  m_busUnfold.net_name = aNet;
390 
392 
394 }
395 
396 
398 {
399  SCH_SCREEN* screen = m_frame->GetScreen();
400 
401  for( auto item : screen->Items().Overlapping( SCH_SHEET_T, aPosition ) )
402  {
403  auto sheet = static_cast<SCH_SHEET*>( item );
404 
405  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
406  {
407  if( pin->GetPosition() == aPosition )
408  return pin;
409  }
410  }
411 
412  return nullptr;
413 }
414 
415 
416 void SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint( const std::pair<SCH_LINE*, SCH_LINE*>& aSegments,
417  wxPoint& aPosition )
418 {
419  wxCHECK_RET( aSegments.first && aSegments.second,
420  wxT( "Cannot compute break point of NULL line segment." ) );
421 
422  SCH_LINE* segment = aSegments.first;
423  SCH_LINE* next_segment = aSegments.second;
424 
425  wxPoint midPoint;
426  int iDx = segment->GetEndPoint().x - segment->GetStartPoint().x;
427  int iDy = segment->GetEndPoint().y - segment->GetStartPoint().y;
428 
429  const SCH_SHEET_PIN* connectedPin = getSheetPin( segment->GetStartPoint() );
430  auto force = connectedPin ? connectedPin->GetEdge() : SHEET_UNDEFINED_SIDE;
431 
432  if( force == SHEET_LEFT_SIDE || force == SHEET_RIGHT_SIDE )
433  {
434  if( aPosition.x == connectedPin->GetPosition().x ) // push outside sheet boundary
435  {
436  int direction = ( force == SHEET_LEFT_SIDE ) ? -1 : 1;
437  aPosition.x += KiROUND( getView()->GetGAL()->GetGridSize().x * direction );
438  }
439 
440  midPoint.x = aPosition.x;
441  midPoint.y = segment->GetStartPoint().y; // force horizontal
442  }
443  else if( iDy != 0 ) // keep the first segment orientation (vertical)
444  {
445  midPoint.x = segment->GetStartPoint().x;
446  midPoint.y = aPosition.y;
447  }
448  else if( iDx != 0 ) // keep the first segment orientation (horizontal)
449  {
450  midPoint.x = aPosition.x;
451  midPoint.y = segment->GetStartPoint().y;
452  }
453  else
454  {
455  if( std::abs( aPosition.x - segment->GetStartPoint().x ) <
456  std::abs( aPosition.y - segment->GetStartPoint().y ) )
457  {
458  midPoint.x = segment->GetStartPoint().x;
459  midPoint.y = aPosition.y;
460  }
461  else
462  {
463  midPoint.x = aPosition.x;
464  midPoint.y = segment->GetStartPoint().y;
465  }
466  }
467 
468  segment->SetEndPoint( midPoint );
469  next_segment->SetStartPoint( midPoint );
470  next_segment->SetEndPoint( aPosition );
471 }
472 
473 
474 int SCH_LINE_WIRE_BUS_TOOL::doDrawSegments( const std::string& aTool, int aType )
475 {
476  SCH_SCREEN* screen = m_frame->GetScreen();
478  SCH_LINE* segment = nullptr;
479 
481  getViewControls()->ShowCursor( true );
482 
483  Activate();
484 
485  // Add the new label to the selection so the rotate command operates on it
486  if( m_busUnfold.label )
488 
489  // Continue the existing wires if we've started (usually by immediate action preference)
490  if( !m_wires.empty() )
491  segment = m_wires.back();
492 
493  // Main loop: keep receiving events
494  while( TOOL_EVENT* evt = Wait() )
495  {
496  if( !pointEditor->HasPoint() ) // Set wxCursor shape when starting the tool
497  m_frame->GetCanvas()->SetCurrentCursor( wxCURSOR_PENCIL );
498 
499  wxPoint cursorPos = (wxPoint) getViewControls()->GetCursorPosition( !evt->Modifier( MD_ALT ) );
500  bool forceHV = m_frame->eeconfig()->m_Drawing.hv_lines_only;
501 
502  //------------------------------------------------------------------------
503  // Handle cancel:
504  //
505  auto cleanup = [&] () {
507 
508  for( auto wire : m_wires )
509  delete wire;
510 
511  m_wires.clear();
512  segment = nullptr;
513 
514  if( m_busUnfold.entry )
516 
519 
522 
523  delete m_busUnfold.entry;
524  delete m_busUnfold.label;
525  m_busUnfold = {};
526 
527  m_view->ClearPreview();
528  m_view->ShowPreview( false );
529  };
530 
531  if( evt->IsCancelInteractive() )
532  {
533  if( segment || m_busUnfold.in_progress )
534  cleanup();
535  else
536  {
537  m_frame->PopTool( aTool );
538  break;
539  }
540  }
541  else if( evt->IsActivate() )
542  {
543  if( segment || m_busUnfold.in_progress )
544  cleanup();
545 
546  if( evt->IsMoveTool() )
547  {
548  // leave ourselves on the stack so we come back after the move
549  break;
550  }
551  else
552  {
553  m_frame->PopTool( aTool );
554  break;
555  }
556  }
557  //------------------------------------------------------------------------
558  // Handle finish:
559  //
560  else if( evt->IsAction( &EE_ACTIONS::finishLineWireOrBus )
561  || evt->IsAction( &EE_ACTIONS::finishWire )
562  || evt->IsAction( &EE_ACTIONS::finishBus )
563  || evt->IsAction( &EE_ACTIONS::finishLine ) )
564  {
565  if( segment || m_busUnfold.in_progress )
566  {
567  finishSegments();
568  segment = nullptr;
569  }
570  }
571  //------------------------------------------------------------------------
572  // Handle click:
573  //
574  else if( evt->IsClick( BUT_LEFT ) || ( segment && evt->IsDblClick( BUT_LEFT ) ) )
575  {
576  // First click when unfolding places the label and wire-to-bus entry
578  {
579  wxASSERT( aType == LAYER_WIRE );
580 
583  m_busUnfold.label_placed = true;
584  }
585 
586  if( !segment )
587  {
588  segment = startSegments( aType, VECTOR2D( cursorPos ) );
589  }
590  // Create a new segment if we're out of previously-created ones
591  else if( !segment->IsNull() || ( forceHV && !m_wires[ m_wires.size() - 2 ]->IsNull() ) )
592  {
593  // Terminate the command if the end point is on a pin, junction, or another
594  // wire or bus.
596  && screen->IsTerminalPoint( cursorPos, segment->GetLayer() ) )
597  {
598  finishSegments();
599  segment = nullptr;
600  }
601  else
602  {
603  segment->SetEndPoint( cursorPos );
604 
605  // Create a new segment, and chain it after the current segment.
606  segment = new SCH_LINE( *segment );
607  segment->SetFlags( IS_NEW | IS_MOVED );
608  segment->SetStartPoint( cursorPos );
609  m_wires.push_back( segment );
610 
611  m_selectionTool->AddItemToSel( segment, true /*quiet mode*/ );
612  }
613  }
614 
615  if( evt->IsDblClick( BUT_LEFT ) && segment )
616  {
617  if( forceHV && m_wires.size() >= 2 )
618  computeBreakPoint( { m_wires[ m_wires.size() - 2 ], segment }, cursorPos );
619 
620  finishSegments();
621  segment = nullptr;
622  }
623  }
624  //------------------------------------------------------------------------
625  // Handle motion:
626  //
627  else if( evt->IsMotion() || evt->IsAction( &ACTIONS::refreshPreview ) )
628  {
629  m_view->ClearPreview();
630 
631  // Update the bus unfold posture based on the mouse movement
633  {
634  wxPoint cursor_delta = cursorPos - m_busUnfold.origin;
636 
637  bool offset = ( cursor_delta.x < 0 );
638 
639  // Erase and redraw if necessary
640  if( offset != m_busUnfold.offset )
641  {
642  wxPoint entry_pos = m_busUnfold.origin;
643 
644  if( offset )
645  entry_pos -= entry->GetSize();
646 
647  entry->SetPosition( entry_pos );
648  m_busUnfold.offset = offset;
649 
650  m_frame->RefreshItem( entry );
651 
652  wxPoint wire_start = offset ? entry->GetPosition() : entry->m_End();
653  m_wires.front()->SetStartPoint( wire_start );
654  }
655 
656  // Update the label "ghost" position
657  m_busUnfold.label->SetPosition( cursorPos );
659 
660  // Ensure segment is non-null at the start of bus unfold
661  if( !segment )
662  segment = m_wires.back();
663  }
664 
665  if( segment )
666  {
667  // Coerce the line to vertical or horizontal if necessary
668  if( forceHV && m_wires.size() >= 2 )
669  computeBreakPoint( { m_wires[ m_wires.size() - 2 ], segment }, cursorPos );
670  else
671  segment->SetEndPoint( cursorPos );
672  }
673 
674  for( auto wire : m_wires )
675  {
676  if( !wire->IsNull() )
677  m_view->AddToPreview( wire->Clone() );
678  }
679  }
680  //------------------------------------------------------------------------
681  // Handle context menu:
682  //
683  else if( evt->IsClick( BUT_RIGHT ) )
684  {
685  // Warp after context menu only if dragging...
686  if( !segment )
688 
690  }
691  else if( evt->Category() == TC_COMMAND && evt->Action() == TA_CHOICE_MENU_CHOICE )
692  {
693  if( evt->GetCommandId().get() >= ID_POPUP_SCH_UNFOLD_BUS
694  && evt->GetCommandId().get() <= ID_POPUP_SCH_UNFOLD_BUS_END )
695  {
696  wxASSERT_MSG( !segment, "Bus unfold event received when already drawing!" );
697 
698  aType = LAYER_WIRE;
699  wxString net = *evt->Parameter<wxString*>();
700  segment = doUnfoldBus( net );
701  }
702  }
703  else
704  evt->SetPassEvent();
705 
706  // Enable autopanning and cursor capture only when there is a segment to be placed
707  getViewControls()->SetAutoPan( segment != nullptr );
708  getViewControls()->CaptureCursor( segment != nullptr );
709  }
710 
711  return 0;
712 }
713 
714 
716 {
717  SCH_LINE* segment = nullptr;
718 
719  switch ( aType )
720  {
721  default:
722  segment = new SCH_LINE( aPos, LAYER_NOTES );
723  break;
724  case LAYER_WIRE:
725  segment = new SCH_LINE( aPos, LAYER_WIRE );
726  break;
727  case LAYER_BUS:
728  segment = new SCH_LINE( aPos, LAYER_BUS );
729  break;
730  }
731 
732  segment->SetFlags( IS_NEW | IS_MOVED );
733  m_wires.push_back( segment );
734 
735  m_selectionTool->AddItemToSel( segment, true /*quiet mode*/ );
736 
737  // We need 2 segments to go from a given start pin to an end point when the
738  // horizontal and vertical lines only switch is on.
740  {
741  segment = new SCH_LINE( *segment );
742  segment->SetFlags( IS_NEW | IS_MOVED );
743  m_wires.push_back( segment );
744 
745  m_selectionTool->AddItemToSel( segment, true /*quiet mode*/ );
746  }
747 
748  return segment;
749 }
750 
751 
766 {
767  for( auto it = m_wires.begin(); it != m_wires.end(); )
768  {
769  SCH_LINE* line = *it;
770 
771  if( line->IsNull() )
772  {
773  delete line;
774  it = m_wires.erase( it );
775  continue;
776  }
777 
778  auto next_it = it;
779  ++next_it;
780 
781  if( next_it == m_wires.end() )
782  break;
783 
784  SCH_LINE* next_line = *next_it;
785 
786  if( line->IsParallel( next_line ) )
787  {
788  if( SCH_LINE* merged = line->MergeOverlap( next_line ) )
789  {
790  delete line;
791  delete next_line;
792  it = m_wires.erase( it );
793  *it = merged;
794  }
795  }
796 
797  ++it;
798  }
799 }
800 
801 
803 {
804  // Clear selection when done so that a new wire can be started.
805  // NOTE: this must be done before simplifyWireList is called or we might end up with
806  // freed selected items.
808 
809  PICKED_ITEMS_LIST itemList;
810 
811  // Remove segments backtracking over others
813 
814  // Collect the possible connection points for the new lines
815  std::vector< wxPoint > connections;
816  std::vector< wxPoint > new_ends;
817  m_frame->GetSchematicConnections( connections );
818 
819  // Check each new segment for possible junctions and add/split if needed
820  for( auto wire : m_wires )
821  {
822  if( wire->HasFlag( SKIP_STRUCT ) )
823  continue;
824 
825  wire->GetConnectionPoints( new_ends );
826 
827  for( auto i : connections )
828  {
829  if( IsPointOnSegment( wire->GetStartPoint(), wire->GetEndPoint(), i ) )
830  new_ends.push_back( i );
831  }
832  itemList.PushItem( ITEM_PICKER( wire, UR_NEW ) );
833  }
834 
836  {
837  wxASSERT( m_busUnfold.entry && m_busUnfold.label );
838 
839  itemList.PushItem( ITEM_PICKER( m_busUnfold.entry, UR_NEW ) );
840  itemList.PushItem( ITEM_PICKER( m_busUnfold.label, UR_NEW ) );
842  }
843 
844  // Get the last non-null wire (this is the last created segment).
845  if( !m_wires.empty() )
847 
848  // Add the new wires
849  for( auto wire : m_wires )
850  {
851  wire->ClearFlags( IS_NEW | IS_MOVED );
852  m_frame->AddToScreen( wire );
853  }
854 
855  m_wires.clear();
856  m_view->ClearPreview();
857  m_view->ShowPreview( false );
858 
859  getViewControls()->CaptureCursor( false );
860  getViewControls()->SetAutoPan( false );
861 
862  m_frame->SaveCopyInUndoList( itemList, UR_NEW );
863 
864  // Correct and remove segments that need to be merged.
866 
867  for( auto item : m_frame->GetScreen()->Items().OfType( SCH_COMPONENT_T ) )
868  {
869  std::vector< wxPoint > pts;
870  item->GetConnectionPoints( pts );
871 
872  if( pts.size() > 2 )
873  continue;
874 
875  for( auto i = pts.begin(); i != pts.end(); i++ )
876  {
877  for( auto j = i + 1; j != pts.end(); j++ )
878  m_frame->TrimWire( *i, *j );
879  }
880  }
881 
882  for( auto i : new_ends )
883  {
884  if( m_frame->GetScreen()->IsJunctionNeeded( i, true ) )
885  m_frame->AddJunction( i, true, false );
886  }
887 
889  m_busUnfold = {};
890 
893 
894  m_frame->OnModify();
895 }
896 
897 
899 {
900  EE_SELECTION* aSelection = aEvent.Parameter<EE_SELECTION*>();
901 
902  std::vector<wxPoint> pts;
903  std::vector<wxPoint> connections;
904 
905  m_frame->GetSchematicConnections( connections );
906 
907  for( unsigned ii = 0; ii < aSelection->GetSize(); ii++ )
908  {
909  SCH_ITEM* item = dynamic_cast<SCH_ITEM*>( aSelection->GetItem( ii ) );
910  std::vector<wxPoint> new_pts;
911 
912  if( !item || !item->IsConnectable() )
913  continue;
914 
915  item->GetConnectionPoints( new_pts );
916  pts.insert( pts.end(), new_pts.begin(), new_pts.end() );
917 
918  // If the item is a line, we also add any connection points from the rest of the schematic
919  // that terminate on the line after it is moved.
920  if( item->Type() == SCH_LINE_T )
921  {
922  SCH_LINE* line = (SCH_LINE*) item;
923  for( auto i : connections )
924  {
925  if( IsPointOnSegment( line->GetStartPoint(), line->GetEndPoint(), i ) )
926  pts.push_back( i );
927  }
928  }
929  else
930  {
931  // Clean up any wires that short non-wire connections in the list
932  for( auto point = new_pts.begin(); point != new_pts.end(); point++ )
933  {
934  for( auto second_point = point + 1; second_point != new_pts.end(); second_point++ )
935  m_frame->TrimWire( *point, *second_point );
936  }
937  }
938  }
939 
940  // We always have some overlapping connection points. Drop duplicates here
941  std::sort( pts.begin(), pts.end(), []( const wxPoint& a, const wxPoint& b ) -> bool {
942  return a.x < b.x || ( a.x == b.x && a.y < b.y );
943  } );
944 
945  pts.erase( unique( pts.begin(), pts.end() ), pts.end() );
946 
947  for( auto point : pts )
948  {
949  if( m_frame->GetScreen()->IsJunctionNeeded( point, true ) )
950  m_frame->AddJunction( point, true, false );
951  }
952 
953  return 0;
954 }
955 
956 
958 {
963 
965 }
static wxString PrintBusForUI(const wxString &aString)
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
SCH_LINE * MergeOverlap(SCH_LINE *aLine)
Check line against aLine to see if it overlaps and merge if it does.
Definition: sch_line.cpp:366
void AddMenu(ACTION_MENU *aMenu, const SELECTION_CONDITION &aCondition=SELECTION_CONDITIONS::ShowAlways, int aOrder=ANY_ORDER)
Function AddMenu()
bool SchematicCleanUp(SCH_SCREEN *aScreen=nullptr)
Performs routine schematic cleaning including breaking wire and buses and deleting identical objects ...
bool IsCurrentTool(const TOOL_ACTION &aAction) const
TOOL_MENU m_menu
functions below are not yet implemented - their interface may change
virtual bool IsConnectable() const
Definition: sch_item.h:369
void AddToPreview(EDA_ITEM *aItem, bool aTakeOwnership=true)
Definition: sch_view.cpp:195
static bool IsDrawingWire(const SELECTION &aSelection)
void simplifyWireList()
Iterates over the wire list and removes the null segments and overlapping segments to create a simpli...
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
static TOOL_ACTION breakBus
Definition: ee_actions.h:134
void GetSchematicConnections(std::vector< wxPoint > &aConnections)
Collects a unique list of all possible connection points in the schematic.
void RecalculateConnections(SCH_CLEANUP_FLAGS aCleanupFlags)
Generates the connection data for the entire schematic hierarchy.
wxPoint GetStartPoint() const
Definition: sch_line.h:94
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,...
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...
ACTION_MENU.
Definition: action_menu.h:44
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:372
const BITMAP_OPAQUE add_line2bus_xpm[1]
static SELECTION_CONDITION MoreThan(int aNumber)
Function MoreThan Creates a functor that tests if the number of selected items is greater than the va...
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.
VIEW_CONTROLS class definition.
SCH_LINE * doUnfoldBus(const wxString &aNet)
std::vector< SCH_LINE * > m_wires
Storage for the line segments while drawing.
bool HasPoint()
Indicates the cursor is over an edit point.
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
int AddJunctionsIfNeeded(const TOOL_EVENT &aEvent)
Handle the addition of junctions to a selection of objects.
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
bool IsParallel(SCH_LINE *aLine)
Definition: sch_line.cpp:353
const wxPoint GetPosition() const override
static TOOL_ACTION placeHierLabel
Definition: ee_actions.h:87
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:219
static TOOL_ACTION placeJunction
Definition: ee_actions.h:83
static TOOL_ACTION selectConnection
If current selection is a wire or bus, expand to entire connection.
Definition: ee_actions.h:53
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
EE_TYPE Overlapping(const EDA_RECT &aRect)
Definition: sch_rtree.h:224
virtual void PushTool(const std::string &actionName)
NB: the definition of "tool" is different at the user level.
void SetPosition(const wxPoint &aPosition) override
Set the schematic item position to aPosition.
SCH_LINE * startSegments(int aType, const VECTOR2D &aPos)
static TOOL_ACTION unfoldBus
Definition: ee_actions.h:81
static TOOL_ACTION finishLineWireOrBus
Definition: ee_actions.h:94
virtual void GetConnectionPoints(std::vector< wxPoint > &aPoints) const
Add all the connection points for this item to aPoints.
Definition: sch_item.h:378
TOOL_MENU & GetToolMenu()
bool IsPointOnSegment(const wxPoint &aSegStart, const wxPoint &aSegEnd, const wxPoint &aTestPoint)
Test if aTestPoint is on line defined by aSegStart and aSegEnd.
Definition: trigo.cpp:42
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
static bool IsDrawingLine(const SELECTION &aSelection)
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
SHEET_SIDE GetEdge() const
Schematic editor (Eeschema) main window.
bool TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
void RemoveFromScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen=nullptr)
Remove an item from the screen (and view) aScreen is the screen the item is located on,...
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:237
static SELECTION_CONDITION Idle
void SetContextMenu(ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
Function SetContextMenu()
void update() override
Update menu state stub.
void setTransitions() override
Sets up handlers for various events.
int UnfoldBus(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()
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:206
virtual void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:196
static TOOL_ACTION breakWire
Definition: ee_actions.h:133
static TOOL_ACTION finishLine
Definition: ee_actions.h:97
void SetEndPoint(const wxPoint &aPosition)
Definition: sch_line.h:98
void SetTool(TOOL_INTERACTIVE *aTool)
Function SetTool() Sets a tool that is the creator of the menu.
bool IsNew() const
Definition: base_struct.h:199
const SCH_SHEET_PIN * getSheetPin(const wxPoint &aPosition)
Searches for a sheet pin at a location.
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
static TOOL_ACTION leaveSheet
Definition: ee_actions.h:176
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:117
EESCHEMA_SETTINGS * eeconfig() const
EE_SELECTION & RequestSelection(const KICAD_T *aFilterList=EE_COLLECTOR::AllItems)
Function RequestSelection()
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
Function WarpCursor() If enabled (.
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_text.cpp:763
wxPoint origin
Origin (on the bus) of the unfold.
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
int doDrawSegments(const std::string &aTool, int aType)
static TOOL_ACTION drawWire
Definition: ee_actions.h:79
const wxPoint GetPosition() const override
Definition: sch_text.h:313
virtual void PopTool(const std::string &actionName)
virtual void CaptureCursor(bool aEnabled)
Function CaptureCursor() Forces the cursor to stay within the drawing panel area.
bool IsNull() const
Definition: sch_line.h:92
void ShowPreview(bool aShow=true)
Definition: sch_view.cpp:209
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:435
void SetStartPoint(const wxPoint &aPosition)
Definition: sch_line.h:95
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetIcon(const BITMAP_OPAQUE *aIcon)
Function SetIcon() Assigns an icon for the entry.
Definition: action_menu.cpp:70
TOOL_EVENT.
Definition: tool_event.h:171
void SaveCopyInUndoList(SCH_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand, bool aAppend=false, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
void ClearPreview()
Definition: sch_view.cpp:183
SCHEMATIC & Schematic() const
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)
EE_SELECTION_TOOL * m_selectionTool
Definition: ee_tool_base.h:153
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:262
SCH_LAYER_ID
Eeschema drawing layers.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
static TOOL_ACTION clearSelection
Clears the current selection.
Definition: ee_actions.h:56
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.
wxPoint m_End() const
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
static TOOL_ACTION addNeededJunctions
Definition: ee_actions.h:75
wxString net_name
Net label for the unfolding operation.
virtual KIGFX::VIEW_ITEM * GetItem(unsigned int aIdx) const override
Definition: selection.h:105
void computeBreakPoint(const std::pair< SCH_LINE *, SCH_LINE * > &aSegments, wxPoint &aPosition)
Function ComputeBreakPoint computes the middle coordinate for 2 segments from the start point to aPos...
TOOL_INTERACTIVE * m_tool
Creator of the menu
Definition: action_menu.h:228
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.
SCH_BUS_WIRE_ENTRY * entry
SCH_CONNECTION * Connection(const SCH_SHEET_PATH &aPath) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:147
static bool IsDrawingBus(const SELECTION &aSelection)
static TOOL_ACTION drawBus
Definition: ee_actions.h:80
bool offset
True if the bus entry should be offset from origin.
virtual unsigned int GetSize() const override
Function GetSize() Returns the number of stored items.
Definition: selection.h:100
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:342
static bool m_allowRealTime
static TOOL_ACTION placeLabel
Definition: ee_actions.h:85
int RemoveItemFromSel(const TOOL_EVENT &aEvent)
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:463
static bool IsDrawingLineWireOrBus(const SELECTION &aSelection)
TOOLS_HOLDER * GetToolHolder() const
Definition: tool_manager.h:295
wxSize GetSize() const
Definition: sch_bus_entry.h:71
SCH_SHEET & Root() const
Definition: schematic.h:97
bool IsTerminalPoint(const wxPoint &aPosition, int aLayer)
Test if aPosition is a connection point on aLayer.
Definition: sch_screen.cpp:456
void SetTitle(const wxString &aTitle) override
Function SetTitle() Sets title for the menu.
Definition: action_menu.cpp:88
Board layer functions and definitions.
int AddItemToSel(const TOOL_EVENT &aEvent)
const char * name
Definition: DXF_plotter.cpp:60
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
void RefreshItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
#define _(s)
Definition: 3d_actions.cpp:33
ACTION_MENU * create() const override
Returns an instance of this class. It has to be overridden in inheriting classes.
EE_POINT_EDITOR.
TOOL_MANAGER * getToolManager() const
Returns an instance of TOOL_MANAGER class.
void AddSubMenu(std::shared_ptr< ACTION_MENU > aSubMenu)
Function CreateSubMenu.
Definition: tool_menu.cpp:52
EE_RTREE & Items()
Definition: sch_screen.h:162
static SELECTION_CONDITION OnlyType(KICAD_T aType)
Function OnlyType Creates a functor that tests if the selected items are only of given type.
void VetoContextMenuMouseWarp()
Disables mouse warping after the current context menu is closed.
Definition: tool_manager.h:408
void Clear()
Function Clear() Removes all the entries from the menu (as well as its title).
static TOOL_ACTION selectNode
Select the junction, wire or bus segment under the cursor.
Definition: ee_actions.h:49
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
These settings were stored in SCH_BASE_FRAME previously.
boost::optional< T > OPT
Definition: optional.h:7
std::vector< std::shared_ptr< SCH_CONNECTION > > & Members()
Class for a wire to bus entry.
void Activate()
Function Activate() Runs the tool.
SCH_SHEET_PATH & GetCurrentSheet() const
bool TrimWire(const wxPoint &aStart, const wxPoint &aEnd)
If any single wire passes through both points, remove the portion between the two points,...
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers of advanced config.
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
static TOOL_ACTION drawLines
Definition: ee_actions.h:92
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current screen and u...
bool label_placed
True if user has placed the net label.
ACTION_MENU(bool isContextMenu)
Default constructor
Definition: action_menu.cpp:45
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:42
virtual void SetLabelSpinStyle(LABEL_SPIN_STYLE aSpinStyle)
Set a spin or rotation angle, along with specific horizontal and vertical justification styles with e...
Definition: sch_text.cpp:233
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
bool IsBus() const
static TOOL_ACTION placeGlobalLabel
Definition: ee_actions.h:86
BASE_SCREEN class implementation.
void ClearEditFlags()
Definition: base_struct.h:251
static TOOL_ACTION finishBus
Definition: ee_actions.h:96
void SetPosition(const wxPoint &aPosition) override
Set the schematic item position to aPosition.
Definition: sch_text.h:314
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:268
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Function AddItem()
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:186
void ShowContextMenu(SELECTION &aSelection)
Function ShowContextMenu.
Definition: tool_menu.cpp:59
int DrawSegments(const TOOL_EVENT &aEvent)
static TOOL_ACTION finishWire
Definition: ee_actions.h:95
BUS_UNFOLDING_T m_busUnfold
Data related to bus unfolding tool.
static TOOL_ACTION refreshPreview
Definition: actions.h:101
This item represents a bus vector.
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
EDA_ITEM * Front() const
Definition: selection.h:184
bool in_progress
True if bus unfold operation is running.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193
#define IS_MOVED
Item being moved.
Definition: base_struct.h:116
wxPoint GetEndPoint() const
Definition: sch_line.h:97