KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2024 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>
30#include <kiplatform/ui.h>
31#include <pcb_base_frame.h>
33#include <tool/actions.h>
35#include <tools/pcb_actions.h>
37
38
40{
41 // Populate the context menu displayed during the tool (primarily the measure tool)
42 auto activeToolCondition =
43 [ this ] ( const SELECTION& aSel )
44 {
45 return !frame()->ToolStackIsEmpty();
46 };
47
48 CONDITIONAL_MENU& ctxMenu = m_menu.GetMenu();
49
50 // "Cancel" goes at the top of the context menu when a tool is active
51 ctxMenu.AddItem( ACTIONS::cancelInteractive, activeToolCondition, 1 );
52 ctxMenu.AddSeparator( 1 );
53
55
56 return true;
57}
58
59
61{
62}
63
64
66{
67 bool do_reload_board = true; // reload board flag
68
69 // At EDA_3D_VIEWER_FRAME creation, the current board is loaded, so disable loading
70 // the current board if the 3D frame is not yet created
71 if( frame()->Get3DViewerFrame() == nullptr )
72 do_reload_board = false;
73
75
76 if( frame()->IsType( FRAME_FOOTPRINT_VIEWER )
77 || frame()->IsType( FRAME_FOOTPRINT_WIZARD ) )
78 {
79 // A stronger version of Raise() which promotes the window to its parent's level.
81 }
82
83 // And load or update the current board (if needed)
84 if( do_reload_board )
85 frame()->Update3DView( true, true );
86
87 return 0;
88}
89
90
91template<class T> void Flip( T& aValue )
92{
93 aValue = !aValue;
94}
95
96
98{
101
102 for( FOOTPRINT* fp : board()->Footprints() )
103 {
104 for( PAD* pad : fp->Pads() )
106 }
107
108 canvas()->Refresh();
109
110 return 0;
111}
112
113
115{
118
119 for( FOOTPRINT* fp : board()->Footprints() )
120 {
121 for( PAD* pad : fp->Pads() )
123 }
124
125 canvas()->Refresh();
126
127 return 0;
128}
129
130
132{
135
136 for( FOOTPRINT* fp : board()->Footprints() )
137 {
138 for( BOARD_ITEM* item : fp->GraphicalItems() )
139 {
140 KICAD_T t = item->Type();
141
142 if( t == PCB_SHAPE_T || BaseType( t ) == PCB_DIMENSION_T )
143 view()->Update( item, KIGFX::REPAINT );
144 }
145 }
146
147 for( BOARD_ITEM* item : board()->Drawings() )
148 {
149 KICAD_T t = item->Type();
150
151 if( t == PCB_SHAPE_T || BaseType( t ) == PCB_DIMENSION_T || t == PCB_TARGET_T )
152 view()->Update( item, KIGFX::REPAINT );
153 }
154
155 canvas()->Refresh();
156
157 return 0;
158}
159
160
162{
165
166 for( FOOTPRINT* fp : board()->Footprints() )
167 {
168 for( PCB_FIELD* field : fp->Fields() )
169 {
170 view()->Update( field, KIGFX::REPAINT );
171 }
172
173 for( BOARD_ITEM* item : fp->GraphicalItems() )
174 {
175 if( item->Type() == PCB_TEXT_T )
176 view()->Update( item, KIGFX::REPAINT );
177 }
178 }
179
180 for( BOARD_ITEM* item : board()->Drawings() )
181 {
182 KICAD_T t = item->Type();
183
184 if( t == PCB_TEXT_T || t == PCB_TEXTBOX_T || BaseType( t ) == PCB_DIMENSION_T )
185 view()->Update( item, KIGFX::REPAINT );
186 }
187
188 canvas()->Refresh();
189
190 return 0;
191}
192
193
195
196
198{
199 if( IsFootprintFrame() && !frame()->GetModel() )
200 return 0;
201
202 if( frame()->IsCurrentTool( ACTIONS::measureTool ) )
203 return 0;
204
205 auto& view = *getView();
206 auto& controls = *getViewControls();
207
208 frame()->PushTool( aEvent );
209
210 bool invertXAxis = displayOptions().m_DisplayInvertXAxis;
211 bool invertYAxis = displayOptions().m_DisplayInvertYAxis;
212
213 if( IsFootprintFrame() )
214 {
217 }
218
220 PCB_GRID_HELPER grid( m_toolMgr, frame()->GetMagneticItemsSettings() );
221 bool originSet = false;
222 EDA_UNITS units = frame()->GetUserUnits();
223 KIGFX::PREVIEW::RULER_ITEM ruler( twoPtMgr, pcbIUScale, units, invertXAxis, invertYAxis );
224
225 view.Add( &ruler );
226 view.SetVisible( &ruler, false );
227
228 auto setCursor =
229 [&]()
230 {
231 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::MEASURE );
232 };
233
234 auto cleanup =
235 [&] ()
236 {
237 view.SetVisible( &ruler, false );
238 controls.SetAutoPan( false );
239 controls.CaptureCursor( false );
240 controls.ForceCursorPosition( false );
241 originSet = false;
242 };
243
244 Activate();
245 // Must be done after Activate() so that it gets set into the correct context
246 controls.ShowCursor( true );
247 controls.SetAutoPan( false );
248 controls.CaptureCursor( false );
249 controls.ForceCursorPosition( false );
250
251 // Set initial cursor
252 setCursor();
253
254 while( TOOL_EVENT* evt = Wait() )
255 {
256 setCursor();
257 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
258 grid.SetUseGrid( view.GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
259 VECTOR2I cursorPos = evt->HasPosition() ? evt->Position() : controls.GetMousePosition();
260 cursorPos = grid.BestSnapAnchor( cursorPos, nullptr );
261 controls.ForceCursorPosition( true, cursorPos );
262
263 if( evt->IsCancelInteractive() )
264 {
265 if( originSet )
266 {
267 cleanup();
268 }
269 else
270 {
271 frame()->PopTool( aEvent );
272 break;
273 }
274 }
275 else if( evt->IsActivate() )
276 {
277 if( originSet )
278 cleanup();
279
280 if( evt->IsMoveTool() )
281 {
282 // leave ourselves on the stack so we come back after the move
283 break;
284 }
285 else
286 {
287 frame()->PopTool( aEvent );
288 break;
289 }
290 }
291 // click or drag starts
292 else if( !originSet && ( evt->IsDrag( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) ) )
293 {
294 twoPtMgr.SetOrigin( cursorPos );
295 twoPtMgr.SetEnd( cursorPos );
296
297 controls.CaptureCursor( true );
298 controls.SetAutoPan( true );
299
300 originSet = true;
301 }
302 // second click or mouse up after drag ends
303 else if( originSet && ( evt->IsClick( BUT_LEFT ) || evt->IsMouseUp( BUT_LEFT ) ) )
304 {
305 originSet = false;
306
307 controls.SetAutoPan( false );
308 controls.CaptureCursor( false );
309 }
310 // move or drag when origin set updates rules
311 else if( originSet && ( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) ) )
312 {
313 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
314 bool force45Deg;
315
316 if( frame()->IsType( FRAME_PCB_EDITOR ) )
317 force45Deg = mgr.GetAppSettings<PCBNEW_SETTINGS>()->m_Use45DegreeLimit;
318 else
319 force45Deg = mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>()->m_Use45Limit;
320
321 twoPtMgr.SetAngleSnap( force45Deg );
322 twoPtMgr.SetEnd( cursorPos );
323
324 view.SetVisible( &ruler, true );
325 view.Update( &ruler, KIGFX::GEOMETRY );
326 }
327 else if( evt->IsAction( &ACTIONS::updateUnits ) )
328 {
329 if( frame()->GetUserUnits() != units )
330 {
331 units = frame()->GetUserUnits();
332 ruler.SwitchUnits( units );
333 view.Update( &ruler, KIGFX::GEOMETRY );
334 canvas()->Refresh();
335 }
336
337 evt->SetPassEvent();
338 }
339 else if( evt->IsAction( &ACTIONS::updatePreferences ) )
340 {
341 invertXAxis = displayOptions().m_DisplayInvertXAxis;
342 invertYAxis = displayOptions().m_DisplayInvertYAxis;
343
344 if( IsFootprintFrame() )
345 {
348 }
349
350 ruler.UpdateDir( invertXAxis, invertYAxis );
351
352 view.Update( &ruler, KIGFX::GEOMETRY );
353 canvas()->Refresh();
354 evt->SetPassEvent();
355 }
356 else if( evt->IsClick( BUT_RIGHT ) )
357 {
359 }
360 else
361 {
362 evt->SetPassEvent();
363 }
364 }
365
366 view.SetVisible( &ruler, false );
367 view.Remove( &ruler );
368
369 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
370 controls.SetAutoPan( false );
371 controls.CaptureCursor( false );
372 controls.ForceCursorPosition( false );
373 return 0;
374}
375
376
378{
380
381 // Display modes
386
388}
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:194
static TOOL_ACTION updatePreferences
Definition: actions.h:207
static TOOL_ACTION updateUnits
Definition: actions.h:181
static TOOL_ACTION measureTool
Definition: actions.h:188
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
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
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:75
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Add a VIEW_ITEM to the view.
Definition: pcb_view.cpp:57
virtual void Remove(VIEW_ITEM *aItem) override
Remove a VIEW_ITEM from the view.
Definition: pcb_view.cpp:66
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:197
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Set the item visibility.
Definition: view.cpp:1563
Definition: pad.h:59
static TOOL_ACTION padDisplayMode
Definition: pcb_actions.h:325
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
Definition: pcb_actions.h:484
static TOOL_ACTION textOutlines
Display texts as lines.
Definition: pcb_actions.h:487
static TOOL_ACTION showPadNumbers
Definition: pcb_actions.h:332
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.
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings() const
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()
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:125
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:216
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:167
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
Declaration of the eda_3d_viewer class.
EDA_UNITS
Definition: eda_units.h:46
@ FRAME_PCB_EDITOR
Definition: frame_type.h:42
@ FRAME_FOOTPRINT_VIEWER
Definition: frame_type.h:45
@ FRAME_FOOTPRINT_WIZARD
Definition: frame_type.h:46
@ REPAINT
Item needs to be redrawn.
Definition: view_item.h:57
@ GEOMETRY
Position or shape has changed.
Definition: view_item.h:54
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:88
void Flip(T &aValue)
void Flip(T &aValue)
see class PGM_BASE
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:119
@ MD_SHIFT
Definition: tool_event.h:142
@ BUT_LEFT
Definition: tool_event.h:131
@ BUT_RIGHT
Definition: tool_event.h:132
constexpr KICAD_T BaseType(const KICAD_T aType)
Return the underlying type of the given type.
Definition: typeinfo.h:257
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_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition: typeinfo.h:93
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:106
@ PCB_DIMENSION_T
class PCB_DIMENSION_BASE: abstract dimension meta-type
Definition: typeinfo.h:100