KiCad PCB EDA Suite
Public Member Functions | Public Attributes | List of all members
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 ()
 
void Reset ()
 

Restores the default settings

More...
 

Public Attributes

bool m_showCursor
 

Flag determining the cursor visibility

More...
 
VECTOR2D m_forcedPosition
 

Forced cursor position (world coordinates)

More...
 
bool m_forceCursorPosition
 

Is the forced cursor position enabled

More...
 
bool m_cursorCaptured
 

Should the cursor be locked within the parent window area

More...
 
bool m_snappingEnabled
 

Should the cursor snap to grid or move freely

More...
 
bool m_grabMouse
 

Flag for grabbing the mouse cursor

More...
 
bool m_autoPanEnabled
 

Flag for turning on autopanning

More...
 
bool m_autoPanSettingEnabled
 

Flag for turning on autopanning

More...
 
float m_autoPanMargin
 

Distance from cursor to VIEW edge when panning is active

More...
 
float m_autoPanSpeed
 

How fast is panning when in auto mode

More...
 
float m_autoPanAcceleration
 

How fast does panning accelerate when approaching the window boundary

More...
 
bool m_warpCursor
 

If the cursor is allowed to be warped

More...
 
bool m_enableMousewheelPan
 

Mousewheel (2-finger touchpad) panning

More...
 
bool m_panWithRightButton
 

Allow panning with the right button in addition to middle

More...
 
bool m_panWithLeftButton
 

Allow panning with the left button in addition to middle

More...
 
bool m_lastKeyboardCursorPositionValid
 

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

More...
 
long m_lastKeyboardCursorCommand
 

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

More...
 
VECTOR2D m_lastKeyboardCursorPosition
 

Position of the above event

More...
 

Detailed Description

Structure to keep VIEW_CONTROLS settings for easy store/restore operations

Definition at line 44 of file view_controls.h.

Constructor & Destructor Documentation

◆ VC_SETTINGS()

KIGFX::VC_SETTINGS::VC_SETTINGS ( )
inline

Definition at line 46 of file view_controls.h.

47  {
48  Reset();
49  }
KIGFX::VC_SETTINGS::Reset
void Reset()
Restores the default settings
Definition: view_controls.cpp:58

References Reset().

Member Function Documentation

◆ Reset()

void VC_SETTINGS::Reset ( )

Restores the default settings

Definition at line 58 of file view_controls.cpp.

59 {
60  m_showCursor = false;
61  m_forceCursorPosition = false;
62  m_cursorCaptured = false;
63  m_snappingEnabled = true;
64  m_grabMouse = false;
65  m_autoPanEnabled = false;
66  m_autoPanSettingEnabled = false;
67  m_autoPanMargin = 0.02f;
68  m_autoPanSpeed = 0.15f;
69  m_autoPanAcceleration = 1.5f;
70  m_warpCursor = false;
71  m_enableMousewheelPan = false;
72  m_panWithRightButton = false;
73  m_panWithLeftButton = false;
74  m_lastKeyboardCursorPositionValid = false;
75  m_lastKeyboardCursorPosition = { 0.0, 0.0 };
76  m_lastKeyboardCursorCommand = ACTIONS::CURSOR_NONE;
77 }
KIGFX::VC_SETTINGS::m_enableMousewheelPan
bool m_enableMousewheelPan
Mousewheel (2-finger touchpad) panning
Definition: view_controls.h:91
KIGFX::VC_SETTINGS::m_autoPanSpeed
float m_autoPanSpeed
How fast is panning when in auto mode
Definition: view_controls.h:82
KIGFX::VC_SETTINGS::m_snappingEnabled
bool m_snappingEnabled
Should the cursor snap to grid or move freely
Definition: view_controls.h:67
KIGFX::VC_SETTINGS::m_grabMouse
bool m_grabMouse
Flag for grabbing the mouse cursor
Definition: view_controls.h:70
KIGFX::VC_SETTINGS::m_panWithRightButton
bool m_panWithRightButton
Allow panning with the right button in addition to middle
Definition: view_controls.h:94
KIGFX::VC_SETTINGS::m_lastKeyboardCursorPosition
VECTOR2D m_lastKeyboardCursorPosition
Position of the above event
Definition: view_controls.h:106
KIGFX::VC_SETTINGS::m_autoPanSettingEnabled
bool m_autoPanSettingEnabled
Flag for turning on autopanning
Definition: view_controls.h:76
KIGFX::VC_SETTINGS::m_forceCursorPosition
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
KIGFX::VC_SETTINGS::m_autoPanAcceleration
float m_autoPanAcceleration
How fast does panning accelerate when approaching the window boundary
Definition: view_controls.h:85
KIGFX::VC_SETTINGS::m_warpCursor
bool m_warpCursor
If the cursor is allowed to be warped
Definition: view_controls.h:88
KIGFX::VC_SETTINGS::m_autoPanMargin
float m_autoPanMargin
Distance from cursor to VIEW edge when panning is active
Definition: view_controls.h:79
KIGFX::VC_SETTINGS::m_autoPanEnabled
bool m_autoPanEnabled
Flag for turning on autopanning
Definition: view_controls.h:73
KIGFX::VC_SETTINGS::m_showCursor
bool m_showCursor
Flag determining the cursor visibility
Definition: view_controls.h:55
KIGFX::VC_SETTINGS::m_lastKeyboardCursorCommand
long m_lastKeyboardCursorCommand
ACTIONS::CURSOR_UP, ACTIONS::CURSOR_DOWN, etc.
Definition: view_controls.h:103
KIGFX::VC_SETTINGS::m_lastKeyboardCursorPositionValid
bool m_lastKeyboardCursorPositionValid
Is last cursor motion event coming from keyboard arrow cursor motion action
Definition: view_controls.h:100
KIGFX::VC_SETTINGS::m_cursorCaptured
bool m_cursorCaptured
Should the cursor be locked within the parent window area
Definition: view_controls.h:64
KIGFX::VC_SETTINGS::m_panWithLeftButton
bool m_panWithLeftButton
Allow panning with the left button in addition to middle
Definition: view_controls.h:97

