board_editor_control.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-2020 CERN
 * Copyright (C) 2021-2022 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 BOARD_EDITOR_CONTROL_H
#define BOARD_EDITOR_CONTROL_H
 
#include <tools/pcb_tool_base.h>
#include <tool/tool_menu.h>
 
namespace KIGFX {
 class ORIGIN_VIEWITEM;
}
 
class PCB_EDIT_FRAME;
 
class BOARD_EDITOR_CONTROL : public PCB_TOOL_BASE
{
public:
 BOARD_EDITOR_CONTROL();
 ~BOARD_EDITOR_CONTROL();
 
 void Reset( RESET_REASON aReason ) override;
 
 bool Init() override;
 
 int New( const TOOL_EVENT& aEvent );
 int Open( const TOOL_EVENT& aEvent );
 int Save( const TOOL_EVENT& aEvent );
 int SaveAs( const TOOL_EVENT& aEvent );
 int SaveCopy( const TOOL_EVENT& aEvent );
 int Revert( const TOOL_EVENT& aEvent );
 int PageSettings( const TOOL_EVENT& aEvent );
 int Plot( const TOOL_EVENT& aEvent );
 
 int Search( const TOOL_EVENT& aEvent );
 int Find( const TOOL_EVENT& aEvent );
 int FindNext( const TOOL_EVENT& aEvent );
 
 int BoardSetup( const TOOL_EVENT& aEvent );
 int ImportNetlist( const TOOL_EVENT& aEvent );
 int ImportSpecctraSession( const TOOL_EVENT& aEvent );
 int ExportSpecctraDSN( const TOOL_EVENT& aEvent );
 int ExportNetlist( const TOOL_EVENT& aEvent );
 int GenerateDrillFiles( const TOOL_EVENT& aEvent );
 int GeneratePosFile( const TOOL_EVENT& aEvent );
 int GenerateFabFiles( const TOOL_EVENT& aEvent );
 int RepairBoard( const TOOL_EVENT& aEvent );
 
 int UpdatePCBFromSchematic( const TOOL_EVENT& aEvent );
 int UpdateSchematicFromPCB( const TOOL_EVENT& aEvent );
 int ShowEeschema( const TOOL_EVENT& aEvent );
 int ToggleLayersManager( const TOOL_EVENT& aEvent );
 int ToggleProperties( const TOOL_EVENT& aEvent );
 int ToggleNetInspector( const TOOL_EVENT& aEvent );
 int ToggleSearch( const TOOL_EVENT& aEvent );
 int TogglePythonConsole( const TOOL_EVENT& aEvent );
 
 // Track & via size control
 int TrackWidthInc( const TOOL_EVENT& aEvent );
 int TrackWidthDec( const TOOL_EVENT& aEvent );
 int ViaSizeInc( const TOOL_EVENT& aEvent );
 int ViaSizeDec( const TOOL_EVENT& aEvent );
 
 // Zone actions
 int ZoneMerge( const TOOL_EVENT& aEvent );
 
 int ZoneDuplicate( const TOOL_EVENT& aEvent );
 
 int EditFpInFpEditor( const TOOL_EVENT& aEvent );
 
 int CrossProbeToSch( const TOOL_EVENT& aEvent );
 
 int ExplicitCrossProbeToSch( const TOOL_EVENT& aEvent );
 
 int AssignNetclass( const TOOL_EVENT& aEvent );
 
 int PlaceFootprint( const TOOL_EVENT& aEvent );
 
 bool PlacingFootprint() const { return m_placingFootprint; }
 
 int ToggleLockSelected( const TOOL_EVENT& aEvent );
 
 int LockSelected( const TOOL_EVENT& aEvent );
 
 int UnlockSelected( const TOOL_EVENT& aEvent );
 
 int DrillOrigin( const TOOL_EVENT& aEvent );
 
 static void DoSetDrillOrigin( KIGFX::VIEW* aView, PCB_BASE_FRAME* aFrame,
 EDA_ITEM* aItem, const VECTOR2D& aPoint );
 
private:
 enum MODIFY_MODE { ON, OFF, TOGGLE };
 
 int modifyLockSelected( MODIFY_MODE aMode );
 
 void setTransitions() override;
 
 void doCrossProbePcbToSch( const TOOL_EVENT& aEvent, bool aForce );
 
private:
 PCB_EDIT_FRAME* m_frame;
 bool m_inPlaceFootprint; // Re-entrancy guard for tool.
 bool m_placingFootprint; // Re-entrancy guard for placement loop.
 bool m_inPlaceTarget; // Re-entrancy guard.
 
 std::unique_ptr<KIGFX::ORIGIN_VIEWITEM> m_placeOrigin;
 
 static const int WIDTH_STEP; 
};
 
#endif