Structure to keep VIEW_CONTROLS settings for easy store/restore operations. More...

#include <view_controls.h>

Public Member Functions
	VC_SETTINGS ()

void	Reset ()
	Restore the default settings.

Public Attributes
bool	m_showCursor
	Flag determining the cursor visibility.

VECTOR2D	m_forcedPosition
	Forced cursor position (world coordinates).

bool	m_forceCursorPosition
	Is the forced cursor position enabled.

bool	m_cursorCaptured
	Should the cursor be locked within the parent window area.

bool	m_snappingEnabled
	Should the cursor snap to grid or move freely.

bool	m_grabMouse
	Flag for grabbing the mouse cursor.

bool	m_focusFollowSchPcb
	Flag for automatic focus switching between Schematic and PCB editors.

bool	m_autoPanEnabled
	Flag for turning on autopanning.

bool	m_autoPanSettingEnabled
	Flag for turning on autopanning.

float	m_autoPanMargin
	Distance from cursor to VIEW edge when panning is active.

float	m_autoPanSpeed
	How fast is panning when in auto mode.

float	m_autoPanAcceleration
	How fast does panning accelerate when approaching the window boundary.

bool	m_warpCursor
	If the cursor is allowed to be warped.

bool	m_horizontalPan
	Enable horizontal panning with the horizontal scroll/trackpad input.

bool	m_zoomAcceleration
	Enable the accelerating zoom controller.

int	m_zoomSpeed
	Zoom speed for the non-accelerating zoom controller.

bool	m_zoomSpeedAuto
	When true, ignore zoom_speed and pick a platform-specific default.

int	m_scrollModifierZoom
	What modifier key to enable zoom with the (vertical) scroll wheel.

int	m_scrollModifierPanH
	What modifier key to enable horizontal pan with the (vertical) scroll wheel.

int	m_scrollModifierPanV
	What modifier key to enable vertical with the (vertical) scroll wheel.

MOUSE_DRAG_ACTION	m_dragLeft

MOUSE_DRAG_ACTION	m_dragMiddle

MOUSE_DRAG_ACTION	m_dragRight

bool	m_lastKeyboardCursorPositionValid
	Is last cursor motion event coming from keyboard arrow cursor motion action.

long	m_lastKeyboardCursorCommand
	ACTIONS::CURSOR_UP, ACTIONS::CURSOR_DOWN, etc.

VECTOR2D	m_lastKeyboardCursorPosition
	Position of the above event.

bool	m_scrollReverseZoom
	Whether to invert the scroll wheel movement for zoom.

bool	m_scrollReversePanH
	Whether to invert the scroll wheel movement for horizontal pan.

Detailed Description

Structure to keep VIEW_CONTROLS settings for easy store/restore operations.

Definition at line 42 of file view_controls.h.

Constructor & Destructor Documentation

◆ VC_SETTINGS()

KIGFX::VC_SETTINGS::VC_SETTINGS ( )

inline

Definition at line 44 of file view_controls.h.

References Reset().

Member Function Documentation

◆ Reset()

void VC_SETTINGS::Reset ( )

Restore the default settings.

Definition at line 58 of file view_controls.cpp.

References ACTIONS::CURSOR_NONE, m_autoPanAcceleration, m_autoPanEnabled, m_autoPanMargin, m_autoPanSettingEnabled, m_autoPanSpeed, m_cursorCaptured, m_dragLeft, m_dragMiddle, m_dragRight, m_focusFollowSchPcb, m_forceCursorPosition, m_grabMouse, m_horizontalPan, m_lastKeyboardCursorCommand, m_lastKeyboardCursorPosition, m_lastKeyboardCursorPositionValid, m_scrollModifierPanH, m_scrollModifierPanV, m_scrollModifierZoom, m_scrollReversePanH, m_scrollReverseZoom, m_showCursor, m_snappingEnabled, m_warpCursor, m_zoomAcceleration, m_zoomSpeed, and m_zoomSpeedAuto.

Referenced by TOOL_MANAGER::TOOL_STATE::clear().

Member Data Documentation

◆ m_autoPanAcceleration

float KIGFX::VC_SETTINGS::m_autoPanAcceleration

How fast does panning accelerate when approaching the window boundary.

Definition at line 86 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), KIGFX::WX_VIEW_CONTROLS::onTimer(), and Reset().

◆ m_autoPanEnabled

bool KIGFX::VC_SETTINGS::m_autoPanEnabled

Flag for turning on autopanning.

Definition at line 74 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), KIGFX::WX_VIEW_CONTROLS::onMotion(), KIGFX::WX_VIEW_CONTROLS::onTimer(), and Reset().

