KiCad PCB EDA Suite
Loading...
Searching...
No Matches
KIGFX::VC_SETTINGS Struct Reference

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

#include <view_controls.h>

Public Member Functions

 VC_SETTINGS ()
 Restore the default settings. More...
 
void Reset ()
 Flag determining the cursor visibility. More...
 

Public Attributes

bool m_showCursor
 Forced cursor position (world coordinates). More...
 
VECTOR2D m_forcedPosition
 Is the forced cursor position enabled. More...
 
bool m_forceCursorPosition
 Should the cursor be locked within the parent window area. More...
 
bool m_cursorCaptured
 Should the cursor snap to grid or move freely. More...
 
bool m_snappingEnabled
 Flag for grabbing the mouse cursor. More...
 
bool m_grabMouse
 Flag for automatic focus switching between Schematic and PCB editors. More...
 
bool m_focusFollowSchPcb
 Flag for turning on autopanning. More...
 
bool m_autoPanEnabled
 Flag for turning on autopanning. More...
 
bool m_autoPanSettingEnabled
 Distance from cursor to VIEW edge when panning is active. More...
 
float m_autoPanMargin
 How fast is panning when in auto mode. More...
 
float m_autoPanSpeed
 How fast does panning accelerate when approaching the window boundary. More...
 
float m_autoPanAcceleration
 If the cursor is allowed to be warped. More...
 
bool m_warpCursor
 Enable horizontal panning with the horizontal scroll/trackpad input. More...
 
bool m_horizontalPan
 Enable the accelerating zoom controller. More...
 
bool m_zoomAcceleration
 Zoom speed for the non-accelerating zoom controller. More...
 
int m_zoomSpeed
 When true, ignore zoom_speed and pick a platform-specific default. More...
 
bool m_zoomSpeedAuto
 What modifier key to enable zoom with the (vertical) scroll wheel. More...
 
int m_scrollModifierZoom
 What modifier key to enable horizontal pan with the (vertical) scroll wheel. More...
 
int m_scrollModifierPanH
 What modifier key to enable vertical with the (vertical) scroll wheel. More...
 
int m_scrollModifierPanV
 
MOUSE_DRAG_ACTION m_dragLeft
 
MOUSE_DRAG_ACTION m_dragMiddle
 
MOUSE_DRAG_ACTION m_dragRight
 Is last cursor motion event coming from keyboard arrow cursor motion action. More...
 
bool m_lastKeyboardCursorPositionValid
 ACTIONS::CURSOR_UP, ACTIONS::CURSOR_DOWN, etc. More...
 
long m_lastKeyboardCursorCommand
 Position of the above event. More...
 
VECTOR2D m_lastKeyboardCursorPosition
 Wether to invert the scroll wheel movement for horizontal pan. More...
 
bool m_scrollReversePanH
 

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

Restore the default settings.

Definition at line 44 of file view_controls.h.

References Reset().

Member Function Documentation

◆ Reset()

Member Data Documentation

◆ m_autoPanAcceleration

float KIGFX::VC_SETTINGS::m_autoPanAcceleration

If the cursor is allowed to be warped.

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

◆ m_autoPanSettingEnabled

bool KIGFX::VC_SETTINGS::m_autoPanSettingEnabled

Distance from cursor to VIEW edge when panning is active.

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 does panning accelerate when approaching the window boundary.

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

◆ m_dragLeft

MOUSE_DRAG_ACTION KIGFX::VC_SETTINGS::m_dragLeft

◆ m_dragMiddle

◆ m_dragRight

MOUSE_DRAG_ACTION KIGFX::VC_SETTINGS::m_dragRight

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

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 turning on autopanning.

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

◆ m_forcedPosition

◆ m_grabMouse

bool KIGFX::VC_SETTINGS::m_grabMouse

Flag for automatic focus switching between Schematic and PCB editors.

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 the accelerating zoom controller.

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

◆ m_lastKeyboardCursorPosition

VECTOR2D KIGFX::VC_SETTINGS::m_lastKeyboardCursorPosition

Wether to invert the scroll wheel movement for horizontal pan.

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

◆ m_scrollModifierPanH

int KIGFX::VC_SETTINGS::m_scrollModifierPanH

What modifier key to enable vertical 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

◆ m_scrollModifierZoom

int KIGFX::VC_SETTINGS::m_scrollModifierZoom

What modifier key to enable horizontal pan 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

◆ m_showCursor

bool KIGFX::VC_SETTINGS::m_showCursor

Forced cursor position (world coordinates).

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

Flag for grabbing the mouse cursor.

Definition at line 65 of file view_controls.h.

Referenced by Reset().

◆ m_warpCursor

bool KIGFX::VC_SETTINGS::m_warpCursor

Enable horizontal panning with the horizontal scroll/trackpad input.

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

Zoom speed for the non-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

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

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

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

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: