KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_move_tool.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2019 CERN
5 * Copyright (C) 2019-2023 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#ifndef KICAD_SCH_MOVE_TOOL_H
26#define KICAD_SCH_MOVE_TOOL_H
27
28#include <tools/ee_tool_base.h>
29#include <sch_base_frame.h>
30
31
32class SCH_EDIT_FRAME;
34
35
37{
40};
41
42
43class SCH_MOVE_TOOL : public EE_TOOL_BASE<SCH_EDIT_FRAME>
44{
45public:
47 ~SCH_MOVE_TOOL() override { }
48
50 bool Init() override;
51
55 int Main( const TOOL_EVENT& aEvent );
56
63 int AlignToGrid( const TOOL_EVENT& aEvent );
64
65private:
66 bool doMoveSelection( const TOOL_EVENT& aEvent, SCH_COMMIT* aCommit, bool aIsSlice );
67
68 void moveItem( EDA_ITEM* aItem, const VECTOR2I& aDelta );
69
73 void getConnectedItems( SCH_ITEM* aOriginalItem, const VECTOR2I& aPoint, EDA_ITEMS& aList );
74 void getConnectedDragItems( SCH_COMMIT* aCommit, SCH_ITEM* fixed, const VECTOR2I& selected,
75 EDA_ITEMS& aList );
76
77 void orthoLineDrag( SCH_COMMIT* aCommit, SCH_LINE* line, const VECTOR2I& splitDelta,
78 int& xBendCount, int& yBendCount, const EE_GRID_HELPER& grid );
79
81 void clearNewDragLines();
82
84 void setTransitions() override;
85
87 void trimDanglingLines( SCH_COMMIT* aCommit );
88
89private:
92
96
98 std::vector<KIID> m_dragAdditions;
100 std::map<SCH_LINE*, EDA_ITEMS> m_lineConnectionCache;
102 std::unordered_set<SCH_LINE*> m_newDragLines;
104 std::unordered_set<SCH_LINE*> m_changedDragLines;
105
107
111
113
114 // A map of labels to scaling factors. Used to scale the movement vector for labels that
115 // are attached to wires which have only one end moving.
116 std::map<SCH_LABEL_BASE*, SPECIAL_CASE_LABEL_INFO> m_specialCaseLabels;
117
118 // A map of sheet pins to the line-endings (true == start) they're connected to. Sheet
119 // pins are constrained in their movement so their attached lines must be too.
120 std::map<SCH_SHEET_PIN*, std::pair<SCH_LINE*, bool>> m_specialCaseSheetPins;
121};
122
123#endif //KICAD_SCH_MOVE_TOOL_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:48
Schematic editor (Eeschema) main window.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:166
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:41
bool Init() override
Init() is called once upon a registration of the tool.
VECTOR2I m_cursor
void trimDanglingLines(SCH_COMMIT *aCommit)
bool m_isDrag
Items (such as wires) which were added to the selection for a drag.
Definition: sch_move_tool.h:95
void orthoLineDrag(SCH_COMMIT *aCommit, SCH_LINE *line, const VECTOR2I &splitDelta, int &xBendCount, int &yBendCount, const EE_GRID_HELPER &grid)
Clears the new drag lines and removes them from the screen.
std::unordered_set< SCH_LINE * > m_newDragLines
Lines changed by drag algorithm that weren't selected.
bool doMoveSelection(const TOOL_EVENT &aEvent, SCH_COMMIT *aCommit, bool aIsSlice)
OPT_VECTOR2I m_anchorPos
int Main(const TOOL_EVENT &aEvent)
Run an interactive move of the selected items, or the item under the cursor.
bool m_inMoveTool
< Re-entrancy guard
Definition: sch_move_tool.h:91
std::vector< KIID > m_dragAdditions
Cache of the line's original connections before dragging started.
Definition: sch_move_tool.h:98
void moveItem(EDA_ITEM *aItem, const VECTOR2I &aDelta)
Find additional items for a drag operation.
std::unordered_set< SCH_LINE * > m_changedDragLines
void setTransitions() override
Cleanup dangling lines left after a drag.
~SCH_MOVE_TOOL() override
Definition: sch_move_tool.h:47
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.
bool m_moveInProgress
Definition: sch_move_tool.h:94
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.
std::map< SCH_SHEET_PIN *, std::pair< SCH_LINE *, bool > > m_specialCaseSheetPins
Generic, UI-independent tool event.
Definition: tool_event.h:167
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: eda_item.h:532
std::optional< VECTOR2I > OPT_VECTOR2I
Definition: seg.h:39