KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_selection_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 The 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 <advanced_config.h>
26#include <core/typeinfo.h>
27#include <core/kicad_algo.h>
30#include <sch_actions.h>
31#include <sch_collectors.h>
32#include <sch_selection_tool.h>
33#include <sch_base_frame.h>
34#include <eeschema_id.h>
35#include <symbol_edit_frame.h>
36#include <symbol_viewer_frame.h>
37#include <math/util.h>
38#include <deque>
39#include <unordered_set>
41#include <geometry/shape_rect.h>
43#include <sch_painter.h>
45#include <sch_commit.h>
46#include <sch_edit_frame.h>
47#include <connection_graph.h>
48#include <sch_line.h>
49#include <sch_bus_entry.h>
50#include <sch_pin.h>
51#include <sch_group.h>
52#include <sch_marker.h>
53#include <sch_no_connect.h>
54#include <sch_sheet_pin.h>
55#include <sch_table.h>
56#include <tool/tool_event.h>
57#include <tool/tool_manager.h>
59#include <tools/sch_move_tool.h>
64#include <trigo.h>
65#include <view/view.h>
66#include <view/view_controls.h>
67#include <wx/log.h>
68
70
71
73{
74 if( aSel.GetSize() == 1 )
75 {
76 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( aSel.Front() );
77
78 if( symbol )
79 return !symbol->GetLibSymbolRef() || !symbol->GetLibSymbolRef()->IsPower();
80 }
81
82 return false;
83};
84
85
87{
88 return aSel.GetSize() == 1 && aSel.Front()->Type() == SCH_SYMBOL_T;
89};
90
91
93{
94 if( aSel.GetSize() == 1 )
95 {
96 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( aSel.Front() );
97
98 if( symbol )
99 return symbol->GetLibSymbolRef() && symbol->GetLibSymbolRef()->IsMultiBodyStyle();
100 }
101
102 return false;
103};
104
105
107{
108 if( aSel.GetSize() == 1 )
109 {
110 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( aSel.Front() );
111
112 if( symbol )
113 return symbol->GetLibSymbolRef() && symbol->GetLibSymbolRef()->GetUnitCount() >= 2;
114 }
115
116 return false;
117};
118
119
121{
122 if( aSel.GetSize() == 1 )
123 {
124 SCH_PIN* pin = dynamic_cast<SCH_PIN*>( aSel.Front() );
125
126 if( pin && pin->GetLibPin() )
127 return !pin->GetLibPin()->GetAlternates().empty();
128 }
129
130 return false;
131};
132
133
135{
136 if( aSel.CountType( SCH_MARKER_T ) != 1 )
137 return false;
138
139 return !static_cast<SCH_MARKER*>( aSel.Front() )->IsExcluded();
140};
141
142
144{
145 return aSel.GetSize() > 1 && aSel.OnlyContains( { SCH_SYMBOL_T } );
146};
147
148
150{
151 return aSel.GetSize() >= 1 && aSel.OnlyContains( { SCH_PIN_T } );
152};
153
154
156{
157 return aSel.GetSize() >= 1 && aSel.OnlyContains( { SCH_PIN_T, SCH_SHEET_PIN_T } );
158};
159
160
162{
163 for( EDA_ITEM* item : aSel.Items() )
164 {
165 if( SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( item ) )
166 {
167 if( schItem->IsLocked() )
168 return true;
169 }
170 }
171
172 return false;
173};
174
175
177{
178 for( EDA_ITEM* item : aSel.Items() )
179 {
180 if( SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( item ) )
181 {
182 if( !schItem->IsLocked() )
183 return true;
184 }
185 }
186
187 return false;
188};
189
190
191static void passEvent( TOOL_EVENT* const aEvent, const TOOL_ACTION* const aAllowedActions[] )
192{
193 for( int i = 0; aAllowedActions[i]; ++i )
194 {
195 if( aEvent->IsAction( aAllowedActions[i] ) )
196 {
197 aEvent->SetPassEvent();
198 break;
199 }
200 }
201}
202
203
204#define HITTEST_THRESHOLD_PIXELS 5
205
206
208 SELECTION_TOOL( "common.InteractiveSelection" ),
209 m_frame( nullptr ),
211 m_isSymbolEditor( false ),
212 m_isSymbolViewer( false ),
213 m_unit( 0 ),
214 m_bodyStyle( 0 ),
215 m_enteredGroup( nullptr ),
217 m_previous_first_cell( nullptr )
218{
219 m_filter.SetDefaults();
220 m_selection.Clear();
221}
222
223
229
230
246
247static std::vector<KICAD_T> connectedLineTypes =
248{
251};
252
272
273static std::vector<KICAD_T> crossProbingTypes =
274{
276 SCH_PIN_T,
278};
279
280static std::vector<KICAD_T> lineTypes = { SCH_LINE_T };
281static std::vector<KICAD_T> sheetTypes = { SCH_SHEET_T };
282static std::vector<KICAD_T> tableCellTypes = { SCH_TABLECELL_T };
283
285{
287
288 SYMBOL_VIEWER_FRAME* symbolViewerFrame = dynamic_cast<SYMBOL_VIEWER_FRAME*>( m_frame );
289 SYMBOL_EDIT_FRAME* symbolEditorFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
290
291 if( symbolEditorFrame )
292 {
293 m_isSymbolEditor = true;
294 m_unit = symbolEditorFrame->GetUnit();
295 m_bodyStyle = symbolEditorFrame->GetBodyStyle();
296 }
297 else
298 {
299 m_isSymbolViewer = symbolViewerFrame != nullptr;
300 }
301
302 // clang-format off
303 auto linesSelection = SCH_CONDITIONS::MoreThan( 0 ) && SCH_CONDITIONS::OnlyTypes( lineTypes );
304 auto wireOrBusSelection = SCH_CONDITIONS::Count( 1 ) && SCH_CONDITIONS::OnlyTypes( connectedLineTypes );
305 auto connectedSelection = SCH_CONDITIONS::MoreThan( 0 ) && SCH_CONDITIONS::OnlyTypes( connectedTypes );
306 auto expandableSelection =
308 auto sheetSelection = SCH_CONDITIONS::Count( 1 ) && SCH_CONDITIONS::OnlyTypes( sheetTypes );
309 auto crossProbingSelection = SCH_CONDITIONS::MoreThan( 0 ) && SCH_CONDITIONS::HasTypes( crossProbingTypes );
310 auto tableCellSelection = SCH_CONDITIONS::MoreThan( 0 ) && SCH_CONDITIONS::OnlyTypes( tableCellTypes );
311 auto multiplePinsSelection = SCH_CONDITIONS::MoreThan( 1 ) && SCH_CONDITIONS::OnlyTypes( { SCH_PIN_T } );
312 // clang-format on
313
314 auto schEditSheetPageNumberCondition =
315 [this] ( const SELECTION& aSel )
316 {
318 return false;
319
320 return SCH_CONDITIONS::LessThan( 2 )( aSel )
322 };
323
324 auto schEditCondition =
325 [this] ( const SELECTION& aSel )
326 {
328 };
329
330 auto belowRootSheetCondition =
331 [this]( const SELECTION& aSel )
332 {
333 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
334
335 return editFrame
336 && editFrame->GetCurrentSheet().Last() != &editFrame->Schematic().Root();
337 };
338
339 auto haveHighlight =
340 [this]( const SELECTION& sel )
341 {
342 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
343
344 return editFrame && !editFrame->GetHighlightedConnection().IsEmpty();
345 };
346
347 auto haveSymbol =
348 [this]( const SELECTION& sel )
349 {
350 return m_isSymbolEditor &&
351 static_cast<SYMBOL_EDIT_FRAME*>( m_frame )->GetCurSymbol();
352 };
353
354 auto groupEnterCondition =
356
357 auto inGroupCondition =
358 [this] ( const SELECTION& )
359 {
360 return m_enteredGroup != nullptr;
361 };
362
363 auto multipleUnitsSelection = []( const SELECTION& aSel )
364 {
365 return !GetSameSymbolMultiUnitSelection( aSel ).empty();
366 };
367
368 auto allowPinSwaps =
369 [this]( const SELECTION& )
370 {
371 return m_frame->eeconfig() &&
372 m_frame->eeconfig()->m_Input.allow_unconstrained_pin_swaps;
373 };
374
375
376 auto& menu = m_menu->GetMenu();
377
378 // clang-format off
379 menu.AddItem( ACTIONS::groupEnter, groupEnterCondition, 1 );
380 menu.AddItem( ACTIONS::groupLeave, inGroupCondition, 1 );
381 menu.AddItem( SCH_ACTIONS::placeLinkedDesignBlock, groupEnterCondition, 1 );
382 menu.AddItem( SCH_ACTIONS::saveToLinkedDesignBlock, groupEnterCondition, 1 );
383 menu.AddItem( SCH_ACTIONS::clearHighlight, haveHighlight && SCH_CONDITIONS::Idle, 1 );
384 menu.AddSeparator( haveHighlight && SCH_CONDITIONS::Idle, 1 );
385
386 menu.AddItem( SCH_ACTIONS::selectConnection, expandableSelection && SCH_CONDITIONS::Idle, 2 );
387 menu.AddItem( ACTIONS::selectColumns, tableCellSelection && SCH_CONDITIONS::Idle, 2 );
388 menu.AddItem( ACTIONS::selectRows, tableCellSelection && SCH_CONDITIONS::Idle, 2 );
389 menu.AddItem( ACTIONS::selectTable, tableCellSelection && SCH_CONDITIONS::Idle, 2 );
390
391 menu.AddSeparator( 100 );
392 menu.AddItem( SCH_ACTIONS::drawWire, schEditCondition && SCH_CONDITIONS::Empty, 100 );
393 menu.AddItem( SCH_ACTIONS::drawBus, schEditCondition && SCH_CONDITIONS::Empty, 100 );
394
395 menu.AddSeparator( 100 );
397
398 menu.AddItem( SCH_ACTIONS::enterSheet, sheetSelection && SCH_CONDITIONS::Idle, 150 );
399 menu.AddItem( SCH_ACTIONS::selectOnPCB, crossProbingSelection && schEditCondition && SCH_CONDITIONS::Idle, 150 );
400 menu.AddItem( SCH_ACTIONS::leaveSheet, belowRootSheetCondition, 150 );
401
402 menu.AddSeparator( 200 );
403 menu.AddItem( SCH_ACTIONS::placeJunction, wireOrBusSelection && SCH_CONDITIONS::Idle, 250 );
404 menu.AddItem( SCH_ACTIONS::placeLabel, wireOrBusSelection && SCH_CONDITIONS::Idle, 250 );
405 menu.AddItem( SCH_ACTIONS::placeClassLabel, wireOrBusSelection && SCH_CONDITIONS::Idle, 250 );
406 menu.AddItem( SCH_ACTIONS::placeGlobalLabel, wireOrBusSelection && SCH_CONDITIONS::Idle, 250 );
407 menu.AddItem( SCH_ACTIONS::placeHierLabel, wireOrBusSelection && SCH_CONDITIONS::Idle, 250 );
408 menu.AddItem( SCH_ACTIONS::breakWire, linesSelection && SCH_CONDITIONS::Idle, 250 );
409 menu.AddItem( SCH_ACTIONS::slice, linesSelection && SCH_CONDITIONS::Idle, 250 );
410 menu.AddItem( SCH_ACTIONS::placeSheetPin, sheetSelection && SCH_CONDITIONS::Idle, 250 );
411 menu.AddItem( SCH_ACTIONS::autoplaceAllSheetPins, sheetSelection && SCH_CONDITIONS::Idle, 250 );
412 menu.AddItem( SCH_ACTIONS::syncSheetPins, sheetSelection && SCH_CONDITIONS::Idle, 250 );
413 menu.AddItem( SCH_ACTIONS::swapPinLabels, multiplePinsSelection && schEditCondition && SCH_CONDITIONS::Idle, 250 );
414 menu.AddItem( SCH_ACTIONS::swapUnitLabels, multipleUnitsSelection && schEditCondition && SCH_CONDITIONS::Idle, 250 );
415 menu.AddItem( SCH_ACTIONS::swapPins, multiplePinsSelection && schEditCondition && SCH_CONDITIONS::Idle && allowPinSwaps, 250 );
416 menu.AddItem( SCH_ACTIONS::assignNetclass, connectedSelection && SCH_CONDITIONS::Idle, 250 );
417 menu.AddItem( SCH_ACTIONS::findNetInInspector, connectedSelection && SCH_CONDITIONS::Idle, 250 );
418 menu.AddItem( SCH_ACTIONS::editPageNumber, schEditSheetPageNumberCondition, 250 );
419
420 menu.AddSeparator( 400 );
421 menu.AddItem( SCH_ACTIONS::symbolProperties, haveSymbol && SCH_CONDITIONS::Empty, 400 );
422 menu.AddItem( SCH_ACTIONS::pinTable, haveSymbol && SCH_CONDITIONS::Empty, 400 );
423
424 menu.AddSeparator( 1000 );
425 m_frame->AddStandardSubMenus( *m_menu.get() );
426 // clang-format on
427
428 m_disambiguateTimer.SetOwner( this );
429 Connect( m_disambiguateTimer.GetId(), wxEVT_TIMER,
430 wxTimerEventHandler( SCH_SELECTION_TOOL::onDisambiguationExpire ), nullptr, this );
431
432 return true;
433}
434
435
437{
439
440 if( aReason != TOOL_BASE::REDRAW )
441 {
442 if( m_enteredGroup )
443 ExitGroup();
444
445 // Remove pointers to the selected items from containers without changing their
446 // properties (as they are already deleted while a new sheet is loaded)
447 m_selection.Clear();
448 }
449
450 if( aReason == RESET_REASON::SHUTDOWN )
451 return;
452
453 if( aReason == TOOL_BASE::MODEL_RELOAD || aReason == TOOL_BASE::SUPERMODEL_RELOAD )
454 {
455 getView()->GetPainter()->GetSettings()->SetHighlight( false );
456
457 SYMBOL_EDIT_FRAME* symbolEditFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
458 SYMBOL_VIEWER_FRAME* symbolViewerFrame = dynamic_cast<SYMBOL_VIEWER_FRAME*>( m_frame );
459
460 if( symbolEditFrame )
461 {
462 m_isSymbolEditor = true;
463 m_unit = symbolEditFrame->GetUnit();
464 m_bodyStyle = symbolEditFrame->GetBodyStyle();
465 }
466 else
467 {
468 m_isSymbolViewer = symbolViewerFrame != nullptr;
469 }
470 }
471
472 // Reinsert the VIEW_GROUP, in case it was removed from the VIEW
474 getView()->Add( &m_selection );
475
478}
479
481{
482 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
483
484 KIID lastRolloverItemId = niluuid;
486
487 auto pinOrientation =
488 []( EDA_ITEM* aItem )
489 {
490 SCH_PIN* pin = dynamic_cast<SCH_PIN*>( aItem );
491
492 if( pin )
493 {
494 const SCH_SYMBOL* parent = dynamic_cast<const SCH_SYMBOL*>( pin->GetParentSymbol() );
495
496 if( !parent )
497 return pin->GetOrientation();
498 else
499 {
500 SCH_PIN dummy( *pin );
502 return dummy.GetOrientation();
503 }
504 }
505
506 SCH_SHEET_PIN* sheetPin = dynamic_cast<SCH_SHEET_PIN*>( aItem );
507
508 if( sheetPin )
509 {
510 switch( sheetPin->GetSide() )
511 {
512 default:
517 }
518 }
519
521 };
522
523 // Main loop: keep receiving events
524 while( TOOL_EVENT* evt = Wait() )
525 {
526 bool selCancelled = false;
527 bool displayWireCursor = false;
528 bool displayBusCursor = false;
529 bool displayLineCursor = false;
530 KIID rolloverItemId = lastRolloverItemId;
531
532 // on left click, a selection is made, depending on modifiers ALT, SHIFT, CTRL:
533 setModifiersState( evt->Modifier( MD_SHIFT ), evt->Modifier( MD_CTRL ),
534 evt->Modifier( MD_ALT ) );
535
536 MOUSE_DRAG_ACTION drag_action = m_frame->GetDragAction();
537
538 if( evt->IsMouseDown( BUT_LEFT ) )
539 {
540 if( !m_frame->ToolStackIsEmpty() )
541 {
542 // Avoid triggering when running under other tools
543 }
544 else if( m_toolMgr->GetTool<SCH_POINT_EDITOR>()
545 && m_toolMgr->GetTool<SCH_POINT_EDITOR>()->HasPoint() )
546 {
547 // Distinguish point editor from selection modification by checking modifiers
548 if( hasModifier() )
549 {
550 m_originalCursor = m_toolMgr->GetMousePosition();
551 m_disambiguateTimer.StartOnce( ADVANCED_CFG::GetCfg().m_DisambiguationMenuDelay );
552 }
553 }
554 else
555 {
556 m_originalCursor = m_toolMgr->GetMousePosition();
557 m_disambiguateTimer.StartOnce( ADVANCED_CFG::GetCfg().m_DisambiguationMenuDelay );
558 }
559 }
560 // Single click? Select single object
561 else if( evt->IsClick( BUT_LEFT ) )
562 {
563 // If the timer has stopped, then we have already run the disambiguate routine
564 // and we don't want to register an extra click here
565 if( !m_disambiguateTimer.IsRunning() )
566 {
567 evt->SetPassEvent();
568 continue;
569 }
570
571 m_disambiguateTimer.Stop();
572
573 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
574 schframe->ClearFocus();
575
576 // Collect items at the clicked location (doesn't select them yet)
577 SCH_COLLECTOR collector;
579
580 CollectHits( collector, evt->Position() );
581 size_t preFilterCount = collector.GetCount();
582 rejected.SetAll( false );
583 narrowSelection( collector, evt->Position(), false, false, &rejected );
584
585 if( m_selection.GetSize() != 0 && dynamic_cast<SCH_TABLECELL*>( m_selection.GetItem( 0 ) ) && m_additive
586 && collector.GetCount() == 1 && dynamic_cast<SCH_TABLECELL*>( collector[0] ) )
587 {
588 SCH_TABLECELL* firstCell = static_cast<SCH_TABLECELL*>( m_selection.GetItem( 0 ) );
589 SCH_TABLECELL* clickedCell = static_cast<SCH_TABLECELL*>( collector[0] );
590 bool allCellsFromSameTable = true;
591
592 if( m_previous_first_cell == nullptr || m_selection.GetSize() == 1)
593 {
594 m_previous_first_cell = firstCell;
595 }
596
598 {
599 if( !static_cast<SCH_TABLECELL*>( selection )
600 || selection->GetParent() != clickedCell->GetParent() )
601 {
602 allCellsFromSameTable = false;
603 }
604 }
605
606 if( m_previous_first_cell && clickedCell && allCellsFromSameTable )
607 {
609 selection->ClearSelected();
610
611 m_selection.Clear();
612 SCH_TABLE* parentTable = dynamic_cast<SCH_TABLE*>( m_previous_first_cell->GetParent() );
613
614 VECTOR2D start = m_previous_first_cell->GetCenter();
615 VECTOR2D end = clickedCell->GetCenter();
616
617 if( parentTable )
618 {
619 InitializeSelectionState( parentTable );
620
621 VECTOR2D topLeft( std::min( start.x, end.x ), std::min( start.y, end.y ) );
622 VECTOR2D bottomRight( std::max( start.x, end.x ), std::max( start.y, end.y ) );
623
624 SelectCellsBetween( topLeft, bottomRight - topLeft, parentTable );
625 }
626 }
627 }
628 else if( collector.GetCount() == 1 && !m_isSymbolEditor && !hasModifier() )
629 {
630 OPT_TOOL_EVENT autostart = autostartEvent( evt, grid, collector[0] );
631
632 if( autostart )
633 {
635
636 params->layer = autostart->Parameter<const DRAW_SEGMENT_EVENT_PARAMS*>()->layer;
637 params->quitOnDraw = true;
638 params->sourceSegment = dynamic_cast<SCH_LINE*>( collector[0] );
639
640 autostart->SetParameter<const DRAW_SEGMENT_EVENT_PARAMS*>( params );
641 m_toolMgr->ProcessEvent( *autostart );
642
643 selCancelled = true;
644 }
645 else if( collector[0]->HasHoveredHypertext() )
646 {
647 collector[ 0 ]->DoHypertextAction( m_frame, evt->Position() );
648 selCancelled = true;
649 }
650 else if( collector[0]->IsBrightened() )
651 {
652 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
653 {
654 NET_NAVIGATOR_ITEM_DATA itemData( schframe->GetCurrentSheet(), collector[0] );
655
656 schframe->SelectNetNavigatorItem( &itemData );
657 }
658 }
659 }
660
661 if( !selCancelled )
662 {
663 if( collector.GetCount() == 0 && preFilterCount > 0 )
664 {
665 if( SCH_BASE_FRAME* frame = dynamic_cast<SCH_BASE_FRAME*>( m_frame ) )
666 frame->HighlightSelectionFilter( rejected );
667 }
668
669 selectPoint( collector, evt->Position(), nullptr, nullptr, m_additive, m_subtractive, m_exclusive_or );
670 m_selection.SetIsHover( false );
671 }
672 }
673 else if( evt->IsClick( BUT_RIGHT ) )
674 {
675 m_disambiguateTimer.Stop();
676
677 // right click? if there is any object - show the context menu
678 if( m_selection.Empty() )
679 {
681 SelectPoint( evt->Position(), { SCH_LOCATE_ANY_T }, nullptr, &selCancelled );
682 m_selection.SetIsHover( true );
683 }
684 // If the cursor has moved off the bounding box of the selection by more than
685 // a grid square, check to see if there is another item available for selection
686 // under the cursor. If there is, the user likely meant to get the context menu
687 // for that item. If there is no new item, then keep the original selection and
688 // show the context menu for it.
689 else if( !m_selection.GetBoundingBox().Inflate( grid.GetGrid().x, grid.GetGrid().y )
690 .Contains( evt->Position() ) )
691 {
692 SCH_COLLECTOR collector;
693
694 if( CollectHits( collector, evt->Position(), { SCH_LOCATE_ANY_T } ) )
695 {
697
698 SelectPoint( evt->Position(), { SCH_LOCATE_ANY_T }, nullptr, &selCancelled );
699 m_selection.SetIsHover( true );
700 }
701 }
702
703 if( !selCancelled )
704 m_menu->ShowContextMenu( m_selection );
705 }
706 else if( evt->IsDblClick( BUT_LEFT ) )
707 {
708 m_disambiguateTimer.Stop();
709
710 // double click? Display the properties window
711 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
712 schframe->ClearFocus();
713
714 if( m_selection.Empty() )
715 SelectPoint( evt->Position() );
716
717 EDA_ITEM* item = m_selection.Front();
718
719 if( item && item->Type() == SCH_SHEET_T )
720 m_toolMgr->PostAction( SCH_ACTIONS::enterSheet );
721 else if( m_selection.GetSize() == 1 && m_selection[0]->Type() == SCH_GROUP_T )
722 EnterGroup();
723 else
724 m_toolMgr->PostAction( SCH_ACTIONS::properties );
725 }
726 else if( evt->IsDblClick( BUT_MIDDLE ) )
727 {
728 m_disambiguateTimer.Stop();
729
730 // Middle double click? Do zoom to fit or zoom to objects
731 if( evt->Modifier( MD_CTRL ) ) // Is CTRL key down?
733 else
734 m_toolMgr->RunAction( ACTIONS::zoomFitScreen );
735 }
736 else if( evt->IsDrag( BUT_LEFT ) )
737 {
738 m_disambiguateTimer.Stop();
739
740 // Is another tool already moving a new object? Don't allow a drag start
741 if( !m_selection.Empty() && m_selection[0]->HasFlag( IS_NEW | IS_MOVING ) )
742 {
743 evt->SetPassEvent();
744 continue;
745 }
746
747 // drag with LMB? Select multiple objects (or at least draw a selection box) or
748 // drag them
749 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
750 schframe->ClearFocus();
751
752 SCH_COLLECTOR collector;
753
754 if( m_selection.GetSize() == 1 && dynamic_cast<SCH_TABLE*>( m_selection.GetItem( 0 ) )
755 && evt->HasPosition() && selectionContains( evt->DragOrigin() ) )
756 {
757 m_toolMgr->RunAction( SCH_ACTIONS::move );
758 }
759 // Allow drag selecting table cells, except when they're inside a group that we haven't entered
760 else if( CollectHits( collector, evt->DragOrigin(), { SCH_TABLECELL_T } )
761 && ( collector[0]->GetParent()->GetParentGroup() == nullptr
762 || collector[0]->GetParent()->GetParentGroup() == m_enteredGroup ) )
763 {
764 selectTableCells( static_cast<SCH_TABLE*>( collector[0]->GetParent() ) );
765 }
766 else if( hasModifier() || drag_action == MOUSE_DRAG_ACTION::SELECT )
767 {
770 selectLasso();
771 else
773 }
774 else if( m_selection.Empty() && drag_action != MOUSE_DRAG_ACTION::DRAG_ANY )
775 {
778 selectLasso();
779 else
781 }
782 else
783 {
784 if( m_isSymbolEditor )
785 {
786 if( static_cast<SYMBOL_EDIT_FRAME*>( m_frame )->IsSymbolAlias() )
787 {
789 }
790 else
791 {
795 SCH_PIN_T,
796 SCH_FIELD_T } );
797 }
798 }
799 else
800 {
802 }
803
804 // Check if dragging has started within any of selected items bounding box
805 if( evt->HasPosition() && selectionContains( evt->DragOrigin() ) )
806 {
807 // drag_is_move option exists only in schematic editor, not in symbol editor
808 // (m_frame->eeconfig() returns nullptr in Symbol Editor)
809 if( m_isSymbolEditor || m_frame->eeconfig()->m_Input.drag_is_move )
810 m_toolMgr->RunAction( SCH_ACTIONS::move );
811 else
812 m_toolMgr->RunAction( SCH_ACTIONS::drag );
813 }
814 else
815 {
816 // No -> drag a selection box
819 selectLasso();
820 else
822 }
823 }
824 }
825 else if( evt->IsMouseDown( BUT_AUX1 ) )
826 {
828 }
829 else if( evt->IsMouseDown( BUT_AUX2 ) )
830 {
832 }
833 else if( evt->Action() == TA_MOUSE_WHEEL )
834 {
835 int field = -1;
836
837 if( evt->Modifier() == ( MD_SHIFT | MD_ALT ) )
838 field = 0;
839 else if( evt->Modifier() == ( MD_CTRL | MD_ALT ) )
840 field = 1;
841 // any more?
842
843 if( field >= 0 )
844 {
845 const int delta = evt->Parameter<int>();
846 ACTIONS::INCREMENT incParams{ delta > 0 ? 1 : -1, field };
847
848 m_toolMgr->RunAction( ACTIONS::increment, incParams );
849 }
850 }
851 else if( evt->Category() == TC_COMMAND && evt->Action() == TA_CHOICE_MENU_CHOICE )
852 {
853 m_disambiguateTimer.Stop();
854
855 // context sub-menu selection? Handle unit selection or bus unfolding
856 if( *evt->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT
857 && *evt->GetCommandId() <= ID_POPUP_SCH_SELECT_UNIT_END )
858 {
859 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( m_selection.Front() );
860 int unit = *evt->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT;
861
862 if( symbol )
863 static_cast<SCH_EDIT_FRAME*>( m_frame )->SelectUnit( symbol, unit );
864 }
865 else if( *evt->GetCommandId() >= ID_POPUP_SCH_PLACE_UNIT
866 && *evt->GetCommandId() <= ID_POPUP_SCH_PLACE_UNIT_END )
867 {
868 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( m_selection.Front() );
869 int unit = *evt->GetCommandId() - ID_POPUP_SCH_PLACE_UNIT;
870
871 if( symbol )
874 }
875 else if( *evt->GetCommandId() >= ID_POPUP_SCH_SELECT_BODY_STYLE
876 && *evt->GetCommandId() <= ID_POPUP_SCH_SELECT_BODY_STYLE_END )
877 {
878 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( m_selection.Front() );
879 int bodyStyle = ( *evt->GetCommandId() - ID_POPUP_SCH_SELECT_BODY_STYLE ) + 1;
880
881 if( symbol && symbol->GetBodyStyle() != bodyStyle )
882 static_cast<SCH_EDIT_FRAME*>( m_frame )->SelectBodyStyle( symbol, bodyStyle );
883 }
884 else if( *evt->GetCommandId() >= ID_POPUP_SCH_ALT_PIN_FUNCTION
885 && *evt->GetCommandId() <= ID_POPUP_SCH_ALT_PIN_FUNCTION_END )
886 {
887 SCH_PIN* pin = dynamic_cast<SCH_PIN*>( m_selection.Front() );
888 wxString alt = *evt->Parameter<wxString*>();
889
890 if( pin )
891 static_cast<SCH_EDIT_FRAME*>( m_frame )->SetAltPinFunction( pin, alt );
892 }
893 else if( *evt->GetCommandId() >= ID_POPUP_SCH_PIN_TRICKS_START
894 && *evt->GetCommandId() <= ID_POPUP_SCH_PIN_TRICKS_END
896 {
897 SCH_EDIT_FRAME* sch_frame = static_cast<SCH_EDIT_FRAME*>( m_frame );
898
899 // Keep track of new items so we make them the new selection at the end
900 EDA_ITEMS newItems;
901 SCH_COMMIT commit( sch_frame );
902
903 if( *evt->GetCommandId() == ID_POPUP_SCH_PIN_TRICKS_NO_CONNECT )
904 {
905 for( EDA_ITEM* item : m_selection )
906 {
907 if( item->Type() != SCH_PIN_T && item->Type() != SCH_SHEET_PIN_T )
908 continue;
909
910 SCH_NO_CONNECT* nc = new SCH_NO_CONNECT( item->GetPosition() );
911 commit.Add( nc, sch_frame->GetScreen() );
912 newItems.push_back( nc );
913 }
914
915 if( !commit.Empty() )
916 {
917 commit.Push( wxS( "No Connect Pins" ) );
919 }
920 }
921 else if( *evt->GetCommandId() == ID_POPUP_SCH_PIN_TRICKS_WIRE )
922 {
923 VECTOR2I wireGrid = grid.GetGridSize( GRID_HELPER_GRIDS::GRID_WIRES );
924
925 for( EDA_ITEM* item : m_selection )
926 {
927 if( item->Type() != SCH_PIN_T && item->Type() != SCH_SHEET_PIN_T )
928 continue;
929
930 SCH_LINE* wire = new SCH_LINE( item->GetPosition(), LAYER_WIRE );
931
932 // Add some length to the wire as nothing in our code base handles
933 // 0 length wires very well, least of all the ortho drag algorithm
934 VECTOR2I stub;
935
936 switch( pinOrientation( item ) )
937 {
938 default:
940 stub = VECTOR2I( -1 * wireGrid.x, 0 );
941 break;
943 stub = VECTOR2I( 1 * wireGrid.x, 0 );
944 break;
946 stub = VECTOR2I( 0, 1 * wireGrid.y );
947 break;
949 stub = VECTOR2I( 0, -1 * wireGrid.y );
950 break;
951 }
952
953 wire->SetEndPoint( item->GetPosition() + stub );
954
955 m_frame->AddToScreen( wire, sch_frame->GetScreen() );
956 commit.Added( wire, sch_frame->GetScreen() );
957 newItems.push_back( wire );
958 }
959
960 if( !commit.Empty() )
961 {
963 AddItemsToSel( &newItems );
964
965 // Select only the ends so we can immediately start dragging them
966 for( EDA_ITEM* item : newItems )
967 static_cast<SCH_LINE*>( item )->SetFlags( ENDPOINT );
968
970
971 // Put the mouse on the nearest point of the first wire
972 SCH_LINE* first = static_cast<SCH_LINE*>( newItems[0] );
973 vc->SetCrossHairCursorPosition( first->GetEndPoint(), false );
974 vc->WarpMouseCursor( vc->GetCursorPosition(), true );
975
976 // Start the drag tool, canceling will remove the wires
977 if( m_toolMgr->RunSynchronousAction( SCH_ACTIONS::drag, &commit ) )
978 commit.Push( wxS( "Wire Pins" ) );
979 else
980 commit.Revert();
981 }
982 }
983 else
984 {
985 // For every pin in the selection, add a label according to menu item
986 // selected by the user
987 for( EDA_ITEM* item : m_selection )
988 {
989 SCH_PIN* pin = dynamic_cast<SCH_PIN*>( item );
990 SCH_SHEET_PIN* sheetPin = dynamic_cast<SCH_SHEET_PIN*>( item );
991 SCH_LABEL_BASE* label = nullptr;
992 SCH_SHEET_PATH& sheetPath = sch_frame->GetCurrentSheet();
993
994 wxString labelText;
995
996 if( pin )
997 {
998 labelText = pin->GetShownName();
999
1000 if( labelText.IsEmpty() )
1001 {
1002 labelText.Printf( "%s_%s",
1003 pin->GetParentSymbol()->GetRef( &sheetPath ),
1004 pin->GetNumber() );
1005 }
1006 }
1007 else if( sheetPin )
1008 {
1009 labelText = sheetPin->GetShownText( &sheetPath, false );
1010 }
1011 else
1012 {
1013 continue;
1014 }
1015
1016 switch( *evt->GetCommandId() )
1017 {
1019 label = new SCH_LABEL( item->GetPosition(), labelText );
1020 break;
1022 label = new SCH_HIERLABEL( item->GetPosition(), labelText );
1023 break;
1025 label = new SCH_GLOBALLABEL( item->GetPosition(), labelText );
1026 break;
1027 default:
1028 continue;
1029 }
1030
1031 switch( pinOrientation( item ) )
1032 {
1033 default:
1036 break;
1039 break;
1042 break;
1045 break;
1046 }
1047
1049
1050 if( pin )
1051 {
1052 pinType = pin->GetType();
1053 }
1054 else if( sheetPin )
1055 {
1056 switch( sheetPin->GetLabelShape() )
1057 {
1058 case LABEL_INPUT: pinType = ELECTRICAL_PINTYPE::PT_INPUT; break;
1059 case LABEL_OUTPUT: pinType = ELECTRICAL_PINTYPE::PT_OUTPUT; break;
1060 case LABEL_BIDI: pinType = ELECTRICAL_PINTYPE::PT_BIDI; break;
1061 case LABEL_TRISTATE: pinType = ELECTRICAL_PINTYPE::PT_TRISTATE; break;
1062 case LABEL_PASSIVE: pinType = ELECTRICAL_PINTYPE::PT_PASSIVE; break;
1063 }
1064 }
1065
1066 switch( pinType )
1067 {
1070 break;
1073 break;
1076 break;
1079 break;
1082 break;
1083 default:
1085 }
1086
1087 commit.Add( label, sch_frame->GetScreen() );
1088 newItems.push_back( label );
1089 }
1090
1091 if( !commit.Empty() )
1092 {
1093 commit.Push( wxS( "Label Pins" ) );
1094
1095 // Many users will want to drag these items to wire off of the pins, so
1096 // pre-select them.
1098 AddItemsToSel( &newItems );
1099 }
1100 }
1101 }
1102 else if( *evt->GetCommandId() >= ID_POPUP_SCH_UNFOLD_BUS
1103 && *evt->GetCommandId() <= ID_POPUP_SCH_UNFOLD_BUS_END )
1104 {
1105 wxString* net = new wxString( *evt->Parameter<wxString*>() );
1106 m_toolMgr->RunAction<wxString*>( SCH_ACTIONS::unfoldBus, net );
1107 }
1108 }
1109 else if( evt->IsCancelInteractive() )
1110 {
1111 m_disambiguateTimer.Stop();
1112
1113 // We didn't set these, but we have reports that they leak out of some other tools,
1114 // so we clear them here.
1115 getViewControls()->SetAutoPan( false );
1116 getViewControls()->CaptureCursor( false );
1117
1118 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
1119 schframe->ClearFocus();
1120
1121 if( !GetSelection().Empty() )
1122 {
1124 }
1125 else if( evt->FirstResponder() == this && evt->GetCommandId() == (int) WXK_ESCAPE )
1126 {
1127 if( m_enteredGroup )
1128 {
1129 ExitGroup();
1130 }
1131 else
1132 {
1134
1135 if( editor && m_frame->eeconfig()->m_Input.esc_clears_net_highlight )
1136 editor->ClearHighlight( *evt );
1137 }
1138 }
1139 }
1140 else if( evt->Action() == TA_UNDO_REDO_PRE )
1141 {
1142 if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( m_frame ) )
1143 schframe->ClearFocus();
1144 }
1145 else if( evt->IsMotion() && !m_isSymbolEditor && evt->FirstResponder() == this )
1146 {
1147 // Update cursor and rollover item
1148 rolloverItemId = niluuid;
1149 SCH_COLLECTOR collector;
1150
1152
1153 if( CollectHits( collector, evt->Position() ) )
1154 {
1155 narrowSelection( collector, evt->Position(), false, false, nullptr );
1156
1157 if( collector.GetCount() == 1 && !hasModifier() )
1158 {
1159 OPT_TOOL_EVENT autostartEvt = autostartEvent( evt, grid, collector[0] );
1160
1161 if( autostartEvt )
1162 {
1163 if( autostartEvt->Matches( SCH_ACTIONS::drawBus.MakeEvent() ) )
1164 displayBusCursor = true;
1165 else if( autostartEvt->Matches( SCH_ACTIONS::drawWire.MakeEvent() ) )
1166 displayWireCursor = true;
1167 else if( autostartEvt->Matches( SCH_ACTIONS::drawLines.MakeEvent() ) )
1168 displayLineCursor = true;
1169 }
1170 else if( collector[0]->HasHypertext() && !collector[0]->IsSelected() )
1171 {
1172 rolloverItemId = collector[0]->m_Uuid;
1173 }
1174 }
1175 }
1176 }
1177 else
1178 {
1179 evt->SetPassEvent();
1180 }
1181
1182 if( lastRolloverItemId != niluuid && lastRolloverItemId != rolloverItemId )
1183 {
1184 EDA_ITEM* item = m_frame->ResolveItem( lastRolloverItemId );
1185
1186 item->SetIsRollover( false, { 0, 0 } );
1187
1188 if( item->Type() == SCH_FIELD_T || item->Type() == SCH_TABLECELL_T )
1189 m_frame->GetCanvas()->GetView()->Update( item->GetParent() );
1190 else
1191 m_frame->GetCanvas()->GetView()->Update( item );
1192 }
1193
1194 SCH_ITEM* rolloverItem = nullptr;
1195
1196 if( rolloverItemId != niluuid )
1197 {
1198 rolloverItem = static_cast<SCH_ITEM*>( m_frame->ResolveItem( rolloverItemId ) );
1199
1200 rolloverItem->SetIsRollover( true, getViewControls()->GetMousePosition() );
1201
1202 if( rolloverItem->Type() == SCH_FIELD_T || rolloverItem->Type() == SCH_TABLECELL_T )
1203 m_frame->GetCanvas()->GetView()->Update( rolloverItem->GetParent() );
1204 else
1205 m_frame->GetCanvas()->GetView()->Update( rolloverItem );
1206 }
1207
1208 lastRolloverItemId = rolloverItemId;
1209
1210 if( m_frame->ToolStackIsEmpty() )
1211 {
1212 if( displayWireCursor )
1213 {
1215 }
1216 else if( displayBusCursor )
1217 {
1219 }
1220 else if( displayLineCursor )
1221 {
1223 }
1224 else if( rolloverItem && rolloverItem->HasHoveredHypertext() )
1225 {
1227 }
1228 else if( !m_selection.Empty()
1229 && drag_action == MOUSE_DRAG_ACTION::DRAG_SELECTED
1230 && evt->HasPosition()
1231 && selectionContains( evt->Position() ) //move/drag option prediction
1232 )
1233 {
1235 }
1236 else
1237 {
1239 }
1240 }
1241 }
1242
1243 m_disambiguateTimer.Stop();
1244
1245 // Shutting down; clear the selection
1246 m_selection.Clear();
1247
1248 return 0;
1249}
1250
1251
1253{
1254 wxCHECK_RET( m_selection.GetSize() == 1 && m_selection[0]->Type() == SCH_GROUP_T,
1255 wxT( "EnterGroup called when selection is not a single group" ) );
1256 SCH_GROUP* aGroup = static_cast<SCH_GROUP*>( m_selection[0] );
1257
1258 if( m_enteredGroup != nullptr )
1259 ExitGroup();
1260
1262 m_enteredGroup = aGroup;
1263 m_enteredGroup->SetFlags( ENTERED );
1264 m_enteredGroup->RunOnChildren(
1265 [&]( SCH_ITEM* aChild )
1266 {
1267 if( aChild->Type() == SCH_LINE_T )
1268 aChild->SetFlags( STARTPOINT | ENDPOINT );
1269
1270 select( aChild );
1271 },
1273
1274 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
1275
1276 getView()->Hide( m_enteredGroup, true );
1279}
1280
1281
1282void SCH_SELECTION_TOOL::ExitGroup( bool aSelectGroup )
1283{
1284 // Only continue if there is a group entered
1285 if( m_enteredGroup == nullptr )
1286 return;
1287
1288 m_enteredGroup->ClearFlags( ENTERED );
1289 getView()->Hide( m_enteredGroup, false );
1291
1292 if( aSelectGroup )
1293 {
1295 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
1296 }
1297
1298 m_enteredGroupOverlay.Clear();
1299 m_enteredGroup = nullptr;
1301}
1302
1303
1305 SCH_ITEM* aItem )
1306{
1307 VECTOR2I pos = aGrid.BestSnapAnchor( aEvent->Position(), aGrid.GetItemGrid( aItem ) );
1308
1309 if( m_frame->eeconfig()->m_Drawing.auto_start_wires
1310 && !m_toolMgr->GetTool<SCH_POINT_EDITOR>()->HasPoint()
1311 && aItem->IsPointClickableAnchor( pos ) )
1312 {
1313 OPT_TOOL_EVENT newEvt = SCH_ACTIONS::drawWire.MakeEvent();
1314
1315 if( aItem->Type() == SCH_BUS_BUS_ENTRY_T )
1316 {
1317 newEvt = SCH_ACTIONS::drawBus.MakeEvent();
1318 }
1319 else if( aItem->Type() == SCH_BUS_WIRE_ENTRY_T )
1320 {
1321 SCH_BUS_WIRE_ENTRY* busEntry = static_cast<SCH_BUS_WIRE_ENTRY*>( aItem );
1322
1323 if( !busEntry->m_connected_bus_item )
1324 newEvt = SCH_ACTIONS::drawBus.MakeEvent();
1325 }
1326 else if( aItem->Type() == SCH_LINE_T )
1327 {
1328 SCH_LINE* line = static_cast<SCH_LINE*>( aItem );
1329
1330 if( line->IsBus() )
1331 newEvt = SCH_ACTIONS::drawBus.MakeEvent();
1332 else if( line->IsGraphicLine() )
1333 newEvt = SCH_ACTIONS::drawLines.MakeEvent();
1334 }
1335 else if( aItem->Type() == SCH_LABEL_T || aItem->Type() == SCH_HIER_LABEL_T
1336 || aItem->Type() == SCH_SHEET_PIN_T || aItem->Type() == SCH_GLOBAL_LABEL_T )
1337 {
1338 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( aItem );
1339 SCH_CONNECTION possibleConnection( label->Schematic()->ConnectionGraph() );
1340 possibleConnection.ConfigureFromLabel( label->GetShownText( false ) );
1341
1342 if( possibleConnection.IsBus() )
1343 newEvt = SCH_ACTIONS::drawBus.MakeEvent();
1344 }
1345 else if( aItem->Type() == SCH_SYMBOL_T )
1346 {
1347 const SCH_SYMBOL* symbol = static_cast<const SCH_SYMBOL*>( aItem );
1348 const SCH_PIN* pin = symbol->GetPin( pos );
1349
1350 if( !pin || !pin->IsPointClickableAnchor( pos ) )
1351 return OPT_TOOL_EVENT();
1352
1353 if( !pin->IsVisible()
1354 && !( m_frame->eeconfig()->m_Appearance.show_hidden_pins
1355 || m_frame->GetRenderSettings()->m_ShowHiddenPins ) )
1356 {
1357 return OPT_TOOL_EVENT();
1358 }
1359 }
1360
1361 newEvt->SetMousePosition( pos );
1362 newEvt->SetHasPosition( true );
1363 newEvt->SetForceImmediate( true );
1364
1365 getViewControls()->ForceCursorPosition( true, pos );
1366
1367 return newEvt;
1368 }
1369
1370 return OPT_TOOL_EVENT();
1371}
1372
1373
1375{
1376 wxMouseState keyboardState = wxGetMouseState();
1377
1378 setModifiersState( keyboardState.ShiftDown(), keyboardState.ControlDown(),
1379 keyboardState.AltDown() );
1380
1381 m_skip_heuristics = true;
1384 m_skip_heuristics = false;
1385
1386 return 0;
1387}
1388
1389
1390void SCH_SELECTION_TOOL::OnIdle( wxIdleEvent& aEvent )
1391{
1392 if( m_frame->ToolStackIsEmpty() && !m_multiple )
1393 {
1394 wxMouseState keyboardState = wxGetMouseState();
1395
1396 setModifiersState( keyboardState.ShiftDown(), keyboardState.ControlDown(),
1397 keyboardState.AltDown() );
1398
1399 if( m_additive )
1400 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ADD );
1401 else if( m_subtractive )
1402 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::SUBTRACT );
1403 else if( m_exclusive_or )
1404 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::XOR );
1405 else
1406 m_frame->GetCanvas()->SetCurrentCursor( m_nonModifiedCursor );
1407 }
1408}
1409
1410
1415
1416
1418 const std::vector<KICAD_T>& aScanTypes )
1419{
1420 int pixelThreshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
1421 int gridThreshold = KiROUND( getView()->GetGAL()->GetGridSize().EuclideanNorm() / 2.0 );
1422 aCollector.m_Threshold = std::max( pixelThreshold, gridThreshold );
1423 aCollector.m_ShowPinElectricalTypes = m_frame->GetRenderSettings()->m_ShowPinsElectricalType;
1424
1425 if( m_isSymbolEditor )
1426 {
1427 LIB_SYMBOL* symbol = static_cast<SYMBOL_EDIT_FRAME*>( m_frame )->GetCurSymbol();
1428
1429 if( !symbol )
1430 return false;
1431
1432 aCollector.Collect( symbol->GetDrawItems(), aScanTypes, aWhere, m_unit, m_bodyStyle );
1433 }
1434 else
1435 {
1436 aCollector.Collect( m_frame->GetScreen(), aScanTypes, aWhere, m_unit, m_bodyStyle );
1437
1438 // If pins are disabled in the filter, they will be removed later. Let's add the parent
1439 // so that people can use pins to select symbols in this case.
1440 if( !m_filter.pins )
1441 {
1442 int originalCount = aCollector.GetCount();
1443
1444 for( int ii = 0; ii < originalCount; ++ii )
1445 {
1446 if( aCollector[ii]->Type() == SCH_PIN_T )
1447 {
1448 SCH_PIN* pin = static_cast<SCH_PIN*>( aCollector[ii] );
1449
1450 if( !aCollector.HasItem( pin->GetParentSymbol() ) )
1451 aCollector.Append( pin->GetParentSymbol() );
1452 }
1453 }
1454 }
1455 }
1456
1457 return aCollector.GetCount() > 0;
1458}
1459
1460
1462 bool aCheckLocked, bool aSelectedOnly,
1463 SCH_SELECTION_FILTER_OPTIONS* aRejected )
1464{
1465 SYMBOL_EDIT_FRAME* symbolEditorFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
1466
1467 for( int i = collector.GetCount() - 1; i >= 0; --i )
1468 {
1469 if( symbolEditorFrame )
1470 {
1471 // Do not select invisible items if they are not displayed
1472 EDA_ITEM* item = collector[i];
1473
1474 if( item->Type() == SCH_FIELD_T )
1475 {
1476 if( !static_cast<SCH_FIELD*>( item )->IsVisible()
1477 && !symbolEditorFrame->GetShowInvisibleFields() )
1478 {
1479 collector.Remove( i );
1480 continue;
1481 }
1482 }
1483 else if( item->Type() == SCH_PIN_T )
1484 {
1485 if( !static_cast<SCH_PIN*>( item )->IsVisible()
1486 && !symbolEditorFrame->GetShowInvisiblePins() )
1487 {
1488 collector.Remove( i );
1489 continue;
1490 }
1491 }
1492 }
1493
1494 if( !Selectable( collector[i], &aWhere ) )
1495 {
1496 collector.Remove( i );
1497 continue;
1498 }
1499
1500 if( aCheckLocked && collector[i]->IsLocked() )
1501 {
1502 if( aRejected )
1503 aRejected->lockedItems = true;
1504 collector.Remove( i );
1505 continue;
1506 }
1507
1508 if( !itemPassesFilter( collector[i], aRejected ) )
1509 {
1510 collector.Remove( i );
1511 continue;
1512 }
1513
1514 if( aSelectedOnly && !collector[i]->IsSelected() )
1515 {
1516 collector.Remove( i );
1517 continue;
1518 }
1519 }
1520
1521 filterCollectorForHierarchy( collector, false );
1522
1523 // Apply some ugly heuristics to avoid disambiguation menus whenever possible
1524 if( collector.GetCount() > 1 && !m_skip_heuristics )
1525 GuessSelectionCandidates( collector, aWhere );
1526}
1527
1528
1530 EDA_ITEM** aItem, bool* aSelectionCancelledFlag, bool aAdd,
1531 bool aSubtract, bool aExclusiveOr )
1532{
1533 m_selection.ClearReferencePoint();
1534
1535 // If still more than one item we're going to have to ask the user.
1536 if( aCollector.GetCount() > 1 )
1537 {
1538 // Try to call selectionMenu via RunAction() to avoid event-loop contention
1539 // But it we cannot handle the event, then we don't have an active tool loop, so
1540 // handle it directly.
1541 if( !m_toolMgr->RunAction<COLLECTOR*>( ACTIONS::selectionMenu, &aCollector ) )
1542 {
1543 if( !doSelectionMenu( &aCollector ) )
1544 aCollector.m_MenuCancelled = true;
1545 }
1546
1547 if( aCollector.m_MenuCancelled )
1548 {
1549 if( aSelectionCancelledFlag )
1550 *aSelectionCancelledFlag = true;
1551
1552 return false;
1553 }
1554 }
1555
1556 if( !aAdd && !aSubtract && !aExclusiveOr )
1558
1559 // It is possible for slop in the selection model to cause us to be outside the group,
1560 // but also selecting an item within the group, so only exit if the selection doesn't
1561 // have an item belonging to the group
1562 if( m_enteredGroup && !m_enteredGroup->GetBoundingBox().Contains( aWhere ) )
1563 {
1564 bool foundEnteredGroup = false;
1565 for( EDA_ITEM* item : aCollector )
1566 {
1567 if( item->GetParentGroup() == m_enteredGroup )
1568 {
1569 foundEnteredGroup = true;
1570 break;
1571 }
1572 }
1573
1574 if( !foundEnteredGroup )
1575 ExitGroup();
1576 }
1577
1578 filterCollectorForHierarchy( aCollector, true );
1579
1580 int addedCount = 0;
1581 bool anySubtracted = false;
1582
1583 if( aCollector.GetCount() > 0 )
1584 {
1585 for( int i = 0; i < aCollector.GetCount(); ++i )
1586 {
1587 EDA_ITEM_FLAGS flags = 0;
1588 bool isLine = aCollector[i]->Type() == SCH_LINE_T;
1589
1590 // Handle line ends specially
1591 if( isLine )
1592 {
1593 SCH_LINE* line = (SCH_LINE*) aCollector[i];
1594
1595 if( line->GetStartPoint().Distance( aWhere ) <= aCollector.m_Threshold )
1596 flags = STARTPOINT;
1597 else if( line->GetEndPoint().Distance( aWhere ) <= aCollector.m_Threshold )
1598 flags = ENDPOINT;
1599 else
1600 flags = STARTPOINT | ENDPOINT;
1601 }
1602
1603 if( aSubtract
1604 || ( aExclusiveOr && aCollector[i]->IsSelected()
1605 && ( !isLine || ( isLine && aCollector[i]->HasFlag( flags ) ) ) ) )
1606 {
1607 aCollector[i]->ClearFlags( flags );
1608
1609 // Need to update end shadows after ctrl-click unselecting one of two selected
1610 // endpoints.
1611 if( isLine )
1612 getView()->Update( aCollector[i] );
1613
1614 if( !aCollector[i]->HasFlag( STARTPOINT ) && !aCollector[i]->HasFlag( ENDPOINT ) )
1615 {
1616 unselect( aCollector[i] );
1617 anySubtracted = true;
1618 }
1619 }
1620 else
1621 {
1622 aCollector[i]->SetFlags( flags );
1623 select( aCollector[i] );
1624 addedCount++;
1625 }
1626 }
1627 }
1628
1629 if( addedCount == 1 )
1630 {
1631 m_toolMgr->ProcessEvent( EVENTS::PointSelectedEvent );
1632
1633 if( aItem && aCollector.GetCount() == 1 )
1634 *aItem = aCollector[0];
1635
1636 return true;
1637 }
1638 else if( addedCount > 1 )
1639 {
1640 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
1641 return true;
1642 }
1643 else if( anySubtracted )
1644 {
1645 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
1646 return true;
1647 }
1648
1649 m_frame->GetCanvas()->ForceRefresh();
1650 return false;
1651}
1652
1653
1655 const std::vector<KICAD_T>& aScanTypes,
1656 EDA_ITEM** aItem, bool* aSelectionCancelledFlag,
1657 bool aCheckLocked, bool aAdd, bool aSubtract,
1658 bool aExclusiveOr )
1659{
1660 SCH_COLLECTOR collector;
1661
1662 if( !CollectHits( collector, aWhere, aScanTypes ) )
1663 return false;
1664
1665 size_t preFilterCount = collector.GetCount();
1667 rejected.SetAll( false );
1668 narrowSelection( collector, aWhere, aCheckLocked, aSubtract, &rejected );
1669
1670 if( collector.GetCount() == 0 && preFilterCount > 0 )
1671 {
1672 if( SCH_BASE_FRAME* frame = dynamic_cast<SCH_BASE_FRAME*>( m_frame ) )
1673 frame->HighlightSelectionFilter( rejected );
1674
1675 return false;
1676 }
1677
1678 return selectPoint( collector, aWhere, aItem, aSelectionCancelledFlag, aAdd, aSubtract,
1679 aExclusiveOr );
1680}
1681
1682
1684{
1685 SCH_COLLECTOR collection;
1686 m_multiple = true; // Multiple selection mode is active
1687 KIGFX::VIEW* view = getView();
1688
1689 std::vector<EDA_ITEM*> sheetPins;
1690
1691 // Filter the view items based on the selection box
1692 BOX2I selectionBox;
1693
1694 selectionBox.SetMaximum();
1695 view->Query( selectionBox,
1696 [&]( KIGFX::VIEW_ITEM* viewItem ) -> bool
1697 {
1698 SCH_ITEM* item = static_cast<SCH_ITEM*>( viewItem );
1699
1700 if( !item )
1701 return true;
1702
1703 collection.Append( item );
1704 return true;
1705 } );
1706
1707 filterCollectorForHierarchy( collection, true );
1708
1709 // Sheet pins aren't in the view; add them by hand
1710 for( EDA_ITEM* item : collection )
1711 {
1712 SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( item );
1713
1714 if( sheet )
1715 {
1716 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
1717 sheetPins.emplace_back( pin );
1718 }
1719 }
1720
1721 for( EDA_ITEM* pin : sheetPins )
1722 collection.Append( pin );
1723
1724 for( EDA_ITEM* item : collection )
1725 {
1726 if( Selectable( item ) && itemPassesFilter( item, nullptr ) )
1727 {
1728 if( item->Type() == SCH_LINE_T )
1729 item->SetFlags( STARTPOINT | ENDPOINT );
1730
1731 select( item );
1732 }
1733 }
1734
1735 m_multiple = false;
1736
1737 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
1738 m_frame->GetCanvas()->ForceRefresh();
1739 return 0;
1740}
1741
1743{
1744 m_multiple = true; // Multiple selection mode is active
1745 KIGFX::VIEW* view = getView();
1746
1747 // hold all visible items
1748 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> selectedItems;
1749
1750 // Filter the view items based on the selection box
1751 BOX2I selectionBox;
1752
1753 selectionBox.SetMaximum();
1754 view->Query( selectionBox, selectedItems ); // Get the list of selected items
1755
1756 for( KIGFX::VIEW::LAYER_ITEM_PAIR& pair : selectedItems )
1757 {
1758 SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( pair.first );
1759
1760 if( sheet )
1761 {
1762 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
1763 {
1764 EDA_ITEM* item = dynamic_cast<EDA_ITEM*>( pin );
1765
1766 if( item && Selectable( item ) )
1767 unselect( item );
1768 }
1769 }
1770
1771 if( EDA_ITEM* item = dynamic_cast<EDA_ITEM*>( pair.first ) )
1772 {
1773 if( Selectable( item ) )
1774 unselect( item );
1775 }
1776 }
1777
1778 m_multiple = false;
1779
1780 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
1781 m_frame->GetCanvas()->ForceRefresh();
1782 return 0;
1783}
1784
1785
1787{
1788 // Prefer exact hits to sloppy ones
1789 std::set<EDA_ITEM*> exactHits;
1790
1791 for( int i = collector.GetCount() - 1; i >= 0; --i )
1792 {
1793 EDA_ITEM* item = collector[ i ];
1794 SCH_LINE* line = dynamic_cast<SCH_LINE*>( item );
1795 SCH_SHAPE* shape = dynamic_cast<SCH_SHAPE*>( item );
1796 SCH_TABLE* table = dynamic_cast<SCH_TABLE*>( item );
1797
1798 // Lines are hard to hit. Give them a bit more slop to still be considered "exact".
1799 if( line || ( shape && shape->GetShape() == SHAPE_T::POLY )
1800 || ( shape && shape->GetShape() == SHAPE_T::ARC ) )
1801 {
1802 int pixelThreshold = KiROUND( getView()->ToWorld( 6 ) );
1803
1804 if( item->HitTest( aPos, pixelThreshold ) )
1805 exactHits.insert( item );
1806 }
1807 else if( table )
1808 {
1809 // Consider table cells exact, but not the table itself
1810 }
1811 else
1812 {
1813
1814 if( m_frame->GetRenderSettings()->m_ShowPinsElectricalType )
1815 item->SetFlags( SHOW_ELEC_TYPE );
1816
1817 if( item->HitTest( aPos, 0 ) )
1818 exactHits.insert( item );
1819
1820 item->ClearFlags( SHOW_ELEC_TYPE );
1821 }
1822 }
1823
1824 if( exactHits.size() > 0 && exactHits.size() < (unsigned) collector.GetCount() )
1825 {
1826 for( int i = collector.GetCount() - 1; i >= 0; --i )
1827 {
1828 EDA_ITEM* item = collector[ i ];
1829
1830 if( !exactHits.contains( item ) )
1831 collector.Transfer( item );
1832 }
1833 }
1834
1835 // Find the closest item. (Note that at this point all hits are either exact or non-exact.)
1836 SEG poss( aPos, aPos );
1837 EDA_ITEM* closest = nullptr;
1838 int closestDist = INT_MAX / 4;
1839
1840 for( EDA_ITEM* item : collector )
1841 {
1842 BOX2I bbox = item->GetBoundingBox();
1843 int dist = INT_MAX / 4;
1844
1845 // A dominating item is one that would unfairly win distance tests
1846 // and mask out other items. For example, a filled rectangle "wins"
1847 // with a zero distance over anything inside it.
1848 bool dominating = false;
1849
1850 if( exactHits.contains( item ) )
1851 {
1852 if( item->Type() == SCH_PIN_T || item->Type() == SCH_JUNCTION_T )
1853 {
1854 closest = item;
1855 break;
1856 }
1857
1858 SCH_LINE* line = dynamic_cast<SCH_LINE*>( item );
1859 SCH_FIELD* field = dynamic_cast<SCH_FIELD*>( item );
1860 EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( item );
1861 EDA_SHAPE* shape = dynamic_cast<EDA_SHAPE*>( item );
1862 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( item );
1863
1864 if( line )
1865 {
1866 dist = line->GetSeg().Distance( aPos );
1867 }
1868 else if( field )
1869 {
1870 BOX2I box = field->GetBoundingBox();
1871 EDA_ANGLE orient = field->GetTextAngle();
1872
1873 if( field->GetParent() && field->GetParent()->Type() == SCH_SYMBOL_T )
1874 {
1875 if( static_cast<SCH_SYMBOL*>( field->GetParent() )->GetTransform().y1 )
1876 {
1877 if( orient.IsHorizontal() )
1878 orient = ANGLE_VERTICAL;
1879 else
1880 orient = ANGLE_HORIZONTAL;
1881 }
1882 }
1883
1884 field->GetEffectiveTextShape( false, box, orient )->Collide( poss, INT_MAX / 4, &dist );
1885 }
1886 else if( text )
1887 {
1888 text->GetEffectiveTextShape( false )->Collide( poss, INT_MAX / 4, &dist );
1889 }
1890 else if( shape )
1891 {
1892 auto shapes = std::make_shared<SHAPE_COMPOUND>( shape->MakeEffectiveShapesForHitTesting() );
1893
1894 shapes->Collide( poss, INT_MAX / 4, &dist );
1895
1896 // Filled shapes win hit tests anywhere inside them
1897 dominating = shape->IsFilledForHitTesting();
1898 }
1899 else if( symbol )
1900 {
1901 bbox = symbol->GetBodyBoundingBox();
1902
1903 SHAPE_RECT rect( bbox.GetPosition(), bbox.GetWidth(), bbox.GetHeight() );
1904
1905 if( bbox.Contains( aPos ) )
1906 dist = bbox.GetCenter().Distance( aPos );
1907 else
1908 rect.Collide( poss, closestDist, &dist );
1909 }
1910 else
1911 {
1912 dist = bbox.GetCenter().Distance( aPos );
1913 }
1914 }
1915 else
1916 {
1917 SHAPE_RECT rect( bbox.GetPosition(), bbox.GetWidth(), bbox.GetHeight() );
1918 rect.Collide( poss, collector.m_Threshold, &dist );
1919 }
1920
1921 // Don't promote dominating items to be the closest item
1922 // (they'll always win) - they'll still be available for selection, but they
1923 // won't boot out worthy competitors.
1924 if ( !dominating )
1925 {
1926 if( dist == closestDist )
1927 {
1928 if( item->GetParent() == closest )
1929 closest = item;
1930 }
1931 else if( dist < closestDist )
1932 {
1933 closestDist = dist;
1934 closest = item;
1935 }
1936 }
1937 }
1938
1939 // Construct a tight box (1/2 height and width) around the center of the closest item.
1940 // All items which exist at least partly outside this box have sufficient other areas
1941 // for selection and can be dropped.
1942 if( closest ) // Don't try and get a tight bbox if nothing is near the mouse pointer
1943 {
1944 BOX2I tightBox = closest->GetBoundingBox();
1945 tightBox.Inflate( -tightBox.GetWidth() / 4, -tightBox.GetHeight() / 4 );
1946
1947 for( int i = collector.GetCount() - 1; i >= 0; --i )
1948 {
1949 EDA_ITEM* item = collector[i];
1950
1951 if( item == closest )
1952 continue;
1953
1954 if( !item->HitTest( tightBox, true ) )
1955 collector.Transfer( item );
1956 }
1957 }
1958}
1959
1960
1961SCH_SELECTION& SCH_SELECTION_TOOL::RequestSelection( const std::vector<KICAD_T>& aScanTypes,
1962 bool aPromoteCellSelections,
1963 bool aPromoteGroups )
1964{
1965 bool anyUnselected = false;
1966 bool anySelected = false;
1967
1968 if( m_selection.Empty() )
1969 {
1970 VECTOR2D cursorPos = getViewControls()->GetCursorPosition( true );
1971
1973 SelectPoint( cursorPos, aScanTypes );
1974 m_selection.SetIsHover( true );
1975 m_selection.ClearReferencePoint();
1976 }
1977 else // Trim an existing selection by aFilterList
1978 {
1979 bool isMoving = false;
1980
1981 for( int i = (int) m_selection.GetSize() - 1; i >= 0; --i )
1982 {
1983 EDA_ITEM* item = (EDA_ITEM*) m_selection.GetItem( i );
1984 isMoving |= static_cast<SCH_ITEM*>( item )->IsMoving();
1985
1986 if( !item->IsType( aScanTypes ) )
1987 {
1988 unselect( item );
1989 anyUnselected = true;
1990 }
1991 }
1992
1993 if( !isMoving )
1995 }
1996
1997 if( aPromoteGroups )
1998 {
1999 for( int i = (int) m_selection.GetSize() - 1; i >= 0; --i )
2000 {
2001 EDA_ITEM* item = (EDA_ITEM*) m_selection.GetItem( i );
2002
2003 std::set<EDA_ITEM*> selectedChildren;
2004
2005 if( item->Type() == SCH_GROUP_T )
2006 {
2007 static_cast<SCH_ITEM*>(item)->RunOnChildren( [&]( SCH_ITEM* aChild )
2008 {
2009 if( aChild->IsType( aScanTypes ) )
2010 selectedChildren.insert( aChild );
2011 },
2013 unselect( item );
2014 anyUnselected = true;
2015 }
2016
2017 for( EDA_ITEM* child : selectedChildren )
2018 {
2019 if( !child->IsSelected() )
2020 {
2021 if( child->Type() == SCH_LINE_T )
2022 static_cast<SCH_LINE*>( child )->SetFlags( STARTPOINT | ENDPOINT );
2023
2024 select( child );
2025 anySelected = true;
2026 }
2027 }
2028 }
2029 }
2030
2031 if( aPromoteCellSelections )
2032 {
2033 std::set<EDA_ITEM*> parents;
2034
2035 for( int i = (int) m_selection.GetSize() - 1; i >= 0; --i )
2036 {
2037 EDA_ITEM* item = (EDA_ITEM*) m_selection.GetItem( i );
2038
2039 if( item->Type() == SCH_TABLECELL_T )
2040 {
2041 parents.insert( item->GetParent() );
2042 unselect( item );
2043 anyUnselected = true;
2044 }
2045 }
2046
2047 for( EDA_ITEM* parent : parents )
2048 {
2049 if( !parent->IsSelected() )
2050 {
2051 select( parent );
2052 anySelected = true;
2053 }
2054 }
2055 }
2056
2057 if( anyUnselected )
2058 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
2059
2060 if( anySelected )
2061 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
2062
2063 return m_selection;
2064}
2065
2066
2067void SCH_SELECTION_TOOL::filterCollectedItems( SCH_COLLECTOR& aCollector, bool aMultiSelect )
2068{
2069 if( aCollector.GetCount() == 0 )
2070 return;
2071
2072 std::set<EDA_ITEM*> rejected;
2073
2074 for( EDA_ITEM* item : aCollector )
2075 {
2076 if( !itemPassesFilter( item, nullptr ) )
2077 rejected.insert( item );
2078 }
2079
2080 for( EDA_ITEM* item : rejected )
2081 aCollector.Remove( item );
2082}
2083
2084
2086{
2087 if( !aItem )
2088 return false;
2089
2090 if( SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( aItem ) )
2091 {
2092 if( schItem->IsLocked() && !m_filter.lockedItems )
2093 {
2094 if( aRejected )
2095 aRejected->lockedItems = true;
2096
2097 return false;
2098 }
2099 }
2100
2101 switch( aItem->Type() )
2102 {
2103 case SCH_SYMBOL_T:
2104 case SCH_SHEET_T:
2105 if( !m_filter.symbols )
2106 {
2107 if( aRejected )
2108 aRejected->symbols = true;
2109 return false;
2110 }
2111
2112 break;
2113
2114 case SCH_PIN_T:
2115 case SCH_SHEET_PIN_T:
2116 if( !m_filter.pins )
2117 {
2118 if( aRejected )
2119 aRejected->pins = true;
2120 return false;
2121 }
2122
2123 break;
2124
2125 case SCH_JUNCTION_T:
2126 if( !m_filter.wires )
2127 {
2128 if( aRejected )
2129 aRejected->wires = true;
2130 return false;
2131 }
2132
2133 break;
2134
2135 case SCH_LINE_T:
2136 {
2137 switch( static_cast<SCH_LINE*>( aItem )->GetLayer() )
2138 {
2139 case LAYER_WIRE:
2140 case LAYER_BUS:
2141 if( !m_filter.wires )
2142 {
2143 if( aRejected )
2144 aRejected->wires = true;
2145 return false;
2146 }
2147
2148 break;
2149
2150 default:
2151 if( !m_filter.graphics )
2152 {
2153 if( aRejected )
2154 aRejected->graphics = true;
2155 return false;
2156 }
2157 }
2158
2159 break;
2160 }
2161
2162 case SCH_SHAPE_T:
2163 if( !m_filter.graphics )
2164 {
2165 if( aRejected )
2166 aRejected->graphics = true;
2167 return false;
2168 }
2169
2170 break;
2171
2172 case SCH_TEXT_T:
2173 case SCH_TEXTBOX_T:
2174 case SCH_TABLE_T:
2175 case SCH_TABLECELL_T:
2176 case SCH_FIELD_T:
2177 if( !m_filter.text )
2178 {
2179 if( aRejected )
2180 aRejected->text = true;
2181 return false;
2182 }
2183
2184 break;
2185
2186 case SCH_LABEL_T:
2187 case SCH_GLOBAL_LABEL_T:
2188 case SCH_HIER_LABEL_T:
2189 if( !m_filter.labels )
2190 {
2191 if( aRejected )
2192 aRejected->labels = true;
2193 return false;
2194 }
2195
2196 break;
2197
2198 case SCH_BITMAP_T:
2199 if( !m_filter.images )
2200 {
2201 if( aRejected )
2202 aRejected->images = true;
2203 return false;
2204 }
2205
2206 break;
2207
2208 case SCH_RULE_AREA_T:
2209 if( !m_filter.ruleAreas )
2210 {
2211 if( aRejected )
2212 aRejected->ruleAreas = true;
2213 return false;
2214 }
2215
2216 break;
2217
2218 default:
2219 if( !m_filter.otherItems )
2220 {
2221 if( aRejected )
2222 aRejected->otherItems = true;
2223 return false;
2224 }
2225
2226 break;
2227 }
2228
2229 return true;
2230}
2231
2232
2234{
2235 VECTOR2I refP( 0, 0 );
2236
2237 if( m_selection.Size() > 0 )
2238 refP = static_cast<SCH_ITEM*>( m_selection.GetTopLeftItem() )->GetPosition();
2239
2240 m_selection.SetReferencePoint( refP );
2241}
2242
2243
2245{
2247 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::SELECT_LASSO );
2248 m_toolMgr->PostAction( ACTIONS::selectionTool );
2249 return 0;
2250}
2251
2252
2254{
2256 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
2257 m_toolMgr->PostAction( ACTIONS::selectionTool );
2258 return 0;
2259}
2260
2261
2262// Some navigation actions are allowed in selectMultiple
2273
2274
2276{
2277 // Block selection not allowed in symbol viewer frame: no actual code to handle
2278 // a selection, so return to avoid to draw a selection rectangle, and to avoid crashes.
2279 if( m_frame->IsType( FRAME_T::FRAME_SCH_VIEWER ) )
2280 return false;
2281
2282 bool cancelled = false; // Was the tool canceled while it was running?
2283 m_multiple = true; // Multiple selection mode is active
2284 KIGFX::VIEW* view = getView();
2285
2287 view->Add( &area );
2288
2289 while( TOOL_EVENT* evt = Wait() )
2290 {
2291 /* Selection mode depends on direction of drag-selection:
2292 * Left > Right : Select objects that are fully enclosed by selection
2293 * Right > Left : Select objects that are crossed by selection
2294 */
2295 bool isGreedy = area.GetEnd().x < area.GetOrigin().x;
2296
2297 if( view->IsMirroredX() )
2298 isGreedy = !isGreedy;
2299
2300 m_frame->GetCanvas()->SetCurrentCursor( isGreedy ? KICURSOR::SELECT_LASSO
2302
2303 if( evt->IsCancelInteractive() || evt->IsActivate() )
2304 {
2305 cancelled = true;
2306 break;
2307 }
2308
2309 if( evt->IsDrag( BUT_LEFT ) )
2310 {
2313
2314 // Start drawing a selection box
2315 area.SetOrigin( evt->DragOrigin() );
2316 area.SetEnd( evt->Position() );
2319 area.SetExclusiveOr( false );
2322
2323 view->SetVisible( &area, true );
2324 view->Update( &area );
2325 getViewControls()->SetAutoPan( true );
2326 }
2327
2328 if( evt->IsMouseUp( BUT_LEFT ) )
2329 {
2330 getViewControls()->SetAutoPan( false );
2331 view->SetVisible( &area, false );
2332 SelectMultiple( area, m_drag_subtractive, false );
2333 evt->SetPassEvent( false );
2334 break;
2335 }
2336
2337 passEvent( evt, allowedActions );
2338 }
2339
2340 getViewControls()->SetAutoPan( false );
2341
2342 // Stop drawing the selection box
2343 view->Remove( &area );
2344 m_multiple = false; // Multiple selection mode is inactive
2345
2346 if( !cancelled )
2347 m_selection.ClearReferencePoint();
2348
2349 return cancelled;
2350}
2351
2352
2354{
2355 bool cancelled = false;
2356 m_multiple = true;
2358 getView()->Add( &area );
2359 getView()->SetVisible( &area, true );
2360 getViewControls()->SetAutoPan( true );
2361
2362 SHAPE_LINE_CHAIN points;
2363 points.SetClosed( true );
2364
2366 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::SELECT_LASSO );
2367
2368 while( TOOL_EVENT* evt = Wait() )
2369 {
2370 double shapeArea = area.GetPoly().Area( false );
2371 bool isClockwise = shapeArea > 0 ? true : false;
2372
2373 if( getView()->IsMirroredX() && shapeArea != 0 )
2374 isClockwise = !isClockwise;
2375
2376 if( isClockwise )
2377 {
2378 selectionMode = SELECTION_MODE::INSIDE_LASSO;
2379 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::SELECT_WINDOW );
2380 }
2381 else
2382 {
2383 selectionMode = SELECTION_MODE::TOUCHING_LASSO;
2384 m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::SELECT_LASSO );
2385 }
2386
2387 if( evt->IsCancelInteractive() || evt->IsActivate() )
2388 {
2389 cancelled = true;
2390 break;
2391 }
2392 else if( evt->IsDrag( BUT_LEFT )
2393 || evt->IsClick( BUT_LEFT )
2394 || evt->IsAction( &ACTIONS::cursorClick ) )
2395 {
2396 points.Append( evt->Position() );
2397 }
2398 else if( evt->IsDblClick( BUT_LEFT )
2399 || evt->IsAction( &ACTIONS::cursorDblClick )
2400 || evt->IsAction( &ACTIONS::finishInteractive ) )
2401 {
2402 area.GetPoly().GenerateBBoxCache();
2403 SelectMultiple( area, m_drag_subtractive, false );
2404 break;
2405 }
2406 else if( evt->IsAction( &ACTIONS::doDelete )
2407 || evt->IsAction( &ACTIONS::undo ) )
2408 {
2409 if( points.GetPointCount() > 0 )
2410 {
2412 points.Remove( points.GetPointCount() - 1 );
2413 }
2414 }
2415 else
2416 {
2417 passEvent( evt, allowedActions );
2418 }
2419
2420 if( points.PointCount() > 0 )
2421 {
2423 {
2424 if( m_selection.GetSize() > 0 )
2425 {
2426 ClearSelection( true );
2427 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
2428 }
2429 }
2430 }
2431
2432 area.SetPoly( points );
2433 area.GetPoly().Append( m_toolMgr->GetMousePosition() );
2436 area.SetExclusiveOr( false );
2437 area.SetMode( selectionMode );
2438 getView()->Update( &area );
2439 }
2440
2441 getViewControls()->SetAutoPan( false );
2442 getView()->SetVisible( &area, false );
2443 getView()->Remove( &area );
2444 m_multiple = false;
2445
2446 if( !cancelled )
2447 m_selection.ClearReferencePoint();
2448
2449 return cancelled;
2450}
2451
2452
2454 bool aExclusiveOr )
2455{
2456 KIGFX::VIEW* view = getView();
2457
2458 SELECTION_MODE selectionMode = aArea.GetMode();
2459 bool containedMode = ( selectionMode == SELECTION_MODE::INSIDE_RECTANGLE
2460 || selectionMode == SELECTION_MODE::INSIDE_LASSO );
2461 bool boxMode = ( selectionMode == SELECTION_MODE::INSIDE_RECTANGLE
2462 || selectionMode == SELECTION_MODE::TOUCHING_RECTANGLE );
2463
2464 std::vector<KIGFX::VIEW::LAYER_ITEM_PAIR> candidates;
2465 BOX2I selectionRect = aArea.ViewBBox();
2466 view->Query( selectionRect, candidates );
2467
2468 std::set<SCH_ITEM*> uniqueCandidates;
2469
2470 for( const auto& [viewItem, layer] : candidates )
2471 {
2472 if( viewItem->IsSCH_ITEM() )
2473 uniqueCandidates.insert( static_cast<SCH_ITEM*>( viewItem ) );
2474 }
2475
2476 for( KIGFX::VIEW_ITEM* item : uniqueCandidates )
2477 {
2478 if( SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( item ) )
2479 {
2480 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
2481 {
2482 if( boxMode ? selectionRect.Intersects( pin->GetBoundingBox() )
2483 : KIGEOM::BoxHitTest( aArea.GetPoly(), pin->GetBoundingBox(), true ) )
2484 uniqueCandidates.insert( pin );
2485 }
2486 }
2487 else if( SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( item ) )
2488 {
2489 for( SCH_PIN* pin : symbol->GetPins() )
2490 {
2491 if( boxMode ? selectionRect.Intersects( pin->GetBoundingBox() )
2492 : KIGEOM::BoxHitTest( aArea.GetPoly(), pin->GetBoundingBox(), true ) )
2493 uniqueCandidates.insert( pin );
2494 }
2495
2496 for( SCH_FIELD& field : symbol->GetFields() )
2497 {
2498 if( field.IsVisible()
2499 && ( boxMode ? selectionRect.Intersects( field.GetBoundingBox() )
2500 : KIGEOM::BoxHitTest( aArea.GetPoly(), field.GetBoundingBox(), true ) ) )
2501 {
2502 uniqueCandidates.insert( &field );
2503 }
2504 }
2505 }
2506 }
2507
2508 SCH_COLLECTOR collector;
2509 SCH_COLLECTOR pinsCollector;
2510 std::set<EDA_ITEM*> group_items;
2511
2512 for( EDA_ITEM* item : m_frame->GetScreen()->Items().OfType( SCH_GROUP_T ) )
2513 {
2514 SCH_GROUP* group = static_cast<SCH_GROUP*>( item );
2515
2516 if( m_enteredGroup == group )
2517 continue;
2518
2519 std::unordered_set<EDA_ITEM*>& newset = group->GetItems();
2520
2521 auto boxContained =
2522 [&]( const BOX2I& aBox )
2523 {
2524 return boxMode ? selectionRect.Contains( aBox )
2525 : KIGEOM::BoxHitTest( aArea.GetPoly(), aBox, true );
2526 };
2527
2528 if( containedMode && boxContained( group->GetBoundingBox() ) && newset.size() )
2529 {
2530 for( EDA_ITEM* group_item : newset )
2531 {
2532 if( !group_item->IsSCH_ITEM() )
2533 continue;
2534
2535 if( Selectable( static_cast<SCH_ITEM*>( group_item ) ) )
2536 collector.Append( group_item );
2537 }
2538 }
2539
2540 for( EDA_ITEM* group_item : newset )
2541 group_items.emplace( group_item );
2542 }
2543
2544 auto hitTest =
2545 [&]( SCH_ITEM* aItem )
2546 {
2547 return boxMode ? aItem->HitTest( selectionRect, containedMode )
2548 : aItem->HitTest( aArea.GetPoly(), containedMode );
2549 };
2550
2551 for( SCH_ITEM* item : uniqueCandidates )
2552 {
2553 if( Selectable( item ) && ( hitTest( item ) || item->Type() == SCH_LINE_T )
2554 && ( !containedMode || !group_items.count( item ) ) )
2555 {
2556 if( item->Type() == SCH_PIN_T && !m_isSymbolEditor )
2557 pinsCollector.Append( item );
2558 else
2559 collector.Append( item );
2560 }
2561 }
2562
2563 filterCollectedItems( collector, true );
2564 filterCollectorForHierarchy( collector, true );
2565
2566 if( collector.GetCount() == 0 )
2567 {
2568 collector = pinsCollector;
2569 filterCollectedItems( collector, true );
2570 filterCollectorForHierarchy( collector, true );
2571 }
2572
2573 std::sort( collector.begin(), collector.end(),
2574 []( EDA_ITEM* a, EDA_ITEM* b )
2575 {
2576 VECTOR2I aPos = a->GetPosition();
2577 VECTOR2I bPos = b->GetPosition();
2578
2579 if( aPos.y == bPos.y )
2580 return aPos.x < bPos.x;
2581
2582 return aPos.y < bPos.y;
2583 } );
2584
2585 bool anyAdded = false;
2586 bool anySubtracted = false;
2587
2588 auto selectItem =
2589 [&]( EDA_ITEM* aItem, EDA_ITEM_FLAGS flags )
2590 {
2591 if( aSubtractive || ( aExclusiveOr && aItem->IsSelected() ) )
2592 {
2593 if( aExclusiveOr )
2594 aItem->XorFlags( flags );
2595 else
2596 aItem->ClearFlags( flags );
2597
2598 if( !aItem->HasFlag( STARTPOINT ) && !aItem->HasFlag( ENDPOINT ) )
2599 {
2600 unselect( aItem );
2601 anySubtracted = true;
2602 }
2603
2604 if( flags && !anySubtracted )
2605 getView()->Update( aItem );
2606 }
2607 else
2608 {
2609 aItem->SetFlags( flags );
2610 select( aItem );
2611 anyAdded = true;
2612 }
2613 };
2614
2615 std::vector<EDA_ITEM*> flaggedItems;
2616
2617 auto shapeContains =
2618 [&]( const VECTOR2I& aPoint )
2619 {
2620 return boxMode ? selectionRect.Contains( aPoint )
2621 : aArea.GetPoly().PointInside( aPoint );
2622 };
2623
2624 for( EDA_ITEM* item : collector )
2625 {
2626 EDA_ITEM_FLAGS flags = 0;
2627
2628 item->SetFlags( SELECTION_CANDIDATE );
2629 flaggedItems.push_back( item );
2630
2631 if( m_frame->GetRenderSettings()->m_ShowPinsElectricalType )
2632 item->SetFlags( SHOW_ELEC_TYPE );
2633
2634 if( item->Type() == SCH_LINE_T )
2635 {
2636 SCH_LINE* line = static_cast<SCH_LINE*>( item );
2637 bool hits = false;
2638
2639 if( boxMode )
2640 hits = line->HitTest( selectionRect, false );
2641 else
2642 hits = line->HitTest( aArea.GetPoly(), false );
2643
2644 if( ( !containedMode && hits )
2645 || ( shapeContains( line->GetEndPoint() ) && shapeContains( line->GetStartPoint() ) ) )
2646 {
2647 flags |= STARTPOINT | ENDPOINT;
2648 }
2649 else if( containedMode )
2650 {
2651 if( shapeContains( line->GetStartPoint() ) && line->IsStartDangling() )
2652 flags |= STARTPOINT;
2653
2654 if( shapeContains( line->GetEndPoint() ) && line->IsEndDangling() )
2655 flags |= ENDPOINT;
2656 }
2657
2658 if( flags & ( STARTPOINT | ENDPOINT ) )
2659 selectItem( item, flags );
2660 }
2661 else
2662 selectItem( item, flags );
2663
2664 item->ClearFlags( SHOW_ELEC_TYPE );
2665 }
2666
2667 for( EDA_ITEM* item : pinsCollector )
2668 {
2669 if( m_frame->GetRenderSettings()->m_ShowPinsElectricalType )
2670 item->SetFlags( SHOW_ELEC_TYPE );
2671
2672 // If the pin lives inside a group that is already being selected, don't also select the pin.
2673 if( EDA_GROUP* group =
2675 {
2676 if( collector.HasItem( group->AsEdaItem() ) )
2677 {
2678 item->ClearFlags( SHOW_ELEC_TYPE );
2679 continue;
2680 }
2681 }
2682
2683 if( Selectable( item ) && itemPassesFilter( item, nullptr )
2684 && !item->GetParent()->HasFlag( SELECTION_CANDIDATE ) && hitTest( static_cast<SCH_ITEM*>( item ) ) )
2685 {
2686 selectItem( item, 0 );
2687 }
2688
2689 item->ClearFlags( SHOW_ELEC_TYPE );
2690 }
2691
2692 for( EDA_ITEM* item : flaggedItems )
2693 item->ClearFlags( SELECTION_CANDIDATE );
2694
2695 m_selection.SetIsHover( false );
2696
2697 if( anyAdded )
2698 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
2699 else if( anySubtracted )
2700 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
2701}
2702
2703
2705 bool aMultiselect ) const
2706{
2707 std::unordered_set<EDA_ITEM*> toAdd;
2708
2709 // Set SELECTION_CANDIDATE on all parents which are included in the GENERAL_COLLECTOR. This
2710 // algorithm is O(3n), whereas checking for the parent inclusion could potentially be O(n^2).
2711 for( int j = 0; j < aCollector.GetCount(); j++ )
2712 {
2713 if( aCollector[j]->GetParent() )
2714 aCollector[j]->GetParent()->ClearFlags( SELECTION_CANDIDATE );
2715
2716 if( aCollector[j]->GetParentSymbol() )
2717 aCollector[j]->GetParentSymbol()->ClearFlags( SELECTION_CANDIDATE );
2718 }
2719
2720 if( aMultiselect )
2721 {
2722 for( int j = 0; j < aCollector.GetCount(); j++ )
2723 aCollector[j]->SetFlags( SELECTION_CANDIDATE );
2724 }
2725
2726 for( int j = 0; j < aCollector.GetCount(); )
2727 {
2728 SCH_ITEM* item = aCollector[j];
2729 SYMBOL* sym = item->GetParentSymbol();
2730 SCH_ITEM* start = item;
2731
2732 if( !m_isSymbolEditor && sym )
2733 start = sym;
2734
2735 // If a group is entered, disallow selections of objects outside the group.
2737 {
2738 aCollector.Remove( item );
2739 continue;
2740 }
2741
2742 // If any element is a member of a group, replace those elements with the top containing
2743 // group.
2745 {
2746 if( top->AsEdaItem() != item )
2747 {
2748 toAdd.insert( top->AsEdaItem() );
2749 top->AsEdaItem()->SetFlags( SELECTION_CANDIDATE );
2750
2751 aCollector.Remove( item );
2752 continue;
2753 }
2754 }
2755
2756 // Symbols are a bit easier as they can't be nested.
2757 if( sym && ( sym->GetFlags() & SELECTION_CANDIDATE ) )
2758 {
2759 // Remove children of selected items
2760 aCollector.Remove( item );
2761 continue;
2762 }
2763
2764 ++j;
2765 }
2766
2767 for( EDA_ITEM* item : toAdd )
2768 {
2769 if( !aCollector.HasItem( item ) )
2770 aCollector.Append( item );
2771 }
2772}
2773
2774
2776{
2777 if( m_frame && m_frame->GetOverrideLocks() )
2778 return;
2779
2780 std::vector<EDA_ITEM*> toRemove;
2781
2782 for( EDA_ITEM* item : m_selection )
2783 {
2784 if( SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( item ) )
2785 {
2786 bool lockedDescendant = false;
2787
2788 schItem->RunOnChildren(
2789 [&]( SCH_ITEM* child )
2790 {
2791 if( child->IsLocked() )
2792 lockedDescendant = true;
2793 },
2795
2796 if( schItem->IsLocked() || lockedDescendant )
2797 toRemove.push_back( item );
2798 }
2799 }
2800
2801 for( EDA_ITEM* item : toRemove )
2802 RemoveItemFromSel( item, true /* quiet mode */ );
2803}
2804
2805
2807{
2808 getView()->Update( &m_selection );
2810
2811 return 0;
2812}
2813
2814
2816{
2817 for( SCH_TABLECELL* cell : aTable->GetCells() )
2818 {
2819 if( cell->IsSelected() )
2820 cell->SetFlags( SELECTION_CANDIDATE );
2821 else
2822 cell->ClearFlags( SELECTION_CANDIDATE );
2823 }
2824}
2825
2827{
2828 BOX2I selectionRect( start, end );
2829 selectionRect.Normalize();
2830
2831 auto wasSelected = []( EDA_ITEM* aItem )
2832 {
2833 return ( aItem->GetFlags() & SELECTION_CANDIDATE ) > 0;
2834 };
2835
2836 for( SCH_TABLECELL* cell : aTable->GetCells() )
2837 {
2838 bool doSelect = false;
2839
2840 if( cell->HitTest( selectionRect, false ) )
2841 {
2842 if( m_subtractive )
2843 doSelect = false;
2844 else if( m_exclusive_or )
2845 doSelect = !wasSelected( cell );
2846 else
2847 doSelect = true;
2848 }
2849 else if( wasSelected( cell ) )
2850 {
2851 doSelect = m_additive || m_subtractive || m_exclusive_or;
2852 }
2853
2854 if( doSelect && !cell->IsSelected() )
2855 select( cell );
2856 else if( !doSelect && cell->IsSelected() )
2857 unselect( cell );
2858 }
2859}
2860
2862{
2863 bool cancelled = false;
2864 m_multiple = true;
2865
2866 InitializeSelectionState( aTable );
2867
2868 while( TOOL_EVENT* evt = Wait() )
2869 {
2870 if( evt->IsCancelInteractive() || evt->IsActivate() )
2871 {
2872 cancelled = true;
2873 break;
2874 }
2875 else if( evt->IsDrag( BUT_LEFT ) )
2876 {
2877 getViewControls()->SetAutoPan( true );
2878 SelectCellsBetween( evt->DragOrigin(), evt->Position() - evt->DragOrigin(), aTable );
2879 }
2880 else if( evt->IsMouseUp( BUT_LEFT ) )
2881 {
2882 m_selection.SetIsHover( false );
2883
2884 bool anyAdded = false;
2885 bool anySubtracted = false;
2886
2887 for( SCH_TABLECELL* cell : aTable->GetCells() )
2888 {
2889 if( cell->IsSelected() && ( cell->GetFlags() & SELECTION_CANDIDATE ) <= 0 )
2890 anyAdded = true;
2891 else if( ( cell->GetFlags() & SELECTION_CANDIDATE ) > 0 && !cell->IsSelected() )
2892 anySubtracted = true;
2893 }
2894
2895 if( anyAdded )
2896 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
2897 if( anySubtracted )
2898 m_toolMgr->ProcessEvent( EVENTS::UnselectedEvent );
2899
2900 break;
2901 }
2902 else
2903 {
2904 for( int i = 0; allowedActions[i]; ++i )
2905 {
2906 if( evt->IsAction( allowedActions[i] ) )
2907 {
2908 evt->SetPassEvent();
2909 break;
2910 }
2911 }
2912 }
2913 }
2914
2915 getViewControls()->SetAutoPan( false );
2916
2917 m_multiple = false;
2918
2919 if( !cancelled )
2920 m_selection.ClearReferencePoint();
2921
2922 return cancelled;
2923}
2924
2925
2927{
2928 SCH_COLLECTOR collector;
2929
2930 //TODO(snh): Reimplement after exposing KNN interface
2931 int pixelThreshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
2932 int gridThreshold = KiROUND( getView()->GetGAL()->GetGridSize().EuclideanNorm() );
2933 int thresholdMax = std::max( pixelThreshold, gridThreshold );
2934
2935 for( int threshold : { 0, thresholdMax/4, thresholdMax/2, thresholdMax } )
2936 {
2937 collector.m_Threshold = threshold;
2938 collector.Collect( m_frame->GetScreen(), connectedTypes, aPosition );
2939
2940 if( collector.GetCount() > 0 )
2941 break;
2942 }
2943
2944 return collector.GetCount() ? collector[ 0 ] : nullptr;
2945}
2946
2947
2949{
2950 VECTOR2I cursorPos = getViewControls()->GetCursorPosition( false );
2951
2952 SelectPoint( cursorPos, connectedTypes );
2953 return 0;
2954}
2955
2956
2958{
2959 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
2960
2961 if( m_isSymbolEditor || m_isSymbolViewer || !editFrame )
2962 return {};
2963
2964 CONNECTION_GRAPH* graph = editFrame->Schematic().ConnectionGraph();
2965
2966 if( !graph )
2967 return {};
2968
2969 SCH_SHEET_PATH& currentSheet = editFrame->GetCurrentSheet();
2970 std::vector<SCH_ITEM*> startItems;
2971 std::set<SCH_ITEM*> added;
2972
2973 // Build the list of starting items for the connection graph traversal
2974 for( auto item : aItems )
2975 {
2976 if( !item->IsSCH_ITEM() )
2977 continue;
2978
2979 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( item );
2980
2981 // If we're a symbol, start from all its pins
2982 if( schItem->Type() == SCH_SYMBOL_T )
2983 {
2984 for( SCH_PIN* pin : static_cast<SCH_SYMBOL*>( schItem )->GetPins( &currentSheet ) )
2985 {
2986 if( pin )
2987 startItems.push_back( pin );
2988 }
2989 }
2990 else if( schItem->IsConnectable() )
2991 {
2992 startItems.push_back( schItem );
2993 }
2994 }
2995
2996 if( startItems.empty() )
2997 return {};
2998
2999 std::deque<SCH_ITEM*> queue;
3000 std::unordered_set<SCH_ITEM*> visited;
3001
3002 auto enqueue = [&]( SCH_ITEM* aItem )
3003 {
3004 if( !aItem )
3005 return;
3006
3007 if( visited.insert( aItem ).second )
3008 queue.push_back( aItem );
3009 };
3010
3011 for( SCH_ITEM* item : startItems )
3012 enqueue( item );
3013
3014 while( !queue.empty() )
3015 {
3016 SCH_ITEM* item = queue.front();
3017 queue.pop_front();
3018
3019 if( SCH_PIN* pin = dynamic_cast<SCH_PIN*>( item ) )
3020 {
3021 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( pin->GetParent() );
3022
3023 if( symbol && Selectable( symbol ) && itemPassesFilter( symbol, nullptr ) && !symbol->IsSelected() )
3024 added.insert( symbol );
3025 }
3026
3027 const SCH_ITEM_VEC& neighbors = item->ConnectedItems( currentSheet );
3028
3029 for( SCH_ITEM* neighbor : neighbors )
3030 {
3031 if( !neighbor )
3032 continue;
3033
3034 if( neighbor->Type() == SCH_SYMBOL_T )
3035 {
3036 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( neighbor );
3037
3038 if( Selectable( symbol ) && itemPassesFilter( symbol, nullptr ) && !symbol->IsSelected() )
3039 added.insert( symbol );
3040
3041 continue;
3042 }
3043
3044 enqueue( neighbor );
3045 }
3046
3047 if( !Selectable( item ) || !itemPassesFilter( item, nullptr ) )
3048 continue;
3049
3050 added.insert( item );
3051 }
3052
3053 return added;
3054}
3055
3056
3058{
3059 std::set<SCH_ITEM*> added;
3060
3061 for( auto item : aItems )
3062 {
3063 if( !item->IsSCH_ITEM() )
3064 continue;
3065
3066 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( item );
3067
3068 std::set<SCH_ITEM*> conns = m_frame->GetScreen()->MarkConnections( schItem, schItem->IsConnectable() );
3069
3070 // Make sure we don't add things the user has disabled in the selection filter
3071 for( SCH_ITEM* connItem : conns )
3072 {
3073 if( !Selectable( connItem ) || !itemPassesFilter( connItem, nullptr ) )
3074 continue;
3075
3076 added.insert( connItem );
3077 }
3078 }
3079
3080 return added;
3081}
3082
3083
3085{
3087
3088 if( m_selection.Empty() )
3089 return 0;
3090
3091 SCH_SELECTION connectableSelection;
3092 SCH_SELECTION graphicalSelection;
3093
3094 // We need to filter the selection into connectable items (wires, pins, symbols)
3095 // and non-connectable items (shapes, unconnectable lines) for processing
3096 // with the graph or by the graphical are-endpoints-touching method.
3097 for( EDA_ITEM* selItem : originalSelection.GetItems() )
3098 {
3099 if( !selItem->IsSCH_ITEM() )
3100 continue;
3101
3102 SCH_ITEM* item = static_cast<SCH_ITEM*>( selItem );
3103
3104 if( item->Type() == SCH_LINE_T && !item->IsConnectable() )
3105 graphicalSelection.Add( item );
3106 else if( item->Type() == SCH_SHAPE_T )
3107 graphicalSelection.Add( item );
3108 else
3109 connectableSelection.Add( item );
3110 }
3111
3112 ClearSelection( true );
3113
3114 std::set<SCH_ITEM*> graphAdded;
3115 std::set<SCH_ITEM*> graphicalAdded;
3116
3117 if( !connectableSelection.Empty() )
3118 graphAdded = expandConnectionWithGraph( connectableSelection );
3119
3120 if( !graphicalSelection.Empty() )
3121 graphicalAdded = expandConnectionGraphically( graphicalSelection );
3122
3123 // For whatever reason, the connection graph isn't working (e.g. in symbol editor )
3124 // so fall back to graphical expansion for those items if nothing was added.
3125 if( graphAdded.empty() && !connectableSelection.Empty() )
3126 {
3127 SCH_SELECTION combinedSelection = connectableSelection;
3128
3129 for( EDA_ITEM* selItem : graphicalSelection.GetItems() )
3130 combinedSelection.Add( selItem );
3131
3132 graphicalSelection = combinedSelection;
3133 }
3134
3135 graphicalAdded = expandConnectionGraphically( graphicalSelection );
3136
3137 auto smartAddToSel = [&]( EDA_ITEM* aItem )
3138 {
3139 AddItemToSel( aItem, true );
3140
3141 if( aItem->Type() == SCH_LINE_T )
3142 aItem->SetFlags( STARTPOINT | ENDPOINT );
3143 };
3144
3145 // Add everything to the selection, including the original selection
3146 for( auto item : graphAdded )
3147 smartAddToSel( item );
3148
3149 for( auto item : graphicalAdded )
3150 smartAddToSel( item );
3151
3152 for( auto item : originalSelection )
3153 smartAddToSel( item );
3154
3155 m_selection.SetIsHover( originalSelection.IsHover() );
3156
3157 if( originalSelection.HasReferencePoint() )
3158 m_selection.SetReferencePoint( originalSelection.GetReferencePoint() );
3159 else
3160 m_selection.ClearReferencePoint();
3161
3162 getView()->Update( &m_selection );
3163
3164 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
3165
3166 return 0;
3167}
3168
3169
3171{
3172 std::set<std::pair<SCH_TABLE*, int>> columns;
3173 bool added = false;
3174
3175 for( EDA_ITEM* item : m_selection )
3176 {
3177 if( SCH_TABLECELL* cell = dynamic_cast<SCH_TABLECELL*>( item ) )
3178 {
3179 SCH_TABLE* table = static_cast<SCH_TABLE*>( cell->GetParent() );
3180 columns.insert( std::make_pair( table, cell->GetColumn() ) );
3181 }
3182 }
3183
3184 for( auto& [ table, col ] : columns )
3185 {
3186 for( int row = 0; row < table->GetRowCount(); ++row )
3187 {
3188 SCH_TABLECELL* cell = table->GetCell( row, col );
3189
3190 if( !cell->IsSelected() )
3191 {
3192 select( table->GetCell( row, col ) );
3193 added = true;
3194 }
3195 }
3196 }
3197
3198 if( added )
3199 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
3200
3201 return 0;
3202}
3203
3204
3206{
3207 std::set<std::pair<SCH_TABLE*, int>> rows;
3208 bool added = false;
3209
3210 for( EDA_ITEM* item : m_selection )
3211 {
3212 if( SCH_TABLECELL* cell = dynamic_cast<SCH_TABLECELL*>( item ) )
3213 {
3214 SCH_TABLE* table = static_cast<SCH_TABLE*>( cell->GetParent() );
3215 rows.insert( std::make_pair( table, cell->GetRow() ) );
3216 }
3217 }
3218
3219 for( auto& [ table, row ] : rows )
3220 {
3221 for( int col = 0; col < table->GetColCount(); ++col )
3222 {
3223 SCH_TABLECELL* cell = table->GetCell( row, col );
3224
3225 if( !cell->IsSelected() )
3226 {
3227 select( table->GetCell( row, col ) );
3228 added = true;
3229 }
3230 }
3231 }
3232
3233 if( added )
3234 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
3235
3236 return 0;
3237}
3238
3239
3241{
3242 std::set<SCH_TABLE*> tables;
3243 bool added = false;
3244
3245 for( EDA_ITEM* item : m_selection )
3246 {
3247 if( SCH_TABLECELL* cell = dynamic_cast<SCH_TABLECELL*>( item ) )
3248 tables.insert( static_cast<SCH_TABLE*>( cell->GetParent() ) );
3249 }
3250
3252
3253 for( SCH_TABLE* table : tables )
3254 {
3255 if( !table->IsSelected() )
3256 {
3257 select( table );
3258 added = true;
3259 }
3260 }
3261
3262 if( added )
3263 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
3264
3265 return 0;
3266}
3267
3268
3270{
3272 return 0;
3273}
3274
3275
3277{
3278 if( aBBox.GetWidth() == 0 )
3279 return;
3280
3281 BOX2I bbox = aBBox;
3282 bbox.Normalize();
3283
3284 VECTOR2I bbSize = bbox.Inflate( KiROUND( bbox.GetWidth() * 0.2f ) ).GetSize();
3285 VECTOR2D screenSize = getView()->GetViewport().GetSize();
3286
3287 // This code tries to come up with a zoom factor that doesn't simply zoom in to the cross
3288 // probed symbol, but instead shows a reasonable amount of the circuit around it to provide
3289 // context. This reduces the need to manually change the zoom because it's too close.
3290
3291 // Using the default text height as a constant to compare against, use the height of the
3292 // bounding box of visible items for a footprint to figure out if this is a big symbol (like
3293 // a processor) or a small symbol (like a resistor). This ratio is not useful by itself as a
3294 // scaling factor. It must be "bent" to provide good scaling at varying symbol sizes. Bigger
3295 // symbols need less scaling than small ones.
3296 double currTextHeight = schIUScale.MilsToIU( DEFAULT_TEXT_SIZE );
3297
3298 double compRatio = bbSize.y / currTextHeight; // Ratio of symbol to text height
3299 double compRatioBent = 1.0;
3300
3301 // LUT to scale zoom ratio to provide reasonable schematic context. Must work with symbols
3302 // of varying sizes (e.g. 0402 package and 200 pin BGA).
3303 // Each entry represents a compRatio (symbol height / default text height) and an amount to
3304 // scale by.
3305 std::vector<std::pair<double, double>> lut{ { 1.25, 16 },
3306 { 2.5, 12 },
3307 { 5, 8 },
3308 { 6, 6 },
3309 { 10, 4 },
3310 { 20, 2 },
3311 { 40, 1.5 },
3312 { 100, 1 } };
3313
3314 std::vector<std::pair<double, double>>::iterator it;
3315
3316 // Large symbol default is last LUT entry (1:1).
3317 compRatioBent = lut.back().second;
3318
3319 // Use LUT to do linear interpolation of "compRatio" within "first", then use that result to
3320 // linearly interpolate "second" which gives the scaling factor needed.
3321 if( compRatio >= lut.front().first )
3322 {
3323 for( it = lut.begin(); it < lut.end() - 1; ++it )
3324 {
3325 if( it->first <= compRatio && next( it )->first >= compRatio )
3326 {
3327 double diffx = compRatio - it->first;
3328 double diffn = next( it )->first - it->first;
3329
3330 compRatioBent = it->second + ( next( it )->second - it->second ) * diffx / diffn;
3331 break; // We have our interpolated value
3332 }
3333 }
3334 }
3335 else
3336 {
3337 compRatioBent = lut.front().second; // Small symbol default is first entry
3338 }
3339
3340 // This is similar to the original KiCad code that scaled the zoom to make sure symbols were
3341 // visible on screen. It's simply a ratio of screen size to symbol size, and its job is to
3342 // zoom in to make the component fullscreen. Earlier in the code the symbol BBox is given a
3343 // 20% margin to add some breathing room. We compare the height of this enlarged symbol bbox
3344 // to the default text height. If a symbol will end up with the sides clipped, we adjust
3345 // later to make sure it fits on screen.
3346 screenSize.x = std::max( 10.0, screenSize.x );
3347 screenSize.y = std::max( 10.0, screenSize.y );
3348 double ratio = std::max( -1.0, fabs( bbSize.y / screenSize.y ) );
3349
3350 // Original KiCad code for how much to scale the zoom
3351 double kicadRatio = std::max( fabs( bbSize.x / screenSize.x ),
3352 fabs( bbSize.y / screenSize.y ) );
3353
3354 // If the width of the part we're probing is bigger than what the screen width will be after
3355 // the zoom, then punt and use the KiCad zoom algorithm since it guarantees the part's width
3356 // will be encompassed within the screen.
3357 if( bbSize.x > screenSize.x * ratio * compRatioBent )
3358 {
3359 // Use standard KiCad zoom for parts too wide to fit on screen/
3360 ratio = kicadRatio;
3361 compRatioBent = 1.0; // Reset so we don't modify the "KiCad" ratio
3362 wxLogTrace( "CROSS_PROBE_SCALE",
3363 "Part TOO WIDE for screen. Using normal KiCad zoom ratio: %1.5f", ratio );
3364 }
3365
3366 // Now that "compRatioBent" holds our final scaling factor we apply it to the original
3367 // fullscreen zoom ratio to arrive at the final ratio itself.
3368 ratio *= compRatioBent;
3369
3370 bool alwaysZoom = false; // DEBUG - allows us to minimize zooming or not
3371
3372 // Try not to zoom on every cross-probe; it gets very noisy
3373 if( ( ratio < 0.5 || ratio > 1.0 ) || alwaysZoom )
3374 getView()->SetScale( getView()->GetScale() / ratio );
3375}
3376
3377
3378void SCH_SELECTION_TOOL::SyncSelection( const std::optional<SCH_SHEET_PATH>& targetSheetPath,
3379 SCH_ITEM* focusItem, const std::vector<SCH_ITEM*>& items )
3380{
3381 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
3382
3383 if( !editFrame )
3384 return;
3385
3386 double targetZoom = 0.0;
3387 VECTOR2D targetCenter;
3388 bool targetZoomValid = false;
3389 bool changedSheet = false;
3390
3391 if( targetSheetPath )
3392 {
3393 SCH_SHEET_PATH path = targetSheetPath.value();
3394
3395 if( SCH_SCREEN* screen = path.LastScreen() )
3396 {
3397 targetZoom = screen->m_LastZoomLevel;
3398 targetCenter = screen->m_ScrollCenter;
3399 targetZoomValid = screen->IsZoomInitialized();
3400 }
3401
3402 if( path != editFrame->Schematic().CurrentSheet() )
3403 {
3404 m_frame->GetToolManager()->RunAction<SCH_SHEET_PATH*>( SCH_ACTIONS::changeSheet, &path );
3405 changedSheet = true;
3406 }
3407 }
3408
3409 if( changedSheet && targetZoomValid && !m_frame->eeconfig()->m_CrossProbing.zoom_to_fit )
3410 {
3411 getView()->SetScale( targetZoom );
3412 getView()->SetCenter( targetCenter );
3413 }
3414
3415 ClearSelection( items.size() > 0 ? true /*quiet mode*/ : false );
3416
3417 // Perform individual selection of each item before processing the event.
3418 for( SCH_ITEM* item : items )
3419 {
3420 SCH_ITEM* parent = dynamic_cast<SCH_ITEM*>( item->GetParent() );
3421
3422 // Make sure we only select items on the current screen
3423 if( m_frame->GetScreen()->CheckIfOnDrawList( item )
3424 || ( parent && m_frame->GetScreen()->CheckIfOnDrawList( parent ) ) )
3425 {
3426 select( item );
3427 }
3428 }
3429
3430 BOX2I bbox = m_selection.GetBoundingBox();
3431
3432 if( bbox.GetWidth() != 0 && bbox.GetHeight() != 0 )
3433 {
3434 if( m_frame->eeconfig()->m_CrossProbing.center_on_items )
3435 {
3436 if( m_frame->eeconfig()->m_CrossProbing.zoom_to_fit )
3437 ZoomFitCrossProbeBBox( bbox );
3438
3439 editFrame->FocusOnItem( focusItem );
3440
3441 if( !focusItem )
3442 editFrame->FocusOnLocation( bbox.Centre() );
3443 }
3444 }
3445
3446 if( m_selection.Size() > 0 )
3447 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
3448}
3449
3450
3452{
3453 m_selection.Clear();
3454
3455 bool enteredGroupFound = false;
3456
3457 if( m_isSymbolEditor )
3458 {
3459 LIB_SYMBOL* start = static_cast<SYMBOL_EDIT_FRAME*>( m_frame )->GetCurSymbol();
3460
3461 for( SCH_ITEM& item : start->GetDrawItems() )
3462 {
3463 if( item.IsSelected() )
3464 select( &item );
3465
3466 if( item.Type() == SCH_GROUP_T )
3467 {
3468 if( &item == m_enteredGroup )
3469 {
3470 item.SetFlags( ENTERED );
3471 enteredGroupFound = true;
3472 }
3473 else
3474 {
3475 item.ClearFlags( ENTERED );
3476 }
3477 }
3478 }
3479 }
3480 else
3481 {
3482 for( SCH_ITEM* item : m_frame->GetScreen()->Items() )
3483 {
3484 // If the field and symbol are selected, only use the symbol
3485 if( item->IsSelected() )
3486 {
3487 select( item );
3488 }
3489 else
3490 {
3491 item->RunOnChildren(
3492 [&]( SCH_ITEM* aChild )
3493 {
3494 if( aChild->IsSelected() )
3495 select( aChild );
3496 },
3498 }
3499
3500 if( item->Type() == SCH_GROUP_T )
3501 {
3502 if( item == m_enteredGroup )
3503 {
3504 item->SetFlags( ENTERED );
3505 enteredGroupFound = true;
3506 }
3507 else
3508 {
3509 item->ClearFlags( ENTERED );
3510 }
3511 }
3512 }
3513 }
3514
3516
3517 if( !enteredGroupFound )
3518 {
3519 m_enteredGroupOverlay.Clear();
3520 m_enteredGroup = nullptr;
3521 }
3522
3523 // Inform other potentially interested tools
3524 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
3525}
3526
3527
3528bool SCH_SELECTION_TOOL::Selectable( const EDA_ITEM* aItem, const VECTOR2I* aPos,
3529 bool checkVisibilityOnly ) const
3530{
3531 // NOTE: in the future this is where Eeschema layer/itemtype visibility will be handled
3532
3533 SYMBOL_EDIT_FRAME* symEditFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
3534
3535 // Do not allow selection of anything except fields when the current symbol in the symbol
3536 // editor is a derived symbol.
3537 if( symEditFrame && symEditFrame->IsSymbolAlias() && aItem->Type() != SCH_FIELD_T )
3538 return false;
3539
3540 switch( aItem->Type() )
3541 {
3542 case SCH_PIN_T:
3543 {
3544 const SCH_PIN* pin = static_cast<const SCH_PIN*>( aItem );
3545
3546 if( symEditFrame )
3547 {
3548 if( pin->GetUnit() && pin->GetUnit() != symEditFrame->GetUnit() )
3549 return false;
3550
3551 if( pin->GetBodyStyle() && pin->GetBodyStyle() != symEditFrame->GetBodyStyle() )
3552 return false;
3553 }
3554
3555 if( !pin->IsVisible() && !m_frame->GetShowAllPins() )
3556 return false;
3557
3558 if( !m_filter.pins )
3559 {
3560 // Pin anchors have to be allowed for auto-starting wires.
3561 if( aPos )
3562 {
3564 GRID_HELPER_GRIDS pinGrid = grid.GetItemGrid( pin );
3565
3566 if( pin->IsPointClickableAnchor( grid.BestSnapAnchor( *aPos, pinGrid ) ) )
3567 return true;
3568 }
3569
3570 return false;
3571 }
3572
3573 break;
3574 }
3575
3577 if( !m_frame->eeconfig()->m_Appearance.show_directive_labels )
3578 return false;
3579
3580 break;
3581
3582 case LIB_SYMBOL_T: // In symbol_editor we do not want to select the symbol itself.
3583 return false;
3584
3585 case SCH_FIELD_T: // SCH_FIELD objects are not unit/body-style-specific.
3586 {
3587 const SCH_FIELD* field = static_cast<const SCH_FIELD*>( aItem );
3588
3589 if( !field->IsVisible() && !( symEditFrame && symEditFrame->GetShowInvisibleFields() ) )
3590 return false;
3591
3592 break;
3593 }
3594
3595 case SCH_SHAPE_T:
3596 case SCH_TEXT_T:
3597 case SCH_TEXTBOX_T:
3598 if( symEditFrame )
3599 {
3600 const SCH_ITEM* sch_item = static_cast<const SCH_ITEM*>( aItem );
3601
3602 if( sch_item->GetUnit() && sch_item->GetUnit() != symEditFrame->GetUnit() )
3603 return false;
3604
3605 if( sch_item->GetBodyStyle() && sch_item->GetBodyStyle() != symEditFrame->GetBodyStyle() )
3606 return false;
3607 }
3608
3609 break;
3610
3611 case SCH_MARKER_T: // Always selectable
3612 return true;
3613
3614 case SCH_TABLECELL_T:
3615 {
3616 const SCH_TABLECELL* cell = static_cast<const SCH_TABLECELL*>( aItem );
3617
3618 if( cell->GetColSpan() == 0 || cell->GetRowSpan() == 0 )
3619 return false;
3620
3621 break;
3622 }
3623
3624 case NOT_USED: // Things like CONSTRUCTION_GEOM that aren't part of the model
3625 return false;
3626
3627 default: // Suppress warnings
3628 break;
3629 }
3630
3631 return true;
3632}
3633
3634
3636{
3637 if( m_selection.Empty() )
3638 return;
3639
3640 while( m_selection.GetSize() )
3642
3643 getView()->Update( &m_selection );
3644
3645 m_selection.SetIsHover( false );
3646 m_selection.ClearReferencePoint();
3647
3648 // Inform other potentially interested tools
3649 if( !aQuietMode )
3650 m_toolMgr->ProcessEvent( EVENTS::ClearedEvent );
3651}
3652
3653
3655{
3656 // Don't group when we select new items, the schematic editor selects all new items for moving.
3657 // The PCB editor doesn't need this logic because it doesn't select new items for moving.
3658 if( m_enteredGroup && !aItem->IsNew()
3659 && !SCH_GROUP::WithinScope( static_cast<SCH_ITEM*>( aItem ), m_enteredGroup, m_isSymbolEditor ) )
3660 {
3661 ExitGroup();
3662 }
3663
3664 highlight( aItem, SELECTED, &m_selection );
3665}
3666
3667
3669{
3670 unhighlight( aItem, SELECTED, &m_selection );
3671}
3672
3673
3674void SCH_SELECTION_TOOL::highlight( EDA_ITEM* aItem, int aMode, SELECTION* aGroup )
3675{
3676 if( aMode == SELECTED )
3677 aItem->SetSelected();
3678 else if( aMode == BRIGHTENED )
3679 aItem->SetBrightened();
3680
3681 if( aGroup )
3682 aGroup->Add( aItem );
3683
3684 // Highlight pins and fields. (All the other symbol children are currently only
3685 // represented in the LIB_SYMBOL and will inherit the settings of the parent symbol.)
3686 if( SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( aItem ) )
3687 {
3688 // We don't want to select group children if the group itself is selected,
3689 // we can only select them when the group is entered
3690 if( sch_item->Type() != SCH_GROUP_T )
3691 {
3692 sch_item->RunOnChildren(
3693 [&]( SCH_ITEM* aChild )
3694 {
3695 if( aMode == SELECTED )
3696 {
3697 aChild->SetSelected();
3698 getView()->Hide( aChild, true );
3699 }
3700 else if( aMode == BRIGHTENED )
3701 {
3702 aChild->SetBrightened();
3703 }
3704 },
3706 }
3707 }
3708
3709 if( aGroup && aMode != BRIGHTENED )
3710 getView()->Hide( aItem, true );
3711
3712 if( aItem->GetParent() && aItem->GetParent()->Type() != SCHEMATIC_T )
3713 getView()->Update( aItem->GetParent(), KIGFX::REPAINT );
3714
3715 getView()->Update( aItem, KIGFX::REPAINT );
3716}
3717
3718
3719void SCH_SELECTION_TOOL::unhighlight( EDA_ITEM* aItem, int aMode, SELECTION* aGroup )
3720{
3721 if( aMode == SELECTED )
3722 {
3723 aItem->ClearSelected();
3724 // Lines need endpoints cleared here
3725 if( aItem->Type() == SCH_LINE_T )
3726 aItem->ClearFlags( STARTPOINT | ENDPOINT );
3727
3728 if( aMode != BRIGHTENED )
3729 getView()->Hide( aItem, false );
3730 }
3731 else if( aMode == BRIGHTENED )
3732 {
3733 aItem->ClearBrightened();
3734 }
3735
3736 if( aGroup )
3737 aGroup->Remove( aItem );
3738
3739 // Unhighlight pins and fields. (All the other symbol children are currently only
3740 // represented in the LIB_SYMBOL.)
3741 if( SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( aItem ) )
3742 {
3743 sch_item->RunOnChildren(
3744 [&]( SCH_ITEM* aChild )
3745 {
3746 if( aMode == SELECTED )
3747 {
3748 aChild->ClearSelected();
3749 getView()->Hide( aChild, false );
3750 }
3751 else if( aMode == BRIGHTENED )
3752 {
3753 aChild->ClearBrightened();
3754 }
3755
3756 if( aGroup )
3757 aGroup->Remove( aChild );
3758 },
3760 }
3761
3762 if( aItem->GetParent() && aItem->GetParent()->Type() != SCHEMATIC_T )
3763 getView()->Update( aItem->GetParent(), KIGFX::REPAINT );
3764
3765 getView()->Update( aItem, KIGFX::REPAINT );
3766}
3767
3768
3770{
3771 const unsigned GRIP_MARGIN = 20;
3772 int margin = KiROUND( getView()->ToWorld( GRIP_MARGIN ) );
3773
3774 // Check if the point is located within any of the currently selected items bounding boxes
3775 for( EDA_ITEM* item : m_selection )
3776 {
3777 BOX2I itemBox = item->ViewBBox();
3778 itemBox.Inflate( margin ); // Give some margin for gripping an item
3779
3780 if( itemBox.Contains( aPoint ) )
3781 return true;
3782 }
3783
3784 return false;
3785}
3786
3787
3789{
3790 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
3791
3792 if( !editFrame || !editFrame->GetNetNavigator() || m_selection.Size() == 0 )
3793 return 0;
3794
3795 if( !m_selection.Front()->IsBrightened() )
3796 return 0;
3797
3798 const SCH_ITEM* item = editFrame->SelectNextPrevNetNavigatorItem( true );
3799
3800 if( item )
3801 {
3803 select( const_cast<SCH_ITEM*>( item ) );
3804 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
3805 }
3806
3807 return 0;
3808}
3809
3810
3812{
3813 SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
3814
3815 if( !editFrame || !editFrame->GetNetNavigator() || m_selection.Size() == 0 )
3816 return 0;
3817
3818 if( !m_selection.Front()->IsBrightened() )
3819 return 0;
3820
3821 const SCH_ITEM* item = editFrame->SelectNextPrevNetNavigatorItem( false );
3822
3823 if( item )
3824 {
3826 select( const_cast<SCH_ITEM*>( item ) );
3827 m_toolMgr->ProcessEvent( EVENTS::SelectedEvent );
3828 }
3829
3830 return 0;
3831}
3832
3833
3835{
3837
3844
3846
3849
3855
3858
3861
3864
3866}
constexpr EDA_IU_SCALE schIUScale
Definition base_units.h:114
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition box2.h:990
static TOOL_ACTION unselectAll
Definition actions.h:83
static TOOL_ACTION selectItem
Select an item (specified as the event parameter).
Definition actions.h:227
static TOOL_ACTION cursorLeft
Definition actions.h:172
static TOOL_ACTION zoomOutCenter
Definition actions.h:136
static TOOL_ACTION unselectItem
Definition actions.h:228
static TOOL_ACTION zoomIn
Definition actions.h:133
static TOOL_ACTION cursorLeftFast
Definition actions.h:177
static TOOL_ACTION selectSetLasso
Definition actions.h:221
static TOOL_ACTION selectSetRect
Set lasso selection mode.
Definition actions.h:220
static TOOL_ACTION groupEnter
Definition actions.h:243
static TOOL_ACTION selectColumns
Definition actions.h:102
static TOOL_ACTION cursorDown
Definition actions.h:171
static TOOL_ACTION zoomOut
Definition actions.h:134
static TOOL_ACTION cursorRightFast
Definition actions.h:178
static TOOL_ACTION zoomCenter
Definition actions.h:141
static TOOL_ACTION panDown
Definition actions.h:185
static TOOL_ACTION cursorDblClick
Definition actions.h:181
static TOOL_ACTION undo
Definition actions.h:75
static TOOL_ACTION selectionActivate
Activation of the selection tool.
Definition actions.h:214
static TOOL_ACTION cursorDownFast
Definition actions.h:176
static TOOL_ACTION selectionMenu
Run a selection menu to select from a list of items.
Definition actions.h:236
static TOOL_ACTION selectRows
Definition actions.h:101
static TOOL_ACTION cursorUpFast
Definition actions.h:175
static TOOL_ACTION panLeft
Definition actions.h:186
static TOOL_ACTION updateMenu
Definition actions.h:270
static TOOL_ACTION doDelete
Definition actions.h:85
static TOOL_ACTION selectionTool
Definition actions.h:251
static TOOL_ACTION cursorClick
Definition actions.h:180
static TOOL_ACTION zoomFitScreen
Definition actions.h:142
static TOOL_ACTION increment
Definition actions.h:94
static TOOL_ACTION selectionClear
Clear the current selection.
Definition actions.h:224
static TOOL_ACTION panUp
Definition actions.h:184
static TOOL_ACTION zoomFitObjects
Definition actions.h:143
static TOOL_ACTION zoomInCenter
Definition actions.h:135
static TOOL_ACTION panRight
Definition actions.h:187
static TOOL_ACTION selectTable
Definition actions.h:103
static TOOL_ACTION cursorUp
Cursor control with keyboard.
Definition actions.h:170
static TOOL_ACTION groupLeave
Definition actions.h:244
static TOOL_ACTION finishInteractive
Definition actions.h:73
static TOOL_ACTION cursorRight
Definition actions.h:173
static TOOL_ACTION selectAll
Definition actions.h:82
static TOOL_ACTION unselectItems
Definition actions.h:233
static TOOL_ACTION selectItems
Select a list of items (specified as the event parameter)
Definition actions.h:232
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
constexpr const Vec & GetPosition() const
Definition box2.h:211
constexpr void SetMaximum()
Definition box2.h:80
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition box2.h:558
constexpr BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
Definition box2.h:146
constexpr size_type GetWidth() const
Definition box2.h:214
constexpr Vec Centre() const
Definition box2.h:97
constexpr const Vec GetCenter() const
Definition box2.h:230
constexpr size_type GetHeight() const
Definition box2.h:215
constexpr bool Contains(const Vec &aPoint) const
Definition box2.h:168
constexpr const SizeVec & GetSize() const
Definition box2.h:206
constexpr bool Intersects(const BOX2< Vec > &aRect) const
Definition box2.h:311
An abstract class that will find and hold all the objects according to an inspection done by the Insp...
Definition collector.h:49
void Transfer(int aIndex)
Move the item at aIndex (first position is 0) to the backup list.
Definition collector.h:153
bool m_MenuCancelled
Definition collector.h:239
ITER begin()
Definition collector.h:75
int GetCount() const
Return the number of objects in the list.
Definition collector.h:83
bool HasItem(const EDA_ITEM *aItem) const
Tests if aItem has already been collected.
Definition collector.h:197
void Remove(int aIndex)
Remove the item at aIndex (first position is 0).
Definition collector.h:111
int m_Threshold
Definition collector.h:236
ITER end()
Definition collector.h:76
void Append(EDA_ITEM *item)
Add an item to the end of the list.
Definition collector.h:101
COMMIT & Added(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
Definition commit.h:84
bool Empty() const
Definition commit.h:137
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Add a new item to the model.
Definition commit.h:78
Calculate the connectivity of a schematic and generates netlists.
bool IsHorizontal() const
Definition eda_angle.h:142
void FocusOnLocation(const VECTOR2I &aPos, bool aAllowScroll=true)
Useful to focus on a particular location, in find functions.
A set of EDA_ITEMs (i.e., without duplicates).
Definition eda_group.h:46
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:100
virtual VECTOR2I GetPosition() const
Definition eda_item.h:279
void SetIsRollover(bool aIsRollover, const VECTOR2I &aMousePos)
Definition eda_item.h:135
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition eda_item.cpp:120
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition eda_item.h:149
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:112
void ClearSelected()
Definition eda_item.h:144
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition eda_item.h:151
bool IsSelected() const
Definition eda_item.h:129
void SetSelected()
Definition eda_item.h:141
virtual bool IsType(const std::vector< KICAD_T > &aScanTypes) const
Check whether the item is one of the listed types.
Definition eda_item.h:199
void ClearBrightened()
Definition eda_item.h:145
void SetBrightened()
Definition eda_item.h:142
virtual bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const
Test if aPosition is inside or on the boundary of this item.
Definition eda_item.h:240
EDA_ITEM * GetParent() const
Definition eda_item.h:114
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
Definition eda_item.h:153
void XorFlags(EDA_ITEM_FLAGS aMask)
Definition eda_item.h:150
EDA_ITEM_FLAGS GetFlags() const
Definition eda_item.h:152
bool IsNew() const
Definition eda_item.h:126
SHAPE_T GetShape() const
Definition eda_shape.h:181
virtual bool IsFilledForHitTesting() const
Definition eda_shape.h:143
virtual std::vector< SHAPE * > MakeEffectiveShapesForHitTesting() const
Definition eda_shape.h:395
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition eda_text.h:91
const EDA_ANGLE & GetTextAngle() const
Definition eda_text.h:158
virtual bool IsVisible() const
Definition eda_text.h:198
std::shared_ptr< SHAPE_COMPOUND > GetEffectiveTextShape(bool aTriangulate=true, const BOX2I &aBBox=BOX2I(), const EDA_ANGLE &aAngle=ANGLE_0) const
build a list of segments (SHAPE_SEGMENT) to describe a text shape.
GRID_HELPER_GRIDS GetItemGrid(const EDA_ITEM *aItem) const override
Get the coarsest grid that applies to an item.
VECTOR2I BestSnapAnchor(const VECTOR2I &aOrigin, GRID_HELPER_GRIDS aGrid, SCH_ITEM *aSkip)
static const TOOL_EVENT DisambiguatePoint
Used for hotkey feedback.
Definition actions.h:362
static const TOOL_EVENT ClearedEvent
Definition actions.h:347
static const TOOL_EVENT SelectedEvent
Definition actions.h:345
static const TOOL_EVENT SelectedItemsModified
Selected items were moved, this can be very high frequency on the canvas, use with care.
Definition actions.h:352
static const TOOL_EVENT PointSelectedEvent
Definition actions.h:344
static const TOOL_EVENT SelectedItemsMoved
Used to inform tools that the selection should temporarily be non-editable.
Definition actions.h:355
static const TOOL_EVENT UnselectedEvent
Definition actions.h:346
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
Represent a selection area (currently a rectangle) in a VIEW, drawn corner-to-corner between two poin...
void SetMode(SELECTION_MODE aMode)
void SetSubtractive(bool aSubtractive)
SELECTION_MODE GetMode() const
void SetAdditive(bool aAdditive)
void SetPoly(SHAPE_LINE_CHAIN &aPoly)
void SetOrigin(const VECTOR2I &aOrigin)
const BOX2I ViewBBox() const override
Set the origin of the rectangle (the fixed corner)
SHAPE_LINE_CHAIN & GetPoly()
void SetExclusiveOr(bool aExclusiveOr)
void SetEnd(const VECTOR2I &aEnd)
Set the current end of the rectangle (the corner that moves with the cursor.
void SetHighlight(bool aEnabled, int aNetcode=-1, bool aMulti=false)
Turns on/off highlighting.
An interface for classes handling user events controlling the view behavior such as zooming,...
virtual void CaptureCursor(bool aEnabled)
Force the cursor to stay within the drawing panel area.
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Place the cursor immediately at a given point.
virtual void WarpMouseCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
If enabled (.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false, long aArrowCommand=0)=0
Move cursor to the requested position expressed in world coordinates.
virtual void SetAutoPan(bool aEnabled)
Turn on/off auto panning (this feature is used when there is a tool active (eg.
An abstract base class for deriving all objects that can be added to a VIEW.
Definition view_item.h:86
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition view.h:67
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition view.cpp:598
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Set the scaling factor, zooming around a given anchor point.
Definition view.cpp:638
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition view.cpp:301
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition view.cpp:405
int Query(const BOX2I &aRect, std::vector< LAYER_ITEM_PAIR > &aResult) const
Find all visible items that touch or are within the rectangle aRect.
Definition view.cpp:488
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition view.cpp:1809
bool IsMirroredX() const
Return true if view is flipped across the X axis.
Definition view.h:259
std::pair< VIEW_ITEM *, int > LAYER_ITEM_PAIR
Definition view.h:71
void Hide(VIEW_ITEM *aItem, bool aHide=true, bool aHideOverlay=false)
Temporarily hide the item in the view (e.g.
Definition view.cpp:1757
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition view.h:229
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition view.cpp:664
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Set the item visibility.
Definition view.cpp:1736
Definition kiid.h:48
Define a library symbol object.
Definition lib_symbol.h:83
bool IsPower() const override
bool IsMultiBodyStyle() const override
Definition lib_symbol.h:774
LIB_ITEMS_CONTAINER & GetDrawItems()
Return a reference to the draw item list.
Definition lib_symbol.h:712
int GetUnitCount() const override
bool IsExcluded() const
Definition marker_base.h:93
Tree view item data for the net navigator.
CONNECTION_GRAPH * ConnectionGraph() const
Definition schematic.h:200
SCH_SHEET & Root() const
Definition schematic.h:133
SCH_SHEET_PATH & CurrentSheet() const
Definition schematic.h:188
static TOOL_ACTION placeClassLabel
Definition sch_actions.h:79
static TOOL_ACTION placeSheetPin
Definition sch_actions.h:85
static TOOL_ACTION placeNextSymbolUnit
Definition sch_actions.h:67
static TOOL_ACTION swapPins
static TOOL_ACTION saveToLinkedDesignBlock
Definition sch_actions.h:71
static TOOL_ACTION clearHighlight
static TOOL_ACTION placeGlobalLabel
Definition sch_actions.h:80
static TOOL_ACTION pinTable
static TOOL_ACTION navigateBack
static TOOL_ACTION properties
static TOOL_ACTION leaveSheet
static TOOL_ACTION breakWire
static TOOL_ACTION findNetInInspector
static TOOL_ACTION autoplaceAllSheetPins
Definition sch_actions.h:86
static TOOL_ACTION drawLines
Definition sch_actions.h:99
static TOOL_ACTION placeHierLabel
Definition sch_actions.h:81
static TOOL_ACTION selectConnection
If current selection is a wire or bus, expand to entire connection.
Definition sch_actions.h:51
static TOOL_ACTION placeLabel
Definition sch_actions.h:78
static TOOL_ACTION nextNetItem
static TOOL_ACTION drawWire
Definition sch_actions.h:72
static TOOL_ACTION drag
static TOOL_ACTION placeJunction
Definition sch_actions.h:76
static TOOL_ACTION previousNetItem
static TOOL_ACTION swapUnitLabels
static TOOL_ACTION navigateForward
static TOOL_ACTION placeLinkedDesignBlock
Definition sch_actions.h:70
static TOOL_ACTION selectNode
Select the junction, wire or bus segment under the cursor.
Definition sch_actions.h:47
static TOOL_ACTION unfoldBus
Definition sch_actions.h:74
static TOOL_ACTION drawBus
Definition sch_actions.h:73
static TOOL_ACTION symbolProperties
static TOOL_ACTION slice
static TOOL_ACTION changeSheet
static TOOL_ACTION assignNetclass
static TOOL_ACTION swapPinLabels
static TOOL_ACTION enterSheet
static TOOL_ACTION editPageNumber
static TOOL_ACTION selectOnPCB
static TOOL_ACTION move
static TOOL_ACTION syncSheetPins
Definition sch_actions.h:89
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Class for a wire to bus entry.
SCH_ITEM * m_connected_bus_item
Pointer to the bus item (usually a bus wire) connected to this bus-wire entry, if it is connected to ...
void Collect(SCH_SCREEN *aScreen, const std::vector< KICAD_T > &aScanTypes, const VECTOR2I &aPos, int aUnit=0, int aBodyStyle=0)
Scan a EDA_ITEM using this class's Inspector method which does the collection.
bool m_ShowPinElectricalTypes
static const std::vector< KICAD_T > MovableItems
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Execute the changes.
virtual void Revert() override
Revert the commit by restoring the modified items state.
static SELECTION_CONDITION SingleMultiFunctionPin
static SELECTION_CONDITION SingleSymbol
static SELECTION_CONDITION MultipleSymbolsOrPower
static SELECTION_CONDITION HasLockedItems
static SELECTION_CONDITION AllPinsOrSheetPins
static SELECTION_CONDITION SingleSymbolOrPower
static SELECTION_CONDITION HasUnlockedItems
static SELECTION_CONDITION SingleNonExcludedMarker
static SELECTION_CONDITION SingleMultiUnitSymbol
static SELECTION_CONDITION SingleMultiBodyStyleSymbol
static SELECTION_CONDITION AllPins
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
void ConfigureFromLabel(const wxString &aLabel)
Configures the connection given a label.
bool IsBus() const
Handle actions specific to the schematic editor.
Schematic editor (Eeschema) main window.
void FocusOnItem(EDA_ITEM *aItem, bool aAllowScroll=true) override
Focus on a particular canvas item.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
const SCH_ITEM * SelectNextPrevNetNavigatorItem(bool aNext)
const wxString & GetHighlightedConnection() const
wxGenericTreeCtrl * GetNetNavigator()
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
A set of SCH_ITEMs (i.e., without duplicates).
Definition sch_group.h:52
static bool WithinScope(SCH_ITEM *aItem, SCH_GROUP *aScope, bool isSymbolEditor)
static EDA_GROUP * TopLevelGroup(SCH_ITEM *aItem, EDA_GROUP *aScope, bool isSymbolEditor)
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:168
virtual bool IsConnectable() const
Definition sch_item.h:530
virtual bool HasHoveredHypertext() const
Indicates that a hypertext link is currently active.
Definition sch_item.h:337
const SCH_ITEM_VEC & ConnectedItems(const SCH_SHEET_PATH &aPath)
Retrieve the set of items connected to this item on the given sheet.
Definition sch_item.cpp:559
const SYMBOL * GetParentSymbol() const
Definition sch_item.cpp:275
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
Definition sch_item.cpp:269
int GetBodyStyle() const
Definition sch_item.h:248
virtual bool IsPointClickableAnchor(const VECTOR2I &aPos) const
Definition sch_item.h:536
bool IsLocked() const override
Definition sch_item.cpp:149
int GetUnit() const
Definition sch_item.h:239
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition sch_item.h:183
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const override
void SetShape(LABEL_FLAG_SHAPE aShape)
Definition sch_label.h:181
LABEL_SHAPE GetLabelShape() const
Definition sch_label.h:177
virtual void SetSpinStyle(SPIN_STYLE aSpinStyle)
static bool IsDrawingLineWireOrBus(const SELECTION &aSelection)
Segment description base class to describe items which have 2 end points (track, wire,...
Definition sch_line.h:42
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
Definition sch_line.cpp:817
bool IsStartDangling() const
Definition sch_line.h:303
VECTOR2I GetEndPoint() const
Definition sch_line.h:148
VECTOR2I GetStartPoint() const
Definition sch_line.h:139
SEG GetSeg() const
Get the geometric aspect of the wire as a SEG.
Definition sch_line.h:158
bool IsEndDangling() const
Definition sch_line.h:304
bool IsBus() const
Return true if the line is a bus.
Definition sch_line.cpp:998
bool IsGraphicLine() const
Return if the line is a graphic (non electrical line)
Definition sch_line.cpp:986
void SetEndPoint(const VECTOR2I &aPosition)
Definition sch_line.h:149
Tool that displays edit points allowing to modify items by dragging the points.
bool HasPoint()
Indicate the cursor is over an edit point.
SELECTION & selection() override
Return a reference to the selection.
int SelectPrevious(const TOOL_EVENT &aEvent)
void highlight(EDA_ITEM *aItem, int aMode, SELECTION *aGroup=nullptr) override
Highlight the item visually.
void SyncSelection(const std::optional< SCH_SHEET_PATH > &targetSheetPath, SCH_ITEM *focusItem, const std::vector< SCH_ITEM * > &items)
int SelectAll(const TOOL_EVENT &aEvent)
Unselect all visible items in sheet.
void narrowSelection(SCH_COLLECTOR &collector, const VECTOR2I &aWhere, bool aCheckLocked, bool aSelectedOnly=false, SCH_SELECTION_FILTER_OPTIONS *aRejected=nullptr)
Apply rules to narrow the collection down to selectable objects, and then heuristics to try and narro...
void FilterSelectionForLockedItems()
Remove locked items from the current selection.
std::set< SCH_ITEM * > expandConnectionGraphically(const SCH_SELECTION &aItems)
KIGFX::VIEW_GROUP m_enteredGroupOverlay
EDA_ITEM * GetNode(const VECTOR2I &aPosition)
Finds a connected item at a point (usually the cursor position).
bool itemPassesFilter(EDA_ITEM *aItem, SCH_SELECTION_FILTER_OPTIONS *aRejected=nullptr)
Return true if the given item passes the stateful selection filter.
SCH_BASE_FRAME * m_frame
void EnterGroup() override
Enter the group at the head of the current selection.
void unhighlight(EDA_ITEM *aItem, int aMode, SELECTION *aGroup=nullptr) override
Unhighlight the item visually.
bool selectTableCells(SCH_TABLE *aTable)
Handle a table cell drag selection within a table.
int SetSelectRect(const TOOL_EVENT &aEvent)
int Main(const TOOL_EVENT &aEvent)
The main loop.
bool SelectPoint(const VECTOR2I &aWhere, const std::vector< KICAD_T > &aScanTypes={ SCH_LOCATE_ANY_T }, EDA_ITEM **aItem=nullptr, bool *aSelectionCancelledFlag=nullptr, bool aCheckLocked=false, bool aAdd=false, bool aSubtract=false, bool aExclusiveOr=false)
Perform a click-type selection at a point (usually the cursor position).
int ClearSelection(const TOOL_EVENT &aEvent)
Select all visible items in sheet.
bool CollectHits(SCH_COLLECTOR &aCollector, const VECTOR2I &aWhere, const std::vector< KICAD_T > &aScanTypes={ SCH_LOCATE_ANY_T })
Collect one or more items at a given point.
void GuessSelectionCandidates(SCH_COLLECTOR &collector, const VECTOR2I &aPos)
Apply heuristics to try and determine a single object when multiple are found under the cursor.
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
void RebuildSelection()
Rebuild the selection from the EDA_ITEMs' selection flags.
SCH_TABLECELL * m_previous_first_cell
SCH_SELECTION & GetSelection()
SCH_SELECTION & RequestSelection(const std::vector< KICAD_T > &aScanTypes={ SCH_LOCATE_ANY_T }, bool aPromoteCellSelections=false, bool aPromoteGroups=false)
Return either an existing selection (filtered), or the selection at the current cursor position if th...
int SelectNext(const TOOL_EVENT &aEvent)
Select previous net item.
int UnselectAll(const TOOL_EVENT &aEvent)
Select next net item.
bool Init() override
Init() is called once upon a registration of the tool.
bool selectPoint(SCH_COLLECTOR &aCollector, const VECTOR2I &aWhere, EDA_ITEM **aItem=nullptr, bool *aSelectionCancelledFlag=nullptr, bool aAdd=false, bool aSubtract=false, bool aExclusiveOr=false)
Perform a click-type selection at a point (usually the cursor position).
std::set< SCH_ITEM * > expandConnectionWithGraph(const SCH_SELECTION &aItems)
OPT_TOOL_EVENT autostartEvent(TOOL_EVENT *aEvent, EE_GRID_HELPER &aGrid, SCH_ITEM *aItem)
void filterCollectorForHierarchy(SCH_COLLECTOR &aCollector, bool aMultiselect) const
In general we don't want to select both a parent and any of it's children.
bool selectMultiple()
Handle drawing a selection box that allows one to select many items at the same time.
SELECTION_MODE m_selectionMode
bool Selectable(const EDA_ITEM *aItem, const VECTOR2I *aPos=nullptr, bool checkVisibilityOnly=false) const
Check conditions for an item to be selected.
void updateReferencePoint()
Set the reference point to the anchor of the top-left item.
int SelectNode(const TOOL_EVENT &aEvent)
Selects the connected item at the current cursor position.
void InitializeSelectionState(SCH_TABLE *aTable)
Initialize the selection state of table cells.
void ExitGroup(bool aSelectGroup=false) override
Leave the currently-entered group.
int SelectRows(const TOOL_EVENT &aEvent)
void SelectCellsBetween(const VECTOR2D &start, const VECTOR2D &end, SCH_TABLE *aTable)
Select table cells within a rectangular area between two points.
void unselect(EDA_ITEM *aItem) override
Take necessary action to mark an item as unselected.
void select(EDA_ITEM *aItem) override
Take necessary action to mark an item as selected.
void SelectMultiple(KIGFX::PREVIEW::SELECTION_AREA &aArea, bool aSubtractive=false, bool aExclusiveOr=false)
int SelectColumns(const TOOL_EVENT &aEvent)
int SetSelectPoly(const TOOL_EVENT &aEvent)
int SelectTable(const TOOL_EVENT &aEvent)
Clear current selection event handler.
int disambiguateCursor(const TOOL_EVENT &aEvent)
Handle disambiguation actions including displaying the menu.
SCH_SELECTION_FILTER_OPTIONS m_filter
int SelectConnection(const TOOL_EVENT &aEvent)
If a connected item is selected then expand the selection to the entire connection,...
void ZoomFitCrossProbeBBox(const BOX2I &aBBox)
void OnIdle(wxIdleEvent &aEvent)
Zoom the screen to fit the bounding box for cross probing/selection sync.
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
int updateSelection(const TOOL_EVENT &aEvent)
Event handler to update the selection VIEW_ITEM.
void filterCollectedItems(SCH_COLLECTOR &aCollector, bool aMultiSelect)
Set up handlers for various events.
bool selectionContains(const VECTOR2I &aPoint) const
VECTOR2I GetCenter() const
Definition sch_shape.h:88
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
SHEET_SIDE GetSide() const
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition sch_sheet.h:48
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition sch_sheet.h:228
Schematic symbol object.
Definition sch_symbol.h:76
std::vector< const SCH_PIN * > GetPins(const SCH_SHEET_PATH *aSheet) const
Retrieve a list of the SCH_PINs for the given sheet path.
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
SCH_PIN * GetPin(const wxString &number) const
Find a symbol pin by number.
int GetOrientation() const override
Get the display symbol orientation.
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
Definition sch_symbol.h:184
BOX2I GetBodyBoundingBox() const override
Return a bounding box for the symbol body but not the pins or fields.
int GetColSpan() const
int GetRowSpan() const
std::vector< SCH_TABLECELL * > GetCells() const
Definition sch_table.h:157
Definition seg.h:42
int Distance(const SEG &aSeg) const
Compute minimum Euclidean distance to segment aSeg.
Definition seg.cpp:702
static SELECTION_CONDITION HasTypes(std::vector< KICAD_T > aTypes)
Create a functor that tests if among the selected items there is at least one of a given types.
static SELECTION_CONDITION HasType(KICAD_T aType)
Create a functor that tests if among the selected items there is at least one of a given type.
static bool Empty(const SELECTION &aSelection)
Test if there are no items selected.
static SELECTION_CONDITION MoreThan(int aNumber)
Create a functor that tests if the number of selected items is greater than the value given as parame...
static bool Idle(const SELECTION &aSelection)
Test if there no items selected or being edited.
static SELECTION_CONDITION LessThan(int aNumber)
Create a functor that tests if the number of selected items is smaller than the value given as parame...
static SELECTION_CONDITION Count(int aNumber)
Create a functor that tests if the number of selected items is equal to the value given as parameter.
static SELECTION_CONDITION OnlyTypes(std::vector< KICAD_T > aTypes)
Create a functor that tests if the selected items are only of given types.
bool m_multiple
Multiple selection mode is active.
int RemoveItemFromSel(const TOOL_EVENT &aEvent)
bool doSelectionMenu(COLLECTOR *aCollector)
wxTimer m_disambiguateTimer
Timer to show the disambiguate menu.
bool m_drag_additive
Add multiple items to selection.
bool m_exclusive_or
Items' selection state should be toggled.
int AddItemsToSel(const TOOL_EVENT &aEvent)
int AddItemToSel(const TOOL_EVENT &aEvent)
int UpdateMenu(const TOOL_EVENT &aEvent)
Update a menu's state based on the current selection.
void setModifiersState(bool aShiftState, bool aCtrlState, bool aAltState)
Set the configuration of m_additive, m_subtractive, m_exclusive_or, m_skip_heuristics from the state ...
VECTOR2I m_originalCursor
Location of original cursor when starting click.
int SelectionMenu(const TOOL_EVENT &aEvent)
Show a popup menu to trim the COLLECTOR passed as aEvent's parameter down to a single item.
int RemoveItemsFromSel(const TOOL_EVENT &aEvent)
bool m_subtractive
Items should be removed from selection.
SELECTION_TOOL(const std::string &aName)
bool m_skip_heuristics
Show disambiguation menu for all items under the cursor rather than trying to narrow them down first ...
bool m_drag_subtractive
Remove multiple from selection.
bool m_additive
Items should be added to sel (instead of replacing).
bool hasModifier()
True if a selection modifier is enabled, false otherwise.
bool m_canceledMenu
Sets to true if the disambiguation menu was canceled.
void onDisambiguationExpire(wxTimerEvent &aEvent)
Start the process to show our disambiguation menu once the user has kept the mouse down for the minim...
virtual void Add(EDA_ITEM *aItem)
Definition selection.cpp:42
const std::deque< EDA_ITEM * > GetItems() const
Definition selection.h:126
VECTOR2I GetReferencePoint() const
virtual void Remove(EDA_ITEM *aItem)
Definition selection.cpp:60
bool IsHover() const
Definition selection.h:89
bool Empty() const
Checks if there is anything selected.
Definition selection.h:115
bool HasReferencePoint() const
Definition selection.h:216
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
void GenerateBBoxCache() const
void SetClosed(bool aClosed)
Mark the line chain as closed (i.e.
int PointCount() const
Return the number of points (vertices) in this line chain.
double Area(bool aAbsolute=true) const
Return the area of this chain.
virtual size_t GetPointCount() const override
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
const VECTOR2I & CLastPoint() const
Return the last point in the line chain.
void Remove(int aStartIndex, int aEndIndex)
Remove the range of points [start_index, end_index] from the line chain.
bool PointInside(const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const override
Check if point aP lies inside a closed shape.
bool Collide(const SHAPE *aShape, int aClearance, VECTOR2I *aMTV) const override
Check if the boundary of shape (this) lies closer to the shape aShape than aClearance,...
Definition shape_rect.h:151
The symbol library editor main window.
bool IsSymbolAlias() const
Return true if aLibId is an alias for the editor screen symbol.
Symbol library viewer main window.
A base class for LIB_SYMBOL and SCH_SYMBOL.
Definition symbol.h:63
const TRANSFORM & GetTransform() const
Definition symbol.h:247
Represent a single user action.
T * getEditFrame() const
Return the application window object, casted to requested user type.
Definition tool_base.h:186
KIGFX::VIEW_CONTROLS * getViewControls() const
Return the instance of VIEW_CONTROLS object used in the application.
Definition tool_base.cpp:44
TOOL_MANAGER * m_toolMgr
Definition tool_base.h:220
KIGFX::VIEW * getView() const
Returns the instance of #VIEW object used in the application.
Definition tool_base.cpp:38
RESET_REASON
Determine the reason of reset for a tool.
Definition tool_base.h:78
@ REDRAW
Full drawing refresh.
Definition tool_base.h:83
@ SHUTDOWN
Tool is being shut down.
Definition tool_base.h:84
@ MODEL_RELOAD
Model changes (the sheet for a schematic)
Definition tool_base.h:80
@ SUPERMODEL_RELOAD
For schematics, the entire schematic changed, not just the sheet.
Definition tool_base.h:81
Generic, UI-independent tool event.
Definition tool_event.h:171
const VECTOR2D Position() const
Return mouse cursor position in world coordinates.
Definition tool_event.h:293
bool IsAction(const TOOL_ACTION *aAction) const
Test if the event contains an action issued upon activation of the given TOOL_ACTION.
void SetPassEvent(bool aPass=true)
Definition tool_event.h:256
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Define which state (aStateFunc) to go when a certain event arrives (aConditions).
std::unique_ptr< TOOL_MENU > m_menu
The functions below are not yet implemented - their interface may change.
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Suspend execution of the tool until an event specified in aEventList arrives.
double Distance(const VECTOR2< extended_type > &aVector) const
Compute the distance between two vectors.
Definition vector2d.h:553
KICURSOR
Definition cursors.h:44
@ LINE_BUS
Definition cursors.h:90
@ LINE_WIRE
Definition cursors.h:94
@ SUBTRACT
Definition cursors.h:72
@ SELECT_WINDOW
Definition cursors.h:86
@ SELECT_LASSO
Definition cursors.h:88
@ MOVING
Definition cursors.h:48
@ ARROW
Definition cursors.h:46
@ LINE_GRAPHIC
Definition cursors.h:92
#define DEFAULT_TEXT_SIZE
Ratio of the font height to the baseline of the text above the wire.
static constexpr EDA_ANGLE ANGLE_VERTICAL
Definition eda_angle.h:408
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
Definition eda_angle.h:407
@ RECURSE
Definition eda_item.h:53
@ NO_RECURSE
Definition eda_item.h:54
#define BRIGHTENED
item is drawn with a bright contour
#define IS_NEW
New item, just created.
#define SELECTED
Item was manually selected by the user.
#define SELECTION_CANDIDATE
indicates an item is a candidate for selection
#define ENTERED
indicates a group has been entered
#define ENDPOINT
ends. (Used to support dragging.)
std::uint32_t EDA_ITEM_FLAGS
#define IS_MOVING
Item being moved.
#define SHOW_ELEC_TYPE
Show pin electrical type.
#define STARTPOINT
When a line is selected, these flags indicate which.
@ ID_POPUP_SCH_PIN_TRICKS_START
@ ID_POPUP_SCH_PIN_TRICKS_HIER_LABEL
@ ID_POPUP_SCH_PIN_TRICKS_WIRE
@ ID_POPUP_SCH_PLACE_UNIT_END
Definition eeschema_id.h:95
@ ID_POPUP_SCH_ALT_PIN_FUNCTION
@ ID_POPUP_SCH_UNFOLD_BUS_END
Definition eeschema_id.h:84
@ ID_POPUP_SCH_SELECT_UNIT
Definition eeschema_id.h:87
@ ID_POPUP_SCH_SELECT_BODY_STYLE
Definition eeschema_id.h:97
@ ID_POPUP_SCH_PIN_TRICKS_NET_LABEL
@ ID_POPUP_SCH_SELECT_BODY_STYLE_END
Definition eeschema_id.h:99
@ ID_POPUP_SCH_PIN_TRICKS_NO_CONNECT
@ ID_POPUP_SCH_UNFOLD_BUS
Definition eeschema_id.h:83
@ ID_POPUP_SCH_SELECT_UNIT_END
Definition eeschema_id.h:91
@ ID_POPUP_SCH_ALT_PIN_FUNCTION_END
@ ID_POPUP_SCH_PLACE_UNIT
Definition eeschema_id.h:93
@ ID_POPUP_SCH_PIN_TRICKS_GLOBAL_LABEL
@ ID_POPUP_SCH_PIN_TRICKS_END
@ FRAME_SCH_VIEWER
Definition frame_type.h:36
a few functions useful in geometry calculations.
GRID_HELPER_GRIDS
Definition grid_helper.h:44
@ GRID_WIRES
Definition grid_helper.h:49
KIID niluuid(0)
@ LAYER_WIRE
Definition layer_ids.h:454
@ LAYER_BUS
Definition layer_ids.h:455
MOUSE_DRAG_ACTION
bool BoxHitTest(const VECTOR2I &aHitPoint, const BOX2I &aHittee, int aAccuracy)
Perform a point-to-box hit test.
@ REPAINT
Item needs to be redrawn.
Definition view_item.h:58
ELECTRICAL_PINTYPE
The symbol library pin object electrical types used in ERC tests.
Definition pin_type.h:36
@ PT_INPUT
usual pin input: must be connected
Definition pin_type.h:37
@ PT_OUTPUT
usual output
Definition pin_type.h:38
@ PT_TRISTATE
tri state bus pin
Definition pin_type.h:40
@ PT_BIDI
input or output (like port for a microprocessor)
Definition pin_type.h:39
@ PT_UNSPECIFIED
unknown electrical properties: creates always a warning when connected
Definition pin_type.h:45
@ PT_PASSIVE
pin for passive symbols: must be connected, and can be connected to any pin.
Definition pin_type.h:43
@ PIN_UP
The pin extends upwards from the connection point: Probably on the bottom side of the symbol.
Definition pin_type.h:127
@ PIN_RIGHT
The pin extends rightwards from the connection point.
Definition pin_type.h:111
@ PIN_LEFT
The pin extends leftwards from the connection point: Probably on the right side of the symbol.
Definition pin_type.h:118
@ PIN_DOWN
The pin extends downwards from the connection: Probably on the top side of the symbol.
Definition pin_type.h:135
CITER next(CITER it)
Definition ptree.cpp:124
#define HITTEST_THRESHOLD_PIXELS
Class to handle a set of SCH_ITEMs.
std::vector< SCH_ITEM * > SCH_ITEM_VEC
Definition sch_item.h:157
std::vector< EDA_ITEM * > EDA_ITEMS
@ L_BIDI
Definition sch_label.h:102
@ L_TRISTATE
Definition sch_label.h:103
@ L_UNSPECIFIED
Definition sch_label.h:104
@ L_OUTPUT
Definition sch_label.h:101
@ L_INPUT
Definition sch_label.h:100
@ LABEL_BIDI
Definition sch_label.h:120
@ LABEL_INPUT
Definition sch_label.h:118
@ LABEL_OUTPUT
Definition sch_label.h:119
@ LABEL_PASSIVE
Definition sch_label.h:122
@ LABEL_TRISTATE
Definition sch_label.h:121
static std::vector< KICAD_T > connectedTypes
static std::vector< KICAD_T > tableCellTypes
static std::vector< KICAD_T > expandConnectionGraphTypes
static std::vector< KICAD_T > lineTypes
static std::vector< KICAD_T > sheetTypes
const TOOL_ACTION * allowedActions[]
static void passEvent(TOOL_EVENT *const aEvent, const TOOL_ACTION *const aAllowedActions[])
static std::vector< KICAD_T > connectedLineTypes
static std::vector< KICAD_T > crossProbingTypes
std::vector< SCH_SYMBOL * > GetSameSymbolMultiUnitSelection(const SELECTION &aSel)
Validates and gathers a selection containing multiple symbol units that all belong to the same refere...
std::function< bool(const SELECTION &)> SELECTION_CONDITION
Functor type that checks a specific condition for selected items.
SELECTION_MODE
std::vector< FAB_LAYER_COLOR > dummy
bool symbols
Allow selecting symbols and sheet symbols.
bool labels
Net and bus labels.
bool pins
Symbol and sheet pins.
bool graphics
Graphic lines, shapes, polygons.
bool lockedItems
Allow selecting locked items.
bool images
Bitmap/vector images.
bool otherItems
Anything not fitting one of the above categories.
bool wires
Net and bus wires and junctions.
void RotateAndMirrorPin(SCH_PIN &aPin, int aOrientMirror)
Rotate and/or mirror a SCH_PIN according to aOrientMirror.
std::string path
KIBIS top(path, &reporter)
KIBIS_PIN * pin
std::vector< std::vector< std::string > > table
VECTOR2I end
int delta
@ TA_CHOICE_MENU_CHOICE
Context menu choice.
Definition tool_event.h:98
@ TA_UNDO_REDO_PRE
This event is sent before undo/redo command is performed.
Definition tool_event.h:106
@ TA_MOUSE_WHEEL
Definition tool_event.h:73
std::optional< TOOL_EVENT > OPT_TOOL_EVENT
Definition tool_event.h:641
@ MD_ALT
Definition tool_event.h:145
@ MD_CTRL
Definition tool_event.h:144
@ MD_SHIFT
Definition tool_event.h:143
@ TC_COMMAND
Definition tool_event.h:57
@ BUT_AUX1
Definition tool_event.h:135
@ BUT_MIDDLE
Definition tool_event.h:134
@ BUT_LEFT
Definition tool_event.h:132
@ BUT_RIGHT
Definition tool_event.h:133
@ BUT_AUX2
Definition tool_event.h:136
@ SCH_GROUP_T
Definition typeinfo.h:174
@ SCH_TABLE_T
Definition typeinfo.h:166
@ SCH_LINE_T
Definition typeinfo.h:164
@ LIB_SYMBOL_T
Definition typeinfo.h:149
@ SCH_NO_CONNECT_T
Definition typeinfo.h:161
@ SCH_SYMBOL_T
Definition typeinfo.h:173
@ SCH_TABLECELL_T
Definition typeinfo.h:167
@ SCH_ITEM_LOCATE_WIRE_T
Definition typeinfo.h:187
@ SCH_FIELD_T
Definition typeinfo.h:151
@ SCH_DIRECTIVE_LABEL_T
Definition typeinfo.h:172
@ SCH_LABEL_T
Definition typeinfo.h:168
@ SCH_LOCATE_ANY_T
Definition typeinfo.h:200
@ SCH_SHEET_T
Definition typeinfo.h:176
@ SCH_ITEM_LOCATE_BUS_T
Definition typeinfo.h:188
@ SCH_MARKER_T
Definition typeinfo.h:159
@ SCH_SHAPE_T
Definition typeinfo.h:150
@ SCH_RULE_AREA_T
Definition typeinfo.h:171
@ SCH_HIER_LABEL_T
Definition typeinfo.h:170
@ NOT_USED
the 3d code uses this value
Definition typeinfo.h:76
@ SCH_BUS_BUS_ENTRY_T
Definition typeinfo.h:163
@ SCH_ITEM_LOCATE_GRAPHIC_LINE_T
Definition typeinfo.h:189
@ SCHEMATIC_T
Definition typeinfo.h:205
@ SCH_SHEET_PIN_T
Definition typeinfo.h:175
@ SCH_TEXT_T
Definition typeinfo.h:152
@ SCH_SYMBOL_LOCATE_POWER_T
Definition typeinfo.h:197
@ SCH_BUS_WIRE_ENTRY_T
Definition typeinfo.h:162
@ SCH_BITMAP_T
Definition typeinfo.h:165
@ SCH_TEXTBOX_T
Definition typeinfo.h:153
@ SCH_GLOBAL_LABEL_T
Definition typeinfo.h:169
@ SCH_JUNCTION_T
Definition typeinfo.h:160
@ SCH_PIN_T
Definition typeinfo.h:154
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:687
VECTOR2< double > VECTOR2D
Definition vector2d.h:686