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 <3d_rendering/opengl/render_3d_opengl.h> // Must be included before any GL header
26
27#include <tool/actions.h>
28#include <tool/tool_manager.h>
29#include <eda_3d_canvas.h>
30#include <eda_3d_viewer_frame.h>
31#include <id.h>
32#include <kiface_base.h>
38
39
41{
42 std::shared_ptr<ACTION_MENU> rotateSubmenu = std::make_shared<ACTION_MENU>( true, this );
43 rotateSubmenu->SetUntranslatedTitle( _HKI( "Rotate Board" ) );
44 rotateSubmenu->SetIcon( BITMAPS::rotate_cw );
45 m_menu->RegisterSubMenu( rotateSubmenu );
46
47 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateXCW );
48 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateXCCW );
49 rotateSubmenu->AppendSeparator();
50 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateYCW );
51 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateYCCW );
52 rotateSubmenu->AppendSeparator();
53 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateZCW );
54 rotateSubmenu->Add( EDA_3D_ACTIONS::rotateZCCW );
55
56 std::shared_ptr<ACTION_MENU> moveSubmenu = std::make_shared<ACTION_MENU>( true, this );
57 moveSubmenu->SetUntranslatedTitle( _HKI( "Move Board" ) );
58 moveSubmenu->SetIcon( BITMAPS::move );
59 m_menu->RegisterSubMenu( moveSubmenu );
60
61 moveSubmenu->Add( EDA_3D_ACTIONS::moveLeft );
62 moveSubmenu->Add( EDA_3D_ACTIONS::moveRight );
63 moveSubmenu->Add( EDA_3D_ACTIONS::moveUp );
64 moveSubmenu->Add( EDA_3D_ACTIONS::moveDown );
65
66 CONDITIONAL_MENU& ctxMenu = m_menu->GetMenu();
67
70
71 ctxMenu.AddSeparator();
78
79 ctxMenu.AddSeparator();
80 ctxMenu.AddMenu( rotateSubmenu.get(), SELECTION_CONDITIONS::ShowAlways );
82 ctxMenu.AddMenu( moveSubmenu.get(), SELECTION_CONDITIONS::ShowAlways );
83
84 return true;
85}
86
87
89{
90 m_canvas = nullptr;
91 m_boardAdapter = nullptr;
92 m_camera = nullptr;
93
94 TOOLS_HOLDER* holder = m_toolMgr->GetToolHolder();
95
96 wxCHECK( holder, /* void */ );
97 wxCHECK( holder->GetToolCanvas()->GetId() == EDA_3D_CANVAS_ID, /* void */ );
98
99 m_canvas = static_cast<EDA_3D_CANVAS*>( holder->GetToolCanvas() );
100
101 if( EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( holder ) )
102 {
103 wxCHECK( frame->GetFrameType() == FRAME_PCB_DISPLAY3D, /* void */ );
104
105 m_boardAdapter = &static_cast<EDA_3D_VIEWER_FRAME*>( frame )->GetAdapter();
106 m_camera = &static_cast<EDA_3D_VIEWER_FRAME*>( frame )->GetCurrentCamera();
107 }
108 else if( wxWindow* previewWindow = dynamic_cast<wxWindow*>( holder ) )
109 {
110 wxCHECK( previewWindow->GetId() == PANEL_PREVIEW_3D_MODEL_ID, /* void */ );
111
112 m_boardAdapter = &static_cast<PANEL_PREVIEW_3D_MODEL*>( holder )->GetAdapter();
113 m_camera = &static_cast<PANEL_PREVIEW_3D_MODEL*>( holder )->GetCurrentCamera();
114 }
115}
116
117
119{
120 ACTION_MENU* actionMenu = aEvent.Parameter<ACTION_MENU*>();
121 CONDITIONAL_MENU* conditionalMenu = dynamic_cast<CONDITIONAL_MENU*>( actionMenu );
122 SELECTION dummySel;
123
124 if( conditionalMenu )
125 conditionalMenu->Evaluate( dummySel );
126
127 if( actionMenu )
128 actionMenu->UpdateAll();
129
130 return 0;
131}
132
133
135{
136 // Main loop: keep receiving events
137 while( TOOL_EVENT* evt = Wait() )
138 {
139 if( evt->IsCancelInteractive() )
140 {
141 wxWindow* canvas = m_toolMgr->GetToolHolder()->GetToolCanvas();
142 KIWAY_HOLDER* parent = dynamic_cast<KIWAY_HOLDER*>( wxGetTopLevelParent( canvas ) );
143
144 if( parent && parent->GetType() == KIWAY_HOLDER::DIALOG )
145 {
146 DIALOG_SHIM* dialog = static_cast<DIALOG_SHIM*>( parent );
147
148 if( dialog->IsQuasiModal() )
149 dialog->EndQuasiModal( wxID_CANCEL );
150 else
151 dialog->EndModal( wxID_CANCEL );
152 }
153 else
154 {
155 evt->SetPassEvent();
156 }
157 }
158 else if( evt->IsMouseDown() )
159 {
160 }
161 else if( evt->IsClick() && ( evt->Buttons() & BUT_RIGHT ) )
162 {
163
164 if( !m_canvas->m_mouse_was_moved )
165 m_menu->ShowContextMenu();
166 }
167 else
168 {
169 evt->SetPassEvent();
170 }
171 }
172
173 return 0;
174}
175
176
178{
179 m_canvas->SetView3D( aEvent.Parameter<VIEW3D_TYPE>() );
180
181 return 0;
182}
183
184
186{
187 switch( aEvent.Parameter<ACTIONS::CURSOR_EVENT_TYPE>() )
188 {
189 case ACTIONS::CURSOR_UP: m_canvas->SetView3D( VIEW3D_TYPE::VIEW3D_PAN_UP ); break;
193 default: wxFAIL; break;
194 }
195
196 return 0;
197}
198
199
201{
202 double rotIncrement = glm::radians( m_rotationIncrement );
203
204 switch( aEvent.Parameter<ROTATION_DIR>() )
205 {
206 case ROTATION_DIR::X_CW: m_camera->RotateX( -rotIncrement ); break;
207 case ROTATION_DIR::X_CCW: m_camera->RotateX( rotIncrement ); break;
208
210 case ROTATION_DIR::Y_CW: m_camera->RotateY( rotIncrement ); break;
211 case ROTATION_DIR::Y_CCW: m_camera->RotateY( -rotIncrement ); break;
212 case ROTATION_DIR::Z_CW: m_camera->RotateZ( -rotIncrement ); break;
213 case ROTATION_DIR::Z_CCW: m_camera->RotateZ( rotIncrement ); break;
214 default: wxFAIL; break;
215 }
216
217 if( m_boardAdapter->m_Cfg->m_Render.engine == RENDER_ENGINE::OPENGL )
218 m_canvas->Request_refresh();
219 else
220 m_canvas->RenderRaytracingRequest();
221
222 return 0;
223}
224
225
227{
228 m_boardAdapter->m_Cfg->m_Render.material_mode = aEvent.Parameter<MATERIAL_MODE>();
229
230 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
231
232 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
233 static_cast<EDA_3D_VIEWER_FRAME*>( frame )->NewDisplay( true );
234 else
235 m_canvas->Request_refresh();
236
237 return 0;
238}
239
240
242{
243 m_camera->ToggleProjection();
244
245 if( m_boardAdapter->m_Cfg->m_Render.engine == RENDER_ENGINE::OPENGL )
246 m_canvas->Request_refresh();
247 else
248 m_canvas->RenderRaytracingRequest();
249
250 return 0;
251}
252
254{
255 std::bitset<LAYER_3D_END> visibilityFlags = m_boardAdapter->GetVisibleLayers();
256 APPEARANCE_CONTROLS_3D* appearanceManager = nullptr;
257
258 auto flipLayer =
259 [&]( int layer )
260 {
261 appearanceManager->OnLayerVisibilityChanged( layer, !visibilityFlags.test( layer ) );
262 };
263
264 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
265
266 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
267 appearanceManager = static_cast<EDA_3D_VIEWER_FRAME*>( frame )->GetAppearanceManager();
268
269 if( appearanceManager )
270 {
271 if( aEvent.IsAction( &EDA_3D_ACTIONS::showTHT ) ) flipLayer( LAYER_3D_TH_MODELS );
272 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showSMD ) ) flipLayer( LAYER_3D_SMD_MODELS );
273 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showVirtual ) ) flipLayer( LAYER_3D_VIRTUAL_MODELS );
275 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showDNP ) ) flipLayer( LAYER_3D_MODELS_MARKED_DNP );
276 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showNavigator ) ) flipLayer( LAYER_3D_NAVIGATOR );
277 else if( aEvent.IsAction( &EDA_3D_ACTIONS::showBBoxes ) ) flipLayer( LAYER_3D_BOUNDING_BOXES );
278 }
279
280 return 0;
281}
282
283
285{
286 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
287
288 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
289 static_cast<EDA_3D_VIEWER_FRAME*>( frame )->ToggleAppearanceManager();
290
291 return 0;
292}
293
294
296{
297 m_boardAdapter->m_Cfg->m_Render.grid_type = aEvent.Parameter<GRID3D_TYPE>();
298
299 if( m_canvas )
300 m_canvas->Request_refresh();
301
302 return 0;
303}
304
305
307{
308 m_canvas->Request_refresh();
309 return 0;
310}
311
312
314{
315 bool direction = aEvent.IsAction( &ACTIONS::zoomIn );
316 return doZoomInOut( direction, true );
317}
318
319
321{
322 bool direction = aEvent.IsAction( &ACTIONS::zoomInCenter );
323 return doZoomInOut( direction, false );
324}
325
326
327int EDA_3D_CONTROLLER::doZoomInOut( bool aDirection, bool aCenterOnCursor )
328{
329 if( m_canvas )
330 {
332 m_canvas->DisplayStatus();
333 }
334
335 return 0;
336}
337
338
340{
341 if( m_canvas )
342 {
344 m_canvas->DisplayStatus();
345 }
346
347 return 0;
348}
349
350
352{
353 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
354
355 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
356 static_cast<EDA_3D_VIEWER_FRAME*>( frame )->NewDisplay( true );
357
358 return 0;
359}
360
361
363{
364 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
365
366 if( frame && frame->GetFrameType() == FRAME_PCB_DISPLAY3D )
367 {
368 EDA_3D_VIEWER_FRAME* frame3d = static_cast<EDA_3D_VIEWER_FRAME*>( frame );
369
370 RENDER_ENGINE& engine = frame3d->GetAdapter().m_Cfg->m_Render.engine;
371 RENDER_ENGINE old_engine = engine;
372
373 if( old_engine == RENDER_ENGINE::OPENGL )
375 else
376 engine = RENDER_ENGINE::OPENGL;
377
378 // Directly tell the canvas the rendering engine changed
379 if( old_engine != engine )
380 frame3d->GetCanvas()->RenderEngineChanged();
381 }
382
383 return 0;
384}
385
386
388{
389 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
390
391 if( !frame || frame->GetFrameType() != FRAME_PCB_DISPLAY3D )
392 return 0;
393
394 EDA_3D_VIEWER_FRAME* viewer = static_cast<EDA_3D_VIEWER_FRAME*>( frame );
396
397 wxSize currentSize = viewer->GetCanvas()->GetClientSize();
398
400 {
401 viewer->ExportImage( fmt, currentSize );
402 return 0;
403 }
404
405 static wxSize lastSize( viewer->GetCanvas()->GetClientSize() );
407 DIALOG_EXPORT_3D_IMAGE dlg( viewer, currentSize );
408
409 if( dlg.ShowModal() == wxID_OK )
410 viewer->ExportImage( lastFormat, dlg.GetSize() );
411
412 return 0;
413}
414
415
417{
420
421 // Miscellaneous control
426
427 // Pan control
436
437 // View rotation
453
454 // Zoom control
459 // zoom in/out at cursor does not exist in 3D viewer but because F1 and F2 keys generate
460 // a zoomIn/zoomOut event, these events must be captured to use these hot keys. The actual
461 // zoom is the same as ZoomInOutCenter
464
465 // Grid
471
472 // Material
476
477 // Visibility
486}
487
488
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:132
static TOOL_ACTION zoomOutCenter
Definition actions.h:136
static TOOL_ACTION zoomIn
Definition actions.h:133
static TOOL_ACTION zoomOut
Definition actions.h:134
static TOOL_ACTION panDown
Definition actions.h:185
CURSOR_EVENT_TYPE
Definition actions.h:303
@ CURSOR_RIGHT
Definition actions.h:311
@ CURSOR_LEFT
Definition actions.h:309
@ CURSOR_UP
Definition actions.h:305
@ CURSOR_DOWN
Definition actions.h:307
static TOOL_ACTION panLeft
Definition actions.h:186
static TOOL_ACTION updateMenu
Definition actions.h:270
static TOOL_ACTION zoomFitScreen
Definition actions.h:142
static TOOL_ACTION panUp
Definition actions.h:184
static TOOL_ACTION zoomInCenter
Definition actions.h:135
static TOOL_ACTION panRight
Definition actions.h:187
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 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:617
@ LAYER_3D_BOUNDING_BOXES
Definition layer_ids.h:618
@ LAYER_3D_SMD_MODELS
Definition layer_ids.h:613
@ LAYER_3D_TH_MODELS
Definition layer_ids.h:612
@ LAYER_3D_VIRTUAL_MODELS
Definition layer_ids.h:614
@ LAYER_3D_MODELS_MARKED_DNP
Definition layer_ids.h:616
@ LAYER_3D_MODELS_NOT_IN_POS
Definition layer_ids.h:615
#define _HKI(x)
Definition page_info.cpp:44
#define PANEL_PREVIEW_3D_MODEL_ID
@ BUT_RIGHT
Definition tool_event.h:133