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 };
87 
88 
95 {
96 public:
97  VIEW_CONTROLS( VIEW* aView ) : m_view( aView )
98  {
99  }
100 
101  virtual ~VIEW_CONTROLS()
102  {
103  }
104 
111  virtual void SetSnapping( bool aEnabled )
112  {
113  m_settings.m_snappingEnabled = aEnabled;
114  }
115 
121  virtual void SetGrabMouse( bool aEnabled )
122  {
123  m_settings.m_grabMouse = aEnabled;
124  }
125 
132  virtual void SetAutoPan( bool aEnabled )
133  {
134  m_settings.m_autoPanEnabled = aEnabled;
135  }
136 
142  virtual void SetAutoPanSpeed( float aSpeed )
143  {
144  m_settings.m_autoPanSpeed = aSpeed;
145  }
146 
152  virtual void SetAutoPanMargin( float aMargin )
153  {
154  m_settings.m_autoPanMargin = aMargin;
155  }
156 
164  virtual VECTOR2I GetMousePosition() const = 0;
165 
174  virtual VECTOR2D GetCursorPosition() const = 0;
175 
182  virtual void ForceCursorPosition( bool aEnabled, const VECTOR2D& aPosition = VECTOR2D( 0, 0 ) )
183  {
185  m_settings.m_forcedPosition = aPosition;
186  }
187 
193  bool ForcedCursorPosition() const
194  {
196  }
197 
203  virtual void ShowCursor( bool aEnabled );
204 
210  bool IsCursorShown() const;
211 
217  virtual void CaptureCursor( bool aEnabled )
218  {
219  m_settings.m_cursorCaptured = aEnabled;
220  }
221 
227  inline bool IsCursorPositionForced() const
228  {
230  }
231 
242  virtual void WarpCursor( const VECTOR2D& aPosition, bool aWorldCoordinates = false,
243  bool aWarpView = false ) const = 0;
244 
250  void EnableCursorWarping( bool aEnable )
251  {
252  m_settings.m_warpCursor = aEnable;
253  }
254 
260  {
261  return m_settings.m_warpCursor;
262  }
263 
269  virtual void EnableMousewheelPan( bool aEnable )
270  {
272  }
273 
278  virtual bool IsMousewheelPanEnabled() const
279  {
281  }
282 
288  virtual void CenterOnCursor() const = 0;
289 
294  virtual void Reset();
295 
297  const VC_SETTINGS& GetSettings() const
298  {
299  return m_settings;
300  }
301 
303  void ApplySettings( const VC_SETTINGS& aSettings );
304 
305 protected:
308 
311 };
312 } // namespace KIGFX
313 
314 #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
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: class_module.h:56
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)
Definition: view_controls.h:97
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.
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 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:579
virtual VECTOR2D GetCursorPosition() const =0
Function GetCursorPosition() Returns the current cursor position in world coordinates.
virtual void CaptureCursor(bool aEnabled)
Function CaptureCursor() Forces the cursor to stay within the drawing panel area. ...
virtual bool IsMousewheelPanEnabled() const
Function IsMousewheelPanEnabled() Returns the current setting for mousewheel panning.
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 (...
Definition: view_controls.h:94
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
bool m_showCursor
Flag determining the cursor visibility
Definition: view_controls.h:55
bool IsCursorWarpingEnabled() const
Function IsCursorWarpingEnabled() Returns the current setting for cursor warping. ...
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
virtual VECTOR2I GetMousePosition() const =0
Function GetMousePosition() Returns the current mouse pointer position in screen coordinates.