wx_view_controls.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 Torsten Hueter, torstenhtr <at> gmx.de
 * Copyright (C) 2013 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

 
#ifndef __WX_VIEW_CONTROLS_H
#define __WX_VIEW_CONTROLS_H
 
#include <view/view_controls.h>
#include <wx/timer.h>
#include <memory>
 
class EDA_DRAW_PANEL_GAL;
class PROF_COUNTER;
 
namespace KIGFX
{
 
class ZOOM_CONTROLLER;

class WX_VIEW_CONTROLS : public VIEW_CONTROLS, public wxEvtHandler
{
public:
    WX_VIEW_CONTROLS( VIEW* aView, EDA_DRAW_PANEL_GAL* aParentPanel );
    virtual ~WX_VIEW_CONTROLS();

    void onWheel( wxMouseEvent& aEvent );
    void onMotion( wxMouseEvent& aEvent );
    void onMagnify( wxMouseEvent& aEvent );
    void onButton( wxMouseEvent& aEvent );
    void onEnter( wxMouseEvent& WXUNUSED( aEvent ) );
    void onLeave( wxMouseEvent& WXUNUSED( aEvent ) );
    void onTimer( wxTimerEvent& WXUNUSED( aEvent ) );
    void onZoomGesture( wxZoomGestureEvent& aEvent );
    void onPanGesture( wxPanGestureEvent& aEvent );
    void onScroll( wxScrollWinEvent& aEvent );
    void onCaptureLost( wxMouseEvent& WXUNUSED( aEvent ) );
 

    void CaptureCursor( bool aEnabled ) override;
 
 
    void PinCursorInsideNonAutoscrollArea( bool aWarpMouseCursor ) override;

    VECTOR2D GetMousePosition( bool aWorldCoordinates = true ) const override;
 
    using VIEW_CONTROLS::GetCursorPosition;

    VECTOR2D GetCursorPosition( bool aSnappingEnabled ) const override;

    VECTOR2D GetRawCursorPosition( bool aSnappingEnabled = true ) const override;
 
    void SetCursorPosition( const VECTOR2D& aPosition, bool warpView, bool aTriggeredByArrows,
                            long aArrowCommand ) override;

    void SetCrossHairCursorPosition( const VECTOR2D& aPosition, bool aWarpView ) override;

    void WarpMouseCursor( const VECTOR2D& aPosition, bool aWorldCoordinates = false, bool aWarpView = false ) override;

    void CenterOnCursor() override;

    void UpdateScrollbars();

    void CancelDrag();
 
    void ForceCursorPosition( bool aEnabled, const VECTOR2D& aPosition = VECTOR2D( 0, 0 ) ) override;

    void LoadSettings() override;

    static const wxEventType EVT_REFRESH_MOUSE;
 
    std::unique_ptr<PROF_COUNTER> m_MotionEventCounter;
 
private:
    enum STATE
    {
        IDLE = 1,     
        DRAG_PANNING, 
        AUTO_PANNING, 
        DRAG_ZOOMING, 
    };

    void setState( STATE aNewState );

    bool handleAutoPanning( const wxMouseEvent& aEvent );

    void handleCursorCapture( int x, int y );

    void refreshMouse( bool aSetModifiers );

    wxPoint getMouseScreenPosition() const;

    STATE m_state;

    EDA_DRAW_PANEL_GAL* m_parentPanel;

    VECTOR2D m_dragStartPoint;

    VECTOR2D m_panDirection;

    wxTimer m_panTimer;

    VECTOR2D m_scrollScale;

    VECTOR2I m_scrollPos;

    VECTOR2D m_zoomStartPoint;

    VECTOR2D m_cursorPos;

    bool m_updateCursor;

    bool m_metaPanning;

    VECTOR2D m_metaPanStart;

    bool m_infinitePanWorks;

    std::unique_ptr<ZOOM_CONTROLLER> m_zoomController;

    double   m_gestureLastZoomFactor;
    VECTOR2D m_gestureLastPos;
};
} // namespace KIGFX
 
#endif