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>
29#include <pcbnew_settings.h>
30
31class PCB_BASE_FRAME;
32
40{
41public:
43 TOOL_INTERACTIVE( "pcbnew.PCBViewerTools" ),
44 m_footprintFrame( false )
45 {}
46
47 ~PCB_VIEWER_TOOLS() override {}
48
49 bool Init() override;
50
52 void Reset( RESET_REASON aReason ) override;
53
55 int MeasureTool( const TOOL_EVENT& aEvent );
56
57 // Display modes
58 int ShowPadNumbers( const TOOL_EVENT& aEvent );
59 int PadDisplayMode( const TOOL_EVENT& aEvent );
60 int GraphicOutlines( const TOOL_EVENT& aEvent );
61 int TextOutlines( const TOOL_EVENT& aEvent );
62
64 int Show3DViewer( const TOOL_EVENT& aEvent );
65
67 void setTransitions() override;
68
77 void SetFootprintFrame( bool aIsFrame )
78 {
79 m_footprintFrame = aIsFrame;
80 }
81
82 bool IsFootprintFrame() const
83 {
84 return m_footprintFrame;
85 }
86
87protected:
89 {
90 return getEditFrame<PCB_BASE_FRAME>();
91 }
92
94 {
95 return static_cast<KIGFX::PCB_VIEW*>( getView() );
96 }
97
99 {
100 return frame()->GetPcbNewSettings()->m_Display;
101 }
102
104 {
105 return static_cast<PCB_DRAW_PANEL_GAL*>( frame()->GetCanvas() );
106 }
107
108 BOARD* board() const
109 {
110 return getModel<BOARD>();
111 }
112
114 {
115 return board()->GetFirstFootprint();
116 }
117
119};
120
121#endif
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:265
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:397
DISPLAY_OPTIONS m_Display
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
PCBNEW_SETTINGS * GetPcbNewSettings() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Tool useful for viewing footprints.
bool Init() override
Init() is called once upon a registration of the tool.
void SetFootprintFrame(bool aIsFrame)
Toggle edit footprint mode.
PCBNEW_SETTINGS::DISPLAY_OPTIONS & displayOptions() const
~PCB_VIEWER_TOOLS() override
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
PCB_BASE_FRAME * frame() const
int PadDisplayMode(const TOOL_EVENT &aEvent)
FOOTPRINT * footprint() const
BOARD * board() const
KIGFX::PCB_VIEW * view() const
int MeasureTool(const TOOL_EVENT &aEvent)
int TextOutlines(const TOOL_EVENT &aEvent)
PCB_DRAW_PANEL_GAL * canvas() const
bool IsFootprintFrame() const
int Show3DViewer(const TOOL_EVENT &aEvent)
Show the 3D viewer.
int GraphicOutlines(const TOOL_EVENT &aEvent)
int ShowPadNumbers(const TOOL_EVENT &aEvent)
bool m_footprintFrame
Is this tool associated with a footprint frame.
KIGFX::VIEW * getView() const
Returns the instance of #VIEW object used in the application.
Definition: tool_base.cpp:36
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:156