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-2023 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{
68
69 if( frame()->IsType( FRAME_FOOTPRINT_VIEWER )
70 || frame()->IsType( FRAME_FOOTPRINT_WIZARD ) )
71 {
72 // A stronger version of Raise() which promotes the window to its parent's level.
74 }
75
76 // And load or update the current board
77 frame()->Update3DView( true, true );
78
79 return 0;
80}
81
82
83template<class T> void Flip( T& aValue )
84{
85 aValue = !aValue;
86}
87
88
90{
93
94 for( FOOTPRINT* fp : board()->Footprints() )
95 {
96 for( PAD* pad : fp->Pads() )
98 }
99
100 canvas()->Refresh();
101
102 return 0;
103}
104
105
107{
110
111 for( FOOTPRINT* fp : board()->Footprints() )
112 {
113 for( PAD* pad : fp->Pads() )
115 }
116
117 canvas()->Refresh();
118
119 return 0;
120}
121
122
124{
127
128 for( FOOTPRINT* fp : board()->Footprints() )
129 {
130 for( BOARD_ITEM* item : fp->GraphicalItems() )
131 {
132 KICAD_T t = item->Type();
133
134 if( t == PCB_SHAPE_T || BaseType( t ) == PCB_DIMENSION_T )
135 view()->Update( item, KIGFX::REPAINT );
136 }
137 }
138
139 for( BOARD_ITEM* item : board()->Drawings() )
140 {
141 KICAD_T t = item->Type();
142
143 if( t == PCB_SHAPE_T || BaseType( t ) == PCB_DIMENSION_T || t == PCB_TARGET_T )
144 view()->Update( item, KIGFX::REPAINT );
145 }
146
147 canvas()->Refresh();
148
149 return 0;
150}
151
152
154{
157
158 for( FOOTPRINT* fp : board()->Footprints() )
159 {
160 for( PCB_FIELD* field : fp->Fields() )
161 {
162 view()->Update( field, KIGFX::REPAINT );
163 }
164
165 for( BOARD_ITEM* item : fp->GraphicalItems() )
166 {
167 if( item->Type() == PCB_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
202 bool invertXAxis = displayOptions().m_DisplayInvertXAxis;
203 bool invertYAxis = displayOptions().m_DisplayInvertYAxis;
204
205 if( IsFootprintFrame() )
206 {
209 }
210
212 PCB_GRID_HELPER grid( m_toolMgr, frame()->GetMagneticItemsSettings() );
213 bool originSet = false;
214 EDA_UNITS units = frame()->GetUserUnits();
215 KIGFX::PREVIEW::RULER_ITEM ruler( twoPtMgr, pcbIUScale, units, invertXAxis, invertYAxis );
216
217 view.Add( &ruler );
218 view.SetVisible( &ruler, false );
219
220 auto setCursor =
221 [&]()
222 {
223 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::MEASURE );
224 };
225
226 auto cleanup =
227 [&] ()
228 {
229 view.SetVisible( &ruler, false );
230 controls.SetAutoPan( false );
231 controls.CaptureCursor( false );
232 controls.ForceCursorPosition( false );
233 originSet = false;
234 };
235
236 Activate();
237 // Must be done after Activate() so that it gets set into the correct context
238 controls.ShowCursor( true );
239 controls.SetAutoPan( false );
240 controls.CaptureCursor( false );
241 controls.ForceCursorPosition( false );
242
243 // Set initial cursor
244 setCursor();
245
246 while( TOOL_EVENT* evt = Wait() )
247 {
248 setCursor();
249 grid.SetSnap( !evt->Modifier( MD_SHIFT ) );
250 grid.SetUseGrid( view.GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
251 VECTOR2I cursorPos = evt->HasPosition() ? evt->Position() : controls.GetMousePosition();
252 cursorPos = grid.BestSnapAnchor( cursorPos, nullptr );
253 controls.ForceCursorPosition( true, cursorPos );
254
255 if( evt->IsCancelInteractive() )
256 {
257 if( originSet )
258 {
259 cleanup();
260 }
261 else
262 {
263 frame()->PopTool( aEvent );
264 break;
265 }
266 }
267 else if( evt->IsActivate() )
268 {
269 if( originSet )
270 cleanup();
271
272 if( evt->IsMoveTool() )
273 {
274 // leave ourselves on the stack so we come back after the move
275 break;
276 }
277 else
278 {
279 frame()->PopTool( aEvent );
280 break;
281 }
282 }
283 // click or drag starts
284 else if( !originSet && ( evt->IsDrag( BUT_LEFT ) || evt->IsClick( BUT_LEFT ) ) )
285 {
286 twoPtMgr.SetOrigin( cursorPos );
287 twoPtMgr.SetEnd( cursorPos );
288
289 controls.CaptureCursor( true );
290 controls.SetAutoPan( true );
291
292 originSet = true;
293 }
294 // second click or mouse up after drag ends
295 else if( originSet && ( evt->IsClick( BUT_LEFT ) || evt->IsMouseUp( BUT_LEFT ) ) )
296 {
297 originSet = false;
298
299 controls.SetAutoPan( false );
300 controls.CaptureCursor( false );
301 }
302 // move or drag when origin set updates rules
303 else if( originSet && ( evt->IsMotion() || evt->IsDrag( BUT_LEFT ) ) )
304 {
305 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
306 bool force45Deg;
307
308 if( frame()->IsType( FRAME_PCB_EDITOR ) )
309 force45Deg = mgr.GetAppSettings<PCBNEW_SETTINGS>()->m_Use45DegreeLimit;
310 else
311 force45Deg = mgr.GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>()->m_Use45Limit;
312
313 twoPtMgr.SetAngleSnap( force45Deg );
314 twoPtMgr.SetEnd( cursorPos );
315
316 view.SetVisible( &ruler, true );
317 view.Update( &ruler, KIGFX::GEOMETRY );
318 }
319 else if( evt->IsAction( &ACTIONS::updateUnits ) )
320 {
321 if( frame()->GetUserUnits() != units )
322 {
323 units = frame()->GetUserUnits();
324 ruler.SwitchUnits( units );
325 view.Update( &ruler, KIGFX::GEOMETRY );
326 canvas()->Refresh();
327 }
328
329 evt->SetPassEvent();
330 }
331 else if( evt->IsAction( &ACTIONS::updatePreferences ) )
332 {
333 invertXAxis = displayOptions().m_DisplayInvertXAxis;
334 invertYAxis = displayOptions().m_DisplayInvertYAxis;
335
336 if( IsFootprintFrame() )
337 {
340 }
341
342 ruler.UpdateDir( invertXAxis, invertYAxis );
343
344 view.Update( &ruler, KIGFX::GEOMETRY );
345 canvas()->Refresh();
346 evt->SetPassEvent();
347 }
348 else if( evt->IsClick( BUT_RIGHT ) )
349 {
351 }
352 else
353 {
354 evt->SetPassEvent();
355 }
356 }
357
358 view.SetVisible( &ruler, false );
359 view.Remove( &ruler );
360
361 frame()->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
362 controls.SetAutoPan( false );
363 controls.CaptureCursor( false );
364 controls.ForceCursorPosition( false );
365 return 0;
366}
367
368
370{
372
373 // Display modes
378
380}
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:171
static TOOL_ACTION updatePreferences
Definition: actions.h:184
static TOOL_ACTION updateUnits
Definition: actions.h:158
static TOOL_ACTION measureTool
Definition: actions.h:165
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:77
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Add a VIEW_ITEM to the view.
Definition: pcb_view.cpp:59
virtual void Remove(VIEW_ITEM *aItem) override
Remove a VIEW_ITEM from the view.
Definition: pcb_view.cpp:68
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:1545
Definition: pad.h:59
static TOOL_ACTION padDisplayMode
Definition: pcb_actions.h:323
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
Definition: pcb_actions.h:485
static TOOL_ACTION textOutlines
Display texts as lines.
Definition: pcb_actions.h:488
static TOOL_ACTION showPadNumbers
Definition: pcb_actions.h:330
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:123
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:253
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:104
@ PCB_DIMENSION_T
class PCB_DIMENSION_BASE: abstract dimension meta-type
Definition: typeinfo.h:98