kicad/pcbnew/tools/pcb_tool_base.h

180 lines
5.1 KiB
C
Raw Normal View History

2016-05-10 16:09:39 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2016 CERN
2020-11-07 17:50:22 +00:00
* Copyright (C) 2017-2020 KiCad Developers, see AUTHORS.txt for contributors.
2016-05-10 16:09:39 +00:00
* @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 PCB_TOOL_BASE_H
#define PCB_TOOL_BASE_H
2016-05-10 16:09:39 +00:00
#include <string>
#include <tool/tool_event.h>
#include <tool/tool_interactive.h>
2018-01-29 20:58:58 +00:00
#include <pcb_edit_frame.h>
2016-05-10 16:09:39 +00:00
#include <class_board.h>
#include <view/view_group.h>
#include <pcb_view.h>
#include <pcb_draw_panel_gal.h>
2016-05-10 16:09:39 +00:00
#include <functional>
#include <tool/tool_menu.h>
2016-05-10 16:09:39 +00:00
/**
* PCB_TOOL_BASE
2016-05-10 16:09:39 +00:00
*
* A tool operating on a BOARD object
**/
class PCB_TOOL_BASE;
class PCB_EDIT_FRAME;
class PCB_DISPLAY_OPTIONS;
class PCBNEW_SELECTION;
struct INTERACTIVE_PLACER_BASE
{
virtual ~INTERACTIVE_PLACER_BASE()
{
}
virtual std::unique_ptr<BOARD_ITEM> CreateItem() = 0;
2020-11-07 17:50:22 +00:00
virtual void SnapItem( BOARD_ITEM *aItem );
2020-11-07 17:50:22 +00:00
virtual bool PlaceItem( BOARD_ITEM *aItem, BOARD_COMMIT& aCommit );
PCB_BASE_EDIT_FRAME* m_frame;
2020-11-07 17:50:22 +00:00
BOARD* m_board;
int m_modifiers;
};
class PCB_TOOL_BASE : public TOOL_INTERACTIVE
2016-05-10 16:09:39 +00:00
{
public:
/**
* Constructor
*
* Creates a tool with given id & name. The name must be unique. */
PCB_TOOL_BASE( TOOL_ID aId, const std::string& aName ) :
2020-11-07 17:50:22 +00:00
TOOL_INTERACTIVE ( aId, aName ),
m_isFootprintEditor( false )
{};
2016-05-10 16:09:39 +00:00
/**
* Constructor
*
* Creates a tool with given name. The name must be unique. */
PCB_TOOL_BASE( const std::string& aName ) :
2020-11-07 17:50:22 +00:00
TOOL_INTERACTIVE ( aName ),
m_isFootprintEditor( false )
{};
2016-05-10 16:09:39 +00:00
virtual ~PCB_TOOL_BASE() {};
2016-05-10 16:09:39 +00:00
virtual bool Init() override;
virtual void Reset( RESET_REASON aReason ) override;
2016-05-10 16:09:39 +00:00
/**
2020-11-07 17:50:22 +00:00
* Function SetIsFootprintEditor()
2016-05-10 16:09:39 +00:00
*
* Toggles edit module mode. When enabled, one may select parts of footprints individually
2016-05-10 16:09:39 +00:00
* (graphics, pads, etc.), so they can be modified.
* @param aEnabled decides if the mode should be enabled.
*/
2020-11-07 17:50:22 +00:00
void SetIsFootprintEditor( bool aEnabled ) { m_isFootprintEditor = aEnabled; }
bool IsFootprintEditor() const { return m_isFootprintEditor; }
2016-05-10 16:09:39 +00:00
protected:
/**
* Options for placing items interactively.
*/
enum INTERACTIVE_PLACEMENT_OPTIONS {
/// Handle the rotate action in the loop by calling the item's rotate method
IPO_ROTATE = 0x01,
/// Handle flip action in the loop by calling the item's flip method
IPO_FLIP = 0x02,
/// Create an item immediately on placement starting, otherwise show the pencil cursor
/// until the item is created
IPO_SINGLE_CLICK = 0x04,
/// Allow repeat placement of the item
IPO_REPEAT = 0x08
};
/**
* Helper function for performing a common interactive idiom:
* wait for a left click, place an item there (perhaps with a
* dialog or other user interaction), then have it move with
* the mouse and respond to rotate/flip, etc
*
* More complex interactive processes are not supported here, you
* should implement a customised event loop for those.
*
* @param aItemCreator the callable that will attempt to create the item
* @param aCommitMessage the message used on a successful commit
*/
void doInteractiveItemPlacement( const std::string& aTool, INTERACTIVE_PLACER_BASE *aPlacer,
const wxString& aCommitMessage,
int aOptions = IPO_ROTATE | IPO_FLIP | IPO_REPEAT );
virtual void setTransitions() override;
KIGFX::PCB_VIEW* view() const
{
return static_cast<KIGFX::PCB_VIEW*>( getView() );
}
KIGFX::VIEW_CONTROLS* controls() const
{
return getViewControls();
}
PCB_BASE_EDIT_FRAME* frame() const
{
return getEditFrame<PCB_BASE_EDIT_FRAME>();
}
2016-05-10 16:09:39 +00:00
BOARD* board() const { return getModel<BOARD>(); }
MODULE* module() const
{
2020-11-08 21:29:04 +00:00
return board()->GetFirstFootprint();
}
const PCB_DISPLAY_OPTIONS& displayOptions() const;
2020-11-07 17:50:22 +00:00
PCB_DRAW_PANEL_GAL* canvas() const;
2020-11-07 17:50:22 +00:00
const PCBNEW_SELECTION& selection() const;
2020-11-07 17:50:22 +00:00
PCBNEW_SELECTION& selection();
2020-11-07 17:50:22 +00:00
protected:
bool m_isFootprintEditor;
2016-05-10 16:09:39 +00:00
};
#endif