KiCad PCB EDA Suite
ee_tool_base.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) 2019 CERN
5  * Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
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 EE_TOOL_BASE_H
26 #define EE_TOOL_BASE_H
27 
28 #include <tool/tool_event.h>
29 #include <tool/tool_interactive.h>
30 #include <tool/tool_manager.h>
31 #include <tool/tool_menu.h>
32 #include <tool/actions.h>
34 #include <sch_view.h>
35 #include <sch_edit_frame.h>
36 #include <symbol_edit_frame.h>
37 #include <undo_redo_container.h>
38 
39 
40 class EE_SELECTION;
41 
47 template <class T>
49 {
50 public:
54  EE_TOOL_BASE( const std::string& aName ) :
55  TOOL_INTERACTIVE ( aName ),
56  m_frame( nullptr ),
57  m_view( nullptr ),
58  m_selectionTool( nullptr ),
59  m_isSymbolEditor( false )
60  {};
61 
62  ~EE_TOOL_BASE() override {};
63 
65  bool Init() override
66  {
67  m_frame = getEditFrame<T>();
70 
71  // A basic context menu. Many (but not all) tools will choose to override this.
72  auto& ctxMenu = m_menu.GetMenu();
73 
74  // cancel current tool goes in main context menu at the top if present
76  ctxMenu.AddSeparator( 1 );
77 
78  // Finally, add the standard zoom/grid items
79  m_frame->AddStandardSubMenus( m_menu );
80 
81  return true;
82  }
83 
85  void Reset( RESET_REASON aReason ) override
86  {
87  if( aReason == MODEL_RELOAD )
88  {
89  // Init variables used by every drawing tool
90  m_frame = getEditFrame<T>();
91  m_isSymbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame ) != nullptr;
92  }
93 
94  m_view = static_cast<KIGFX::SCH_VIEW*>( getView() );
95  }
96 
97 protected:
102  void updateItem( EDA_ITEM* aItem, bool aUpdateRTree ) const
103  {
104  switch( aItem->Type() )
105  {
106  case SCH_SHEET_PIN_T:
107  getView()->Update( aItem );
108  getView()->Update( aItem->GetParent() );
109 
110  // Moving sheet pins does not change the BBox.
111  break;
112 
113  case SCH_PIN_T:
114  case SCH_FIELD_T:
115  getView()->Update( aItem );
116  getView()->Update( aItem->GetParent() );
117 
118  if( aUpdateRTree )
119  m_frame->GetScreen()->Update( static_cast<SCH_ITEM*>( aItem->GetParent() ) );
120 
121  break;
122 
123  default:
124  getView()->Update( aItem );
125 
126  if( aUpdateRTree )
127  m_frame->GetScreen()->Update( static_cast<SCH_ITEM*>( aItem ) );
128  }
129  }
130 
133  void saveCopyInUndoList( EDA_ITEM* aItem, UNDO_REDO aType, bool aAppend = false )
134  {
135  KICAD_T itemType = aItem->Type();
136  bool selected = aItem->IsSelected();
137 
138  // IS_SELECTED flag should not be set on undo items which were added for
139  // a drag operation.
140  if( selected && aItem->HasFlag( TEMP_SELECTED ) )
141  aItem->ClearSelected();
142 
143  if( m_isSymbolEditor )
144  {
145  SYMBOL_EDIT_FRAME* editFrame = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame );
146  wxASSERT( editFrame );
147 
148  editFrame->SaveCopyInUndoList( static_cast<LIB_ITEM*>( aItem ), aType, aAppend );
149  }
150  else
151  {
152  SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
153  wxASSERT( editFrame );
154 
155  if( itemType == SCH_PIN_T || itemType == SCH_FIELD_T || itemType == SCH_SHEET_PIN_T )
156  {
157  editFrame->SaveCopyInUndoList( editFrame->GetScreen(),
158  static_cast<SCH_ITEM*>( aItem->GetParent() ),
159  UNDO_REDO::CHANGED, aAppend );
160  }
161  else
162  {
163  editFrame->SaveCopyInUndoList( editFrame->GetScreen(),
164  static_cast<SCH_ITEM*>( aItem ),
165  aType, aAppend );
166  }
167  }
168 
169  if( selected && aItem->HasFlag( TEMP_SELECTED ) )
170  aItem->SetSelected();
171  }
172 
173 protected:
178 };
179 
180 #endif
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
Definition: ee_tool_base.h:85
TOOL_MENU m_menu
The functions below are not yet implemented - their interface may change.
bool IsSelected() const
Definition: eda_item.h:172
Model changes (required full reload)
Definition: tool_base.h:81
void ClearSelected()
Definition: eda_item.h:181
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:46
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:215
static TOOL_ACTION cancelInteractive
Definition: actions.h:65
~EE_TOOL_BASE() override
Definition: ee_tool_base.h:62
Schematic editor (Eeschema) main window.
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: eda_item.h:114
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
bool Init() override
Init() is called once upon a registration of the tool.
Definition: ee_tool_base.h:65
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
KIGFX::SCH_VIEW * m_view
Definition: ee_tool_base.h:175
void SetSelected()
Definition: eda_item.h:178
void saveCopyInUndoList(EDA_ITEM *aItem, UNDO_REDO aType, bool aAppend=false)
Definition: ee_tool_base.h:133
bool m_isSymbolEditor
Definition: ee_tool_base.h:177
void SaveCopyInUndoList(EDA_ITEM *aItem, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT, bool aAppend=false)
Create a copy of the current symbol, and save it in the undo list.
EDA_ITEM * GetParent() const
Definition: eda_item.h:164
EE_SELECTION_TOOL * m_selectionTool
Definition: ee_tool_base.h:176
KIGFX::VIEW * getView() const
Returns the instance of #VIEW object used in the application.
Definition: tool_base.cpp:36
void updateItem(EDA_ITEM *aItem, bool aUpdateRTree) const
Similar to getView()->Update(), but handles items that are redrawn by their parents and updating the ...
Definition: ee_tool_base.h:102
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend)
Create a copy of the current schematic item, and put it in the undo list.
EE_TOOL_BASE(const std::string &aName)
Create a tool with given name.
Definition: ee_tool_base.h:54
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:149
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:48
void AddItem(const TOOL_ACTION &aAction, const SELECTION_CONDITION &aCondition, int aOrder=ANY_ORDER)
Add a menu entry to run a TOOL_ACTION on selected items.
bool HasFlag(STATUS_FLAGS aFlag) const
Definition: eda_item.h:205
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1508
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162
The symbol library editor main window.