KiCad PCB EDA Suite
KIGFX::WX_VIEW_CONTROLS Class Reference

Class WX_VIEW_CONTROLS is a specific implementation of class VIEW_CONTROLS for wxWidgets library. More...

#include <wx_view_controls.h>

Inheritance diagram for KIGFX::WX_VIEW_CONTROLS:
KIGFX::VIEW_CONTROLS

Public Member Functions

 WX_VIEW_CONTROLS (VIEW *aView, wxScrolledCanvas *aParentPanel)
 
virtual ~WX_VIEW_CONTROLS ()
 
void onWheel (wxMouseEvent &aEvent)
 Handler functions. More...
 
void onMotion (wxMouseEvent &aEvent)
 
void onButton (wxMouseEvent &aEvent)
 
void onEnter (wxMouseEvent &WXUNUSED(aEvent))
 
void onLeave (wxMouseEvent &WXUNUSED(aEvent))
 
void onTimer (wxTimerEvent &WXUNUSED(aEvent))
 
void onScroll (wxScrollWinEvent &aEvent)
 
void SetGrabMouse (bool aEnabled) override
 Function SetGrabMouse() Enables/disables mouse cursor grabbing (limits the movement field only to the panel area). More...
 
VECTOR2D GetMousePosition (bool aWorldCoordinates=true) const override
 Function GetMousePosition() Returns the current mouse pointer position. More...
 
VECTOR2D GetCursorPosition (bool aSnappingEnabled) const override
 Returns the current cursor position in world coordinates. More...
 
VECTOR2D GetRawCursorPosition (bool aSnappingEnabled=true) const override
 Returns the current cursor position in world coordinates - ingoring the cursorUp position force mode. More...
 
void SetCursorPosition (const VECTOR2D &aPosition, bool warpView) override
 Moves cursor to the requested position expressed in world coordinates. More...
 
void SetCrossHairCursorPosition (const VECTOR2D &aPosition, bool aWarpView) override
 Moves the graphic crosshair cursor to the requested position expressed in world coordinates. More...
 
void WarpCursor (const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false) override
 
void CenterOnCursor () const override
 Function CenterOnCursor() Sets the viewport center to the current cursor position and warps the cursor to the screen center. More...
 
void UpdateScrollbars ()
 Adjusts the scrollbars position to match the current viewport. More...
 
virtual void SetSnapping (bool aEnabled)
 Function SetSnapping() Enables/disables snapping cursor to grid. More...
 
virtual void SetAutoPan (bool aEnabled)
 Function SetAutoPan Turns on/off auto panning (this feature is used when there is a tool active (eg. More...
 
virtual void EnableAutoPan (bool aEnabled)
 Function EnableAutoPan Turns on/off auto panning (user setting to disable it entirely). More...
 
virtual void SetAutoPanSpeed (float aSpeed)
 Function SetAutoPanSpeed() Sets speed of autopanning. More...
 
virtual void SetAutoPanMargin (float aMargin)
 Function SetAutoPanMArgin() Sets margin for autopanning (ie. More...
 
VECTOR2D GetCursorPosition () const
 Returns the current cursor position in world coordinates. More...
 
virtual void ForceCursorPosition (bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
 Function ForceCursorPosition() Places the cursor immediately at a given point. More...
 
bool ForcedCursorPosition () const
 Function ForcedCursorPosition() Returns true if the current cursor position is forced to a specific location, ignoring the mouse cursor position. More...
 
virtual void ShowCursor (bool aEnabled)
 Function ShowCursor() Enables or disables display of cursor. More...
 
bool IsCursorShown () const
 Function IsCursorShown() Returns true when cursor is visible. More...
 
virtual void CaptureCursor (bool aEnabled)
 Function CaptureCursor() Forces the cursor to stay within the drawing panel area. More...
 
bool IsCursorPositionForced () const
 Function IsCursorPositionForced() Returns true if the cursor position is set by one of the tools. More...
 
void EnableCursorWarping (bool aEnable)
 Function EnableCursorWarping() Enables or disables warping the cursor. More...
 
bool IsCursorWarpingEnabled () const
 Function IsCursorWarpingEnabled() More...
 
virtual void EnableMousewheelPan (bool aEnable)
 Function EnableMousewheelPan() Enables or disables mousewheel panning. More...
 
virtual bool IsMousewheelPanEnabled () const
 Function IsMousewheelPanEnabled() More...
 
void SetAdditionalPanButtons (bool aLeft=false, bool aRight=false)
 
virtual void Reset ()
 Function Reset() Restores the default VIEW_CONTROLS settings. More...
 
const VC_SETTINGSGetSettings () const
 

Returns the current VIEW_CONTROLS settings

More...
 
void ApplySettings (const VC_SETTINGS &aSettings)
 

Applies VIEW_CONTROLS settings from an object

More...
 

Static Public Attributes

static const wxEventType EVT_REFRESH_MOUSE = wxNewEventType()
 Event that forces mouse move event in the dispatcher (eg. More...
 

Protected Attributes

VIEWm_view
 

Pointer to controlled VIEW.

More...
 
VC_SETTINGS m_settings
 

Current VIEW_CONTROLS settings

More...
 

Private Types

enum  STATE { IDLE = 1, DRAG_PANNING, AUTO_PANNING }
 Possible states for WX_VIEW_CONTROLS. More...
 

Private Member Functions

bool handleAutoPanning (const wxMouseEvent &aEvent)
 Function handleAutoPanning() Computes new viewport settings while in autopanning mode. More...
 
void refreshMouse ()
 Sends an event to refresh mouse position. More...
 
wxPoint getMouseScreenPosition () const
 Gets the cursor position in the screen coordinates. More...
 

Private Attributes

STATE m_state
 Current state of VIEW_CONTROLS. More...
 
wxScrolledCanvas * m_parentPanel
 Panel that is affected by VIEW_CONTROLS. More...
 
VECTOR2D m_dragStartPoint
 Stores information about point where dragging has started. More...
 
VECTOR2D m_lookStartPoint
 Stores information about the center of viewport when dragging has started. More...
 
VECTOR2D m_panDirection
 Current direction of panning (only autopanning mode) More...
 
wxLongLong m_timeStamp
 Used for determining time intervals between scroll & zoom events. More...
 
wxTimer m_panTimer
 Timer repsonsible for handling autopanning. More...
 
VECTOR2D m_scrollScale
 Ratio used for scaling world coordinates to scrollbar position. More...
 
VECTOR2I m_scrollPos
 Current scrollbar position. More...
 
VECTOR2D m_cursorPos
 Current cursor position (world coordinates) More...
 
bool m_updateCursor
 Flag deciding whether the cursor position should be calculated using the mouse position. More...
 

Detailed Description

Class WX_VIEW_CONTROLS is a specific implementation of class VIEW_CONTROLS for wxWidgets library.

Definition at line 46 of file wx_view_controls.h.

Member Enumeration Documentation

Possible states for WX_VIEW_CONTROLS.

Enumerator
IDLE 
DRAG_PANNING 

Nothing is happening.

AUTO_PANNING 

Panning with mouse button pressed.

Definition at line 105 of file wx_view_controls.h.

106  {
107  IDLE = 1,
108  DRAG_PANNING,
109  AUTO_PANNING,
110  };
Panning with mouse button pressed.

Constructor & Destructor Documentation

WX_VIEW_CONTROLS::WX_VIEW_CONTROLS ( VIEW aView,
wxScrolledCanvas *  aParentPanel 
)

Definition at line 38 of file wx_view_controls.cpp.

References m_panTimer, m_parentPanel, onButton(), onEnter(), onLeave(), onMotion(), onScroll(), onTimer(), and onWheel().

38  :
39  VIEW_CONTROLS( aView ), m_state( IDLE ), m_parentPanel( aParentPanel ),
40  m_scrollScale( 1.0, 1.0 ), m_cursorPos( 0, 0 ), m_updateCursor( true )
41 {
42  m_parentPanel->Connect( wxEVT_MOTION,
43  wxMouseEventHandler( WX_VIEW_CONTROLS::onMotion ), NULL, this );
44 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
45  m_parentPanel->Connect( wxEVT_MAGNIFY,
46  wxMouseEventHandler( WX_VIEW_CONTROLS::onMagnify ), NULL, this );
47 #endif
48  m_parentPanel->Connect( wxEVT_MOUSEWHEEL,
49  wxMouseEventHandler( WX_VIEW_CONTROLS::onWheel ), NULL, this );
50  m_parentPanel->Connect( wxEVT_MIDDLE_UP,
51  wxMouseEventHandler( WX_VIEW_CONTROLS::onButton ), NULL, this );
52  m_parentPanel->Connect( wxEVT_MIDDLE_DOWN,
53  wxMouseEventHandler( WX_VIEW_CONTROLS::onButton ), NULL, this );
54  m_parentPanel->Connect( wxEVT_LEFT_UP,
55  wxMouseEventHandler( WX_VIEW_CONTROLS::onButton ), NULL, this );
56  m_parentPanel->Connect( wxEVT_LEFT_DOWN,
57  wxMouseEventHandler( WX_VIEW_CONTROLS::onButton ), NULL, this );
58  m_parentPanel->Connect( wxEVT_RIGHT_UP,
59  wxMouseEventHandler( WX_VIEW_CONTROLS::onButton ), NULL, this );
60  m_parentPanel->Connect( wxEVT_RIGHT_DOWN,
61  wxMouseEventHandler( WX_VIEW_CONTROLS::onButton ), NULL, this );
62 #if defined _WIN32 || defined _WIN64
63  m_parentPanel->Connect( wxEVT_ENTER_WINDOW,
64  wxMouseEventHandler( WX_VIEW_CONTROLS::onEnter ), NULL, this );
65 #endif
66  m_parentPanel->Connect( wxEVT_LEAVE_WINDOW,
67  wxMouseEventHandler( WX_VIEW_CONTROLS::onLeave ), NULL, this );
68  m_parentPanel->Connect( wxEVT_SCROLLWIN_THUMBTRACK,
69  wxScrollWinEventHandler( WX_VIEW_CONTROLS::onScroll ), NULL, this );
70  m_parentPanel->Connect( wxEVT_SCROLLWIN_PAGEUP,
71  wxScrollWinEventHandler( WX_VIEW_CONTROLS::onScroll ), NULL, this );
72  m_parentPanel->Connect( wxEVT_SCROLLWIN_PAGEDOWN,
73  wxScrollWinEventHandler( WX_VIEW_CONTROLS::onScroll ), NULL, this );
74 
75  m_panTimer.SetOwner( this );
76  this->Connect( wxEVT_TIMER,
77  wxTimerEventHandler( WX_VIEW_CONTROLS::onTimer ), NULL, this );
78 }
VIEW_CONTROLS(VIEW *aView)
void onButton(wxMouseEvent &aEvent)
VECTOR2D m_scrollScale
Ratio used for scaling world coordinates to scrollbar position.
void onWheel(wxMouseEvent &aEvent)
Handler functions.
void onMotion(wxMouseEvent &aEvent)
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
void onTimer(wxTimerEvent &WXUNUSED(aEvent))
bool m_updateCursor
Flag deciding whether the cursor position should be calculated using the mouse position.
void onEnter(wxMouseEvent &WXUNUSED(aEvent))
STATE m_state
Current state of VIEW_CONTROLS.
void onScroll(wxScrollWinEvent &aEvent)
void onLeave(wxMouseEvent &WXUNUSED(aEvent))
VECTOR2D m_cursorPos
Current cursor position (world coordinates)
wxTimer m_panTimer
Timer repsonsible for handling autopanning.

Member Function Documentation

void VIEW_CONTROLS::ApplySettings ( const VC_SETTINGS aSettings)
inherited

Applies VIEW_CONTROLS settings from an object

Definition at line 75 of file view_controls.cpp.

References KIGFX::VIEW_CONTROLS::CaptureCursor(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), KIGFX::VC_SETTINGS::m_autoPanEnabled, KIGFX::VC_SETTINGS::m_autoPanMargin, KIGFX::VC_SETTINGS::m_autoPanSpeed, KIGFX::VC_SETTINGS::m_cursorCaptured, KIGFX::VC_SETTINGS::m_forceCursorPosition, KIGFX::VC_SETTINGS::m_forcedPosition, KIGFX::VC_SETTINGS::m_grabMouse, KIGFX::VC_SETTINGS::m_showCursor, KIGFX::VC_SETTINGS::m_snappingEnabled, KIGFX::VIEW_CONTROLS::SetAutoPan(), KIGFX::VIEW_CONTROLS::SetAutoPanMargin(), KIGFX::VIEW_CONTROLS::SetAutoPanSpeed(), KIGFX::VIEW_CONTROLS::SetGrabMouse(), KIGFX::VIEW_CONTROLS::SetSnapping(), and KIGFX::VIEW_CONTROLS::ShowCursor().

Referenced by TOOL_MANAGER::applyViewControls(), and KIGFX::VIEW_CONTROLS::Reset().

76 {
77  ShowCursor( aSettings.m_showCursor );
78  CaptureCursor( aSettings.m_cursorCaptured );
79  SetSnapping( aSettings.m_snappingEnabled );
80  SetGrabMouse( aSettings.m_grabMouse );
81  SetAutoPan( aSettings.m_autoPanEnabled );
82  SetAutoPanMargin( aSettings.m_autoPanMargin );
83  SetAutoPanSpeed( aSettings.m_autoPanSpeed );
85 }
virtual void ShowCursor(bool aEnabled)
Function ShowCursor() Enables or disables display of cursor.
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
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
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.
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
virtual void CaptureCursor(bool aEnabled)
Function CaptureCursor() Forces the cursor to stay within the drawing panel area. ...
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:79
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...
bool m_showCursor
Flag determining the cursor visibility
Definition: view_controls.h:55
virtual void SetGrabMouse(bool aEnabled)
Function SetGrabMouse Turns on/off mouse grabbing.
bool m_cursorCaptured
Should the cursor be locked within the parent window area
Definition: view_controls.h:64
virtual void KIGFX::VIEW_CONTROLS::CaptureCursor ( bool  aEnabled)
inlinevirtualinherited

Function CaptureCursor() Forces the cursor to stay within the drawing panel area.

Parameters
aEnableddetermines if the cursor should be captured.

Definition at line 276 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), EDIT_TOOL::MeasureTool(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::runPolygonEventLoop(), DRAWING_TOOL::SetAnchor(), and PICKER_TOOL::setControls().

277  {
278  m_settings.m_cursorCaptured = aEnabled;
279  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool m_cursorCaptured
Should the cursor be locked within the parent window area
Definition: view_controls.h:64
void WX_VIEW_CONTROLS::CenterOnCursor ( ) const
overridevirtual

Function CenterOnCursor() Sets the viewport center to the current cursor position and warps the cursor to the screen center.

Implements KIGFX::VIEW_CONTROLS.

Definition at line 502 of file wx_view_controls.cpp.

References KIGFX::VIEW_CONTROLS::GetCursorPosition(), KIGFX::VIEW::GetGAL(), GetMousePosition(), KIGFX::GAL::GetScreenPixelSize(), KiROUND(), m_parentPanel, KIGFX::VIEW_CONTROLS::m_view, KIGFX::VIEW::SetCenter(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by onWheel(), and ~WX_VIEW_CONTROLS().

503 {
504  const VECTOR2I& screenSize = m_view->GetGAL()->GetScreenPixelSize();
505  VECTOR2I screenCenter( screenSize / 2 );
506 
507  if( GetMousePosition( false ) != screenCenter )
508  {
510  m_parentPanel->WarpPointer( KiROUND( screenSize.x / 2 ), KiROUND( screenSize.y / 2 ) );
511  }
512 }
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:120
VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const override
Function GetMousePosition() Returns the current mouse pointer position.
VIEW * m_view
Pointer to controlled VIEW.
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:587
GAL * GetGAL() const
Function GetGAL() Returns the GAL this view is using to draw graphical primitives.
Definition: view.h:177
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
virtual void KIGFX::VIEW_CONTROLS::EnableAutoPan ( bool  aEnabled)
inlinevirtualinherited

Function EnableAutoPan Turns on/off auto panning (user setting to disable it entirely).

Parameters
aEnabledtells if the autopanning should be enabled.

Definition at line 151 of file view_controls.h.

Referenced by EDA_DRAW_PANEL::SetEnableAutoPan(), and EDA_DRAW_FRAME::UseGalCanvas().

152  {
154  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool m_autoPanSettingEnabled
Flag for turning on autopanning
Definition: view_controls.h:76
void KIGFX::VIEW_CONTROLS::EnableCursorWarping ( bool  aEnable)
inlineinherited

Function EnableCursorWarping() Enables or disables warping the cursor.

Parameters
aEnableis true if the cursor is allowed to be warped.

Definition at line 309 of file view_controls.h.

Referenced by EDA_DRAW_PANEL::SetEnableZoomNoCenter(), and EDA_DRAW_FRAME::UseGalCanvas().

310  {
311  m_settings.m_warpCursor = aEnable;
312  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool m_warpCursor
If the cursor is allowed to be warped
Definition: view_controls.h:85
virtual void KIGFX::VIEW_CONTROLS::EnableMousewheelPan ( bool  aEnable)
inlinevirtualinherited

Function EnableMousewheelPan() Enables or disables mousewheel panning.

Parameters
aEnableis true if mouse-wheel panning is enabled.

Definition at line 328 of file view_controls.h.

Referenced by DIALOG_PAD_PROPERTIES::prepareCanvas(), EDA_DRAW_PANEL::SetEnableMousewheelPan(), and EDA_DRAW_FRAME::UseGalCanvas().

329  {
331  }
bool m_enableMousewheelPan
Mousewheel (2-finger touchpad) panning
Definition: view_controls.h:88
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
virtual void KIGFX::VIEW_CONTROLS::ForceCursorPosition ( bool  aEnabled,
const VECTOR2D aPosition = VECTOR2D( 0, 0 ) 
)
inlinevirtualinherited

Function ForceCursorPosition() Places the cursor immediately at a given point.

Mouse movement is ignored.

Parameters
aEnabledenable forced cursor position
aPositionthe position (world coordinates).

Definition at line 223 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), TOOL_MANAGER::dispatchContextMenu(), SELECTION_TOOL::findMove(), ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::InlineDrag(), PICKER_TOOL::Main(), EDIT_TOOL::Main(), ROUTER_TOOL::mainLoop(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), LENGTH_TUNER_TOOL::performTuning(), ROUTER_TOOL::prepareInteractive(), POINT_EDITOR::setEditedPoint(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

224  {
226  m_settings.m_forcedPosition = aPosition;
227  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
VECTOR2D m_forcedPosition
Forced cursor position (world coordinates)
Definition: view_controls.h:58
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
bool KIGFX::VIEW_CONTROLS::ForcedCursorPosition ( ) const
inlineinherited

Function ForcedCursorPosition() Returns true if the current cursor position is forced to a specific location, ignoring the mouse cursor position.

Definition at line 252 of file view_controls.h.

253  {
255  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
VECTOR2D WX_VIEW_CONTROLS::GetCursorPosition ( bool  aSnappingEnabled) const
overridevirtual

Returns the current cursor position in world coordinates.

Note, that it may be different from the mouse pointer position if snapping is enabled or cursor position is forced to a specific point.

Returns
The current cursor position in world coordinates.

Implements KIGFX::VIEW_CONTROLS.

Definition at line 433 of file wx_view_controls.cpp.

References GetRawCursorPosition(), KIGFX::VC_SETTINGS::m_forceCursorPosition, KIGFX::VC_SETTINGS::m_forcedPosition, and KIGFX::VIEW_CONTROLS::m_settings.

Referenced by EDA_DRAW_PANEL_GAL::onPaint().

434 {
436  {
438  }
439  else
440  {
441  return GetRawCursorPosition( aEnableSnapping );
442  }
443 }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
VECTOR2D m_forcedPosition
Forced cursor position (world coordinates)
Definition: view_controls.h:58
VECTOR2D GetRawCursorPosition(bool aSnappingEnabled=true) const override
Returns the current cursor position in world coordinates - ingoring the cursorUp position force mode...
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
VECTOR2D KIGFX::VIEW_CONTROLS::GetCursorPosition ( ) const
inlineinherited

Returns the current cursor position in world coordinates.

Note, that it may be different from the mouse pointer position if snapping is enabled or cursor position is forced to a specific point.

Returns
The current cursor position in world coordinates.

Definition at line 194 of file view_controls.h.

Referenced by POINT_EDITOR::addCorner(), CenterOnCursor(), TOOL_MANAGER::dispatchContextMenu(), PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), MODULE_EDITOR_TOOLS::EnumeratePads(), SELECTION_TOOL::findMove(), EDA_DRAW_FRAME::GetCrossHairPosition(), ROUTER_TOOL::InlineDrag(), EDIT_TOOL::Main(), ROUTER_TOOL::mainLoop(), DRAWING_TOOL::make45DegLine(), EDIT_TOOL::MeasureTool(), POINT_EDITOR::OnSelectionChange(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), CVPCB_CONTROL::ResetCoords(), GERBVIEW_CONTROL::ResetCoords(), PCBNEW_CONTROL::ResetCoords(), DRAWING_TOOL::runPolygonEventLoop(), DRAWING_TOOL::SetAnchor(), PNS::TOOL_BASE::updateEndItem(), EDIT_TOOL::updateModificationPoint(), PNS::TOOL_BASE::updateStartItem(), and ~WX_VIEW_CONTROLS().

195  {
197  }
bool m_snappingEnabled
Should the cursor snap to grid or move freely
Definition: view_controls.h:67
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
VECTOR2D WX_VIEW_CONTROLS::GetMousePosition ( bool  aWorldCoordinates = true) const
overridevirtual

Function GetMousePosition() Returns the current mouse pointer position.

Note, that it may be different from the cursor position if snapping is enabled (

See also
GetCursorPosition()).
Parameters
aWorldCoordinatesif true, the result is given in world coordinates, otherwise it is given in screen coordinates.
Returns
The current mouse pointer position in either world or screen coordinates.

Implements KIGFX::VIEW_CONTROLS.

Definition at line 411 of file wx_view_controls.cpp.

References getMouseScreenPosition(), KIGFX::VIEW_CONTROLS::m_view, KIGFX::VIEW::ToWorld(), wxPoint::x, and wxPoint::y.

Referenced by CenterOnCursor(), and ~WX_VIEW_CONTROLS().

412 {
414  VECTOR2D screenPos( msp.x, msp.y );
415 
416  return aWorldCoordinates ? m_view->ToWorld( screenPos ) : screenPos;
417 }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:463
Class VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
VIEW * m_view
Pointer to controlled VIEW.
wxPoint getMouseScreenPosition() const
Gets the cursor position in the screen coordinates.
wxPoint WX_VIEW_CONTROLS::getMouseScreenPosition ( ) const
private

Gets the cursor position in the screen coordinates.

Definition at line 601 of file wx_view_controls.cpp.

References m_parentPanel, wxPoint::x, and wxPoint::y.

Referenced by GetMousePosition(), and refreshMouse().

602 {
603  wxPoint msp = wxGetMousePosition();
604  m_parentPanel->ScreenToClient( &msp.x, &msp.y );
605  return msp;
606 }
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
VECTOR2D WX_VIEW_CONTROLS::GetRawCursorPosition ( bool  aSnappingEnabled = true) const
overridevirtual

Returns the current cursor position in world coordinates - ingoring the cursorUp position force mode.

Returns
The current cursor position in world coordinates.

Implements KIGFX::VIEW_CONTROLS.

Definition at line 420 of file wx_view_controls.cpp.

References KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetGridPoint(), m_cursorPos, and KIGFX::VIEW_CONTROLS::m_view.

Referenced by GetCursorPosition(), and ~WX_VIEW_CONTROLS().

421 {
422  if( aEnableSnapping )
423  {
424  return m_view->GetGAL()->GetGridPoint( m_cursorPos );
425  }
426  else
427  {
428  return m_cursorPos;
429  }
430 }
VIEW * m_view
Pointer to controlled VIEW.
GAL * GetGAL() const
Function GetGAL() Returns the GAL this view is using to draw graphical primitives.
Definition: view.h:177
VECTOR2D GetGridPoint(const VECTOR2D &aPoint) const
Function GetGridPoint() For a given point it returns the nearest point belonging to the grid in world...
VECTOR2D m_cursorPos
Current cursor position (world coordinates)
const VC_SETTINGS& KIGFX::VIEW_CONTROLS::GetSettings ( ) const
inlineinherited

Returns the current VIEW_CONTROLS settings

Definition at line 362 of file view_controls.h.

Referenced by TOOL_MANAGER::GetCurrentToolVC(), and TOOL_MANAGER::saveViewControls().

363  {
364  return m_settings;
365  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool WX_VIEW_CONTROLS::handleAutoPanning ( const wxMouseEvent &  aEvent)
private

Function handleAutoPanning() Computes new viewport settings while in autopanning mode.

Parameters
aEventis an event to be processed and decide if autopanning should happen.
Returns
true if it is currently autopanning (ie. autopanning is active and mouse cursor is in the area that causes autopanning to happen).

Definition at line 515 of file wx_view_controls.cpp.

References AUTO_PANNING, DRAG_PANNING, KIGFX::VIEW::GetScreenPixelSize(), IDLE, KIGFX::VC_SETTINGS::m_autoPanMargin, m_panDirection, m_panTimer, KIGFX::VIEW_CONTROLS::m_settings, m_state, KIGFX::VIEW_CONTROLS::m_view, min, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by onMotion().

516 {
517  VECTOR2D p( aEvent.GetX(), aEvent.GetY() );
518 
519  // Compute areas where autopanning is active
520  double borderStart = std::min( m_settings.m_autoPanMargin * m_view->GetScreenPixelSize().x,
522  double borderEndX = m_view->GetScreenPixelSize().x - borderStart;
523  double borderEndY = m_view->GetScreenPixelSize().y - borderStart;
524 
525  if( p.x < borderStart )
526  m_panDirection.x = -( borderStart - p.x );
527  else if( p.x > borderEndX )
528  m_panDirection.x = ( p.x - borderEndX );
529  else
530  m_panDirection.x = 0;
531 
532  if( p.y < borderStart )
533  m_panDirection.y = -( borderStart - p.y );
534  else if( p.y > borderEndY )
535  m_panDirection.y = ( p.y - borderEndY );
536  else
537  m_panDirection.y = 0;
538 
539  bool borderHit = ( m_panDirection.x != 0 || m_panDirection.y != 0 );
540 
541  switch( m_state )
542  {
543  case AUTO_PANNING:
544  if( !borderHit )
545  {
546  m_panTimer.Stop();
547  m_state = IDLE;
548 
549  return false;
550  }
551 
552  return true;
553  break;
554 
555  case IDLE:
556  if( borderHit )
557  {
559  m_panTimer.Start( (int) ( 250.0 / 60.0 ) );
560 
561  return true;
562  }
563 
564  return false;
565  break;
566 
567  case DRAG_PANNING:
568  return false;
569  }
570 
571  wxASSERT_MSG( false, wxT( "This line should never be reached" ) );
572  return false; // Should not be reached, just avoid the compiler warnings..
573 }
Class VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
VIEW * m_view
Pointer to controlled VIEW.
Panning with mouse button pressed.
float m_autoPanMargin
Distance from cursor to VIEW edge when panning is active
Definition: view_controls.h:79
VECTOR2D m_panDirection
Current direction of panning (only autopanning mode)
const VECTOR2I & GetScreenPixelSize() const
Function GetScreenPixelSize() Returns the size of the our rendering area, in pixels.
Definition: view.cpp:1147
STATE m_state
Current state of VIEW_CONTROLS.
#define min(a, b)
Definition: auxiliary.h:85
wxTimer m_panTimer
Timer repsonsible for handling autopanning.
bool KIGFX::VIEW_CONTROLS::IsCursorPositionForced ( ) const
inlineinherited

Function IsCursorPositionForced() Returns true if the cursor position is set by one of the tools.

Forced cursor position means it does not react to mouse movement.

Definition at line 286 of file view_controls.h.

287  {
289  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
bool VIEW_CONTROLS::IsCursorShown ( ) const
inherited

Function IsCursorShown() Returns true when cursor is visible.

Returns
True if cursor is visible.

Definition at line 40 of file view_controls.cpp.

References KIGFX::VIEW_CONTROLS::m_settings, and KIGFX::VC_SETTINGS::m_showCursor.

41 {
42  // this only says if the VIEW_CONTROLS say the cursor should be
43  // shown: m_view->GetGAL()->IsCursorEnabled() will say if the GAL is
44  // actually going to do show the cursor or not
45  return m_settings.m_showCursor;
46 }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool m_showCursor
Flag determining the cursor visibility
Definition: view_controls.h:55
bool KIGFX::VIEW_CONTROLS::IsCursorWarpingEnabled ( ) const
inlineinherited

Function IsCursorWarpingEnabled()

Returns
the current setting for cursor warping.

Definition at line 318 of file view_controls.h.

Referenced by onWheel().

319  {
320  return m_settings.m_warpCursor;
321  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool m_warpCursor
If the cursor is allowed to be warped
Definition: view_controls.h:85
virtual bool KIGFX::VIEW_CONTROLS::IsMousewheelPanEnabled ( ) const
inlinevirtualinherited

Function IsMousewheelPanEnabled()

Returns
the current setting for mousewheel panning

Definition at line 337 of file view_controls.h.

338  {
340  }
bool m_enableMousewheelPan
Mousewheel (2-finger touchpad) panning
Definition: view_controls.h:88
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
void WX_VIEW_CONTROLS::onButton ( wxMouseEvent &  aEvent)

Definition at line 225 of file wx_view_controls.cpp.

References AUTO_PANNING, DRAG_PANNING, KIGFX::VIEW::GetCenter(), IDLE, m_dragStartPoint, m_lookStartPoint, KIGFX::VC_SETTINGS::m_panWithLeftButton, KIGFX::VC_SETTINGS::m_panWithRightButton, KIGFX::VIEW_CONTROLS::m_settings, m_state, and KIGFX::VIEW_CONTROLS::m_view.

Referenced by WX_VIEW_CONTROLS(), and ~WX_VIEW_CONTROLS().

226 {
227  switch( m_state )
228  {
229  case IDLE:
230  case AUTO_PANNING:
231  if( aEvent.MiddleDown() ||
232  ( aEvent.LeftDown() && m_settings.m_panWithLeftButton ) ||
233  ( aEvent.RightDown() && m_settings.m_panWithRightButton ) )
234  {
235  m_dragStartPoint = VECTOR2D( aEvent.GetX(), aEvent.GetY() );
238  }
239 
240  if( aEvent.LeftUp() )
241  m_state = IDLE; // Stop autopanning when user release left mouse button
242 
243  break;
244 
245  case DRAG_PANNING:
246  if( aEvent.MiddleUp() || aEvent.LeftUp() || aEvent.RightUp() )
247  m_state = IDLE;
248 
249  break;
250  }
251 
252  aEvent.Skip();
253 }
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates) ...
Definition: view.h:325
VECTOR2D m_lookStartPoint
Stores information about the center of viewport when dragging has started.
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool m_panWithRightButton
Allow panning with the right button in addition to middle
Definition: view_controls.h:91
VIEW * m_view
Pointer to controlled VIEW.
Panning with mouse button pressed.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
VECTOR2D m_dragStartPoint
Stores information about point where dragging has started.
STATE m_state
Current state of VIEW_CONTROLS.
bool m_panWithLeftButton
Allow panning with the left button in addition to middle
Definition: view_controls.h:94
void WX_VIEW_CONTROLS::onEnter ( wxMouseEvent &  WXUNUSEDaEvent)

Definition at line 256 of file wx_view_controls.cpp.

References m_parentPanel.

Referenced by WX_VIEW_CONTROLS(), and ~WX_VIEW_CONTROLS().

257 {
258  m_parentPanel->SetFocus();
259 }
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
void WX_VIEW_CONTROLS::onLeave ( wxMouseEvent &  WXUNUSEDaEvent)

Definition at line 262 of file wx_view_controls.cpp.

References KIGFX::VC_SETTINGS::m_cursorCaptured, m_parentPanel, and KIGFX::VIEW_CONTROLS::m_settings.

Referenced by WX_VIEW_CONTROLS(), and ~WX_VIEW_CONTROLS().

263 {
265  {
266  bool warp = false;
267  int x = aEvent.GetX();
268  int y = aEvent.GetY();
269  wxSize parentSize = m_parentPanel->GetClientSize();
270 
271  if( x < 0 )
272  {
273  x = 0;
274  warp = true;
275  }
276  else if( x >= parentSize.x )
277  {
278  x = parentSize.x - 1;
279  warp = true;
280  }
281 
282  if( y < 0 )
283  {
284  y = 0;
285  warp = true;
286  }
287  else if( y >= parentSize.y )
288  {
289  y = parentSize.y - 1;
290  warp = true;
291  }
292 
293  if( warp )
294  m_parentPanel->WarpPointer( x, y );
295  }
296 }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
bool m_cursorCaptured
Should the cursor be locked within the parent window area
Definition: view_controls.h:64
void WX_VIEW_CONTROLS::onMotion ( wxMouseEvent &  aEvent)

Definition at line 81 of file wx_view_controls.cpp.

References delta, DRAG_PANNING, handleAutoPanning(), KIGFX::VC_SETTINGS::m_autoPanEnabled, KIGFX::VC_SETTINGS::m_autoPanSettingEnabled, m_cursorPos, m_dragStartPoint, m_lookStartPoint, KIGFX::VIEW_CONTROLS::m_settings, m_state, m_updateCursor, KIGFX::VIEW_CONTROLS::m_view, KIGFX::VIEW::SetCenter(), and KIGFX::VIEW::ToWorld().

Referenced by WX_VIEW_CONTROLS(), and ~WX_VIEW_CONTROLS().

82 {
83  bool isAutoPanning = false;
84  VECTOR2D mousePos( aEvent.GetX(), aEvent.GetY() );
85 
87  isAutoPanning = handleAutoPanning( aEvent );
88 
89  if( !isAutoPanning && aEvent.Dragging() )
90  {
91  if( m_state == DRAG_PANNING )
92  {
93  VECTOR2D d = m_dragStartPoint - mousePos;
94  VECTOR2D delta = m_view->ToWorld( d, false );
95 
96  m_view->SetCenter( m_lookStartPoint + delta );
97  aEvent.StopPropagation();
98  }
99  }
100 
101  if( m_updateCursor ) // do not update the cursor position if it was explicitly set
102  m_cursorPos = m_view->ToWorld( mousePos );
103  else
104  m_updateCursor = true;
105 
106  aEvent.Skip();
107 }
VECTOR2D m_lookStartPoint
Stores information about the center of viewport when dragging has started.
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:463
Class VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
VIEW * m_view
Pointer to controlled VIEW.
static const int delta[8][2]
Definition: solve.cpp:112
bool m_autoPanSettingEnabled
Flag for turning on autopanning
Definition: view_controls.h:76
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:587
bool m_autoPanEnabled
Flag for turning on autopanning
Definition: view_controls.h:73
bool m_updateCursor
Flag deciding whether the cursor position should be calculated using the mouse position.
bool handleAutoPanning(const wxMouseEvent &aEvent)
Function handleAutoPanning() Computes new viewport settings while in autopanning mode.
VECTOR2D m_dragStartPoint
Stores information about point where dragging has started.
STATE m_state
Current state of VIEW_CONTROLS.
VECTOR2D m_cursorPos
Current cursor position (world coordinates)
void WX_VIEW_CONTROLS::onScroll ( wxScrollWinEvent &  aEvent)

Definition at line 338 of file wx_view_controls.cpp.

References delta, dist, KIGFX::VIEW::GetBoundary(), KIGFX::VIEW::GetCenter(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), KIGFX::VIEW::GetScreenPixelSize(), BOX2< Vec >::GetTop(), KIGFX::VIEW::IsMirroredX(), m_parentPanel, m_scrollScale, KIGFX::VIEW_CONTROLS::m_view, KIGFX::VIEW::SetCenter(), KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by WX_VIEW_CONTROLS(), and ~WX_VIEW_CONTROLS().

339 {
340  const double linePanDelta = 0.05;
341  const double pagePanDelta = 0.5;
342 
343  int type = aEvent.GetEventType();
344  int dir = aEvent.GetOrientation();
345 
346  if( type == wxEVT_SCROLLWIN_THUMBTRACK )
347  {
348  VECTOR2D center = m_view->GetCenter();
349  const BOX2I& boundary = m_view->GetBoundary();
350 
351  // Flip scroll direction in flipped view
352  const double xstart = ( m_view->IsMirroredX() ?
353  boundary.GetRight() : boundary.GetLeft() );
354  const double xdelta = ( m_view->IsMirroredX() ? -1 : 1 );
355 
356  if( dir == wxHORIZONTAL )
357  center.x = xstart + xdelta * ( aEvent.GetPosition() / m_scrollScale.x );
358  else
359  center.y = boundary.GetTop() + aEvent.GetPosition() / m_scrollScale.y;
360 
361  m_view->SetCenter( center );
362  }
363  else
364  {
365  double dist = 0;
366 
367  if( type == wxEVT_SCROLLWIN_PAGEUP )
368  dist = pagePanDelta;
369  else if( type == wxEVT_SCROLLWIN_PAGEDOWN )
370  dist = -pagePanDelta;
371  else if( type == wxEVT_SCROLLWIN_LINEUP )
372  dist = linePanDelta;
373  else if( type == wxEVT_SCROLLWIN_LINEDOWN )
374  dist = -linePanDelta;
375  else
376  {
377  wxASSERT( "Unhandled event type" );
378  return;
379  }
380 
381  VECTOR2D scroll = m_view->ToWorld( m_view->GetScreenPixelSize(), false ) * dist;
382 
383  double scrollX = 0.0;
384  double scrollY = 0.0;
385 
386  if ( dir == wxHORIZONTAL )
387  scrollX = -scroll.x;
388  else
389  scrollY = -scroll.y;
390 
391  VECTOR2D delta( scrollX, scrollY );
392 
394  }
395 
396  m_parentPanel->Refresh();
397 }
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates) ...
Definition: view.h:325
bool IsMirroredX() const
Function IsMirroredX() Returns true if view is flipped across the X axis.
Definition: view.h:227
const BOX2I & GetBoundary() const
Function GetBoundary()
Definition: view.h:284
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:463
Class VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
static const int dist[10][10]
Definition: dist.cpp:57
coord_type GetRight() const
Definition: box2.h:197
VIEW * m_view
Pointer to controlled VIEW.
VECTOR2D m_scrollScale
Ratio used for scaling world coordinates to scrollbar position.
static const int delta[8][2]
Definition: solve.cpp:112
coord_type GetTop() const
Definition: box2.h:202
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:587
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
const VECTOR2I & GetScreenPixelSize() const
Function GetScreenPixelSize() Returns the size of the our rendering area, in pixels.
Definition: view.cpp:1147
coord_type GetLeft() const
Definition: box2.h:201
void WX_VIEW_CONTROLS::onTimer ( wxTimerEvent &  WXUNUSEDaEvent)

Definition at line 299 of file wx_view_controls.cpp.

References AUTO_PANNING, DRAG_PANNING, KIGFX::VIEW::GetCenter(), KIGFX::VIEW::GetScreenPixelSize(), IDLE, KIGFX::VC_SETTINGS::m_autoPanEnabled, KIGFX::VC_SETTINGS::m_autoPanMargin, KIGFX::VC_SETTINGS::m_autoPanSpeed, m_panDirection, m_parentPanel, KIGFX::VIEW_CONTROLS::m_settings, m_state, KIGFX::VIEW_CONTROLS::m_view, min, refreshMouse(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by WX_VIEW_CONTROLS(), and ~WX_VIEW_CONTROLS().

300 {
301  switch( m_state )
302  {
303  case AUTO_PANNING:
304  {
306  {
307  m_state = IDLE;
308  return;
309  }
310 
311 #if wxCHECK_VERSION( 3, 0, 0 )
312  if( !m_parentPanel->HasFocus() )
313  break;
314 #endif
315 
316  double borderSize = std::min( m_settings.m_autoPanMargin * m_view->GetScreenPixelSize().x,
318 
319  VECTOR2D dir( m_panDirection );
320 
321  if( dir.EuclideanNorm() > borderSize )
322  dir = dir.Resize( borderSize );
323 
324  dir = m_view->ToWorld( dir, false );
326 
327  refreshMouse();
328  }
329  break;
330 
331  case IDLE: // Just remove unnecessary warnings
332  case DRAG_PANNING:
333  break;
334  }
335 }
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates) ...
Definition: view.h:325
float m_autoPanSpeed
How fast is panning when in auto mode
Definition: view_controls.h:82
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:463
Class VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
VIEW * m_view
Pointer to controlled VIEW.
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:587
Panning with mouse button pressed.
float m_autoPanMargin
Distance from cursor to VIEW edge when panning is active
Definition: view_controls.h:79
void refreshMouse()
Sends an event to refresh mouse position.
bool m_autoPanEnabled
Flag for turning on autopanning
Definition: view_controls.h:73
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
VECTOR2D m_panDirection
Current direction of panning (only autopanning mode)
const VECTOR2I & GetScreenPixelSize() const
Function GetScreenPixelSize() Returns the size of the our rendering area, in pixels.
Definition: view.cpp:1147
STATE m_state
Current state of VIEW_CONTROLS.
#define min(a, b)
Definition: auxiliary.h:85
void WX_VIEW_CONTROLS::onWheel ( wxMouseEvent &  aEvent)

Handler functions.

Definition at line 110 of file wx_view_controls.cpp.

References CenterOnCursor(), delta, KIGFX::VIEW::GetCenter(), KIGFX::VIEW::GetScale(), KIGFX::VIEW::GetScreenPixelSize(), KIGFX::VIEW_CONTROLS::IsCursorWarpingEnabled(), KIGFX::VC_SETTINGS::m_enableMousewheelPan, KIGFX::VIEW_CONTROLS::m_settings, m_timeStamp, KIGFX::VIEW_CONTROLS::m_view, max, min, refreshMouse(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by WX_VIEW_CONTROLS(), and ~WX_VIEW_CONTROLS().

111 {
112  const double wheelPanSpeed = 0.001;
113  const double zoomLevelScale = 1.2; // The minimal step value when changing the current zoom level
114 
115  // mousewheelpan disabled:
116  // wheel + ctrl -> horizontal scrolling;
117  // wheel + shift -> vertical scrolling;
118  // wheel -> zooming;
119  // mousewheelpan enabled:
120  // wheel -> pan;
121  // wheel + ctrl -> zooming;
122  // wheel + shift -> horizontal scrolling.
123 
124  if( ( !m_settings.m_enableMousewheelPan && ( aEvent.ControlDown() || aEvent.ShiftDown() ) ) ||
125  ( m_settings.m_enableMousewheelPan && !aEvent.ControlDown() ) )
126  {
127  // Scrolling
128  VECTOR2D scrollVec = m_view->ToWorld( m_view->GetScreenPixelSize(), false ) *
129  ( (double) aEvent.GetWheelRotation() * wheelPanSpeed );
130  int axis = aEvent.GetWheelAxis();
131  double scrollX = 0.0;
132  double scrollY = 0.0;
133 
135  {
136  if ( axis == wxMOUSE_WHEEL_HORIZONTAL || aEvent.ShiftDown() )
137  scrollX = scrollVec.x;
138  else
139  scrollY = -scrollVec.y;
140  }
141  else
142  {
143  if( aEvent.ControlDown() )
144  scrollX = -scrollVec.x;
145  else
146  scrollY = -scrollVec.y;
147  }
148 
149  VECTOR2D delta( scrollX, scrollY );
150 
152  refreshMouse();
153  }
154  else
155  {
156  // Zooming
157  wxLongLong timeStamp = wxGetLocalTimeMillis();
158  double timeDiff = timeStamp.ToDouble() - m_timeStamp.ToDouble();
159  int rotation = aEvent.GetWheelRotation();
160  double zoomScale = 1.0;
161 
162 #ifdef __WXMAC__
163  // On Apple pointer devices, wheel events occur frequently and with
164  // smaller rotation values. For those devices, let's handle zoom
165  // based on the rotation amount rather than the time difference.
166 
167  // Unused
168  ( void )timeDiff;
169 
170  rotation = ( rotation > 0 ) ? std::min( rotation , 100 )
171  : std::max( rotation , -100 );
172 
173  double dscale = rotation * 0.01;
174  zoomScale = ( rotation > 0 ) ? (1 + dscale) : 1/(1 - dscale);
175 
176 #else
177 
178  m_timeStamp = timeStamp;
179 
180  // Set scaling speed depending on scroll wheel event interval
181  if( timeDiff < 500 && timeDiff > 0 )
182  {
183  zoomScale = 2.05 - timeDiff / 500;
184 
185  // be sure zoomScale value is significant
186  zoomScale = std::max( zoomScale, zoomLevelScale );
187 
188  if( rotation < 0 )
189  zoomScale = 1.0 / zoomScale;
190  }
191  else
192  {
193  zoomScale = ( rotation > 0 ) ? zoomLevelScale : 1/zoomLevelScale;
194  }
195 #endif
196 
197  if( IsCursorWarpingEnabled() )
198  {
199  CenterOnCursor();
200  m_view->SetScale( m_view->GetScale() * zoomScale );
201  }
202  else
203  {
204  VECTOR2D anchor = m_view->ToWorld( VECTOR2D( aEvent.GetX(), aEvent.GetY() ) );
205  m_view->SetScale( m_view->GetScale() * zoomScale, anchor );
206  }
207  }
208 
209  aEvent.Skip();
210 }
bool m_enableMousewheelPan
Mousewheel (2-finger touchpad) panning
Definition: view_controls.h:88
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates) ...
Definition: view.h:325
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:463
Class VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
VIEW * m_view
Pointer to controlled VIEW.
void SetScale(double aScale)
Function SetScale() Sets the scaling factor.
Definition: view.h:247
static const int delta[8][2]
Definition: solve.cpp:112
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:587
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
void refreshMouse()
Sends an event to refresh mouse position.
#define max(a, b)
Definition: auxiliary.h:86
bool IsCursorWarpingEnabled() const
Function IsCursorWarpingEnabled()
const VECTOR2I & GetScreenPixelSize() const
Function GetScreenPixelSize() Returns the size of the our rendering area, in pixels.
Definition: view.cpp:1147
double GetScale() const
Function GetScale()
Definition: view.h:265
wxLongLong m_timeStamp
Used for determining time intervals between scroll & zoom events.
void CenterOnCursor() const override
Function CenterOnCursor() Sets the viewport center to the current cursor position and warps the curso...
#define min(a, b)
Definition: auxiliary.h:85
void WX_VIEW_CONTROLS::refreshMouse ( )
private

Sends an event to refresh mouse position.

It is mostly used for notifying the tools that the cursor position in the world coordinates has changed, whereas the screen coordinates remained the same (e.g. frame edge autopanning).

Definition at line 576 of file wx_view_controls.cpp.

References EVT_REFRESH_MOUSE, getMouseScreenPosition(), m_cursorPos, m_parentPanel, KIGFX::VIEW_CONTROLS::m_view, KIGFX::VIEW::ToWorld(), wxPoint::x, and wxPoint::y.

Referenced by onTimer(), onWheel(), and WarpCursor().

577 {
578  // Notify tools that the cursor position has changed in the world coordinates
579  wxMouseEvent moveEvent( EVT_REFRESH_MOUSE );
581  moveEvent.SetX( msp.x );
582  moveEvent.SetY( msp.y );
583 
584  // Set the modifiers state
585 #if wxCHECK_VERSION( 3, 0, 0 )
586  moveEvent.SetControlDown( wxGetKeyState( WXK_CONTROL ) );
587  moveEvent.SetShiftDown( wxGetKeyState( WXK_SHIFT ) );
588  moveEvent.SetAltDown( wxGetKeyState( WXK_ALT ) );
589 #else
590  // wx <3.0 do not have accessors, but the fields are exposed
591  moveEvent.m_controlDown = wxGetKeyState( WXK_CONTROL );
592  moveEvent.m_shiftDown = wxGetKeyState( WXK_SHIFT );
593  moveEvent.m_altDown = wxGetKeyState( WXK_ALT );
594 #endif
595 
596  m_cursorPos = m_view->ToWorld( VECTOR2D( msp.x, msp.y ) );
597  wxPostEvent( m_parentPanel, moveEvent );
598 }
static const wxEventType EVT_REFRESH_MOUSE
Event that forces mouse move event in the dispatcher (eg.
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates...
Definition: view.cpp:463
VIEW * m_view
Pointer to controlled VIEW.
wxPoint getMouseScreenPosition() const
Gets the cursor position in the screen coordinates.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
VECTOR2D m_cursorPos
Current cursor position (world coordinates)
void VIEW_CONTROLS::Reset ( )
virtualinherited

Function Reset() Restores the default VIEW_CONTROLS settings.

Definition at line 49 of file view_controls.cpp.

References KIGFX::VIEW_CONTROLS::ApplySettings(), and dummy().

50 {
51  // Get the default settings from the default constructor
53  ApplySettings( dummy );
54 }
void ApplySettings(const VC_SETTINGS &aSettings)
Applies VIEW_CONTROLS settings from an object
Structure to keep VIEW_CONTROLS settings for easy store/restore operations
Definition: view_controls.h:44
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
void KIGFX::VIEW_CONTROLS::SetAdditionalPanButtons ( bool  aLeft = false,
bool  aRight = false 
)
inlineinherited

Definition at line 349 of file view_controls.h.

References KIGFX::VC_SETTINGS::Reset().

Referenced by CVPCB_SELECTION_TOOL::Main(), and GERBVIEW_SELECTION_TOOL::Main().

350  {
353  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
bool m_panWithRightButton
Allow panning with the right button in addition to middle
Definition: view_controls.h:91
bool m_panWithLeftButton
Allow panning with the left button in addition to middle
Definition: view_controls.h:94
virtual void KIGFX::VIEW_CONTROLS::SetAutoPan ( bool  aEnabled)
inlinevirtualinherited
virtual void KIGFX::VIEW_CONTROLS::SetAutoPanMargin ( float  aMargin)
inlinevirtualinherited

Function SetAutoPanMArgin() Sets margin for autopanning (ie.

the area when autopanning becomes active).

Parameters
aMarginis a new margin for autopanning.

Definition at line 171 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings().

172  {
173  m_settings.m_autoPanMargin = aMargin;
174  }
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
float m_autoPanMargin
Distance from cursor to VIEW edge when panning is active
Definition: view_controls.h:79
virtual void KIGFX::VIEW_CONTROLS::SetAutoPanSpeed ( float  aSpeed)
inlinevirtualinherited

Function SetAutoPanSpeed() Sets speed of autopanning.

Parameters
aSpeedis a new speed for autopanning.

Definition at line 161 of file view_controls.h.

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings().

162  {
163  m_settings.m_autoPanSpeed = aSpeed;
164  }
float m_autoPanSpeed
How fast is panning when in auto mode
Definition: view_controls.h:82
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
void WX_VIEW_CONTROLS::SetCrossHairCursorPosition ( const VECTOR2D aPosition,
bool  aWarpView = true 
)
overridevirtual

Moves the graphic crosshair cursor to the requested position expressed in world coordinates.

Parameters
aPositionis the requested cursor position in the world coordinates.
aWarpViewenables/disables view warp if the cursor is outside the current viewport.

Implements KIGFX::VIEW_CONTROLS.

Definition at line 454 of file wx_view_controls.cpp.

References BOX2< Vec >::Contains(), KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetScreenPixelSize(), m_cursorPos, m_updateCursor, KIGFX::VIEW_CONTROLS::m_view, KIGFX::VIEW::SetCenter(), and KIGFX::VIEW::ToScreen().

Referenced by ~WX_VIEW_CONTROLS().

455 {
456  m_updateCursor = false;
457 
458  const VECTOR2I& screenSize = m_view->GetGAL()->GetScreenPixelSize();
459  BOX2I screen( VECTOR2I( 0, 0 ), screenSize );
460  VECTOR2D screenPos = m_view->ToScreen( aPosition );
461 
462  if( !screen.Contains( screenPos ) )
463  {
464  m_view->SetCenter( aPosition );
465  }
466 
467  m_cursorPos = aPosition;
468 }
VIEW * m_view
Pointer to controlled VIEW.
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:587
GAL * GetGAL() const
Function GetGAL() Returns the GAL this view is using to draw graphical primitives.
Definition: view.h:177
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
bool m_updateCursor
Flag deciding whether the cursor position should be calculated using the mouse position.
VECTOR2D ToScreen(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToScreen() Converts a world space point/vector to a point/vector in screen space coordinates...
Definition: view.cpp:482
VECTOR2D m_cursorPos
Current cursor position (world coordinates)
void WX_VIEW_CONTROLS::SetCursorPosition ( const VECTOR2D aPosition,
bool  aWarpView 
)
overridevirtual

Moves cursor to the requested position expressed in world coordinates.

The position is not forced and will be overridden with the next mouse motion event. Mouse cursor follows the world cursor.

Parameters
aPositionis the requested cursor position in the world coordinates.
aWarpViewenables/disables view warp if the cursor is outside the current viewport.

Implements KIGFX::VIEW_CONTROLS.

Definition at line 446 of file wx_view_controls.cpp.

References m_cursorPos, m_updateCursor, and WarpCursor().

Referenced by ~WX_VIEW_CONTROLS().

447 {
448  m_updateCursor = false;
449  WarpCursor( aPosition, true, aWarpView );
450  m_cursorPos = aPosition;
451 }
void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false) override
bool m_updateCursor
Flag deciding whether the cursor position should be calculated using the mouse position.
VECTOR2D m_cursorPos
Current cursor position (world coordinates)
void WX_VIEW_CONTROLS::SetGrabMouse ( bool  aEnabled)
overridevirtual

Function SetGrabMouse() Enables/disables mouse cursor grabbing (limits the movement field only to the panel area).

Parameters
aEnabledsays whether the option should be enabled or disabled.

Reimplemented from KIGFX::VIEW_CONTROLS.

Definition at line 400 of file wx_view_controls.cpp.

References KIGFX::VC_SETTINGS::m_grabMouse, m_parentPanel, KIGFX::VIEW_CONTROLS::m_settings, and KIGFX::VIEW_CONTROLS::SetGrabMouse().

Referenced by ~WX_VIEW_CONTROLS().

401 {
402  if( aEnabled && !m_settings.m_grabMouse )
403  m_parentPanel->CaptureMouse();
404  else if( !aEnabled && m_settings.m_grabMouse )
405  m_parentPanel->ReleaseMouse();
406 
407  VIEW_CONTROLS::SetGrabMouse( aEnabled );
408 }
bool m_grabMouse
Flag for grabbing the mouse cursor
Definition: view_controls.h:70
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
virtual void SetGrabMouse(bool aEnabled)
Function SetGrabMouse Turns on/off mouse grabbing.
virtual void KIGFX::VIEW_CONTROLS::SetSnapping ( bool  aEnabled)
inlinevirtualinherited
void VIEW_CONTROLS::ShowCursor ( bool  aEnabled)
virtualinherited

Function ShowCursor() Enables or disables display of cursor.

Parameters
aEnableddecides if the cursor should be shown.

Definition at line 33 of file view_controls.cpp.

References KIGFX::VIEW::GetGAL(), KIGFX::VIEW_CONTROLS::m_settings, KIGFX::VC_SETTINGS::m_showCursor, KIGFX::VIEW_CONTROLS::m_view, and KIGFX::GAL::SetCursorEnabled().

Referenced by KIGFX::VIEW_CONTROLS::ApplySettings(), PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::drawZone(), MODULE_EDITOR_TOOLS::EnumeratePads(), ROUTER_TOOL::InlineDrag(), EDIT_TOOL::Main(), LENGTH_TUNER_TOOL::mainLoop(), ROUTER_TOOL::mainLoop(), EDIT_TOOL::MeasureTool(), DRAWING_TOOL::PlaceDXF(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), PICKER_TOOL::setControls(), and POINT_EDITOR::setEditedPoint().

34 {
35  m_settings.m_showCursor = aEnabled;
36  m_view->GetGAL()->SetCursorEnabled( aEnabled );
37 }
void SetCursorEnabled(bool aCursorEnabled)
Enable/disable cursor.
VC_SETTINGS m_settings
Current VIEW_CONTROLS settings
VIEW * m_view
Pointer to controlled VIEW.
GAL * GetGAL() const
Function GetGAL() Returns the GAL this view is using to draw graphical primitives.
Definition: view.h:177
bool m_showCursor
Flag determining the cursor visibility
Definition: view_controls.h:55
void WX_VIEW_CONTROLS::UpdateScrollbars ( )

Adjusts the scrollbars position to match the current viewport.

Definition at line 609 of file wx_view_controls.cpp.

References BOX2< Vec >::Centre(), KIGFX::VIEW::GetBoundary(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), KIGFX::VIEW::IsMirroredX(), m_parentPanel, m_scrollPos, m_scrollScale, KIGFX::VIEW_CONTROLS::m_view, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_DRAW_PANEL_GAL::onPaint(), and ~WX_VIEW_CONTROLS().

610 {
611  const BOX2D viewport = m_view->GetViewport();
612  const BOX2I& boundary = m_view->GetBoundary();
613 
614  m_scrollScale.x = 2e3 / viewport.GetWidth(); // TODO it does not have to be updated so often
615  m_scrollScale.y = 2e3 / viewport.GetHeight();
616  VECTOR2I newScroll( ( viewport.Centre().x - boundary.GetLeft() ) * m_scrollScale.x,
617  ( viewport.Centre().y - boundary.GetTop() ) * m_scrollScale.y );
618 
619  // Flip scroll direction in flipped view
620  if( m_view->IsMirroredX() )
621  newScroll.x = ( boundary.GetRight() - viewport.Centre().x ) * m_scrollScale.x;
622 
623  // Adjust scrollbars only if it is needed. Otherwise there are cases when canvas is continuosly
624  // refreshed (Windows)
625  if( m_scrollPos != newScroll )
626  {
627  // Another example of wxWidgets being broken by design: scroll position is determined by the
628  // left (or top, if vertical) edge of the slider. Fortunately, slider size seems to be constant
629  // (at least for wxGTK and wxMSW), so we have to add its size to allow user to scroll the workspace
630  // till the end.
631 
632  m_parentPanel->SetScrollbars( 1, 1,
633 #if defined(__LINUX__)
634  m_scrollScale.x * boundary.GetWidth() + 1623, m_scrollScale.y * boundary.GetHeight() + 1623,
635 #elif defined(__WIN32__) || defined(__WIN64__)
636  m_scrollScale.x * boundary.GetWidth() + 1377, m_scrollScale.y * boundary.GetHeight() + 741,
637 #else
638  m_scrollScale.x * boundary.GetWidth(), m_scrollScale.y * boundary.GetHeight(),
639 #endif
640  newScroll.x, newScroll.y, false );
641 
642  m_scrollPos = newScroll;
643  }
644 }
bool IsMirroredX() const
Function IsMirroredX() Returns true if view is flipped across the X axis.
Definition: view.h:227
const BOX2I & GetBoundary() const
Function GetBoundary()
Definition: view.h:284
coord_type GetRight() const
Definition: box2.h:197
VIEW * m_view
Pointer to controlled VIEW.
Class BOX2 handles a 2-D bounding box, built on top of an origin point and size vector, both of templated class Vec.
Definition: box2.h:41
VECTOR2D m_scrollScale
Ratio used for scaling world coordinates to scrollbar position.
coord_type GetTop() const
Definition: box2.h:202
coord_type GetWidth() const
Definition: box2.h:195
BOX2D GetViewport() const
Function GetViewport() Returns the current viewport visible area rectangle.
Definition: view.cpp:524
Vec Centre() const
Definition: box2.h:77
coord_type GetHeight() const
Definition: box2.h:196
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
VECTOR2I m_scrollPos
Current scrollbar position.
coord_type GetLeft() const
Definition: box2.h:201
void WX_VIEW_CONTROLS::WarpCursor ( const VECTOR2D aPosition,
bool  aWorldCoordinates = false,
bool  aWarpView = false 
)
overridevirtual

Implements KIGFX::VIEW_CONTROLS.

Definition at line 471 of file wx_view_controls.cpp.

References BOX2< Vec >::Contains(), KIGFX::VIEW::GetGAL(), KIGFX::GAL::GetScreenPixelSize(), m_parentPanel, KIGFX::VIEW_CONTROLS::m_view, refreshMouse(), KIGFX::VIEW::SetCenter(), KIGFX::VIEW::ToScreen(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SetCursorPosition(), and ~WX_VIEW_CONTROLS().

473 {
474  if( aWorldCoordinates )
475  {
476  const VECTOR2I& screenSize = m_view->GetGAL()->GetScreenPixelSize();
477  BOX2I screen( VECTOR2I( 0, 0 ), screenSize );
478  VECTOR2D screenPos = m_view->ToScreen( aPosition );
479 
480  if( !screen.Contains( screenPos ) )
481  {
482  if( aWarpView )
483  {
484  m_view->SetCenter( aPosition );
485  m_parentPanel->WarpPointer( screenSize.x / 2, screenSize.y / 2 );
486  }
487  }
488  else
489  {
490  m_parentPanel->WarpPointer( screenPos.x, screenPos.y );
491  }
492  }
493  else
494  {
495  m_parentPanel->WarpPointer( aPosition.x, aPosition.y );
496  }
497 
498  refreshMouse();
499 }
VIEW * m_view
Pointer to controlled VIEW.
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:587
GAL * GetGAL() const
Function GetGAL() Returns the GAL this view is using to draw graphical primitives.
Definition: view.h:177
void refreshMouse()
Sends an event to refresh mouse position.
const VECTOR2I & GetScreenPixelSize() const
Returns GAL canvas size in pixels.
wxScrolledCanvas * m_parentPanel
Panel that is affected by VIEW_CONTROLS.
VECTOR2D ToScreen(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToScreen() Converts a world space point/vector to a point/vector in screen space coordinates...
Definition: view.cpp:482

Member Data Documentation

const wxEventType WX_VIEW_CONTROLS::EVT_REFRESH_MOUSE = wxNewEventType()
static

Event that forces mouse move event in the dispatcher (eg.

used in autopanning, when mouse cursor does not move in screen coordinates, but does in world coordinates)

Definition at line 101 of file wx_view_controls.h.

Referenced by TOOL_DISPATCHER::DispatchWxEvent(), EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), and refreshMouse().

VECTOR2D KIGFX::WX_VIEW_CONTROLS::m_cursorPos
private

Current cursor position (world coordinates)

Definition at line 162 of file wx_view_controls.h.

Referenced by GetRawCursorPosition(), onMotion(), refreshMouse(), SetCrossHairCursorPosition(), and SetCursorPosition().

VECTOR2D KIGFX::WX_VIEW_CONTROLS::m_dragStartPoint
private

Stores information about point where dragging has started.

Definition at line 141 of file wx_view_controls.h.

Referenced by onButton(), and onMotion().

VECTOR2D KIGFX::WX_VIEW_CONTROLS::m_lookStartPoint
private

Stores information about the center of viewport when dragging has started.

Definition at line 144 of file wx_view_controls.h.

Referenced by onButton(), and onMotion().

VECTOR2D KIGFX::WX_VIEW_CONTROLS::m_panDirection
private

Current direction of panning (only autopanning mode)

Definition at line 147 of file wx_view_controls.h.

Referenced by handleAutoPanning(), and onTimer().

wxTimer KIGFX::WX_VIEW_CONTROLS::m_panTimer
private

Timer repsonsible for handling autopanning.

Definition at line 153 of file wx_view_controls.h.

Referenced by handleAutoPanning(), and WX_VIEW_CONTROLS().

wxScrolledCanvas* KIGFX::WX_VIEW_CONTROLS::m_parentPanel
private
VECTOR2I KIGFX::WX_VIEW_CONTROLS::m_scrollPos
private

Current scrollbar position.

Definition at line 159 of file wx_view_controls.h.

Referenced by UpdateScrollbars().

VECTOR2D KIGFX::WX_VIEW_CONTROLS::m_scrollScale
private

Ratio used for scaling world coordinates to scrollbar position.

Definition at line 156 of file wx_view_controls.h.

Referenced by onScroll(), and UpdateScrollbars().

STATE KIGFX::WX_VIEW_CONTROLS::m_state
private

Current state of VIEW_CONTROLS.

Definition at line 135 of file wx_view_controls.h.

Referenced by handleAutoPanning(), onButton(), onMotion(), and onTimer().

wxLongLong KIGFX::WX_VIEW_CONTROLS::m_timeStamp
private

Used for determining time intervals between scroll & zoom events.

Definition at line 150 of file wx_view_controls.h.

Referenced by onWheel().

bool KIGFX::WX_VIEW_CONTROLS::m_updateCursor
private

Flag deciding whether the cursor position should be calculated using the mouse position.

Definition at line 165 of file wx_view_controls.h.

Referenced by onMotion(), SetCrossHairCursorPosition(), and SetCursorPosition().


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