KiCad PCB EDA Suite
Loading...
Searching...
No Matches
picker_tool.cpp
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 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#include <tool/actions.h>
26#include <tool/picker_tool.h>
27#include <view/view_controls.h>
28#include <eda_draw_frame.h>
29#include <wx/debug.h>
30
31
33{
34 m_cursor = KICURSOR::ARROW;
35 m_snap = true;
36
37 m_picked = std::nullopt;
38 m_clickHandler = std::nullopt;
39 m_motionHandler = std::nullopt;
40 m_cancelHandler = std::nullopt;
41 m_finalizeHandler = std::nullopt;
42}
43
44
45PICKER_TOOL::PICKER_TOOL( const std::string& aName ) :
46 TOOL_INTERACTIVE( aName ),
48{
49}
50
51
53 TOOL_INTERACTIVE( "common.InteractivePicker" ),
55{
56}
57
58
60{
61 m_frame = getEditFrame<EDA_DRAW_FRAME>();
62
63 auto& ctxMenu = m_menu.GetMenu();
64
65 // cancel current tool goes in main context menu at the top if present
67 ctxMenu.AddSeparator( 1 );
68
69 // Finally, add the standard zoom/grid items
71
72 return true;
73}
74
75
76int PICKER_TOOL::Main( const TOOL_EVENT& aEvent )
77{
79 int finalize_state = WAIT_CANCEL;
80
81 wxCHECK_MSG( aEvent.Parameter<const TOOL_EVENT*>(), -1,
82 wxT( "PICKER_TOOL::Main() called without a source event" ) );
83
84 const TOOL_EVENT sourceEvent = *aEvent.Parameter<const TOOL_EVENT*>();
85
86 m_frame->PushTool( sourceEvent );
87 Activate();
88
90
91 auto setCursor =
92 [&]()
93 {
95 };
96
97 // Set initial cursor
98 setCursor();
99
100 while( TOOL_EVENT* evt = Wait() )
101 {
102 setCursor();
103 VECTOR2D cursorPos = controls->GetCursorPosition( m_snap && m_frame->IsGridVisible() );
104
105 if( evt->IsCancelInteractive() || evt->IsActivate() )
106 {
107 if( m_cancelHandler )
108 {
109 try
110 {
111 (*m_cancelHandler)();
112 }
113 catch( std::exception& )
114 {
115 }
116 }
117
118 // Activating a new tool may have alternate finalization from canceling the current
119 // tool
120 if( evt->IsActivate() )
121 {
122 finalize_state = END_ACTIVATE;
123 }
124 else
125 {
126 evt->SetPassEvent( false );
127 finalize_state = EVT_CANCEL;
128 }
129
130 break;
131 }
132
133 else if( evt->IsClick( BUT_LEFT ) )
134 {
135 bool getNext = false;
136
137 m_picked = cursorPos;
138
139 if( m_clickHandler )
140 {
141 try
142 {
143 getNext = (*m_clickHandler)( *m_picked );
144 }
145 catch( std::exception& )
146 {
147 finalize_state = EXCEPTION_CANCEL;
148 break;
149 }
150 }
151
152 if( !getNext )
153 {
154 finalize_state = CLICK_CANCEL;
155 break;
156 }
157 else
158 setControls();
159 }
160
161 else if( evt->IsMotion() )
162 {
163 if( m_motionHandler )
164 {
165 try
166 {
167 (*m_motionHandler)( cursorPos );
168 }
169 catch( std::exception& )
170 {
171 }
172 }
173 }
174
175 else if( evt->IsDblClick( BUT_LEFT ) || evt->IsDrag( BUT_LEFT ) )
176 {
177 // Not currently used, but we don't want to pass them either
178 }
179
180 else if( evt->IsClick( BUT_RIGHT ) )
181 {
183 }
184
185 else
186 evt->SetPassEvent();
187 }
188
190 {
191 try
192 {
193 (*m_finalizeHandler)( finalize_state );
194 }
195 catch( std::exception& )
196 {
197 }
198 }
199
200 reset();
201 controls->ForceCursorPosition( false );
202 m_frame->PopTool( sourceEvent );
203 return 0;
204}
205
206
208{
210}
211
212
214{
216
217 controls->CaptureCursor( false );
218 controls->SetAutoPan( false );
219}
static TOOL_ACTION cancelInteractive
Definition: actions.h:64
static TOOL_ACTION pickerTool
Definition: actions.h:193
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Add a menu entry to run a TOOL_ACTION on selected items.
void AddStandardSubMenus(TOOL_MENU &aMenu)
Construct a "basic" menu for a tool, containing only items that apply to all tools (e....
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
bool IsGridVisible() const
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
An interface for classes handling user events controlling the view behavior such as zooming,...
virtual void CaptureCursor(bool aEnabled)
Force the cursor to stay within the drawing panel area.
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Place the cursor immediately at a given point.
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.
virtual void SetAutoPan(bool aEnabled)
Turn on/off auto panning (this feature is used when there is a tool active (eg.
std::optional< VECTOR2D > m_picked
Definition: picker_tool.h:122
std::optional< FINALIZE_HANDLER > m_finalizeHandler
Definition: picker_tool.h:120
EDA_DRAW_FRAME * m_frame
Definition: picker_tool.h:113
std::optional< MOTION_HANDLER > m_motionHandler
Definition: picker_tool.h:118
std::optional< CLICK_HANDLER > m_clickHandler
Definition: picker_tool.h:117
std::optional< CANCEL_HANDLER > m_cancelHandler
Definition: picker_tool.h:119
KICURSOR m_cursor
Definition: picker_tool.h:114
virtual void reset()
< Reinitializes tool to its initial state.
Definition: picker_tool.cpp:32
void setControls()
< Applies the requested VIEW_CONTROLS settings.
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.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
virtual void PopTool(const TOOL_EVENT &aEvent)
Pops a tool from the stack.
virtual void PushTool(const TOOL_EVENT &aEvent)
NB: the definition of "tool" is different at the user level.
KIGFX::VIEW_CONTROLS * getViewControls() const
Return the instance of VIEW_CONTROLS object used in the application.
Definition: tool_base.cpp:42
Generic, UI-independent tool event.
Definition: tool_event.h:167
T Parameter() const
Return a parameter assigned to the event.
Definition: tool_event.h:460
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Define which state (aStateFunc) to go when a certain event arrives (aConditions).
TOOL_MENU m_menu
The functions below are not yet implemented - their interface may change.
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Suspend execution of the tool until an event specified in aEventList arrives.
void Activate()
Run the tool.
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:44
void ShowContextMenu(SELECTION &aSelection)
Helper function to set and immediately show a CONDITIONAL_MENU in concert with the given SELECTION.
Definition: tool_menu.cpp:57
@ BUT_LEFT
Definition: tool_event.h:131
@ BUT_RIGHT
Definition: tool_event.h:132