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 
36 #include <functional>
37 
38 
45 class PCB_TOOL;
46 class PCB_EDIT_FRAME;
47 
49 {
50  virtual std::unique_ptr<BOARD_ITEM> CreateItem() = 0;
51  virtual bool PlaceItem( BOARD_ITEM *aItem ) { return false; }
52 
55 };
56 
57 
58 class PCB_TOOL : public TOOL_INTERACTIVE
59 {
60 public:
65  PCB_TOOL( TOOL_ID aId, const std::string& aName ) :
66  TOOL_INTERACTIVE ( aId, aName ),
67  m_editModules( false ) {};
68 
73  PCB_TOOL( const std::string& aName ) :
74  TOOL_INTERACTIVE ( aName ),
75  m_editModules( false ) {};
76 
77  virtual ~PCB_TOOL() {};
78 
86  void SetEditModules( bool aEnabled )
87  {
88  m_editModules = aEnabled;
89  }
90 
91  bool EditingModules() const
92  {
93  return m_editModules;
94  }
95 
96 protected:
97 
100  IPO_FLIP = 2,
104  };
105 
106 
120  const wxString& aCommitMessage,
121  int aOptions = IPO_ROTATE | IPO_FLIP | IPO_REPEAT );
122 
123  KIGFX::VIEW* view() const { return getView(); }
125  PCB_EDIT_FRAME* frame() const { return getEditFrame<PCB_EDIT_FRAME>(); }
126  BOARD* board() const { return getModel<BOARD>(); }
127 
129 };
130 
131 #endif
KIGFX::VIEW * view() const
Definition: pcb_tool.h:123
virtual bool PlaceItem(BOARD_ITEM *aItem)
Definition: pcb_tool.h:51
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:53
INTERACTIVE_PLACEMENT_OPTIONS
Definition: pcb_tool.h:98
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:124
int TOOL_ID
Unique identifier for tools.
Definition: tool_base.h:57
virtual ~PCB_TOOL()
Definition: pcb_tool.h:77
PCB_TOOL(TOOL_ID aId, const std::string &aName)
Constructor.
Definition: pcb_tool.h:65
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:125
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
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:128
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:35
bool EditingModules() const
Definition: pcb_tool.h:91
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
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:38
Class VIEW.
Definition: view.h:58
PCB_TOOL(const std::string &aName)
Constructor.
Definition: pcb_tool.h:73
void SetEditModules(bool aEnabled)
Function SetEditModules()
Definition: pcb_tool.h:86
BOARD * board() const
Definition: pcb_tool.h:126