KiCad PCB EDA Suite
lib_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 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef KICAD_LIB_MOVE_TOOL_H
25 #define KICAD_LIB_MOVE_TOOL_H
26 
27 #include <tools/ee_tool_base.h>
28 #include <lib_edit_frame.h>
29 
30 class LIB_EDIT_FRAME;
31 class EE_SELECTION_TOOL;
32 
33 
34 class LIB_MOVE_TOOL : public EE_TOOL_BASE<LIB_EDIT_FRAME>
35 {
36 public:
37  LIB_MOVE_TOOL();
38  ~LIB_MOVE_TOOL() override { }
39 
41  bool Init() override;
42 
44  void Reset( RESET_REASON aReason ) override;
45 
51  int Main( const TOOL_EVENT& aEvent );
52 
53 private:
54  void moveItem( EDA_ITEM* aItem, VECTOR2I aDelta );
55 
58  bool updateModificationPoint( EE_SELECTION& aSelection );
59 
61  void setTransitions() override;
62 
63 private:
66 
69 
73 };
74 
75 #endif //KICAD_LIB_MOVE_TOOL_H
VECTOR2I m_cursor
Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point).
Definition: lib_move_tool.h:72
bool m_moveInProgress
Flag determining if anything is being dragged right now
Definition: lib_move_tool.h:65
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
int Main(const TOOL_EVENT &aEvent)
Function Main()
void setTransitions() override
Sets up handlers for various events.
bool updateModificationPoint(EE_SELECTION &aSelection)
Returns the right modification point (e.g.
void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
Class TOOL_EVENT.
Definition: tool_event.h:168
~LIB_MOVE_TOOL() override
Definition: lib_move_tool.h:38
void moveItem(EDA_ITEM *aItem, VECTOR2I aDelta)
The symbol library editor main window.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:150
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:79
Class EE_TOOL_BASE.
Definition: ee_tool_base.h:49
VECTOR2I m_moveOffset
Used for chaining commands
Definition: lib_move_tool.h:68