Rework on 3D viewer (work in progress): Disable or enable layers, grid or 3D...

Rework on 3D viewer (work in progress): Disable or enable layers, grid or 3D footprint shapes should be now faster.

3d-viewer/3d_canvas.cpp

@@ -78,7 +78,11 @@ EDA_3D_CANVAS::EDA_3D_CANVAS( EDA_3D_FRAME* parent, int* attribList ) :
                 wxFULL_REPAINT_ON_RESIZE )
 {
     m_init   = false;
-    m_gllist = 0;
+
+    // Clear all gl list identifiers:
+    for( int ii = GL_ID_BEGIN; ii < GL_ID_END; ii++ )
+        m_glLists[ii] = 0;
+
     // Explicitly create a new rendering context instance for this canvas.
     m_glRC = new wxGLContext( this );
 
@@ -94,12 +98,25 @@ EDA_3D_CANVAS::~EDA_3D_CANVAS()
 }
 
 
-void EDA_3D_CANVAS::ClearLists()
+void EDA_3D_CANVAS::ClearLists( GLuint aGlList )
 {
-    if( m_gllist > 0 )
-        glDeleteLists( m_gllist, 1 );
+    if( aGlList )
+    {
+        if( m_glLists[aGlList] > 0 )
+            glDeleteLists( m_glLists[aGlList], 1 );
+
+        m_glLists[aGlList] = 0;
+
+        return;
+    }
 
-    m_gllist = 0;
+    for( int ii = GL_ID_BEGIN; ii < GL_ID_END; ii++ )
+    {
+        if( m_glLists[ii] > 0 )
+            glDeleteLists( m_glLists[ii], 1 );
+
+        m_glLists[ii] = 0;
+    }
 }
 
 

3d-viewer/3d_canvas.h

@@ -50,14 +50,29 @@ class S3D_VERTEX;
 class SEGVIA;
 class D_PAD;
 
