KiCad PCB EDA Suite
TOOL_DISPATCHER Class Reference

Class TOOL_DISPATCHER. More...

#include <tool_dispatcher.h>

Inheritance diagram for TOOL_DISPATCHER:

Classes

struct  BUTTON_STATE
 

Stores information about a mouse button state

More...
 

Public Member Functions

 TOOL_DISPATCHER (TOOL_MANAGER *aToolMgr, ACTIONS *aActions)
 Constructor. More...
 
virtual ~TOOL_DISPATCHER ()
 
virtual void ResetState ()
 Function ResetState() Brings the dispatcher to its initial state. More...
 
virtual void DispatchWxEvent (wxEvent &aEvent)
 Function DispatchWxEvent() Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs, and makes tools handle those. More...
 
virtual void DispatchWxCommand (wxCommandEvent &aEvent)
 Function DispatchWxCommand() Processes wxCommands (mostly menu related events) and runs appropriate actions (eg. More...
 

Private Member Functions

bool handleMouseButton (wxEvent &aEvent, int aIndex, bool aMotion)
 

Handles mouse related events (click, motion, dragging).

More...
 
void updateUI ()
 

Redraws the status bar and message panel.

More...
 
KIGFX::VIEWgetView ()
 

Returns the instance of VIEW, used by the application.

More...
 

Static Private Member Functions

static int decodeModifiers (const wxKeyboardState *aState)
 

Saves the state of key modifiers (Alt, Ctrl and so on).

More...
 

Private Attributes

VECTOR2D m_lastMousePos
 

The last mouse cursor position (in world coordinates).

More...
 
std::vector< BUTTON_STATE * > m_buttons
 

State of mouse buttons.

More...
 
TOOL_MANAGERm_toolMgr
 

Instance of tool manager that cooperates with the dispatcher.

More...
 
ACTIONSm_actions
 

Instance of an actions list that handles legacy action translation

More...
 

Static Private Attributes

static const int MouseButtonCount = 3
 

Number of mouse buttons that is handled in events.

More...
 
static const int DragTimeThreshold = 300
 

The time threshold for a mouse button press that distinguishes between a single mouse click and a beginning of drag event (expressed in milliseconds).

More...
 
static const int DragDistanceThreshold = 8
 

The distance threshold for mouse cursor that disinguishes between a single mouse click and a beginning of drag event (expressed in screen pixels).

More...
 

Detailed Description

Class TOOL_DISPATCHER.

  • takes wx events,
  • fixes all wx quirks (mouse warping, panning, ordering problems, etc)
  • translates coordinates to world space
  • low-level input conditioning (drag/click threshold), updating mouse position during view auto-scroll/pan.
  • issues TOOL_EVENTS to the tool manager

Definition at line 51 of file tool_dispatcher.h.

Constructor & Destructor Documentation

TOOL_DISPATCHER::TOOL_DISPATCHER ( TOOL_MANAGER aToolMgr,
ACTIONS aActions 
)

Constructor.

Parameters
aToolMgrtool manager instance the events will be sent to
aActionsACTIONS subclass instance for ACTIONS::TranslateLegacyId()

Definition at line 117 of file tool_dispatcher.cpp.

References BUT_LEFT, BUT_MIDDLE, BUT_RIGHT, m_buttons, and ResetState().

117  :
118  m_toolMgr( aToolMgr ),
119  m_actions( aActions )
120 {
121  m_buttons.push_back( new BUTTON_STATE( BUT_LEFT, wxEVT_LEFT_DOWN,
122  wxEVT_LEFT_UP, wxEVT_LEFT_DCLICK ) );
123  m_buttons.push_back( new BUTTON_STATE( BUT_RIGHT, wxEVT_RIGHT_DOWN,
124  wxEVT_RIGHT_UP, wxEVT_RIGHT_DCLICK ) );
125  m_buttons.push_back( new BUTTON_STATE( BUT_MIDDLE, wxEVT_MIDDLE_DOWN,
126  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DCLICK ) );
127 
128  ResetState();
129 }
ACTIONS * m_actions
Instance of an actions list that handles legacy action translation
virtual void ResetState()
Function ResetState() Brings the dispatcher to its initial state.
std::vector< BUTTON_STATE * > m_buttons
State of mouse buttons.
TOOL_MANAGER * m_toolMgr
Instance of tool manager that cooperates with the dispatcher.
TOOL_DISPATCHER::~TOOL_DISPATCHER ( )
virtual

Definition at line 132 of file tool_dispatcher.cpp.

References m_buttons.

133 {
134  for( BUTTON_STATE* st : m_buttons )
135  delete st;
136 }
std::vector< BUTTON_STATE * > m_buttons
State of mouse buttons.

Member Function Documentation

static int TOOL_DISPATCHER::decodeModifiers ( const wxKeyboardState *  aState)
inlinestaticprivate

Saves the state of key modifiers (Alt, Ctrl and so on).

Definition at line 102 of file tool_dispatcher.h.

References MD_ALT, MD_CTRL, and MD_SHIFT.

Referenced by DispatchWxEvent(), and handleMouseButton().

103  {
104  int mods = 0;
105 
106  if( aState->ControlDown() )
107  mods |= MD_CTRL;
108 
109  if( aState->AltDown() )
110  mods |= MD_ALT;
111 
112  if( aState->ShiftDown() )
113  mods |= MD_SHIFT;
114 
115  return mods;
116  }
void TOOL_DISPATCHER::DispatchWxCommand ( wxCommandEvent &  aEvent)
virtual

Function DispatchWxCommand() Processes wxCommands (mostly menu related events) and runs appropriate actions (eg.

run the specified tool).

Parameters
aEventis the wxCommandEvent to be processed.

Definition at line 345 of file tool_dispatcher.cpp.

References m_actions, m_toolMgr, TOOL_MANAGER::ProcessEvent(), ACTIONS::TranslateLegacyId(), and updateUI().

Referenced by EDA_DRAW_PANEL_GAL::SetEventDispatcher().

346 {
348 
349  if( evt )
350  m_toolMgr->ProcessEvent( *evt );
351  else
352  aEvent.Skip();
353 
354  updateUI();
355 }
ACTIONS * m_actions
Instance of an actions list that handles legacy action translation
virtual boost::optional< TOOL_EVENT > TranslateLegacyId(int aId)=0
Function TranslateLegacyId() Translates legacy tool ids to the corresponding TOOL_ACTION name...
void updateUI()
Redraws the status bar and message panel.
void ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
TOOL_MANAGER * m_toolMgr
Instance of tool manager that cooperates with the dispatcher.
void TOOL_DISPATCHER::DispatchWxEvent ( wxEvent &  aEvent)
virtual

Function DispatchWxEvent() Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs, and makes tools handle those.

Parameters
aEventis the wxWidgets event to be processed.

Definition at line 247 of file tool_dispatcher.cpp.

References decodeModifiers(), KIGFX::WX_VIEW_CONTROLS::EVT_REFRESH_MOUSE, TOOL_MANAGER::GetEditFrame(), KIGFX::VIEW_CONTROLS::GetMousePosition(), TOOL_MANAGER::GetViewControls(), handleMouseButton(), m_buttons, m_lastMousePos, m_toolMgr, MD_CTRL, TOOL_MANAGER::ProcessEvent(), TA_CANCEL_TOOL, TA_KEY_PRESSED, TA_MOUSE_MOTION, TC_COMMAND, TC_KEYBOARD, TC_MOUSE, and updateUI().

Referenced by EDA_DRAW_PANEL_GAL::onEvent().

248 {
249  bool motion = false, buttonEvents = false;
251 
252  int type = aEvent.GetEventType();
253 
254  // Mouse handling
255  if( type == wxEVT_MOTION || type == wxEVT_MOUSEWHEEL ||
256 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
257  type == wxEVT_MAGNIFY ||
258 #endif
259  type == wxEVT_LEFT_DOWN || type == wxEVT_LEFT_UP ||
260  type == wxEVT_MIDDLE_DOWN || type == wxEVT_MIDDLE_UP ||
261  type == wxEVT_RIGHT_DOWN || type == wxEVT_RIGHT_UP ||
262  type == wxEVT_LEFT_DCLICK || type == wxEVT_MIDDLE_DCLICK || type == wxEVT_RIGHT_DCLICK ||
263  // Event issued whem mouse retains position in screen coordinates,
264  // but changes in world coordinates (e.g. autopanning)
266  {
267  wxMouseEvent* me = static_cast<wxMouseEvent*>( &aEvent );
268  int mods = decodeModifiers( me );
269 
271 
272  if( pos != m_lastMousePos )
273  {
274  motion = true;
275  m_lastMousePos = pos;
276  }
277 
278  for( unsigned int i = 0; i < m_buttons.size(); i++ )
279  buttonEvents |= handleMouseButton( aEvent, i, motion );
280 
281  if( !buttonEvents && motion )
282  {
283  evt = TOOL_EVENT( TC_MOUSE, TA_MOUSE_MOTION, mods );
284  evt->SetMousePosition( pos );
285  }
286 
287 #ifdef __APPLE__
288  // TODO That's a big ugly workaround, somehow DRAWPANEL_GAL loses focus
289  // after second LMB click and currently I have no means to do better debugging
290  if( type == wxEVT_LEFT_UP )
291  static_cast<PCB_BASE_FRAME*>( m_toolMgr->GetEditFrame() )->GetGalCanvas()->SetFocus();
292 #endif /* __APPLE__ */
293  }
294 
295  // Keyboard handling
296  else if( type == wxEVT_CHAR )
297  {
298  wxKeyEvent* ke = static_cast<wxKeyEvent*>( &aEvent );
299  int key = ke->GetKeyCode();
300  int mods = decodeModifiers( ke );
301 
302  if( mods & MD_CTRL )
303  {
304 #if !wxCHECK_VERSION( 2, 9, 0 )
305  // I really look forward to the day when we will use only one version of wxWidgets..
306  const int WXK_CONTROL_A = 1;
307  const int WXK_CONTROL_Z = 26;
308 #endif
309 
310  // wxWidgets have a quirk related to Ctrl+letter hot keys handled by CHAR_EVT
311  // http://docs.wxwidgets.org/trunk/classwx_key_event.html:
312  // "char events for ASCII letters in this case carry codes corresponding to the ASCII
313  // value of Ctrl-Latter, i.e. 1 for Ctrl-A, 2 for Ctrl-B and so on until 26 for Ctrl-Z."
314  if( key >= WXK_CONTROL_A && key <= WXK_CONTROL_Z )
315  key += 'A' - 1;
316  }
317 
318  if( key == WXK_ESCAPE ) // ESC is the special key for cancelling tools
320  else
321  evt = TOOL_EVENT( TC_KEYBOARD, TA_KEY_PRESSED, key | mods );
322  }
323 
324  if( evt )
325  m_toolMgr->ProcessEvent( *evt );
326 
327  // pass the event to the GUI, it might still be interested in it
328 #ifdef __APPLE__
329  // On OS X, key events are always meant to be caught. An uncaught key event is assumed
330  // to be a user input error by OS X (as they are pressing keys in a context where nothing
331  // is there to catch the event). This annoyingly makes OS X beep and/or flash the screen
332  // in pcbnew and the footprint editor any time a hotkey is used. The correct procedure is
333  // to NOT pass key events to the GUI under OS X.
334 
335  if( type != wxEVT_CHAR )
336  aEvent.Skip();
337 #else
338  aEvent.Skip();
339 #endif
340 
341  updateUI();
342 }
static int decodeModifiers(const wxKeyboardState *aState)
Saves the state of key modifiers (Alt, Ctrl and so on).
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Function GetMousePosition() Returns the current mouse pointer position.
static const wxEventType EVT_REFRESH_MOUSE
Event that forces mouse move event in the dispatcher (eg.
wxWindow * GetEditFrame() const
Definition: tool_manager.h:258
KIGFX::VIEW_CONTROLS * GetViewControls() const
Definition: tool_manager.h:248
Class TOOL_EVENT.
Definition: tool_event.h:162
VECTOR2D m_lastMousePos
The last mouse cursor position (in world coordinates).
void updateUI()
Redraws the status bar and message panel.
std::vector< BUTTON_STATE * > m_buttons
State of mouse buttons.
void ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
bool handleMouseButton(wxEvent &aEvent, int aIndex, bool aMotion)
Handles mouse related events (click, motion, dragging).
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
TOOL_MANAGER * m_toolMgr
Instance of tool manager that cooperates with the dispatcher.
KIGFX::VIEW * TOOL_DISPATCHER::getView ( )
private

Returns the instance of VIEW, used by the application.

Definition at line 146 of file tool_dispatcher.cpp.

References TOOL_MANAGER::GetEditFrame(), and m_toolMgr.

Referenced by handleMouseButton().

147 {
148  return static_cast<EDA_DRAW_FRAME*>( m_toolMgr->GetEditFrame() )->GetGalCanvas()->GetView();
149 }
wxWindow * GetEditFrame() const
Definition: tool_manager.h:258
Class EDA_DRAW_FRAME is the base class for create windows for drawing purpose.
Definition: draw_frame.h:53
TOOL_MANAGER * m_toolMgr
Instance of tool manager that cooperates with the dispatcher.
bool TOOL_DISPATCHER::handleMouseButton ( wxEvent &  aEvent,
int  aIndex,
bool  aMotion 
)
private

Handles mouse related events (click, motion, dragging).

Definition at line 152 of file tool_dispatcher.cpp.

References TOOL_DISPATCHER::BUTTON_STATE::button, TOOL_DISPATCHER::BUTTON_STATE::dblClickEvent, decodeModifiers(), TOOL_DISPATCHER::BUTTON_STATE::downPosition, TOOL_DISPATCHER::BUTTON_STATE::downTimestamp, DragDistanceThreshold, TOOL_DISPATCHER::BUTTON_STATE::dragging, TOOL_DISPATCHER::BUTTON_STATE::dragMaxDelta, TOOL_DISPATCHER::BUTTON_STATE::dragOrigin, DragTimeThreshold, VECTOR2< T >::EuclideanNorm(), TOOL_DISPATCHER::BUTTON_STATE::GetState(), getView(), m_buttons, m_lastMousePos, m_toolMgr, max, TOOL_DISPATCHER::BUTTON_STATE::pressed, TOOL_MANAGER::ProcessEvent(), TA_MOUSE_CLICK, TA_MOUSE_DBLCLICK, TA_MOUSE_DOWN, TA_MOUSE_DRAG, TA_MOUSE_UP, TC_MOUSE, and KIGFX::VIEW::ToScreen().

Referenced by DispatchWxEvent().

153 {
154  BUTTON_STATE* st = m_buttons[aIndex];
155  wxEventType type = aEvent.GetEventType();
157  bool isClick = false;
158 
159 // bool up = type == st->upEvent;
160 // bool down = type == st->downEvent;
161  bool up = false, down = false;
162  bool dblClick = type == st->dblClickEvent;
163  bool state = st->GetState();
164 
165  if( !dblClick )
166  {
167  // Sometimes the dispatcher does not receive mouse button up event, so it stays
168  // in the dragging mode even if the mouse button is not held anymore
169  if( st->pressed && !state )
170  up = true;
171  else if( !st->pressed && state )
172  down = true;
173  }
174 
175  int mods = decodeModifiers( static_cast<wxMouseEvent*>( &aEvent ) );
176  int args = st->button | mods;
177 
178  if( down ) // Handle mouse button press
179  {
180  st->downTimestamp = wxGetLocalTimeMillis();
181 
182  if( !st->pressed ) // save the drag origin on the first click only
183  st->dragOrigin = m_lastMousePos;
184 
185  st->downPosition = m_lastMousePos;
186  st->dragMaxDelta = 0;
187  st->pressed = true;
188  evt = TOOL_EVENT( TC_MOUSE, TA_MOUSE_DOWN, args );
189  }
190  else if( up ) // Handle mouse button release
191  {
192  st->pressed = false;
193 
194  if( st->dragging )
195  {
196  wxLongLong t = wxGetLocalTimeMillis();
197 
198  // Determine if it was just a single click or beginning of dragging
199  if( t - st->downTimestamp < DragTimeThreshold &&
200  st->dragMaxDelta < DragDistanceThreshold )
201  isClick = true;
202  else
203  evt = TOOL_EVENT( TC_MOUSE, TA_MOUSE_UP, args );
204  }
205  else
206  isClick = true;
207 
208  if( isClick )
209  evt = TOOL_EVENT( TC_MOUSE, TA_MOUSE_CLICK, args );
210 
211  st->dragging = false;
212  }
213  else if( dblClick )
214  {
215  evt = TOOL_EVENT( TC_MOUSE, TA_MOUSE_DBLCLICK, args );
216  }
217 
218  if( st->pressed && aMotion )
219  {
220  st->dragging = true;
221  double dragPixelDistance =
222  getView()->ToScreen( m_lastMousePos - st->dragOrigin, false ).EuclideanNorm();
223  st->dragMaxDelta = std::max( st->dragMaxDelta, dragPixelDistance );
224 
225  wxLongLong t = wxGetLocalTimeMillis();
226 
227  if( t - st->downTimestamp > DragTimeThreshold || st->dragMaxDelta > DragDistanceThreshold )
228  {
229  evt = TOOL_EVENT( TC_MOUSE, TA_MOUSE_DRAG, args );
230  evt->setMouseDragOrigin( st->dragOrigin );
231  evt->setMouseDelta( m_lastMousePos - st->dragOrigin );
232  }
233  }
234 
235  if( evt )
236  {
237  evt->SetMousePosition( isClick ? st->downPosition : m_lastMousePos );
238  m_toolMgr->ProcessEvent( *evt );
239 
240  return true;
241  }
242 
243  return false;
244 }
static int decodeModifiers(const wxKeyboardState *aState)
Saves the state of key modifiers (Alt, Ctrl and so on).
static const int DragDistanceThreshold
The distance threshold for mouse cursor that disinguishes between a single mouse click and a beginnin...
T EuclideanNorm() const
Destructor.
Definition: vector2d.h:295
Class TOOL_EVENT.
Definition: tool_event.h:162
VECTOR2D m_lastMousePos
The last mouse cursor position (in world coordinates).
std::vector< BUTTON_STATE * > m_buttons
State of mouse buttons.
#define max(a, b)
Definition: auxiliary.h:86
VECTOR2D ToScreen(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToScreen() Converts a world space point/vector to a point/vector in screen space coordinates...
Definition: view.cpp:459
void ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
static const int DragTimeThreshold
The time threshold for a mouse button press that distinguishes between a single mouse click and a beg...
KIGFX::VIEW * getView()
Returns the instance of VIEW, used by the application.
TOOL_MANAGER * m_toolMgr
Instance of tool manager that cooperates with the dispatcher.
void TOOL_DISPATCHER::ResetState ( )
virtual

Function ResetState() Brings the dispatcher to its initial state.

Definition at line 139 of file tool_dispatcher.cpp.

References m_buttons.

Referenced by TOOL_DISPATCHER().

140 {
141  for( BUTTON_STATE* st : m_buttons )
142  st->Reset();
143 }
std::vector< BUTTON_STATE * > m_buttons
State of mouse buttons.
void TOOL_DISPATCHER::updateUI ( )
private

Redraws the status bar and message panel.

Definition at line 358 of file tool_dispatcher.cpp.

References TOOL_MANAGER::GetEditFrame(), m_toolMgr, and EDA_DRAW_FRAME::UpdateStatusBar().

Referenced by DispatchWxCommand(), and DispatchWxEvent().

359 {
360  // TODO I don't feel it is the right place for updating UI,
361  // but at the moment I cannot think of a better one..
362  EDA_DRAW_FRAME* frame = static_cast<EDA_DRAW_FRAME*>( m_toolMgr->GetEditFrame() );
363  frame->UpdateStatusBar();
364  //frame->UpdateMsgPanel();
365 }
wxWindow * GetEditFrame() const
Definition: tool_manager.h:258
Class EDA_DRAW_FRAME is the base class for create windows for drawing purpose.
Definition: draw_frame.h:53
virtual void UpdateStatusBar()
Function UpdateStatusBar updates the status bar information.
Definition: draw_frame.cpp:669
TOOL_MANAGER * m_toolMgr
Instance of tool manager that cooperates with the dispatcher.

Member Data Documentation

const int TOOL_DISPATCHER::DragDistanceThreshold = 8
staticprivate

The distance threshold for mouse cursor that disinguishes between a single mouse click and a beginning of drag event (expressed in screen pixels).

Definition at line 96 of file tool_dispatcher.h.

Referenced by handleMouseButton().

const int TOOL_DISPATCHER::DragTimeThreshold = 300
staticprivate

The time threshold for a mouse button press that distinguishes between a single mouse click and a beginning of drag event (expressed in milliseconds).

Definition at line 92 of file tool_dispatcher.h.

Referenced by handleMouseButton().

ACTIONS* TOOL_DISPATCHER::m_actions
private

Instance of an actions list that handles legacy action translation

Definition at line 137 of file tool_dispatcher.h.

Referenced by DispatchWxCommand().

std::vector<BUTTON_STATE*> TOOL_DISPATCHER::m_buttons
private

State of mouse buttons.

Definition at line 128 of file tool_dispatcher.h.

Referenced by DispatchWxEvent(), handleMouseButton(), ResetState(), TOOL_DISPATCHER(), and ~TOOL_DISPATCHER().

VECTOR2D TOOL_DISPATCHER::m_lastMousePos
private

The last mouse cursor position (in world coordinates).

Definition at line 122 of file tool_dispatcher.h.

Referenced by DispatchWxEvent(), and handleMouseButton().

TOOL_MANAGER* TOOL_DISPATCHER::m_toolMgr
private

Instance of tool manager that cooperates with the dispatcher.

Definition at line 134 of file tool_dispatcher.h.

Referenced by DispatchWxCommand(), DispatchWxEvent(), getView(), handleMouseButton(), and updateUI().

const int TOOL_DISPATCHER::MouseButtonCount = 3
staticprivate

Number of mouse buttons that is handled in events.

Definition at line 88 of file tool_dispatcher.h.


The documentation for this class was generated from the following files: