KiCad PCB EDA Suite
position_relative_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) 2017 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 __POSITION_RELATIVE_TOOL_H
25 #define __POSITION_RELATIVE_TOOL_H
26 
27 #include <math/vector2d.h>
28 #include <tools/pcb_tool.h>
29 #include "selection_tool.h"
32 
33 class BOARD_COMMIT;
34 class BOARD_ITEM;
35 class SELECTION_TOOL;
37 
46 {
47 public:
49 
50  void Reset( RESET_REASON aReason ) override;
51 
53  bool Init() override;
54 
60  int PositionRelative( const TOOL_EVENT& aEvent );
61 
68  int SelectPositionRelativeItem( const TOOL_EVENT& aEvent );
69 
76  int RelativeItemSelectionMove( wxPoint anchor, wxPoint translation );
77 
79  void setTransitions() override;
80 
81 private:
83 
87 
88  std::unique_ptr<BOARD_COMMIT> m_commit;
89 
92 
94 };
95 
96 #endif
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
Class POSITION_RELATIVE_TOOL.
std::unique_ptr< BOARD_COMMIT > m_commit
int PositionRelative(const TOOL_EVENT &aEvent)
Function PositionRelative()
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Class SELECTION_TOOL.
DIALOG_POSITION_RELATIVE * m_dialog
SELECTION_TOOL * m_selectionTool
Selection tool used for obtaining selected items
int SelectPositionRelativeItem(const TOOL_EVENT &aEvent)
Function SelectPositionRelativeItem()
void setTransitions() override
Sets up handlers for various events.
Class TOOL_EVENT.
Definition: tool_event.h:168
int RelativeItemSelectionMove(wxPoint anchor, wxPoint translation)
Function RelativeItemSelectionMove()
void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:80