blob: 6512d95d03ec4b038bbc96de49c0b983c9fafa37 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 CERN
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef PICKER_TOOL_H
#define PICKER_TOOL_H
#include <tool/tool_interactive.h>
#include <boost/optional/optional.hpp>
#include <boost/function.hpp>
/**
* @brief Generic tool for picking a point.
*/
class PICKER_TOOL : public TOOL_INTERACTIVE
{
public:
PICKER_TOOL();
~PICKER_TOOL() {}
///> Mouse event click handler type.
typedef boost::function<bool(const VECTOR2D&)> CLICK_HANDLER;
///> @copydoc TOOL_INTERACTIVE::Reset()
void Reset( RESET_REASON aReason ) {}
///> Main event loop.
int Main( const TOOL_EVENT& aEvent );
/**
* Function SetSnapping()
* Sets cursor snapping to grid for the period when the tool is active.
*/
inline void SetSnapping( bool aEnable ) { m_cursorSnapping = aEnable; }
/**
* Function SetCursorVisible()
* Sets cursor visibility for the period when the tool is active.
*/
inline void SetCursorVisible( bool aEnable ) { m_cursorVisible = aEnable; }
/**
* Function SetAutoPanning()
* Sets autopanning mode for the period when the tool is active.
*/
inline void SetAutoPanning( bool aEnable ) { m_autoPanning = aEnable; }
/**
* Function SetAutoPanning()
* Toggles cursor capture mode for the period when the tool is active.
*/
inline void SetCursorCapture( bool aEnable ) { m_cursorCapture = aEnable; }
/**
* Function GetPoint()
* Returns picked point.
*/
inline boost::optional<VECTOR2D> GetPoint() const
{
assert( !m_picking );
return m_picked;
}
/**
* Function IsPicking()
* Returns information whether the tool is still active.
*/
bool IsPicking() const { return m_picking; }
/**
* Function SetClickHandler()
* Sets a handler for mouse click event. Handler may decide to receive further click by
* returning true.
*/
inline void SetClickHandler( CLICK_HANDLER aHandler )
{
assert( !m_clickHandler );
m_clickHandler = aHandler;
}
///> @copydoc TOOL_INTERACTIVE::SetTransitions();
void SetTransitions();
private:
// Tool settings.
bool m_cursorSnapping;
bool m_cursorVisible;
bool m_cursorCapture;
bool m_autoPanning;
///> Optional mouse click event handler.
boost::optional<CLICK_HANDLER> m_clickHandler;
///> Picked point (if any).
boost::optional<VECTOR2D> m_picked;
///> Activity status.
bool m_picking;
///> Reinitializes tool to its initial state.
void reset();
///> Applies the requested VIEW_CONTROLS settings.
void setControls();
};
#endif /* PICKER_TOOL_H */
|