+// We are using GL lists to store layers and other items
+// to draw or not
+// GL_LIST_ID are the GL lists indexes in m_glLists
+enum GL_LIST_ID
+{
+    GL_ID_BEGIN = 0,
+    GL_ID_AXIS = GL_ID_BEGIN,   // list id for 3D axis
+    GL_ID_GRID,                 // list id for 3D grid
+    GL_ID_BOARD,                // List id for copper layers
+    GL_ID_TECH_LAYERS,          // List id for non copper layers (masks...)
+    GL_ID_AUX_LAYERS,           // List id for user layers (draw, eco, comment)
+    GL_ID_3DSHAPES_SOLID,       // List id for 3D shapes, non transparent entities
+    GL_ID_3DSHAPES_TRANSP,      // List id for 3D shapes, transparent entities
+    GL_ID_END
+};
 
 class EDA_3D_CANVAS : public wxGLCanvas
 {
 private:
     bool            m_init;
-    GLuint          m_gllist;
+    GLuint          m_glLists[GL_ID_END];    // GL lists
     wxGLContext*    m_glRC;
-    wxRealPoint     m_draw3dOffset;     // offset to draw the 3 mesh.
+    wxRealPoint     m_draw3dOffset;     // offset to draw the 3D mesh.
     double          m_ZBottom;          // position of the back layer
     double          m_ZTop;             // position of the front layer
 
@@ -67,7 +82,15 @@ public:
 
     EDA_3D_FRAME*   Parent() { return (EDA_3D_FRAME*)GetParent(); }
 
-    void   ClearLists();
+    BOARD* GetBoard() { return Parent()->GetBoard(); }
+
+    /**
+     * Function ClearLists
+     * Clear the display list.
+     * @param aGlList = the list to clear.
+     * if 0 (default) all lists are cleared
+     */
+    void   ClearLists( GLuint aGlList = 0 );
 
     // Event functions:
     void   OnPaint( wxPaintEvent& event );
@@ -92,7 +115,7 @@ public:
      * Prepares the parameters of the OpenGL draw list
      * creates the OpenGL draw list items (board, grid ...
      */
-    GLuint CreateDrawGL_List();
+    void   CreateDrawGL_List();
     void   InitGL();
     void   SetLights();
     void   SetOffset(double aPosX, double aPosY)
@@ -104,11 +127,40 @@ public:
     /**
      * Function BuildBoard3DView
      * Called by CreateDrawGL_List()
-     * Fills the OpenGL draw list with board items draw list.
+     * Populates the OpenGL GL_ID_BOARD draw list with board items only on copper layers.
+     * 3D footprint shapes, tech layers and aux layers are not on this list
      */
     void   BuildBoard3DView();
 
-    void   DrawGrid( double aGriSizeMM );
+    /**
+     * Function BuildTechLayers3DView
+     * Called by CreateDrawGL_List()
+     * Populates the OpenGL GL_ID_BOARD draw list with items on tech layers
+     */
+    void   BuildTechLayers3DView();
+
+    /**
+     * Function BuildFootprintShape3DList
+     * Called by CreateDrawGL_List()
+     * Fills the OpenGL GL_ID_3DSHAPES_SOLID and GL_ID_3DSHAPES_TRANSP
+     * draw lists with 3D footprint shapes
+     * @param aOpaqueList is the gl list for non transparent items
+     * @param aTransparentList is the gl list for non transparent items,
+     * which need to be drawn after all other items
+     */
+    void   BuildFootprintShape3DList( GLuint aOpaqueList,
+                                      GLuint aTransparentList);
+    /**
+     * Function BuildBoard3DAuxLayers
+     * Called by CreateDrawGL_List()
+     * Fills the OpenGL GL_ID_AUX_LAYERS draw list
+     * with items on aux layers only
+     */
+    void   BuildBoard3DAuxLayers();
+
+    void   Draw3DGrid( double aGriSizeMM );
+    void   Draw3DAxis();
+
     void   Draw3DViaHole( SEGVIA * aVia );
     void   Draw3DPadHole( D_PAD * aPad );
 

3d-viewer/3d_frame.cpp

@@ -45,6 +45,8 @@ static const wxString   keyBgColor_Green( wxT( "BgColor_Green" ) );
 static const wxString   keyBgColor_Blue( wxT( "BgColor_Blue" ) );
 static const wxString   keyShowRealisticMode( wxT( "ShowRealisticMode" ) );
 static const wxString   keyShowAxis( wxT( "ShowAxis" ) );
+static const wxString   keyShowGrid( wxT( "ShowGrid3D" ) );
+static const wxString   keyShowGridSize( wxT( "Grid3DSize" ) );
 static const wxString   keyShowZones( wxT( "ShowZones" ) );
 static const wxString   keyShowFootprints( wxT( "ShowFootprints" ) );
 static const wxString   keyShowCopperThickness( wxT( "ShowCopperThickness" ) );
@@ -148,9 +150,9 @@ void EDA_3D_FRAME::GetSettings()
     {
         EDA_BASE_FRAME::LoadSettings();
 
-        config->Read( keyBgColor_Red, &g_Parm_3D_Visu.m_BgColor.m_Red, 0.0 );
-        config->Read( keyBgColor_Green, &g_Parm_3D_Visu.m_BgColor.m_Green, 0.0 );
-        config->Read( keyBgColor_Blue, &g_Parm_3D_Visu.m_BgColor.m_Blue, 0.0 );
+        config->Read( keyBgColor_Red, &prms.m_BgColor.m_Red, 0.0 );
+        config->Read( keyBgColor_Green, &prms.m_BgColor.m_Green, 0.0 );
+        config->Read( keyBgColor_Blue, &prms.m_BgColor.m_Blue, 0.0 );
 
         bool tmp;
         config->Read( keyShowRealisticMode, &tmp, false );
@@ -159,6 +161,12 @@ void EDA_3D_FRAME::GetSettings()
         config->Read( keyShowAxis, &tmp, true );
         prms.SetFlag( FL_AXIS, tmp );
 
+        config->Read( keyShowGrid, &tmp, true );
+        prms.SetFlag( FL_GRID, tmp );
+
+        config->Read( keyShowGridSize, &prms.m_3D_Grid, 10.0 );
+        prms.SetFlag( FL_MODULE, tmp );
+
         config->Read( keyShowFootprints, &tmp, true );
         prms.SetFlag( FL_MODULE, tmp );
 
@@ -201,12 +209,14 @@ void EDA_3D_FRAME::SaveSettings()
 
     EDA_BASE_FRAME::SaveSettings();
 
-    config->Write( keyBgColor_Red, g_Parm_3D_Visu.m_BgColor.m_Red );
-    config->Write( keyBgColor_Green, g_Parm_3D_Visu.m_BgColor.m_Green );
-    config->Write( keyBgColor_Blue, g_Parm_3D_Visu.m_BgColor.m_Blue );
     class INFO3D_VISU& prms = g_Parm_3D_Visu;
+    config->Write( keyBgColor_Red, prms.m_BgColor.m_Red );
+    config->Write( keyBgColor_Green, prms.m_BgColor.m_Green );
+    config->Write( keyBgColor_Blue, prms.m_BgColor.m_Blue );
     config->Write( keyShowRealisticMode, prms.GetFlag( FL_USE_REALISTIC_MODE )  );
     config->Write( keyShowAxis, prms.GetFlag( FL_AXIS )  );
+    config->Write( keyShowGrid, prms.GetFlag( FL_GRID )  );
+    config->Write( keyShowGridSize, prms.m_3D_Grid  );
     config->Write( keyShowFootprints, prms.GetFlag( FL_MODULE )  );
     config->Write( keyShowCopperThickness, prms.GetFlag( FL_USE_COPPER_THICKNESS )  );
     config->Write( keyShowZones, prms.GetFlag( FL_ZONE )  );
@@ -364,52 +374,52 @@ void EDA_3D_FRAME::Process_Special_Functions( wxCommandEvent& event )
 
     case ID_MENU3D_AXIS_ONOFF:
         g_Parm_3D_Visu.SetFlag( FL_AXIS, isChecked );
-        NewDisplay();
+        m_canvas->Refresh();
         return;
 
     case ID_MENU3D_MODULE_ONOFF:
         g_Parm_3D_Visu.SetFlag( FL_MODULE, isChecked );
-        NewDisplay();
+        m_canvas->Refresh();
         return;
 
     case ID_MENU3D_USE_COPPER_THICKNESS:
         g_Parm_3D_Visu.SetFlag( FL_USE_COPPER_THICKNESS, isChecked );
-        NewDisplay();
+        NewDisplay(GL_ID_BOARD);
         return;
 
     case ID_MENU3D_ZONE_ONOFF:
         g_Parm_3D_Visu.SetFlag( FL_ZONE, isChecked );
-        NewDisplay();
+        NewDisplay(GL_ID_BOARD);
         return;
 
     case ID_MENU3D_ADHESIVE_ONOFF:
         g_Parm_3D_Visu.SetFlag( FL_ADHESIVE, isChecked );
-        NewDisplay();
+        NewDisplay(GL_ID_TECH_LAYERS);
         return;
 
     case ID_MENU3D_SILKSCREEN_ONOFF:
         g_Parm_3D_Visu.SetFlag( FL_SILKSCREEN, isChecked );
-        NewDisplay();
+        NewDisplay(GL_ID_TECH_LAYERS);
         return;
 
     case ID_MENU3D_SOLDER_MASK_ONOFF:
         g_Parm_3D_Visu.SetFlag( FL_SOLDERMASK, isChecked );
-        NewDisplay();
+       NewDisplay(GL_ID_TECH_LAYERS);
         return;
 
     case ID_MENU3D_SOLDER_PASTE_ONOFF:
         g_Parm_3D_Visu.SetFlag( FL_SOLDERPASTE, isChecked );
-        NewDisplay();
+        NewDisplay(GL_ID_TECH_LAYERS);
         return;
 
     case ID_MENU3D_COMMENTS_ONOFF:
         g_Parm_3D_Visu.SetFlag( FL_COMMENTS, isChecked );
-        NewDisplay();
+        NewDisplay(GL_ID_AUX_LAYERS);
         return;
 
     case ID_MENU3D_ECO_ONOFF:
         g_Parm_3D_Visu.SetFlag( FL_ECO, isChecked );
-        NewDisplay();
+        NewDisplay(GL_ID_AUX_LAYERS);
         return;
 
     default:
@@ -434,7 +444,6 @@ void EDA_3D_FRAME::On3DGridSelection( wxCommandEvent& event )
         GetMenuBar()->Check( ii, false );
     }
 
-
     switch( id )
     {
     case ID_MENU3D_GRID_NOGRID:
@@ -466,18 +475,17 @@ void EDA_3D_FRAME::On3DGridSelection( wxCommandEvent& event )
         return;
     }
 
-    NewDisplay();
+    NewDisplay( GL_ID_GRID );
 }
 
 
-void EDA_3D_FRAME::NewDisplay()
+void EDA_3D_FRAME::NewDisplay( GLuint aGlList )
 {
     m_reloadRequest = false;
 
-    m_canvas->ClearLists();
+    m_canvas->ClearLists( aGlList );
     m_canvas->CreateDrawGL_List();
 
-// m_canvas->InitGL();
     m_canvas->Refresh( true );
     m_canvas->DisplayStatus();
 }
@@ -507,6 +515,9 @@ void EDA_3D_FRAME::Set3DBgColor()
 
     newcolor = wxGetColourFromUser( this, oldcolor );
 
+    if( ! newcolor.IsOk() )     // Happens on cancel dialog
+        return;
+
     if( newcolor != oldcolor )
     {
         g_Parm_3D_Visu.m_BgColor.m_Red = (double) newcolor.Red() / 255.0;
@@ -515,3 +526,8 @@ void EDA_3D_FRAME::Set3DBgColor()
         NewDisplay();
     }
 }
