KiCad PCB EDA Suite
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-2015 CERN
5  * @author Maciej Suminski <maciej.suminski@cern.ch>
6  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #ifndef __EDIT_TOOL_H
27 #define __EDIT_TOOL_H
28 
29 #include <math/vector2d.h>
30 #include <tools/pcb_tool.h>
31 #include <tools/selection_tool.h>
32 
33 
34 class BOARD_COMMIT;
35 class BOARD_ITEM;
36 class CONNECTIVITY_DATA;
37 
45 #define EXCLUDE_LOCKED 0x0001
46 #define EXCLUDE_LOCKED_PADS 0x0002
47 #define EXCLUDE_TRANSIENTS 0x0004
48 
49 void EditToolSelectionFilter( GENERAL_COLLECTOR& aCollector, int aFlags );
50 
51 
59 class EDIT_TOOL : public PCB_TOOL
60 {
61 public:
62  EDIT_TOOL();
63 
65  void Reset( RESET_REASON aReason ) override;
66 
68  bool Init() override;
69 
76  int Main( const TOOL_EVENT& aEvent );
77 
83  int Drag( const TOOL_EVENT& aEvent );
84 
90  int Properties( const TOOL_EVENT& aEvent );
91 
97  int Rotate( const TOOL_EVENT& aEvent );
98 
104  int Flip( const TOOL_EVENT& aEvent );
105 
111  int Mirror( const TOOL_EVENT& aEvent );
112 
118  int Remove( const TOOL_EVENT& aEvent );
119 
125  int Duplicate( const TOOL_EVENT& aEvent );
126 
132  int MoveExact( const TOOL_EVENT& aEvent );
133 
140  int CreateArray( const TOOL_EVENT& aEvent );
141 
148  int ExchangeFootprints( const TOOL_EVENT& aEvent );
149 
151  int MeasureTool( const TOOL_EVENT& aEvent );
152 
159  static void FootprintFilter( const VECTOR2I&, GENERAL_COLLECTOR& aCollector );
160 
162  void setTransitions() override;
163 
170  int copyToClipboard( const TOOL_EVENT& aEvent );
171 
172  int copyToClipboardWithAnchor( const TOOL_EVENT& aEvent );
173 
174  int doCopyToClipboard( bool withAnchor );
175 
182  int cutToClipboard( const TOOL_EVENT& aEvent );
183 
185  {
186  return m_commit.get();
187  }
188 
189 private:
192 
195 
199 
202  bool updateModificationPoint( SELECTION& aSelection );
203 
204  int editFootprintInFpEditor( const TOOL_EVENT& aEvent );
205 
206  bool invokeInlineRouter( int aDragMode );
207  bool isInteractiveDragEnabled() const;
208 
210  bool pickCopyReferencePoint( VECTOR2I& aP );
211 
212  std::unique_ptr<BOARD_COMMIT> m_commit;
213 };
214 
215 #endif
void setTransitions() override
Sets up handlers for various events.
Definition: edit_tool.cpp:1299
VECTOR2I m_cursor
Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point)...
Definition: edit_tool.h:198
int Main(const TOOL_EVENT &aEvent)
Function Main()
Definition: edit_tool.cpp:336
int Properties(const TOOL_EVENT &aEvent)
Function Edit()
Definition: edit_tool.cpp:621
int Rotate(const TOOL_EVENT &aEvent)
Function Rotate()
Definition: edit_tool.cpp:663
int ExchangeFootprints(const TOOL_EVENT &aEvent)
Function ExchangeFootprints()
Definition: edit_tool.cpp:1179
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: edit_tool.h:212
int doCopyToClipboard(bool withAnchor)
Definition: edit_tool.cpp:1425
Class SELECTION_TOOL.
bool updateModificationPoint(SELECTION &aSelection)
Returns the right modification point (e.g.
Definition: edit_tool.cpp:1326
SELECTION_TOOL * m_selectionTool
Selection tool used for obtaining selected items
Definition: edit_tool.h:191
int Mirror(const TOOL_EVENT &aEvent)
Function Mirror.
Definition: edit_tool.cpp:741
int cutToClipboard(const TOOL_EVENT &aEvent)
Function cutToClipboard() Cuts the current selection to the clipboard by formatting it as a fake pcb ...
Definition: edit_tool.cpp:1469
int Flip(const TOOL_EVENT &aEvent)
Function Flip()
Definition: edit_tool.cpp:820
bool m_dragging
Flag determining if anything is being dragged right now
Definition: edit_tool.h:194
void EditToolSelectionFilter(GENERAL_COLLECTOR &aCollector, int aFlags)
Definition: edit_tool.cpp:173
Class TOOL_EVENT.
Definition: tool_event.h:168
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
Definition: edit_tool.cpp:230
int Drag(const TOOL_EVENT &aEvent)
Function Drag()
Definition: edit_tool.cpp:324
const SELECTION & selection() const
Definition: pcb_tool.cpp:245
bool isInteractiveDragEnabled() const
Definition: edit_tool.cpp:316
Class EDIT_TOOL.
Definition: edit_tool.h:59
void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
Definition: edit_tool.cpp:221
int MoveExact(const TOOL_EVENT &aEvent)
Function MoveExact()
Definition: edit_tool.cpp:926
int Remove(const TOOL_EVENT &aEvent)
Function Remove()
Definition: edit_tool.cpp:858
bool invokeInlineRouter(int aDragMode)
Definition: edit_tool.cpp:295
bool pickCopyReferencePoint(VECTOR2I &aP)
Definition: edit_tool.cpp:1386
int CreateArray(const TOOL_EVENT &aEvent)
Function CreateArray()
Definition: edit_tool.cpp:1149
bool changeTrackWidthOnClick(const SELECTION &selection)
Definition: edit_tool.cpp:580
int MeasureTool(const TOOL_EVENT &aEvent)
Launches a tool to measure between points
Definition: edit_tool.cpp:1203
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:245
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:80
int editFootprintInFpEditor(const TOOL_EVENT &aEvent)
Definition: edit_tool.cpp:1349
int copyToClipboard(const TOOL_EVENT &aEvent)
Function copyToClipboard() Sends the current selection to the clipboard by formatting it as a fake pc...
Definition: edit_tool.cpp:1457
int copyToClipboardWithAnchor(const TOOL_EVENT &aEvent)
Definition: edit_tool.cpp:1463
static void FootprintFilter(const VECTOR2I &, GENERAL_COLLECTOR &aCollector)
Function FootprintFilter()
Definition: edit_tool.cpp:1167
BOARD_COMMIT * GetCurrentCommit() const
Definition: edit_tool.h:184
int Duplicate(const TOOL_EVENT &aEvent)
Function Duplicate()
Definition: edit_tool.cpp:999