KiCad PCB EDA Suite
Loading...
Searching...
No Matches
edit_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) 2013-2020 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Maciej Suminski <[email protected]>
8 * @author Tomasz Wlostowski <[email protected]>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, you may find one here:
22 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23 * or you may search the http://www.gnu.org website for the version 2 license,
24 * or you may write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 */
27
28#ifndef __EDIT_TOOL_H
29#define __EDIT_TOOL_H
30
31#include <math/vector2d.h>
32#include <tools/pcb_tool_base.h>
34#include <status_popup.h>
35#include <unordered_set>
36
37
38class BOARD_COMMIT;
39class BOARD_ITEM;
42
43namespace KIGFX::PREVIEW
44{
45 class RULER_ITEM;
46}
47
48
56{
57public:
58 EDIT_TOOL();
59
61 void Reset( RESET_REASON aReason ) override;
62
64 bool Init() override;
65
67 int GetAndPlace( const TOOL_EVENT& aEvent );
68
72 int Move( const TOOL_EVENT& aEvent );
73
78 int Drag( const TOOL_EVENT& aEvent );
79
83 int DragArcTrack( const TOOL_EVENT& aTrack );
84
88 int Properties( const TOOL_EVENT& aEvent );
89
93 int Rotate( const TOOL_EVENT& aEvent );
94
98 int Flip( const TOOL_EVENT& aEvent );
99
103 int Mirror( const TOOL_EVENT& aEvent );
104
105 static const std::vector<KICAD_T> MirrorableItems;
106
110 int JustifyText( const TOOL_EVENT& aEvent );
111
115 int Swap( const TOOL_EVENT& aEvent );
116
120 int PackAndMoveFootprints( const TOOL_EVENT& aEvent );
121
122 int ChangeTrackWidth( const TOOL_EVENT& aEvent );
123 int ChangeTrackLayer( const TOOL_EVENT& aEvent );
124
128 int FilletTracks( const TOOL_EVENT& aEvent );
129
134 int ModifyLines( const TOOL_EVENT& aEvent );
135
139 int HealShapes( const TOOL_EVENT& aEvent );
140
144 int SimplifyPolygons( const TOOL_EVENT& aEvent );
145
149 int OutsetItems( const TOOL_EVENT& aEvent );
150
155 int BooleanPolygons( const TOOL_EVENT& aEvent );
156
160 int Remove( const TOOL_EVENT& aEvent );
161
162 void DeleteItems( const PCB_SELECTION& aItem, bool aIsCut );
163
167 int Duplicate( const TOOL_EVENT& aItem );
168
172 int MoveExact( const TOOL_EVENT& aEvent );
173
177 int Increment( const TOOL_EVENT& aEvent );
178
182 static void FootprintFilter( const VECTOR2I&, GENERAL_COLLECTOR& aCollector,
183 PCB_SELECTION_TOOL* sTool );
184
188 static void PadFilter( const VECTOR2I&, GENERAL_COLLECTOR& aCollector,
189 PCB_SELECTION_TOOL* sTool );
190
191private:
193 void setTransitions() override;
194
199 int copyToClipboard( const TOOL_EVENT& aEvent );
200
204 int copyToClipboardAsText( const TOOL_EVENT& aEvent );
205
210 int cutToClipboard( const TOOL_EVENT& aEvent );
211
214 bool updateModificationPoint( PCB_SELECTION& aSelection );
215
216 bool invokeInlineRouter( int aDragMode );
217 bool isRouterActive() const;
218
219 VECTOR2I getSafeMovement( const VECTOR2I& aMovement, const BOX2I& aSourceBBox,
220 const VECTOR2D& aBBoxOffset );
221
222 bool pickReferencePoint( const wxString& aTooltip, const wxString& aSuccessMessage,
223 const wxString& aCanceledMessage, VECTOR2I& aReferencePoint );
224
225 bool doMoveSelection( const TOOL_EVENT& aEvent, BOARD_COMMIT* aCommit, bool aAutoStart );
226
228 void rebuildConnectivity();
229
230private:
232 bool m_dragging; // Indicates objects are currently being dragged
233 VECTOR2I m_cursor; // Last cursor position (so getModificationPoint()
234 // can avoid changes of edit reference point).
235 std::unique_ptr<STATUS_TEXT_POPUP> m_statusPopup;
236
237 static const unsigned int COORDS_PADDING; // Padding from coordinates limits for this tool
238};
239
240#endif
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
The interactive edit tool.
Definition: edit_tool.h:56
bool isRouterActive() const
Definition: edit_tool.cpp:517
int Duplicate(const TOOL_EVENT &aItem)
Duplicate the current selection and starts a move action.
Definition: edit_tool.cpp:2909
int Drag(const TOOL_EVENT &aEvent)
Invoke the PNS router to drag tracks or do an offline resizing of an arc track if a single arc track ...
Definition: edit_tool.cpp:525
bool doMoveSelection(const TOOL_EVENT &aEvent, BOARD_COMMIT *aCommit, bool aAutoStart)
Rebuilds the ratsnest for operations that require it outside the commit rebuild.
int Swap(const TOOL_EVENT &aEvent)
Swap currently selected items' positions.
int OutsetItems(const TOOL_EVENT &aEvent)
Create outset items from selection.
int PackAndMoveFootprints(const TOOL_EVENT &aEvent)
Try to fit selected footprints inside a minimal area and start movement.
int Mirror(const TOOL_EVENT &aEvent)
Mirror the current selection.
Definition: edit_tool.cpp:2265
int Increment(const TOOL_EVENT &aEvent)
Increment some aspect of the selected items.q.
Definition: edit_tool.cpp:3079
bool pickReferencePoint(const wxString &aTooltip, const wxString &aSuccessMessage, const wxString &aCanceledMessage, VECTOR2I &aReferencePoint)
Definition: edit_tool.cpp:3242
bool Init() override
Init() is called once upon a registration of the tool.
Definition: edit_tool.cpp:210
int ModifyLines(const TOOL_EVENT &aEvent)
"Modify" graphical lines.
Definition: edit_tool.cpp:1424
bool m_dragging
Definition: edit_tool.h:232
int MoveExact(const TOOL_EVENT &aEvent)
Invoke a dialog box to allow moving of the item by an exact amount.
Definition: edit_tool.cpp:2813
int Move(const TOOL_EVENT &aEvent)
Main loop in which events are handled.
static const unsigned int COORDS_PADDING
Definition: edit_tool.h:237
int JustifyText(const TOOL_EVENT &aEvent)
Set the justification on any text items (or fields) in the current selection.
Definition: edit_tool.cpp:2390
bool updateModificationPoint(PCB_SELECTION &aSelection)
Definition: edit_tool.cpp:3196
int ChangeTrackLayer(const TOOL_EVENT &aEvent)
Definition: edit_tool.cpp:1067
VECTOR2I getSafeMovement(const VECTOR2I &aMovement, const BOX2I &aSourceBBox, const VECTOR2D &aBBoxOffset)
std::unique_ptr< STATUS_TEXT_POPUP > m_statusPopup
Definition: edit_tool.h:235
int DragArcTrack(const TOOL_EVENT &aTrack)
Drag-resize an arc (and change end points of connected straight segments).
Definition: edit_tool.cpp:641
int copyToClipboard(const TOOL_EVENT &aEvent)
Send the current selection to the clipboard by formatting it as a fake pcb see #AppendBoardFromClipbo...
Definition: edit_tool.cpp:3354
int Remove(const TOOL_EVENT &aEvent)
Delete currently selected items.
Definition: edit_tool.cpp:2737
int cutToClipboard(const TOOL_EVENT &aEvent)
Cut the current selection to the clipboard by formatting it as a fake pcb see #AppendBoardFromClipboa...
Definition: edit_tool.cpp:3515
static const std::vector< KICAD_T > MirrorableItems
Definition: edit_tool.h:105
void DeleteItems(const PCB_SELECTION &aItem, bool aIsCut)
Definition: edit_tool.cpp:2562
static void PadFilter(const VECTOR2I &, GENERAL_COLLECTOR &aCollector, PCB_SELECTION_TOOL *sTool)
A selection filter which prunes the selection to contain only items of type PCB_PAD_T.
Definition: edit_tool.cpp:3176
VECTOR2I m_cursor
Definition: edit_tool.h:233
bool invokeInlineRouter(int aDragMode)
Definition: edit_tool.cpp:488
void rebuildConnectivity()
Definition: edit_tool.cpp:3531
void setTransitions() override
< Set up handlers for various events.
Definition: edit_tool.cpp:3540
int HealShapes(const TOOL_EVENT &aEvent)
Make ends of selected shapes meet by extending or cutting them, or adding extra geometry.
Definition: edit_tool.cpp:1744
int ChangeTrackWidth(const TOOL_EVENT &aEvent)
Definition: edit_tool.cpp:994
int BooleanPolygons(const TOOL_EVENT &aEvent)
Modify selected polygons into a single polygon using boolean operations such as merge (union) or subt...
Definition: edit_tool.cpp:1823
int copyToClipboardAsText(const TOOL_EVENT &aEvent)
Send the current selection to the clipboard as text.
Definition: edit_tool.cpp:3419
int GetAndPlace(const TOOL_EVENT &aEvent)
Definition: edit_tool.cpp:465
int FilletTracks(const TOOL_EVENT &aEvent)
Fillet (i.e.
Definition: edit_tool.cpp:1130
PCB_SELECTION_TOOL * m_selectionTool
Definition: edit_tool.h:231
int SimplifyPolygons(const TOOL_EVENT &aEvent)
Simplify the outlines of selected polygon objects.
Definition: edit_tool.cpp:1674
int Properties(const TOOL_EVENT &aEvent)
Display properties window for the selected object.
Definition: edit_tool.cpp:1982
static void FootprintFilter(const VECTOR2I &, GENERAL_COLLECTOR &aCollector, PCB_SELECTION_TOOL *sTool)
A selection filter which prunes the selection to contain only items of type #PCB_MODULE_T.
Definition: edit_tool.cpp:3186
int Rotate(const TOOL_EVENT &aEvent)
Rotate currently selected items.
Definition: edit_tool.cpp:2070
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:207
The selection tool: currently supports:
Extension of STATUS_POPUP for displaying a single line text.
Definition: status_popup.h:83
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:168
void Reset() override
void Flip(T &aValue)
#define EDIT_TOOL(tool)