+
+BOARD* EDA_3D_FRAME::GetBoard()
+{
+    return Parent()->GetBoard();
+}

3d-viewer/3d_toolbar.cpp

@@ -166,13 +166,22 @@ void EDA_3D_FRAME::CreateMenuBar()
     wxMenu * gridlistMenu = new wxMenu;
     AddMenuItem( prefsMenu, gridlistMenu, ID_MENU3D_GRID,
            _( "3D Grid" ), KiBitmap( grid_xpm ) );
-    gridlistMenu->Append( ID_MENU3D_GRID_NOGRID, _( "No 3D Grid" ), wxEmptyString, true );
-    gridlistMenu->Check( ID_MENU3D_GRID_NOGRID, true );
-
-    gridlistMenu->Append( ID_MENU3D_GRID_10_MM, _( "3D Grid 10 mm" ), wxEmptyString, true );
-    gridlistMenu->Append( ID_MENU3D_GRID_5_MM, _( "3D Grid 5 mm" ), wxEmptyString, true );
-    gridlistMenu->Append( ID_MENU3D_GRID_2P5_MM, _( "3D Grid 2.5 mm" ), wxEmptyString, true );
-    gridlistMenu->Append( ID_MENU3D_GRID_1_MM, _( "3D Grid 1 mm" ), wxEmptyString, true );
+    gridlistMenu->Append( ID_MENU3D_GRID_NOGRID, _( "No 3D Grid" ), wxEmptyString, true  );
+    gridlistMenu->Append( ID_MENU3D_GRID_10_MM, _( "3D Grid 10 mm" ), wxEmptyString, true  );
+    gridlistMenu->Append( ID_MENU3D_GRID_5_MM, _( "3D Grid 5 mm" ), wxEmptyString, true  );
+    gridlistMenu->Append( ID_MENU3D_GRID_2P5_MM, _( "3D Grid 2.5 mm" ), wxEmptyString, true  );
+    gridlistMenu->Append( ID_MENU3D_GRID_1_MM, _( "3D Grid 1 mm" ), wxEmptyString, true  );
+
+    // If the grid is on, check the corresponding menuitem showing the grid  size
+    if( g_Parm_3D_Visu.GetFlag( FL_GRID ) )
+    {
+        gridlistMenu->Check( ID_MENU3D_GRID_10_MM, g_Parm_3D_Visu.m_3D_Grid == 10.0 );
+        gridlistMenu->Check( ID_MENU3D_GRID_5_MM, g_Parm_3D_Visu.m_3D_Grid == 5.0 );
+        gridlistMenu->Check( ID_MENU3D_GRID_2P5_MM, g_Parm_3D_Visu.m_3D_Grid == 2.5 );
+        gridlistMenu->Check( ID_MENU3D_GRID_1_MM, g_Parm_3D_Visu.m_3D_Grid == 1.0 );
+    }
+    else
+        gridlistMenu->Check( ID_MENU3D_GRID_NOGRID, true );
 
     prefsMenu->AppendSeparator();
 