References ACTIONS::CURSOR_NONE, m_autoPanAcceleration, m_autoPanEnabled, m_autoPanMargin, m_autoPanSettingEnabled, m_autoPanSpeed, m_cursorCaptured, m_enableMousewheelPan, m_forceCursorPosition, m_grabMouse, m_lastKeyboardCursorCommand, m_lastKeyboardCursorPosition, m_lastKeyboardCursorPositionValid, m_panWithLeftButton, m_panWithRightButton, m_showCursor, m_snappingEnabled, and m_warpCursor.

Referenced by TOOL_MANAGER::TOOL_STATE::clear(), and VC_SETTINGS().

Member Data Documentation

◆ m_autoPanAcceleration

float KIGFX::VC_SETTINGS::m_autoPanAcceleration

How fast does panning accelerate when approaching the window boundary

Definition at line 85 of file view_controls.h.

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

◆ m_autoPanEnabled

bool KIGFX::VC_SETTINGS::m_autoPanEnabled

Flag for turning on autopanning

Definition at line 73 of file view_controls.h.

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

◆ m_autoPanMargin

float KIGFX::VC_SETTINGS::m_autoPanMargin

Distance from cursor to VIEW edge when panning is active

Definition at line 79 of file view_controls.h.

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

◆ m_autoPanSettingEnabled

bool KIGFX::VC_SETTINGS::m_autoPanSettingEnabled

Flag for turning on autopanning

Definition at line 76 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::EnableAutoPan(), KIGFX::WX_VIEW_CONTROLS::onMotion(), Reset(), KIGFX::WX_VIEW_CONTROLS::WX_VIEW_CONTROLS(), and KIGFX::WX_VIEW_CONTROLS::~WX_VIEW_CONTROLS().

◆ m_autoPanSpeed

float KIGFX::VC_SETTINGS::m_autoPanSpeed

How fast is panning when in auto mode

Definition at line 82 of file view_controls.h.

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

◆ m_cursorCaptured

bool KIGFX::VC_SETTINGS::m_cursorCaptured

Should the cursor be locked within the parent window area

Definition at line 64 of file view_controls.h.

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

◆ m_enableMousewheelPan

bool KIGFX::VC_SETTINGS::m_enableMousewheelPan

Mousewheel (2-finger touchpad) panning

Definition at line 91 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::EnableMousewheelPan(), KIGFX::VIEW_CONTROLS::IsMousewheelPanEnabled(), KIGFX::WX_VIEW_CONTROLS::onWheel(), Reset(), KIGFX::WX_VIEW_CONTROLS::WX_VIEW_CONTROLS(), and KIGFX::WX_VIEW_CONTROLS::~WX_VIEW_CONTROLS().

◆ m_forceCursorPosition

bool KIGFX::VC_SETTINGS::m_forceCursorPosition

Is the forced cursor position enabled

Definition at line 61 of file view_controls.h.

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

◆ m_forcedPosition

VECTOR2D KIGFX::VC_SETTINGS::m_forcedPosition

Forced cursor position (world coordinates)

Definition at line 58 of file view_controls.h.

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

◆ m_grabMouse

bool KIGFX::VC_SETTINGS::m_grabMouse

Flag for grabbing the mouse cursor

Definition at line 70 of file view_controls.h.

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

◆ m_lastKeyboardCursorCommand

long KIGFX::VC_SETTINGS::m_lastKeyboardCursorCommand

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

Definition at line 103 of file view_controls.h.

Referenced by EDIT_TOOL::Move(), 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 106 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 100 of file view_controls.h.

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

◆ m_panWithLeftButton

bool KIGFX::VC_SETTINGS::m_panWithLeftButton

Allow panning with the left button in addition to middle

Definition at line 97 of file view_controls.h.

Referenced by KIGFX::WX_VIEW_CONTROLS::onButton(), Reset(), and KIGFX::VIEW_CONTROLS::SetAdditionalPanButtons().

◆ m_panWithRightButton

bool KIGFX::VC_SETTINGS::m_panWithRightButton

Allow panning with the right button in addition to middle

Definition at line 94 of file view_controls.h.

Referenced by KIGFX::WX_VIEW_CONTROLS::onButton(), Reset(), and KIGFX::VIEW_CONTROLS::SetAdditionalPanButtons().

◆ m_showCursor

bool KIGFX::VC_SETTINGS::m_showCursor

Flag determining the cursor visibility

Definition at line 55 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 67 of file view_controls.h.

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

◆ m_warpCursor

bool KIGFX::VC_SETTINGS::m_warpCursor

If the cursor is allowed to be warped

Definition at line 88 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::EnableCursorWarping(), KIGFX::VIEW_CONTROLS::IsCursorWarpingEnabled(), Reset(), KIGFX::WX_VIEW_CONTROLS::WX_VIEW_CONTROLS(), and KIGFX::WX_VIEW_CONTROLS::~WX_VIEW_CONTROLS().

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