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 
145  static void FootprintFilter( const VECTOR2I&, GENERAL_COLLECTOR& aCollector );
146 
148  void setTransitions() override;
149 
156  int copyToClipboard( const TOOL_EVENT& aEvent );
157 
164  int cutToClipboard( const TOOL_EVENT& aEvent );
165 
167  {
168  return m_commit.get();
169  }
170 
171 private:
174 
177 
181 
184  bool updateModificationPoint( SELECTION& aSelection );
185 
186  int editFootprintInFpEditor( const TOOL_EVENT& aEvent );
187 
188  bool invokeInlineRouter( int aDragMode );
189  bool isInteractiveDragEnabled() const;
190 
192  bool pickCopyReferencePoint( VECTOR2I& aP );
193 
194 
206  bool hoverSelection( bool aSanitize = true );
207 
208 
209  std::unique_ptr<BOARD_COMMIT> m_commit;
210 };
211 
212 #endif
void setTransitions() override
Sets up handlers for various events.
Definition: edit_tool.cpp:1253
VECTOR2I m_cursor
Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point)...
Definition: edit_tool.h:180
int Main(const TOOL_EVENT &aEvent)
Function Main()
Definition: edit_tool.cpp:382
int Properties(const TOOL_EVENT &aEvent)
Function Edit()
Definition: edit_tool.cpp:628
int Rotate(const TOOL_EVENT &aEvent)
Function Rotate()
Definition: edit_tool.cpp:679
int ExchangeFootprints(const TOOL_EVENT &aEvent)
Function ExchangeFootprints()
Definition: edit_tool.cpp:1122
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:209
Class SELECTION_TOOL.
bool updateModificationPoint(SELECTION &aSelection)
Returns the right modification point (e.g.
Definition: edit_tool.cpp:1280
SELECTION_TOOL * m_selectionTool
Selection tool used for obtaining selected items
Definition: edit_tool.h:173
int Mirror(const TOOL_EVENT &aEvent)
Function Mirror.
Definition: edit_tool.cpp:750
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:1390
int Flip(const TOOL_EVENT &aEvent)
Function Flip()
Definition: edit_tool.cpp:821
bool m_dragging
Flag determining if anything is being dragged right now
Definition: edit_tool.h:176
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:278
int Drag(const TOOL_EVENT &aEvent)
Function Drag()
Definition: edit_tool.cpp:370
const SELECTION & selection() const
Definition: pcb_tool.cpp:221
bool isInteractiveDragEnabled() const
Definition: edit_tool.cpp:362
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:269
int MoveExact(const TOOL_EVENT &aEvent)
Function MoveExact()
Definition: edit_tool.cpp:894
int Remove(const TOOL_EVENT &aEvent)
Function Remove()
Definition: edit_tool.cpp:852
bool invokeInlineRouter(int aDragMode)
Definition: edit_tool.cpp:341
bool pickCopyReferencePoint(VECTOR2I &aP)
Definition: edit_tool.cpp:1340
int CreateArray(const TOOL_EVENT &aEvent)
Function CreateArray()
Definition: edit_tool.cpp:1094
bool changeTrackWidthOnClick(const SELECTION &selection)
Definition: edit_tool.cpp:587
int MeasureTool(const TOOL_EVENT &aEvent)
Launches a tool to measure between points
Definition: edit_tool.cpp:1146
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:232
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:1303
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:1358
static void FootprintFilter(const VECTOR2I &, GENERAL_COLLECTOR &aCollector)
Function FootprintFilter()
Definition: edit_tool.cpp:1110
BOARD_COMMIT * GetCurrentCommit() const
Definition: edit_tool.h:166
int Duplicate(const TOOL_EVENT &aEvent)
Function Duplicate()
Definition: edit_tool.cpp:946
bool hoverSelection(bool aSanitize=true)
Function hoverSelection()