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-2021 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_base.h>
29 #include "pcb_selection_tool.h"
32 
33 class BOARD_COMMIT;
34 class BOARD_ITEM;
35 class PCB_SELECTION_TOOL;
37 
46 {
47 public:
49 
50  void Reset( RESET_REASON aReason ) override;
51 
53  bool Init() override;
54 
58  int PositionRelative( const TOOL_EVENT& aEvent );
59 
64  int SelectPositionRelativeItem( const TOOL_EVENT& aEvent );
65 
69  wxPoint GetSelectionAnchorPosition() const { return m_selectionAnchor; }
70 
75  int RelativeItemSelectionMove( wxPoint anchor, wxPoint translation );
76 
78  void setTransitions() override;
79 
80 private:
82 
86 
87  std::unique_ptr<BOARD_COMMIT> m_commit;
88 
90  wxPoint m_anchor;
91 
92  wxPoint m_translation;
93 };
94 
95 #endif
bool Init() override
Init() is called once upon a registration of the tool.
The interactive edit tool.
std::unique_ptr< BOARD_COMMIT > m_commit
wxPoint GetSelectionAnchorPosition() const
Return the position of the selected item(s)
int PositionRelative(const TOOL_EVENT &aEvent)
Invoke a dialog box to allow positioning of the item relative to another by an exact amount.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:82
DIALOG_POSITION_RELATIVE * m_dialog
int SelectPositionRelativeItem(const TOOL_EVENT &aEvent)
Invoke the picker tool to select the item to which the previous selection will be placed relative to.
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
Generic, UI-independent tool event.
Definition: tool_event.h:173
int RelativeItemSelectionMove(wxPoint anchor, wxPoint translation)
Position the m_position_relative_selection selection relative to anchor position using the given tran...
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
The selection tool: currently supports:
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:149
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
PCB_SELECTION_TOOL * m_selectionTool