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 <trace_helpers.h>
59
60
61// For adding to or removing from selections
62#define QUIET_MODE true
63
64
65static bool isGraphicItemForDrop( const SCH_ITEM* aItem )
66{
67 switch( aItem->Type() )
68 {
69 case SCH_SHAPE_T:
70 case SCH_BITMAP_T:
71 case SCH_TEXT_T:
72 case SCH_TEXTBOX_T:
73 return true;
74 case SCH_LINE_T:
75 return static_cast<const SCH_LINE*>( aItem )->IsGraphicLine();
76 default:
77 return false;
78 }
79}
80
81
82static void cloneWireConnection( SCH_LINE* aNewLine, SCH_ITEM* aSource, SCH_EDIT_FRAME* aFrame )
83{
84 if( !aNewLine || !aSource || !aFrame )
85 return;
86
87 SCH_LINE* sourceLine = dynamic_cast<SCH_LINE*>( aSource );
88
89 if( !sourceLine )
90 return;
91
92 SCH_SHEET_PATH sheetPath = aFrame->GetCurrentSheet();
93 SCH_CONNECTION* sourceConnection = sourceLine->Connection( &sheetPath );
94
95 if( !sourceConnection )
96 return;
97
98 SCH_CONNECTION* newConnection = aNewLine->InitializeConnection( sheetPath, nullptr );
99
100 if( !newConnection )
101 return;
102
103 newConnection->Clone( *sourceConnection );
104}
105
106
108 SCH_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.InteractiveMove" ),
109 m_inMoveTool( false ),
110 m_moveInProgress( false ),
111 m_mode( MOVE ),
112 m_moveOffset( 0, 0 )
113{
114}
115
116
118{
120
121 auto moveCondition =
122 []( const SELECTION& aSel )
123 {
124 if( aSel.Empty() || SELECTION_CONDITIONS::OnlyTypes( { SCH_MARKER_T } )( aSel ) )
125 return false;
126
128 return false;
129
130 return true;
131 };
132
133 // Add move actions to the selection tool menu
134 //
135 CONDITIONAL_MENU& selToolMenu = m_selectionTool->GetToolMenu().GetMenu();
136
137 selToolMenu.AddItem( SCH_ACTIONS::move, moveCondition, 150 );
138 selToolMenu.AddItem( SCH_ACTIONS::drag, moveCondition, 150 );
139 selToolMenu.AddItem( SCH_ACTIONS::alignToGrid, moveCondition, 150 );
140
141 return true;
142}
143
144
146{
147 SCH_TOOL_BASE::Reset( aReason );
148
149 if( aReason == MODEL_RELOAD || aReason == SUPERMODEL_RELOAD )
150 {
151 // If we were in the middle of a move/drag operation and the model changes (e.g., sheet
152 // switch), we need to clean up our state to avoid blocking future move/drag operations
153 if( m_moveInProgress )
154 {
155 // Clear the move state
156 m_moveInProgress = false;
157 m_mode = MOVE;
158 m_moveOffset = VECTOR2I( 0, 0 );
159 m_anchorPos.reset();
160 m_breakPos.reset();
161
162 // Clear cached data that references items from the previous sheet
163 m_dragAdditions.clear();
164 m_lineConnectionCache.clear();
165 m_newDragLines.clear();
166 m_changedDragLines.clear();
167 m_specialCaseLabels.clear();
169 m_hiddenJunctions.clear();
170
171 // Clear any preview
172 if( m_view )
173 m_view->ClearPreview();
174 }
175 }
176}
177
178
179void SCH_MOVE_TOOL::orthoLineDrag( SCH_COMMIT* aCommit, SCH_LINE* line, const VECTOR2I& splitDelta,
180 int& xBendCount, int& yBendCount, const EE_GRID_HELPER& grid )
181{
182 // If the move is not the same angle as this move, then we need to do something special with
183 // the unselected end to maintain orthogonality. Either drag some connected line that is the
184 // same angle as the move or add two lines to make a 90 degree connection
185 if( !EDA_ANGLE( splitDelta ).IsParallelTo( line->Angle() ) || line->GetLength() == 0 )
186 {
187 VECTOR2I unselectedEnd = line->HasFlag( STARTPOINT ) ? line->GetEndPoint()
188 : line->GetStartPoint();
189 VECTOR2I selectedEnd = line->HasFlag( STARTPOINT ) ? line->GetStartPoint()
190 : line->GetEndPoint();
191
192 // Look for pre-existing lines we can drag with us instead of creating new ones
193 bool foundAttachment = false;
194 bool foundJunction = false;
195 bool foundPin = false;
196 SCH_LINE* foundLine = nullptr;
197
198 for( EDA_ITEM* cItem : m_lineConnectionCache[line] )
199 {
200 foundAttachment = true;
201
202 // If the move is the same angle as a connected line, we can shrink/extend that line
203 // endpoint
204 switch( cItem->Type() )
205 {
206 case SCH_LINE_T:
207 {
208 SCH_LINE* cLine = static_cast<SCH_LINE*>( cItem );
209
210 // A matching angle on a non-zero-length line means lengthen/shorten will work
211 if( EDA_ANGLE( splitDelta ).IsParallelTo( cLine->Angle() )
212 && cLine->GetLength() != 0 )
213 {
214 foundLine = cLine;
215 }
216
217 // Zero length lines are lines that this algorithm has shortened to 0 so they also
218 // work but we should prefer using a segment with length and angle matching when
219 // we can (otherwise the zero length line will draw overlapping segments on them)
220 if( !foundLine && cLine->GetLength() == 0 )
221 foundLine = cLine;
222
223 break;
224 }
225 case SCH_JUNCTION_T:
226 foundJunction = true;
227 break;
228
229 case SCH_PIN_T:
230 foundPin = true;
231 break;
232
233 case SCH_SHEET_T:
234 for( const auto& pair : m_specialCaseSheetPins )
235 {
236 if( pair.first->IsConnected( selectedEnd ) )
237 {
238 foundPin = true;
239 break;
240 }
241 }
242
243 break;
244
245 default:
246 break;
247 }
248 }
249
250 // Ok... what if our original line is length zero from moving in its direction, and the
251 // last added segment of the 90 bend we are connected to is zero from moving it in its
252 // direction after it was added?
253 //
254 // If we are moving in original direction, we should lengthen the original drag wire.
255 // Otherwise we should lengthen the new wire.
256 bool preferOriginalLine = false;
257
258 if( foundLine
259 && foundLine->GetLength() == 0
260 && line->GetLength() == 0
261 && EDA_ANGLE( splitDelta ).IsParallelTo( line->GetStoredAngle() ) )
262 {
263 preferOriginalLine = true;
264 }
265 // If we have found an attachment, but not a line, we want to check if it's a junction.
266 // These are special-cased and get a single line added instead of a 90-degree bend. Except
267 // when we're on a pin, because pins always need bends, and junctions are just added to
268 // pins for visual clarity.
269 else if( !foundLine && foundJunction && !foundPin )
270 {
271 // Create a new wire ending at the unselected end
272 foundLine = new SCH_LINE( unselectedEnd, line->GetLayer() );
273 foundLine->SetFlags( IS_NEW );
274 foundLine->SetLastResolvedState( line );
275 cloneWireConnection( foundLine, line, m_frame );
276 m_frame->AddToScreen( foundLine, m_frame->GetScreen() );
277 m_newDragLines.insert( foundLine );
278
279 // We just broke off of the existing items, so replace all of them with our new
280 // end connection.
282 m_lineConnectionCache[line].clear();
283 m_lineConnectionCache[line].emplace_back( foundLine );
284 }
285
286 // We want to drag our found line if it's in the same angle as the move or zero length,
287 // but if the original drag line is also zero and the same original angle we should extend
288 // that one first
289 if( foundLine && !preferOriginalLine )
290 {
291 // Move the connected line found oriented in the direction of our move.
292 //
293 // Make sure we grab the right endpoint, it's not always STARTPOINT since the user can
294 // draw a box of lines. We need to only move one though, and preferably the start point,
295 // in case we have a zero length line that we are extending (we want the foundLine
296 // start point to be attached to the unselected end of our drag line).
297 //
298 // Also, new lines are added already so they'll be in the undo list, skip adding them.
299
300 if( !foundLine->HasFlag( IS_CHANGED ) && !foundLine->HasFlag( IS_NEW ) )
301 {
302 aCommit->Modify( (SCH_ITEM*) foundLine, m_frame->GetScreen() );
303
304 if( !foundLine->IsSelected() )
305 m_changedDragLines.insert( foundLine );
306 }
307
308 if( foundLine->GetStartPoint() == unselectedEnd )
309 foundLine->MoveStart( splitDelta );
310 else if( foundLine->GetEndPoint() == unselectedEnd )
311 foundLine->MoveEnd( splitDelta );
312
313 updateItem( foundLine, true );
314
315 SCH_LINE* bendLine = nullptr;
316
317 if( m_lineConnectionCache.count( foundLine ) == 1
318 && m_lineConnectionCache[foundLine][0]->Type() == SCH_LINE_T )
319 {
320 bendLine = static_cast<SCH_LINE*>( m_lineConnectionCache[foundLine][0] );
321 }
322
323 // Remerge segments we've created if this is a segment that we've added whose only
324 // other connection is also an added segment
325 //
326 // bendLine is first added segment at the original attachment point, foundLine is the
327 // orthogonal line between bendLine and this line
328 if( foundLine->HasFlag( IS_NEW )
329 && foundLine->GetLength() == 0
330 && bendLine && bendLine->HasFlag( IS_NEW ) )
331 {
332 if( line->HasFlag( STARTPOINT ) )
333 line->SetEndPoint( bendLine->GetEndPoint() );
334 else
335 line->SetStartPoint( bendLine->GetEndPoint() );
336
337 // Update our cache of the connected items.
338
339 // First, re-attach our drag labels to the original line being re-merged.
340 for( EDA_ITEM* candidate : m_lineConnectionCache[bendLine] )
341 {
342 SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( candidate );
343
344 if( label && m_specialCaseLabels.count( label ) )
345 m_specialCaseLabels[label].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
532 // also be for subsequent 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
572 // the new segment is now an existing segment we are breaking from, this will be checked for
573 // in the line selection 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,
710 // so we were getting double-key events that toggled the axis locking if you
711 // pressed them in a certain order.
713 {
714 VECTOR2I keyboardPos( controls->GetSettings().m_lastKeyboardCursorPosition );
715 long action = controls->GetSettings().m_lastKeyboardCursorCommand;
716
717 grid.SetSnap( false );
718 m_cursor = grid.Align( keyboardPos, snapLayer );
719
720 // Update axis lock based on arrow key press
721 if( action == ACTIONS::CURSOR_LEFT || action == ACTIONS::CURSOR_RIGHT )
722 {
723 if( axisLock == AXIS_LOCK::HORIZONTAL )
724 {
725 // Check if opposite horizontal key pressed to unlock
726 if( ( lastArrowKeyAction == ACTIONS::CURSOR_LEFT && action == ACTIONS::CURSOR_RIGHT ) ||
727 ( lastArrowKeyAction == ACTIONS::CURSOR_RIGHT && action == ACTIONS::CURSOR_LEFT ) )
728 {
729 axisLock = AXIS_LOCK::NONE;
730 }
731 // Same direction axis, keep locked
732 }
733 else
734 {
735 axisLock = AXIS_LOCK::HORIZONTAL;
736 }
737 }
738 else if( action == ACTIONS::CURSOR_UP || action == ACTIONS::CURSOR_DOWN )
739 {
740 if( axisLock == AXIS_LOCK::VERTICAL )
741 {
742 // Check if opposite vertical key pressed to unlock
743 if( ( lastArrowKeyAction == ACTIONS::CURSOR_UP && action == ACTIONS::CURSOR_DOWN ) ||
744 ( lastArrowKeyAction == ACTIONS::CURSOR_DOWN && action == ACTIONS::CURSOR_UP ) )
745 {
746 axisLock = AXIS_LOCK::NONE;
747 }
748 // Same direction axis, keep locked
749 }
750 else
751 {
752 axisLock = AXIS_LOCK::VERTICAL;
753 }
754 }
755
756 lastArrowKeyAction = action;
757 }
758 else
759 {
760 m_cursor = grid.BestSnapAnchor( controls->GetCursorPosition( false ), snapLayer, selection );
761 }
762
763 if( axisLock == AXIS_LOCK::HORIZONTAL )
764 m_cursor.y = prevPos.y;
765 else if( axisLock == AXIS_LOCK::VERTICAL )
766 m_cursor.x = prevPos.x;
767
768 // Find potential target sheet for dropping
769 SCH_SHEET* sheet = findTargetSheet( selection, m_cursor, selectionHasSheetPins,
770 selectionIsGraphicsOnly, ctrlDown );
771
772 if( sheet != hoverSheet )
773 {
774 hoverSheet = sheet;
775
776 if( hoverSheet )
777 {
778 hoverSheet->SetFlags( BRIGHTENED );
779 m_frame->UpdateItem( hoverSheet, false );
780 }
781 }
782
783 currentCursor = hoverSheet ? KICURSOR::PLACE : KICURSOR::MOVING;
784
785 if( netCollisionMonitor )
786 currentCursor = netCollisionMonitor->AdjustCursor( currentCursor );
787
788 VECTOR2I delta( m_cursor - prevPos );
790
791 // Used for tracking how far off a drag end should have its 90 degree elbow added
792 int xBendCount = 1;
793 int yBendCount = 1;
794
795 performItemMove( selection, delta, aCommit, xBendCount, yBendCount, grid );
796 prevPos = m_cursor;
797
798 std::vector<SCH_ITEM*> previewItems;
799
800 for( EDA_ITEM* it : selection )
801 previewItems.push_back( static_cast<SCH_ITEM*>( it ) );
802
803 for( SCH_LINE* line : m_newDragLines )
804 previewItems.push_back( line );
805
806 for( SCH_LINE* line : m_changedDragLines )
807 previewItems.push_back( line );
808
809 std::vector<SCH_JUNCTION*> previewJunctions =
810 JUNCTION_HELPERS::PreviewJunctions( m_frame->GetScreen(), previewItems );
811
812 if( netCollisionMonitor )
813 netCollisionMonitor->Update( previewJunctions, selection );
814
815 for( SCH_JUNCTION* jct : previewJunctions )
816 {
817 m_view->AddToPreview( jct, true );
818 }
819
821 }
822
823 //------------------------------------------------------------------------
824 // Handle cancel
825 //
826 else if( evt->IsCancelInteractive()
827 || evt->IsActivate()
828 || evt->IsAction( &ACTIONS::undo ) )
829 {
830 if( evt->IsCancelInteractive() )
831 {
832 m_frame->GetInfoBar()->Dismiss();
833
834 // When breaking, the user can cancel after multiple breaks to keep all but the last
835 // break, so exit normally if we have done at least one break
836 if( didAtLeastOneBreak && m_mode == BREAK )
837 break;
838 }
839
840 if( m_moveInProgress )
841 {
842 if( evt->IsActivate() )
843 {
844 // Allowing other tools to activate during a move runs the risk of race
845 // conditions in which we try to spool up both event loops at once.
846
847 switch( m_mode )
848 {
849 case MOVE: m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel move." ) ); break;
850 case DRAG: m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel drag." ) ); break;
851 case BREAK: m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel break." ) ); break;
852 case SLICE: m_frame->ShowInfoBarMsg( _( "Press <ESC> to cancel slice." ) ); break;
853 }
854
855 evt->SetPassEvent( false );
856 continue;
857 }
858
859 evt->SetPassEvent( false );
860 restore_state = true;
861 }
862
864
865 m_view->ClearPreview();
866
867 break;
868 }
869 //------------------------------------------------------------------------
870 // Handle TOOL_ACTION special cases
871 //
872 else if( !handleMoveToolActions( evt, aCommit, selection ) )
873 {
874 wxLogTrace( traceSchMove, "doMoveSelection: handleMoveToolActions returned false, exiting" );
875 break; // Exit if told to by handler
876 }
877 //------------------------------------------------------------------------
878 // Handle context menu
879 //
880 else if( evt->IsClick( BUT_RIGHT ) )
881 {
882 m_menu->ShowContextMenu( m_selectionTool->GetSelection() );
883 }
884 //------------------------------------------------------------------------
885 // Handle drop
886 //
887 else if( evt->IsMouseUp( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) )
888 {
889 if( m_mode != BREAK )
890 break; // Finish
891 else
892 {
893 didAtLeastOneBreak = true;
894 preprocessBreakOrSliceSelection( aCommit, *evt );
895 selection = m_selectionTool->RequestSelection( SCH_COLLECTOR::MovableItems, true );
896
897 if( m_breakPos )
898 {
901 selection.SetReferencePoint( m_cursor );
902 m_moveOffset = VECTOR2I( 0, 0 );
903 m_breakPos.reset();
904
905 controls->SetCursorPosition( m_cursor, false );
906 prevPos = m_cursor;
907 }
908 }
909 }
910 else if( evt->IsDblClick( BUT_LEFT ) )
911 {
912 // Double click always finishes, even breaks
913 break;
914 }
915 // Don't call SetPassEvent() for events we've handled - let them be consumed
916 else if( evt->IsAction( &SCH_ACTIONS::rotateCW )
918 || evt->IsAction( &ACTIONS::increment )
923 || evt->IsAction( &SCH_ACTIONS::toText )
927 || evt->IsAction( &ACTIONS::duplicate )
929 || evt->IsAction( &ACTIONS::redo ) )
930 {
931 // Event was already handled by handleMoveToolActions, don't pass it on
932 wxLogTrace( traceSchMove, "doMoveSelection: event handled, not passing" );
933 }
934 else
935 {
936 evt->SetPassEvent();
937 }
938
939 controls->SetAutoPan( m_moveInProgress );
940
941 } while( ( evt = Wait() ) ); //Should be assignment not equality test
942
943 SCH_SHEET* targetSheet = hoverSheet;
944
945 if( selectionHasSheetPins || ( selectionIsGraphicsOnly && !lastCtrlDown ) )
946 targetSheet = nullptr;
947
948 if( hoverSheet )
949 {
950 hoverSheet->ClearFlags( BRIGHTENED );
951 m_frame->UpdateItem( hoverSheet, false );
952 }
953
954 if( targetSheet )
955 {
956 moveSelectionToSheet( selection, targetSheet, aCommit );
958 m_newDragLines.clear();
959 m_changedDragLines.clear();
960 }
961
962 if( restore_state )
963 {
964 m_selectionTool->RemoveItemsFromSel( &m_dragAdditions, QUIET_MODE );
965 }
966 else
967 {
968 finalizeMoveOperation( selection, aCommit, unselect, internalPoints );
969 }
970
971 m_dragAdditions.clear();
972 m_lineConnectionCache.clear();
973 m_moveInProgress = false;
974 m_breakPos.reset();
975
976 m_hiddenJunctions.clear();
977 m_view->ClearPreview();
978 m_frame->PopTool( aEvent );
979
980 return !restore_state;
981}
982
983
984bool SCH_MOVE_TOOL::checkMoveInProgress( const TOOL_EVENT& aEvent, SCH_COMMIT* aCommit, bool aCurrentModeIsDragLike,
985 bool aWasDragging )
986{
988
989 if( !m_moveInProgress )
990 return false;
991
992 if( aCurrentModeIsDragLike != aWasDragging )
993 {
994 EDA_ITEM* sel = m_selectionTool->GetSelection().Front();
995
996 if( sel && !sel->IsNew() )
997 {
998 // Reset the selected items so we can start again with the current drag mode state
999 aCommit->Revert();
1000
1001 m_selectionTool->RemoveItemsFromSel( &m_dragAdditions, QUIET_MODE );
1003 m_moveInProgress = false;
1004 controls->SetAutoPan( false );
1005
1006 // Give it a kick so it doesn't have to wait for the first mouse movement to refresh
1007 m_toolMgr->PostAction( SCH_ACTIONS::restartMove );
1008 }
1009 }
1010 else
1011 {
1012 // The tool hotkey is interpreted as a click when already dragging/moving
1013 m_toolMgr->PostAction( ACTIONS::cursorClick );
1014 }
1015
1016 return true;
1017}
1018
1019
1021{
1022 SCH_SELECTION& userSelection = m_selectionTool->GetSelection();
1023
1024 // If a single pin is selected, promote the move selection to its parent symbol
1025 if( userSelection.GetSize() == 1 )
1026 {
1027 EDA_ITEM* selItem = userSelection.Front();
1028
1029 if( selItem->Type() == SCH_PIN_T )
1030 {
1031 EDA_ITEM* parent = selItem->GetParent();
1032
1033 if( parent->Type() == SCH_SYMBOL_T )
1034 {
1035 m_selectionTool->ClearSelection();
1036 m_selectionTool->AddItemToSel( parent );
1037 }
1038 }
1039 }
1040
1041 // Be sure that there is at least one item that we can move. If there's no selection try
1042 // looking for the stuff under mouse cursor (i.e. KiCad old-style hover selection).
1043 SCH_SELECTION& selection = m_selectionTool->RequestSelection( SCH_COLLECTOR::MovableItems,
1044 true );
1045 aUnselect = selection.IsHover();
1046
1047 return selection;
1048}
1049
1050
1051void SCH_MOVE_TOOL::refreshSelectionTraits( const SCH_SELECTION& aSelection, bool& aHasSheetPins,
1052 bool& aHasGraphicItems, bool& aHasNonGraphicItems,
1053 bool& aIsGraphicsOnly )
1054{
1055 aHasSheetPins = false;
1056 aHasGraphicItems = false;
1057 aHasNonGraphicItems = false;
1058
1059 for( EDA_ITEM* edaItem : aSelection )
1060 {
1061 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( edaItem );
1062
1063 if( schItem->Type() == SCH_SHEET_PIN_T )
1064 aHasSheetPins = true;
1065
1066 if( isGraphicItemForDrop( schItem ) )
1067 aHasGraphicItems = true;
1068 else if( schItem->Type() != SCH_SHEET_T )
1069 aHasNonGraphicItems = true;
1070 }
1071
1072 aIsGraphicsOnly = aHasGraphicItems && !aHasNonGraphicItems;
1073}
1074
1075
1077{
1078 // Drag of split items start over top of their other segment, so we want to skip grabbing
1079 // the segments we split from
1080 if( m_mode != DRAG && m_mode != BREAK )
1081 return;
1082
1083 EDA_ITEMS connectedDragItems;
1084
1085 // Add connections to the selection for a drag.
1086 // Do all non-labels/entries first so we don't add junctions to drag when the line will
1087 // eventually be drag selected.
1088 std::vector<SCH_ITEM*> stageTwo;
1089
1090 for( EDA_ITEM* edaItem : aSelection )
1091 {
1092 SCH_ITEM* item = static_cast<SCH_ITEM*>( edaItem );
1093 std::vector<VECTOR2I> connections;
1094
1095 switch( item->Type() )
1096 {
1097 case SCH_LABEL_T:
1098 case SCH_HIER_LABEL_T:
1099 case SCH_GLOBAL_LABEL_T:
1101 stageTwo.emplace_back( item );
1102 break;
1103
1104 case SCH_LINE_T:
1105 static_cast<SCH_LINE*>( item )->GetSelectedPoints( connections );
1106 break;
1107
1108 default:
1109 connections = item->GetConnectionPoints();
1110 }
1111
1112 for( const VECTOR2I& point : connections )
1113 getConnectedDragItems( aCommit, item, point, connectedDragItems );
1114 }
1115
1116 // Go back and get all label connections now that we can test for drag-selected lines
1117 // the labels might be on
1118 for( SCH_ITEM* item : stageTwo )
1119 {
1120 for( const VECTOR2I& point : item->GetConnectionPoints() )
1121 getConnectedDragItems( aCommit, item, point, connectedDragItems );
1122 }
1123
1124 for( EDA_ITEM* item : connectedDragItems )
1125 {
1126 m_dragAdditions.push_back( item->m_Uuid );
1127 m_selectionTool->AddItemToSel( item, QUIET_MODE );
1128 }
1129
1130 // Pre-cache all connections of our selected objects so we can keep track of what they
1131 // were originally connected to as we drag them around
1132 for( EDA_ITEM* edaItem : aSelection )
1133 {
1134 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( edaItem );
1135
1136 if( schItem->Type() == SCH_LINE_T )
1137 {
1138 SCH_LINE* line = static_cast<SCH_LINE*>( schItem );
1139
1140 // Store the original angle of the line; needed later to decide which segment
1141 // to extend when they've become zero length
1142 line->StoreAngle();
1143
1144 for( const VECTOR2I& point : line->GetConnectionPoints() )
1145 getConnectedItems( line, point, m_lineConnectionCache[line] );
1146 }
1147 }
1148}
1149
1150
1152 std::vector<DANGLING_END_ITEM>& aInternalPoints )
1153{
1154 // Mark the edges of the block with dangling flags for a move
1155 for( EDA_ITEM* item : aSelection )
1156 static_cast<SCH_ITEM*>( item )->GetEndPoints( aInternalPoints );
1157
1158 std::vector<DANGLING_END_ITEM> endPointsByType = aInternalPoints;
1159 std::vector<DANGLING_END_ITEM> endPointsByPos = endPointsByType;
1160 DANGLING_END_ITEM_HELPER::sort_dangling_end_items( endPointsByType, endPointsByPos );
1161
1162 for( EDA_ITEM* item : aSelection )
1163 static_cast<SCH_ITEM*>( item )->UpdateDanglingState( endPointsByType, endPointsByPos );
1164}
1165
1166
1168 std::vector<DANGLING_END_ITEM>& aInternalPoints,
1169 GRID_HELPER_GRIDS& aSnapLayer )
1170{
1173 SCH_ITEM* sch_item = static_cast<SCH_ITEM*>( aSelection.Front() );
1174 bool placingNewItems = sch_item && sch_item->IsNew();
1175
1176 //------------------------------------------------------------------------
1177 // Setup a drag or a move
1178 //
1179 m_dragAdditions.clear();
1180 m_specialCaseLabels.clear();
1181 m_specialCaseSheetPins.clear();
1182 aInternalPoints.clear();
1184
1185 for( SCH_ITEM* it : m_frame->GetScreen()->Items() )
1186 {
1187 it->ClearFlags( SELECTED_BY_DRAG );
1188
1189 if( !it->IsSelected() )
1190 it->ClearFlags( STARTPOINT | ENDPOINT );
1191 }
1192
1193 setupItemsForDrag( aSelection, aCommit );
1194 setupItemsForMove( aSelection, aInternalPoints );
1195
1196 // Hide junctions connected to line endpoints that are not selected
1197 m_hiddenJunctions.clear();
1198
1199 for( EDA_ITEM* edaItem : aSelection )
1200 {
1201 if( edaItem->Type() != SCH_LINE_T )
1202 continue;
1203
1204 SCH_LINE* line = static_cast<SCH_LINE*>( edaItem );
1205
1206 for( const VECTOR2I& pt : line->GetConnectionPoints() )
1207 {
1208 SCH_JUNCTION* jct = static_cast<SCH_JUNCTION*>(
1209 m_frame->GetScreen()->GetItem( pt, 0, SCH_JUNCTION_T ) );
1210
1211 if( jct && !jct->IsSelected()
1212 && std::find( m_hiddenJunctions.begin(), m_hiddenJunctions.end(), jct )
1213 == m_hiddenJunctions.end() )
1214 {
1215 jct->SetFlags( STRUCT_DELETED );
1216 m_frame->RemoveFromScreen( jct, m_frame->GetScreen() );
1217 aCommit->Removed( jct, m_frame->GetScreen() );
1218 }
1219 }
1220 }
1221
1222 // Generic setup
1223 aSnapLayer = grid.GetSelectionGrid( aSelection );
1224
1225 for( EDA_ITEM* item : aSelection )
1226 {
1227 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( item );
1228
1229 if( schItem->IsNew() )
1230 {
1231 // Item was added to commit in a previous command
1232
1233 // While SCH_COMMIT::Push() will add any new items to the entered group, we need
1234 // to do it earlier so that the previews while moving are correct.
1235 if( SCH_GROUP* enteredGroup = m_selectionTool->GetEnteredGroup() )
1236 {
1237 if( schItem->IsGroupableType() && !schItem->GetParentGroup() )
1238 {
1239 aCommit->Modify( enteredGroup, m_frame->GetScreen(),
1241 enteredGroup->AddItem( schItem );
1242 }
1243 }
1244 }
1245 else if( schItem->GetParent() && schItem->GetParent()->IsSelected() )
1246 {
1247 // Item will be (or has been) added to commit by parent
1248 }
1249 else
1250 {
1251 aCommit->Modify( schItem, m_frame->GetScreen(), RECURSE_MODE::RECURSE );
1252 }
1253
1254 schItem->SetFlags( IS_MOVING );
1255
1256 if( SCH_SHAPE* shape = dynamic_cast<SCH_SHAPE*>( schItem ) )
1257 {
1258 shape->SetHatchingDirty();
1259 shape->UpdateHatching();
1260 }
1261
1262 schItem->RunOnChildren(
1263 [&]( SCH_ITEM* unused )
1264 {
1265 item->SetFlags( IS_MOVING );
1266 },
1268
1269 schItem->SetStoredPos( schItem->GetPosition() );
1270 }
1271
1272 // Set up the starting position and move/drag offset
1273 m_cursor = controls->GetCursorPosition();
1274
1275 if( m_mode == BREAK && m_breakPos )
1276 {
1279 aSelection.SetReferencePoint( m_cursor );
1280 m_moveOffset = VECTOR2I( 0, 0 );
1281 m_breakPos.reset();
1282 }
1283
1284 if( aEvent.IsAction( &SCH_ACTIONS::restartMove ) )
1285 {
1286 wxASSERT_MSG( m_anchorPos, "Should be already set from previous cmd" );
1287 }
1288 else if( placingNewItems )
1289 {
1290 m_anchorPos = aSelection.GetReferencePoint();
1291 }
1292
1293 if( m_anchorPos )
1294 {
1295 VECTOR2I delta = m_cursor - ( *m_anchorPos );
1296 bool isPasted = false;
1297
1298 // Drag items to the current cursor position
1299 for( EDA_ITEM* item : aSelection )
1300 {
1301 // Don't double move pins, fields, etc.
1302 if( item->GetParent() && item->GetParent()->IsSelected() )
1303 continue;
1304
1305 moveItem( item, delta );
1306 updateItem( item, false );
1307
1308 isPasted |= ( item->GetFlags() & IS_PASTED ) != 0;
1309 }
1310
1311 // The first time pasted items are moved we need to store the position of the cursor
1312 // so that rotate while moving works as expected (instead of around the original
1313 // anchor point)
1314 if( isPasted )
1315 aSelection.SetReferencePoint( m_cursor );
1316
1318 }
1319 // For some items, moving the cursor to anchor is not good (for instance large
1320 // hierarchical sheets or symbols can have the anchor outside the view)
1321 else if( aSelection.Size() == 1 && !sch_item->IsMovableFromAnchorPoint() )
1322 {
1325 }
1326 else
1327 {
1328 if( m_frame->GetMoveWarpsCursor() )
1329 {
1330 // User wants to warp the mouse
1331 m_cursor = grid.BestDragOrigin( m_cursor, aSnapLayer, aSelection );
1332 aSelection.SetReferencePoint( m_cursor );
1333 }
1334 else
1335 {
1336 // User does not want to warp the mouse
1338 }
1339 }
1340
1341 controls->SetCursorPosition( m_cursor, false );
1342 controls->SetAutoPan( true );
1343 m_moveInProgress = true;
1344}
1345
1346
1348 const VECTOR2I& aCursorPos, bool aHasSheetPins,
1349 bool aIsGraphicsOnly, bool aCtrlDown )
1350{
1351 // Determine potential target sheet
1352 SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>(
1353 m_frame->GetScreen()->GetItem( aCursorPos, 0, SCH_SHEET_T ) );
1354
1355 if( sheet && sheet->IsSelected() )
1356 sheet = nullptr; // Never target a selected sheet
1357
1358 if( !sheet )
1359 {
1360 // Build current selection bounding box in its (already moved) position
1361 BOX2I selBBox;
1362
1363 for( EDA_ITEM* it : aSelection )
1364 {
1365 if( SCH_ITEM* schIt = dynamic_cast<SCH_ITEM*>( it ) )
1366 selBBox.Merge( schIt->GetBoundingBox() );
1367 }
1368
1369 if( selBBox.GetWidth() > 0 && selBBox.GetHeight() > 0 )
1370 {
1371 VECTOR2I selCenter( selBBox.GetX() + selBBox.GetWidth() / 2,
1372 selBBox.GetY() + selBBox.GetHeight() / 2 );
1373
1374 // Find first non-selected sheet whose body fully contains the selection or at
1375 // least contains its center point
1376 for( SCH_ITEM* it : m_frame->GetScreen()->Items().OfType( SCH_SHEET_T ) )
1377 {
1378 SCH_SHEET* candidate = static_cast<SCH_SHEET*>( it );
1379
1380 if( candidate->IsSelected() || candidate->IsTopLevelSheet() )
1381 continue;
1382
1383 BOX2I body = candidate->GetBodyBoundingBox();
1384
1385 if( body.Contains( selBBox ) || body.Contains( selCenter ) )
1386 {
1387 sheet = candidate;
1388 break;
1389 }
1390 }
1391 }
1392 }
1393
1394 bool dropAllowedBySelection = !aHasSheetPins;
1395 bool dropAllowedByModifiers = !aIsGraphicsOnly || aCtrlDown;
1396
1397 if( sheet && !( dropAllowedBySelection && dropAllowedByModifiers ) )
1398 sheet = nullptr;
1399
1400 return sheet;
1401}
1402
1403
1405 SCH_COMMIT* aCommit, int& aXBendCount, int& aYBendCount,
1406 const EE_GRID_HELPER& aGrid )
1407{
1408 wxLogTrace( traceSchMove, "performItemMove: delta=(%d,%d), moveOffset=(%d,%d), selection size=%u",
1409 aDelta.x, aDelta.y, m_moveOffset.x, m_moveOffset.y, aSelection.GetSize() );
1410
1411 // We need to check if the movement will change the net offset direction on the X and Y
1412 // axes. This is because we remerge added bend lines in realtime, and we also account for
1413 // the direction of the move when adding bend lines. So, if the move direction changes,
1414 // we need to split it into a move that gets us back to zero, then the rest of the move.
1415 std::vector<VECTOR2I> splitMoves;
1416
1417 if( alg::signbit( m_moveOffset.x ) != alg::signbit( ( m_moveOffset + aDelta ).x ) )
1418 {
1419 splitMoves.emplace_back( VECTOR2I( -1 * m_moveOffset.x, 0 ) );
1420 splitMoves.emplace_back( VECTOR2I( aDelta.x + m_moveOffset.x, 0 ) );
1421 }
1422 else
1423 {
1424 splitMoves.emplace_back( VECTOR2I( aDelta.x, 0 ) );
1425 }
1426
1427 if( alg::signbit( m_moveOffset.y ) != alg::signbit( ( m_moveOffset + aDelta ).y ) )
1428 {
1429 splitMoves.emplace_back( VECTOR2I( 0, -1 * m_moveOffset.y ) );
1430 splitMoves.emplace_back( VECTOR2I( 0, aDelta.y + m_moveOffset.y ) );
1431 }
1432 else
1433 {
1434 splitMoves.emplace_back( VECTOR2I( 0, aDelta.y ) );
1435 }
1436
1437 m_moveOffset += aDelta;
1438
1439 // Split the move into X and Y moves so we can correctly drag orthogonal lines
1440 for( const VECTOR2I& splitDelta : splitMoves )
1441 {
1442 // Skip non-moves
1443 if( splitDelta == VECTOR2I( 0, 0 ) )
1444 continue;
1445
1446 for( EDA_ITEM* item : aSelection.GetItemsSortedByTypeAndXY( ( aDelta.x >= 0 ),
1447 ( aDelta.y >= 0 ) ) )
1448 {
1449 // Don't double move pins, fields, etc.
1450 if( item->GetParent() && item->GetParent()->IsSelected() )
1451 continue;
1452
1453 SCH_LINE* line = dynamic_cast<SCH_LINE*>( item );
1454 bool isLineModeConstrained = false;
1455
1456 if( EESCHEMA_SETTINGS* cfg = GetAppSettings<EESCHEMA_SETTINGS>( "eeschema" ) )
1457 isLineModeConstrained = cfg->m_Drawing.line_mode != LINE_MODE::LINE_MODE_FREE;
1458
1459 // Only partially selected drag lines in orthogonal line mode need special handling
1460 if( ( m_mode == DRAG ) && isLineModeConstrained && line
1461 && line->HasFlag( STARTPOINT ) != line->HasFlag( ENDPOINT ) )
1462 {
1463 orthoLineDrag( aCommit, line, splitDelta, aXBendCount, aYBendCount, aGrid );
1464 }
1465
1466 // Move all other items normally, including the selected end of partially selected
1467 // lines
1468 moveItem( item, splitDelta );
1469 updateItem( item, false );
1470
1471 // Update any lines connected to sheet pins to the sheet pin's location (which may
1472 // not exactly follow the splitDelta as the pins are constrained along the sheet
1473 // edges)
1474 for( const auto& [pin, lineEnd] : m_specialCaseSheetPins )
1475 {
1476 if( lineEnd.second && lineEnd.first->HasFlag( STARTPOINT ) )
1477 lineEnd.first->SetStartPoint( pin->GetPosition() );
1478 else if( !lineEnd.second && lineEnd.first->HasFlag( ENDPOINT ) )
1479 lineEnd.first->SetEndPoint( pin->GetPosition() );
1480 }
1481 }
1482 }
1483
1484 if( aSelection.HasReferencePoint() )
1485 aSelection.SetReferencePoint( aSelection.GetReferencePoint() + aDelta );
1486}
1487
1488
1490 const SCH_SELECTION& aSelection )
1491{
1492 wxLogTrace( traceSchMove, "handleMoveToolActions: received event, action=%s",
1493 aEvent->Format().c_str() );
1494
1495 if( aEvent->IsAction( &ACTIONS::doDelete ) )
1496 {
1497 wxLogTrace( traceSchMove, "handleMoveToolActions: doDelete, exiting move" );
1498 const_cast<TOOL_EVENT*>( aEvent )->SetPassEvent();
1499 return false; // Exit on delete; there will no longer be anything to drag
1500 }
1501 else if( aEvent->IsAction( &ACTIONS::duplicate )
1503 || aEvent->IsAction( &ACTIONS::redo ) )
1504 {
1505 wxBell();
1506 }
1507 else if( aEvent->IsAction( &SCH_ACTIONS::rotateCW ) )
1508 {
1509 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCW event received, selection size=%u",
1510 aSelection.GetSize() );
1511 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::rotateCW, aCommit );
1512 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCW RunSynchronousAction completed" );
1513 updateStoredPositions( aSelection );
1514 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCW updateStoredPositions completed" );
1515 // Note: SCH_EDIT_TOOL::Rotate already posts refreshPreview when moving
1516 }
1517 else if( aEvent->IsAction( &SCH_ACTIONS::rotateCCW ) )
1518 {
1519 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCCW event received, selection size=%u",
1520 aSelection.GetSize() );
1521 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::rotateCCW, aCommit );
1522 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCCW RunSynchronousAction completed" );
1523 updateStoredPositions( aSelection );
1524 wxLogTrace( traceSchMove, "handleMoveToolActions: rotateCCW updateStoredPositions completed" );
1525 // Note: SCH_EDIT_TOOL::Rotate already posts refreshPreview when moving
1526 }
1527 else if( aEvent->IsAction( &ACTIONS::increment ) )
1528 {
1529 if( aEvent->HasParameter() )
1530 m_toolMgr->RunSynchronousAction( ACTIONS::increment, aCommit,
1531 aEvent->Parameter<ACTIONS::INCREMENT>() );
1532 else
1533 m_toolMgr->RunSynchronousAction( ACTIONS::increment, aCommit,
1534 ACTIONS::INCREMENT{ 1, 0 } );
1535
1536 updateStoredPositions( aSelection );
1537 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1538 }
1539 else if( aEvent->IsAction( &SCH_ACTIONS::toDLabel ) )
1540 {
1541 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toDLabel, aCommit );
1542 updateStoredPositions( aSelection );
1543 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1544 }
1545 else if( aEvent->IsAction( &SCH_ACTIONS::toGLabel ) )
1546 {
1547 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toGLabel, aCommit );
1548 updateStoredPositions( aSelection );
1549 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1550 }
1551 else if( aEvent->IsAction( &SCH_ACTIONS::toHLabel ) )
1552 {
1553 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toHLabel, aCommit );
1554 updateStoredPositions( aSelection );
1555 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1556 }
1557 else if( aEvent->IsAction( &SCH_ACTIONS::toLabel ) )
1558 {
1559 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toLabel, aCommit );
1560 updateStoredPositions( aSelection );
1561 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1562 }
1563 else if( aEvent->IsAction( &SCH_ACTIONS::toText ) )
1564 {
1565 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toText, aCommit );
1566 updateStoredPositions( aSelection );
1567 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1568 }
1569 else if( aEvent->IsAction( &SCH_ACTIONS::toTextBox ) )
1570 {
1571 m_toolMgr->RunSynchronousAction( SCH_ACTIONS::toTextBox, aCommit );
1572 updateStoredPositions( aSelection );
1573 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1574 }
1575 else if( aEvent->Action() == TA_CHOICE_MENU_CHOICE )
1576 {
1577 if( *aEvent->GetCommandId() >= ID_POPUP_SCH_SELECT_UNIT
1579 {
1580 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>(
1581 m_selectionTool->GetSelection().Front() );
1582 int unit = *aEvent->GetCommandId() - ID_POPUP_SCH_SELECT_UNIT;
1583
1584 if( symbol )
1585 {
1586 m_frame->SelectUnit( symbol, unit );
1587 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1588 }
1589 }
1590 else if( *aEvent->GetCommandId() >= ID_POPUP_SCH_SELECT_BODY_STYLE
1592 {
1593 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>(
1594 m_selectionTool->GetSelection().Front() );
1595 int bodyStyle = ( *aEvent->GetCommandId() - ID_POPUP_SCH_SELECT_BODY_STYLE ) + 1;
1596
1597 if( symbol && symbol->GetBodyStyle() != bodyStyle )
1598 {
1599 m_frame->SelectBodyStyle( symbol, bodyStyle );
1600 m_toolMgr->PostAction( ACTIONS::refreshPreview );
1601 }
1602 }
1603 }
1604 else if( aEvent->IsAction( &SCH_ACTIONS::highlightNet )
1605 || aEvent->IsAction( &SCH_ACTIONS::selectOnPCB ) )
1606 {
1607 // These don't make any sense during a move. Eat them.
1608 }
1609 else
1610 {
1611 return true; // Continue processing
1612 }
1613
1614 return true; // Continue processing
1615}
1616
1617
1619{
1620 wxLogTrace( traceSchMove, "updateStoredPositions: start, selection size=%u",
1621 aSelection.GetSize() );
1622
1623 // After transformations like rotation during a move, we need to update the stored
1624 // positions that moveItem() uses, particularly for sheet pins which rely on them
1625 // for constraint calculations.
1626 int itemCount = 0;
1627 for( EDA_ITEM* item : aSelection )
1628 {
1629 SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( item );
1630
1631 if( !schItem )
1632 continue;
1633
1634 VECTOR2I oldPos = schItem->GetStoredPos();
1635 VECTOR2I newPos = schItem->GetPosition();
1636 schItem->SetStoredPos( newPos );
1637
1638 wxLogTrace( traceSchMove, " item[%d] type=%d: stored pos updated (%d,%d) -> (%d,%d)",
1639 itemCount++, (int) schItem->Type(), oldPos.x, oldPos.y, newPos.x, newPos.y );
1640
1641 // Also update stored positions for sheet pins
1642 if( schItem->Type() == SCH_SHEET_T )
1643 {
1644 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( schItem );
1645 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
1646 {
1647 VECTOR2I pinOldPos = pin->GetStoredPos();
1648 VECTOR2I pinNewPos = pin->GetPosition();
1649 pin->SetStoredPos( pinNewPos );
1650 wxLogTrace( traceSchMove, " sheet pin: stored pos updated (%d,%d) -> (%d,%d)",
1651 pinOldPos.x, pinOldPos.y, pinNewPos.x, pinNewPos.y );
1652 }
1653 }
1654 }
1655
1656 wxLogTrace( traceSchMove, "updateStoredPositions: complete, updated %d items", itemCount );
1657}
1658
1659
1660void SCH_MOVE_TOOL::finalizeMoveOperation( SCH_SELECTION& aSelection, SCH_COMMIT* aCommit, bool aUnselect,
1661 const std::vector<DANGLING_END_ITEM>& aInternalPoints )
1662{
1664 const bool isSlice = ( m_mode == SLICE );
1665 const bool isDragLike = ( m_mode == DRAG || m_mode == BREAK );
1666
1667 // Save whatever new bend lines and changed lines survived the drag
1668 for( SCH_LINE* newLine : m_newDragLines )
1669 {
1670 newLine->ClearEditFlags();
1671 aCommit->Added( newLine, m_frame->GetScreen() );
1672 }
1673
1674 // These lines have been changed, but aren't selected. We need to manually clear these
1675 // edit flags or they'll stick around.
1676 for( SCH_LINE* oldLine : m_changedDragLines )
1677 oldLine->ClearEditFlags();
1678
1679 m_newDragLines.clear();
1680 m_changedDragLines.clear();
1681
1682 controls->ForceCursorPosition( false );
1683 controls->ShowCursor( false );
1684 controls->SetAutoPan( false );
1685
1686 m_moveOffset = { 0, 0 };
1687 m_anchorPos.reset();
1688
1689 // One last update after exiting loop (for slower stuff, such as updating SCREEN's RTree)
1690 for( EDA_ITEM* item : aSelection )
1691 {
1692 updateItem( item, true );
1693
1694 if( SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( item ) )
1695 sch_item->SetConnectivityDirty( true );
1696 }
1697
1698 if( aSelection.GetSize() == 1 && aSelection.Front()->IsNew() )
1699 m_frame->SaveCopyForRepeatItem( static_cast<SCH_ITEM*>( aSelection.Front() ) );
1700
1701 m_selectionTool->RemoveItemsFromSel( &m_dragAdditions, QUIET_MODE );
1702
1704
1705 // If we move items away from a junction, we _may_ want to add a junction there
1706 // to denote the state
1707 for( const DANGLING_END_ITEM& it : aInternalPoints )
1708 {
1709 if( m_frame->GetScreen()->IsExplicitJunctionNeeded( it.GetPosition() ) )
1710 lwbTool->AddJunction( aCommit, m_frame->GetScreen(), it.GetPosition() );
1711 }
1712
1713 // Create a selection of original selection, drag selected/changed items, and new bend
1714 // lines for later before we clear them in the aCommit. We'll need these to check for new
1715 // junctions needed, etc.
1716 SCH_SELECTION selectionCopy( aSelection );
1717
1718 for( SCH_LINE* line : m_newDragLines )
1719 selectionCopy.Add( line );
1720
1721 for( SCH_LINE* line : m_changedDragLines )
1722 selectionCopy.Add( line );
1723
1724 lwbTool->TrimOverLappingWires( aCommit, &selectionCopy );
1725 lwbTool->AddJunctionsIfNeeded( aCommit, &selectionCopy );
1726
1727 // This needs to run prior to `RecalculateConnections` because we need to identify the
1728 // lines that are newly dangling
1729 if( isDragLike && !isSlice )
1730 trimDanglingLines( aCommit );
1731
1732 // Auto-rotate any moved labels
1733 for( EDA_ITEM* item : aSelection )
1734 m_frame->AutoRotateItem( m_frame->GetScreen(), static_cast<SCH_ITEM*>( item ) );
1735
1736 m_frame->Schematic().CleanUp( aCommit );
1737
1738 for( EDA_ITEM* item : m_frame->GetScreen()->Items() )
1739 item->ClearEditFlags();
1740
1741 // Ensure any selected item not in screen main list (for instance symbol fields) has its
1742 // edit flags cleared
1743 for( EDA_ITEM* item : selectionCopy )
1744 item->ClearEditFlags();
1745
1746 if( aUnselect )
1747 m_toolMgr->RunAction( ACTIONS::selectionClear );
1748 else
1749 m_selectionTool->RebuildSelection(); // Schematic cleanup might have merged lines, etc.
1750}
1751
1752
1754 SCH_COMMIT* aCommit )
1755{
1756 SCH_SCREEN* destScreen = aTargetSheet->GetScreen();
1757 SCH_SCREEN* srcScreen = m_frame->GetScreen();
1758
1759 BOX2I bbox;
1760
1761 for( EDA_ITEM* item : aSelection )
1762 bbox.Merge( static_cast<SCH_ITEM*>( item )->GetBoundingBox() );
1763
1764 VECTOR2I offset = VECTOR2I( 0, 0 ) - bbox.GetPosition();
1765 int step = schIUScale.MilsToIU( 50 );
1766 bool overlap = false;
1767
1768 do
1769 {
1770 BOX2I moved = bbox;
1771 moved.Move( offset );
1772 overlap = false;
1773
1774 for( SCH_ITEM* existing : destScreen->Items() )
1775 {
1776 if( moved.Intersects( existing->GetBoundingBox() ) )
1777 {
1778 overlap = true;
1779 break;
1780 }
1781 }
1782
1783 if( overlap )
1784 offset += VECTOR2I( step, step );
1785 } while( overlap );
1786
1787 for( EDA_ITEM* item : aSelection )
1788 {
1789 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( item );
1790
1791 // Remove from current screen and view manually
1792 m_frame->RemoveFromScreen( schItem, srcScreen );
1793
1794 // Move the item
1795 schItem->Move( offset );
1796
1797 // Add to destination screen manually (won't add to view since it's not current)
1798 destScreen->Append( schItem );
1799
1800 // Record in commit with CHT_DONE flag to bypass automatic screen/view operations
1801 aCommit->Stage( schItem, CHT_REMOVE | CHT_DONE, srcScreen );
1802 aCommit->Stage( schItem, CHT_ADD | CHT_DONE, destScreen );
1803 }
1804}
1805
1806
1808{
1809 // Need a local cleanup first to ensure we remove unneeded junctions
1810 m_frame->Schematic().CleanUp( aCommit, m_frame->GetScreen() );
1811
1812 std::set<SCH_ITEM*> danglers;
1813
1814 std::function<void( SCH_ITEM* )> changeHandler =
1815 [&]( SCH_ITEM* aChangedItem ) -> void
1816 {
1817 m_toolMgr->GetView()->Update( aChangedItem, KIGFX::REPAINT );
1818
1819 // Delete newly dangling lines:
1820 // Find split segments (one segment is new, the other is changed) that
1821 // we aren't dragging and don't have selected
1822 if( aChangedItem->HasFlag( IS_BROKEN) && aChangedItem->IsDangling()
1823 && !aChangedItem->IsSelected() )
1824 {
1825 danglers.insert( aChangedItem );
1826 }
1827 };
1828
1829 m_frame->GetScreen()->TestDanglingEnds( nullptr, &changeHandler );
1830
1831 for( SCH_ITEM* line : danglers )
1832 {
1833 line->SetFlags( STRUCT_DELETED );
1834 aCommit->Removed( line, m_frame->GetScreen() );
1835 updateItem( line, false ); // Update any cached visuals before commit processes
1836 m_frame->RemoveFromScreen( line, m_frame->GetScreen() );
1837 }
1838}
1839
1840
1841void SCH_MOVE_TOOL::getConnectedItems( SCH_ITEM* aOriginalItem, const VECTOR2I& aPoint,
1842 EDA_ITEMS& aList )
1843{
1844 EE_RTREE& items = m_frame->GetScreen()->Items();
1845 EE_RTREE::EE_TYPE itemsOverlapping = items.Overlapping( aOriginalItem->GetBoundingBox() );
1846 SCH_ITEM* foundJunction = nullptr;
1847 SCH_ITEM* foundSymbol = nullptr;
1848
1849 // If you're connected to a junction, you're only connected to the junction.
1850 //
1851 // But, if you're connected to a junction on a pin, you're only connected to the pin. This
1852 // is because junctions and pins have different logic for how bend lines are generated and
1853 // we need to prioritize the pin version in some cases.
1854 for( SCH_ITEM* item : itemsOverlapping )
1855 {
1856 if( item != aOriginalItem && item->IsConnected( aPoint ) )
1857 {
1858 if( item->Type() == SCH_JUNCTION_T )
1859 foundJunction = item;
1860 else if( item->Type() == SCH_SYMBOL_T )
1861 foundSymbol = item;
1862 }
1863 }
1864
1865 if( foundSymbol && foundJunction )
1866 {
1867 aList.push_back( foundSymbol );
1868 return;
1869 }
1870
1871 if( foundJunction )
1872 {
1873 aList.push_back( foundJunction );
1874 return;
1875 }
1876
1877
1878 for( SCH_ITEM* test : itemsOverlapping )
1879 {
1880 if( test == aOriginalItem || !test->CanConnect( aOriginalItem ) )
1881 continue;
1882
1883 switch( test->Type() )
1884 {
1885 case SCH_LINE_T:
1886 {
1887 SCH_LINE* line = static_cast<SCH_LINE*>( test );
1888
1889 // When getting lines for the connection cache, it's important that we only add
1890 // items at the unselected end, since that is the only end that is handled specially.
1891 // Fully selected lines, and the selected end of a partially selected line, are moved
1892 // around normally and don't care about their connections.
1893 if( ( line->HasFlag( STARTPOINT ) && aPoint == line->GetStartPoint() )
1894 || ( line->HasFlag( ENDPOINT ) && aPoint == line->GetEndPoint() ) )
1895 {
1896 continue;
1897 }
1898
1899 if( test->IsConnected( aPoint ) )
1900 aList.push_back( test );
1901
1902 // Labels can connect to a wire (or bus) anywhere along the length
1903 if( SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( aOriginalItem ) )
1904 {
1905 if( static_cast<SCH_LINE*>( test )->HitTest( label->GetPosition(), 1 ) )
1906 aList.push_back( test );
1907 }
1908
1909 break;
1910 }
1911
1912 case SCH_SHEET_T:
1913 if( aOriginalItem->Type() == SCH_LINE_T )
1914 {
1915 SCH_LINE* line = static_cast<SCH_LINE*>( aOriginalItem );
1916
1917 for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( test )->GetPins() )
1918 {
1919 if( pin->IsConnected( aPoint ) )
1920 {
1921 if( pin->IsSelected() )
1922 m_specialCaseSheetPins[pin] = { line, line->GetStartPoint() == aPoint };
1923
1924 aList.push_back( pin );
1925 }
1926 }
1927 }
1928
1929 break;
1930
1931 case SCH_SYMBOL_T:
1932 case SCH_JUNCTION_T:
1933 case SCH_NO_CONNECT_T:
1934 if( test->IsConnected( aPoint ) )
1935 aList.push_back( test );
1936
1937 break;
1938
1939 case SCH_LABEL_T:
1940 case SCH_GLOBAL_LABEL_T:
1941 case SCH_HIER_LABEL_T:
1943 // Labels can connect to a wire (or bus) anywhere along the length
1944 if( aOriginalItem->Type() == SCH_LINE_T && test->CanConnect( aOriginalItem ) )
1945 {
1946 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( test );
1947 SCH_LINE* line = static_cast<SCH_LINE*>( aOriginalItem );
1948
1949 if( line->HitTest( label->GetPosition(), 1 ) )
1950 aList.push_back( label );
1951 }
1952
1953 break;
1954
1957 if( aOriginalItem->Type() == SCH_LINE_T && test->CanConnect( aOriginalItem ) )
1958 {
1959 SCH_TEXT* label = static_cast<SCH_TEXT*>( test );
1960 SCH_LINE* line = static_cast<SCH_LINE*>( aOriginalItem );
1961
1962 if( line->HitTest( aPoint, 1 ) )
1963 aList.push_back( label );
1964 }
1965
1966 break;
1967
1968 default:
1969 break;
1970 }
1971 }
1972}
1973
1974
1976 const VECTOR2I& aPoint, EDA_ITEMS& aList )
1977{
1978 EE_RTREE& items = m_frame->GetScreen()->Items();
1979 EE_RTREE::EE_TYPE itemsOverlappingRTree = items.Overlapping( aSelectedItem->GetBoundingBox() );
1980 std::vector<SCH_ITEM*> itemsConnectable;
1981 bool ptHasUnselectedJunction = false;
1982
1983 auto makeNewWire =
1984 [this]( SCH_COMMIT* commit, SCH_ITEM* fixed, SCH_ITEM* selected, const VECTOR2I& start,
1985 const VECTOR2I& end )
1986 {
1987 SCH_LINE* newWire;
1988
1989 // Add a new newWire between the fixed item and the selected item so the selected
1990 // item can be dragged.
1991 if( fixed->GetLayer() == LAYER_BUS_JUNCTION || fixed->GetLayer() == LAYER_BUS
1992 || selected->GetLayer() == LAYER_BUS )
1993 {
1994 newWire = new SCH_LINE( start, LAYER_BUS );
1995 }
1996 else
1997 {
1998 newWire = new SCH_LINE( start, LAYER_WIRE );
1999 }
2000
2001 newWire->SetFlags( IS_NEW );
2002 newWire->SetConnectivityDirty( true );
2003
2004 SCH_LINE* selectedLine = dynamic_cast<SCH_LINE*>( selected );
2005 SCH_LINE* fixedLine = dynamic_cast<SCH_LINE*>( fixed );
2006
2007 if( selectedLine )
2008 {
2009 newWire->SetLastResolvedState( selected );
2010 cloneWireConnection( newWire, selectedLine, m_frame );
2011 }
2012 else if( fixedLine )
2013 {
2014 newWire->SetLastResolvedState( fixed );
2015 cloneWireConnection( newWire, fixedLine, m_frame );
2016 }
2017
2018 newWire->SetEndPoint( end );
2019 m_frame->AddToScreen( newWire, m_frame->GetScreen() );
2020 commit->Added( newWire, m_frame->GetScreen() );
2021
2022 return newWire;
2023 };
2024
2025 auto makeNewJunction =
2026 [this]( SCH_COMMIT* commit, SCH_LINE* line, const VECTOR2I& pt )
2027 {
2028 SCH_JUNCTION* junction = new SCH_JUNCTION( pt );
2029 junction->SetFlags( IS_NEW );
2030 junction->SetConnectivityDirty( true );
2031 junction->SetLastResolvedState( line );
2032
2033 if( line->IsBus() )
2034 junction->SetLayer( LAYER_BUS_JUNCTION );
2035
2036 m_frame->AddToScreen( junction, m_frame->GetScreen() );
2037 commit->Added( junction, m_frame->GetScreen() );
2038
2039 return junction;
2040 };
2041
2042 for( SCH_ITEM* item : itemsOverlappingRTree )
2043 {
2044 if( item->Type() == SCH_SHEET_T )
2045 {
2046 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
2047
2048 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
2049 {
2050 if( !pin->IsSelected()
2051 && pin->GetPosition() == aSelectedItem->GetPosition()
2052 && pin->CanConnect( aSelectedItem ) )
2053 {
2054 itemsConnectable.push_back( pin );
2055 }
2056 }
2057
2058 continue;
2059 }
2060
2061 // Skip ourselves, skip already selected items (but not lines, they need both ends tested)
2062 // and skip unconnectable items
2063 if( item == aSelectedItem
2064 || ( item->Type() != SCH_LINE_T && item->IsSelected() )
2065 || !item->CanConnect( aSelectedItem ) )
2066 {
2067 continue;
2068 }
2069
2070 itemsConnectable.push_back( item );
2071 }
2072
2073 for( SCH_ITEM* item : itemsConnectable )
2074 {
2075 if( item->Type() == SCH_JUNCTION_T && item->IsConnected( aPoint ) && !item->IsSelected() )
2076 {
2077 ptHasUnselectedJunction = true;
2078 break;
2079 }
2080 }
2081
2082 SCH_LINE* newWire = nullptr;
2083
2084 for( SCH_ITEM* test : itemsConnectable )
2085 {
2086 KICAD_T testType = test->Type();
2087
2088 switch( testType )
2089 {
2090 case SCH_LINE_T:
2091 {
2092 // Select the connected end of wires/bus connections that don't have an unselected
2093 // junction isolating them from the drag
2094 if( ptHasUnselectedJunction )
2095 break;
2096
2097 SCH_LINE* line = static_cast<SCH_LINE*>( test );
2098
2099 if( line->GetStartPoint() == aPoint )
2100 {
2101 // It's possible to manually select one end of a line and get a drag
2102 // connected other end, so we set the flag and then early exit the loop
2103 // later if the other drag items like labels attached to the line have
2104 // already been grabbed during the partial selection process.
2105 line->SetFlags( STARTPOINT );
2106
2107 if( line->HasFlag( SELECTED ) || line->HasFlag( SELECTED_BY_DRAG ) )
2108 {
2109 continue;
2110 }
2111 else
2112 {
2113 line->SetFlags( SELECTED_BY_DRAG );
2114 aList.push_back( line );
2115 }
2116 }
2117 else if( line->GetEndPoint() == aPoint )
2118 {
2119 line->SetFlags( ENDPOINT );
2120
2121 if( line->HasFlag( SELECTED ) || line->HasFlag( SELECTED_BY_DRAG ) )
2122 {
2123 continue;
2124 }
2125 else
2126 {
2127 line->SetFlags( SELECTED_BY_DRAG );
2128 aList.push_back( line );
2129 }
2130 }
2131 else
2132 {
2133 switch( aSelectedItem->Type() )
2134 {
2135 // These items can connect anywhere along a line
2138 case SCH_LABEL_T:
2139 case SCH_HIER_LABEL_T:
2140 case SCH_GLOBAL_LABEL_T:
2142 // Only add a line if this line is unselected; if the label and line are both
2143 // selected they'll move together
2144 if( line->HitTest( aPoint, 1 ) && !line->HasFlag( SELECTED )
2145 && !line->HasFlag( SELECTED_BY_DRAG ) )
2146 {
2147 newWire = makeNewWire( aCommit, line, aSelectedItem, aPoint, aPoint );
2148 newWire->SetFlags( SELECTED_BY_DRAG | STARTPOINT );
2149 newWire->StoreAngle( ( line->Angle() + ANGLE_90 ).Normalize() );
2150 aList.push_back( newWire );
2151
2152 if( aPoint != line->GetStartPoint() && aPoint != line->GetEndPoint() )
2153 {
2154 // Split line in half
2155 aCommit->Modify( line, m_frame->GetScreen() );
2156
2157 VECTOR2I oldEnd = line->GetEndPoint();
2158 line->SetEndPoint( aPoint );
2159
2160 makeNewWire( aCommit, line, line, aPoint, oldEnd );
2161 makeNewJunction( aCommit, line, aPoint );
2162 }
2163 else
2164 {
2165 m_lineConnectionCache[ newWire ] = { line };
2166 m_lineConnectionCache[ line ] = { newWire };
2167 }
2168 }
2169 break;
2170
2171 default:
2172 break;
2173 }
2174
2175 break;
2176 }
2177
2178 // Since only one end is going to move, the movement vector of any labels attached to
2179 // it is scaled by the proportion of the line length the label is from the moving end.
2180 for( SCH_ITEM* item : items.Overlapping( line->GetBoundingBox() ) )
2181 {
2182 SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( item );
2183
2184 if( !label || label->IsSelected() )
2185 continue; // These will be moved on their own because they're selected
2186
2187 if( label->HasFlag( SELECTED_BY_DRAG ) )
2188 continue;
2189
2190 if( label->CanConnect( line ) && line->HitTest( label->GetPosition(), 1 ) )
2191 {
2192 label->SetFlags( SELECTED_BY_DRAG );
2193 aList.push_back( label );
2194
2196 info.attachedLine = line;
2197 info.originalLabelPos = label->GetPosition();
2198 m_specialCaseLabels[label] = info;
2199 }
2200 }
2201
2202 break;
2203 }
2204
2205 case SCH_SHEET_T:
2206 for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( test )->GetPins() )
2207 {
2208 if( pin->IsConnected( aPoint ) )
2209 {
2210 if( pin->IsSelected() && aSelectedItem->Type() == SCH_LINE_T )
2211 {
2212 SCH_LINE* line = static_cast<SCH_LINE*>( aSelectedItem );
2213 m_specialCaseSheetPins[ pin ] = { line, line->GetStartPoint() == aPoint };
2214 }
2215 else if( !newWire )
2216 {
2217 // Add a new wire between the sheetpin and the selected item so the
2218 // selected item can be dragged.
2219 newWire = makeNewWire( aCommit, pin, aSelectedItem, aPoint, aPoint );
2220 newWire->SetFlags( SELECTED_BY_DRAG | STARTPOINT );
2221 aList.push_back( newWire );
2222 }
2223 }
2224 }
2225
2226 break;
2227
2228 case SCH_SYMBOL_T:
2229 case SCH_JUNCTION_T:
2230 if( test->IsConnected( aPoint ) && !newWire )
2231 {
2232 // Add a new wire between the symbol or junction and the selected item so
2233 // the selected item can be dragged.
2234 newWire = makeNewWire( aCommit, test, aSelectedItem, aPoint, aPoint );
2235 newWire->SetFlags( SELECTED_BY_DRAG | STARTPOINT );
2236 aList.push_back( newWire );
2237 }
2238
2239 break;
2240
2241 case SCH_NO_CONNECT_T:
2242 // Select no-connects that are connected to items being moved.
2243 if( !test->HasFlag( SELECTED_BY_DRAG ) && test->IsConnected( aPoint ) )
2244 {
2245 aList.push_back( test );
2246 test->SetFlags( SELECTED_BY_DRAG );
2247 }
2248
2249 break;
2250
2251 case SCH_LABEL_T:
2252 case SCH_GLOBAL_LABEL_T:
2253 case SCH_HIER_LABEL_T:
2255 case SCH_SHEET_PIN_T:
2256 // Performance optimization:
2257 if( test->HasFlag( SELECTED_BY_DRAG ) )
2258 break;
2259
2260 // Select labels that are connected to a wire (or bus) being moved.
2261 if( aSelectedItem->Type() == SCH_LINE_T && test->CanConnect( aSelectedItem ) )
2262 {
2263 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( test );
2264 SCH_LINE* line = static_cast<SCH_LINE*>( aSelectedItem );
2265
2266 bool oneEndFixed = !line->HasFlag( STARTPOINT ) || !line->HasFlag( ENDPOINT );
2267
2268 if( line->HitTest( label->GetTextPos(), 1 ) )
2269 {
2270 if( ( !line->HasFlag( STARTPOINT ) && label->GetPosition() == line->GetStartPoint() )
2271 || ( !line->HasFlag( ENDPOINT ) && label->GetPosition() == line->GetEndPoint() ) )
2272 {
2273 //If we have a line selected at only one end, don't grab labels
2274 //connected directly to the unselected endpoint
2275 break;
2276 }
2277 else
2278 {
2279 label->SetFlags( SELECTED_BY_DRAG );
2280 aList.push_back( label );
2281
2282 if( oneEndFixed )
2283 {
2285 info.attachedLine = line;
2286 info.originalLabelPos = label->GetPosition();
2287 m_specialCaseLabels[label] = info;
2288 }
2289 }
2290 }
2291 }
2292 else if( test->IsConnected( aPoint ) && !newWire )
2293 {
2294 // Add a new wire between the label and the selected item so the selected item
2295 // can be dragged.
2296 newWire = makeNewWire( aCommit, test, aSelectedItem, aPoint, aPoint );
2297 newWire->SetFlags( SELECTED_BY_DRAG | STARTPOINT );
2298 aList.push_back( newWire );
2299 }
2300
2301 break;
2302
2305 // Performance optimization:
2306 if( test->HasFlag( SELECTED_BY_DRAG ) )
2307 break;
2308
2309 // Select bus entries that are connected to a bus being moved.
2310 if( aSelectedItem->Type() == SCH_LINE_T && test->CanConnect( aSelectedItem ) )
2311 {
2312 SCH_LINE* line = static_cast<SCH_LINE*>( aSelectedItem );
2313
2314 if( ( !line->HasFlag( STARTPOINT ) && test->IsConnected( line->GetStartPoint() ) )
2315 || ( !line->HasFlag( ENDPOINT ) && test->IsConnected( line->GetEndPoint() ) ) )
2316 {
2317 // If we have a line selected at only one end, don't grab bus entries
2318 // connected directly to the unselected endpoint
2319 continue;
2320 }
2321
2322 for( VECTOR2I& point : test->GetConnectionPoints() )
2323 {
2324 if( line->HitTest( point, 1 ) )
2325 {
2326 test->SetFlags( SELECTED_BY_DRAG );
2327 aList.push_back( test );
2328
2329 // A bus entry needs its wire & label as well
2330 std::vector<VECTOR2I> ends = test->GetConnectionPoints();
2331 VECTOR2I otherEnd;
2332
2333 if( ends[0] == point )
2334 otherEnd = ends[1];
2335 else
2336 otherEnd = ends[0];
2337
2338 getConnectedDragItems( aCommit, test, otherEnd, aList );
2339
2340 // No need to test the other end of the bus entry
2341 break;
2342 }
2343 }
2344 }
2345
2346 break;
2347
2348 default:
2349 break;
2350 }
2351 }
2352}
2353
2354
2355void SCH_MOVE_TOOL::moveItem( EDA_ITEM* aItem, const VECTOR2I& aDelta )
2356{
2357 static int moveCallCount = 0;
2358 wxLogTrace( traceSchMove, "moveItem[%d]: type=%d, delta=(%d,%d)",
2359 ++moveCallCount, aItem->Type(), aDelta.x, aDelta.y );
2360
2361 switch( aItem->Type() )
2362 {
2363 case SCH_LINE_T:
2364 {
2365 SCH_LINE* line = static_cast<SCH_LINE*>( aItem );
2366
2367 if( aItem->HasFlag( STARTPOINT ) || ( m_mode == MOVE ) )
2368 line->MoveStart( aDelta );
2369
2370 if( aItem->HasFlag( ENDPOINT ) || ( m_mode == MOVE ) )
2371 line->MoveEnd( aDelta );
2372
2373 break;
2374 }
2375
2376 case SCH_PIN_T:
2377 case SCH_FIELD_T:
2378 {
2379 SCH_ITEM* parent = (SCH_ITEM*) aItem->GetParent();
2380 VECTOR2I delta( aDelta );
2381
2382 if( parent && parent->Type() == SCH_SYMBOL_T )
2383 {
2384 SCH_SYMBOL* symbol = (SCH_SYMBOL*) aItem->GetParent();
2385 TRANSFORM transform = symbol->GetTransform().InverseTransform();
2386
2387 delta = transform.TransformCoordinate( delta );
2388 }
2389
2390 static_cast<SCH_ITEM*>( aItem )->Move( delta );
2391
2392 // If we're moving a field with respect to its parent then it's no longer auto-placed
2393 if( aItem->Type() == SCH_FIELD_T && parent && !parent->IsSelected() )
2395
2396 break;
2397 }
2398
2399 case SCH_SHEET_PIN_T:
2400 {
2401 SCH_SHEET_PIN* pin = (SCH_SHEET_PIN*) aItem;
2402
2403 pin->SetStoredPos( pin->GetStoredPos() + aDelta );
2404 pin->ConstrainOnEdge( pin->GetStoredPos(), true );
2405 break;
2406 }
2407
2408 case SCH_LABEL_T:
2410 case SCH_GLOBAL_LABEL_T:
2411 case SCH_HIER_LABEL_T:
2412 {
2413 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( aItem );
2414
2415 if( m_specialCaseLabels.count( label ) )
2416 {
2418 SEG currentLine( info.attachedLine->GetStartPoint(), info.attachedLine->GetEndPoint() );
2419 label->SetPosition( currentLine.NearestPoint( info.originalLabelPos ) );
2420 }
2421 else
2422 {
2423 label->Move( aDelta );
2424 }
2425
2426 break;
2427 }
2428
2429 default:
2430 static_cast<SCH_ITEM*>( aItem )->Move( aDelta );
2431 break;
2432 }
2433
2434 aItem->SetFlags( IS_MOVING );
2435}
2436
2437
2439{
2441 SCH_SELECTION& selection = m_selectionTool->RequestSelection( SCH_COLLECTOR::MovableItems );
2442 GRID_HELPER_GRIDS selectionGrid = grid.GetSelectionGrid( selection );
2443 SCH_COMMIT commit( m_toolMgr );
2444
2445 auto doMoveItem =
2446 [&]( EDA_ITEM* item, const VECTOR2I& delta )
2447 {
2448 commit.Modify( item, m_frame->GetScreen(), RECURSE_MODE::RECURSE );
2449
2450 // Ensure only one end is moved when calling moveItem
2451 // i.e. we are in drag mode
2452 MOVE_MODE tmpMode = m_mode;
2453 m_mode = DRAG;
2454 moveItem( item, delta );
2455 m_mode = tmpMode;
2456
2457 item->ClearFlags( IS_MOVING );
2458 updateItem( item, true );
2459 };
2460
2461 for( SCH_ITEM* it : m_frame->GetScreen()->Items() )
2462 {
2463 if( !it->IsSelected() )
2464 it->ClearFlags( STARTPOINT | ENDPOINT );
2465
2466 if( !selection.IsHover() && it->IsSelected() )
2467 it->SetFlags( STARTPOINT | ENDPOINT );
2468
2469 it->SetStoredPos( it->GetPosition() );
2470
2471 if( it->Type() == SCH_SHEET_T )
2472 {
2473 for( SCH_SHEET_PIN* pin : static_cast<SCH_SHEET*>( it )->GetPins() )
2474 pin->SetStoredPos( pin->GetPosition() );
2475 }
2476 }
2477
2478 for( EDA_ITEM* item : selection )
2479 {
2480 if( item->Type() == SCH_LINE_T )
2481 {
2482 SCH_LINE* line = static_cast<SCH_LINE*>( item );
2483 std::vector<int> flags{ STARTPOINT, ENDPOINT };
2484 std::vector<VECTOR2I> pts{ line->GetStartPoint(), line->GetEndPoint() };
2485
2486 for( int ii = 0; ii < 2; ++ii )
2487 {
2488 EDA_ITEMS drag_items{ item };
2489 line->ClearFlags();
2490 line->SetFlags( SELECTED );
2491 line->SetFlags( flags[ii] );
2492 getConnectedDragItems( &commit, line, pts[ii], drag_items );
2493 std::set<EDA_ITEM*> unique_items( drag_items.begin(), drag_items.end() );
2494
2495 VECTOR2I delta = grid.AlignGrid( pts[ii], selectionGrid ) - pts[ii];
2496
2497 if( delta != VECTOR2I( 0, 0 ) )
2498 {
2499 for( EDA_ITEM* dragItem : unique_items )
2500 {
2501 if( dragItem->GetParent() && dragItem->GetParent()->IsSelected() )
2502 continue;
2503
2504 doMoveItem( dragItem, delta );
2505 }
2506 }
2507 }
2508 }
2509 else if( item->Type() == SCH_FIELD_T || item->Type() == SCH_TEXT_T )
2510 {
2511 VECTOR2I delta = grid.AlignGrid( item->GetPosition(), selectionGrid ) - item->GetPosition();
2512
2513 if( delta != VECTOR2I( 0, 0 ) )
2514 doMoveItem( item, delta );
2515 }
2516 else if( item->Type() == SCH_SHEET_T )
2517 {
2518 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
2519 VECTOR2I topLeft = sheet->GetPosition();
2520 VECTOR2I bottomRight = topLeft + sheet->GetSize();
2521 VECTOR2I tl_delta = grid.AlignGrid( topLeft, selectionGrid ) - topLeft;
2522 VECTOR2I br_delta = grid.AlignGrid( bottomRight, selectionGrid ) - bottomRight;
2523
2524 if( tl_delta != VECTOR2I( 0, 0 ) || br_delta != VECTOR2I( 0, 0 ) )
2525 {
2526 doMoveItem( sheet, tl_delta );
2527
2528 VECTOR2I newSize = (VECTOR2I) sheet->GetSize() - tl_delta + br_delta;
2529 sheet->SetSize( VECTOR2I( newSize.x, newSize.y ) );
2530 updateItem( sheet, true );
2531 }
2532
2533 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
2534 {
2535 VECTOR2I newPos;
2536
2537 if( pin->GetSide() == SHEET_SIDE::TOP || pin->GetSide() == SHEET_SIDE::LEFT )
2538 newPos = pin->GetPosition() + tl_delta;
2539 else
2540 newPos = pin->GetPosition() + br_delta;
2541
2542 VECTOR2I delta = grid.AlignGrid( newPos - pin->GetPosition(), selectionGrid );
2543
2544 if( delta != VECTOR2I( 0, 0 ) )
2545 {
2546 EDA_ITEMS drag_items;
2547 getConnectedDragItems( &commit, pin, pin->GetConnectionPoints()[0],
2548 drag_items );
2549
2550 doMoveItem( pin, delta );
2551
2552 for( EDA_ITEM* dragItem : drag_items )
2553 {
2554 if( dragItem->GetParent() && dragItem->GetParent()->IsSelected() )
2555 continue;
2556
2557 doMoveItem( dragItem, delta );
2558 }
2559 }
2560 }
2561 }
2562 else
2563 {
2564 SCH_ITEM* schItem = static_cast<SCH_ITEM*>( item );
2565 std::vector<VECTOR2I> connections = schItem->GetConnectionPoints();
2566 EDA_ITEMS drag_items;
2567
2568 for( const VECTOR2I& point : connections )
2569 getConnectedDragItems( &commit, schItem, point, drag_items );
2570
2571 std::map<VECTOR2I, int> shifts;
2572 VECTOR2I most_common( 0, 0 );
2573 int max_count = 0;
2574
2575 for( const VECTOR2I& conn : connections )
2576 {
2577 VECTOR2I gridpt = grid.AlignGrid( conn, selectionGrid ) - conn;
2578
2579 shifts[gridpt]++;
2580
2581 if( shifts[gridpt] > max_count )
2582 {
2583 most_common = gridpt;
2584 max_count = shifts[most_common];
2585 }
2586 }
2587
2588 if( most_common != VECTOR2I( 0, 0 ) )
2589 {
2590 doMoveItem( item, most_common );
2591
2592 for( EDA_ITEM* dragItem : drag_items )
2593 {
2594 if( dragItem->GetParent() && dragItem->GetParent()->IsSelected() )
2595 continue;
2596
2597 doMoveItem( dragItem, most_common );
2598 }
2599 }
2600 }
2601 }
2602
2604 lwbTool->TrimOverLappingWires( &commit, &selection );
2605 lwbTool->AddJunctionsIfNeeded( &commit, &selection );
2606
2608
2609 m_frame->Schematic().CleanUp( &commit );
2610 commit.Push( _( "Align Items to Grid" ) );
2611 return 0;
2612}
2613
2614
2616{
2617 // Remove new bend lines added during the drag
2618 for( SCH_LINE* newLine : m_newDragLines )
2619 {
2620 m_frame->RemoveFromScreen( newLine, m_frame->GetScreen() );
2621 delete newLine;
2622 }
2623
2624 m_newDragLines.clear();
2625}
2626
2627
constexpr EDA_IU_SCALE schIUScale
Definition base_units.h:114
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
@ CURSOR_RIGHT
Definition actions.h:312
@ CURSOR_LEFT
Definition actions.h:310
@ CURSOR_UP
Definition actions.h:306
@ CURSOR_DOWN
Definition actions.h:308
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:179
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:223
static TOOL_ACTION refreshPreview
Definition actions.h:158
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:841
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:272
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:142
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:144
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:146
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:356
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:292
virtual bool CanConnect(const SCH_ITEM *aItem) const
Definition sch_item.h:502
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode)
Definition sch_item.h:611
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:440
virtual void Move(const VECTOR2I &aMoveVector)
Move the item by aMoveVector to a new position.
Definition sch_item.h:379
void SetLayer(SCH_LAYER_ID aLayer)
Definition sch_item.h:322
void SetConnectivityDirty(bool aDirty=true)
Definition sch_item.h:570
void SetFieldsAutoplaced(AUTOPLACE_ALGO aAlgo)
Definition sch_item.h:607
bool IsConnected(const VECTOR2I &aPoint) const
Test the item to see if it is connected to aPoint.
Definition sch_item.cpp:343
virtual bool IsMovableFromAnchorPoint() const
Check if object is movable from the anchor point.
Definition sch_item.h:289
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:352
VECTOR2I & GetStoredPos()
Definition sch_item.h:291
bool IsGroupableType() const
Definition sch_item.cpp:105
virtual std::vector< VECTOR2I > GetConnectionPoints() const
Add all the connection points for this item to aPoints.
Definition sch_item.h:522
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:817
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:717
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:117
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:47
void SetSize(const VECTOR2I &aSize)
Definition sch_sheet.h:119
bool IsTopLevelSheet() const
Check if this sheet is a top-level sheet.
VECTOR2I GetSize() const
Definition sch_sheet.h:118
SCH_SCREEN * GetScreen() const
Definition sch_sheet.h:116
VECTOR2I GetPosition() const override
Definition sch_sheet.h:463
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:198
Schematic symbol object.
Definition sch_symbol.h:76
VECTOR2I GetPosition() const override
Definition sch_text.h:150
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:604
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
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:220
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
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition eda_item.h:566
#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...
@ 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
#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
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.
bool moved
VECTOR2I end
int delta
@ TA_CHOICE_MENU_CHOICE
Context menu choice.
Definition tool_event.h:98
@ TC_COMMAND
Definition tool_event.h:57
@ TC_MOUSE
Definition tool_event.h:55
@ TC_KEYBOARD
Definition tool_event.h:56
@ MD_CTRL
Definition tool_event.h:144
@ MD_SHIFT
Definition tool_event.h:143
@ STS_CANCELLED
Definition tool_event.h:164
@ STS_FINISHED
Definition tool_event.h:163
@ STS_RUNNING
Definition tool_event.h:162
@ 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