KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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) 2019 CERN
5 * Copyright (C) 2019-2020 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef PICKER_TOOL_H
26#define PICKER_TOOL_H
27
28#include <optional>
29#include <gal/cursors.h>
30#include <math/vector2d.h>
32
33class EDA_DRAW_FRAME;
34
35
37{
38public:
40 typedef std::function<bool(const VECTOR2D&)> CLICK_HANDLER;
41 typedef std::function<void(const VECTOR2D&)> MOTION_HANDLER;
42 typedef std::function<void(void)> CANCEL_HANDLER;
43 typedef std::function<void(const int&)> FINALIZE_HANDLER;
44
46 {
52 };
53
55 m_frame( nullptr ),
56 m_snap( false ),
57 m_modifiers( 0 )
58 {
59 reset();
60 }
61
62 virtual ~PICKER_TOOL_BASE() = default;
63
64 inline void SetCursor( KICURSOR aCursor ) { m_cursor = aCursor; }
65
66 inline void SetSnapping( bool aSnap ) { m_snap = aSnap; }
67
73 inline void SetClickHandler( CLICK_HANDLER aHandler )
74 {
75 wxASSERT( !m_clickHandler );
76 m_clickHandler = aHandler;
77 }
78
84 inline void SetMotionHandler( MOTION_HANDLER aHandler )
85 {
86 wxASSERT( !m_motionHandler );
87 m_motionHandler = aHandler;
88 }
89
93 inline void SetCancelHandler( CANCEL_HANDLER aHandler )
94 {
95 wxASSERT( !m_cancelHandler );
96 m_cancelHandler = aHandler;
97 }
98
104 inline void SetFinalizeHandler( FINALIZE_HANDLER aHandler )
105 {
106 wxASSERT( !m_finalizeHandler );
107 m_finalizeHandler = aHandler;
108 }
109
110 int CurrentModifiers() const { return m_modifiers; }
111
112protected:
114 virtual void reset();
115
118 bool m_snap;
120
121 std::optional<CLICK_HANDLER> m_clickHandler;
122 std::optional<MOTION_HANDLER> m_motionHandler;
123 std::optional<CANCEL_HANDLER> m_cancelHandler;
124 std::optional<FINALIZE_HANDLER> m_finalizeHandler;
125
126 std::optional<VECTOR2D> m_picked;
127};
128
129
131{
132public:
133 PICKER_TOOL();
134
135 PICKER_TOOL( const std::string& aName );
136
137 virtual ~PICKER_TOOL() = default;
138
140 bool Init() override;
141
143 void Reset( RESET_REASON aReason ) override { }
144
146 int Main( const TOOL_EVENT& aEvent );
147
148protected:
150 void setControls();
151
153 void setTransitions() override;
154};
155
156#endif /* PICKER_TOOL_H */
The base class for create windows for drawing purpose.
void SetMotionHandler(MOTION_HANDLER aHandler)
Set a handler for mouse motion.
Definition: picker_tool.h:84
void SetClickHandler(CLICK_HANDLER aHandler)
Set a handler for mouse click event.
Definition: picker_tool.h:73
void SetSnapping(bool aSnap)
Definition: picker_tool.h:66
virtual ~PICKER_TOOL_BASE()=default
int CurrentModifiers() const
Definition: picker_tool.h:110
std::optional< VECTOR2D > m_picked
Definition: picker_tool.h:126
std::function< void(void)> CANCEL_HANDLER
Definition: picker_tool.h:42
std::optional< FINALIZE_HANDLER > m_finalizeHandler
Definition: picker_tool.h:124
void SetCursor(KICURSOR aCursor)
Definition: picker_tool.h:64
EDA_DRAW_FRAME * m_frame
Definition: picker_tool.h:116
std::function< bool(const VECTOR2D &)> CLICK_HANDLER
< Event handler types.
Definition: picker_tool.h:40
std::optional< MOTION_HANDLER > m_motionHandler
Definition: picker_tool.h:122
std::optional< CLICK_HANDLER > m_clickHandler
Definition: picker_tool.h:121
void SetCancelHandler(CANCEL_HANDLER aHandler)
Set a handler for cancel events (ESC or context-menu Cancel).
Definition: picker_tool.h:93
void SetFinalizeHandler(FINALIZE_HANDLER aHandler)
Set a handler for the finalize event.
Definition: picker_tool.h:104
std::optional< CANCEL_HANDLER > m_cancelHandler
Definition: picker_tool.h:123
std::function< void(const VECTOR2D &)> MOTION_HANDLER
Definition: picker_tool.h:41
KICURSOR m_cursor
Definition: picker_tool.h:117
virtual void reset()
< Reinitializes tool to its initial state.
Definition: picker_tool.cpp:32
std::function< void(const int &)> FINALIZE_HANDLER
Definition: picker_tool.h:43
void setControls()
< Applies the requested VIEW_CONTROLS settings.
virtual ~PICKER_TOOL()=default
bool Init() override
Init() is called once upon a registration of the tool.
Definition: picker_tool.cpp:59
int Main(const TOOL_EVENT &aEvent)
Definition: picker_tool.cpp:76
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
Definition: picker_tool.h:143
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:167
KICURSOR
Definition: cursors.h:34