#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)

virtual	~TOOL_DISPATCHER ()

virtual void	ResetState ()
	Bring the dispatcher to its initial state. More...

virtual void	DispatchWxEvent (wxEvent &aEvent)
	Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those. More...

std::optional< TOOL_EVENT >	GetToolEvent (wxKeyEvent aKeyEvent, bool aSpecialKeyFlag)
	Map a wxWidgets key event to a TOOL_EVENT. More...

Private Member Functions
bool	handleMouseButton (wxEvent &aEvent, int aIndex, bool aMotion)
	Saves the state of key modifiers (Alt, Ctrl and so on). More...

KIGFX::VIEW *	getView ()
	Instance of tool manager that cooperates with the dispatcher. More...

Static Private Member Functions
static int	decodeModifiers (const wxKeyboardState *aState)
	Stores all the information regarding a mouse button state. More...

Private Attributes
int	m_sysDragMinX
	Maximum distance before drag is activated in the Y axis. More...

int	m_sysDragMinY
	Handles mouse related events (click, motion, dragging). More...

VECTOR2D	m_lastMousePos
	The last mouse cursor position (in world coordinates). More...

VECTOR2D	m_lastMousePosScreen
	State of mouse buttons. More...

std::vector< BUTTON_STATE * >	m_buttons
	Returns the instance of VIEW, used by the application. More...

TOOL_MANAGER *	m_toolMgr

Static Private Attributes
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
	Mininum distance before drag is activated in the X axis. More...

Detailed Description

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_DISPATCHER ( TOOL_MANAGER * aToolMgr )

Parameters

aToolMgr tool manager instance the events will be sent to.

Definition at line 127 of file tool_dispatcher.cpp.

References BUT_AUX1, BUT_AUX2, BUT_LEFT, BUT_MIDDLE, BUT_RIGHT, DragDistanceThreshold, m_buttons, m_sysDragMinX, m_sysDragMinY, and ResetState().

◆ ~TOOL_DISPATCHER()

TOOL_DISPATCHER::~TOOL_DISPATCHER ( )

virtual

Definition at line 151 of file tool_dispatcher.cpp.

References m_buttons.

Member Function Documentation

◆ decodeModifiers()

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

inlinestaticprivate

Stores all the information regarding a mouse button state.

Definition at line 98 of file tool_dispatcher.h.

References MD_ALT, MD_CTRL, and MD_SHIFT.

Referenced by DispatchWxEvent(), GetToolEvent(), and handleMouseButton().

◆ DispatchWxEvent()

void TOOL_DISPATCHER::DispatchWxEvent ( wxEvent & aEvent )

virtual

Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.

Parameters

aEvent is the wxWidgets event to be processed.

Definition at line 420 of file tool_dispatcher.cpp.

References decodeModifiers(), dump(), KIGFX::WX_VIEW_CONTROLS::EVT_REFRESH_MOUSE, KIPLATFORM::APP::ForceTimerMessagesToBeCreatedIfNecessary(), KIGFX::VIEW_CONTROLS::GetMousePosition(), TOOLS_HOLDER::GetToolCanvas(), GetToolEvent(), TOOL_MANAGER::GetToolHolder(), TOOL_MANAGER::GetViewControls(), handleMouseButton(), KIUI::IsInputControlEditable(), KIUI::IsInputControlFocused(), isMouseClick(), KIPLATFORM::UI::IsWindowActive(), kicadTraceKeyEvent, kicadTraceToolStack, m_buttons, m_lastMousePos, m_lastMousePosScreen, m_toolMgr, ACTION_MENU::OnMenuEvent(), TOOL_MANAGER::ProcessEvent(), TA_MOUSE_MOTION, and TC_MOUSE.

Referenced by FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), EDA_3D_CANVAS::OnEvent(), EDA_DRAW_PANEL_GAL::OnEvent(), PANEL_PREVIEW_3D_MODEL::OnMenuEvent(), EDA_BASE_FRAME::OnMenuEvent(), CVPCB_MAINFRAME::setupEventHandlers(), SIMULATOR_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), and SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().

