KiCad PCB EDA Suite
pcb_viewer_tools.cpp
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-2022 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#include <pgm_base.h>
26#include <pcbnew_settings.h>
29#include <kiplatform/ui.h>
30#include <pcb_base_frame.h>
32#include <tool/actions.h>
34#include <tools/pcb_actions.h>
36#include <view/view_controls.h>
37#include <wx/debug.h>
38
39
41{
42 // Populate the context menu displayed during the tool (primarily the measure tool)
43 auto activeToolCondition =
44 [ this ] ( const SELECTION& aSel )
45 {
46 return !frame()->ToolStackIsEmpty();
47 };
48
49 CONDITIONAL_MENU& ctxMenu = m_menu.GetMenu();
50
51 // "Cancel" goes at the top of the context menu when a tool is active
52 ctxMenu.AddItem( ACTIONS::cancelInteractive, activeToolCondition, 1 );
53 ctxMenu.AddSeparator( 1 );
54
56
57 return true;
58}
59
60
62{
63}
64
65
67{
69
70 if( frame()->IsType( FRAME_FOOTPRINT_VIEWER )
72 || frame()->IsType( FRAME_FOOTPRINT_WIZARD ) )
73 {
74 // A stronger version of Raise() which promotes the window to its parent's level.
76 }
77
78 // And load or update the current board
79 frame()->Update3DView( true, true );
80
81 return 0;
82}
83
84
85template<class T> void Flip( T& aValue )
86{
87 aValue = !aValue;
88}
89
90
92{
95
96 for( FOOTPRINT* fp : board()->Footprints() )
97 {
98 for( PAD* pad : fp->Pads() )
100 }
101
102 canvas()->Refresh();
103
104 return 0;
105}
106
107
109{
112
113 for( FOOTPRINT* fp : board()->Footprints() )
114 {
115 for( PAD* pad : fp->Pads() )
117 }
118
119 canvas()->Refresh();
120
121 return 0;
122}
123
124
126{
129
130 for( FOOTPRINT* fp : board()->Footprints() )
131 {
132 for( BOARD_ITEM* item : fp->GraphicalItems() )
133 {
134 KICAD_T t = item->Type();
135
136 if( t == PCB_FP_SHAPE_T || BaseType( t ) == PCB_DIMENSION_T )
137 view()->Update( item, KIGFX::REPAINT );
138 }
139 }
140
141 for( BOARD_ITEM* item : board()->Drawings() )
142 {
143 KICAD_T t = item->Type();
144
145 if( t == PCB_SHAPE_T || BaseType( t ) == PCB_DIMENSION_T || t == PCB_TARGET_T )
146 view()->Update( item, KIGFX::REPAINT );
147 }
148
149 canvas()->Refresh();
150
151 return 0;
152}
153
154
156{
159
160 for( FOOTPRINT* fp : board()->Footprints() )
161 {
162 view()->Update( &fp->Reference(), KIGFX::REPAINT );
163 view()->Update( &fp->Value(), KIGFX::REPAINT );
164
165 for( BOARD_ITEM* item : fp->GraphicalItems() )
166 {
167 if( item->Type() == PCB_FP_TEXT_T )
168 view()->Update( item, KIGFX::REPAINT );
169 }
170 }
171
172 for( BOARD_ITEM* item : board()->Drawings() )
173 {
174 KICAD_T t = item->Type();
175
176 if( t == PCB_TEXT_T || t == PCB_TEXTBOX_T || BaseType( t ) == PCB_DIMENSION_T )
177 view()->Update( item, KIGFX::REPAINT );
178 }
179
180 canvas()->Refresh();
181
182 return 0;
183}
184
185
187
188
190{
191 if( IsFootprintFrame() && !frame()->GetModel() )
192 return 0;
193
194 if( frame()->IsCurrentTool( ACTIONS::measureTool ) )
195 return 0;
196
197 auto& view = *getView();
198 auto& controls = *getViewControls();
199
200 frame()->PushTool( aEvent );
201
203 PCB_GRID_HELPER grid( m_toolMgr, frame()->GetMagneticItemsSettings() );
204 bool originSet = false;
205 EDA_UNITS units = frame()->GetUserUnits();
206 KIGFX::PREVIEW::RULER_ITEM ruler( twoPtMgr, pcbIUScale, units,
207 displayOptions().m_DisplayInvertXAxis,
208 displayOptions().m_DisplayInvertYAxis );
209
210 view.Add( &ruler );
211 view.SetVisible( &ruler, false );
212
213 auto setCursor =
214 [&]()
215 {
217 };
218
219 auto cleanup =
220 [&] ()
221 {
222 view.SetVisible( &ruler, false );
223 controls.SetAutoPan( false );
224 controls.CaptureCursor( false );
225 controls.ForceCursorPosition( false );
226 originSet = false;
227 };
228
229 Activate();
230 // Must be done after Activate() so that it gets set into the correct context
231 controls.ShowCursor( true );
232 controls.SetAutoPan( false );
233 controls.CaptureCursor( false );
234 controls.ForceCursorPosition( false );
235
236 // Set initial cursor
237 setCursor();
238
239 while( TOOL_EVENT* evt = Wait() )
240 {
241 setCursor();
242 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
243 grid.SetUseGrid( view.GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
244 const VECTOR2I cursorPos = grid.BestSnapAnchor( controls.GetMousePosition(), nullptr );
245 controls.ForceCursorPosition( true, cursorPos );
246
247 if( evt->IsCancelInteractive() )
248 {
249 if( originSet )
250 {
251 cleanup();
252 }
253 else
254 {
255 frame()->PopTool( aEvent );
256 break;
257 }
258 }
259 else if( evt->IsActivate() )
260 {
261 if( originSet )
262 cleanup();
263
264 if( evt->IsMoveTool() )
265 {
266 // leave ourselves on the stack so we come back after the move
267 break;
268 }
269 else
270 {
271 frame()->PopTool( aEvent );
272 break;
273 }
274 }
275 // click or drag starts
276 else if( !originSet && ( evt->IsDrag( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) ) )
277 {
278 twoPtMgr.SetOrigin( cursorPos );
279 twoPtMgr.SetEnd( cursorPos );
280
281 controls.CaptureCursor( true );
282 controls.SetAutoPan( true );
283
284 originSet = true;
285 }
286 // second click or mouse up after drag ends
287 else if( originSet && ( evt->IsClick( BUT_LEFT ) || evt->IsMouseUp( BUT_LEFT ) ) )
288 {
289 originSet = false;
290
291 controls.SetAutoPan( false );
292 controls.CaptureCursor( false );
293 }
294 // move or drag when origin set updates rules
295 else if( originSet && ( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) ) )
296 {
297 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
298 bool force45Deg;
299
300 if( frame()->IsType( FRAME_PCB_EDITOR ) )
301 force45Deg = mgr.GetAppSettings<PCBNEW_SETTINGS>()->m_Use45DegreeLimit;
302 else
303 force45Deg = mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>()->m_Use45Limit;
304
305 twoPtMgr.SetAngleSnap( force45Deg );
306 twoPtMgr.SetEnd( cursorPos );
307
308 view.SetVisible( &ruler, true );
309 view.Update( &ruler, KIGFX::GEOMETRY );
310 }
311 else if( evt->IsAction( &ACTIONS::updateUnits ) )
312 {
313 if( frame()->GetUserUnits() != units )
314 {
315 units = frame()->GetUserUnits();
316 ruler.SwitchUnits( units );
317 view.Update( &ruler, KIGFX::GEOMETRY );
318 canvas()->Refresh();
319 }
320
321 evt->SetPassEvent();
322 }
323 else if( evt->IsAction( &ACTIONS::updatePreferences ) )
324 {
325 ruler.UpdateDir( displayOptions().m_DisplayInvertXAxis,
326 displayOptions().m_DisplayInvertYAxis );
327
328 view.Update( &ruler, KIGFX::GEOMETRY );
329 canvas()->Refresh();
330 evt->SetPassEvent();
331 }
332 else if( evt->IsClick( BUT_RIGHT ) )
333 {
335 }
336 else
337 {
338 evt->SetPassEvent();
339 }
340 }
341
342 view.SetVisible( &ruler, false );
343 view.Remove( &ruler );
344
346 controls.SetAutoPan( false );
347 controls.CaptureCursor( false );
348 controls.ForceCursorPosition( false );
349 return 0;
350}
351
352
354{
356
357 // Display modes
362
364}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:109
static TOOL_ACTION cancelInteractive
Definition: actions.h:63
static TOOL_ACTION show3DViewer
Definition: actions.h:162
static TOOL_ACTION updatePreferences
Definition: actions.h:174
static TOOL_ACTION updateUnits
Definition: actions.h:150
static TOOL_ACTION measureTool
Definition: actions.h:157
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:58
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.
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
void AddStandardSubMenus(TOOL_MENU &aMenu)
Construct a "basic" menu for a tool, containing only items that apply to all tools (e....
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
bool GetGridSnapping() const
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: pcb_view.cpp:92
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Add a VIEW_ITEM to the view.
Definition: pcb_view.cpp:58
virtual void Remove(VIEW_ITEM *aItem) override
Remove a VIEW_ITEM from the view.
Definition: pcb_view.cpp:75
A drawn ruler item for showing the distance between two points.
Definition: ruler_item.h:42
void SwitchUnits(EDA_UNITS aUnits)
Switch the ruler units.
Definition: ruler_item.h:77
void UpdateDir(bool aFlipX, bool aFlipY)
Definition: ruler_item.h:79
Represent a very simple geometry manager for items that have a start and end point.
void SetOrigin(const VECTOR2I &aOrigin)
< Set the origin of the ruler (the fixed end)
void SetEnd(const VECTOR2I &aEnd)
Set the current end of the rectangle (the end that moves with the cursor.
GAL * GetGAL() const
Return the #GAL this view is using to draw graphical primitives.
Definition: view.h:195
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Set the item visibility.
Definition: view.cpp:1512
Definition: pad.h:59
static TOOL_ACTION padDisplayMode
Definition: pcb_actions.h:272
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
Definition: pcb_actions.h:428
static TOOL_ACTION textOutlines
Display texts as lines.
Definition: pcb_actions.h:431
static TOOL_ACTION showPadNumbers
Definition: pcb_actions.h:279
virtual PCB_VIEWERS_SETTINGS_BASE * GetViewerSettingsBase() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_3D_VIEWER_FRAME * CreateAndShow3D_Frame()
Shows the 3D view frame.
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
VIEWERS_DISPLAY_OPTIONS m_ViewersDisplay
bool Init() override
Init() is called once upon a registration of the tool.
PCBNEW_SETTINGS::DISPLAY_OPTIONS & displayOptions() const
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)
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)
T * GetAppSettings(bool aLoadNow=true)
Returns a handle to the a given settings by type If the settings have already been loaded,...
virtual void PopTool(const TOOL_EVENT &aEvent)
Pops a tool from the stack.
virtual void PushTool(const TOOL_EVENT &aEvent)
NB: the definition of "tool" is different at the user level.
bool ToolStackIsEmpty()
Definition: tools_holder.h:128
KIGFX::VIEW_CONTROLS * getViewControls() const
Return the instance of VIEW_CONTROLS object used in the application.
Definition: tool_base.cpp:42
TOOL_MANAGER * m_toolMgr
Definition: tool_base.h:214
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
void Go(int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
Define which state (aStateFunc) to go when a certain event arrives (aConditions).
TOOL_MENU m_menu
The functions below are not yet implemented - their interface may change.
TOOL_EVENT * Wait(const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
Suspend execution of the tool until an event specified in aEventList arrives.
void Activate()
Run the tool.
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:44
void ShowContextMenu(SELECTION &aSelection)
Helper function to set and immediately show a CONDITIONAL_MENU in concert with the given SELECTION.
Definition: tool_menu.cpp:57
EDA_UNITS GetUserUnits() const
EDA_UNITS
Definition: eda_units.h:43
@ FRAME_PCB_EDITOR
Definition: frame_type.h:40
@ FRAME_FOOTPRINT_VIEWER_MODAL
Definition: frame_type.h:43
@ FRAME_FOOTPRINT_VIEWER
Definition: frame_type.h:42
@ FRAME_FOOTPRINT_WIZARD
Definition: frame_type.h:44
@ REPAINT
Item needs to be redrawn.
Definition: view_item.h:52
@ GEOMETRY
Position or shape has changed.
Definition: view_item.h:49
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:65
SGLIB_API S3DMODEL * GetModel(SCENEGRAPH *aNode)
Function GetModel creates an S3DMODEL representation of aNode (raw data, no transforms)
Definition: ifsg_api.cpp:338
void Flip(T &aValue)
see class PGM_BASE
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111
@ MD_SHIFT
Definition: tool_event.h:138
@ BUT_LEFT
Definition: tool_event.h:127
@ BUT_RIGHT
Definition: tool_event.h:128
constexpr KICAD_T BaseType(const KICAD_T aType)
Return the underlying type of the given type.
Definition: typeinfo.h:254
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:88
@ PCB_FP_SHAPE_T
class FP_SHAPE, a footprint edge
Definition: typeinfo.h:94
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition: typeinfo.h:91
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:90
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:111
@ PCB_FP_TEXT_T
class FP_TEXT, text in a footprint
Definition: typeinfo.h:92
@ PCB_DIMENSION_T
class PCB_DIMENSION_BASE: abstract dimension meta-type
Definition: typeinfo.h:105