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 
32 
33 class BOARD_COMMIT;
34 class BOARD_ITEM;
35 class SELECTION_TOOL;
36 class CONNECTIVITY_DATA;
37 
45 class EDIT_TOOL : public PCB_TOOL
46 {
47 public:
48  EDIT_TOOL();
49 
51  void Reset( RESET_REASON aReason ) override;
52 
54  bool Init() override;
55 
62  int Main( const TOOL_EVENT& aEvent );
63 
69  int Drag( const TOOL_EVENT& aEvent );
70 
76  int Properties( const TOOL_EVENT& aEvent );
77 
83  int Rotate( const TOOL_EVENT& aEvent );
84 
90  int Flip( const TOOL_EVENT& aEvent );
91 
97  int Mirror( const TOOL_EVENT& aEvent );
98 
104  int Remove( const TOOL_EVENT& aEvent );
105 
111  int Duplicate( const TOOL_EVENT& aEvent );
112 
118  int MoveExact( const TOOL_EVENT& aEvent );
119 
126  int CreateArray( const TOOL_EVENT& aEvent );
127 
134  int ExchangeFootprints( const TOOL_EVENT& aEvent );
135 
137  int MeasureTool( const TOOL_EVENT& aEvent );
138 
140  void setTransitions() override;
141 
148  int copyToClipboard( const TOOL_EVENT& aEvent );
149 
156  int cutToClipboard( const TOOL_EVENT& aEvent );
157 
159  {
160  return m_commit.get();
161  }
162 
163 private:
166 
169 
173 
176  bool updateModificationPoint( SELECTION& aSelection );
177 
178  int editFootprintInFpEditor( const TOOL_EVENT& aEvent );
179 
180  bool invokeInlineRouter( int aDragMode );
181  bool isInteractiveDragEnabled() const;
182 
184  bool pickCopyReferencePoint( VECTOR2I& aP );
185 
186 
198  bool hoverSelection( bool aSanitize = true );
199 
209  template<class T> T* uniqueSelected();
210 
222  template<class T>
223  T* uniqueHoverSelection( bool aSanitize = true )
224  {
225  if( !hoverSelection( aSanitize ) )
226  return nullptr;
227 
228  T* item = uniqueSelected<T>();
229 
230  return item;
231  }
232 
233  std::unique_ptr<BOARD_COMMIT> m_commit;
234 };
235 
236 #endif
void setTransitions() override
Sets up handlers for various events.
Definition: edit_tool.cpp:1213
VECTOR2I m_cursor
Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point)...
Definition: edit_tool.h:172
int Main(const TOOL_EVENT &aEvent)
Function Main()
Definition: edit_tool.cpp:369
int Properties(const TOOL_EVENT &aEvent)
Function Edit()
Definition: edit_tool.cpp:611
int Rotate(const TOOL_EVENT &aEvent)
Function Rotate()
Definition: edit_tool.cpp:662
int ExchangeFootprints(const TOOL_EVENT &aEvent)
Function ExchangeFootprints()
Definition: edit_tool.cpp:1088
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:233
T
enum T contains all this lexer's tokens.
Class SELECTION_TOOL.
bool updateModificationPoint(SELECTION &aSelection)
Returns the right modification point (e.g.
Definition: edit_tool.cpp:1239
T * uniqueHoverSelection(bool aSanitize=true)
Function uniqueHoverSelection()
Definition: edit_tool.h:223
SELECTION_TOOL * m_selectionTool
Selection tool used for obtaining selected items
Definition: edit_tool.h:165
int Mirror(const TOOL_EVENT &aEvent)
Function Mirror.
Definition: edit_tool.cpp:733
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:1351
int Flip(const TOOL_EVENT &aEvent)
Function Flip()
Definition: edit_tool.cpp:804
bool m_dragging
Flag determining if anything is being dragged right now
Definition: edit_tool.h:168
T * uniqueSelected()
Function uniqueSelected()
Definition: edit_tool.cpp:1360
Class TOOL_EVENT.
Definition: tool_event.h:162
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
Definition: edit_tool.cpp:267
int Drag(const TOOL_EVENT &aEvent)
Function Drag()
Definition: edit_tool.cpp:357
const SELECTION & selection() const
Definition: pcb_tool.cpp:218
bool isInteractiveDragEnabled() const
Definition: edit_tool.cpp:349
Class EDIT_TOOL.
Definition: edit_tool.h:45
void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
Definition: edit_tool.cpp:258
int MoveExact(const TOOL_EVENT &aEvent)
Function MoveExact()
Definition: edit_tool.cpp:873
int Remove(const TOOL_EVENT &aEvent)
Function Remove()
Definition: edit_tool.cpp:835
bool invokeInlineRouter(int aDragMode)
Definition: edit_tool.cpp:325
bool pickCopyReferencePoint(VECTOR2I &aP)
Definition: edit_tool.cpp:1301
int CreateArray(const TOOL_EVENT &aEvent)
Function CreateArray()
Definition: edit_tool.cpp:1072
bool changeTrackWidthOnClick(const SELECTION &selection)
Definition: edit_tool.cpp:570
int MeasureTool(const TOOL_EVENT &aEvent)
Launches a tool to measure between points
Definition: edit_tool.cpp:1120
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:1264
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:1319
BOARD_COMMIT * GetCurrentCommit() const
Definition: edit_tool.h:158
int Duplicate(const TOOL_EVENT &aEvent)
Function Duplicate()
Definition: edit_tool.cpp:925
bool hoverSelection(bool aSanitize=true)
Function hoverSelection()