3d-viewer/3d_viewer.h

@@ -78,6 +78,8 @@ public:
 
     PCB_BASE_FRAME* Parent() { return (PCB_BASE_FRAME*)GetParent(); }
 
+    BOARD* GetBoard();
+
     /**
      * Function ReloadRequest
      * must be called when reloading data from Pcbnew is needed
@@ -93,8 +95,10 @@ public:
      * Function NewDisplay
      * Rebuild the display list.
      * must be called when 3D opengl data is modified
+     * @param aGlList = the list to rebuild.
+     * if 0 (default) all lists are rebuilt
      */
-    void NewDisplay();
+    void NewDisplay( GLuint aGlList = 0 );
 
     void SetDefaultFileName(const wxString &aFn) { m_defaultFileName = aFn; }
     const wxString &GetDefaultFileName() const { return m_defaultFileName; }

3d-viewer/info3d_visu.h

@@ -74,7 +74,6 @@ enum DISPLAY3D_FLG {
     FL_LAST
 };
 
-
 class INFO3D_VISU
 {
 public:

include/layers_id_colors_and_visibility.h

@@ -63,6 +63,8 @@ typedef int LAYER_NUM;
 #define NB_COPPER_LAYERS        (LAST_COPPER_LAYER - FIRST_COPPER_LAYER + 1)
 
 #define FIRST_NON_COPPER_LAYER  16
+#define FIRST_TECHNICAL_LAYER   16
+#define FIRST_USER_LAYER        24
 #define ADHESIVE_N_BACK         16
 #define ADHESIVE_N_FRONT        17
 #define SOLDERPASTE_N_BACK      18
@@ -77,6 +79,8 @@ typedef int LAYER_NUM;
 #define ECO2_N                  27
 #define EDGE_N                  28
 #define LAST_NON_COPPER_LAYER   28
+#define LAST_TECHNICAL_LAYER    23
+#define LAST_USER_LAYER   27
 #define NB_PCB_LAYERS           (LAST_NON_COPPER_LAYER + 1)
 #define UNUSED_LAYER_29         29
 #define UNUSED_LAYER_30         30
@@ -128,13 +132,16 @@ typedef unsigned LAYER_MSK;
 #define ALL_CU_LAYERS           0x0000FFFF
 #define INTERNAL_CU_LAYERS      0x00007FFE
 #define EXTERNAL_CU_LAYERS      0x00008001
-#define FRONT_AUX_LAYERS       (SILKSCREEN_LAYER_FRONT | SOLDERMASK_LAYER_FRONT \
+#define FRONT_TECH_LAYERS       (SILKSCREEN_LAYER_FRONT | SOLDERMASK_LAYER_FRONT \
                                | ADHESIVE_LAYER_FRONT | SOLDERPASTE_LAYER_FRONT)
