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 <wx/debug.h>
28 #include <wx/gdicmn.h>
29 #include <wx/string.h>
30 #include <wx/stringimpl.h>
31 #include <wx/translation.h>
32 #include <algorithm>
33 #include <cstdlib>
34 #include <iterator>
35 #include <memory>
36 #include <utility>
37 #include <vector>
38 
39 #include <base_struct.h>
40 #include <bitmaps.h>
41 #include <core/typeinfo.h>
43 #include <math/vector2d.h>
44 #include <advanced_config.h>
45 #include <tool/actions.h>
46 #include <tool/conditional_menu.h>
47 #include <tool/selection.h>
49 #include <tool/tool_event.h>
50 #include <trigo.h>
51 #include <undo_redo_container.h>
52 
53 #include <connection_graph.h>
54 #include <eeschema_id.h>
55 #include <sch_bus_entry.h>
56 #include <sch_connection.h>
57 #include <sch_edit_frame.h>
58 #include <sch_item.h>
59 #include <sch_line.h>
60 #include <sch_screen.h>
61 #include <sch_sheet.h>
62 #include <sch_text.h>
63 #include <schematic.h>
64 
65 #include <ee_actions.h>
66 #include <ee_grid_helper.h>
67 #include <ee_point_editor.h>
68 #include <ee_selection.h>
69 #include <ee_selection_tool.h>
70 
72 {
73 public:
75  ACTION_MENU( true ),
76  m_showTitle( false )
77  {
79  SetTitle( _( "Unfold from Bus" ) );
80  }
81 
82  void SetShowTitle()
83  {
84  m_showTitle = true;
85  }
86 
87 
88 protected:
89  ACTION_MENU* create() const override
90  {
91  return new BUS_UNFOLD_MENU();
92  }
93 
94 private:
95  void update() override
96  {
99  KICAD_T busType[] = { SCH_LINE_LOCATE_BUS_T, EOT };
100  EE_SELECTION& selection = selTool->RequestSelection( busType );
101  SCH_LINE* bus = (SCH_LINE*) selection.Front();
102 
103  Clear();
104 
105  // TODO(JE) remove once real-time is enabled
106  if( !ADVANCED_CFG::GetCfg().m_realTimeConnectivity || !CONNECTION_GRAPH::m_allowRealTime )
107  {
109 
110  // Pick up the pointer again because it may have been changed by SchematicCleanUp
111  selection = selTool->RequestSelection( busType );
112  bus = (SCH_LINE*) selection.Front();
113  }
114 
115  if( !bus )
116  {
117  Append( ID_POPUP_SCH_UNFOLD_BUS, _( "No bus selected" ), wxEmptyString );
118  Enable( ID_POPUP_SCH_UNFOLD_BUS, false );
119  return;
120  }
121 
122  SCH_CONNECTION* connection = bus->Connection( frame->GetCurrentSheet() );
123 
124  if( !connection || !connection->IsBus() || connection->Members().empty() )
125  {
126  Append( ID_POPUP_SCH_UNFOLD_BUS, _( "Bus has no members" ), wxEmptyString );
127  Enable( ID_POPUP_SCH_UNFOLD_BUS, false );
128  return;
129  }
130 
131  int idx = 0;
132 
133  if( m_showTitle )
134  {
135  Append( ID_POPUP_SCH_UNFOLD_BUS, _( "Unfold from Bus" ), wxEmptyString );
136  Enable( ID_POPUP_SCH_UNFOLD_BUS, false );
137  }
138 
139  for( const auto& member : connection->Members() )
140  {
141  int id = ID_POPUP_SCH_UNFOLD_BUS + ( idx++ );
142  wxString name = SCH_CONNECTION::PrintBusForUI( member->FullLocalName() );
143 
144  if( member->Type() == CONNECTION_TYPE::BUS )
145  {
146  ACTION_MENU* submenu = new ACTION_MENU( true );
147  submenu->SetTool( m_tool );
148  AppendSubMenu( submenu, name );
149 
150  for( const auto& sub_member : member->Members() )
151  {
152  id = ID_POPUP_SCH_UNFOLD_BUS + ( idx++ );
153  name = SCH_CONNECTION::PrintBusForUI( sub_member->FullLocalName() );
154  submenu->Append( id, name, wxEmptyString );
155  }
156  }
157  else
158  {
159  Append( id, name, wxEmptyString );
160  }
161  }
162  }
163 
165 };
166 
167 
169  EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.InteractiveDrawingLineWireBus" )
170 {
171  m_busUnfold = {};
172  m_wires.reserve( 16 );
173 }
174 
175 
177 {
178 }
179 
180 
182 {
184 
185  auto wireOrBusTool = [ this ] ( const SELECTION& aSel ) {
188  };
189 
190  auto lineTool = [ this ] ( const SELECTION& aSel ) {
192  };
193 
194  auto belowRootSheetCondition =
195  [&]( const SELECTION& aSel )
196  {
197  return m_frame->GetCurrentSheet().Last() != &m_frame->Schematic().Root();
198  };
199 
200  auto busSelection = EE_CONDITIONS::MoreThan( 0 )
202 
203  auto& ctxMenu = m_menu.GetMenu();
204 
205  // Build the tool menu
206  //
207  ctxMenu.AddItem( EE_ACTIONS::leaveSheet, belowRootSheetCondition, 2 );
208 
209  ctxMenu.AddSeparator( 10 );
210  ctxMenu.AddItem( EE_ACTIONS::drawWire, wireOrBusTool && EE_CONDITIONS::Idle, 10 );
211  ctxMenu.AddItem( EE_ACTIONS::drawBus, wireOrBusTool && EE_CONDITIONS::Idle, 10 );
212  ctxMenu.AddItem( EE_ACTIONS::drawLines, lineTool && EE_CONDITIONS::Idle, 10 );
213  ctxMenu.AddItem( EE_ACTIONS::finishWire, IsDrawingWire, 10 );
214  ctxMenu.AddItem( EE_ACTIONS::finishBus, IsDrawingBus, 10 );
215  ctxMenu.AddItem( EE_ACTIONS::finishLine, IsDrawingLine, 10 );
216 
217  std::shared_ptr<BUS_UNFOLD_MENU> busUnfoldMenu = std::make_shared<BUS_UNFOLD_MENU>();
218  busUnfoldMenu->SetTool( this );
219  m_menu.AddSubMenu( busUnfoldMenu );
220  ctxMenu.AddMenu( busUnfoldMenu.get(), EE_CONDITIONS::Idle, 10 );
221 
222  ctxMenu.AddSeparator( 100 );
223  ctxMenu.AddItem( EE_ACTIONS::placeJunction, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
224  ctxMenu.AddItem( EE_ACTIONS::placeLabel, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
225  ctxMenu.AddItem( EE_ACTIONS::placeGlobalLabel, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
226  ctxMenu.AddItem( EE_ACTIONS::placeHierLabel, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
227  ctxMenu.AddItem( EE_ACTIONS::breakWire, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
228  ctxMenu.AddItem( EE_ACTIONS::breakBus, wireOrBusTool && EE_CONDITIONS::Idle, 100 );
229 
230  ctxMenu.AddSeparator( 200 );
231  ctxMenu.AddItem( EE_ACTIONS::selectNode, wireOrBusTool && EE_CONDITIONS::Idle, 200 );
232  ctxMenu.AddItem( EE_ACTIONS::selectConnection, wireOrBusTool && EE_CONDITIONS::Idle, 200 );
233 
234  // Add bus unfolding to the selection tool
235  //
237 
238  std::shared_ptr<BUS_UNFOLD_MENU> selBusUnfoldMenu = std::make_shared<BUS_UNFOLD_MENU>();
239  selBusUnfoldMenu->SetTool( m_selectionTool );
240  m_selectionTool->GetToolMenu().AddSubMenu( selBusUnfoldMenu );
241  selToolMenu.AddMenu( selBusUnfoldMenu.get(), busSelection && EE_CONDITIONS::Idle, 100 );
242 
243  return true;
244 }
245 
246 
248 {
249  static KICAD_T graphicLineType[] = { SCH_LINE_LOCATE_GRAPHIC_LINE_T, EOT };
250  return IsDrawingLineWireOrBus( aSelection ) && aSelection.Front()->IsType( graphicLineType );
251 }
252 
253 
255 {
256  static KICAD_T wireType[] = { SCH_LINE_LOCATE_WIRE_T, EOT };
257  return IsDrawingLineWireOrBus( aSelection ) && aSelection.Front()->IsType( wireType );
258 }
259 
260 
262 {
263  static KICAD_T busType[] = { SCH_LINE_LOCATE_BUS_T, EOT };
264  return IsDrawingLineWireOrBus( aSelection ) && aSelection.Front()->IsType( busType );
265 }
266 
267 
269 {
270  // NOTE: for immediate hotkeys, it is NOT required that the line, wire or bus tool
271  // be selected
272  SCH_ITEM* item = (SCH_ITEM*) aSelection.Front();
273  return item && item->IsNew() && item->Type() == SCH_LINE_T;
274 }
275 
276 
278 {
279  SCH_LAYER_ID layer = aEvent.Parameter<SCH_LAYER_ID>();
280 
281  if( aEvent.HasPosition() )
282  getViewControls()->WarpCursor( aEvent.Position(), true );
283 
284  std::string tool = aEvent.GetCommandStr().get();
285  m_frame->PushTool( tool );
286 
287  if( aEvent.HasPosition() )
288  {
289  VECTOR2D cursorPos = getViewControls()->GetCursorPosition( !aEvent.Modifier( MD_ALT ) );
290  startSegments( layer, cursorPos );
291  }
292 
293  return doDrawSegments( tool, layer );
294 }
295 
296 
298 {
299  wxString* netPtr = aEvent.Parameter<wxString*>();
300  wxString net;
301  SCH_LINE* segment = nullptr;
302 
303  std::string tool = aEvent.GetCommandStr().get();
304  m_frame->PushTool( tool );
305  Activate();
306 
307  if( netPtr )
308  {
309  net = *netPtr;
310  delete netPtr;
311  }
312  else
313  {
314  BUS_UNFOLD_MENU unfoldMenu;
315  unfoldMenu.SetTool( this );
316  unfoldMenu.SetShowTitle();
317 
318  SetContextMenu( &unfoldMenu, CMENU_NOW );
319 
320  while( TOOL_EVENT* evt = Wait() )
321  {
322  if( evt->Action() == TA_CHOICE_MENU_CHOICE )
323  {
324  OPT<int> id = evt->GetCommandId();
325 
326  if( id && ( *id > 0 ) )
327  net = *evt->Parameter<wxString*>();
328 
329  break;
330  }
331  else if( evt->Action() == TA_CHOICE_MENU_CLOSED )
332  {
333  break;
334  }
335  else
336  {
337  evt->SetPassEvent();
338  }
339  }
340  }
341 
342  // Break a wire for the given net out of the bus
343  if( !net.IsEmpty() )
344  segment = doUnfoldBus( net );
345 
346  // If we have an unfolded wire to draw, then draw it
347  if( segment )
348  return doDrawSegments( tool, LAYER_WIRE );
349  else
350  {
351  m_frame->PopTool( tool );
352  return 0;
353  }
354 }
355 
356 
358 {
359  SCHEMATIC_SETTINGS& cfg = getModel<SCHEMATIC>()->Settings();
361 
363 
364  m_busUnfold.entry = new SCH_BUS_WIRE_ENTRY( pos );
367 
373 
374  m_busUnfold.in_progress = true;
375  m_busUnfold.origin = pos;
376  m_busUnfold.net_name = aNet;
377 
379 
381 }
382 
383 
385 {
386  SCH_SCREEN* screen = m_frame->GetScreen();
387 
388  for( auto item : screen->Items().Overlapping( SCH_SHEET_T, aPosition ) )
389  {
390  auto sheet = static_cast<SCH_SHEET*>( item );
391 
392  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
393  {
394  if( pin->GetPosition() == aPosition )
395  return pin;
396  }
397  }
398 
399  return nullptr;
400 }
401 
402 
403 void SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint( const std::pair<SCH_LINE*, SCH_LINE*>& aSegments,
404  wxPoint& aPosition )
405 {
406  wxCHECK_RET( aSegments.first && aSegments.second,
407  wxT( "Cannot compute break point of NULL line segment." ) );
408 
409  SCH_LINE* segment = aSegments.first;
410  SCH_LINE* next_segment = aSegments.second;
411 
412  wxPoint midPoint;
413  int iDx = segment->GetEndPoint().x - segment->GetStartPoint().x;
414  int iDy = segment->GetEndPoint().y - segment->GetStartPoint().y;
415 
416  const SCH_SHEET_PIN* connectedPin = getSheetPin( segment->GetStartPoint() );
417  auto force = connectedPin ? connectedPin->GetEdge() : SHEET_UNDEFINED_SIDE;
418 
419  if( force == SHEET_LEFT_SIDE || force == SHEET_RIGHT_SIDE )
420  {
421  if( aPosition.x == connectedPin->GetPosition().x ) // push outside sheet boundary
422  {
423  int direction = ( force == SHEET_LEFT_SIDE ) ? -1 : 1;
424  aPosition.x += KiROUND( getView()->GetGAL()->GetGridSize().x * direction );
425  }
426 
427  midPoint.x = aPosition.x;
428  midPoint.y = segment->GetStartPoint().y; // force horizontal
429  }
430  else if( iDy != 0 ) // keep the first segment orientation (vertical)
431  {
432  midPoint.x = segment->GetStartPoint().x;
433  midPoint.y = aPosition.y;
434  }
435  else if( iDx != 0 ) // keep the first segment orientation (horizontal)
436  {
437  midPoint.x = aPosition.x;
438  midPoint.y = segment->GetStartPoint().y;
439  }
440  else
441  {
442  if( std::abs( aPosition.x - segment->GetStartPoint().x ) <
443  std::abs( aPosition.y - segment->GetStartPoint().y ) )
444  {
445  midPoint.x = segment->GetStartPoint().x;
446  midPoint.y = aPosition.y;
447  }
448  else
449  {
450  midPoint.x = aPosition.x;
451  midPoint.y = segment->GetStartPoint().y;
452  }
453  }
454 
455  segment->SetEndPoint( midPoint );
456  next_segment->SetStartPoint( midPoint );
457  next_segment->SetEndPoint( aPosition );
458 }
459 
460 
461 int SCH_LINE_WIRE_BUS_TOOL::doDrawSegments( const std::string& aTool, int aType )
462 {
463  SCH_SCREEN* screen = m_frame->GetScreen();
465  SCH_LINE* segment = nullptr;
466  EE_GRID_HELPER grid( m_toolMgr );
467 
469 
471  controls->ShowCursor( true );
472 
473 
474  Activate();
475 
476  // Add the new label to the selection so the rotate command operates on it
477  if( m_busUnfold.label )
479 
480  // Continue the existing wires if we've started (usually by immediate action preference)
481  if( !m_wires.empty() )
482  segment = m_wires.back();
483 
484  // Main loop: keep receiving events
485  while( TOOL_EVENT* evt = Wait() )
486  {
487  if( !pointEditor->HasPoint() ) // Set wxCursor shape when starting the tool
488  m_frame->GetCanvas()->SetCurrentCursor( wxCURSOR_PENCIL );
489 
490  grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
491  wxPoint cursorPos = wxPoint( grid.BestSnapAnchor(
492  evt->IsPrime() ? evt->Position() : controls->GetMousePosition(), nullptr ) );
493  controls->ForceCursorPosition( true, cursorPos );
494 
495  bool forceHV = m_frame->eeconfig()->m_Drawing.hv_lines_only;
496 
497  //------------------------------------------------------------------------
498  // Handle cancel:
499  //
500  auto cleanup = [&] () {
502 
503  for( auto wire : m_wires )
504  delete wire;
505 
506  m_wires.clear();
507  segment = nullptr;
508 
509  if( m_busUnfold.entry )
511 
514 
517 
518  delete m_busUnfold.entry;
519  delete m_busUnfold.label;
520  m_busUnfold = {};
521 
522  m_view->ClearPreview();
523  m_view->ShowPreview( false );
524  };
525 
526  if( evt->IsCancelInteractive() )
527  {
528  if( segment || m_busUnfold.in_progress )
529  cleanup();
530  else
531  {
532  m_frame->PopTool( aTool );
533  break;
534  }
535  }
536  else if( evt->IsActivate() )
537  {
538  if( segment || m_busUnfold.in_progress )
539  cleanup();
540 
541  if( evt->IsMoveTool() )
542  {
543  // leave ourselves on the stack so we come back after the move
544  break;
545  }
546  else
547  {
548  m_frame->PopTool( aTool );
549  break;
550  }
551  }
552  //------------------------------------------------------------------------
553  // Handle finish:
554  //
555  else if( evt->IsAction( &EE_ACTIONS::finishLineWireOrBus )
556  || evt->IsAction( &EE_ACTIONS::finishWire )
557  || evt->IsAction( &EE_ACTIONS::finishBus )
558  || evt->IsAction( &EE_ACTIONS::finishLine ) )
559  {
560  if( segment || m_busUnfold.in_progress )
561  {
562  finishSegments();
563  segment = nullptr;
564  }
565  }
566  //------------------------------------------------------------------------
567  // Handle click:
568  //
569  else if( evt->IsClick( BUT_LEFT ) || ( segment && evt->IsDblClick( BUT_LEFT ) ) )
570  {
571  // First click when unfolding places the label and wire-to-bus entry
573  {
574  wxASSERT( aType == LAYER_WIRE );
575 
576  m_frame->AddToScreen( m_busUnfold.label, screen );
578  m_busUnfold.label_placed = true;
579  }
580 
581  if( !segment )
582  {
583  segment = startSegments( aType, VECTOR2D( cursorPos ) );
584  }
585  // Create a new segment if we're out of previously-created ones
586  else if( !segment->IsNull() || ( forceHV && !m_wires[ m_wires.size() - 2 ]->IsNull() ) )
587  {
588  // Terminate the command if the end point is on a pin, junction, or another
589  // wire or bus.
591  && screen->IsTerminalPoint( cursorPos, segment->GetLayer() ) )
592  {
593  finishSegments();
594  segment = nullptr;
595  }
596  else
597  {
598  segment->SetEndPoint( cursorPos );
599 
600  // Create a new segment, and chain it after the current segment.
601  segment = new SCH_LINE( *segment );
602  segment->SetFlags( IS_NEW | IS_MOVED );
603  segment->SetStartPoint( cursorPos );
604  m_wires.push_back( segment );
605 
606  m_selectionTool->AddItemToSel( segment, true /*quiet mode*/ );
607  }
608  }
609 
610  if( evt->IsDblClick( BUT_LEFT ) && segment )
611  {
612  if( forceHV && m_wires.size() >= 2 )
613  computeBreakPoint( { m_wires[ m_wires.size() - 2 ], segment }, cursorPos );
614 
615  finishSegments();
616  segment = nullptr;
617  }
618  }
619  //------------------------------------------------------------------------
620  // Handle motion:
621  //
622  else if( evt->IsMotion() || evt->IsAction( &ACTIONS::refreshPreview ) )
623  {
624  m_view->ClearPreview();
625 
626  // Update the bus unfold posture based on the mouse movement
628  {
629  wxPoint cursor_delta = cursorPos - m_busUnfold.origin;
631 
632  bool flipX = ( cursor_delta.x < 0 );
633  bool flipY = ( cursor_delta.y < 0 );
634 
635  // Erase and redraw if necessary
636  if( flipX != m_busUnfold.flipX || flipY != m_busUnfold.flipY )
637  {
638  wxSize size = entry->GetSize();
639  int ySign = flipY ? -1 : 1;
640  int xSign = flipX ? -1 : 1;
641 
642  size.x = std::abs( size.x ) * xSign;
643  size.y = std::abs( size.y ) * ySign;
644  entry->SetSize( size );
645 
646  m_busUnfold.flipY = flipY;
647  m_busUnfold.flipX = flipX;
648 
649  m_frame->UpdateItem( entry );
650  m_wires.front()->SetStartPoint( entry->GetEnd() );
651  }
652 
653  // Update the label "ghost" position
654  m_busUnfold.label->SetPosition( cursorPos );
656 
657  // Ensure segment is non-null at the start of bus unfold
658  if( !segment )
659  segment = m_wires.back();
660  }
661 
662  if( segment )
663  {
664  // Coerce the line to vertical or horizontal if necessary
665  if( forceHV && m_wires.size() >= 2 )
666  computeBreakPoint( { m_wires[ m_wires.size() - 2 ], segment }, cursorPos );
667  else
668  segment->SetEndPoint( cursorPos );
669  }
670 
671  for( auto wire : m_wires )
672  {
673  if( !wire->IsNull() )
674  m_view->AddToPreview( wire->Clone() );
675  }
676  }
677  //------------------------------------------------------------------------
678  // Handle context menu:
679  //
680  else if( evt->IsClick( BUT_RIGHT ) )
681  {
682  // Warp after context menu only if dragging...
683  if( !segment )
685 
687  }
688  else if( evt->Category() == TC_COMMAND && evt->Action() == TA_CHOICE_MENU_CHOICE )
689  {
690  if( evt->GetCommandId().get() >= ID_POPUP_SCH_UNFOLD_BUS
691  && evt->GetCommandId().get() <= ID_POPUP_SCH_UNFOLD_BUS_END )
692  {
693  wxASSERT_MSG( !segment, "Bus unfold event received when already drawing!" );
694 
695  aType = LAYER_WIRE;
696  wxString net = *evt->Parameter<wxString*>();
697  segment = doUnfoldBus( net );
698  }
699  }
700  else
701  evt->SetPassEvent();
702 
703  // Enable autopanning and cursor capture only when there is a segment to be placed
704  controls->SetAutoPan( segment != nullptr );
705  controls->CaptureCursor( segment != nullptr );
706  }
707 
708  controls->ForceCursorPosition( false );
709  return 0;
710 }
711 
712 
714 {
715  SCH_LINE* segment = nullptr;
716 
717  switch ( aType )
718  {
719  default:
720  segment = new SCH_LINE( aPos, LAYER_NOTES );
721  break;
722  case LAYER_WIRE:
723  segment = new SCH_LINE( aPos, LAYER_WIRE );
724  break;
725  case LAYER_BUS:
726  segment = new SCH_LINE( aPos, LAYER_BUS );
727  break;
728  }
729 
730  // Give segments a parent so they find the default line/wire/bus widths
731  segment->SetParent( &m_frame->Schematic() );
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  SCH_SCREEN* screen = m_frame->GetScreen();
810  PICKED_ITEMS_LIST itemList;
811 
812  // Remove segments backtracking over others
814 
815  // Collect the possible connection points for the new lines
816  std::vector< wxPoint > connections = m_frame->GetSchematicConnections();
817  std::vector< wxPoint > new_ends;
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  std::vector<wxPoint> tmpends = wire->GetConnectionPoints();
826 
827  new_ends.insert( new_ends.end(), tmpends.begin(), tmpends.end() );
828 
829  for( auto i : connections )
830  {
831  if( IsPointOnSegment( wire->GetStartPoint(), wire->GetEndPoint(), i ) )
832  new_ends.push_back( i );
833  }
834  itemList.PushItem( ITEM_PICKER( screen, wire, UNDO_REDO::NEWITEM ) );
835  }
836 
838  {
839  wxASSERT( m_busUnfold.entry && m_busUnfold.label );
840 
841  itemList.PushItem( ITEM_PICKER( screen, m_busUnfold.entry, UNDO_REDO::NEWITEM ) );
842  itemList.PushItem( ITEM_PICKER( screen, m_busUnfold.label, UNDO_REDO::NEWITEM ) );
844  }
845 
846  // Get the last non-null wire (this is the last created segment).
847  if( !m_wires.empty() )
849 
850  // Add the new wires
851  for( auto wire : m_wires )
852  {
853  wire->ClearFlags( IS_NEW | IS_MOVED );
854  m_frame->AddToScreen( wire, screen );
855  }
856 
857  m_wires.clear();
858  m_view->ClearPreview();
859  m_view->ShowPreview( false );
860 
861  getViewControls()->CaptureCursor( false );
862  getViewControls()->SetAutoPan( false );
863 
864  m_frame->SaveCopyInUndoList( itemList, UNDO_REDO::NEWITEM, false );
865 
866  // Correct and remove segments that need to be merged.
868 
869  for( auto item : m_frame->GetScreen()->Items().OfType( SCH_COMPONENT_T ) )
870  {
871  std::vector< wxPoint > pts = item->GetConnectionPoints();
872 
873  if( pts.size() > 2 )
874  continue;
875 
876  for( auto i = pts.begin(); i != pts.end(); i++ )
877  {
878  for( auto j = i + 1; j != pts.end(); j++ )
879  m_frame->TrimWire( *i, *j );
880  }
881  }
882 
883  for( auto i : new_ends )
884  {
885  if( m_frame->GetScreen()->IsJunctionNeeded( i, true ) )
886  m_frame->AddJunction( m_frame->GetScreen(), i, true, false );
887  }
888 
890  m_busUnfold = {};
891 
894 
895  m_frame->OnModify();
896 }
897 
898 
900 {
901  EE_SELECTION* aSelection = aEvent.Parameter<EE_SELECTION*>();
902 
903  std::vector<wxPoint> pts;
904  std::vector<wxPoint> connections = m_frame->GetSchematicConnections();
905 
906  for( unsigned ii = 0; ii < aSelection->GetSize(); ii++ )
907  {
908  SCH_ITEM* item = dynamic_cast<SCH_ITEM*>( aSelection->GetItem( ii ) );
909 
910  if( !item || !item->IsConnectable() )
911  continue;
912 
913  std::vector<wxPoint> new_pts = item->GetConnectionPoints();
914  pts.insert( pts.end(), new_pts.begin(), new_pts.end() );
915 
916  // If the item is a line, we also add any connection points from the rest of the schematic
917  // that terminate on the line after it is moved.
918  if( item->Type() == SCH_LINE_T )
919  {
920  SCH_LINE* line = (SCH_LINE*) item;
921  for( auto i : connections )
922  {
923  if( IsPointOnSegment( line->GetStartPoint(), line->GetEndPoint(), i ) )
924  pts.push_back( i );
925  }
926  }
927  else
928  {
929  // Clean up any wires that short non-wire connections in the list
930  for( auto point = new_pts.begin(); point != new_pts.end(); point++ )
931  {
932  for( auto second_point = point + 1; second_point != new_pts.end(); second_point++ )
933  m_frame->TrimWire( *point, *second_point );
934  }
935  }
936  }
937 
938  // We always have some overlapping connection points. Drop duplicates here
939  std::sort( pts.begin(), pts.end(), []( const wxPoint& a, const wxPoint& b ) -> bool {
940  return a.x < b.x || ( a.x == b.x && a.y < b.y );
941  } );
942 
943  pts.erase( unique( pts.begin(), pts.end() ), pts.end() );
944 
945  for( auto point : pts )
946  {
947  if( m_frame->GetScreen()->IsJunctionNeeded( point, true ) )
948  m_frame->AddJunction( m_frame->GetScreen(), point, true, false );
949  }
950 
951  return 0;
952 }
953 
954 
956 {
961 
963 }
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:403
void AddMenu(ACTION_MENU *aMenu, const SELECTION_CONDITION &aCondition=SELECTION_CONDITIONS::ShowAlways, int aOrder=ANY_ORDER)
Adds a submenu to the menu.
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:377
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false)
Mark an item for refresh.
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...
bool flipY
True if the bus entry should be flipped in the y-axis.
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Function Wait()
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Function GetMousePosition() Returns the current mouse pointer position.
virtual std::vector< wxPoint > GetConnectionPoints() const
Add all the connection points for this item to aPoints.
Definition: sch_item.h:386
static TOOL_ACTION breakBus
Definition: ee_actions.h:135
void RecalculateConnections(SCH_CLEANUP_FLAGS aCleanupFlags)
Generates the connection data for the entire schematic hierarchy.
wxPoint GetStartPoint() const
Definition: sch_line.h:94
void SetSize(const wxSize &aSize)
Definition: sch_bus_entry.h:73
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...
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
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:373
const BITMAP_OPAQUE add_line2bus_xpm[1]
static SELECTION_CONDITION MoreThan(int aNumber)
Creates a functor that tests if the number of selected items is greater than the value given as param...
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.
void AddToPreview(EDA_ITEM *aItem, bool aTakeOwnership=true)
Definition: view.cpp:1572
SCH_LINE * doUnfoldBus(const wxString &aNet)
static bool Idle(const SELECTION &aSelection)
Tests if there no items selected or being edited.
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:390
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.
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
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
VECTOR2I BestSnapAnchor(const VECTOR2I &aOrigin, SCH_ITEM *aDraggedItem)
static bool IsDrawingLine(const SELECTION &aSelection)
void RemoveFromScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen)
Remove an item from the screen (and view) aScreen is the screen the item is located on,...
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 SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:238
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:211
virtual void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:196
static TOOL_ACTION breakWire
Definition: ee_actions.h:134
static TOOL_ACTION finishLine
Definition: ee_actions.h:97
void SetEndPoint(const wxPoint &aPosition)
Definition: sch_line.h:98
void SetTool(TOOL_INTERACTIVE *aTool)
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.
SCH_JUNCTION * AddJunction(SCH_SCREEN *aScreen, const wxPoint &aPos, bool aAppendToUndo, bool aFinal=true)
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
void ShowPreview(bool aShow=true)
Definition: view.cpp:1586
static TOOL_ACTION leaveSheet
Definition: ee_actions.h:185
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:718
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
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
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)
Assigns an icon for the entry.
Definition: action_menu.cpp:71
TOOL_EVENT.
Definition: tool_event.h:171
void ClearPreview()
Definition: view.cpp:1553
SCHEMATIC & Schematic() const
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
void SaveCopyForRepeatItem(SCH_ITEM *aItem)
Clone aItem and owns that clone in this container.
std::vector< wxPoint > GetSchematicConnections()
Collects a unique list of all possible connection points in the schematic.
VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (such a...
EE_SELECTION_TOOL * m_selectionTool
Definition: ee_tool_base.h:160
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
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.
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
wxPoint GetPosition() const override
Definition: sch_text.h:313
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:235
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:150
static bool IsDrawingBus(const SELECTION &aSelection)
static TOOL_ACTION drawBus
Definition: ee_actions.h:80
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:300
wxSize GetSize() const
Definition: sch_bus_entry.h:71
SCH_SHEET & Root() const
Definition: schematic.h:94
bool IsTerminalPoint(const wxPoint &aPosition, int aLayer)
Test if aPosition is a connection point on aLayer.
Definition: sch_screen.cpp:483
void SetTitle(const wxString &aTitle) override
Sets title for the menu.
Definition: action_menu.cpp:89
Board layer functions and definitions.
int AddItemToSel(const TOOL_EVENT &aEvent)
const char * name
Definition: DXF_plotter.cpp:60
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
ACTION_MENU(bool isContextMenu, TOOL_INTERACTIVE *aTool=nullptr)
Default constructor
Definition: action_menu.cpp:46
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:158
static SELECTION_CONDITION OnlyType(KICAD_T aType)
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:413
void 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.
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:229
void SetSnap(bool aSnap)
bool IsBus() const
static TOOL_ACTION placeGlobalLabel
Definition: ee_actions.h:86
void ClearEditFlags()
Definition: base_struct.h:251
static TOOL_ACTION finishBus
Definition: ee_actions.h:96
void SetPosition(const wxPoint &aPosition) override
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:273
bool flipX
True if the bus entry should be flipped in the x-axis.
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Adds a menu entry to run a TOOL_ACTION on selected items.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
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
const VECTOR2D Position() const
Returns mouse cursor position in world coordinates.
Definition: tool_event.h:274
BUS_UNFOLDING_T m_busUnfold
Data related to bus unfolding tool.
static TOOL_ACTION refreshPreview
Definition: actions.h:104
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
wxPoint GetEnd() const
#define IS_MOVED
Item being moved.
Definition: base_struct.h:116
wxPoint GetEndPoint() const
Definition: sch_line.h:97