Structure to keep VIEW_CONTROLS settings for easy store/restore operations

#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_horizontalPan
	Enable horizontal panning with the horizontal scroll/trackpad input More...

bool	m_zoomAcceleration
	Enable the accelerating zoom controller More...

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

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

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

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

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

MOUSE_DRAG_ACTION	m_dragMiddle
	What drag action to perform when the middle button is pressed More...

MOUSE_DRAG_ACTION	m_dragRight
	What drag action to perform when the right button is pressed 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 55 of file view_controls.h.

Constructor & Destructor Documentation

◆ VC_SETTINGS()

KIGFX::VC_SETTINGS::VC_SETTINGS ( )

inline

Definition at line 57 of file view_controls.h.

     {
         Reset();
     }

References Reset().

Member Function Documentation

◆ Reset()

void VC_SETTINGS::Reset ( )

Restores the default settings

Definition at line 58 of file view_controls.cpp.

 {
     m_showCursor                      = false;
     m_forceCursorPosition             = false;
     m_cursorCaptured                  = false;
     m_snappingEnabled                 = true;
     m_grabMouse                       = false;
     m_autoPanEnabled                  = false;
     m_autoPanSettingEnabled           = false;
     m_autoPanMargin                   = 0.02f;
     m_autoPanSpeed                    = 0.15f;
     m_autoPanAcceleration             = 5.0f;
     m_warpCursor                      = false;
     m_horizontalPan                   = false;
     m_zoomAcceleration                = false;
     m_zoomSpeed                       = 5;
     m_zoomSpeedAuto                   = true;
     m_scrollModifierZoom              = 0;
     m_scrollModifierPanH              = WXK_CONTROL;
     m_scrollModifierPanV              = WXK_SHIFT;
     m_dragMiddle                      = MOUSE_DRAG_ACTION::PAN;
     m_dragRight                       = MOUSE_DRAG_ACTION::PAN;
     m_lastKeyboardCursorPositionValid = false;
     m_lastKeyboardCursorPosition      = { 0.0, 0.0 };
     m_lastKeyboardCursorCommand       = ACTIONS::CURSOR_NONE;
 }

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

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 96 of file view_controls.h.

Referenced by KIGFX::WX_VIEW_CONTROLS::LoadSettings(), 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 84 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 90 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 87 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::EnableAutoPan(), 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 93 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 75 of file view_controls.h.

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

◆ m_dragMiddle

MOUSE_DRAG_ACTION KIGFX::VC_SETTINGS::m_dragMiddle

What drag action to perform when the middle button is pressed

Definition at line 123 of file view_controls.h.

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

◆ m_dragRight

MOUSE_DRAG_ACTION KIGFX::VC_SETTINGS::m_dragRight

What drag action to perform when the right button is pressed

Definition at line 126 of file view_controls.h.

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

◆ m_forceCursorPosition

bool KIGFX::VC_SETTINGS::m_forceCursorPosition

Is the forced cursor position enabled

Definition at line 72 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 69 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 81 of file view_controls.h.

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

◆ m_horizontalPan

bool KIGFX::VC_SETTINGS::m_horizontalPan

Enable horizontal panning with the horizontal scroll/trackpad input

Definition at line 102 of file view_controls.h.

Referenced by 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 132 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 135 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 129 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 117 of file view_controls.h.

Referenced by KIGFX::WX_VIEW_CONTROLS::LoadSettings(), 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 120 of file view_controls.h.

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

◆ m_scrollModifierZoom

int KIGFX::VC_SETTINGS::m_scrollModifierZoom

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

Definition at line 114 of file view_controls.h.

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

◆ m_showCursor

bool KIGFX::VC_SETTINGS::m_showCursor

Flag determining the cursor visibility

Definition at line 66 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 78 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 99 of file view_controls.h.

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

◆ m_zoomAcceleration

bool KIGFX::VC_SETTINGS::m_zoomAcceleration

Enable the accelerating zoom controller

Definition at line 105 of file view_controls.h.

Referenced by 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 108 of file view_controls.h.

Referenced by 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 111 of file view_controls.h.

Referenced by 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_dragMiddle

◆ m_dragRight

◆ m_forceCursorPosition

◆ m_forcedPosition

◆ m_grabMouse

◆ m_horizontalPan

◆ m_lastKeyboardCursorCommand

◆ m_lastKeyboardCursorPosition

◆ m_lastKeyboardCursorPositionValid

◆ m_scrollModifierPanH

◆ m_scrollModifierPanV

◆ m_scrollModifierZoom

◆ m_showCursor

◆ m_snappingEnabled

◆ m_warpCursor

◆ m_zoomAcceleration

◆ m_zoomSpeed

◆ m_zoomSpeedAuto