-#define BACK_AUX_LAYERS        (SILKSCREEN_LAYER_BACK | SOLDERMASK_LAYER_BACK \
+#define BACK_TECH_LAYERS        (SILKSCREEN_LAYER_BACK | SOLDERMASK_LAYER_BACK \
                                | ADHESIVE_LAYER_BACK | SOLDERPASTE_LAYER_BACK)
-#define ALL_AUX_LAYERS         (FRONT_AUX_LAYERS | BACK_AUX_LAYERS)
-#define BACK_LAYERS            (LAYER_BACK | BACK_AUX_LAYERS)
-#define FRONT_LAYERS           (LAYER_FRONT | FRONT_AUX_LAYERS)
+#define ALL_TECH_LAYERS         (FRONT_TECH_LAYERS | BACK_TECH_LAYERS)
+#define BACK_LAYERS            (LAYER_BACK | BACK_TECH_LAYERS)
+#define FRONT_LAYERS           (LAYER_FRONT | FRONT_TECH_LAYERS)
+
+#define ALL_USER_LAYERS         (DRAW_LAYER | COMMENT_LAYER |\
+                                 ECO1_LAYER | ECO2_LAYER )
 
 #define NO_LAYERS               0x00000000
 
@@ -329,8 +336,18 @@ inline bool IsCopperLayer( LAYER_NUM aLayer )
  */
 inline bool IsNonCopperLayer( LAYER_NUM aLayer )
 {
-    return aLayer >= FIRST_NON_COPPER_LAYER
-        && aLayer <= LAST_NON_COPPER_LAYER;
+    return aLayer >= FIRST_NON_COPPER_LAYER && aLayer <= LAST_NON_COPPER_LAYER;
+}
+
+/**
+ * Function IsUserLayer
+ * tests whether a layer is a non copper and a non tech layer
+ * @param aLayer = Layer to test
+ * @return true if aLayer is a user layer
+ */
+inline bool IsUserLayer( LAYER_NUM aLayer )
+{
+    return aLayer >= FIRST_USER_LAYER && aLayer <= LAST_USER_LAYER;
 }
 
 /* IMPORTANT: If a layer is not a front layer not necessarily is true

pcbnew/dialogs/dialog_layers_setup.cpp

@@ -176,19 +176,19 @@ static const LAYER_MSK presets[] =
     NO_LAYERS,  // shift the array index up by one, matches with "Custom".
 
     // "Two layers, parts on Front only"
-    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | FRONT_AUX_LAYERS,
+    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | FRONT_TECH_LAYERS,
 
     // "Two layers, parts on Back only",
-    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | BACK_AUX_LAYERS,
+    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | BACK_TECH_LAYERS,
 
     // "Two layers, parts on Front and Back",
-    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | ALL_AUX_LAYERS,
+    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | ALL_TECH_LAYERS,
 
     // "Four layers, parts on Front only"
-    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | LAYER_2 | LAYER_3 | FRONT_AUX_LAYERS,
+    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | LAYER_2 | LAYER_3 | FRONT_TECH_LAYERS,
 
     // "Four layers, parts on Front and Back"
-    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | LAYER_2 | LAYER_3 | ALL_AUX_LAYERS,
+    EDGE_LAYER | LAYER_FRONT | LAYER_BACK | LAYER_2 | LAYER_3 | ALL_TECH_LAYERS,
 
     //  "All layers on",
     ALL_LAYERS,

pcbnew/dialogs/dialog_plot.cpp

@@ -246,7 +246,7 @@ void DIALOG_PLOT::OnPopUpLayers( wxCommandEvent& event )
             for( i = 0; i < m_layerList.size(); i++ )
             {
                 LAYER_MSK layermask = GetLayerMask( m_layerList[ i ] );
-                if( layermask & ( ALL_CU_LAYERS | ALL_AUX_LAYERS ) )
+                if( layermask & ( ALL_CU_LAYERS | ALL_TECH_LAYERS ) )
                     m_layerCheckListBox->Check( i, true );
                 else
                     m_layerCheckListBox->Check( i, false );