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 (C) 2013-2019 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
 *
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 *
 */

#ifndef __VIEW_CONTROLS_H
#define __VIEW_CONTROLS_H

#include <math/box2.h>

namespace KIGFX
{
class VIEW;


enum class MOUSE_DRAG_ACTION
{
    SELECT,
    ZOOM,
    PAN,
    NONE
};


struct VC_SETTINGS
{
    VC_SETTINGS()
    {
        Reset();
    }

    void Reset();

    bool m_showCursor;

    VECTOR2D m_forcedPosition;

    bool m_forceCursorPosition;

    bool m_cursorCaptured;

    bool m_snappingEnabled;

    bool m_grabMouse;

    bool m_autoPanEnabled;

    bool m_autoPanSettingEnabled;

    float m_autoPanMargin;

    float m_autoPanSpeed;

    float m_autoPanAcceleration;

    bool m_warpCursor;

    bool m_horizontalPan;

    bool m_zoomAcceleration;

    int m_zoomSpeed;

    bool m_zoomSpeedAuto;

    int m_scrollModifierZoom;

    int m_scrollModifierPanH;

    int m_scrollModifierPanV;

    MOUSE_DRAG_ACTION m_dragMiddle;

    MOUSE_DRAG_ACTION m_dragRight;

    bool m_lastKeyboardCursorPositionValid;

    long m_lastKeyboardCursorCommand;

    VECTOR2D m_lastKeyboardCursorPosition;
};


class VIEW_CONTROLS
{
public:
    VIEW_CONTROLS( VIEW* aView ) :
        m_view( aView ), m_cursorWarped( false )
    {
    }

    virtual ~VIEW_CONTROLS()
    {
    }

    virtual void SetGrabMouse( bool aEnabled )
    {
        m_settings.m_grabMouse = aEnabled;
    }

    virtual void SetAutoPan( bool aEnabled )
    {
        m_settings.m_autoPanEnabled = aEnabled;
    }

    virtual void EnableAutoPan( bool aEnabled )
    {
        m_settings.m_autoPanSettingEnabled = aEnabled;
    }

    virtual void SetAutoPanSpeed( float aSpeed )
    {
        m_settings.m_autoPanSpeed = aSpeed;
    }

    virtual void SetAutoPanAcceleration( float aAcceleration )
    {
        m_settings.m_autoPanAcceleration = aAcceleration;
    }

    virtual void SetAutoPanMargin( float aMargin )
    {
        m_settings.m_autoPanMargin = aMargin;
    }

    virtual VECTOR2D GetMousePosition( bool aWorldCoordinates = true ) const = 0;

    VECTOR2D GetCursorPosition() const
    {
        return GetCursorPosition( m_settings.m_snappingEnabled );
    }

    virtual VECTOR2D GetRawCursorPosition( bool aSnappingEnabled = true ) const = 0;

    virtual VECTOR2D GetCursorPosition( bool aEnableSnapping ) const = 0;

    virtual void ForceCursorPosition( bool aEnabled, const VECTOR2D& aPosition = VECTOR2D( 0, 0 ) )
    {
        m_settings.m_forceCursorPosition = aEnabled;
        m_settings.m_forcedPosition = aPosition;
    }

    virtual void SetCursorPosition( const VECTOR2D& aPosition, bool aWarpView = true,
                                    bool aTriggeredByArrows = false, long aArrowCommand = 0 ) = 0;


    virtual void SetCrossHairCursorPosition( const VECTOR2D& aPosition, bool aWarpView = true ) = 0;


    bool ForcedCursorPosition() const
    {
        return m_settings.m_forceCursorPosition;
    }

    virtual void ShowCursor( bool aEnabled );

    bool IsCursorShown() const;

    virtual void CaptureCursor( bool aEnabled )
    {
        m_settings.m_cursorCaptured = aEnabled;
    }

    inline bool IsCursorPositionForced() const
    {
        return m_settings.m_forceCursorPosition;
    }

    virtual void WarpCursor( const VECTOR2D& aPosition, bool aWorldCoordinates = false,
            bool aWarpView = false ) = 0;

    void EnableCursorWarping( bool aEnable )
    {
        m_settings.m_warpCursor = aEnable;
    }

    bool IsCursorWarpingEnabled() const
    {
        return m_settings.m_warpCursor;
    }

    virtual void CenterOnCursor() const = 0;

    virtual void Reset();

    const VC_SETTINGS& GetSettings() const
    {
        return m_settings;
    }

    void ApplySettings( const VC_SETTINGS& aSettings );

    virtual void LoadSettings() {}

protected:
    VIEW* m_view;

    bool m_cursorWarped;

    VC_SETTINGS m_settings;
};
} // namespace KIGFX

#endif