kicad/pcbnew/tools/pcb_editor_control.h

160 lines
5.2 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2014 CERN
* @author Maciej Suminski <maciej.suminski@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 PCB_EDITOR_CONTROL_H
#define PCB_EDITOR_CONTROL_H
#include <tools/pcb_tool.h>
#include <tool/tool_menu.h>
2015-06-18 15:51:54 +00:00
namespace KIGFX {
class ORIGIN_VIEWITEM;
}
class PCB_EDIT_FRAME;
/**
* Class PCB_EDITOR_CONTROL
*
* Handles actions specific to the board editor in pcbnew.
*/
class PCB_EDITOR_CONTROL : public wxEvtHandler, public PCB_TOOL
{
public:
PCB_EDITOR_CONTROL();
2015-06-18 15:51:54 +00:00
~PCB_EDITOR_CONTROL();
/// @copydoc TOOL_INTERACTIVE::Reset()
2016-09-24 18:53:15 +00:00
void Reset( RESET_REASON aReason ) override;
/// @copydoc TOOL_INTERACTIVE::Init()
2016-09-24 18:53:15 +00:00
bool Init() override;
// 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
2015-06-19 15:32:33 +00:00
int ZoneMerge( const TOOL_EVENT& aEvent );
///> Duplicates a zone onto a layer (prompts for new layer)
int ZoneDuplicate( const TOOL_EVENT& aEvent );
/**
* Function PlaceTarget()
* Allows user to place a layer alignment target.
*/
int PlaceTarget( const TOOL_EVENT& aEvent );
/**
* Function PlaceModule()
* Displays a dialog to select a module to be added and allows the user to set its position.
*/
int PlaceModule( const TOOL_EVENT& aEvent );
///> Toggles 'lock' property for selected items.
int ToggleLockSelected( const TOOL_EVENT& aEvent );
///> Locks selected items.
int LockSelected( const TOOL_EVENT& aEvent );
///> Unlocks selected items.
int UnlockSelected( const TOOL_EVENT& aEvent );
2015-02-14 20:52:22 +00:00
///> Notifies eeschema about the selected item.
int CrossProbePcbToSch( const TOOL_EVENT& aEvent );
///> Reacts to selection change in eeschema.
int CrossProbeSchToPcb( const TOOL_EVENT& aEvent );
2015-02-14 20:52:22 +00:00
///> Runs the drill origin tool for setting the origin for drill and pick-and-place files.
int DrillOrigin( const TOOL_EVENT& aEvent );
///> UI-level access (including undo) to setting the drill origin
static bool SetDrillOrigin( KIGFX::VIEW* aView, PCB_BASE_FRAME* aFrame,
BOARD_ITEM* aItem, const VECTOR2D& aPoint );
///> Low-level access (below undo) to setting the drill origin
static bool DoSetDrillOrigin( KIGFX::VIEW* aView, PCB_BASE_FRAME* aFrame,
BOARD_ITEM* aItem, const VECTOR2D& aPoint );
///> Highlights net belonging to the item under the cursor.
int HighlightNet( const TOOL_EVENT& aEvent );
///> Clears all board highlights
int ClearHighlight( const TOOL_EVENT& aEvent );
///> Launches a tool to pick the item whose net is going to be highlighted.
int HighlightNetCursor( const TOOL_EVENT& aEvent );
///> Updates ratsnest for selected items.
int UpdateSelectionRatsnest( const TOOL_EVENT& aEvent );
///> Hides ratsnest for selected items. Called when there are no items selected.
int HideSelectionRatsnest( const TOOL_EVENT& aEvent );
2017-04-24 20:26:11 +00:00
///> Shows local ratsnest of a component
int ShowLocalRatsnest( const TOOL_EVENT& aEvent );
private:
///> Event handler to recalculate dynamic ratsnest
void ratsnestTimer( wxTimerEvent& aEvent );
///> Recalculates dynamic ratsnest for the current selection
void calculateSelectionRatsnest();
///> Sets up handlers for various events.
void setTransitions() override;
///> Pointer to the currently used edit frame.
PCB_EDIT_FRAME* m_frame;
/// Menu model displayed by the tool.
TOOL_MENU m_menu;
2015-06-18 15:51:54 +00:00
///> Place & drill origin marker.
2017-03-02 22:57:13 +00:00
std::unique_ptr<KIGFX::ORIGIN_VIEWITEM> m_placeOrigin;
2015-06-18 15:51:54 +00:00
///> Flag to ignore a single crossprobe message from eeschema.
bool m_probingSchToPcb;
///> Flag to indicate whether the current selection ratsnest is slow to calculate.
bool m_slowRatsnest;
///> Timer that start ratsnest calculation when it is slow to compute.
wxTimer m_ratsnestTimer;
///> How to modify a property for selected items.
enum MODIFY_MODE { ON, OFF, TOGGLE };
int modifyLockSelected( MODIFY_MODE aMode );
// How does line width change after one -/+ key press.
static const int WIDTH_STEP;
};
#endif