KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eda_3d_controller.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) 2023 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#include <tool/actions.h>
26#include <tool/tool_manager.h>
27#include <eda_3d_canvas.h>
28#include <eda_3d_viewer_frame.h>
29#include <id.h>
30#include <kiface_base.h>
37
38
40{
41 std::shared_ptr<ACTION_MENU> rotateSubmenu = std::make_shared<ACTION_MENU>( true, this );
42 rotateSubmenu->SetTitle( _( "Rotate Board" ) );
43 rotateSubmenu->SetIcon( BITMAPS::rotate_cw );
44 m_menu->RegisterSubMenu( rotateSubmenu );
45
46 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateXCW );
47 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateXCCW );
48 rotateSubmenu->AppendSeparator();
49 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateYCW );
50 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateYCCW );
51 rotateSubmenu->AppendSeparator();
52 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateZCW );
53 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateZCCW );
54
55 std::shared_ptr<ACTION_MENU> moveSubmenu = std::make_shared<ACTION_MENU>( true, this );
56 moveSubmenu->SetTitle( _( "Move Board" ) );
57 moveSubmenu->SetIcon( BITMAPS::move );
58 m_menu->RegisterSubMenu( moveSubmenu );
59
60 moveSubmenu->Add( EDA_3D_ACTIONS::moveLeft );
61 moveSubmenu->Add( EDA_3D_ACTIONS::moveRight );
62 moveSubmenu->Add( EDA_3D_ACTIONS::moveUp );
63 moveSubmenu->Add( EDA_3D_ACTIONS::moveDown );
64
65 CONDITIONAL_MENU& ctxMenu = m_menu->GetMenu();
66
69
70 ctxMenu.AddSeparator();
77
78 ctxMenu.AddSeparator();
79 ctxMenu.AddMenu( rotateSubmenu.get(), SELECTION_CONDITIONS::ShowAlways );
81 ctxMenu.AddMenu( moveSubmenu.get(), SELECTION_CONDITIONS::ShowAlways );
82
83 return true;
84}
85
86
88{
89 m_canvas = nullptr;
90 m_boardAdapter = nullptr;
91 m_camera = nullptr;
92
93 TOOLS_HOLDER* holder = m_toolMgr->GetToolHolder();
94
95 wxCHECK( holder, /* void */ );
96 wxCHECK( holder->GetToolCanvas()->GetId() == EDA_3D_CANVAS_ID, /* void */ );
97
98 m_canvas = static_cast<EDA_3D_CANVAS*>( holder->GetToolCanvas() );
99
100 if( EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( holder ) )
101 {
102 wxCHECK( frame->GetFrameType() == FRAME_PCB_DISPLAY3D, /* void */ );
103
104 m_boardAdapter = &static_cast<EDA_3D_VIEWER_FRAME*>( frame )->GetAdapter();
105 m_camera = &static_cast<EDA_3D_VIEWER_FRAME*>( frame )->GetCurrentCamera();
106 }
107 else if( wxWindow* previewWindow = dynamic_cast<wxWindow*>( holder ) )
108 {
109 wxCHECK( previewWindow->GetId() == PANEL_PREVIEW_3D_MODEL_ID, /* void */ );
110
111 m_boardAdapter = &static_cast<PANEL_PREVIEW_3D_MODEL*>( holder )->GetAdapter();
112 m_camera = &static_cast<PANEL_PREVIEW_3D_MODEL*>( holder )->GetCurrentCamera();
113 }
114}
115
116
118{
119 ACTION_MENU* actionMenu = aEvent.Parameter<ACTION_MENU*>();
120 CONDITIONAL_MENU* conditionalMenu = dynamic_cast<CONDITIONAL_MENU*>( actionMenu );
121 SELECTION dummySel;
122
123 if( conditionalMenu )
124 conditionalMenu->Evaluate( dummySel );
125
126 if( actionMenu )
127 actionMenu->UpdateAll();
128
129 return 0;
130}
131
132
134{
135 // Main loop: keep receiving events
136 while( TOOL_EVENT* evt = Wait() )
137 {
138 if( evt->IsCancelInteractive() )
139 {
140 wxWindow* canvas = m_toolMgr->GetToolHolder()->GetToolCanvas();
141 KIWAY_HOLDER* parent = dynamic_cast<KIWAY_HOLDER*>( wxGetTopLevelParent( canvas ) );
142
143 if( parent && parent->GetType() == KIWAY_HOLDER::DIALOG )
144 {
145 DIALOG_SHIM* dialog = static_cast<DIALOG_SHIM*>( parent );
146
147 if( dialog->IsQuasiModal() )
148 dialog->EndQuasiModal( wxID_CANCEL );
149 else
150 dialog->EndModal( wxID_CANCEL );
151 }
152 else
153 {
154 evt->SetPassEvent();
155 }
156 }
157 else if( evt->IsMouseDown() )
158 {
159 }
160 else if( evt->IsClick() && ( evt->Buttons() & BUT_RIGHT ) )
161 {
162
163 if( !m_canvas->m_mouse_was_moved )
164 m_menu->ShowContextMenu();
165 }
166 else
167 {
168 evt->SetPassEvent();
169 }
170 }
171
172 return 0;
173}
174
175
177{
178 m_canvas->SetView3D( aEvent.Parameter<VIEW3D_TYPE>() );
179
180 return 0;
181}
182
183
185{
186 switch( aEvent.Parameter<ACTIONS::CURSOR_EVENT_TYPE>() )
187 {
188 case ACTIONS::CURSOR_UP: m_canvas->SetView3D( VIEW3D_TYPE::VIEW3D_PAN_UP ); break;
192 default: wxFAIL; break;
193 }
194
195 return 0;
196}
197
198
200{
201 double rotIncrement = glm::radians( m_rotationIncrement );
202
203 switch( aEvent.Parameter<ROTATION_DIR>() )
204 {
205 case ROTATION_DIR::X_CW: m_camera->RotateX( -rotIncrement ); break;
206 case ROTATION_DIR::X_CCW: m_camera->RotateX( rotIncrement ); break;
207
209 case ROTATION_DIR::Y_CW: m_camera->RotateY( rotIncrement ); break;
210 case ROTATION_DIR::Y_CCW: m_camera->RotateY( -rotIncrement ); break;
211 case ROTATION_DIR::Z_CW: m_camera->RotateZ( -rotIncrement ); break;
212 case ROTATION_DIR::Z_CCW: m_camera->RotateZ( rotIncrement ); break;
213 default: wxFAIL; break;
214 }
215
216 if( m_boardAdapter->m_Cfg->m_Render.engine == RENDER_ENGINE::OPENGL )
217 m_canvas->Request_refresh();
218 else
219 m_canvas->RenderRaytracingRequest();
220
221 return 0;
222}
223
224
226{
227 m_boardAdapter->m_Cfg->m_Render.material_mode = aEvent.Parameter<MATERIAL_MODE>();
228
229 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
230
231 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
232 static_cast<EDA_3D_VIEWER_FRAME*>( frame )->NewDisplay( true );
233 else
234 m_canvas->Request_refresh();
235
236 return 0;
237}
238
239
241{
242 m_camera->ToggleProjection();
243
244 if( m_boardAdapter->m_Cfg->m_Render.engine == RENDER_ENGINE::OPENGL )
245 m_canvas->Request_refresh();
246 else
247 m_canvas->RenderRaytracingRequest();
248
249 return 0;
250}
251
253{
254 std::bitset<LAYER_3D_END> visibilityFlags = m_boardAdapter->GetVisibleLayers();
255 APPEARANCE_CONTROLS_3D* appearanceManager = nullptr;
256
257 auto flipLayer =
258 [&]( int layer )
259 {
260 appearanceManager->OnLayerVisibilityChanged( layer, !visibilityFlags.test( layer ) );
261 };
262
263 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
264
265 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
266 appearanceManager = static_cast<EDA_3D_VIEWER_FRAME*>( frame )->GetAppearanceManager();
267
268 if( appearanceManager )
269 {
270 if( aEvent.IsAction( &EDA_3D_ACTIONS::showTHT ) ) flipLayer( LAYER_3D_TH_MODELS );
271 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showSMD ) ) flipLayer( LAYER_3D_SMD_MODELS );
272 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showVirtual ) ) flipLayer( LAYER_3D_VIRTUAL_MODELS );
274 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showDNP ) ) flipLayer( LAYER_3D_MODELS_MARKED_DNP );
275 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showNavigator ) ) flipLayer( LAYER_3D_NAVIGATOR );
276 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showBBoxes ) ) flipLayer( LAYER_3D_BOUNDING_BOXES );
277 }
278
279 return 0;
280}
281
282
284{
285 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
286
287 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
288 static_cast<EDA_3D_VIEWER_FRAME*>( frame )->ToggleAppearanceManager();
289
290 return 0;
291}
292
293
295{
296 m_boardAdapter->m_Cfg->m_Render.grid_type = aEvent.Parameter<GRID3D_TYPE>();
297
298 if( m_canvas )
299 m_canvas->Request_refresh();
300
301 return 0;
302}
303
304
306{
307 m_canvas->Request_refresh();
308 return 0;
309}
310
311
313{
314 bool direction = aEvent.IsAction( &ACTIONS::zoomIn );
315 return doZoomInOut( direction, true );
316}
317
318
320{
321 bool direction = aEvent.IsAction( &ACTIONS::zoomInCenter );
322 return doZoomInOut( direction, false );
323}
324
325
326int EDA_3D_CONTROLLER::doZoomInOut( bool aDirection, bool aCenterOnCursor )
327{
328 if( m_canvas )
329 {
331 m_canvas->DisplayStatus();
332 }
333
334 return 0;
335}
336
337
339{
340 if( m_canvas )
341 {
343 m_canvas->DisplayStatus();
344 }
345
346 return 0;
347}
348
349
351{
352 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
353
354 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
355 static_cast<EDA_3D_VIEWER_FRAME*>( frame )->NewDisplay( true );
356
357 return 0;
358}
359
360
362{
363 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
364
365 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
366 {
367 EDA_3D_VIEWER_FRAME* frame3d = static_cast<EDA_3D_VIEWER_FRAME*>( frame );
368
369 RENDER_ENGINE& engine = frame3d->GetAdapter().m_Cfg->m_Render.engine;
370 RENDER_ENGINE old_engine = engine;
371
372 if( old_engine == RENDER_ENGINE::OPENGL )
374 else
375 engine = RENDER_ENGINE::OPENGL;
376
377 // Directly tell the canvas the rendering engine changed
378 if( old_engine != engine )
379 frame3d->GetCanvas()->RenderEngineChanged();
380 }
381
382 return 0;
383}
384
385
387{
388 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
389
390 if( !frame || frame->GetFrameType() != FRAME_PCB_DISPLAY3D )
391 return 0;
392
393 EDA_3D_VIEWER_FRAME* viewer = static_cast<EDA_3D_VIEWER_FRAME*>( frame );
395
396 wxSize currentSize = viewer->GetCanvas()->GetClientSize();
397
399 {
400 viewer->ExportImage( fmt, currentSize );
401 return 0;
402 }
403
404 static wxSize lastSize( viewer->GetCanvas()->GetClientSize() );
406 DIALOG_EXPORT_3D_IMAGE dlg( viewer, currentSize );
407
408 if( dlg.ShowModal() == wxID_OK )
409 viewer->ExportImage( lastFormat, dlg.GetSize() );
410
411 return 0;
412}
413
414
416{
419
420 // Miscellaneous control
425
426 // Pan control
435
436 // View rotation
452
453 // Zoom control
458 // zoom in/out at cursor does not exist in 3D viewer but because F1 and F2 keys generate
459 // a zoomIn/zoomOut event, these events must be captured to use these hot keys. The actual
460 // zoom is the same as ZoomInOutCenter
463
464 // Grid
470
471 // Material
475
476 // Visibility
484}
485
486
ROTATION_DIR
Rotation direction for the 3d canvas.
Definition 3d_enums.h:35
GRID3D_TYPE
Grid types.
Definition 3d_enums.h:54
MATERIAL_MODE
Render 3d model shape materials mode.
Definition 3d_enums.h:71
RENDER_ENGINE
Render engine mode.
Definition 3d_enums.h:64
VIEW3D_TYPE
Definition 3d_enums.h:78
@ VIEW3D_ZOOM_OUT
Definition 3d_enums.h:94
@ VIEW3D_PAN_LEFT
Definition 3d_enums.h:91
@ VIEW3D_FIT_SCREEN
Definition 3d_enums.h:98
@ VIEW3D_ZOOM_IN
Definition 3d_enums.h:93
@ VIEW3D_PAN_UP
Definition 3d_enums.h:89
@ VIEW3D_PAN_DOWN
Definition 3d_enums.h:90
@ VIEW3D_PAN_RIGHT
Definition 3d_enums.h:92
static TOOL_ACTION zoomRedraw
Definition actions.h:131
static TOOL_ACTION zoomOutCenter
Definition actions.h:135
static TOOL_ACTION zoomIn
Definition actions.h:132
static TOOL_ACTION zoomOut
Definition actions.h:133
static TOOL_ACTION panDown
Definition actions.h:184
CURSOR_EVENT_TYPE
Definition actions.h:304
@ CURSOR_RIGHT
Definition actions.h:312
@ CURSOR_LEFT
Definition actions.h:310
@ CURSOR_UP
Definition actions.h:306
@ CURSOR_DOWN
Definition actions.h:308
static TOOL_ACTION panLeft
Definition actions.h:185
static TOOL_ACTION updateMenu
Definition actions.h:271
static TOOL_ACTION zoomFitScreen
Definition actions.h:141
static TOOL_ACTION panUp
Definition actions.h:183
static TOOL_ACTION zoomInCenter
Definition actions.h:134
static TOOL_ACTION panRight
Definition actions.h:186
Define the structure of a menu based on ACTIONs.
Definition action_menu.h:47
void UpdateAll()
Run update handlers for the menu and its submenus.
void OnLayerVisibilityChanged(int aLayer, bool isVisible)
EDA_3D_VIEWER_SETTINGS * m_Cfg
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.
void AddMenu(ACTION_MENU *aMenu, const SELECTION_CONDITION &aCondition=SELECTION_CONDITIONS::ShowAlways, int aOrder=ANY_ORDER)
Add a submenu to the menu.
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition dialog_shim.h:68
bool IsQuasiModal() const
Definition dialog_shim.h:93
void EndQuasiModal(int retCode)
int ShowModal() override
static TOOL_ACTION showNavigator
static TOOL_ACTION showLayersManager
static TOOL_ACTION rotateXCCW
static TOOL_ACTION showNotInPosFile
static TOOL_ACTION exportImage
static TOOL_ACTION showTHT
static TOOL_ACTION noGrid
static TOOL_ACTION show2_5mmGrid
static TOOL_ACTION reloadBoard
static TOOL_ACTION rotateZCCW
static TOOL_ACTION rotateZCW
static TOOL_ACTION rotateYCCW
static TOOL_ACTION rotateXCW
static TOOL_ACTION viewTop
static TOOL_ACTION show1mmGrid
static TOOL_ACTION showDNP
static TOOL_ACTION toggleOrtho
static TOOL_ACTION moveLeft
static TOOL_ACTION viewLeft
static TOOL_ACTION show10mmGrid
static TOOL_ACTION toggleRaytacing
static TOOL_ACTION viewBack
static TOOL_ACTION show5mmGrid
static TOOL_ACTION viewRight
static TOOL_ACTION showSMD
static TOOL_ACTION homeView
static TOOL_ACTION moveUp
static TOOL_ACTION flipView
static TOOL_ACTION moveDown
static TOOL_ACTION viewBottom
static TOOL_ACTION copyToClipboard
static TOOL_ACTION moveRight
static TOOL_ACTION materialDiffuse
static TOOL_ACTION pivotCenter
static TOOL_ACTION controlActivate
static TOOL_ACTION showVirtual
static TOOL_ACTION rotateYCW
static TOOL_ACTION materialCAD
static TOOL_ACTION viewFront
static TOOL_ACTION showBBoxes
static TOOL_ACTION materialNormal
Implement a canvas based on a wxGLCanvas.
void RenderEngineChanged()
Notify that the render engine was changed.
int On3DGridSelection(const TOOL_EVENT &aEvent)
double m_rotationIncrement
Rotation increment for the rotate actions (degrees)
int ZoomFitScreen(const TOOL_EVENT &aEvent)
EDA_3D_CANVAS * m_canvas
int ExportImage(const TOOL_EVENT &aEvent)
int doZoomInOut(bool aDirection, bool aCenterOnCursor)
int ToggleLayersManager(const TOOL_EVENT &aEvent)
int ToggleRaytracing(const TOOL_EVENT &aEvent)
int Main(const TOOL_EVENT &aEvent)
BOARD_ADAPTER * m_boardAdapter
int ZoomRedraw(const TOOL_EVENT &aEvent)
int ToggleOrtho(const TOOL_EVENT &aEvent)
int PanControl(const TOOL_EVENT &aEvent)
bool Init() override
Init() is called once upon a registration of the tool.
int ToggleVisibility(const TOOL_EVENT &aEvent)
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
void setTransitions() override
Set up handlers for various events.
int RotateView(const TOOL_EVENT &aEvent)
int SetMaterial(const TOOL_EVENT &aEvent)
int UpdateMenu(const TOOL_EVENT &aEvent)
int ViewControl(const TOOL_EVENT &aEvent)
int ReloadBoard(const TOOL_EVENT &aEvent)
int ZoomInOutCenter(const TOOL_EVENT &aEvent)
int ZoomInOut(const TOOL_EVENT &aEvent)
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
EDA_3D_CANVAS * GetCanvas()
BOARD_ADAPTER & GetAdapter()
void ExportImage(EDA_3D_VIEWER_EXPORT_FORMAT aFormat, const wxSize &aSize)
Export 3D viewer image to file or clipboard.
The base frame for deriving all KiCad main window classes.
FRAME_T GetFrameType() const
A mix in class which holds the location of a wxWindow's KIWAY.
HOLDER_TYPE GetType() const
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
TOOL_MANAGER * m_toolMgr
Definition tool_base.h:220
RESET_REASON
Determine the reason of reset for a tool.
Definition tool_base.h:78
Generic, UI-independent tool event.
Definition tool_event.h:171
bool IsAction(const TOOL_ACTION *aAction) const
Test if the event contains an action issued upon activation of the given TOOL_ACTION.
T Parameter() const
Return a parameter assigned to the event.
Definition tool_event.h:473
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).
std::unique_ptr< 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.
#define _(s)
#define EDA_3D_CANVAS_ID
Declaration of the eda_3d_viewer class.
EDA_3D_VIEWER_EXPORT_FORMAT
@ FRAME_PCB_DISPLAY3D
Definition frame_type.h:47
@ LAYER_3D_NAVIGATOR
Definition layer_ids.h:614
@ LAYER_3D_BOUNDING_BOXES
Definition layer_ids.h:615
@ LAYER_3D_SMD_MODELS
Definition layer_ids.h:610
@ LAYER_3D_TH_MODELS
Definition layer_ids.h:609
@ LAYER_3D_VIRTUAL_MODELS
Definition layer_ids.h:611
@ LAYER_3D_MODELS_MARKED_DNP
Definition layer_ids.h:613
@ LAYER_3D_MODELS_NOT_IN_POS
Definition layer_ids.h:612
#define PANEL_PREVIEW_3D_MODEL_ID
@ BUT_RIGHT
Definition tool_event.h:133