KiCad PCB EDA Suite
eda_3d_canvas.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) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
5  * Copyright (C) 1992-2020 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 <gal/opengl/kiglew.h> // Must be included first
26 #include <gl_utils.h>
27 #include <wx/tokenzr.h>
28 
29 #include "../common_ogl/ogl_utils.h"
30 #include "eda_3d_canvas.h"
31 #include <eda_3d_viewer.h>
34 #include <3d_viewer_id.h>
35 #include <board.h>
36 #include <reporter.h>
37 #include <gl_context_mgr.h>
38 #include <profile.h> // To use GetRunningMicroSecs or another profiling utility
39 #include <bitmaps.h>
40 #include <macros.h>
41 #include <menus_helpers.h>
42 #include <pgm_base.h>
44 #include <tool/tool_dispatcher.h>
45 
47 
48 
56 const wxChar* EDA_3D_CANVAS::m_logTrace = wxT( "KI_TRACE_EDA_3D_CANVAS" );
57 
59 
60 
61 // A custom event, used to call DoRePaint during an idle time
62 wxDEFINE_EVENT( wxEVT_REFRESH_CUSTOM_COMMAND, wxEvent);
63 
64 
65 BEGIN_EVENT_TABLE( EDA_3D_CANVAS, wxGLCanvas )
66  EVT_PAINT( EDA_3D_CANVAS::OnPaint )
67 
68  // mouse events
69  EVT_LEFT_DOWN( EDA_3D_CANVAS::OnLeftDown )
70  EVT_LEFT_UP( EDA_3D_CANVAS::OnLeftUp )
71  EVT_MIDDLE_UP( EDA_3D_CANVAS::OnMiddleUp )
73  EVT_MOUSEWHEEL( EDA_3D_CANVAS::OnMouseWheel )
74  EVT_MOTION( EDA_3D_CANVAS::OnMouseMove )
75 
76 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
77  EVT_MAGNIFY( EDA_3D_CANVAS::OnMagnify )
78 #endif
79 
80  // other events
81  EVT_ERASE_BACKGROUND( EDA_3D_CANVAS::OnEraseBackground )
82  //EVT_REFRESH_CUSTOM_COMMAND( ID_CUSTOM_EVENT_1, EDA_3D_CANVAS::OnRefreshRequest )
83  EVT_CUSTOM(wxEVT_REFRESH_CUSTOM_COMMAND, ID_CUSTOM_EVENT_1, EDA_3D_CANVAS::OnRefreshRequest )
84 
85  EVT_CLOSE( EDA_3D_CANVAS::OnCloseWindow )
86  EVT_SIZE( EDA_3D_CANVAS::OnResize )
87 END_EVENT_TABLE()
88 
89 
90 EDA_3D_CANVAS::EDA_3D_CANVAS( wxWindow* aParent, const int* aAttribList, BOARD* aBoard,
91  BOARD_ADAPTER& aBoardAdapter, CAMERA& aCamera,
92  S3D_CACHE* a3DCachePointer )
93  : HIDPI_GL_CANVAS( aParent, wxID_ANY, aAttribList, wxDefaultPosition, wxDefaultSize,
94  wxFULL_REPAINT_ON_RESIZE ),
95  m_eventDispatcher( nullptr ),
96  m_parentStatusBar( nullptr ),
97  m_parentInfoBar( nullptr ),
98  m_glRC( nullptr ),
99  m_is_opengl_initialized( false ),
100  m_is_opengl_version_supported( true ),
101  m_mouse_is_moving( false ),
102  m_mouse_was_moved( false ),
103  m_camera_is_moving( false ),
104  m_render_pivot( false ),
105  m_camera_moving_speed( 1.0f ),
106  m_strtime_camera_movement( 0 ),
107  m_animation_enabled( true ),
108  m_moving_speed_multiplier( 3 ),
109  m_boardAdapter( aBoardAdapter ),
110  m_camera( aCamera ),
111  m_3d_render( nullptr ),
112  m_opengl_supports_raytracing( true ),
113  m_render_raytracing_was_requested( false ),
114  m_accelerator3DShapes( nullptr ),
115  m_currentRollOverItem( nullptr )
116 {
117  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::EDA_3D_CANVAS" );
118 
119  m_editing_timeout_timer.SetOwner( this );
120  Connect( m_editing_timeout_timer.GetId(), wxEVT_TIMER,
121  wxTimerEventHandler( EDA_3D_CANVAS::OnTimerTimeout_Editing ), nullptr, this );
122 
123  m_redraw_trigger_timer.SetOwner( this );
124  Connect( m_redraw_trigger_timer.GetId(), wxEVT_TIMER,
125  wxTimerEventHandler( EDA_3D_CANVAS::OnTimerTimeout_Redraw ), nullptr, this );
126 
127  m_is_currently_painting.clear();
128 
129  m_3d_render_raytracing = new RENDER_3D_RAYTRACE( m_boardAdapter, m_camera );
130  m_3d_render_ogl_legacy = new RENDER_3D_LEGACY( m_boardAdapter, m_camera );
131 
132  wxASSERT( m_3d_render_raytracing != nullptr );
133  wxASSERT( m_3d_render_ogl_legacy != nullptr );
134 
135  auto busy_indicator_factory = []() { return std::make_unique<WX_BUSY_INDICATOR>(); };
136 
137  m_3d_render_raytracing->SetBusyIndicatorFactory( busy_indicator_factory );
138  m_3d_render_ogl_legacy->SetBusyIndicatorFactory( busy_indicator_factory );
139 
140  RenderEngineChanged();
141 
142  wxASSERT( aBoard != nullptr );
143  m_boardAdapter.SetBoard( aBoard );
144 
145  m_boardAdapter.SetColorSettings( Pgm().GetSettingsManager().GetColorSettings() );
146 
147  wxASSERT( a3DCachePointer != nullptr );
148  m_boardAdapter.Set3dCacheManager( a3DCachePointer );
149 
150  const wxEventType events[] =
151  {
152  // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
153  // especially special key like arrow keys, are handled by the GAL event dispatcher,
154  // and not sent to GUI without filtering, because they have a default action (scroll)
155  // that must not be called.
156  wxEVT_LEFT_UP, wxEVT_LEFT_DOWN, wxEVT_LEFT_DCLICK,
157  wxEVT_RIGHT_UP, wxEVT_RIGHT_DOWN, wxEVT_RIGHT_DCLICK,
158  wxEVT_MIDDLE_UP, wxEVT_MIDDLE_DOWN, wxEVT_MIDDLE_DCLICK,
159  wxEVT_MOTION, wxEVT_MOUSEWHEEL, wxEVT_CHAR, wxEVT_CHAR_HOOK,
160 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
161  wxEVT_MAGNIFY,
162 #endif
163  wxEVT_MENU_OPEN, wxEVT_MENU_CLOSE, wxEVT_MENU_HIGHLIGHT
164  };
165 
166  for( wxEventType eventType : events )
167  Connect( eventType, wxEventHandler( EDA_3D_CANVAS::OnEvent ), nullptr, m_eventDispatcher );
168 }
169 
170 
172 {
173  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::~EDA_3D_CANVAS" );
174 
175  delete m_accelerator3DShapes;
176  m_accelerator3DShapes = nullptr;
177 
178  releaseOpenGL();
179 }
180 
181 
183 {
184  if( m_glRC )
185  {
187 
188  delete m_3d_render_raytracing;
189  m_3d_render_raytracing = nullptr;
190 
191  delete m_3d_render_ogl_legacy;
192  m_3d_render_ogl_legacy = nullptr;
193 
194  // This is just a copy of a pointer, can safely be set to NULL.
195  m_3d_render = nullptr;
196 
199  m_glRC = nullptr;
200  }
201 }
202 
203 
204 void EDA_3D_CANVAS::OnCloseWindow( wxCloseEvent& event )
205 {
206  releaseOpenGL();
207 
208  event.Skip();
209 }
210 
211 
212 void EDA_3D_CANVAS::OnResize( wxSizeEvent& event )
213 {
214  this->Request_refresh();
215 }
216 
217 
219 {
220  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::initializeOpenGL" );
221 
222  const GLenum err = glewInit();
223 
224  if( GLEW_OK != err )
225  {
226  const wxString msgError = (const char*) glewGetErrorString( err );
227 
228  wxLogMessage( msgError );
229 
230  return false;
231  }
232  else
233  {
234  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::initializeOpenGL Using GLEW version %s",
235  FROM_UTF8( (char*) glewGetString( GLEW_VERSION ) ) );
236  }
237 
238  wxString version = FROM_UTF8( (char *) glGetString( GL_VERSION ) );
239 
240  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::%s OpenGL version string %s.",
241  __WXFUNCTION__, version );
242 
243  // Extract OpenGL version from string. This method is used because prior to OpenGL 2,
244  // getting the OpenGL major and minor version as integers didn't exist.
245  wxString tmp;
246 
247  wxStringTokenizer tokenizer( version );
248 
249  if( tokenizer.HasMoreTokens() )
250  {
251  long major = 0;
252  long minor = 0;
253 
254  tmp = tokenizer.GetNextToken();
255 
256  tokenizer.SetString( tmp, wxString( "." ) );
257 
258  if( tokenizer.HasMoreTokens() )
259  tokenizer.GetNextToken().ToLong( &major );
260 
261  if( tokenizer.HasMoreTokens() )
262  tokenizer.GetNextToken().ToLong( &minor );
263 
264  if( major < 2 || ( ( major == 2 ) && ( minor < 1 ) ) )
265  {
266  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::%s OpenGL ray tracing not supported.",
267  __WXFUNCTION__ );
268 
269  if( GetParent() )
270  {
271  wxCommandEvent evt( wxEVT_MENU, ID_DISABLE_RAY_TRACING );
272  GetParent()->ProcessWindowEvent( evt );
273  }
274 
276  }
277 
278  if( ( major == 1 ) && ( minor < 5 ) )
279  {
280  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::%s OpenGL not supported.", __WXFUNCTION__ );
281 
283  }
284  }
285 
288 
289  return true;
290 }
291 
292 
293 void EDA_3D_CANVAS::GetScreenshot( wxImage& aDstImage )
294 {
295  OglGetScreenshot( aDstImage );
296 }
297 
298 
299 void EDA_3D_CANVAS::ReloadRequest( BOARD* aBoard , S3D_CACHE* aCachePointer )
300 {
301  if( aCachePointer != nullptr )
302  m_boardAdapter.Set3dCacheManager( aCachePointer );
303 
304  if( aBoard != nullptr )
305  m_boardAdapter.SetBoard( aBoard );
306 
307  m_boardAdapter.SetColorSettings( Pgm().GetSettingsManager().GetColorSettings() );
308 
309  if( m_3d_render )
311 }
312 
313 
315 {
317 
318  if( m_3d_render )
320 
322 
323  Request_refresh();
324 }
325 
326 
328 {
329  if( m_parentStatusBar )
330  {
331  wxString msg;
332 
333  msg.Printf( "dx %3.2f", m_camera.GetCameraPos().x );
334  m_parentStatusBar->SetStatusText( msg, static_cast<int>( EDA_3D_VIEWER_STATUSBAR::X_POS ) );
335 
336  msg.Printf( "dy %3.2f", m_camera.GetCameraPos().y );
337  m_parentStatusBar->SetStatusText( msg, static_cast<int>( EDA_3D_VIEWER_STATUSBAR::Y_POS ) );
338  }
339 }
340 
341 
342 void EDA_3D_CANVAS::OnPaint( wxPaintEvent& aEvent )
343 {
344  // Please have a look at: https://lists.launchpad.net/kicad-developers/msg25149.html
345  DoRePaint();
346 }
347 
348 
350 {
351  if( m_is_currently_painting.test_and_set() )
352  return;
353 
354  // SwapBuffer requires the window to be shown before calling
355  if( !IsShownOnScreen() )
356  {
357  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::DoRePaint !IsShown" );
358  m_is_currently_painting.clear();
359  return;
360  }
361 
362  // Because the board to draw is handled by the parent viewer frame,
363  // ensure this parent is still alive. When it is closed before the viewer
364  // frame, a paint event can be generated after the parent is closed,
365  // therefore with invalid board.
366  // This is dependent of the platform.
367  // Especially on OSX, but also on Windows, it frequently happens
368  if( !GetParent()->GetParent()->IsShown() )
369  return; // The parent board editor frame is no more alive
370 
371  wxString err_messages;
372 
373  // !TODO: implement error reporter
374  INFOBAR_REPORTER warningReporter( m_parentInfoBar );
375  STATUSBAR_REPORTER activityReporter( m_parentStatusBar,
377 
378  unsigned strtime = GetRunningMicroSecs();
379 
380  // "Makes the OpenGL state that is represented by the OpenGL rendering
381  // context context current, i.e. it will be used by all subsequent OpenGL calls.
382  // This function may only be called when the window is shown on screen"
383 
384  // Explicitly create a new rendering context instance for this canvas.
385  if( m_glRC == nullptr )
387 
389 
390  // Set the OpenGL viewport according to the client size of this canvas.
391  // This is done here rather than in a wxSizeEvent handler because our
392  // OpenGL rendering context (and thus viewport setting) is used with
393  // multiple canvases: If we updated the viewport in the wxSizeEvent
394  // handler, changing the size of one canvas causes a viewport setting that
395  // is wrong when next another canvas is repainted.
396  wxSize clientSize = GetNativePixelSize();
397 
398  const bool windows_size_changed = m_camera.SetCurWindowSize( clientSize );
399 
400  // Initialize openGL if need
402  {
403  if( !initializeOpenGL() )
404  {
406  m_is_currently_painting.clear();
407 
408  return;
409  }
410 
412  {
413  warningReporter.Report( _( "Your OpenGL version is not supported. Minimum required "
414  "is 1.5" ), RPT_SEVERITY_ERROR );
415 
416  warningReporter.Finalize();
417  }
418  }
419 
421  {
422  glClearColor( 0.0f, 0.0f, 0.0f, 1.0f );
423  glClear( GL_COLOR_BUFFER_BIT );
424 
425  SwapBuffers();
426 
428  m_is_currently_painting.clear();
429 
430  return;
431  }
432 
433  // Don't attend to ray trace if OpenGL doesn't support it.
435  {
439  }
440 
441  // Check if a raytacing was requested and need to switch to raytracing mode
443  {
444  const bool was_camera_changed = m_camera.ParametersChanged();
445 
446  // It reverts back to OpenGL mode if it was requested a raytracing
447  // render of the current scene. AND the mouse / camera is moving
448  if( ( m_mouse_is_moving || m_camera_is_moving || was_camera_changed
449  || windows_size_changed )
451  {
454  }
455  }
456 
457  float curtime_delta_s = 0.0f;
458 
459  if( m_camera_is_moving )
460  {
461  const unsigned curtime_delta = GetRunningMicroSecs() - m_strtime_camera_movement;
462  curtime_delta_s = (curtime_delta / 1e6) * m_camera_moving_speed;
463  m_camera.Interpolate( curtime_delta_s );
464 
465  if( curtime_delta_s > 1.0f )
466  {
467  m_render_pivot = false;
468  m_camera_is_moving = false;
469  m_mouse_was_moved = true;
470 
472  DisplayStatus();
473  }
474  else
475  {
476  Request_refresh();
477  }
478  }
479 
480  // It will return true if the render request a new redraw
481  bool requested_redraw = false;
482 
483  if( m_3d_render )
484  {
485  try
486  {
487  m_3d_render->SetCurWindowSize( clientSize );
488 
489  bool reloadRaytracingForIntersectionCalculations = false;
490 
493  {
494  reloadRaytracingForIntersectionCalculations = true;
495  }
496 
497  requested_redraw = m_3d_render->Redraw( m_mouse_was_moved || m_camera_is_moving,
498  &activityReporter, &warningReporter );
499 
500  if( reloadRaytracingForIntersectionCalculations )
501  m_3d_render_raytracing->Reload( nullptr, nullptr, true );
502  }
503  catch( std::runtime_error& )
504  {
507  m_is_opengl_initialized = false;
509  m_is_currently_painting.clear();
510  return;
511  }
512  }
513 
514  if( m_render_pivot )
515  {
516  const float scale = glm::min( m_camera.ZoomGet(), 1.0f );
517  render_pivot( curtime_delta_s, scale * scale );
518  }
519 
520  // "Swaps the double-buffer of this window, making the back-buffer the
521  // front-buffer and vice versa, so that the output of the previous OpenGL
522  // commands is displayed on the window."
523  SwapBuffers();
524 
526 
527  if( !activityReporter.HasMessage() )
528  {
530  {
531  // Calculation time in milliseconds
532  const double calculation_time = (double)( GetRunningMicroSecs() - strtime) / 1e3;
533 
534  activityReporter.Report( wxString::Format( _( "Last render time %.0f ms" ),
535  calculation_time ) );
536  }
537  }
538 
539  // This will reset the flag of camera parameters changed
541 
542  warningReporter.Finalize();
543 
544  if( !err_messages.IsEmpty() )
545  wxLogMessage( err_messages );
546 
547  if( ( !m_camera_is_moving ) && requested_redraw )
548  {
549  m_mouse_was_moved = false;
550  Request_refresh( false );
551  }
552 
553  m_is_currently_painting.clear();
554 }
555 
556 
558 {
559  m_eventDispatcher = aEventDispatcher;
560 }
561 
562 
563 void EDA_3D_CANVAS::OnEvent( wxEvent& aEvent )
564 {
565  if( !m_eventDispatcher )
566  aEvent.Skip();
567  else
569 
570  Refresh();
571 }
572 
573 
574 void EDA_3D_CANVAS::OnEraseBackground( wxEraseEvent& event )
575 {
576  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::OnEraseBackground" );
577  // Do nothing, to avoid flashing.
578 }
579 
580 
581 void EDA_3D_CANVAS::OnMouseWheel( wxMouseEvent& event )
582 {
583  bool mouseActivity = false;
584 
585  wxLogTrace( m_logTrace, "EDA_3D_CANVAS::OnMouseWheel" );
586 
587  if( m_camera_is_moving )
588  return;
589 
590  float delta_move = m_delta_move_step_factor * m_camera.ZoomGet();
591 
593  delta_move *= 0.01f * event.GetWheelRotation();
594  else
595  if( event.GetWheelRotation() < 0 )
596  delta_move = -delta_move;
597 
598  // mousewheel_panning enabled:
599  // wheel -> pan;
600  // wheel + shift -> horizontal scrolling;
601  // wheel + ctrl -> zooming;
602  // mousewheel_panning disabled:
603  // wheel + shift -> vertical scrolling;
604  // wheel + ctrl -> horizontal scrolling;
605  // wheel -> zooming.
606 
607  if( m_boardAdapter.GetFlag( FL_MOUSEWHEEL_PANNING ) && !event.ControlDown() )
608  {
609  if( event.GetWheelAxis() == wxMOUSE_WHEEL_HORIZONTAL || event.ShiftDown() )
610  m_camera.Pan( SFVEC3F( -delta_move, 0.0f, 0.0f ) );
611  else
612  m_camera.Pan( SFVEC3F( 0.0f, -delta_move, 0.0f ) );
613 
614  mouseActivity = true;
615  }
616  else if( event.ShiftDown() && !m_boardAdapter.GetFlag( FL_MOUSEWHEEL_PANNING ) )
617  {
618  m_camera.Pan( SFVEC3F( 0.0f, -delta_move, 0.0f ) );
619  mouseActivity = true;
620  }
621  else if( event.ControlDown() && !m_boardAdapter.GetFlag( FL_MOUSEWHEEL_PANNING ) )
622  {
623  m_camera.Pan( SFVEC3F( delta_move, 0.0f, 0.0f ) );
624  mouseActivity = true;
625  }
626  else
627  {
628  mouseActivity = m_camera.Zoom( event.GetWheelRotation() > 0 ? 1.1f : 1/1.1f );
629  }
630 
631  // If it results on a camera movement
632  if( mouseActivity )
633  {
634  DisplayStatus();
635  Request_refresh();
636 
637  m_mouse_is_moving = true;
638  m_mouse_was_moved = true;
639 
641  }
642 
643  // Update the cursor current mouse position on the camera
644  m_camera.SetCurMousePosition( event.GetPosition() );
645 }
646 
647 
648 #if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
649 void EDA_3D_CANVAS::OnMagnify( wxMouseEvent& event )
650 {
651  SetFocus();
652 
653  if( m_camera_is_moving )
654  return;
655 
656  //m_is_moving_mouse = true;
658 
659  float magnification = ( event.GetMagnification() + 1.0f );
660 
661  m_camera.Zoom( magnification );
662 
663  DisplayStatus();
664  Request_refresh();
665 }
666 #endif
667 
668 
669 void EDA_3D_CANVAS::OnMouseMove( wxMouseEvent& event )
670 {
671  //wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::OnMouseMove" ) );
672 
673  if( m_camera_is_moving )
674  return;
675 
677 
678  if( event.Dragging() )
679  {
680  if( event.LeftIsDown() ) // Drag
681  m_camera.Drag( event.GetPosition() );
682  else if( event.MiddleIsDown() ) // Pan
683  m_camera.Pan( event.GetPosition() );
684 
685  m_mouse_is_moving = true;
686  m_mouse_was_moved = true;
687 
688  // orientation has changed, redraw mesh
689  DisplayStatus();
690  Request_refresh();
691  }
692 
693  const wxPoint eventPosition = event.GetPosition();
694  m_camera.SetCurMousePosition( eventPosition );
695 
696  if( !event.Dragging() &&
698  {
700  static_cast<int>( EDA_3D_VIEWER_STATUSBAR::HOVERED_ITEM ) );
701 
702  RAY mouseRay = getRayAtCurrrentMousePosition();
703 
704  BOARD_ITEM *rollOverItem = m_3d_render_raytracing->IntersectBoardItem( mouseRay );
705 
706  if( rollOverItem )
707  {
708  if( rollOverItem != m_currentRollOverItem )
709  {
711  m_currentRollOverItem = rollOverItem;
712 
713  Request_refresh();
714  }
715 
716  switch( rollOverItem->Type() )
717  {
718  case PCB_PAD_T:
719  {
720  PAD* pad = dynamic_cast<PAD*>( rollOverItem );
721 
722  if( pad && pad->IsOnCopperLayer() )
723  {
724  reporter.Report( wxString::Format( _( "Net %s\tNetClass %s\tPadName %s" ),
725  pad->GetNet()->GetNetname(),
726  pad->GetNet()->GetNetClassName(),
727  pad->GetName() ) );
728  }
729  }
730  break;
731 
732  case PCB_FOOTPRINT_T:
733  {
734  FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( rollOverItem );
735 
736  if( footprint )
737  reporter.Report( footprint->GetReference() );
738  }
739  break;
740 
741  case PCB_TRACE_T:
742  case PCB_VIA_T:
743  case PCB_ARC_T:
744  {
745  PCB_TRACK* track = dynamic_cast<PCB_TRACK*>( rollOverItem );
746 
747  if( track )
748  {
749  reporter.Report( wxString::Format( _( "Net %s\tNetClass %s" ),
750  track->GetNet()->GetNetname(),
751  track->GetNet()->GetNetClassName() ) );
752  }
753  }
754  break;
755 
756  case PCB_ZONE_T:
757  {
758  ZONE* zone = dynamic_cast<ZONE*>( rollOverItem );
759 
760  if( zone && zone->IsOnCopperLayer() )
761  {
762  reporter.Report( wxString::Format( _( "Net %s\tNetClass %s" ),
763  zone->GetNet()->GetNetname(),
764  zone->GetNet()->GetNetClassName() ) );
765  }
766  }
767  break;
768 
769  default:
770  break;
771  }
772  }
773  else
774  {
775  if( ( m_currentRollOverItem != nullptr ) &&
777  {
779  Request_refresh();
780 
781  reporter.Report( "" );
782  }
783 
784  m_currentRollOverItem = nullptr;
785  }
786  }
787 }
788 
789 
790 void EDA_3D_CANVAS::OnLeftDown( wxMouseEvent& event )
791 {
792  SetFocus();
794 
795  if( !event.Dragging() && ( m_3d_render_raytracing != nullptr ) )
796  {
797  RAY mouseRay = getRayAtCurrrentMousePosition();
798 
799  BOARD_ITEM *intersectedBoardItem = m_3d_render_raytracing->IntersectBoardItem( mouseRay );
800 
801  // !TODO: send a selection item to pcbnew, eg: via kiway?
802  }
803 }
804 
805 
806 void EDA_3D_CANVAS::OnLeftUp( wxMouseEvent& event )
807 {
808  if( m_camera_is_moving )
809  return;
810 
811  if( m_mouse_is_moving )
812  {
813  m_mouse_is_moving = false;
815  }
816 }
817 
818 
819 void EDA_3D_CANVAS::OnMiddleDown( wxMouseEvent& event )
820 {
821  SetFocus();
823 }
824 
825 
826 void EDA_3D_CANVAS::OnMiddleUp( wxMouseEvent& event )
827 {
828  if( m_camera_is_moving )
829  return;
830 
831  if( m_mouse_is_moving )
832  {
833  m_mouse_is_moving = false;
835  }
836  else
837  {
839  }
840 }
841 
842 
843 void EDA_3D_CANVAS::OnTimerTimeout_Editing( wxTimerEvent& event )
844 {
845  (void)event;
846 
847  m_mouse_is_moving = false;
848  m_mouse_was_moved = false;
849 
850  Request_refresh();
851 }
852 
853 
855 {
857 }
858 
859 
861 {
862  if( m_3d_render )
863  m_editing_timeout_timer.Start( m_3d_render->GetWaitForEditingTimeOut(), wxTIMER_ONE_SHOT );
864 }
865 
866 
867 void EDA_3D_CANVAS::OnTimerTimeout_Redraw( wxTimerEvent& event )
868 {
869  Request_refresh( true );
870 }
871 
872 
873 void EDA_3D_CANVAS::OnRefreshRequest( wxEvent& aEvent )
874 {
875  DoRePaint();
876 }
877 
878 
879 void EDA_3D_CANVAS::Request_refresh( bool aRedrawImmediately )
880 {
881  if( aRedrawImmediately )
882  {
883  // Just calling Refresh() does not work always
884  // Using an event to call DoRepaint ensure the repaint code will be executed,
885  // and PostEvent will take priority to other events like mouse movements, keys, etc.
886  // and is executed during the next idle time
887  wxCommandEvent redrawEvent( wxEVT_REFRESH_CUSTOM_COMMAND, ID_CUSTOM_EVENT_1 );
888  wxPostEvent( this, redrawEvent );
889  }
890  else
891  {
892  // Schedule a timed redraw
893  m_redraw_trigger_timer.Start( 10 , wxTIMER_ONE_SHOT );
894  }
895 }
896 
897 
898 void EDA_3D_CANVAS::request_start_moving_camera( float aMovingSpeed, bool aRenderPivot )
899 {
900  wxASSERT( aMovingSpeed > FLT_EPSILON );
901 
902  // Fast forward the animation if the animation is disabled
903  if( !m_animation_enabled )
904  {
905  m_camera.Interpolate( 1.0f );
906  DisplayStatus();
907  Request_refresh();
908  return;
909  }
910 
911  // Map speed multiplier option to actual multiplier value
912  // [1,2,3,4,5] -> [0.25, 0.5, 1, 2, 4]
913  aMovingSpeed *= ( 1 << m_moving_speed_multiplier ) / 8.0f;
914 
915  m_render_pivot = aRenderPivot;
916  m_camera_moving_speed = aMovingSpeed;
917 
919 
920  DisplayStatus();
921  Request_refresh();
922 
923  m_camera_is_moving = true;
924 
926 }
927 
928 
930 {
931  RAY mouseRay = getRayAtCurrrentMousePosition();
932 
933  float hit_t;
934 
935  // Test it with the board bounding box
936  if( m_boardAdapter.GetBBox().Intersect( mouseRay, &hit_t ) )
937  {
940  m_camera.SetLookAtPos_T1( mouseRay.at( hit_t ) );
942 
944  }
945 }
946 
947 
948 bool EDA_3D_CANVAS::SetView3D( int aKeycode )
949 {
950  if( m_camera_is_moving )
951  return false;
952 
953  const float delta_move = m_delta_move_step_factor * m_camera.ZoomGet();
954  const float arrow_moving_time_speed = 8.0f;
955  bool handled = false;
956 
957  switch( aKeycode )
958  {
959  case WXK_SPACE:
961  return true;
962 
963  case WXK_LEFT:
966  m_camera.Pan_T1( SFVEC3F( -delta_move, 0.0f, 0.0f ) );
967  request_start_moving_camera( arrow_moving_time_speed, false );
968  return true;
969 
970  case WXK_RIGHT:
973  m_camera.Pan_T1( SFVEC3F( +delta_move, 0.0f, 0.0f ) );
974  request_start_moving_camera( arrow_moving_time_speed, false );
975  return true;
976 
977  case WXK_UP:
980  m_camera.Pan_T1( SFVEC3F( 0.0f, +delta_move, 0.0f ) );
981  request_start_moving_camera( arrow_moving_time_speed, false );
982  return true;
983 
984  case WXK_DOWN:
987  m_camera.Pan_T1( SFVEC3F( 0.0f, -delta_move, 0.0f ) );
988  request_start_moving_camera( arrow_moving_time_speed, false );
989  return true;
990 
991  case WXK_HOME:
994  m_camera.Reset_T1();
995  request_start_moving_camera( glm::min( glm::max( m_camera.ZoomGet(), 1/1.26f ), 1.26f ) );
996  return true;
997 
998  case WXK_END:
999  break;
1000 
1001  case WXK_TAB:
1004  m_camera.RotateZ_T1( glm::radians( 45.0f ) );
1006  handled = true;
1007  break;
1008 
1009  case WXK_F1:
1012 
1013  if( m_camera.Zoom_T1( 1.26f ) ) // 3 steps per doubling
1015 
1016  return true;
1017 
1018  case WXK_F2:
1021 
1022  if( m_camera.Zoom_T1( 1/1.26f ) ) // 3 steps per halving
1024 
1025  return true;
1026 
1027  case ID_VIEW3D_RESET:
1030  m_camera.Reset_T1();
1031  request_start_moving_camera( glm::min( glm::max( m_camera.ZoomGet(), 0.5f ), 1.125f ) );
1032  return true;
1033 
1034  case ID_VIEW3D_RIGHT:
1037  m_camera.Reset_T1();
1038  m_camera.RotateZ_T1( glm::radians( -90.0f ) );
1039  m_camera.RotateX_T1( glm::radians( -90.0f ) );
1041  return true;
1042 
1043  case ID_VIEW3D_LEFT:
1046  m_camera.Reset_T1();
1047  m_camera.RotateZ_T1( glm::radians( 90.0f ) );
1048  m_camera.RotateX_T1( glm::radians( -90.0f ) );
1050  return true;
1051 
1052  case ID_VIEW3D_FRONT:
1055  m_camera.Reset_T1();
1056  m_camera.RotateX_T1( glm::radians( -90.0f ) );
1058  return true;
1059 
1060  case ID_VIEW3D_BACK:
1063  m_camera.Reset_T1();
1064  m_camera.RotateX_T1( glm::radians( -90.0f ) );
1065 
1066  // The rotation angle should be 180.
1067  // We use 179.999 (180 - epsilon) to avoid a full 360 deg rotation when
1068  // using 180 deg if the previous rotated position was already 180 deg
1069  m_camera.RotateZ_T1( glm::radians( 179.999f ) );
1071  return true;
1072 
1073  case ID_VIEW3D_TOP:
1076  m_camera.Reset_T1();
1077  request_start_moving_camera( glm::min( glm::max( m_camera.ZoomGet(), 0.5f ), 1.125f ) );
1078  return true;
1079 
1080  case ID_VIEW3D_BOTTOM:
1083  m_camera.Reset_T1();
1084  m_camera.RotateY_T1( glm::radians( 179.999f ) ); // Rotation = 180 - epsilon
1085  request_start_moving_camera( glm::min( glm::max( m_camera.ZoomGet(), 0.5f ), 1.125f ) );
1086  return true;
1087 
1088  case ID_VIEW3D_FLIP:
1091  m_camera.RotateY_T1( glm::radians( 179.999f ) );
1093  return true;
1094 
1095  default:
1096  return false;
1097  }
1098 
1099  m_mouse_was_moved = true;
1100 
1102 
1103  DisplayStatus();
1104  Request_refresh();
1105 
1106  return handled;
1107 }
1108 
1109 
1111 {
1112  switch( m_boardAdapter.GetRenderEngine() )
1113  {
1116  default: m_3d_render = nullptr; break;
1117  }
1118 
1119  if( m_3d_render )
1121 
1122  m_mouse_was_moved = false;
1123 
1124  Request_refresh();
1125 }
1126 
1127 
1129 {
1130  SFVEC3F rayOrigin;
1131  SFVEC3F rayDir;
1132 
1133  // Generate a ray origin and direction based on current mouser position and camera
1134  m_camera.MakeRayAtCurrrentMousePosition( rayOrigin, rayDir );
1135 
1136  RAY mouseRay;
1137  mouseRay.Init( rayOrigin, rayDir );
1138 
1139  return mouseRay;
1140 }
A wrapper for reporting to a specific text location in a statusbar.
Definition: reporter.h:280
virtual wxSize GetNativePixelSize() const
void SetLookAtPos_T1(const SFVEC3F &aLookAtPos)
Definition: camera.h:125
virtual void Pan(const wxPoint &aNewMousePosition)=0
bool GetFlag(DISPLAY3D_FLG aFlag) const
Get a configuration status of a flag.
void RotateZ_T1(float aAngleInRadians)
Definition: camera.cpp:543
void SetCurrentRollOverItem(BOARD_ITEM *aRollOverItem)
bool IsReloadRequestPending() const
Query if there is a pending reload request.
void OnMouseMove(wxMouseEvent &event)
bool Zoom_T1(float aFactor)
Definition: camera.cpp:484
void OnResize(wxSizeEvent &event)
void ReloadRequest()
void request_start_moving_camera(float aMovingSpeed=2.0f, bool aRenderPivot=true)
Start a camera movement.
void releaseOpenGL()
Free created targets and openGL context.
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
bool m_mouse_is_moving
virtual void Pan_T1(const SFVEC3F &aDeltaOffsetInc)=0
void OnRefreshRequest(wxEvent &aEvent)
unsigned m_strtime_camera_movement
wxDEFINE_EVENT(wxEVT_REFRESH_CUSTOM_COMMAND, wxEvent)
WX_INFOBAR * m_parentInfoBar
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:80
RAY getRayAtCurrrentMousePosition()
wxString GetNetClassName() const
Definition: netinfo.h:108
void stop_editingTimeOut_Timer()
Stop the editing time so it will not timeout.
NETINFO_ITEM * GetNet() const
Return #NET_INFO object for a given item.
void Init(const SFVEC3F &o, const SFVEC3F &d)
Definition: ray.cpp:41
bool Intersect(const RAY &aRay, float *t) const
Definition: bbox_3d_ray.cpp:46
wxStatusBar * m_parentStatusBar
virtual void SetCurWindowSize(const wxSize &aSize)=0
Before each render, the canvas will tell the render what is the size of its windows,...
wxGLContext * m_glRC
void RotateY_T1(float aAngleInRadians)
Definition: camera.cpp:537
void OnCloseWindow(wxCloseEvent &event)
wxGLCanvas wrapper for HiDPI/Retina support.
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:97
Implement a canvas based on a wxGLCanvas.
Definition: eda_3d_canvas.h:48
wxTimer m_editing_timeout_timer
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
class PAD, a pad in a footprint
Definition: typeinfo.h:89
Definition: ray.h:67
void DisplayStatus()
Update the status bar with the position information.
Cache for storing the 3D shapes.
Definition: 3d_cache.h:52
void Request_refresh(bool aRedrawImmediately=true)
Schedule a refresh update of the canvas.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void UnlockCtx(wxGLContext *aContext)
Allow other canvases to bind an OpenGL context.
virtual void Drag(const wxPoint &aNewMousePosition)=0
Calculate a new mouse drag position.
SFVEC3F at(float t) const
Definition: ray.h:89
void DoRePaint()
The actual function to repaint the canvas.
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
This file contains miscellaneous commonly used macros and functions.
void SetBoard(BOARD *aBoard) noexcept
Set current board to be rendered.
BOARD_ADAPTER & m_boardAdapter
void OnLeftDown(wxMouseEvent &event)
float m_camera_moving_speed
RENDER_ENGINE GetRenderEngine() const noexcept
bool m_is_opengl_version_supported
A class used to derive camera objects from.
Definition: camera.h:77
static GL_CONTEXT_MANAGER & Get()
Return the GL_CONTEXT_MANAGER instance (singleton).
void OnLeftUp(wxMouseEvent &event)
virtual int GetWaitForEditingTimeOut()=0
Give the interface the time (in ms) that it should wait for editing or movements before (this works f...
void restart_editingTimeOut_Timer()
Reset the editing timer.
void RenderRaytracingRequest()
Request to render the current view in Raytracing mode.
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
RENDER_3D_LEGACY * m_3d_render_ogl_legacy
void Set3dCacheManager(S3D_CACHE *aCachePointer) noexcept
Update the cache manager pointer.
Definition: board_adapter.h:79
void OnMiddleDown(wxMouseEvent &event)
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
bool m_mouse_was_moved
void OnPaint(wxPaintEvent &aEvent)
Called by a wxPaintEvent event.
void OnEraseBackground(wxEraseEvent &event)
void OnMouseWheel(wxMouseEvent &event)
void RenderEngineChanged()
Notify that the render engine was changed.
RENDER_3D_RAYTRACE * m_3d_render_raytracing
Object to render the board using openGL legacy mode.
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
bool m_camera_is_moving
void SetCurMousePosition(const wxPoint &aPosition)
Update the current mouse position without make any new calculations on camera.
Definition: camera.cpp:418
RENDER_3D_BASE * m_3d_render
EVT_MIDDLE_DOWN(mpWindow::OnMouseMiddleDown) EVT_MOUSEWHEEL(mpWindow
Definition: mathplot.cpp:1680
const wxString & GetNetname() const
Definition: netinfo.h:119
virtual bool Redraw(bool aIsMoving, REPORTER *aStatusReporter=nullptr, REPORTER *aWarningReporter=nullptr)=0
Redraw the view.
REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
Report a string with a given severity.
Definition: reporter.cpp:177
void Reload(REPORTER *aStatusReporter, REPORTER *aWarningReporter, bool aOnlyLoadCopperAndShapes)
const wxString & GetReference() const
Definition: footprint.h:421
#define _(s)
REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
Report a string with a given severity.
Definition: reporter.cpp:194
virtual void Reset_T1()
Definition: camera.cpp:101
Handle a list of polygons defining a copper zone.
Definition: zone.h:57
class ZONE, a copper pour area
Definition: typeinfo.h:105
void Finalize()
Update the infobar with the reported text.
Definition: reporter.cpp:210
wxGLContext * CreateCtx(wxGLCanvas *aCanvas, const wxGLContext *aOther=nullptr)
Create a managed OpenGL context.
void MakeRayAtCurrrentMousePosition(SFVEC3F &aOutOrigin, SFVEC3F &aOutDirection) const
Make a ray based on the latest mouse position.
Definition: camera.cpp:364
void OnTimerTimeout_Redraw(wxTimerEvent &event)
SETTINGS_MANAGER * GetSettingsManager()
float ZoomGet() const
Definition: camera.cpp:504
void SetRenderEngine(RENDER_ENGINE aRenderEngine) noexcept
bool m_animation_enabled
void LockCtx(wxGLContext *aContext, wxGLCanvas *aCanvas)
Set a context as current and prevents other canvases from switching it.
bool Zoom(float aFactor)
Definition: camera.cpp:461
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
BOARD_ITEM * IntersectBoardItem(const RAY &aRay)
bool m_is_opengl_initialized
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
void SetInterpolateMode(CAMERA_INTERPOLATION aInterpolateMode)
Definition: camera.h:198
void OnMiddleUp(wxMouseEvent &event)
bool SetCurWindowSize(const wxSize &aSize)
Update the windows size of the camera.
Definition: camera.cpp:435
const BBOX_3D & GetBBox() const noexcept
Get the board outling bounding box.
TOOL_DISPATCHER * m_eventDispatcher
void GetScreenshot(wxImage &aDstImage)
Request a screenshot and output it to the aDstImage.
int m_moving_speed_multiplier
const int scale
virtual void SetT0_and_T1_current_T()
This will set T0 and T1 with the current values.
Definition: camera.cpp:549
see class PGM_BASE
bool initializeOpenGL()
void OnEvent(wxEvent &aEvent)
Used to forward events to the canvas from popups, etc.
bool m_opengl_supports_raytracing
Declaration of the eda_3d_viewer class.
ACCELERATOR_3D * m_accelerator3DShapes
void move_pivot_based_on_cur_mouse_position()
This function hits a ray to the board and start a movement.
std::atomic_flag m_is_currently_painting
virtual void Interpolate(float t)
It will update the matrix to interpolate between T0 and T1 values.
Definition: camera.cpp:563
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
unsigned GetRunningMicroSecs()
An alternate way to calculate an elapset time (in microsecondes) to class PROF_COUNTER.
glm::vec3 SFVEC3F
Definition: xv3d_types.h:44
bool SetView3D(int aKeycode)
Helper function to call view commands.
bool IsOnCopperLayer() const override
Definition: zone.cpp:224
const SFVEC3F & GetCameraPos() const
Definition: camera.h:132
void OnTimerTimeout_Editing(wxTimerEvent &event)
void ReloadRequest(BOARD *aBoard=nullptr, S3D_CACHE *aCachePointer=nullptr)
bool ParametersChanged()
Definition: camera.cpp:581
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
void DestroyCtx(wxGLContext *aContext)
Destroy a managed OpenGL context.
void SetColorSettings(COLOR_SETTINGS *aSettings) noexcept
void ResetXYpos_T1()
Definition: camera.cpp:399
Definition: pad.h:57
static int SetSwapInterval(int aVal)
Attempts to set the OpenGL swap interval.
Definition: gl_utils.h:40
BOARD_ITEM * m_currentRollOverItem
void OglGetScreenshot(wxImage &aDstImage)
Get the pixel data of current OpenGL image.
Definition: ogl_utils.cpp:37
CAMERA & m_camera
wxTimer m_redraw_trigger_timer
Helper class to handle information needed to display 3D board.
Definition: board_adapter.h:67
static const float m_delta_move_step_factor
void render_pivot(float t, float aScale)
Render the pivot cursor.
A wrapper for reporting to a WX_INFOBAR UI element.
Definition: reporter.h:309
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113
void RotateX_T1(float aAngleInRadians)
Definition: camera.cpp:531
bool HasMessage() const override
Returns true if the reporter client is non-empty.
Definition: reporter.cpp:185
bool m_render_raytracing_was_requested