KiCad PCB EDA Suite
eda_3d_model_viewer.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 <[email protected]>
5  * Copyright (C) 1992-2021 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 
30 #include <iostream>
32 #include "eda_3d_model_viewer.h"
33 #include "../3d_rendering/opengl/opengl_utils.h"
34 #include "../3d_cache/3d_cache.h"
35 #include <wx/dcclient.h>
36 #include <base_units.h>
37 #include <gl_context_mgr.h>
39 #include <pgm_base.h>
40 #include <gal/dpi_scaling.h>
41 
45 #define UNITS3D_TO_UNITSPCB (IU_PER_MM)
46 
55 const wxChar* EDA_3D_MODEL_VIEWER::m_logTrace = wxT( "KI_TRACE_EDA_3D_MODEL_VIEWER" );
56 
57 
58 BEGIN_EVENT_TABLE( EDA_3D_MODEL_VIEWER, wxGLCanvas )
59  EVT_PAINT( EDA_3D_MODEL_VIEWER::OnPaint )
60 
61  // mouse events
62  EVT_LEFT_DOWN( EDA_3D_MODEL_VIEWER::OnLeftDown )
63  EVT_LEFT_UP( EDA_3D_MODEL_VIEWER::OnLeftUp )
64  EVT_MIDDLE_UP( EDA_3D_MODEL_VIEWER::OnMiddleUp )
66  EVT_RIGHT_DOWN( EDA_3D_MODEL_VIEWER::OnRightClick )
67  EVT_MOUSEWHEEL( EDA_3D_MODEL_VIEWER::OnMouseWheel )
69 
70 #ifdef USE_OSX_MAGNIFY_EVENT
71  EVT_MAGNIFY( EDA_3D_MODEL_VIEWER::OnMagnify )
72 #endif
73 
74  // other events
75  EVT_ERASE_BACKGROUND( EDA_3D_MODEL_VIEWER::OnEraseBackground )
76 END_EVENT_TABLE()
77 
78 
79 // This defines the range that all coord will have to be rendered.
80 // It will use this value to convert to a normalized value between
81 // -(RANGE_SCALE_3D/2) .. +(RANGE_SCALE_3D/2)
82 #define RANGE_SCALE_3D 8.0f
83 
84 
85 EDA_3D_MODEL_VIEWER::EDA_3D_MODEL_VIEWER( wxWindow* aParent, const int* aAttribList,
86  S3D_CACHE* aCacheManager ) :
87  HIDPI_GL_CANVAS( aParent, wxID_ANY, aAttribList, wxDefaultPosition, wxDefaultSize,
88  wxFULL_REPAINT_ON_RESIZE ),
89  m_trackBallCamera( RANGE_SCALE_3D * 4.0f ),
90  m_cacheManager( aCacheManager )
91 {
92  wxLogTrace( m_logTrace, wxT( "EDA_3D_MODEL_VIEWER::EDA_3D_MODEL_VIEWER" ) );
93 
94  m_ogl_initialized = false;
95  m_reload_is_needed = false;
96  m_ogl_3dmodel = nullptr;
97  m_3d_model = nullptr;
98  m_BiuTo3dUnits = 1.0;
99 
100  m_glRC = nullptr;
101 
102  COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
103 
104  const DPI_SCALING dpi{ settings, this };
105  SetScaleFactor( dpi.GetScaleFactor() );
106 }
107 
108 
110 {
111  wxLogTrace( m_logTrace, wxT( "EDA_3D_MODEL_VIEWER::~EDA_3D_MODEL_VIEWER" ) );
112 
113  if( m_glRC )
114  {
116 
117  delete m_ogl_3dmodel;
118  m_ogl_3dmodel = nullptr;
119 
122  }
123 }
124 
125 
127 {
128  wxLogTrace( m_logTrace, wxT( "EDA_3D_MODEL_VIEWER::Set3DModel with a S3DMODEL" ) );
129 
130  // Validate a3DModel pointers
131  wxASSERT( a3DModel.m_Materials != nullptr );
132  wxASSERT( a3DModel.m_Meshes != nullptr );
133  wxASSERT( a3DModel.m_MaterialsSize > 0 );
134  wxASSERT( a3DModel.m_MeshesSize > 0 );
135 
136  // Delete the old model
137  delete m_ogl_3dmodel;
138  m_ogl_3dmodel = nullptr;
139 
140  m_3d_model = nullptr;
141 
142  if( ( a3DModel.m_Materials != nullptr ) && ( a3DModel.m_Meshes != nullptr )
143  && ( a3DModel.m_MaterialsSize > 0 ) && ( a3DModel.m_MeshesSize > 0 ) )
144  {
145  m_3d_model = &a3DModel;
146  m_reload_is_needed = true;
147  }
148 
149  Refresh();
150 }
151 
152 
153 void EDA_3D_MODEL_VIEWER::Set3DModel( const wxString& aModelPathName)
154 {
155  wxLogTrace( m_logTrace, wxT( "EDA_3D_MODEL_VIEWER::Set3DModel with a wxString" ) );
156 
157  if( m_cacheManager )
158  {
159  const S3DMODEL* model = m_cacheManager->GetModel( aModelPathName );
160 
161  if( model )
162  Set3DModel( (const S3DMODEL &)*model );
163  else
164  Clear3DModel();
165  }
166 }
167 
168 
170 {
171  // Delete the old model
172  m_reload_is_needed = false;
173 
174  delete m_ogl_3dmodel;
175  m_ogl_3dmodel = nullptr;
176 
177  m_3d_model = nullptr;
178 
179  Refresh();
180 }
181 
182 
184 {
185  glHint( GL_PERSPECTIVE_CORRECTION_HINT, GL_NICEST );
186  glHint( GL_LINE_SMOOTH_HINT, GL_NICEST );
187  glHint( GL_POLYGON_SMOOTH_HINT, GL_NICEST );
188 
189  glPolygonMode( GL_FRONT_AND_BACK, GL_FILL );
190  glEnable( GL_DEPTH_TEST );
191  glEnable( GL_CULL_FACE );
192  glShadeModel( GL_SMOOTH );
193  glEnable( GL_LINE_SMOOTH );
194  glEnable( GL_NORMALIZE );
195 
196  // Setup light
197  // https://www.opengl.org/sdk/docs/man2/xhtml/glLight.xml
198  const GLfloat ambient[] = { 0.01f, 0.01f, 0.01f, 1.0f };
199  const GLfloat diffuse[] = { 1.0f, 1.0f, 1.0f, 1.0f };
200  const GLfloat specular[] = { 1.0f, 1.0f, 1.0f, 1.0f };
201 
202  // defines a directional light that points along the negative z-axis
203  const GLfloat position[] = { 0.0f, 0.0f, 2.0f * RANGE_SCALE_3D, 0.0f };
204 
205  const GLfloat lmodel_ambient[] = { 0.0f, 0.0f, 0.0f, 1.0f };
206 
207  glLightfv( GL_LIGHT0, GL_AMBIENT, ambient );
208  glLightfv( GL_LIGHT0, GL_DIFFUSE, diffuse );
209  glLightfv( GL_LIGHT0, GL_SPECULAR, specular );
210  glLightfv( GL_LIGHT0, GL_POSITION, position );
211  glLightModelfv( GL_LIGHT_MODEL_AMBIENT, lmodel_ambient );
212 }
213 
214 
216 {
217  glEnable( GL_COLOR_MATERIAL );
218  glColorMaterial( GL_FRONT_AND_BACK, GL_AMBIENT_AND_DIFFUSE );
219 
220  const SFVEC4F specular = SFVEC4F( 0.1f, 0.1f, 0.1f, 1.0f );
221 
222  glMaterialfv( GL_FRONT_AND_BACK, GL_SPECULAR, &specular.r );
223  glMaterialf( GL_FRONT_AND_BACK, GL_SHININESS, 96.0f );
224 }
225 
226 
227 void EDA_3D_MODEL_VIEWER::OnPaint( wxPaintEvent& event )
228 {
229  event.Skip( false );
230 
231  // SwapBuffer requires the window to be shown before calling
232  if( !IsShownOnScreen() )
233  {
234  wxLogTrace( m_logTrace, wxT( "EDA_3D_MODEL_VIEWER::OnPaint !IsShown" ) );
235  return;
236  }
237 
238  // "Makes the OpenGL state that is represented by the OpenGL rendering
239  // context context current, i.e. it will be used by all subsequent OpenGL calls.
240  // This function may only be called when the window is shown on screen"
241  if( m_glRC == nullptr )
243 
245 
246  // Set the OpenGL viewport according to the client size of this canvas.
247  // This is done here rather than in a wxSizeEvent handler because our
248  // OpenGL rendering context (and thus viewport setting) is used with
249  // multiple canvases: If we updated the viewport in the wxSizeEvent
250  // handler, changing the size of one canvas causes a viewport setting that
251  // is wrong when next another canvas is repainted.
252  wxSize clientSize = GetNativePixelSize();
253 
254  if( !m_ogl_initialized )
255  {
256  m_ogl_initialized = true;
257  ogl_initialize();
258  }
259 
260  if( m_reload_is_needed )
261  {
262  wxLogTrace( m_logTrace, wxT( "EDA_3D_MODEL_VIEWER::OnPaint m_reload_is_needed" ) );
263 
264  m_reload_is_needed = false;
266 
267  // It convert a model as it was a board, so get the max size dimension of the board
268  // and compute the conversion scale
270  (double) RANGE_SCALE_3D
272  }
273 
274  glViewport( 0, 0, clientSize.x, clientSize.y );
275 
276  m_trackBallCamera.SetCurWindowSize( clientSize );
277 
278  // clear color and depth buffers
279  glEnable( GL_DEPTH_TEST );
280  glClearColor( 0.0f, 0.0f, 0.0f, 1.0f );
281  glClearDepth( 1.0f );
282  glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT );
283 
284  // Set projection and modelview matrices
285  glMatrixMode( GL_PROJECTION );
286  glLoadMatrixf( glm::value_ptr( m_trackBallCamera.GetProjectionMatrix() ) );
287  glMatrixMode( GL_MODELVIEW );
288  glLoadMatrixf( glm::value_ptr( m_trackBallCamera.GetViewMatrix() ) );
289  glEnable( GL_LIGHTING );
290  glEnable( GL_LIGHT0 );
291 
292  // Render Model
293  if( m_ogl_3dmodel )
294  {
295  glPushMatrix();
296 
297  double modelunit_to_3d_units_factor = m_BiuTo3dUnits * UNITS3D_TO_UNITSPCB;
298 
299  glScaled( modelunit_to_3d_units_factor, modelunit_to_3d_units_factor,
300  modelunit_to_3d_units_factor );
301 
302  // Center model in the render viewport
303  const SFVEC3F model_center = m_ogl_3dmodel->GetBBox().GetCenter();
304 
305  glTranslatef( -model_center.x, -model_center.y, -model_center.z );
306 
307  m_ogl_3dmodel->BeginDrawMulti( true );
308 
309  m_ogl_3dmodel->DrawOpaque( false );
310  m_ogl_3dmodel->DrawTransparent( 1.0f, false );
311 
313 
314  glPopMatrix();
315  }
316 
317  // YxY squared view port
318  glViewport( 0, 0, clientSize.y / 8 , clientSize.y / 8 );
319  glClear( GL_DEPTH_BUFFER_BIT );
320 
321  glMatrixMode( GL_PROJECTION );
322  glLoadIdentity();
323  gluPerspective( 45.0f, 1.0f, 0.01f, RANGE_SCALE_3D * 2.0f );
324 
325  glMatrixMode( GL_MODELVIEW );
326  glLoadIdentity();
327 
328  const glm::mat4 TranslationMatrix = glm::translate( glm::mat4(1.0f),
329  SFVEC3F( 0.0f, 0.0f, -RANGE_SCALE_3D ) );
330 
331  const glm::mat4 ViewMatrix = TranslationMatrix * m_trackBallCamera.GetRotationMatrix();
332 
333  glLoadMatrixf( glm::value_ptr( ViewMatrix ) );
334 
336 
337  glColor3f( 0.9f, 0.0f, 0.0f );
338  DrawRoundArrow( SFVEC3F( 0.0f, 0.0f, 0.0f ), SFVEC3F( RANGE_SCALE_3D / 2.65f, 0.0f, 0.0f ),
339  0.275f );
340 
341  glColor3f( 0.0f, 0.9f, 0.0f );
342  DrawRoundArrow( SFVEC3F( 0.0f, 0.0f, 0.0f ), SFVEC3F( 0.0f, RANGE_SCALE_3D / 2.65f, 0.0f ),
343  0.275f );
344 
345  glColor3f( 0.0f, 0.0f, 0.9f );
346  DrawRoundArrow( SFVEC3F( 0.0f, 0.0f, 0.0f ), SFVEC3F( 0.0f, 0.0f, RANGE_SCALE_3D / 2.65f ),
347  0.275f );
348 
349  // "Swaps the double-buffer of this window, making the back-buffer the
350  // front-buffer and vice versa, so that the output of the previous OpenGL
351  // commands is displayed on the window."
352  SwapBuffers();
353 
355 }
356 
357 
358 void EDA_3D_MODEL_VIEWER::OnEraseBackground( wxEraseEvent& event )
359 {
360  wxLogTrace( m_logTrace, wxT( "EDA_3D_MODEL_VIEWER::OnEraseBackground" ) );
361  // Do nothing, to avoid flashing.
362 }
363 
364 
365 void EDA_3D_MODEL_VIEWER::OnMouseWheel( wxMouseEvent& event )
366 {
367  wxLogTrace( m_logTrace, wxT( "EDA_3D_MODEL_VIEWER::OnMouseWheel" ) );
368 
369  if( event.ShiftDown() )
370  {
371  //if( event.GetWheelRotation() < 0 )
372  //SetView3D( WXK_UP ); // move up
373  //else
374  //SetView3D( WXK_DOWN ); // move down
375  }
376  else if( event.ControlDown() )
377  {
378  //if( event.GetWheelRotation() > 0 )
379  //SetView3D( WXK_RIGHT ); // move right
380  //else
381  //SetView3D( WXK_LEFT ); // move left
382  }
383  else
384  {
385  m_trackBallCamera.Zoom( event.GetWheelRotation() > 0 ? 1.1f : 1/1.1f );
386 
387  //DisplayStatus();
388  Refresh( false );
389  }
390 
391  m_trackBallCamera.SetCurMousePosition( event.GetPosition() );
392 }
393 
394 
395 #ifdef USE_OSX_MAGNIFY_EVENT
396 void EDA_3D_MODEL_VIEWER::OnMagnify( wxMouseEvent& event )
397 {
398 }
399 #endif
400 
401 
402 void EDA_3D_MODEL_VIEWER::OnMouseMove( wxMouseEvent& event )
403 {
404  const wxSize& nativeWinSize = GetNativePixelSize();
405  const wxPoint& nativePosition = GetNativePosition( event.GetPosition() );
406 
407  m_trackBallCamera.SetCurWindowSize( nativeWinSize );
408 
409  if( event.Dragging() )
410  {
411  if( event.LeftIsDown() ) // Drag
412  m_trackBallCamera.Drag( nativePosition );
413 
414  // orientation has changed, redraw mesh
415  Refresh( false );
416  }
417 
418  m_trackBallCamera.SetCurMousePosition( nativePosition );
419 }
420 
421 
422 void EDA_3D_MODEL_VIEWER::OnLeftDown( wxMouseEvent& event )
423 {
424  event.Skip();
425 }
426 
427 
428 void EDA_3D_MODEL_VIEWER::OnLeftUp( wxMouseEvent& event )
429 {
430  event.Skip();
431 }
432 
433 
434 void EDA_3D_MODEL_VIEWER::OnMiddleDown( wxMouseEvent& event )
435 {
436  event.Skip();
437 }
438 
439 
440 void EDA_3D_MODEL_VIEWER::OnMiddleUp( wxMouseEvent& event )
441 {
442  event.Skip();
443 }
444 
445 
446 void EDA_3D_MODEL_VIEWER::OnRightClick( wxMouseEvent& event )
447 {
448  event.Skip();
449 }
450 
virtual wxSize GetNativePixelSize() const
double m_BiuTo3dUnits
factor to convert the model or any other items to keep it in relation to the +/-RANGE_SCALE_3D (it is...
void OnPaint(wxPaintEvent &event)
void OnMiddleUp(wxMouseEvent &event)
Implementation of conversion functions that require both schematic and board internal units.
TRACK_BALL m_trackBallCamera
Camera used in this canvas.
Implement a canvas based on a wxGLCanvas.
const glm::mat4 & GetProjectionMatrix() const
Definition: camera.cpp:391
glm::vec4 SFVEC4F
Definition: xv3d_types.h:46
void OnLeftDown(wxMouseEvent &event)
S3D_CACHE * m_cacheManager
Optional cache manager.
wxGLCanvas wrapper for HiDPI/Retina support.
void OnMiddleDown(wxMouseEvent &event)
EDA_3D_MODEL_VIEWER(wxWindow *aParent, const int *aAttribList=nullptr, S3D_CACHE *aCacheManager=nullptr)
Create a new 3D Canvas with a attribute list.
void OnEraseBackground(wxEraseEvent &event)
bool m_reload_is_needed
Flag that we have a new model and it need to be reloaded when the paint is called.
#define UNITS3D_TO_UNITSPCB
Implements a model viewer canvas.
Cache for storing the 3D shapes.
Definition: 3d_cache.h:52
wxGLContext * m_glRC
openGL context
const glm::mat4 GetRotationMatrix() const
Get the rotation matrix to be applied in a transformation camera.
Definition: camera.cpp:168
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.
SMESH * m_Meshes
The meshes list of this model.
Definition: c3dmodel.h:93
Class to handle configuration and automatic determination of the DPI scale to use for canvases.
Definition: dpi_scaling.h:36
S3DMODEL * GetModel(const wxString &aModelFileName)
Attempt to load the scene data for a model and to translate it into an S3D_MODEL structure for displa...
Definition: 3d_cache.cpp:643
#define RANGE_SCALE_3D
static GL_CONTEXT_MANAGER & Get()
Return the GL_CONTEXT_MANAGER instance (singleton).
SFVEC3F GetCenter() const
Return the center point of the bounding box.
Definition: bbox_3d.cpp:132
void Clear3DModel()
Unload the displayed 3D model.
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
Use all material properties from model file.
float GetMaxDimension() const
Definition: bbox_3d.cpp:167
const glm::mat4 & GetViewMatrix() const
Definition: camera.cpp:427
const S3DMODEL * m_3d_model
Original 3d model data.
void SetCurMousePosition(const wxPoint &aPosition)
Update the current mouse position without make any new calculations on camera.
Definition: camera.cpp:439
EVT_MIDDLE_DOWN(mpWindow::OnMouseMiddleDown) EVT_MOUSEWHEEL(mpWindow
Definition: mathplot.cpp:1586
void OnLeftUp(wxMouseEvent &event)
wxGLContext * CreateCtx(wxGLCanvas *aCanvas, const wxGLContext *aOther=nullptr)
Create a managed OpenGL context.
unsigned int m_MaterialsSize
Number of materials in the material array.
Definition: c3dmodel.h:95
void DrawRoundArrow(SFVEC3F aPosition, SFVEC3F aTargetPos, float aSize)
Draw a round arrow.
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:482
wxPoint GetNativePosition(const wxPoint &aPoint) const
Convert the given point from client coordinates to native pixel coordinates.
bool SetCurWindowSize(const wxSize &aSize)
Update the windows size of the camera.
Definition: camera.cpp:456
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
void DrawOpaque(bool aUseSelectedMaterial, SFVEC3F aSelectionColor=SFVEC3F(0.0f)) const
Render the model into the current context.
Definition: 3d_model.h:55
static void EndDrawMulti()
Cleanup render states after drawing multiple models.
Definition: 3d_model.cpp:390
see class PGM_BASE
void OnMouseMove(wxMouseEvent &event)
void OnMouseWheel(wxMouseEvent &event)
void DrawTransparent(float aOpacity, bool aUseSelectedMaterial, SFVEC3F aSelectionColor=SFVEC3F(0.0f)) const
Render the model into the current context.
Definition: 3d_model.h:63
glm::vec3 SFVEC3F
Definition: xv3d_types.h:44
SMATERIAL * m_Materials
The materials list of this model.
Definition: c3dmodel.h:96
void SetScaleFactor(double aFactor)
Set the canvas scale factor, probably for a hi-DPI display.
void OnRightClick(wxMouseEvent &event)
bool m_ogl_initialized
Flag if open gl was initialized.
const BBOX_3D & GetBBox() const
Get the main bounding box.
Definition: 3d_model.h:93
void Set3DModel(const S3DMODEL &a3DModel)
Set this model to be displayed.
void DestroyCtx(wxGLContext *aContext)
Destroy a managed OpenGL context.
Store the a model based on meshes and materials.
Definition: c3dmodel.h:90
static void BeginDrawMulti(bool aUseColorInformation)
Set some basic render states before drawing multiple models.
Definition: 3d_model.cpp:374
unsigned int m_MeshesSize
Number of meshes in the array.
Definition: c3dmodel.h:92
MODEL_3D * m_ogl_3dmodel
Class holder for 3d model to display on openGL.
void Drag(const wxPoint &aNewMousePosition) override
Calculate a new mouse drag position.
Definition: track_ball.cpp:52