KiCad PCB EDA Suite
pcb_picker_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) 2015 CERN
5  * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * @author Maciej Suminski <[email protected]>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #ifndef PCB_PICKER_TOOL_H
28 #define PCB_PICKER_TOOL_H
29 
30 #include <layer_ids.h>
31 #include <tool/picker_tool.h>
32 #include <tools/pcb_tool_base.h>
33 
38 {
39 public:
41  virtual ~PCB_PICKER_TOOL() = default;
42 
44  int Main( const TOOL_EVENT& aEvent );
45 
49  inline void SetLayerSet( LSET aLayerSet ) { m_layerMask = aLayerSet; }
50 
51 protected:
53  void setTransitions() override;
54 
56  void setControls();
57 
59  void reset() override;
60 
61 private:
64 };
65 
66 #endif /* PCB_PICKER_TOOL_H */
int Main(const TOOL_EVENT &aEvent)
void setTransitions() override
<
void SetLayerSet(LSET aLayerSet)
Set the tool's snap layer set.
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:504
Generic, UI-independent tool event.
Definition: tool_event.h:152
void setControls()
Reinitialize tool to its initial state.
virtual ~PCB_PICKER_TOOL()=default
Main event loop.
void reset() override
< Reinitializes tool to its initial state.
Generic tool for picking an item.
LSET m_layerMask
< The layer set to use for optional snapping.