◆ m_autoPanMargin

float KIGFX::VC_SETTINGS::m_autoPanMargin

Distance from cursor to VIEW edge when panning is active.

Definition at line 80 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), KIGFX::WX_VIEW_CONTROLS::handleAutoPanning(), KIGFX::WX_VIEW_CONTROLS::onTimer(), KIGFX::WX_VIEW_CONTROLS::PinCursorInsideNonAutoscrollArea(), and Reset().

◆ m_autoPanSettingEnabled

bool KIGFX::VC_SETTINGS::m_autoPanSettingEnabled

Flag for turning on autopanning.

Definition at line 77 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), KIGFX::WX_VIEW_CONTROLS::onMotion(), and Reset().

◆ m_autoPanSpeed

float KIGFX::VC_SETTINGS::m_autoPanSpeed

How fast is panning when in auto mode.

Definition at line 83 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), and Reset().

◆ m_cursorCaptured

bool KIGFX::VC_SETTINGS::m_cursorCaptured

Should the cursor be locked within the parent window area.

Definition at line 62 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), KIGFX::WX_VIEW_CONTROLS::CancelDrag(), KIGFX::WX_VIEW_CONTROLS::handleCursorCapture(), KIGFX::WX_VIEW_CONTROLS::onButton(), and Reset().

◆ m_dragLeft

MOUSE_DRAG_ACTION KIGFX::VC_SETTINGS::m_dragLeft

Definition at line 112 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), and Reset().

◆ m_dragMiddle

MOUSE_DRAG_ACTION KIGFX::VC_SETTINGS::m_dragMiddle

Definition at line 113 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), KIGFX::WX_VIEW_CONTROLS::onButton(), and Reset().

◆ m_dragRight

MOUSE_DRAG_ACTION KIGFX::VC_SETTINGS::m_dragRight

Definition at line 114 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), KIGFX::WX_VIEW_CONTROLS::onButton(), and Reset().

◆ m_focusFollowSchPcb

bool KIGFX::VC_SETTINGS::m_focusFollowSchPcb

Flag for automatic focus switching between Schematic and PCB editors.

Definition at line 71 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), KIGFX::WX_VIEW_CONTROLS::onMotion(), and Reset().

◆ m_forceCursorPosition

bool KIGFX::VC_SETTINGS::m_forceCursorPosition

Is the forced cursor position enabled.

Definition at line 59 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), TOOL_MANAGER::DispatchContextMenu(), KIGFX::WX_VIEW_CONTROLS::ForceCursorPosition(), KIGFX::WX_VIEW_CONTROLS::GetCursorPosition(), Reset(), COMMON_TOOLS::ResetLocalCoords(), and TOOL_MANAGER::saveViewControls().

◆ m_forcedPosition

VECTOR2D KIGFX::VC_SETTINGS::m_forcedPosition

Forced cursor position (world coordinates).

Definition at line 56 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), TOOL_MANAGER::DispatchContextMenu(), KIGFX::WX_VIEW_CONTROLS::ForceCursorPosition(), KIGFX::WX_VIEW_CONTROLS::GetCursorPosition(), COMMON_TOOLS::ResetLocalCoords(), and TOOL_MANAGER::saveViewControls().

◆ m_grabMouse

bool KIGFX::VC_SETTINGS::m_grabMouse

Flag for grabbing the mouse cursor.

Definition at line 68 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), and Reset().

◆ m_horizontalPan

bool KIGFX::VC_SETTINGS::m_horizontalPan

Enable horizontal panning with the horizontal scroll/trackpad input.

Definition at line 92 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), KIGFX::WX_VIEW_CONTROLS::onWheel(), and Reset().

◆ m_lastKeyboardCursorCommand

long KIGFX::VC_SETTINGS::m_lastKeyboardCursorCommand

ACTIONS::CURSOR_UP, ACTIONS::CURSOR_DOWN, etc.

Definition at line 120 of file view_controls.h.

Referenced by EDIT_TOOL::doMoveSelection(), Reset(), KIGFX::WX_VIEW_CONTROLS::SetCursorPosition(), and KIGFX::WX_VIEW_CONTROLS::WX_VIEW_CONTROLS().

◆ m_lastKeyboardCursorPosition

VECTOR2D KIGFX::VC_SETTINGS::m_lastKeyboardCursorPosition

Position of the above event.

Definition at line 123 of file view_controls.h.

Referenced by KIGFX::WX_VIEW_CONTROLS::handleAutoPanning(), Reset(), KIGFX::WX_VIEW_CONTROLS::SetCursorPosition(), and KIGFX::WX_VIEW_CONTROLS::WX_VIEW_CONTROLS().

