KiCad PCB EDA Suite
pcb_tool.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2016 CERN
5  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef __PCB_TOOL_H
26 #define __PCB_TOOL_H
27 
28 #include <string>
29 
30 #include <tool/tool_event.h>
31 #include <tool/tool_interactive.h>
32 #include <wxPcbStruct.h>
33 #include <class_board.h>
34 #include <view/view_group.h>
35 #include <pcb_view.h>
36 
37 #include <functional>
38 
39 
46 class PCB_TOOL;
47 class PCB_EDIT_FRAME;
49 class PCB_DRAW_PANEL_GAL;
50 
52 {
53  virtual std::unique_ptr<BOARD_ITEM> CreateItem() = 0;
54  virtual bool PlaceItem( BOARD_ITEM *aItem ) { return false; }
55 
58 };
59 
60 
61 class PCB_TOOL : public TOOL_INTERACTIVE
62 {
63 public:
68  PCB_TOOL( TOOL_ID aId, const std::string& aName ) :
69  TOOL_INTERACTIVE ( aId, aName ),
70  m_editModules( false ) {};
71 
76  PCB_TOOL( const std::string& aName ) :
77  TOOL_INTERACTIVE ( aName ),
78  m_editModules( false ) {};
79 
80  virtual ~PCB_TOOL() {};
81 
82  virtual void Reset( RESET_REASON aReason ) override;
83 
91  void SetEditModules( bool aEnabled )
92  {
93  m_editModules = aEnabled;
94  }
95 
96  bool EditingModules() const
97  {
98  return m_editModules;
99  }
100 
101 protected:
102 
105  IPO_FLIP = 2,
109  };
110 
111 
125  const wxString& aCommitMessage,
126  int aOptions = IPO_ROTATE | IPO_FLIP | IPO_REPEAT );
127 
128  virtual void setTransitions() override;
129 
130 
131  KIGFX::PCB_VIEW* view() const { return static_cast<KIGFX::PCB_VIEW*>( getView() ); }
133  PCB_EDIT_FRAME* frame() const { return getEditFrame<PCB_EDIT_FRAME>(); }
134  BOARD* board() const { return getModel<BOARD>(); }
135  MODULE* module() const { return board()->m_Modules; }
137  PCB_DRAW_PANEL_GAL* canvas() const;
138 
140 };
141 
142 #endif
virtual void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
Definition: pcb_tool.cpp:203
virtual bool PlaceItem(BOARD_ITEM *aItem)
Definition: pcb_tool.h:54
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
virtual std::unique_ptr< BOARD_ITEM > CreateItem()=0
Class BOARD to handle a board.
PCB_EDIT_FRAME * m_frame
Definition: pcb_tool.h:56
INTERACTIVE_PLACEMENT_OPTIONS
Definition: pcb_tool.h:103
PCB_DRAW_PANEL_GAL * canvas() const
Definition: pcb_tool.cpp:213
PCB_DISPLAY_OPTIONS * displayOptions() const
Definition: pcb_tool.cpp:208
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:132
int TOOL_ID
Unique identifier for tools.
Definition: tool_base.h:57
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
virtual ~PCB_TOOL()
Definition: pcb_tool.h:80
PCB_TOOL(TOOL_ID aId, const std::string &aName)
Constructor.
Definition: pcb_tool.h:68
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:133
virtual void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
Definition: pcb_tool.cpp:198
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
MODULE * module() const
Definition: pcb_tool.h:135
VIEW_GROUP extends VIEW_ITEM by possibility of grouping items into a single object.
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:41
bool m_editModules
Definition: pcb_tool.h:139
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:35
bool EditingModules() const
Definition: pcb_tool.h:96
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
KIGFX::PCB_VIEW * view() const
Definition: pcb_tool.h:131
DLIST< MODULE > m_Modules
Definition: class_board.h:245
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:80
void doInteractiveItemPlacement(INTERACTIVE_PLACER_BASE *aPlacer, const wxString &aCommitMessage, int aOptions=IPO_ROTATE|IPO_FLIP|IPO_REPEAT)
Helper function for performing a common interactive idiom: wait for a left click, place an item there...
Definition: pcb_tool.cpp:39
PCB_TOOL(const std::string &aName)
Constructor.
Definition: pcb_tool.h:76
void SetEditModules(bool aEnabled)
Function SetEditModules()
Definition: pcb_tool.h:91
BOARD * board() const
Definition: pcb_tool.h:134