common_tools.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014-2016 CERN
 * Copyright (C) 2019-2020 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[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, 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 _COMMON_TOOLS_H
#define _COMMON_TOOLS_H
 
#include <tool/tool_interactive.h>
 
class EDA_DRAW_FRAME;
 
class COMMON_TOOLS : public TOOL_INTERACTIVE
{
public:
 COMMON_TOOLS();
 
 ~COMMON_TOOLS() override { }
 
 void Reset( RESET_REASON aReason ) override;
 
 int SelectionTool( const TOOL_EVENT& aEvent );
 
 // View controls
 int ZoomRedraw( const TOOL_EVENT& aEvent );
 int ZoomInOut( const TOOL_EVENT& aEvent );
 int ZoomInOutCenter( const TOOL_EVENT& aEvent );
 int ZoomCenter( const TOOL_EVENT& aEvent );
 int ZoomFitScreen( const TOOL_EVENT& aEvent );
 int ZoomFitObjects( const TOOL_EVENT& aEvent );
 int ZoomPreset( const TOOL_EVENT& aEvent );
 
 int CenterContents( const TOOL_EVENT& aEvent );
 
 int PanControl( const TOOL_EVENT& aEvent );
 
 // Cursor control
 int CursorControl( const TOOL_EVENT& aEvent );
 int ToggleCursor( const TOOL_EVENT& aEvent );
 int ToggleCursorStyle( const TOOL_EVENT& aEvent );
 
 int ToggleBoundingBoxes( const TOOL_EVENT& aEvent );
 
 // Units control
 int SwitchUnits( const TOOL_EVENT& aEvent );
 int ToggleUnits( const TOOL_EVENT& aEvent );
 int TogglePolarCoords( const TOOL_EVENT& aEvent );
 int ResetLocalCoords( const TOOL_EVENT& aEvent );
 
 void SetLastUnits( EDA_UNITS aUnit );
 EDA_UNITS GetLastMetricUnits() { return m_metricUnit; }
 EDA_UNITS GetLastImperialUnits() { return m_imperialUnit; }
 
 // Grid control
 int GridNext( const TOOL_EVENT& aEvent );
 int GridPrev( const TOOL_EVENT& aEvent );
 int GridPreset( const TOOL_EVENT& aEvent );
 int GridFast1( const TOOL_EVENT& aEvent );
 int GridFast2( const TOOL_EVENT& aEvent );
 int GridFastCycle( const TOOL_EVENT& aEvent );
 int ToggleGrid( const TOOL_EVENT& aEvent );
 int ToggleGridOverrides( const TOOL_EVENT& aEvent );
 int GridProperties( const TOOL_EVENT& aEvent );
 int GridPreset( int idx, bool aFromHotkey );
 int GridOrigin( const TOOL_EVENT& aEvent );
 int OnGridChanged( bool aFromHotkey );
 
 const std::vector<VECTOR2I> Grids() const { return m_grids; }
 
private:
 enum ZOOM_FIT_TYPE_T
 {
 ZOOM_FIT_ALL, 
 ZOOM_FIT_OBJECTS, 
 };
 
 void setTransitions() override;
 
 EDA_DRAW_FRAME* m_frame;
 
 int doZoomInOut( bool aDirection, bool aCenterOnCursor );
 
 int doZoomToPreset( int idx, bool aCenterOnCursor );
 
 int doZoomFit( ZOOM_FIT_TYPE_T aFitType );
 
 std::vector<VECTOR2I> m_grids; 
 
 // The last used units in each system (used for toggling between metric and imperial)
 EDA_UNITS m_imperialUnit;
 EDA_UNITS m_metricUnit;
};
 
#endif