KiCad PCB EDA Suite
view_controls.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2012 Torsten Hueter, torstenhtr <at> gmx.de
5  * Copyright (C) 2013 CERN
6  * Copyright (C) 2013-2019 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, you may find one here:
22  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23  * or you may search the http://www.gnu.org website for the version 2 license,
24  * or you may write to the Free Software Foundation, Inc.,
25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26  *
27  */
28 
34 #ifndef __VIEW_CONTROLS_H
35 #define __VIEW_CONTROLS_H
36 
37 #include <math/box2.h>
38 
39 namespace KIGFX
40 {
41 class VIEW;
42 
45 {
47  {
48  Reset();
49  }
50 
52  void Reset();
53 
56 
59 
62 
65 
68 
71 
74 
77 
80 
83 
86 
89 
92 
95 
98 
101 
104 
107 };
108 
109 
116 {
117 public:
118  VIEW_CONTROLS( VIEW* aView ) :
119  m_view( aView ), m_cursorWarped( false )
120  {
121  }
122 
123  virtual ~VIEW_CONTROLS()
124  {
125  }
126 
133  virtual void SetSnapping( bool aEnabled )
134  {
135  m_settings.m_snappingEnabled = aEnabled;
136  }
137 
141  virtual bool GetSnappingState()
142  {
144  }
145 
151  virtual void SetGrabMouse( bool aEnabled )
152  {
153  m_settings.m_grabMouse = aEnabled;
154  }
155 
162  virtual void SetAutoPan( bool aEnabled )
163  {
164  m_settings.m_autoPanEnabled = aEnabled;
165  }
166 
172  virtual void EnableAutoPan( bool aEnabled )
173  {
175  }
176 
182  virtual void SetAutoPanSpeed( float aSpeed )
183  {
184  m_settings.m_autoPanSpeed = aSpeed;
185  }
186 
192  virtual void SetAutoPanAcceleration( float aAcceleration )
193  {
194  m_settings.m_autoPanAcceleration = aAcceleration;
195  }
196 
202  virtual void SetAutoPanMargin( float aMargin )
203  {
204  m_settings.m_autoPanMargin = aMargin;
205  }
206 
216  virtual VECTOR2D GetMousePosition( bool aWorldCoordinates = true ) const = 0;
217 
226  {
228  }
229 
236  virtual VECTOR2D GetRawCursorPosition( bool aSnappingEnabled = true ) const = 0;
237 
246  virtual VECTOR2D GetCursorPosition( bool aEnableSnapping ) const = 0;
247 
254  virtual void ForceCursorPosition( bool aEnabled, const VECTOR2D& aPosition = VECTOR2D( 0, 0 ) )
255  {
257  m_settings.m_forcedPosition = aPosition;
258  }
259 
267  virtual void SetCursorPosition( const VECTOR2D& aPosition, bool aWarpView = true,
268  bool aTriggeredByArrows = false, long aArrowCommand = 0 ) = 0;
269 
270 
276  virtual void SetCrossHairCursorPosition( const VECTOR2D& aPosition, bool aWarpView = true ) = 0;
277 
278 
284  bool ForcedCursorPosition() const
285  {
287  }
288 
294  virtual void ShowCursor( bool aEnabled );
295 
301  bool IsCursorShown() const;
302 
308  virtual void CaptureCursor( bool aEnabled )
309  {
310  m_settings.m_cursorCaptured = aEnabled;
311  }
312 
318  inline bool IsCursorPositionForced() const
319  {
321  }
322 
333  virtual void WarpCursor( const VECTOR2D& aPosition, bool aWorldCoordinates = false,
334  bool aWarpView = false ) = 0;
335 
341  void EnableCursorWarping( bool aEnable )
342  {
343  m_settings.m_warpCursor = aEnable;
344  }
345 
351  {
352  return m_settings.m_warpCursor;
353  }
354 
360  virtual void EnableMousewheelPan( bool aEnable )
361  {
363  }
364 
369  virtual bool IsMousewheelPanEnabled() const
370  {
372  }
373 
379  virtual void CenterOnCursor() const = 0;
380 
381  void SetAdditionalPanButtons( bool aLeft = false, bool aRight = false )
382  {
385  }
386 
391  virtual void Reset();
392 
394  const VC_SETTINGS& GetSettings() const
395  {
396  return m_settings;
397  }
398 
400  void ApplySettings( const VC_SETTINGS& aSettings );
401 
402 protected:
405 
408 
411 };
412 } // namespace KIGFX
413 
414 #endif
bool m_enableMousewheelPan
Mousewheel (2-finger touchpad) panning
Definition: view_controls.h:91
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
void Reset()
Restores the default settings
virtual void SetAutoPanSpeed(float aSpeed)
Function SetAutoPanSpeed() Sets speed of autopanning.
float m_autoPanSpeed
How fast is panning when in auto mode
Definition: view_controls.h:82
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Function GetMousePosition() Returns the current mouse pointer position.
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:131
bool m_snappingEnabled
Should the cursor snap to grid or move freely
Definition: view_controls.h:67
bool m_grabMouse
Flag for grabbing the mouse cursor
Definition: view_controls.h:70
void ApplySettings(const VC_SETTINGS &aSettings)
Applies VIEW_CONTROLS settings from an object
VIEW_CONTROLS(VIEW *aView)
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
virtual void EnableMousewheelPan(bool aEnable)
Function EnableMousewheelPan() Enables or disables mousewheel panning.
VECTOR2D m_forcedPosition
Forced cursor position (world coordinates)
Definition: view_controls.h:58
virtual void SetSnapping(bool aEnabled)
Function SetSnapping() Enables/disables snapping cursor to grid.
bool m_panWithRightButton
Allow panning with the right button in addition to middle
Definition: view_controls.h:94
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false, long aArrowCommand=0)=0
Moves cursor to the requested position expressed in world coordinates.
virtual void SetAutoPanMargin(float aMargin)
Function SetAutoPanMArgin() Sets margin for autopanning (ie.
VIEW * m_view
Pointer to controlled VIEW.
virtual void Reset()
Function Reset() Restores the default VIEW_CONTROLS settings.
const VC_SETTINGS & GetSettings() const
Returns the current VIEW_CONTROLS settings
virtual void CenterOnCursor() const =0
Function CenterOnCursor() Sets the viewport center to the current cursor position and warps the curso...
bool IsCursorPositionForced() const
Function IsCursorPositionForced() Returns true if the cursor position is set by one of the tools.
void EnableCursorWarping(bool aEnable)
Function EnableCursorWarping() Enables or disables warping the cursor.
VECTOR2D m_lastKeyboardCursorPosition
Position of the above event
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
Function WarpCursor() If enabled (.
bool m_autoPanSettingEnabled
Flag for turning on autopanning
Definition: view_controls.h:76
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
virtual void CaptureCursor(bool aEnabled)
Function CaptureCursor() Forces the cursor to stay within the drawing panel area.
virtual bool GetSnappingState()
float m_autoPanAcceleration
How fast does panning accelerate when approaching the window boundary
Definition: view_controls.h:85
Structure to keep VIEW_CONTROLS settings for easy store/restore operations
Definition: view_controls.h:44
bool IsCursorWarpingEnabled() const
Function IsCursorWarpingEnabled()
VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (such a...
bool m_warpCursor
If the cursor is allowed to be warped
Definition: view_controls.h:88
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
virtual void EnableAutoPan(bool aEnabled)
Function EnableAutoPan Turns on/off auto panning (user setting to disable it entirely).
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.
float m_autoPanMargin
Distance from cursor to VIEW edge when panning is active
Definition: view_controls.h:79
bool m_cursorWarped
Application warped the cursor, not the user (keyboard)
bool ForcedCursorPosition() const
Function ForcedCursorPosition() Returns true if the current cursor position is forced to a specific l...
bool m_autoPanEnabled
Flag for turning on autopanning
Definition: view_controls.h:73
virtual void SetAutoPan(bool aEnabled)
Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg.
void SetAdditionalPanButtons(bool aLeft=false, bool aRight=false)
virtual void SetAutoPanAcceleration(float aAcceleration)
Function SetAutoPanSpeed() Sets speed of autopanning.
bool m_showCursor
Flag determining the cursor visibility
Definition: view_controls.h:55
virtual VECTOR2D GetRawCursorPosition(bool aSnappingEnabled=true) const =0
Returns the current cursor position in world coordinates - ingoring the cursorUp position force mode.
bool IsCursorShown() const
Function IsCursorShown() Returns true when cursor is visible.
virtual bool IsMousewheelPanEnabled() const
Function IsMousewheelPanEnabled()
long m_lastKeyboardCursorCommand
ACTIONS::CURSOR_UP, ACTIONS::CURSOR_DOWN, etc.
bool m_lastKeyboardCursorPositionValid
Is last cursor motion event coming from keyboard arrow cursor motion action
virtual void SetGrabMouse(bool aEnabled)
Function SetGrabMouse Turns on/off mouse grabbing.
VIEW.
Definition: view.h:61
bool m_cursorCaptured
Should the cursor be locked within the parent window area
Definition: view_controls.h:64
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
bool m_panWithLeftButton
Allow panning with the left button in addition to middle
Definition: view_controls.h:97