KiCad PCB EDA Suite
pcb_viewer_tools.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) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef PCB_VIEWER_TOOLS_H_
25 #define PCB_VIEWER_TOOLS_H_
26 
27 #include <board.h>
28 #include <tool/tool_interactive.h>
29 
30 class PCB_BASE_FRAME;
31 
39 {
40 public:
42  TOOL_INTERACTIVE( "pcbnew.PCBViewerTools" ),
43  m_footprintFrame( false )
44  {}
45 
46  ~PCB_VIEWER_TOOLS() override {}
47 
48  bool Init() override;
49 
51  void Reset( RESET_REASON aReason ) override;
52 
54  int MeasureTool( const TOOL_EVENT& aEvent );
55 
56  // Display modes
57  int ShowPadNumbers( const TOOL_EVENT& aEvent );
58  int PadDisplayMode( const TOOL_EVENT& aEvent );
59  int GraphicOutlines( const TOOL_EVENT& aEvent );
60  int TextOutlines( const TOOL_EVENT& aEvent );
61 
63  int Show3DViewer( const TOOL_EVENT& aEvent );
64 
66  void setTransitions() override;
67 
76  void SetFootprintFrame( bool aIsFrame )
77  {
78  m_footprintFrame = aIsFrame;
79  }
80 
81  bool IsFootprintFrame() const
82  {
83  return m_footprintFrame;
84  }
85 
86 protected:
88  {
89  return getEditFrame<PCB_BASE_FRAME>();
90  }
91 
93  {
94  return static_cast<KIGFX::PCB_VIEW*>( getView() );
95  }
96 
98  {
99  return frame()->GetDisplayOptions();
100  }
101 
103  {
104  return static_cast<PCB_DRAW_PANEL_GAL*>( frame()->GetCanvas() );
105  }
106 
107  BOARD* board() const
108  {
109  return getModel<BOARD>();
110  }
111 
113  {
114  return board()->GetFirstFootprint();
115  }
116 
118 };
119 
120 #endif
int ShowPadNumbers(const TOOL_EVENT &aEvent)
int MeasureTool(const TOOL_EVENT &aEvent)
~PCB_VIEWER_TOOLS() override
FOOTPRINT * footprint() const
PCB_BASE_FRAME * frame() const
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
KIGFX::PCB_VIEW * view() const
Container for display options like enable/disable some optional drawings.
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:317
int Show3DViewer(const TOOL_EVENT &aEvent)
Show the 3D viewer.
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
bool m_footprintFrame
Is this tool associated with a footprint frame.
Generic, UI-independent tool event.
Definition: tool_event.h:152
KIGFX::VIEW * getView() const
Returns the instance of #VIEW object used in the application.
Definition: tool_base.cpp:36
bool IsFootprintFrame() const
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
const PCB_DISPLAY_OPTIONS & displayOptions() const
int GraphicOutlines(const TOOL_EVENT &aEvent)
BOARD * board() const
PCB_DRAW_PANEL_GAL * canvas() const
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:77
Tool useful for viewing footprints.
int TextOutlines(const TOOL_EVENT &aEvent)
void SetFootprintFrame(bool aIsFrame)
Toggle edit footprint mode.
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
bool Init() override
Init() is called once upon a registration of the tool.
int PadDisplayMode(const TOOL_EVENT &aEvent)
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.