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-2016 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 };
93 
94 
101 {
102 public:
103  VIEW_CONTROLS( VIEW* aView ) : m_view( aView )
104  {
105  }
106 
107  virtual ~VIEW_CONTROLS()
108  {
109  }
110 
117  virtual void SetSnapping( bool aEnabled )
118  {
119  m_settings.m_snappingEnabled = aEnabled;
120  }
121 
127  virtual void SetGrabMouse( bool aEnabled )
128  {
129  m_settings.m_grabMouse = aEnabled;
130  }
131 
138  virtual void SetAutoPan( bool aEnabled )
139  {
140  m_settings.m_autoPanEnabled = aEnabled;
141  }
142 
148  virtual void SetAutoPanSpeed( float aSpeed )
149  {
150  m_settings.m_autoPanSpeed = aSpeed;
151  }
152 
158  virtual void SetAutoPanMargin( float aMargin )
159  {
160  m_settings.m_autoPanMargin = aMargin;
161  }
162 
172  virtual VECTOR2D GetMousePosition( bool aWorldCoordinates = true ) const = 0;
173 
182  {
184  }
185 
194  virtual VECTOR2D GetCursorPosition( bool aEnableSnapping ) const = 0;
195 
202  virtual void ForceCursorPosition( bool aEnabled, const VECTOR2D& aPosition = VECTOR2D( 0, 0 ) )
203  {
205  m_settings.m_forcedPosition = aPosition;
206  }
207 
215  virtual void SetCursorPosition( const VECTOR2D& aPosition, bool aWarpView = true ) = 0;
216 
222  bool ForcedCursorPosition() const
223  {
225  }
226 
232  virtual void ShowCursor( bool aEnabled );
233 
239  bool IsCursorShown() const;
240 
246  virtual void CaptureCursor( bool aEnabled )
247  {
248  m_settings.m_cursorCaptured = aEnabled;
249  }
250 
256  inline bool IsCursorPositionForced() const
257  {
259  }
260 
271  virtual void WarpCursor( const VECTOR2D& aPosition, bool aWorldCoordinates = false,
272  bool aWarpView = false ) const = 0;
273 
279  void EnableCursorWarping( bool aEnable )
280  {
281  m_settings.m_warpCursor = aEnable;
282  }
283 
289  {
290  return m_settings.m_warpCursor;
291  }
292 
298  virtual void EnableMousewheelPan( bool aEnable )
299  {
301  }
302 
307  virtual bool IsMousewheelPanEnabled() const
308  {
310  }
311 
317  virtual void CenterOnCursor() const = 0;
318 
319  void SetAdditionalPanButtons( bool aLeft = false, bool aRight = false )
320  {
323  }
324 
329  virtual void Reset();
330 
332  const VC_SETTINGS& GetSettings() const
333  {
334  return m_settings;
335  }
336 
338  void ApplySettings( const VC_SETTINGS& aSettings );
339 
340 protected:
343 
346 };
347 } // namespace KIGFX
348 
349 #endif
bool m_enableMousewheelPan
Mousewheel (2-finger touchpad) panning
Definition: view_controls.h:85
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:79
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: class_module.h:58
bool m_snappingEnabled
Should the cursor snap to grid or move freely
Definition: view_controls.h:67
bool IsCursorPositionForced() const
Function IsCursorPositionForced() Returns true if the cursor position is set by one of the tools...
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:88
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.
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves cursor to the requested position expressed in world coordinates.
virtual void CenterOnCursor() const =0
Function CenterOnCursor() Sets the viewport center to the current cursor position and warps the curso...
void EnableCursorWarping(bool aEnable)
Function EnableCursorWarping() Enables or disables warping the cursor.
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false) const =0
Function WarpCursor() If enabled (.
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
VECTOR2< double > VECTOR2D
Definition: vector2d.h:589
virtual void CaptureCursor(bool aEnabled)
Function CaptureCursor() Forces the cursor to stay within the drawing panel area. ...
virtual bool IsMousewheelPanEnabled() const
Function IsMousewheelPanEnabled()
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
bool IsCursorShown() const
Function IsCursorShown() Returns true when cursor is visible.
Structure to keep VIEW_CONTROLS settings for easy store/restore operations
Definition: view_controls.h:44
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
bool m_warpCursor
If the cursor is allowed to be warped
Definition: view_controls.h:82
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
float m_autoPanMargin
Distance from cursor to VIEW edge when panning is active
Definition: view_controls.h:76
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...
const VC_SETTINGS & GetSettings() const
Returns the current VIEW_CONTROLS settings
void SetAdditionalPanButtons(bool aLeft=false, bool aRight=false)
bool m_showCursor
Flag determining the cursor visibility
Definition: view_controls.h:55
bool IsCursorWarpingEnabled() const
Function IsCursorWarpingEnabled()
virtual void SetGrabMouse(bool aEnabled)
Function SetGrabMouse Turns on/off mouse grabbing.
bool ForcedCursorPosition() const
Function ForcedCursorPosition() Returns true if the current cursor position is forced to a specific l...
Class VIEW.
Definition: view.h:58
bool m_cursorCaptured
Should the cursor be locked within the parent window area
Definition: view_controls.h:64
bool m_panWithLeftButton
Allow panning with the left button in addition to middle
Definition: view_controls.h:91