KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_move_tool.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2019 CERN
5 * Copyright 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 <cmath>
26#include <memory>
27#include <optional>
28#include <wx/log.h>
29#include <trigo.h>
31#include <tool/tool_manager.h>
36#include <tools/sch_move_tool.h>
37
38#include <sch_actions.h>
39#include <sch_commit.h>
40#include <eda_item.h>
41#include <sch_group.h>
42#include <sch_item.h>
43#include <sch_symbol.h>
44#include <sch_sheet.h>
45#include <sch_sheet_pin.h>
46#include <sch_line.h>
47#include <sch_connection.h>
48#include <sch_junction.h>
49#include <junction_helpers.h>
50#include <sch_edit_frame.h>
51#include <eeschema_id.h>
52#include <pgm_base.h>
53#include <view/view_controls.h>
55#include <math/box2.h>
56#include <base_units.h>
57#include <sch_screen.h>
58#include <sch_item_alignment.h>
59#include <trace_helpers.h>
60
61
62// For adding to or removing from selections
63#define QUIET_MODE true
64
65
66static bool isGraphicItemForDrop( const SCH_ITEM* aItem )
67{
68 switch( aItem->Type() )
69 {
70 case SCH_SHAPE_T:
71 case SCH_BITMAP_T:
72 case SCH_TEXT_T:
73 case SCH_TEXTBOX_T:
74 return true;
75 case SCH_LINE_T:
76 return static_cast<const SCH_LINE*>( aItem )->IsGraphicLine();
77 default:
78 return false;
79 }
80}
81
82
83static void cloneWireConnection( SCH_LINE* aNewLine, SCH_ITEM* aSource, SCH_EDIT_FRAME* aFrame )
84{
85 if( !aNewLine || !aSource || !aFrame )
86 return;
87
88 SCH_LINE* sourceLine = dynamic_cast<SCH_LINE*>( aSource );
89
90 if( !sourceLine )
91 return;
92
93 SCH_SHEET_PATH sheetPath = aFrame->GetCurrentSheet();
94 SCH_CONNECTION* sourceConnection = sourceLine->Connection( &sheetPath );
95
96 if( !sourceConnection )
97 return;
98
99 SCH_CONNECTION* newConnection = aNewLine->InitializeConnection( sheetPath, nullptr );
100
101 if( !newConnection )
102 return;
103
104 newConnection->Clone( *sourceConnection );
105}
106
107
109 SCH_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.InteractiveMove" ),
110 m_inMoveTool( false ),
111 m_moveInProgress( false ),
112 m_mode( MOVE ),
113 m_moveOffset( 0, 0 )
114{
115}
116
117
119{
121
122 auto moveCondition =
123 []( const SELECTION& aSel )
124 {
125 if( aSel.Empty() || SELECTION_CONDITIONS::OnlyTypes( { SCH_MARKER_T } )( aSel ) )
126 return false;
127
129 return false;
130
131 return true;
132 };
133
134 // Add move actions to the selection tool menu
135 //
136 CONDITIONAL_MENU& selToolMenu = m_selectionTool->GetToolMenu().GetMenu();
137
138 selToolMenu.AddItem( SCH_ACTIONS::move, moveCondition, 150 );
139 selToolMenu.AddItem( SCH_ACTIONS::drag, moveCondition, 150 );
140 selToolMenu.AddItem( SCH_ACTIONS::alignToGrid, moveCondition, 150 );
141
142 return true;
143}
144
145
147{
148 SCH_TOOL_BASE::Reset( aReason );
149
150 if( aReason == MODEL_RELOAD || aReason == SUPERMODEL_RELOAD )
151 {
152 // If we were in the middle of a move/drag operation and the model changes (e.g., sheet
153 // switch), we need to clean up our state to avoid blocking future move/drag operations
154 if( m_moveInProgress )
155 {
156 // Clear the move state
157 m_moveInProgress = false;
158 m_mode = MOVE;
159 m_moveOffset = VECTOR2I( 0, 0 );
160 m_anchorPos.reset();
161 m_breakPos.reset();
162
163 // Clear cached data that references items from the previous sheet
164 m_dragAdditions.clear();
165 m_lineConnectionCache.clear();
166 m_newDragLines.clear();
167 m_changedDragLines.clear();
168 m_specialCaseLabels.clear();
170 m_hiddenJunctions.clear();
171
172 // Clear any preview
173 if( m_view )
174 m_view->ClearPreview();
175 }
176 }
177}
178
179
180void SCH_MOVE_TOOL::orthoLineDrag( SCH_COMMIT* aCommit, SCH_LINE* line, const VECTOR2I& splitDelta,
181 int& xBendCount, int& yBendCount, const EE_GRID_HELPER& grid )
182{
183 // If the move is not the same angle as this move, then we need to do something special with
184 // the unselected end to maintain orthogonality. Either drag some connected line that is the
185 // same angle as the move or add two lines to make a 90 degree connection
186 if( !EDA_ANGLE( splitDelta ).IsParallelTo( line->Angle() ) || line->GetLength() == 0 )
187 {
188 VECTOR2I unselectedEnd = line->HasFlag( STARTPOINT ) ? line->GetEndPoint()
189 : line->GetStartPoint();
190 VECTOR2I selectedEnd = line->HasFlag( STARTPOINT ) ? line->GetStartPoint()
191 : line->GetEndPoint();
192
193 // Look for pre-existing lines we can drag with us instead of creating new ones
194 bool foundAttachment = false;
195 bool foundJunction = false;
196 bool foundPin = false;
197 SCH_LINE* foundLine = nullptr;
198
199 for( EDA_ITEM* cItem : m_lineConnectionCache[line] )
200 {
201 foundAttachment = true;
202
203 // If the move is the same angle as a connected line, we can shrink/extend that line
204 // endpoint
205 switch( cItem->Type() )
206 {
207 case SCH_LINE_T:
208 {
209 SCH_LINE* cLine = static_cast<SCH_LINE*>( cItem );
210
211 // A matching angle on a non-zero-length line means lengthen/shorten will work
212 if( EDA_ANGLE( splitDelta ).IsParallelTo( cLine->Angle() )
213 && cLine->GetLength() != 0 )
214 {
215 foundLine = cLine;
216 }
217
218 // Zero length lines are lines that this algorithm has shortened to 0 so they also
219 // work but we should prefer using a segment with length and angle matching when
220 // we can (otherwise the zero length line will draw overlapping segments on them)
221 if( !foundLine && cLine->GetLength() == 0 )
222 foundLine = cLine;
223
224 break;
225 }
226 case SCH_JUNCTION_T:
227 foundJunction = true;
228 break;
229
230 case SCH_PIN_T:
231 foundPin = true;
232 break;
233
234 case SCH_SHEET_T:
235 for( const auto& pair : m_specialCaseSheetPins )
236 {
237 if( pair.first->IsConnected( selectedEnd ) )
238 {
239 foundPin = true;
240 break;
241 }
242 }
243
244 break;
245
246 default:
247 break;
248 }
249 }
250
251 // Ok... what if our original line is length zero from moving in its direction, and the
252 // last added segment of the 90 bend we are connected to is zero from moving it in its
253 // direction after it was added?
254 //
255 // If we are moving in original direction, we should lengthen the original drag wire.
256 // Otherwise we should lengthen the new wire.
257 bool preferOriginalLine = false;
258
259 if( foundLine
260 && foundLine->GetLength() == 0
261 && line->GetLength() == 0
262 && EDA_ANGLE( splitDelta ).IsParallelTo( line->GetStoredAngle() ) )
263 {
264 preferOriginalLine = true;
265 }
266 // If we have found an attachment, but not a line, we want to check if it's a junction.
267 // These are special-cased and get a single line added instead of a 90-degree bend. Except
268 // when we're on a pin, because pins always need bends, and junctions are just added to
269 // pins for visual clarity.
270 else if( !foundLine && foundJunction && !foundPin )
271 {
272 // Create a new wire ending at the unselected end
273 foundLine = new SCH_LINE( unselectedEnd, line->GetLayer() );
274 foundLine->SetFlags( IS_NEW );
275 foundLine->SetLastResolvedState( line );
276 cloneWireConnection( foundLine, line, m_frame );
277 m_frame->AddToScreen( foundLine, m_frame->GetScreen() );
278 m_newDragLines.insert( foundLine );
279
280 // We just broke off of the existing items, so replace all of them with our new
281 // end connection.
283 m_lineConnectionCache[line].clear();
284 m_lineConnectionCache[line].emplace_back( foundLine );
285 }
286
287 // We want to drag our found line if it's in the same angle as the move or zero length,
288 // but if the original drag line is also zero and the same original angle we should extend
289 // that one first
290 if( foundLine && !preferOriginalLine )
291 {
292 // Move the connected line found oriented in the direction of our move.
293 //
294 // Make sure we grab the right endpoint, it's not always STARTPOINT since the user can
295 // draw a box of lines. We need to only move one though, and preferably the start point,
296 // in case we have a zero length line that we are extending (we want the foundLine
297 // start point to be attached to the unselected end of our drag line).
298 //
299 // Also, new lines are added already so they'll be in the undo list, skip adding them.
300
301 if( !foundLine->HasFlag( IS_CHANGED ) && !foundLine->HasFlag( IS_NEW ) )
302 {
303 aCommit->Modify( (SCH_ITEM*) foundLine, m_frame->GetScreen() );
304
305 if( !foundLine->IsSelected() )
306 m_changedDragLines.insert( foundLine );
307 }
308
309 if( foundLine->GetStartPoint() == unselectedEnd )
310 foundLine->MoveStart( splitDelta );
311 else if( foundLine->GetEndPoint() == unselectedEnd )
312 foundLine->MoveEnd( splitDelta );
313
314 updateItem( foundLine, true );
315
316 SCH_LINE* bendLine = nullptr;
317
318 if( m_lineConnectionCache.count( foundLine ) == 1
319 && m_lineConnectionCache[foundLine][0]->Type() == SCH_LINE_T )
320 {
321 bendLine = static_cast<SCH_LINE*>( m_lineConnectionCache[foundLine][0] );
322 }
323
324 // Remerge segments we've created if this is a segment that we've added whose only
325 // other connection is also an added segment
326 //
327 // bendLine is first added segment at the original attachment point, foundLine is the
328 // orthogonal line between bendLine and this line
329 if( foundLine->HasFlag( IS_NEW )
330 && foundLine->GetLength() == 0
331 && bendLine && bendLine->HasFlag( IS_NEW ) )
332 {
333 if( line->HasFlag( STARTPOINT ) )
334 line->SetEndPoint( bendLine->GetEndPoint() );
335 else
336 line->SetStartPoint( bendLine->GetEndPoint() );
337
338 // Update our cache of the connected items.
339
340 // Re-attach drag labels from lines being deleted to the surviving line.
341 // This prevents dangling pointers when bendLine/foundLine are deleted below.
342 for( auto& [label, info] : m_specialCaseLabels )
343 {
344 if( info.attachedLine == bendLine || info.attachedLine == foundLine )
345 info.attachedLine = line;
346 }
347
349 m_lineConnectionCache[bendLine].clear();
350 m_lineConnectionCache[foundLine].clear();
351
352 m_frame->RemoveFromScreen( bendLine, m_frame->GetScreen() );
353 m_frame->RemoveFromScreen( foundLine, m_frame->GetScreen() );
354
355 m_newDragLines.erase( bendLine );
356 m_newDragLines.erase( foundLine );
357
358 delete bendLine;
359 delete foundLine;
360 }
361 //Ok, move the unselected end of our item
362 else
363 {
364 if( line->HasFlag( STARTPOINT ) )
365 line->MoveEnd( splitDelta );
366 else
367 line->MoveStart( splitDelta );
368 }
369
370 updateItem( line, true );
371 }
372 else if( line->GetLength() == 0 )
373 {
374 // We didn't find another line to shorten/lengthen, (or we did but it's also zero)
375 // so now is a good time to use our existing zero-length original line
376 }
377 // Either no line was at the "right" angle, or this was a junction, pin, sheet, etc. We
378 // need to add segments to keep the soon-to-move unselected end connected to these items.
379 //
380 // To keep our drag selections all the same, we'll move our unselected end point and then
381 // put wires between it and its original endpoint.
382 else if( foundAttachment && line->IsOrthogonal() )
383 {
384 VECTOR2D lineGrid = grid.GetGridSize( grid.GetItemGrid( line ) );
385
386 // The bend counter handles a group of wires all needing their offset one grid movement
387 // further out from each other to not overlap. The absolute value stuff finds the
388 // direction of the line and hence the the bend increment on that axis
389 unsigned int xMoveBit = splitDelta.x != 0;
390 unsigned int yMoveBit = splitDelta.y != 0;
391 int xLength = abs( unselectedEnd.x - selectedEnd.x );
392 int yLength = abs( unselectedEnd.y - selectedEnd.y );
393 int xMove = ( xLength - ( xBendCount * lineGrid.x ) )
394 * sign( selectedEnd.x - unselectedEnd.x );
395 int yMove = ( yLength - ( yBendCount * lineGrid.y ) )
396 * sign( selectedEnd.y - unselectedEnd.y );
397
398 // Create a new wire ending at the unselected end, we'll move the new wire's start
399 // point to the unselected end
400 SCH_LINE* a = new SCH_LINE( unselectedEnd, line->GetLayer() );
401 a->MoveStart( VECTOR2I( xMove, yMove ) );
402 a->SetFlags( IS_NEW );
403 a->SetConnectivityDirty( true );
404 a->SetLastResolvedState( line );
405 cloneWireConnection( a, line, m_frame );
406 m_frame->AddToScreen( a, m_frame->GetScreen() );
407 m_newDragLines.insert( a );
408
409 SCH_LINE* b = new SCH_LINE( a->GetStartPoint(), line->GetLayer() );
410 b->MoveStart( VECTOR2I( splitDelta.x, splitDelta.y ) );
411 b->SetFlags( IS_NEW | STARTPOINT );
412 b->SetConnectivityDirty( true );
413 b->SetLastResolvedState( line );
414 cloneWireConnection( b, line, m_frame );
415 m_frame->AddToScreen( b, m_frame->GetScreen() );
416 m_newDragLines.insert( b );
417
418 xBendCount += yMoveBit;
419 yBendCount += xMoveBit;
420
421 // Ok move the unselected end of our item
422 if( line->HasFlag( STARTPOINT ) )
423 {
424 line->MoveEnd( VECTOR2I( splitDelta.x ? splitDelta.x : xMove,
425 splitDelta.y ? splitDelta.y : yMove ) );
426 }
427 else
428 {
429 line->MoveStart( VECTOR2I( splitDelta.x ? splitDelta.x : xMove,
430 splitDelta.y ? splitDelta.y : yMove ) );
431 }
432
433 // Update our cache of the connected items. First, attach our drag labels to the line
434 // left behind.
435 for( EDA_ITEM* candidate : m_lineConnectionCache[line] )
436 {
437 SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( candidate );
438
439 if( label && m_specialCaseLabels.count( label ) )
440 m_specialCaseLabels[label].attachedLine = a;
441 }
442
443 // We just broke off of the existing items, so replace all of them with our new end
444 // connection.
446 m_lineConnectionCache[b].emplace_back( a );
447 m_lineConnectionCache[line].clear();
448 m_lineConnectionCache[line].emplace_back( b );
449 }
450 // Original line has no attachments, just move the unselected end
451 else if( !foundAttachment )
452 {
453 if( line->HasFlag( STARTPOINT ) )
454 line->MoveEnd( splitDelta );
455 else
456 line->MoveStart( splitDelta );
457 }
458 }
459}
460
461
462int SCH_MOVE_TOOL::Main( const TOOL_EVENT& aEvent )
463{
464 if( aEvent.IsAction( &SCH_ACTIONS::drag ) )
465 m_mode = DRAG;
466 else if( aEvent.IsAction( &SCH_ACTIONS::breakWire ) )
467 m_mode = BREAK;
468 else if( aEvent.IsAction( &SCH_ACTIONS::slice ) )
469 m_mode = SLICE;
470 else
471 m_mode = MOVE;
472
473 if( SCH_COMMIT* commit = dynamic_cast<SCH_COMMIT*>( aEvent.Commit() ) )
474 {
475 wxCHECK( aEvent.SynchronousState(), 0 );
476 aEvent.SynchronousState()->store( STS_RUNNING );
477
478 if( doMoveSelection( aEvent, commit ) )
479 aEvent.SynchronousState()->store( STS_FINISHED );
480 else
481 aEvent.SynchronousState()->store( STS_CANCELLED );
482 }
483 else
484 {
485 SCH_COMMIT localCommit( m_toolMgr );
486
487 if( doMoveSelection( aEvent, &localCommit ) )
488 {
489 switch( m_mode )
490 {
491 case MOVE: localCommit.Push( _( "Move" ) ); break;
492 case DRAG: localCommit.Push( _( "Drag" ) ); break;
493 case BREAK: localCommit.Push( _( "Break Wire" ) ); break;
494 case SLICE: localCommit.Push( _( "Slice Wire" ) ); break;
495 }
496 }
497 else
498 {
499 localCommit.Revert();
500 }
501 }
502
503 return 0;
504}
505
506
508{
509 if( m_mode != BREAK && m_mode != SLICE )
510 return;
511
512 if( !aCommit )
513 return;
514
516
517 if( !lwbTool )
518 return;
519
520 SCH_SELECTION& selection = m_selectionTool->GetSelection();
521
522 if( selection.Empty() )
523 return;
524
525 std::vector<SCH_LINE*> lines;
526
527 for( EDA_ITEM* item : selection )
528 {
529 if( item->Type() == SCH_LINE_T )
530 {
531 // This function gets called every time segments are broken, which can also be for subsequent
532 // breaks in a loop without leaving the current move tool.
533 // Skip already placed segments (segment keeps IS_BROKEN but will have IS_NEW cleared below)
534 // so that only the actively placed tail segment gets split again.
535 if( item->HasFlag( IS_BROKEN ) && !item->HasFlag( IS_NEW ) )
536 continue;
537
538 lines.push_back( static_cast<SCH_LINE*>( item ) );
539 }
540 }
541
542 if( lines.empty() )
543 return;
544
546 SCH_SCREEN* screen = m_frame->GetScreen();
547 VECTOR2I cursorPos = controls->GetCursorPosition( !aEvent.DisableGridSnapping() );
548
549 bool useCursorForSingleLine = false;
550
551 if( lines.size() == 1 )
552 useCursorForSingleLine = true;
553
554 m_selectionTool->ClearSelection();
555 m_breakPos.reset();
556
557 for( SCH_LINE* line : lines )
558 {
559 VECTOR2I breakPos = useCursorForSingleLine ? cursorPos : line->GetMidPoint();
560
561 if( m_mode == BREAK && !m_breakPos )
562 m_breakPos = breakPos;
563
564 SCH_LINE* newLine = nullptr;
565
566 lwbTool->BreakSegment( aCommit, line, breakPos, &newLine, screen );
567
568 if( !newLine )
569 continue;
570
571 // If this is a second+ round break, we need to get rid of the IS_NEW flag since the new segment
572 // is now an existing segment we are breaking from, this will be checked for in the line selection
573 // gathering above
574 line->ClearFlags( STARTPOINT | IS_NEW );
575 line->SetFlags( ENDPOINT );
576 m_selectionTool->AddItemToSel( line );
577
578 newLine->ClearFlags( ENDPOINT | STARTPOINT );
579
580 if( m_mode == BREAK )
581 {
582 m_selectionTool->AddItemToSel( newLine );
583 newLine->SetFlags( STARTPOINT );
584 }
585 }
586}
587
588
590{
593 bool currentModeIsDragLike = ( m_mode != MOVE );
594 bool wasDragging = m_moveInProgress && currentModeIsDragLike;
595 bool didAtLeastOneBreak = false;
596
597 m_anchorPos.reset();
598
599 // Check if already in progress and handle state transitions
600 if( checkMoveInProgress( aEvent, aCommit, currentModeIsDragLike, wasDragging ) )
601 return false;
602
603 if( m_inMoveTool ) // Must come after m_moveInProgress checks above...
604 return false;
605
607
608 preprocessBreakOrSliceSelection( aCommit, aEvent );
609
610 // Prepare selection (promote pins to symbols, request selection)
611 bool unselect = false;
612 SCH_SELECTION& selection = prepareSelection( unselect );
613
614 // Keep an original copy of the starting points for cleanup after the move
615 std::vector<DANGLING_END_ITEM> internalPoints;
616
617 // Track selection characteristics
618 bool selectionHasSheetPins = false;
619 bool selectionHasGraphicItems = false;
620 bool selectionHasNonGraphicItems = false;
621 bool selectionIsGraphicsOnly = false;
622
623 std::unique_ptr<SCH_DRAG_NET_COLLISION_MONITOR> netCollisionMonitor;
624
625 auto refreshTraits =
626 [&]()
627 {
628 refreshSelectionTraits( selection, selectionHasSheetPins, selectionHasGraphicItems,
629 selectionHasNonGraphicItems, selectionIsGraphicsOnly );
630 };
631
632 refreshTraits();
633
634 if( !selection.Empty() )
635
636 {
637 netCollisionMonitor = std::make_unique<SCH_DRAG_NET_COLLISION_MONITOR>( m_frame, m_view );
638 netCollisionMonitor->Initialize( selection );
639 }
640
641 bool lastCtrlDown = false;
642
643 Activate();
644
645 // Must be done after Activate() so that it gets set into the correct context
646 controls->ShowCursor( true );
647
648 m_frame->PushTool( aEvent );
649
650 if( selection.Empty() )
651 {
652 // Note that it's important to go through push/pop even when the selection is empty.
653 // This keeps other tools from having to special-case an empty move.
654 m_frame->PopTool( aEvent );
655 return false;
656 }
657
658 bool restore_state = false;
659 TOOL_EVENT copy = aEvent;
660 TOOL_EVENT* evt = &copy;
661 VECTOR2I prevPos = controls->GetCursorPosition();
663 SCH_SHEET* hoverSheet = nullptr;
664 KICURSOR currentCursor = KICURSOR::MOVING;
665 m_cursor = controls->GetCursorPosition();
666
667 // Axis locking for arrow key movement
668 enum class AXIS_LOCK { NONE, HORIZONTAL, VERTICAL };
669 AXIS_LOCK axisLock = AXIS_LOCK::NONE;
670 long lastArrowKeyAction = 0;
671
672 // Main loop: keep receiving events
673 do
674 {
675 wxLogTrace( traceSchMove, "doMoveSelection: event loop iteration, evt=%s, action=%s",
676 evt->Category() == TC_MOUSE ? "MOUSE" :
677 evt->Category() == TC_KEYBOARD ? "KEYBOARD" :
678 evt->Category() == TC_COMMAND ? "COMMAND" : "OTHER",
679 evt->Format().c_str() );
680
681 m_frame->GetCanvas()->SetCurrentCursor( currentCursor );
682 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
683 grid.SetUseGrid( getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
684
685 bool ctrlDown = evt->Modifier( MD_CTRL );
686 lastCtrlDown = ctrlDown;
687
689 || evt->IsAction( &SCH_ACTIONS::move )
690 || evt->IsAction( &SCH_ACTIONS::drag )
691 || evt->IsMotion()
692 || evt->IsDrag( BUT_LEFT )
694 {
695 refreshTraits();
696
697 if( !m_moveInProgress ) // Prepare to start moving/dragging
698 {
699 initializeMoveOperation( aEvent, selection, aCommit, internalPoints, snapLayer );
700 prevPos = m_cursor;
701 refreshTraits();
702 }
703
704 //------------------------------------------------------------------------
705 // Follow the mouse
706 //
707 m_view->ClearPreview();
708
709 // We need to bypass refreshPreview action here because it is triggered by the move, so we were
710 // getting double-key events that toggled the axis locking if you pressed them in a certain order.
712 {
713 VECTOR2I keyboardPos( controls->GetSettings().m_lastKeyboardCursorPosition );
714 long action = controls->GetSettings().m_lastKeyboardCursorCommand;
715
716 grid.SetSnap( false );
717 m_cursor = grid.Align( keyboardPos, snapLayer );
718
719 // Update axis lock based on arrow key press
720 if( action == ACTIONS::CURSOR_LEFT || action == ACTIONS::CURSOR_RIGHT )
721 {
722 if( axisLock == AXIS_LOCK::HORIZONTAL )
723 {
724 // Check if opposite horizontal key pressed to unlock
725 if( ( lastArrowKeyAction == ACTIONS::CURSOR_LEFT && action == ACTIONS::CURSOR_RIGHT ) ||
726 ( lastArrowKeyAction == ACTIONS::CURSOR_RIGHT && action == ACTIONS::CURSOR_LEFT ) )
727 {
728 axisLock = AXIS_LOCK::NONE;
729 }
730 // Same direction axis, keep locked
731 }
732 else
733 {
734 axisLock = AXIS_LOCK::HORIZONTAL;
735 }
736 }
737 else if( action == ACTIONS::CURSOR_UP || action == ACTIONS::CURSOR_DOWN )
738 {
739 if( axisLock == AXIS_LOCK::VERTICAL )
740 {
741 // Check if opposite vertical key pressed to unlock
742 if( ( lastArrowKeyAction == ACTIONS::CURSOR_UP && action == ACTIONS::CURSOR_DOWN ) ||
743 ( lastArrowKeyAction == ACTIONS::CURSOR_DOWN && action == ACTIONS::CURSOR_UP ) )
744 {
745 axisLock = AXIS_LOCK::NONE;
746 }
747 // Same direction axis, keep locked
748 }
749 else
750 {
751 axisLock = AXIS_LOCK::VERTICAL;
752 }
753 }
754
755 lastArrowKeyAction = action;
756 }
757 else
758 {
759 m_cursor = grid.BestSnapAnchor( controls->GetCursorPosition( false ), snapLayer, selection );
760 }
761
762 if( axisLock == AXIS_LOCK::HORIZONTAL )
763 m_cursor.y = prevPos.y;
764 else if( axisLock == AXIS_LOCK::VERTICAL )
765 m_cursor.x = prevPos.x;
766
767 // Find potential target sheet for dropping
768 SCH_SHEET* sheet = findTargetSheet( selection, m_cursor, selectionHasSheetPins,
769 selectionIsGraphicsOnly, ctrlDown );
770
771 if( sheet != hoverSheet )
772 {
773 hoverSheet = sheet;
774
775 if( hoverSheet )
776 {
777 hoverSheet->SetFlags( BRIGHTENED );
778 m_frame->UpdateItem( hoverSheet, false );
779 }
780 }
781
782 currentCursor = hoverSheet ? KICURSOR::PLACE : KICURSOR::MOVING;
783
784 if( netCollisionMonitor )
785 currentCursor = netCollisionMonitor->AdjustCursor( currentCursor );
786
787 VECTOR2I delta( m_cursor - prevPos );
789
790 // Used for tracking how far off a drag end should have its 90 degree elbow added
791 int xBendCount = 1;
792 int yBendCount = 1;
793
794 performItemMove( selection, delta, aCommit, xBendCount, yBendCount, grid );
795 prevPos = m_cursor;
796
797 std::vector<SCH_ITEM*> previewItems;
798
799 for( EDA_ITEM* it : selection )
800 previewItems.push_back( static_cast<SCH_ITEM*>( it ) );
801
802 for( SCH_LINE* line : m_newDragLines )
803 previewItems.push_back( line );
804
805 for( SCH_LINE* line : m_changedDragLines )
806 previewItems.push_back( line );
807
808 std::vector<SCH_JUNCTION*> previewJunctions =
809 JUNCTION_HELPERS::PreviewJunctions( m_frame->GetScreen(), previewItems );
810
811 if( netCollisionMonitor )
812 netCollisionMonitor->Update( previewJunctions, selection );
813
814 for( SCH_JUNCTION* jct : previewJunctions )
815 m_view->AddToPreview( jct, true );
816
818 }
819
820 //------------------------------------------------------------------------
821 // Handle cancel
822 //
823 else if( evt->IsCancelInteractive()
824 || evt->IsActivate()
825 || evt->IsAction( &ACTIONS::undo ) )
826 {
827 if( evt->IsCancelInteractive() )
828 {
829 m_frame->GetInfoBar()->Dismiss();
830
831 // When breaking, the user can cancel after multiple breaks to keep all but the last
832 // break, so exit normally if we have done at least one break
833 if( didAtLeastOneBreak && m_mode == BREAK )
834 break;
835 }
836
837 if( m_moveInProgress )
838 {
839 if( evt->IsActivate() )
840 {
841 // Allowing other tools to activate during a move runs the risk of race
842 // conditions in which we try to spool up both event loops at once.
843
844 switch( m_mode )
845 {
846 case MOVE: m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel move." ) ); break;
847 case DRAG: m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel drag." ) ); break;
848 case BREAK: m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel break." ) ); break;
849 case SLICE: m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel slice." ) ); break;
850 }
851
852 evt->SetPassEvent( false );
853 continue;
854 }
855
856 evt->SetPassEvent( false );
857 restore_state = true;
858 }
859
861
862 m_view->ClearPreview();
863
864 break;
865 }
866 //------------------------------------------------------------------------
867 // Handle TOOL_ACTION special cases
868 //
869 else if( !handleMoveToolActions( evt, aCommit, selection ) )
870 {
871 wxLogTrace( traceSchMove, "doMoveSelection: handleMoveToolActions returned false, exiting" );
872 break; // Exit if told to by handler
873 }
874 //------------------------------------------------------------------------
875 // Handle context menu
876 //
877 else if( evt->IsClick( BUT_RIGHT ) )
878 {
879 m_menu->ShowContextMenu( m_selectionTool->GetSelection() );
880 }
881 //------------------------------------------------------------------------
882 // Handle drop
883 //
884 else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) )
885 {
886 if( m_mode != BREAK )
887 break; // Finish
888 else
889 {
890 didAtLeastOneBreak = true;
891 preprocessBreakOrSliceSelection( aCommit, *evt );
892 selection = m_selectionTool->RequestSelection( SCH_COLLECTOR::MovableItems, true );
893
894 if( m_breakPos )
895 {
898 selection.SetReferencePoint( m_cursor );
899 m_moveOffset = VECTOR2I( 0, 0 );
900 m_breakPos.reset();
901
902 controls->SetCursorPosition( m_cursor, false );
903 prevPos = m_cursor;
904 }
905 }
906 }
907 else if( evt->IsDblClick( BUT_LEFT ) )
908 {
909 // Double click always finishes, even breaks
910 break;
911 }
912 // Don't call SetPassEvent() for events we've handled - let them be consumed
913 else if( evt->IsAction( &SCH_ACTIONS::rotateCW )
915 || evt->IsAction( &ACTIONS::increment )
920 || evt->IsAction( &SCH_ACTIONS::toText )
924 || evt->IsAction( &ACTIONS::duplicate )
926 || evt->IsAction( &ACTIONS::redo ) )
927 {
928 // Event was already handled by handleMoveToolActions, don't pass it on
929 wxLogTrace( traceSchMove, "doMoveSelection: event handled, not passing" );
930 }
931 else
932 {
933 evt->SetPassEvent();
934 }
935
936 controls->SetAutoPan( m_moveInProgress );
937
938 } while( ( evt = Wait() ) ); //Should be assignment not equality test
939
940 SCH_SHEET* targetSheet = hoverSheet;
941
942 if( selectionHasSheetPins || ( selectionIsGraphicsOnly && !lastCtrlDown ) )
943 targetSheet = nullptr;
944
945 if( hoverSheet )
946 {
947 hoverSheet->ClearFlags( BRIGHTENED );
948 m_frame->UpdateItem( hoverSheet, false );
949 }
950
951 if( restore_state )
952 {
953 m_selectionTool->RemoveItemsFromSel( &m_dragAdditions, QUIET_MODE );
954 }
955 else
956 {
957 // Only drop into a sheet when the move is committed, not when canceled.
958 if( targetSheet )
959 {
960 moveSelectionToSheet( selection, targetSheet, aCommit );
962 m_newDragLines.clear();
963 m_changedDragLines.clear();
964 }
965
966 finalizeMoveOperation( selection, aCommit, unselect, internalPoints );
967 }
968
969 m_dragAdditions.clear();
970 m_lineConnectionCache.clear();
971 m_moveInProgress = false;
972 m_breakPos.reset();
973
974 m_hiddenJunctions.clear();
975 m_view->ClearPreview();
976 m_frame->PopTool( aEvent );
977
978 return !restore_state;
979}
980
981
982bool SCH_MOVE_TOOL::checkMoveInProgress( const TOOL_EVENT& aEvent, SCH_COMMIT* aCommit, bool aCurrentModeIsDragLike,
983 bool aWasDragging )
984{
986
987 if( !m_moveInProgress )
988 return false;
989
990 if( aCurrentModeIsDragLike != aWasDragging )
991 {
992 EDA_ITEM* sel = m_selectionTool->GetSelection().Front();
993
994 if( sel && !sel->IsNew() )
995 {
996 // Reset the selected items so we can start again with the current drag mode state
997 aCommit->Revert();
998
999 m_selectionTool->RemoveItemsFromSel( &m_dragAdditions, QUIET_MODE );
1001 m_moveInProgress = false;
1002 controls->SetAutoPan( false );
1003
1004 // Give it a kick so it doesn't have to wait for the first mouse movement to refresh
1005 m_toolMgr->PostAction( SCH_ACTIONS::restartMove );
1006 }
1007 }
1008 else
1009 {
1010 // The tool hotkey is interpreted as a click when already dragging/moving
1011 m_toolMgr->PostAction( ACTIONS::cursorClick );
1012 }
1013
1014 return true;
1015}
1016
1017
1019{
1020 SCH_SELECTION& userSelection = m_selectionTool->GetSelection();
1021
1022 // If a single pin is selected, promote the move selection to its parent symbol
1023 if( userSelection.GetSize() == 1 )
1024 {
1025 EDA_ITEM* selItem = userSelection.Front();
1026
1027 if( selItem->Type() == SCH_PIN_T )
1028 {
1029 EDA_ITEM* parent = selItem->GetParent();
1030
1031 if( parent->Type() == SCH_SYMBOL_T )
1032 {
1033 m_selectionTool->ClearSelection();
1034 m_selectionTool->AddItemToSel( parent );
1035 }
1036 }
1037 }
1038
1039 // Be sure that there is at least one item that we can move. If there's no selection try
1040 // looking for the stuff under mouse cursor (i.e. KiCad old-style hover selection).
1041 SCH_SELECTION& selection = m_selectionTool->RequestSelection( SCH_COLLECTOR::MovableItems, true );
1042 aUnselect = selection.IsHover();
1043
1044 return selection;
1045}
1046
1047
1048void SCH_MOVE_TOOL::refreshSelectionTraits( const SCH_SELECTION& aSelection, bool& aHasSheetPins,
1049 bool& aHasGraphicItems, bool& aHasNonGraphicItems,
1050 bool& aIsGraphicsOnly )
1051{
1052 aHasSheetPins = false;
1053 aHasGraphicItems = false;
1054 aHasNonGraphicItems = false;
1055
1056 for( EDA_ITEM* edaItem : aSelection )
1057 {
1058 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( edaItem );
1059
1060 if( schItem->Type() == SCH_SHEET_PIN_T )
1061 aHasSheetPins = true;
1062
1063 if( isGraphicItemForDrop( schItem ) )
1064 aHasGraphicItems = true;
1065 else if( schItem->Type() != SCH_SHEET_T )
1066 aHasNonGraphicItems = true;
1067 }
1068
1069 aIsGraphicsOnly = aHasGraphicItems && !aHasNonGraphicItems;
1070}
1071
1072
1074{
1075 // Drag of split items start over top of their other segment, so we want to skip grabbing
1076 // the segments we split from
1077 if( m_mode != DRAG && m_mode != BREAK )
1078 return;
1079
1080 EDA_ITEMS connectedDragItems;
1081
1082 // Add connections to the selection for a drag.
1083 // Do all non-labels/entries first so we don't add junctions to drag when the line will
1084 // eventually be drag selected.
1085 std::vector<SCH_ITEM*> stageTwo;
1086
1087 for( EDA_ITEM* edaItem : aSelection )
1088 {
1089 SCH_ITEM* item = static_cast<SCH_ITEM*>( edaItem );
1090 std::vector<VECTOR2I> connections;
1091
1092 switch( item->Type() )
1093 {
1094 case SCH_LABEL_T:
1095 case SCH_HIER_LABEL_T:
1096 case SCH_GLOBAL_LABEL_T:
1098 stageTwo.emplace_back( item );
1099 break;
1100
1101 case SCH_LINE_T:
1102 static_cast<SCH_LINE*>( item )->GetSelectedPoints( connections );
1103 break;
1104
1105 default:
1106 connections = item->GetConnectionPoints();
1107 }
1108
1109 for( const VECTOR2I& point : connections )
1110 getConnectedDragItems( aCommit, item, point, connectedDragItems );
1111 }
1112
1113 // Go back and get all label connections now that we can test for drag-selected lines
1114 // the labels might be on
1115 for( SCH_ITEM* item : stageTwo )
1116 {
1117 for( const VECTOR2I& point : item->GetConnectionPoints() )
1118 getConnectedDragItems( aCommit, item, point, connectedDragItems );
1119 }
1120
1121 for( EDA_ITEM* item : connectedDragItems )
1122 {
1123 m_dragAdditions.push_back( item->m_Uuid );
1124 m_selectionTool->AddItemToSel( item, QUIET_MODE );
1125 }
1126
1127 // Pre-cache all connections of our selected objects so we can keep track of what they
1128 // were originally connected to as we drag them around
1129 for( EDA_ITEM* edaItem : aSelection )
1130 {
1131 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( edaItem );
1132
1133 if( schItem->Type() == SCH_LINE_T )
1134 {
1135 SCH_LINE* line = static_cast<SCH_LINE*>( schItem );
1136
1137 // Store the original angle of the line; needed later to decide which segment
1138 // to extend when they've become zero length
1139 line->StoreAngle();
1140
1141 for( const VECTOR2I& point : line->GetConnectionPoints() )
1142 getConnectedItems( line, point, m_lineConnectionCache[line] );
1143 }
1144 }
1145}
1146
1147
1148void SCH_MOVE_TOOL::setupItemsForMove( SCH_SELECTION& aSelection, std::vector<DANGLING_END_ITEM>& aInternalPoints )
1149{
1150 // Mark the edges of the block with dangling flags for a move
1151 for( EDA_ITEM* item : aSelection )
1152 static_cast<SCH_ITEM*>( item )->GetEndPoints( aInternalPoints );
1153
1154 std::vector<DANGLING_END_ITEM> endPointsByType = aInternalPoints;
1155 std::vector<DANGLING_END_ITEM> endPointsByPos = endPointsByType;
1156 DANGLING_END_ITEM_HELPER::sort_dangling_end_items( endPointsByType, endPointsByPos );
1157
1158 for( EDA_ITEM* item : aSelection )
1159 static_cast<SCH_ITEM*>( item )->UpdateDanglingState( endPointsByType, endPointsByPos );
1160}
1161
1162
1164 std::vector<DANGLING_END_ITEM>& aInternalPoints,
1165 GRID_HELPER_GRIDS& aSnapLayer )
1166{
1169 SCH_ITEM* sch_item = static_cast<SCH_ITEM*>( aSelection.Front() );
1170 bool placingNewItems = sch_item && sch_item->IsNew();
1171
1172 //------------------------------------------------------------------------
1173 // Setup a drag or a move
1174 //
1175 m_dragAdditions.clear();
1176 m_specialCaseLabels.clear();
1177 m_specialCaseSheetPins.clear();
1178 aInternalPoints.clear();
1180
1181 for( SCH_ITEM* it : m_frame->GetScreen()->Items() )
1182 {
1183 it->ClearFlags( SELECTED_BY_DRAG );
1184
1185 if( !it->IsSelected() )
1186 it->ClearFlags( STARTPOINT | ENDPOINT );
1187 }
1188
1189 setupItemsForDrag( aSelection, aCommit );
1190 setupItemsForMove( aSelection, aInternalPoints );
1191
1192 // Hide junctions connected to line endpoints that are not selected
1193 m_hiddenJunctions.clear();
1194
1195 for( EDA_ITEM* item : aSelection )
1196 item->SetFlags( STRUCT_DELETED );
1197
1198 for( EDA_ITEM* edaItem : aSelection )
1199 {
1200 if( edaItem->Type() != SCH_LINE_T )
1201 continue;
1202
1203 SCH_LINE* line = static_cast<SCH_LINE*>( edaItem );
1204
1205 for( const VECTOR2I& pt : line->GetConnectionPoints() )
1206 {
1207 SCH_JUNCTION* jct = static_cast<SCH_JUNCTION*>( m_frame->GetScreen()->GetItem( pt, 0, SCH_JUNCTION_T ) );
1208
1209 if( jct && !jct->IsSelected()
1210 && std::find( m_hiddenJunctions.begin(), m_hiddenJunctions.end(), jct ) == m_hiddenJunctions.end() )
1211 {
1213 pt, false );
1214
1215 if( !info.isJunction )
1216 {
1217 jct->SetFlags( STRUCT_DELETED );
1218 m_frame->RemoveFromScreen( jct, m_frame->GetScreen() );
1219 aCommit->Removed( jct, m_frame->GetScreen() );
1220 }
1221 }
1222 }
1223 }
1224
1225 for( EDA_ITEM* item : aSelection )
1226 item->ClearFlags( STRUCT_DELETED );
1227
1228 // Generic setup
1229 aSnapLayer = grid.GetSelectionGrid( aSelection );
1230
1231 for( EDA_ITEM* item : aSelection )
1232 {
1233 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( item );
1234
1235 if( schItem->IsNew() )
1236 {
1237 // Item was added to commit in a previous command
1238
1239 // While SCH_COMMIT::Push() will add any new items to the entered group, we need
1240 // to do it earlier so that the previews while moving are correct.
1241 if( SCH_GROUP* enteredGroup = m_selectionTool->GetEnteredGroup() )
1242 {
1243 if( schItem->IsGroupableType() && !schItem->GetParentGroup() )
1244 {
1245 aCommit->Modify( enteredGroup, m_frame->GetScreen(), RECURSE_MODE::NO_RECURSE );
1246 enteredGroup->AddItem( schItem );
1247 }
1248 }
1249 }
1250 else if( schItem->GetParent() && schItem->GetParent()->IsSelected() )
1251 {
1252 // Item will be (or has been) added to commit by parent
1253 }
1254 else
1255 {
1256 aCommit->Modify( schItem, m_frame->GetScreen(), RECURSE_MODE::RECURSE );
1257 }
1258
1259 schItem->SetFlags( IS_MOVING );
1260
1261 if( SCH_SHAPE* shape = dynamic_cast<SCH_SHAPE*>( schItem ) )
1262 {
1263 shape->SetHatchingDirty();
1264 shape->UpdateHatching();
1265 }
1266
1267 schItem->RunOnChildren(
1268 [&]( SCH_ITEM* aChild )
1269 {
1270 aChild->SetFlags( IS_MOVING );
1271 },
1273
1274 schItem->SetStoredPos( schItem->GetPosition() );
1275 }
1276
1277 // Set up the starting position and move/drag offset
1278 m_cursor = controls->GetCursorPosition();
1279
1280 if( m_mode == BREAK && m_breakPos )
1281 {
1284 aSelection.SetReferencePoint( m_cursor );
1285 m_moveOffset = VECTOR2I( 0, 0 );
1286 m_breakPos.reset();
1287 }
1288
1289 if( aEvent.IsAction( &SCH_ACTIONS::restartMove ) )
1290 {
1291 wxASSERT_MSG( m_anchorPos, "Should be already set from previous cmd" );
1292 }
1293 else if( placingNewItems )
1294 {
1295 m_anchorPos = aSelection.GetReferencePoint();
1296 }
1297
1298 if( m_anchorPos )
1299 {
1300 VECTOR2I delta = m_cursor - ( *m_anchorPos );
1301 bool isPasted = false;
1302
1303 // Drag items to the current cursor position
1304 for( EDA_ITEM* item : aSelection )
1305 {
1306 // Don't double move pins, fields, etc.
1307 if( item->GetParent() && item->GetParent()->IsSelected() )
1308 continue;
1309
1310 moveItem( item, delta );
1311 updateItem( item, false );
1312
1313 isPasted |= ( item->GetFlags() & IS_PASTED ) != 0;
1314 }
1315
1316 // The first time pasted items are moved we need to store the position of the cursor
1317 // so that rotate while moving works as expected (instead of around the original
1318 // anchor point)
1319 if( isPasted )
1320 aSelection.SetReferencePoint( m_cursor );
1321
1323 }
1324 // For some items, moving the cursor to anchor is not good (for instance large
1325 // hierarchical sheets or symbols can have the anchor outside the view)
1326 else if( aSelection.Size() == 1 && !sch_item->IsMovableFromAnchorPoint() )
1327 {
1330 }
1331 else
1332 {
1333 if( m_frame->GetMoveWarpsCursor() )
1334 {
1335 // User wants to warp the mouse
1336 m_cursor = grid.BestDragOrigin( m_cursor, aSnapLayer, aSelection );
1337 aSelection.SetReferencePoint( m_cursor );
1338 }
1339 else
1340 {
1341 // User does not want to warp the mouse
1343 }
1344 }
1345
1346 controls->SetCursorPosition( m_cursor, false );
1347 controls->SetAutoPan( true );
1348 m_moveInProgress = true;
1349}
1350
1351
1353 bool aHasSheetPins, bool aIsGraphicsOnly, bool aCtrlDown )
1354{
1355 // Determine potential target sheet
1356 SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( m_frame->GetScreen()->GetItem( aCursorPos, 0, SCH_SHEET_T ) );
1357
1358 if( sheet && sheet->IsSelected() )
1359 sheet = nullptr; // Never target a selected sheet
1360
1361 if( !sheet )
1362 {
1363 // Build current selection bounding box in its (already moved) position
1364 BOX2I selBBox;
1365
1366 for( EDA_ITEM* it : aSelection )
1367 {
1368 if( SCH_ITEM* schIt = dynamic_cast<SCH_ITEM*>( it ) )
1369 selBBox.Merge( schIt->GetBoundingBox() );
1370 }
1371
1372 if( selBBox.GetWidth() > 0 && selBBox.GetHeight() > 0 )
1373 {
1374 VECTOR2I selCenter( selBBox.GetX() + selBBox.GetWidth() / 2,
1375 selBBox.GetY() + selBBox.GetHeight() / 2 );
1376
1377 // Find first non-selected sheet whose body fully contains the selection or at
1378 // least contains its center point
1379 for( SCH_ITEM* it : m_frame->GetScreen()->Items().OfType( SCH_SHEET_T ) )
1380 {
1381 SCH_SHEET* candidate = static_cast<SCH_SHEET*>( it );
1382
1383 if( candidate->IsSelected() || candidate->IsTopLevelSheet() )
1384 continue;
1385
1386 BOX2I body = candidate->GetBodyBoundingBox();
1387
1388 if( body.Contains( selBBox ) || body.Contains( selCenter ) )
1389 {
1390 sheet = candidate;
1391 break;
1392 }
1393 }
1394 }
1395 }
1396
1397 // Don't drop into a sheet if any connection point of the selection lands on a sheet pin.
1398 // This indicates the user is trying to connect to the pin, not drop into the sheet.
1399 if( sheet )
1400 {
1401 for( EDA_ITEM* it : aSelection )
1402 {
1403 SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( it );
1404
1405 if( !schItem )
1406 continue;
1407
1408 for( const VECTOR2I& pt : schItem->GetConnectionPoints() )
1409 {
1410 if( sheet->GetPin( pt ) )
1411 {
1412 sheet = nullptr;
1413 break;
1414 }
1415 }
1416
1417 if( !sheet )
1418 break;
1419 }
1420 }
1421
1422 bool dropAllowedBySelection = !aHasSheetPins;
1423 bool dropAllowedByModifiers = !aIsGraphicsOnly || aCtrlDown;
1424
1425 if( sheet && !( dropAllowedBySelection && dropAllowedByModifiers ) )
1426 sheet = nullptr;
1427
1428 return sheet;
1429}
1430
1431
1433 SCH_COMMIT* aCommit, int& aXBendCount, int& aYBendCount,
1434 const EE_GRID_HELPER& aGrid )
1435{
1436 wxLogTrace( traceSchMove, "performItemMove: delta=(%d,%d), moveOffset=(%d,%d), selection size=%u",
1437 aDelta.x, aDelta.y, m_moveOffset.x, m_moveOffset.y, aSelection.GetSize() );
1438
1439 // We need to check if the movement will change the net offset direction on the X and Y
1440 // axes. This is because we remerge added bend lines in realtime, and we also account for
1441 // the direction of the move when adding bend lines. So, if the move direction changes,
1442 // we need to split it into a move that gets us back to zero, then the rest of the move.
1443 std::vector<VECTOR2I> splitMoves;
1444
1445 if( alg::signbit( m_moveOffset.x ) != alg::signbit( ( m_moveOffset + aDelta ).x ) )
1446 {
1447 splitMoves.emplace_back( VECTOR2I( -1 * m_moveOffset.x, 0 ) );
1448 splitMoves.emplace_back( VECTOR2I( aDelta.x + m_moveOffset.x, 0 ) );
1449 }
1450 else
1451 {
1452 splitMoves.emplace_back( VECTOR2I( aDelta.x, 0 ) );
1453 }
1454
1455 if( alg::signbit( m_moveOffset.y ) != alg::signbit( ( m_moveOffset + aDelta ).y ) )
1456 {
1457 splitMoves.emplace_back( VECTOR2I( 0, -1 * m_moveOffset.y ) );
1458 splitMoves.emplace_back( VECTOR2I( 0, aDelta.y + m_moveOffset.y ) );
1459 }
1460 else
1461 {
1462 splitMoves.emplace_back( VECTOR2I( 0, aDelta.y ) );
1463 }
1464
1465 m_moveOffset += aDelta;
1466
1467 // Split the move into X and Y moves so we can correctly drag orthogonal lines
1468 for( const VECTOR2I& splitDelta : splitMoves )
1469 {
1470 // Skip non-moves
1471 if( splitDelta == VECTOR2I( 0, 0 ) )
1472 continue;
1473
1474 for( EDA_ITEM* item : aSelection.GetItemsSortedByTypeAndXY( ( aDelta.x >= 0 ),
1475 ( aDelta.y >= 0 ) ) )
1476 {
1477 // Don't double move pins, fields, etc.
1478 if( item->GetParent() && item->GetParent()->IsSelected() )
1479 continue;
1480
1481 SCH_LINE* line = dynamic_cast<SCH_LINE*>( item );
1482 bool isLineModeConstrained = false;
1483
1484 if( EESCHEMA_SETTINGS* cfg = GetAppSettings<EESCHEMA_SETTINGS>( "eeschema" ) )
1485 isLineModeConstrained = cfg->m_Drawing.line_mode != LINE_MODE::LINE_MODE_FREE;
1486
1487 // Only partially selected drag lines in orthogonal line mode need special handling
1488 if( ( m_mode == DRAG ) && isLineModeConstrained && line
1489 && line->HasFlag( STARTPOINT ) != line->HasFlag( ENDPOINT ) )
1490 {
1491 orthoLineDrag( aCommit, line, splitDelta, aXBendCount, aYBendCount, aGrid );
1492 }
1493
1494 // Move all other items normally, including the selected end of partially selected
1495 // lines
1496 moveItem( item, splitDelta );
1497 updateItem( item, false );
1498
1499 // Update any lines connected to sheet pins to the sheet pin's location (which may
1500 // not exactly follow the splitDelta as the pins are constrained along the sheet
1501 // edges)
1502 for( const auto& [pin, lineEnd] : m_specialCaseSheetPins )
1503 {
1504 if( lineEnd.second && lineEnd.first->HasFlag( STARTPOINT ) )
1505 lineEnd.first->SetStartPoint( pin->GetPosition() );
1506 else if( !lineEnd.second && lineEnd.first->HasFlag( ENDPOINT ) )
1507 lineEnd.first->SetEndPoint( pin->GetPosition() );
1508 }
1509 }
1510 }
1511
1512 if( aSelection.HasReferencePoint() )
1513 aSelection.SetReferencePoint( aSelection.GetReferencePoint() + aDelta );
1514}
1515
1516
1518 const SCH_SELECTION& aSelection )
1519{
1520 wxLogTrace( traceSchMove, "handleMoveToolActions: received event, action=%s",
1521 aEvent->Format().c_str() );
1522
1523 if( aEvent->IsAction( &ACTIONS::doDelete ) )
1524 {
1525 wxLogTrace( traceSchMove, "handleMoveToolActions: doDelete, exiting move" );
1526 const_cast<TOOL_EVENT*>( aEvent )->SetPassEvent();
1527 return false; // Exit on delete; there will no longer be anything to drag
1528 }
1529 else if( aEvent->IsAction( &ACTIONS::duplicate )
1531 || aEvent->IsAction( &ACTIONS::redo ) )
1532 {
1533 wxBell();
1534 }
1535 else if( aEvent->IsAction( &SCH_ACTIONS::rotateCW ) )
1536 {
1537 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCW event received, selection size=%u",
1538 aSelection.GetSize() );
1539 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::rotateCW, aCommit );
1540 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCW RunSynchronousAction completed" );
1541 updateStoredPositions( aSelection );
1542 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCW updateStoredPositions completed" );
1543 // Note: SCH_EDIT_TOOL::Rotate already posts refreshPreview when moving
1544 }
1545 else if( aEvent->IsAction( &SCH_ACTIONS::rotateCCW ) )
1546 {
1547 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCCW event received, selection size=%u",
1548 aSelection.GetSize() );
1549 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::rotateCCW, aCommit );
1550 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCCW RunSynchronousAction completed" );
1551 updateStoredPositions( aSelection );
1552 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCCW updateStoredPositions completed" );
1553 // Note: SCH_EDIT_TOOL::Rotate already posts refreshPreview when moving
1554 }
1555 else if( aEvent->IsAction( &ACTIONS::increment ) )
1556 {
1557 if( aEvent->HasParameter() )
1558 m_toolMgr->RunSynchronousAction( ACTIONS::increment, aCommit, aEvent->Parameter<ACTIONS::INCREMENT>() );
1559 else
1560 m_toolMgr->RunSynchronousAction( ACTIONS::increment, aCommit, ACTIONS::INCREMENT{ 1, 0 } );
1561
1562 updateStoredPositions( aSelection );
1563 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1564 }
1565 else if( aEvent->IsAction( &SCH_ACTIONS::toDLabel ) )
1566 {
1567 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toDLabel, aCommit );
1568 updateStoredPositions( aSelection );
1569 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1570 }
1571 else if( aEvent->IsAction( &SCH_ACTIONS::toGLabel ) )
1572 {
1573 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toGLabel, aCommit );
1574 updateStoredPositions( aSelection );
1575 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1576 }
1577 else if( aEvent->IsAction( &SCH_ACTIONS::toHLabel ) )
1578 {
1579 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toHLabel, aCommit );
1580 updateStoredPositions( aSelection );
1581 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1582 }
1583 else if( aEvent->IsAction( &SCH_ACTIONS::toLabel ) )
1584 {
1585 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toLabel, aCommit );
1586 updateStoredPositions( aSelection );
1587 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1588 }
1589 else if( aEvent->IsAction( &SCH_ACTIONS::toText ) )
1590 {
1591 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toText, aCommit );
1592 updateStoredPositions( aSelection );
1593 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1594 }
1595 else if( aEvent->IsAction( &SCH_ACTIONS::toTextBox ) )
1596 {
1597 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toTextBox, aCommit );
1598 updateStoredPositions( aSelection );
1599 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1600 }
1601 else if( aEvent->Action() == TA_CHOICE_MENU_CHOICE )
1602 {
1603 if( *aEvent->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT
1605 {
1606 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( m_selectionTool->GetSelection().Front() );
1607 int unit = *aEvent->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT;
1608
1609 if( symbol )
1610 {
1611 m_frame->SelectUnit( symbol, unit );
1612 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1613 }
1614 }
1615 else if( *aEvent->GetCommandId() >= ID_POPUP_SCH_SELECT_BODY_STYLE
1617 {
1618 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( m_selectionTool->GetSelection().Front() );
1619 int bodyStyle = ( *aEvent->GetCommandId() - ID_POPUP_SCH_SELECT_BODY_STYLE ) + 1;
1620
1621 if( symbol && symbol->GetBodyStyle() != bodyStyle )
1622 {
1623 m_frame->SelectBodyStyle( symbol, bodyStyle );
1624 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1625 }
1626 }
1627 }
1628 else if( aEvent->IsAction( &SCH_ACTIONS::highlightNet )
1629 || aEvent->IsAction( &SCH_ACTIONS::selectOnPCB ) )
1630 {
1631 // These don't make any sense during a move. Eat them.
1632 }
1633 else
1634 {
1635 return true; // Continue processing
1636 }
1637
1638 return true; // Continue processing
1639}
1640
1641
1643{
1644 wxLogTrace( traceSchMove, "updateStoredPositions: start, selection size=%u",
1645 aSelection.GetSize() );
1646
1647 // After transformations like rotation during a move, we need to update the stored
1648 // positions that moveItem() uses, particularly for sheet pins which rely on them
1649 // for constraint calculations.
1650 int itemCount = 0;
1651
1652 for( EDA_ITEM* item : aSelection )
1653 {
1654 SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( item );
1655
1656 if( !schItem )
1657 continue;
1658
1659 VECTOR2I oldPos = schItem->GetStoredPos();
1660 VECTOR2I newPos = schItem->GetPosition();
1661 schItem->SetStoredPos( newPos );
1662
1663 wxLogTrace( traceSchMove, " item[%d] type=%d: stored pos updated (%d,%d) -> (%d,%d)",
1664 itemCount++, (int) schItem->Type(), oldPos.x, oldPos.y, newPos.x, newPos.y );
1665
1666 // Also update stored positions for sheet pins
1667 if( schItem->Type() == SCH_SHEET_T )
1668 {
1669 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( schItem );
1670 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
1671 {
1672 VECTOR2I pinOldPos = pin->GetStoredPos();
1673 VECTOR2I pinNewPos = pin->GetPosition();
1674 pin->SetStoredPos( pinNewPos );
1675 wxLogTrace( traceSchMove, " sheet pin: stored pos updated (%d,%d) -> (%d,%d)",
1676 pinOldPos.x, pinOldPos.y, pinNewPos.x, pinNewPos.y );
1677 }
1678 }
1679 }
1680
1681 wxLogTrace( traceSchMove, "updateStoredPositions: complete, updated %d items", itemCount );
1682}
1683
1684
1685void SCH_MOVE_TOOL::finalizeMoveOperation( SCH_SELECTION& aSelection, SCH_COMMIT* aCommit, bool aUnselect,
1686 const std::vector<DANGLING_END_ITEM>& aInternalPoints )
1687{
1689 const bool isSlice = ( m_mode == SLICE );
1690 const bool isDragLike = ( m_mode == DRAG || m_mode == BREAK );
1691
1692 // Save whatever new bend lines and changed lines survived the drag
1693 for( SCH_LINE* newLine : m_newDragLines )
1694 {
1695 newLine->ClearEditFlags();
1696 aCommit->Added( newLine, m_frame->GetScreen() );
1697 }
1698
1699 // These lines have been changed, but aren't selected. We need to manually clear these
1700 // edit flags or they'll stick around.
1701 for( SCH_LINE* oldLine : m_changedDragLines )
1702 oldLine->ClearEditFlags();
1703
1704 controls->ForceCursorPosition( false );
1705 controls->ShowCursor( false );
1706 controls->SetAutoPan( false );
1707
1708 m_moveOffset = { 0, 0 };
1709 m_anchorPos.reset();
1710
1711 // One last update after exiting loop (for slower stuff, such as updating SCREEN's RTree)
1712 for( EDA_ITEM* item : aSelection )
1713 {
1714 updateItem( item, true );
1715
1716 if( SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( item ) )
1717 sch_item->SetConnectivityDirty( true );
1718 }
1719
1720 if( aSelection.GetSize() == 1 && aSelection.Front()->IsNew() )
1721 m_frame->SaveCopyForRepeatItem( static_cast<SCH_ITEM*>( aSelection.Front() ) );
1722
1723 m_selectionTool->RemoveItemsFromSel( &m_dragAdditions, QUIET_MODE );
1724
1726
1727 // If we move items away from a junction, we _may_ want to add a junction there
1728 // to denote the state
1729 for( const DANGLING_END_ITEM& it : aInternalPoints )
1730 {
1731 if( m_frame->GetScreen()->IsExplicitJunctionNeeded( it.GetPosition() ) )
1732 lwbTool->AddJunction( aCommit, m_frame->GetScreen(), it.GetPosition() );
1733 }
1734
1735 // Create a selection of original selection, drag selected/changed items, and new bend
1736 // lines for later before we clear them in the aCommit. We'll need these to check for new
1737 // junctions needed, etc.
1738 SCH_SELECTION selectionCopy( aSelection );
1739
1740 for( SCH_LINE* line : m_newDragLines )
1741 selectionCopy.Add( line );
1742
1743 for( SCH_LINE* line : m_changedDragLines )
1744 selectionCopy.Add( line );
1745
1746 lwbTool->TrimOverLappingWires( aCommit, &selectionCopy );
1747 lwbTool->AddJunctionsIfNeeded( aCommit, &selectionCopy );
1748
1749 // This needs to run prior to `RecalculateConnections` because we need to identify the
1750 // lines that are newly dangling
1751 if( isDragLike && !isSlice )
1752 trimDanglingLines( aCommit );
1753
1754 // Auto-rotate any moved labels
1755 for( EDA_ITEM* item : aSelection )
1756 m_frame->AutoRotateItem( m_frame->GetScreen(), static_cast<SCH_ITEM*>( item ) );
1757
1758 m_frame->Schematic().CleanUp( aCommit );
1759
1760 for( EDA_ITEM* item : m_frame->GetScreen()->Items() )
1761 item->ClearEditFlags();
1762
1763 // Ensure any selected item not in screen main list (for instance symbol fields) has its
1764 // edit flags cleared
1765 for( EDA_ITEM* item : selectionCopy )
1766 item->ClearEditFlags();
1767
1768 m_newDragLines.clear();
1769 m_changedDragLines.clear();
1770
1771 if( aUnselect )
1772 m_toolMgr->RunAction( ACTIONS::selectionClear );
1773 else
1774 m_selectionTool->RebuildSelection(); // Schematic cleanup might have merged lines, etc.
1775}
1776
1777
1779 SCH_COMMIT* aCommit )
1780{
1781 SCH_SCREEN* destScreen = aTargetSheet->GetScreen();
1782 SCH_SCREEN* srcScreen = m_frame->GetScreen();
1783
1784 BOX2I bbox;
1785
1786 for( EDA_ITEM* item : aSelection )
1787 bbox.Merge( static_cast<SCH_ITEM*>( item )->GetBoundingBox() );
1788
1789 VECTOR2I offset = VECTOR2I( 0, 0 ) - bbox.GetPosition();
1790 int step = schIUScale.MilsToIU( 50 );
1791 bool overlap = false;
1792
1793 do
1794 {
1795 BOX2I moved = bbox;
1796 moved.Move( offset );
1797 overlap = false;
1798
1799 for( SCH_ITEM* existing : destScreen->Items() )
1800 {
1801 if( moved.Intersects( existing->GetBoundingBox() ) )
1802 {
1803 overlap = true;
1804 break;
1805 }
1806 }
1807
1808 if( overlap )
1809 offset += VECTOR2I( step, step );
1810 } while( overlap );
1811
1812 for( EDA_ITEM* item : aSelection )
1813 {
1814 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( item );
1815
1816 // Remove from current screen and view manually
1817 m_frame->RemoveFromScreen( schItem, srcScreen );
1818
1819 // Move the item
1820 schItem->Move( offset );
1821
1822 // Add to destination screen manually (won't add to view since it's not current)
1823 destScreen->Append( schItem );
1824
1825 // Record in commit with CHT_DONE flag to bypass automatic screen/view operations
1826 aCommit->Stage( schItem, CHT_REMOVE | CHT_DONE, srcScreen );
1827 aCommit->Stage( schItem, CHT_ADD | CHT_DONE, destScreen );
1828 }
1829}
1830
1831
1833{
1834 // Need a local cleanup first to ensure we remove unneeded junctions
1835 m_frame->Schematic().CleanUp( aCommit, m_frame->GetScreen() );
1836
1837 std::set<SCH_ITEM*> danglers;
1838
1839 std::function<void( SCH_ITEM* )> changeHandler =
1840 [&]( SCH_ITEM* aChangedItem ) -> void
1841 {
1842 m_toolMgr->GetView()->Update( aChangedItem, KIGFX::REPAINT );
1843
1844 // Delete newly dangling lines:
1845 // Find split segments (one segment is new, the other is changed) that
1846 // we aren't dragging and don't have selected
1847 if( aChangedItem->HasFlag( IS_BROKEN) && aChangedItem->IsDangling()
1848 && !aChangedItem->IsSelected() )
1849 {
1850 danglers.insert( aChangedItem );
1851 }
1852 };
1853
1854 m_frame->GetScreen()->TestDanglingEnds( nullptr, &changeHandler );
1855
1856 for( SCH_ITEM* line : danglers )
1857 {
1858 line->SetFlags( STRUCT_DELETED );
1859 aCommit->Removed( line, m_frame->GetScreen() );
1860 updateItem( line, false ); // Update any cached visuals before commit processes
1861 m_frame->RemoveFromScreen( line, m_frame->GetScreen() );
1862 }
1863}
1864
1865
1866void SCH_MOVE_TOOL::getConnectedItems( SCH_ITEM* aOriginalItem, const VECTOR2I& aPoint, EDA_ITEMS& aList )
1867{
1868 EE_RTREE& items = m_frame->GetScreen()->Items();
1869 EE_RTREE::EE_TYPE itemsOverlapping = items.Overlapping( aOriginalItem->GetBoundingBox() );
1870 SCH_ITEM* foundJunction = nullptr;
1871 SCH_ITEM* foundSymbol = nullptr;
1872
1873 // If you're connected to a junction, you're only connected to the junction.
1874 //
1875 // But, if you're connected to a junction on a pin, you're only connected to the pin. This
1876 // is because junctions and pins have different logic for how bend lines are generated and
1877 // we need to prioritize the pin version in some cases.
1878 for( SCH_ITEM* item : itemsOverlapping )
1879 {
1880 if( item != aOriginalItem && item->IsConnected( aPoint ) )
1881 {
1882 if( item->Type() == SCH_JUNCTION_T )
1883 foundJunction = item;
1884 else if( item->Type() == SCH_SYMBOL_T )
1885 foundSymbol = item;
1886 }
1887 }
1888
1889 if( foundSymbol && foundJunction )
1890 {
1891 aList.push_back( foundSymbol );
1892 return;
1893 }
1894
1895 if( foundJunction )
1896 {
1897 aList.push_back( foundJunction );
1898 return;
1899 }
1900
1901
1902 for( SCH_ITEM* test : itemsOverlapping )
1903 {
1904 if( test == aOriginalItem || !test->CanConnect( aOriginalItem ) )
1905 continue;
1906
1907 switch( test->Type() )
1908 {
1909 case SCH_LINE_T:
1910 {
1911 SCH_LINE* line = static_cast<SCH_LINE*>( test );
1912
1913 // When getting lines for the connection cache, it's important that we only add
1914 // items at the unselected end, since that is the only end that is handled specially.
1915 // Fully selected lines, and the selected end of a partially selected line, are moved
1916 // around normally and don't care about their connections.
1917 if( ( line->HasFlag( STARTPOINT ) && aPoint == line->GetStartPoint() )
1918 || ( line->HasFlag( ENDPOINT ) && aPoint == line->GetEndPoint() ) )
1919 {
1920 continue;
1921 }
1922
1923 if( test->IsConnected( aPoint ) )
1924 aList.push_back( test );
1925
1926 // Labels can connect to a wire (or bus) anywhere along the length
1927 if( SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( aOriginalItem ) )
1928 {
1929 if( static_cast<SCH_LINE*>( test )->HitTest( label->GetPosition(), 1 ) )
1930 aList.push_back( test );
1931 }
1932
1933 break;
1934 }
1935
1936 case SCH_SHEET_T:
1937 if( aOriginalItem->Type() == SCH_LINE_T )
1938 {
1939 SCH_LINE* line = static_cast<SCH_LINE*>( aOriginalItem );
1940
1941 for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( test )->GetPins() )
1942 {
1943 if( pin->IsConnected( aPoint ) )
1944 {
1945 if( pin->IsSelected() )
1946 m_specialCaseSheetPins[pin] = { line, line->GetStartPoint() == aPoint };
1947
1948 aList.push_back( pin );
1949 }
1950 }
1951 }
1952
1953 break;
1954
1955 case SCH_SYMBOL_T:
1956 case SCH_JUNCTION_T:
1957 case SCH_NO_CONNECT_T:
1958 if( test->IsConnected( aPoint ) )
1959 aList.push_back( test );
1960
1961 break;
1962
1963 case SCH_LABEL_T:
1964 case SCH_GLOBAL_LABEL_T:
1965 case SCH_HIER_LABEL_T:
1967 // Labels can connect to a wire (or bus) anywhere along the length
1968 if( aOriginalItem->Type() == SCH_LINE_T && test->CanConnect( aOriginalItem ) )
1969 {
1970 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( test );
1971 SCH_LINE* line = static_cast<SCH_LINE*>( aOriginalItem );
1972
1973 if( line->HitTest( label->GetPosition(), 1 ) )
1974 aList.push_back( label );
1975 }
1976
1977 break;
1978
1981 if( aOriginalItem->Type() == SCH_LINE_T && test->CanConnect( aOriginalItem ) )
1982 {
1983 SCH_TEXT* label = static_cast<SCH_TEXT*>( test );
1984 SCH_LINE* line = static_cast<SCH_LINE*>( aOriginalItem );
1985
1986 if( line->HitTest( aPoint, 1 ) )
1987 aList.push_back( label );
1988 }
1989
1990 break;
1991
1992 default:
1993 break;
1994 }
1995 }
1996}
1997
1998
1999void SCH_MOVE_TOOL::getConnectedDragItems( SCH_COMMIT* aCommit, SCH_ITEM* aSelectedItem, const VECTOR2I& aPoint,
2000 EDA_ITEMS& aList )
2001{
2002 EE_RTREE& items = m_frame->GetScreen()->Items();
2003 EE_RTREE::EE_TYPE itemsOverlappingRTree = items.Overlapping( aSelectedItem->GetBoundingBox() );
2004 std::vector<SCH_ITEM*> itemsConnectable;
2005 bool ptHasUnselectedJunction = false;
2006
2007 auto makeNewWire =
2008 [this]( SCH_COMMIT* commit, SCH_ITEM* fixed, SCH_ITEM* selected, const VECTOR2I& start,
2009 const VECTOR2I& end )
2010 {
2011 SCH_LINE* newWire;
2012
2013 // Add a new newWire between the fixed item and the selected item so the selected
2014 // item can be dragged.
2015 if( fixed->GetLayer() == LAYER_BUS_JUNCTION || fixed->GetLayer() == LAYER_BUS
2016 || selected->GetLayer() == LAYER_BUS )
2017 {
2018 newWire = new SCH_LINE( start, LAYER_BUS );
2019 }
2020 else
2021 {
2022 newWire = new SCH_LINE( start, LAYER_WIRE );
2023 }
2024
2025 newWire->SetFlags( IS_NEW );
2026 newWire->SetConnectivityDirty( true );
2027
2028 SCH_LINE* selectedLine = dynamic_cast<SCH_LINE*>( selected );
2029 SCH_LINE* fixedLine = dynamic_cast<SCH_LINE*>( fixed );
2030
2031 if( selectedLine )
2032 {
2033 newWire->SetLastResolvedState( selected );
2034 cloneWireConnection( newWire, selectedLine, m_frame );
2035 }
2036 else if( fixedLine )
2037 {
2038 newWire->SetLastResolvedState( fixed );
2039 cloneWireConnection( newWire, fixedLine, m_frame );
2040 }
2041
2042 newWire->SetEndPoint( end );
2043 m_frame->AddToScreen( newWire, m_frame->GetScreen() );
2044 commit->Added( newWire, m_frame->GetScreen() );
2045
2046 return newWire;
2047 };
2048
2049 auto makeNewJunction =
2050 [this]( SCH_COMMIT* commit, SCH_LINE* line, const VECTOR2I& pt )
2051 {
2052 SCH_JUNCTION* junction = new SCH_JUNCTION( pt );
2053 junction->SetFlags( IS_NEW );
2054 junction->SetConnectivityDirty( true );
2055 junction->SetLastResolvedState( line );
2056
2057 if( line->IsBus() )
2058 junction->SetLayer( LAYER_BUS_JUNCTION );
2059
2060 m_frame->AddToScreen( junction, m_frame->GetScreen() );
2061 commit->Added( junction, m_frame->GetScreen() );
2062
2063 return junction;
2064 };
2065
2066 for( SCH_ITEM* item : itemsOverlappingRTree )
2067 {
2068 if( item->Type() == SCH_SHEET_T )
2069 {
2070 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
2071
2072 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
2073 {
2074 if( !pin->IsSelected()
2075 && pin->GetPosition() == aPoint
2076 && pin->CanConnect( aSelectedItem ) )
2077 {
2078 itemsConnectable.push_back( pin );
2079 }
2080 }
2081
2082 continue;
2083 }
2084
2085 // Skip ourselves, skip already selected items (but not lines, they need both ends tested)
2086 // and skip unconnectable items
2087 if( item == aSelectedItem
2088 || ( item->Type() != SCH_LINE_T && item->IsSelected() )
2089 || !item->CanConnect( aSelectedItem ) )
2090 {
2091 continue;
2092 }
2093
2094 itemsConnectable.push_back( item );
2095 }
2096
2097 for( SCH_ITEM* item : itemsConnectable )
2098 {
2099 if( item->Type() == SCH_JUNCTION_T && item->IsConnected( aPoint ) && !item->IsSelected() )
2100 {
2101 ptHasUnselectedJunction = true;
2102 break;
2103 }
2104 }
2105
2106 SCH_LINE* newWire = nullptr;
2107
2108 for( SCH_ITEM* test : itemsConnectable )
2109 {
2110 KICAD_T testType = test->Type();
2111
2112 switch( testType )
2113 {
2114 case SCH_LINE_T:
2115 {
2116 // Select the connected end of wires/bus connections that don't have an unselected
2117 // junction isolating them from the drag
2118 if( ptHasUnselectedJunction )
2119 break;
2120
2121 SCH_LINE* line = static_cast<SCH_LINE*>( test );
2122
2123 if( line->GetStartPoint() == aPoint )
2124 {
2125 // It's possible to manually select one end of a line and get a drag
2126 // connected other end, so we set the flag and then early exit the loop
2127 // later if the other drag items like labels attached to the line have
2128 // already been grabbed during the partial selection process.
2129 line->SetFlags( STARTPOINT );
2130
2131 if( line->HasFlag( SELECTED ) || line->HasFlag( SELECTED_BY_DRAG ) )
2132 {
2133 continue;
2134 }
2135 else
2136 {
2137 line->SetFlags( SELECTED_BY_DRAG );
2138 aList.push_back( line );
2139 }
2140 }
2141 else if( line->GetEndPoint() == aPoint )
2142 {
2143 line->SetFlags( ENDPOINT );
2144
2145 if( line->HasFlag( SELECTED ) || line->HasFlag( SELECTED_BY_DRAG ) )
2146 {
2147 continue;
2148 }
2149 else
2150 {
2151 line->SetFlags( SELECTED_BY_DRAG );
2152 aList.push_back( line );
2153 }
2154 }
2155 else
2156 {
2157 switch( aSelectedItem->Type() )
2158 {
2159 // These items can connect anywhere along a line
2162 case SCH_LABEL_T:
2163 case SCH_HIER_LABEL_T:
2164 case SCH_GLOBAL_LABEL_T:
2166 // Only add a line if this line is unselected; if the label and line are both
2167 // selected they'll move together
2168 if( line->HitTest( aPoint, 1 ) && !line->HasFlag( SELECTED )
2169 && !line->HasFlag( SELECTED_BY_DRAG ) )
2170 {
2171 newWire = makeNewWire( aCommit, line, aSelectedItem, aPoint, aPoint );
2172 newWire->SetFlags( SELECTED_BY_DRAG | STARTPOINT );
2173 newWire->StoreAngle( ( line->Angle() + ANGLE_90 ).Normalize() );
2174 aList.push_back( newWire );
2175
2176 if( aPoint != line->GetStartPoint() && aPoint != line->GetEndPoint() )
2177 {
2178 // Split line in half
2179 aCommit->Modify( line, m_frame->GetScreen() );
2180
2181 VECTOR2I oldEnd = line->GetEndPoint();
2182 line->SetEndPoint( aPoint );
2183
2184 makeNewWire( aCommit, line, line, aPoint, oldEnd );
2185 makeNewJunction( aCommit, line, aPoint );
2186 }
2187 else
2188 {
2189 m_lineConnectionCache[ newWire ] = { line };
2190 m_lineConnectionCache[ line ] = { newWire };
2191 }
2192 }
2193 break;
2194
2195 default:
2196 break;
2197 }
2198
2199 break;
2200 }
2201
2202 // Since only one end is going to move, the movement vector of any labels attached to
2203 // it is scaled by the proportion of the line length the label is from the moving end.
2204 for( SCH_ITEM* item : items.Overlapping( line->GetBoundingBox() ) )
2205 {
2206 SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( item );
2207
2208 if( !label || label->IsSelected() )
2209 continue; // These will be moved on their own because they're selected
2210
2211 if( label->HasFlag( SELECTED_BY_DRAG ) )
2212 continue;
2213
2214 if( label->CanConnect( line ) && line->HitTest( label->GetPosition(), 1 ) )
2215 {
2216 label->SetFlags( SELECTED_BY_DRAG );
2217 aList.push_back( label );
2218
2220 info.attachedLine = line;
2221 info.originalLabelPos = label->GetPosition();
2222 m_specialCaseLabels[label] = info;
2223 }
2224 }
2225
2226 break;
2227 }
2228
2229 case SCH_SHEET_T:
2230 for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( test )->GetPins() )
2231 {
2232 if( pin->IsConnected( aPoint ) )
2233 {
2234 if( pin->IsSelected() && aSelectedItem->Type() == SCH_LINE_T )
2235 {
2236 SCH_LINE* line = static_cast<SCH_LINE*>( aSelectedItem );
2237 m_specialCaseSheetPins[ pin ] = { line, line->GetStartPoint() == aPoint };
2238 }
2239 else if( !newWire )
2240 {
2241 // Add a new wire between the sheetpin and the selected item so the
2242 // selected item can be dragged.
2243 newWire = makeNewWire( aCommit, pin, aSelectedItem, aPoint, aPoint );
2244 newWire->SetFlags( SELECTED_BY_DRAG | STARTPOINT );
2245 aList.push_back( newWire );
2246 }
2247 }
2248 }
2249
2250 break;
2251
2252 case SCH_SYMBOL_T:
2253 case SCH_JUNCTION_T:
2254 if( test->IsConnected( aPoint ) && !newWire )
2255 {
2256 // Add a new wire between the symbol or junction and the selected item so
2257 // the selected item can be dragged.
2258 newWire = makeNewWire( aCommit, test, aSelectedItem, aPoint, aPoint );
2259 newWire->SetFlags( SELECTED_BY_DRAG | STARTPOINT );
2260 aList.push_back( newWire );
2261 }
2262
2263 break;
2264
2265 case SCH_NO_CONNECT_T:
2266 // Select no-connects that are connected to items being moved.
2267 if( !test->HasFlag( SELECTED_BY_DRAG ) && test->IsConnected( aPoint ) )
2268 {
2269 aList.push_back( test );
2270 test->SetFlags( SELECTED_BY_DRAG );
2271 }
2272
2273 break;
2274
2275 case SCH_LABEL_T:
2276 case SCH_GLOBAL_LABEL_T:
2277 case SCH_HIER_LABEL_T:
2279 case SCH_SHEET_PIN_T:
2280 // Performance optimization:
2281 if( test->HasFlag( SELECTED_BY_DRAG ) )
2282 break;
2283
2284 // Select labels that are connected to a wire (or bus) being moved.
2285 if( aSelectedItem->Type() == SCH_LINE_T && test->CanConnect( aSelectedItem ) )
2286 {
2287 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( test );
2288 SCH_LINE* line = static_cast<SCH_LINE*>( aSelectedItem );
2289
2290 bool oneEndFixed = !line->HasFlag( STARTPOINT ) || !line->HasFlag( ENDPOINT );
2291
2292 if( line->HitTest( label->GetTextPos(), 1 ) )
2293 {
2294 if( ( !line->HasFlag( STARTPOINT ) && label->GetPosition() == line->GetStartPoint() )
2295 || ( !line->HasFlag( ENDPOINT ) && label->GetPosition() == line->GetEndPoint() ) )
2296 {
2297 //If we have a line selected at only one end, don't grab labels
2298 //connected directly to the unselected endpoint
2299 break;
2300 }
2301 else
2302 {
2303 label->SetFlags( SELECTED_BY_DRAG );
2304 aList.push_back( label );
2305
2306 if( oneEndFixed )
2307 {
2309 info.attachedLine = line;
2310 info.originalLabelPos = label->GetPosition();
2311 m_specialCaseLabels[label] = info;
2312 }
2313 }
2314 }
2315 }
2316 else if( test->IsConnected( aPoint ) && !newWire )
2317 {
2318 // Add a new wire between the label and the selected item so the selected item
2319 // can be dragged.
2320 newWire = makeNewWire( aCommit, test, aSelectedItem, aPoint, aPoint );
2321 newWire->SetFlags( SELECTED_BY_DRAG | STARTPOINT );
2322 aList.push_back( newWire );
2323 }
2324
2325 break;
2326
2329 // Performance optimization:
2330 if( test->HasFlag( SELECTED_BY_DRAG ) )
2331 break;
2332
2333 // Select bus entries that are connected to a bus being moved.
2334 if( aSelectedItem->Type() == SCH_LINE_T && test->CanConnect( aSelectedItem ) )
2335 {
2336 SCH_LINE* line = static_cast<SCH_LINE*>( aSelectedItem );
2337
2338 if( ( !line->HasFlag( STARTPOINT ) && test->IsConnected( line->GetStartPoint() ) )
2339 || ( !line->HasFlag( ENDPOINT ) && test->IsConnected( line->GetEndPoint() ) ) )
2340 {
2341 // If we have a line selected at only one end, don't grab bus entries
2342 // connected directly to the unselected endpoint
2343 continue;
2344 }
2345
2346 for( VECTOR2I& point : test->GetConnectionPoints() )
2347 {
2348 if( line->HitTest( point, 1 ) )
2349 {
2350 test->SetFlags( SELECTED_BY_DRAG );
2351 aList.push_back( test );
2352
2353 // A bus entry needs its wire & label as well
2354 std::vector<VECTOR2I> ends = test->GetConnectionPoints();
2355 VECTOR2I otherEnd;
2356
2357 if( ends[0] == point )
2358 otherEnd = ends[1];
2359 else
2360 otherEnd = ends[0];
2361
2362 getConnectedDragItems( aCommit, test, otherEnd, aList );
2363
2364 // No need to test the other end of the bus entry
2365 break;
2366 }
2367 }
2368 }
2369
2370 break;
2371
2372 default:
2373 break;
2374 }
2375 }
2376}
2377
2378
2379void SCH_MOVE_TOOL::moveItem( EDA_ITEM* aItem, const VECTOR2I& aDelta )
2380{
2381 static int moveCallCount = 0;
2382 wxLogTrace( traceSchMove, "moveItem[%d]: type=%d, delta=(%d,%d)",
2383 ++moveCallCount, aItem->Type(), aDelta.x, aDelta.y );
2384
2385 switch( aItem->Type() )
2386 {
2387 case SCH_LINE_T:
2388 if( m_mode == MOVE )
2389 {
2390 // In MOVE mode, both endpoints always move
2391 static_cast<SCH_LINE*>( aItem )->Move( aDelta );
2392 }
2393 else
2394 {
2395 // In DRAG mode, only flagged endpoints move - use shared function
2396 MoveSchematicItem( aItem, aDelta );
2397 }
2398
2399 break;
2400
2401 case SCH_PIN_T:
2402 case SCH_FIELD_T:
2403 {
2404 SCH_ITEM* parent = (SCH_ITEM*) aItem->GetParent();
2405 VECTOR2I delta( aDelta );
2406
2407 if( parent && parent->Type() == SCH_SYMBOL_T )
2408 {
2409 SCH_SYMBOL* symbol = (SCH_SYMBOL*) aItem->GetParent();
2410 TRANSFORM transform = symbol->GetTransform().InverseTransform();
2411
2412 delta = transform.TransformCoordinate( delta );
2413 }
2414
2415 static_cast<SCH_ITEM*>( aItem )->Move( delta );
2416
2417 // If we're moving a field with respect to its parent then it's no longer auto-placed
2418 if( aItem->Type() == SCH_FIELD_T && parent && !parent->IsSelected() )
2420
2421 break;
2422 }
2423
2424 case SCH_SHEET_PIN_T:
2425 // Use shared function for sheet pin movement
2426 MoveSchematicItem( aItem, aDelta );
2427 break;
2428
2429 case SCH_LABEL_T:
2431 case SCH_GLOBAL_LABEL_T:
2432 case SCH_HIER_LABEL_T:
2433 {
2434 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( aItem );
2435
2436 if( m_specialCaseLabels.count( label ) )
2437 {
2439 SEG currentLine( info.attachedLine->GetStartPoint(), info.attachedLine->GetEndPoint() );
2440 label->SetPosition( currentLine.NearestPoint( info.originalLabelPos ) );
2441 }
2442 else
2443 {
2444 label->Move( aDelta );
2445 }
2446
2447 break;
2448 }
2449
2450 default:
2451 static_cast<SCH_ITEM*>( aItem )->Move( aDelta );
2452 break;
2453 }
2454
2455 aItem->SetFlags( IS_MOVING );
2456}
2457
2458
2460{
2462 SCH_SELECTION& selection = m_selectionTool->RequestSelection( SCH_COLLECTOR::MovableItems );
2463 GRID_HELPER_GRIDS selectionGrid = grid.GetSelectionGrid( selection );
2464 SCH_COMMIT commit( m_toolMgr );
2465
2466 auto doMoveItem =
2467 [&]( EDA_ITEM* item, const VECTOR2I& delta )
2468 {
2469 commit.Modify( item, m_frame->GetScreen(), RECURSE_MODE::RECURSE );
2470
2471 // Ensure only one end is moved when calling moveItem
2472 // i.e. we are in drag mode
2473 MOVE_MODE tmpMode = m_mode;
2474 m_mode = DRAG;
2475 moveItem( item, delta );
2476 m_mode = tmpMode;
2477
2478 item->ClearFlags( IS_MOVING );
2479 updateItem( item, true );
2480 };
2481
2482 for( SCH_ITEM* it : m_frame->GetScreen()->Items() )
2483 {
2484 if( !it->IsSelected() )
2485 it->ClearFlags( STARTPOINT | ENDPOINT );
2486
2487 if( !selection.IsHover() && it->IsSelected() )
2488 it->SetFlags( STARTPOINT | ENDPOINT );
2489
2490 it->SetStoredPos( it->GetPosition() );
2491
2492 if( it->Type() == SCH_SHEET_T )
2493 {
2494 for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( it )->GetPins() )
2495 pin->SetStoredPos( pin->GetPosition() );
2496 }
2497 }
2498
2499 SCH_ALIGNMENT_CALLBACKS callbacks;
2500
2501 callbacks.m_doMoveItem = doMoveItem;
2502
2503 callbacks.m_getConnectedDragItems =
2504 [&]( SCH_ITEM* aItem, const VECTOR2I& aPoint, EDA_ITEMS& aList )
2505 {
2506 getConnectedDragItems( &commit, aItem, aPoint, aList );
2507 };
2508
2509 callbacks.m_updateItem =
2510 [&]( EDA_ITEM* aItem )
2511 {
2512 updateItem( aItem, true );
2513 };
2514
2515 std::vector<EDA_ITEM*> items( selection.begin(), selection.end() );
2516 AlignSchematicItemsToGrid( m_frame->GetScreen(), items, grid, selectionGrid, callbacks );
2517
2519 lwbTool->TrimOverLappingWires( &commit, &selection );
2520 lwbTool->AddJunctionsIfNeeded( &commit, &selection );
2521
2523
2524 m_frame->Schematic().CleanUp( &commit );
2525 commit.Push( _( "Align Items to Grid" ) );
2526 return 0;
2527}
2528
2529
2531{
2532 // Remove new bend lines added during the drag
2533 for( SCH_LINE* newLine : m_newDragLines )
2534 {
2535 m_frame->RemoveFromScreen( newLine, m_frame->GetScreen() );
2536 delete newLine;
2537 }
2538
2539 m_newDragLines.clear();
2540}
2541
2542
constexpr EDA_IU_SCALE schIUScale
Definition base_units.h:114
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
@ CURSOR_RIGHT
Definition actions.h:311
@ CURSOR_LEFT
Definition actions.h:309
@ CURSOR_UP
Definition actions.h:305
@ CURSOR_DOWN
Definition actions.h:307
static TOOL_ACTION undo
Definition actions.h:75
static TOOL_ACTION duplicate
Definition actions.h:84
static TOOL_ACTION doDelete
Definition actions.h:85
static TOOL_ACTION cursorClick
Definition actions.h:180
static TOOL_ACTION redo
Definition actions.h:76
static TOOL_ACTION increment
Definition actions.h:94
static TOOL_ACTION selectionClear
Clear the current selection.
Definition actions.h:224
static TOOL_ACTION refreshPreview
Definition actions.h:159
constexpr const Vec & GetPosition() const
Definition box2.h:211
constexpr coord_type GetY() const
Definition box2.h:208
constexpr size_type GetWidth() const
Definition box2.h:214
constexpr coord_type GetX() const
Definition box2.h:207
constexpr BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition box2.h:658
constexpr size_type GetHeight() const
Definition box2.h:215
constexpr bool Contains(const Vec &aPoint) const
Definition box2.h:168
COMMIT & Added(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
Definition commit.h:84
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
Definition commit.h:106
COMMIT & Removed(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Definition commit.h:96
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Add a menu entry to run a TOOL_ACTION on selected items.
static void sort_dangling_end_items(std::vector< DANGLING_END_ITEM > &aItemListByType, std::vector< DANGLING_END_ITEM > &aItemListByPos)
Both contain the same information.
Definition sch_item.cpp:958
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition sch_item.h:96
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
virtual VECTOR2I GetPosition() const
Definition eda_item.h:277
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition eda_item.cpp:110
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition eda_item.h:147
virtual EDA_GROUP * GetParentGroup() const
Definition eda_item.h:116
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition eda_item.h:149
bool IsSelected() const
Definition eda_item.h:127
EDA_ITEM * GetParent() const
Definition eda_item.h:112
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
Definition eda_item.h:151
bool IsNew() const
Definition eda_item.h:124
const VECTOR2I & GetTextPos() const
Definition eda_text.h:273
Implement an R-tree for fast spatial and type indexing of schematic items.
Definition sch_rtree.h:40
EE_TYPE Overlapping(const BOX2I &aRect) const
Definition sch_rtree.h:246
static const TOOL_EVENT SelectedItemsMoved
Used to inform tools that the selection should temporarily be non-editable.
Definition actions.h:355
An interface for classes handling user events controlling the view behavior such as zooming,...
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Place the cursor immediately at a given point.
virtual void ShowCursor(bool aEnabled)
Enable or disables display of cursor.
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.
const VC_SETTINGS & GetSettings() const
Return the current VIEW_CONTROLS settings.
static TOOL_ACTION rotateCCW
static TOOL_ACTION breakWire
static TOOL_ACTION toText
static TOOL_ACTION restartMove
static TOOL_ACTION toHLabel
static TOOL_ACTION rotateCW
static TOOL_ACTION drag
static TOOL_ACTION toLabel
static TOOL_ACTION alignToGrid
static TOOL_ACTION toDLabel
static TOOL_ACTION slice
static TOOL_ACTION toTextBox
static TOOL_ACTION highlightNet
static TOOL_ACTION repeatDrawItem
static TOOL_ACTION toGLabel
static TOOL_ACTION selectOnPCB
static TOOL_ACTION move
static const std::vector< KICAD_T > MovableItems
COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE) override
Add a change of the item aItem of type aChangeType to the change list.
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.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
void Clone(const SCH_CONNECTION &aOther)
Copies connectivity information (but not parent) from another connection.
Schematic editor (Eeschema) main window.
SCH_SHEET_PATH & GetCurrentSheet() const
A set of SCH_ITEMs (i.e., without duplicates).
Definition sch_group.h:52
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:167
void SetStoredPos(const VECTOR2I &aPos)
Definition sch_item.h:304
virtual bool CanConnect(const SCH_ITEM *aItem) const
Definition sch_item.h:521
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode)
Definition sch_item.h:630
int GetBodyStyle() const
Definition sch_item.h:247
SCH_CONNECTION * InitializeConnection(const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
Create a new connection object associated with this object.
Definition sch_item.cpp:559
virtual void Move(const VECTOR2I &aMoveVector)
Move the item by aMoveVector to a new position.
Definition sch_item.h:398
void SetLayer(SCH_LAYER_ID aLayer)
Definition sch_item.h:341
void SetConnectivityDirty(bool aDirty=true)
Definition sch_item.h:589
void SetFieldsAutoplaced(AUTOPLACE_ALGO aAlgo)
Definition sch_item.h:626
bool IsConnected(const VECTOR2I &aPoint) const
Test the item to see if it is connected to aPoint.
Definition sch_item.cpp:462
virtual bool IsMovableFromAnchorPoint() const
Check if object is movable from the anchor point.
Definition sch_item.h:301
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition sch_item.cpp:471
VECTOR2I & GetStoredPos()
Definition sch_item.h:303
bool IsGroupableType() const
Definition sch_item.cpp:112
virtual std::vector< VECTOR2I > GetConnectionPoints() const
Add all the connection points for this item to aPoints.
Definition sch_item.h:541
void SetLastResolvedState(const SCH_ITEM *aItem) override
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
void SetPosition(const VECTOR2I &aPosition) override
bool CanConnect(const SCH_ITEM *aItem) const override
Definition sch_label.h:148
Tool responsible for drawing/placing items (symbols, wires, buses, labels, etc.)
int AddJunctionsIfNeeded(SCH_COMMIT *aCommit, SCH_SELECTION *aSelection)
Handle the addition of junctions to a selection of objects.
SCH_JUNCTION * AddJunction(SCH_COMMIT *aCommit, SCH_SCREEN *aScreen, const VECTOR2I &aPos)
int TrimOverLappingWires(SCH_COMMIT *aCommit, SCH_SELECTION *aSelection)
Logic to remove wires when overlapping correct items.
static bool IsDrawingLineWireOrBus(const SELECTION &aSelection)
void BreakSegment(SCH_COMMIT *aCommit, SCH_LINE *aSegment, const VECTOR2I &aPoint, SCH_LINE **aNewSegment, SCH_SCREEN *aScreen)
Break a single segment into two at the specified point.
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:816
void StoreAngle()
Save the current line angle.
Definition sch_line.h:115
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
Definition sch_line.cpp:716
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition sch_line.cpp:233
EDA_ANGLE Angle() const
Get the angle between the start and end lines.
Definition sch_line.h:104
VECTOR2I GetEndPoint() const
Definition sch_line.h:148
VECTOR2I GetStartPoint() const
Definition sch_line.h:139
void MoveEnd(const VECTOR2I &aMoveVector)
Definition sch_line.cpp:178
void SetLastResolvedState(const SCH_ITEM *aItem) override
Definition sch_line.h:163
void MoveStart(const VECTOR2I &aMoveVector)
Definition sch_line.cpp:172
double GetLength() const
Definition sch_line.cpp:249
void SetEndPoint(const VECTOR2I &aPosition)
Definition sch_line.h:149
void moveSelectionToSheet(SCH_SELECTION &aSelection, SCH_SHEET *aTarget, SCH_COMMIT *aCommit)
Clears the new drag lines and removes them from the screen.
void refreshSelectionTraits(const SCH_SELECTION &aSelection, bool &aHasSheetPins, bool &aHasGraphicItems, bool &aHasNonGraphicItems, bool &aIsGraphicsOnly)
Initialize the move/drag operation, setting up flags and connections.
bool Init() override
Init() is called once upon a registration of the tool.
VECTOR2I m_cursor
void trimDanglingLines(SCH_COMMIT *aCommit)
Break or slice the current selection before initiating a move, if required.
void orthoLineDrag(SCH_COMMIT *aCommit, SCH_LINE *line, const VECTOR2I &splitDelta, int &xBendCount, int &yBendCount, const EE_GRID_HELPER &grid)
std::unordered_set< SCH_LINE * > m_newDragLines
Lines changed by drag algorithm that weren't selected.
SCH_SHEET * findTargetSheet(const SCH_SELECTION &aSelection, const VECTOR2I &aCursorPos, bool aHasSheetPins, bool aIsGraphicsOnly, bool aCtrlDown)
Perform the actual move of items by delta, handling split moves and orthogonal dragging.
bool handleMoveToolActions(const TOOL_EVENT *aEvent, SCH_COMMIT *aCommit, const SCH_SELECTION &aSelection)
Update stored positions after transformations (rotation, mirroring, etc.) during move.
bool checkMoveInProgress(const TOOL_EVENT &aEvent, SCH_COMMIT *aCommit, bool aCurrentModeIsDragLike, bool aWasDragging)
< Check if a move is already in progress and handle state transitions
void initializeMoveOperation(const TOOL_EVENT &aEvent, SCH_SELECTION &aSelection, SCH_COMMIT *aCommit, std::vector< DANGLING_END_ITEM > &aInternalPoints, GRID_HELPER_GRIDS &aSnapLayer)
Setup items for drag operation, collecting connected items.
OPT_VECTOR2I m_anchorPos
void performItemMove(SCH_SELECTION &aSelection, const VECTOR2I &aDelta, SCH_COMMIT *aCommit, int &aXBendCount, int &aYBendCount, const EE_GRID_HELPER &aGrid)
Handle tool action events during the move operation.
int Main(const TOOL_EVENT &aEvent)
Run an interactive move of the selected items, or the item under the cursor.
SCH_SELECTION & prepareSelection(bool &aUnselect)
Refresh selection traits (sheet pins, graphic items, etc.)
std::vector< SCH_JUNCTION * > m_hiddenJunctions
void setupItemsForMove(SCH_SELECTION &aSelection, std::vector< DANGLING_END_ITEM > &aInternalPoints)
Find the target sheet for dropping items (if any)
bool m_inMoveTool
< Re-entrancy guard
std::vector< KIID > m_dragAdditions
Cache of the line's original connections before dragging started.
void moveItem(EDA_ITEM *aItem, const VECTOR2I &aDelta)
Find additional items for a drag operation.
void setupItemsForDrag(SCH_SELECTION &aSelection, SCH_COMMIT *aCommit)
Setup items for move operation, marking dangling ends.
std::unordered_set< SCH_LINE * > m_changedDragLines
Junctions that were hidden during the move.
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
void finalizeMoveOperation(SCH_SELECTION &aSelection, SCH_COMMIT *aCommit, bool aUnselect, const std::vector< DANGLING_END_ITEM > &aInternalPoints)
void setTransitions() override
Cleanup dangling lines left after a drag.
void getConnectedItems(SCH_ITEM *aOriginalItem, const VECTOR2I &aPoint, EDA_ITEMS &aList)
std::map< SCH_LINE *, EDA_ITEMS > m_lineConnectionCache
Lines added at bend points dynamically during the move.
OPT_VECTOR2I m_breakPos
void updateStoredPositions(const SCH_SELECTION &aSelection)
Finalize the move operation, updating junctions and cleaning up.
bool doMoveSelection(const TOOL_EVENT &aEvent, SCH_COMMIT *aCommit)
void getConnectedDragItems(SCH_COMMIT *aCommit, SCH_ITEM *fixed, const VECTOR2I &selected, EDA_ITEMS &aList)
VECTOR2I m_moveOffset
Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point).
std::map< SCH_LABEL_BASE *, SPECIAL_CASE_LABEL_INFO > m_specialCaseLabels
int AlignToGrid(const TOOL_EVENT &aEvent)
Align selected elements to the grid.
void clearNewDragLines()
Set up handlers for various events.
MOVE_MODE m_mode
Items (such as wires) which were added to the selection for a drag.
void preprocessBreakOrSliceSelection(SCH_COMMIT *aCommit, const TOOL_EVENT &aEvent)
std::map< SCH_SHEET_PIN *, std::pair< SCH_LINE *, bool > > m_specialCaseSheetPins
void Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
EE_RTREE & Items()
Get the full RTree, usually for iterating.
Definition sch_screen.h:118
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition sch_sheet.h:48
bool IsTopLevelSheet() const
Check if this sheet is a top-level sheet.
SCH_SHEET_PIN * GetPin(const VECTOR2I &aPosition)
Return the sheet pin item found at aPosition in the sheet.
SCH_SCREEN * GetScreen() const
Definition sch_sheet.h:145
const BOX2I GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition sch_sheet.h:233
Schematic symbol object.
Definition sch_symbol.h:76
VECTOR2I GetPosition() const override
Definition sch_text.h:147
void updateItem(EDA_ITEM *aItem, bool aUpdateRTree) const
bool Init() override
Init() is called once upon a registration of the tool.
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
SCH_TOOL_BASE(const std::string &aName)
SCH_SELECTION_TOOL * m_selectionTool
Definition seg.h:42
const VECTOR2I NearestPoint(const VECTOR2I &aP) const
Compute a point on the segment (this) that is closest to point aP.
Definition seg.cpp:633
static SELECTION_CONDITION OnlyTypes(std::vector< KICAD_T > aTypes)
Create a functor that tests if the selected items are only of given types.
virtual void Add(EDA_ITEM *aItem)
Definition selection.cpp:42
ITER end()
Definition selection.h:80
ITER begin()
Definition selection.h:79
VECTOR2I GetReferencePoint() const
bool IsHover() const
Definition selection.h:89
virtual unsigned int GetSize() const override
Return the number of stored items.
Definition selection.h:105
EDA_ITEM * Front() const
Definition selection.h:177
int Size() const
Returns the number of selected parts.
Definition selection.h:121
void SetReferencePoint(const VECTOR2I &aP)
bool Empty() const
Checks if there is anything selected.
Definition selection.h:115
std::vector< EDA_ITEM * > GetItemsSortedByTypeAndXY(bool leftBeforeRight=true, bool topBeforeBottom=true) const
Returns a copy of this selection of items sorted by their X then Y position.
bool HasReferencePoint() const
Definition selection.h:216
const TRANSFORM & GetTransform() const
Definition symbol.h:247
KIGFX::VIEW_CONTROLS * getViewControls() const
Definition tool_base.cpp:44
KIGFX::VIEW * getView() const
Definition tool_base.cpp:38
Generic, UI-independent tool event.
Definition tool_event.h:171
bool DisableGridSnapping() const
Definition tool_event.h:371
bool HasParameter() const
Definition tool_event.h:464
bool IsCancelInteractive() const
Indicate the event should restart/end an ongoing interactive tool's event loop (eg esc key,...
TOOL_ACTIONS Action() const
Returns more specific information about the type of an event.
Definition tool_event.h:250
bool IsActivate() const
Definition tool_event.h:345
COMMIT * Commit() const
Definition tool_event.h:283
bool IsClick(int aButtonMask=BUT_ANY) const
TOOL_EVENT_CATEGORY Category() const
Return the category (eg. mouse/keyboard/action) of an event.
Definition tool_event.h:247
bool IsDrag(int aButtonMask=BUT_ANY) const
Definition tool_event.h:315
int Modifier(int aMask=MD_MODIFIER_MASK) const
Return information about key modifiers state (Ctrl, Alt, etc.).
Definition tool_event.h:366
bool IsAction(const TOOL_ACTION *aAction) const
Test if the event contains an action issued upon activation of the given TOOL_ACTION.
T Parameter() const
Return a parameter assigned to the event.
Definition tool_event.h:473
bool IsDblClick(int aButtonMask=BUT_ANY) const
std::atomic< SYNCRONOUS_TOOL_STATE > * SynchronousState() const
Definition tool_event.h:280
std::optional< int > GetCommandId() const
Definition tool_event.h:533
void SetPassEvent(bool aPass=true)
Definition tool_event.h:256
bool IsMouseUp(int aButtonMask=BUT_ANY) const
Definition tool_event.h:325
bool IsMotion() const
Definition tool_event.h:330
const std::string Format() const
Return information about event in form of a human-readable string.
void Go(int(SCH_EDIT_FRAME::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
std::unique_ptr< TOOL_MENU > m_menu
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
for transforming drawing coordinates for a wxDC device context.
Definition transform.h:46
TRANSFORM InverseTransform() const
Calculate the Inverse mirror/rotation transform.
Definition transform.cpp:59
VECTOR2I TransformCoordinate(const VECTOR2I &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition transform.cpp:44
@ CHT_REMOVE
Definition commit.h:43
@ CHT_DONE
Flag to indicate the change is already applied.
Definition commit.h:47
@ CHT_ADD
Definition commit.h:42
KICURSOR
Definition cursors.h:44
@ PLACE
Definition cursors.h:98
@ MOVING
Definition cursors.h:48
#define _(s)
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:413
@ RECURSE
Definition eda_item.h:51
@ NO_RECURSE
Definition eda_item.h:52
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
#define IS_CHANGED
Item was edited, and modified.
#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 SELECTED_BY_DRAG
Item was algorithmically selected as a dragged item.
#define IS_BROKEN
Is a segment just broken by BreakSegment.
#define STRUCT_DELETED
flag indication structures to be erased
#define ENDPOINT
ends. (Used to support dragging.)
#define IS_MOVING
Item being moved.
#define STARTPOINT
When a line is selected, these flags indicate which.
@ NONE
Definition eda_shape.h:69
@ ID_POPUP_SCH_SELECT_UNIT
Definition eeschema_id.h:89
@ ID_POPUP_SCH_SELECT_BODY_STYLE
Definition eeschema_id.h:99
@ ID_POPUP_SCH_SELECT_BODY_STYLE_END
@ ID_POPUP_SCH_SELECT_UNIT_END
Definition eeschema_id.h:93
@ LINE_MODE_FREE
GRID_HELPER_GRIDS
Definition grid_helper.h:44
@ GRID_CURRENT
Definition grid_helper.h:46
const wxChar *const traceSchMove
Flag to watch how schematic move tool actions are handled.
@ LAYER_WIRE
Definition layer_ids.h:452
@ LAYER_BUS
Definition layer_ids.h:453
@ LAYER_BUS_JUNCTION
Definition layer_ids.h:498
std::vector< SCH_JUNCTION * > PreviewJunctions(const class SCH_SCREEN *aScreen, const std::vector< class SCH_ITEM * > &aItems)
Determine the points where explicit junctions would be required if the given temporary items were com...
POINT_INFO AnalyzePoint(const EE_RTREE &aItem, const VECTOR2I &aPosition, bool aBreakCrossings)
Check a tree of items for a confluence at a given point and work out what kind of junction it is,...
@ REPAINT
Item needs to be redrawn.
Definition view_item.h:58
bool signbit(T v)
Integral version of std::signbit that works all compilers.
Definition kicad_algo.h:176
see class PGM_BASE
Class to handle a set of SCH_ITEMs.
@ AUTOPLACE_NONE
Definition sch_item.h:69
void MoveSchematicItem(EDA_ITEM *aItem, const VECTOR2I &aDelta)
Move a schematic item by a delta.
void AlignSchematicItemsToGrid(SCH_SCREEN *aScreen, const std::vector< EDA_ITEM * > &aItems, EE_GRID_HELPER &aGrid, GRID_HELPER_GRIDS aSelectionGrid, const SCH_ALIGNMENT_CALLBACKS &aCallbacks)
Align a set of schematic items to the grid.
std::vector< EDA_ITEM * > EDA_ITEMS
#define QUIET_MODE
static bool isGraphicItemForDrop(const SCH_ITEM *aItem)
static void cloneWireConnection(SCH_LINE *aNewLine, SCH_ITEM *aSource, SCH_EDIT_FRAME *aFrame)
T * GetAppSettings(const char *aFilename)
The EE_TYPE struct provides a type-specific auto-range iterator to the RTree.
Definition sch_rtree.h:195
A selection of information about a point in the schematic that might be eligible for turning into a j...
VECTOR2D m_lastKeyboardCursorPosition
Position of the above event.
bool m_lastKeyboardCursorPositionValid
Is last cursor motion event coming from keyboard arrow cursor motion action.
long m_lastKeyboardCursorCommand
ACTIONS::CURSOR_UP, ACTIONS::CURSOR_DOWN, etc.
Callbacks for alignment operations.
std::function< void(SCH_ITEM *aItem, const VECTOR2I &aPoint, EDA_ITEMS &aList)> m_getConnectedDragItems
Callback to get items connected to a given item at a specific point.
std::function< void(EDA_ITEM *aItem, const VECTOR2I &aDelta)> m_doMoveItem
Callback to move an item by a delta.
std::function< void(EDA_ITEM *aItem)> m_updateItem
Optional callback to update an item's display after modification.
bool moved
KIBIS_PIN * pin
VECTOR2I end
int delta
@ TA_CHOICE_MENU_CHOICE
Context menu choice.
Definition tool_event.h:98
@ STS_CANCELLED
Definition tool_event.h:164
@ STS_FINISHED
Definition tool_event.h:163
@ STS_RUNNING
Definition tool_event.h:162
@ MD_CTRL
Definition tool_event.h:144
@ MD_SHIFT
Definition tool_event.h:143
@ TC_COMMAND
Definition tool_event.h:57
@ TC_MOUSE
Definition tool_event.h:55
@ TC_KEYBOARD
Definition tool_event.h:56
@ BUT_LEFT
Definition tool_event.h:132
@ BUT_RIGHT
Definition tool_event.h:133
wxLogTrace helper definitions.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition typeinfo.h:78
@ SCH_LINE_T
Definition typeinfo.h:167
@ SCH_NO_CONNECT_T
Definition typeinfo.h:164
@ SCH_SYMBOL_T
Definition typeinfo.h:176
@ SCH_FIELD_T
Definition typeinfo.h:154
@ SCH_DIRECTIVE_LABEL_T
Definition typeinfo.h:175
@ SCH_LABEL_T
Definition typeinfo.h:171
@ SCH_SHEET_T
Definition typeinfo.h:179
@ SCH_SHAPE_T
Definition typeinfo.h:153
@ SCH_HIER_LABEL_T
Definition typeinfo.h:173
@ SCH_BUS_BUS_ENTRY_T
Definition typeinfo.h:166
@ SCH_SHEET_PIN_T
Definition typeinfo.h:178
@ SCH_TEXT_T
Definition typeinfo.h:155
@ SCH_BUS_WIRE_ENTRY_T
Definition typeinfo.h:165
@ SCH_BITMAP_T
Definition typeinfo.h:168
@ SCH_TEXTBOX_T
Definition typeinfo.h:156
@ SCH_GLOBAL_LABEL_T
Definition typeinfo.h:172
@ SCH_JUNCTION_T
Definition typeinfo.h:163
@ SCH_PIN_T
Definition typeinfo.h:157
constexpr int sign(T val)
Definition util.h:145
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695
VECTOR2< double > VECTOR2D
Definition vector2d.h:694