◆ m_lastKeyboardCursorPositionValid

bool KIGFX::VC_SETTINGS::m_lastKeyboardCursorPositionValid

Is last cursor motion event coming from keyboard arrow cursor motion action.

Definition at line 117 of file view_controls.h.

Referenced by EDIT_TOOL::doMoveSelection(), KIGFX::WX_VIEW_CONTROLS::handleAutoPanning(), Reset(), KIGFX::WX_VIEW_CONTROLS::SetCursorPosition(), and KIGFX::WX_VIEW_CONTROLS::WX_VIEW_CONTROLS().

◆ m_scrollModifierPanH

int KIGFX::VC_SETTINGS::m_scrollModifierPanH

What modifier key to enable horizontal pan with the (vertical) scroll wheel.

Definition at line 107 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), KIGFX::WX_VIEW_CONTROLS::onWheel(), and Reset().

◆ m_scrollModifierPanV

int KIGFX::VC_SETTINGS::m_scrollModifierPanV

What modifier key to enable vertical with the (vertical) scroll wheel.

Definition at line 110 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), and Reset().

◆ m_scrollModifierZoom

int KIGFX::VC_SETTINGS::m_scrollModifierZoom

What modifier key to enable zoom with the (vertical) scroll wheel.

Definition at line 104 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), KIGFX::WX_VIEW_CONTROLS::onWheel(), and Reset().

◆ m_scrollReversePanH

bool KIGFX::VC_SETTINGS::m_scrollReversePanH

Whether to invert the scroll wheel movement for horizontal pan.

Definition at line 130 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), KIGFX::WX_VIEW_CONTROLS::onWheel(), and Reset().

◆ m_scrollReverseZoom

bool KIGFX::VC_SETTINGS::m_scrollReverseZoom

Whether to invert the scroll wheel movement for zoom.

Definition at line 127 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), HIDPI_GL_3D_CANVAS::OnMouseWheelCamera(), KIGFX::WX_VIEW_CONTROLS::onWheel(), and Reset().

◆ m_showCursor

bool KIGFX::VC_SETTINGS::m_showCursor

Flag determining the cursor visibility.

Definition at line 53 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), KIGFX::VIEW_CONTROLS::IsCursorShown(), Reset(), and KIGFX::VIEW_CONTROLS::ShowCursor().

◆ m_snappingEnabled

bool KIGFX::VC_SETTINGS::m_snappingEnabled

Should the cursor snap to grid or move freely.

Definition at line 65 of file view_controls.h.

Referenced by Reset().

◆ m_warpCursor

bool KIGFX::VC_SETTINGS::m_warpCursor

If the cursor is allowed to be warped.

Definition at line 89 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), and Reset().

◆ m_zoomAcceleration

bool KIGFX::VC_SETTINGS::m_zoomAcceleration

Enable the accelerating zoom controller.

Definition at line 95 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), and Reset().

◆ m_zoomSpeed

int KIGFX::VC_SETTINGS::m_zoomSpeed

Zoom speed for the non-accelerating zoom controller.

Definition at line 98 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), KIGFX::WX_VIEW_CONTROLS::onMotion(), and Reset().

◆ m_zoomSpeedAuto

bool KIGFX::VC_SETTINGS::m_zoomSpeedAuto

When true, ignore zoom_speed and pick a platform-specific default.

Definition at line 101 of file view_controls.h.

Referenced by EDA_DRAW_PANEL_GAL::GetVcSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), and Reset().

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VC_SETTINGS()

Member Function Documentation

◆ Reset()

Member Data Documentation

◆ m_autoPanAcceleration

◆ m_autoPanEnabled

◆ m_autoPanMargin

◆ m_autoPanSettingEnabled

◆ m_autoPanSpeed

◆ m_cursorCaptured

◆ m_dragLeft

◆ m_dragMiddle

◆ m_dragRight

◆ m_focusFollowSchPcb

◆ m_forceCursorPosition

◆ m_forcedPosition

◆ m_grabMouse

◆ m_horizontalPan

◆ m_lastKeyboardCursorCommand

◆ m_lastKeyboardCursorPosition

◆ m_lastKeyboardCursorPositionValid

◆ m_scrollModifierPanH

◆ m_scrollModifierPanV

◆ m_scrollModifierZoom

◆ m_scrollReversePanH

◆ m_scrollReverseZoom

◆ m_showCursor

◆ m_snappingEnabled

◆ m_warpCursor

◆ m_zoomAcceleration

◆ m_zoomSpeed

◆ m_zoomSpeedAuto