◆ GetToolEvent()

std::optional< TOOL_EVENT > TOOL_DISPATCHER::GetToolEvent	(	wxKeyEvent *	aKeyEvent,
		bool *	aSpecialKeyFlag
	)

Map a wxWidgets key event to a TOOL_EVENT.

Definition at line 340 of file tool_dispatcher.cpp.

References decodeModifiers(), dump(), ignore_unused(), isKeyModifierOnly(), isKeySpecialCode(), kicadTraceKeyEvent, MD_ALT, MD_CTRL, TA_CANCEL_TOOL, TA_KEY_PRESSED, TC_COMMAND, TC_KEYBOARD, and translateSpecialCode().

Referenced by DispatchWxEvent().

◆ getView()

KIGFX::VIEW * TOOL_DISPATCHER::getView ( )

private

Instance of tool manager that cooperates with the dispatcher.

Definition at line 165 of file tool_dispatcher.cpp.

References TOOL_MANAGER::GetView(), and m_toolMgr.

◆ handleMouseButton()

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

private

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

Definition at line 171 of file tool_dispatcher.cpp.

Referenced by DispatchWxEvent().

◆ ResetState()

void TOOL_DISPATCHER::ResetState ( )

virtual

Bring the dispatcher to its initial state.

Definition at line 158 of file tool_dispatcher.cpp.

References m_buttons.

Referenced by TOOL_DISPATCHER().

Member Data Documentation

◆ DragDistanceThreshold

const int TOOL_DISPATCHER::DragDistanceThreshold = 8

staticprivate

Mininum distance before drag is activated in the X axis.

Definition at line 87 of file tool_dispatcher.h.

Referenced by TOOL_DISPATCHER().

◆ DragTimeThreshold

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).

The distance threshold for mouse cursor that distinguishes between a single mouse click and a beginning of drag event (expressed in screen pixels). System drag preferences take precedence if available

Definition at line 82 of file tool_dispatcher.h.

Referenced by handleMouseButton().

◆ m_buttons

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

private

Returns the instance of VIEW, used by the application.

Definition at line 124 of file tool_dispatcher.h.

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

◆ m_lastMousePos

VECTOR2D TOOL_DISPATCHER::m_lastMousePos

private

The last mouse cursor position (in world coordinates).

The last mouse cursor position (in screen coordinates).

Definition at line 118 of file tool_dispatcher.h.

Referenced by DispatchWxEvent(), and handleMouseButton().

◆ m_lastMousePosScreen

VECTOR2D TOOL_DISPATCHER::m_lastMousePosScreen

private

State of mouse buttons.

Definition at line 121 of file tool_dispatcher.h.

Referenced by DispatchWxEvent(), and handleMouseButton().

◆ m_sysDragMinX

int TOOL_DISPATCHER::m_sysDragMinX

private

Maximum distance before drag is activated in the Y axis.

Definition at line 90 of file tool_dispatcher.h.

Referenced by handleMouseButton(), and TOOL_DISPATCHER().

◆ m_sysDragMinY

int TOOL_DISPATCHER::m_sysDragMinY

private

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

Definition at line 92 of file tool_dispatcher.h.

Referenced by handleMouseButton(), and TOOL_DISPATCHER().

◆ m_toolMgr

TOOL_MANAGER* TOOL_DISPATCHER::m_toolMgr

private

Definition at line 130 of file tool_dispatcher.h.

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

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

Classes

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TOOL_DISPATCHER()

◆ ~TOOL_DISPATCHER()

Member Function Documentation

◆ decodeModifiers()

◆ DispatchWxEvent()

◆ GetToolEvent()

◆ getView()

◆ handleMouseButton()

◆ ResetState()

Member Data Documentation

◆ DragDistanceThreshold

◆ DragTimeThreshold

◆ m_buttons

◆ m_lastMousePos

◆ m_lastMousePosScreen

◆ m_sysDragMinX

◆ m_sysDragMinY

◆ m_toolMgr