Adding Autodesk fusion import (incomplete, and I don't think I will continue there)

These are treated as pads in KiCad

Fixes https://gitlab.com/kicad/code/kicad/-/issues/18194

.gitignore

@@ -17,8 +17,6 @@ include/fp_lib_table_lexer.h
 include/lib_table_lexer.h
 include/netlist_lexer.h
 include/page_layout_reader_lexer.h
-eeschema/cmp_library_lexer.h
-eeschema/cmp_library_keywords.*
 eeschema/dialogs/dialog_bom_cfg_keywords.cpp
 eeschema/dialogs/dialog_bom_cfg_lexer.h
 common/template_fieldnames_keywords.cpp
@@ -103,7 +101,9 @@ __pycache__
 .editorconfig
 CMakeSettings.json
 .vscode/
+compile_commands.json
 /vcpkg_installed
+CMakePresets.json
 
 # Sublime Text
 *.sublime-*
@@ -112,6 +112,10 @@ CMakeSettings.json
 .kdev4/
 *.kdev4
 
+# Qt Creator
+CMakeLists.txt.user
+*.autosave
+
 # Translations
 *.mo
 i18n_status.svg

.gitlab/Fedora-Linux-CI.yml

@@ -28,6 +28,7 @@
       -DKICAD_BUILD_I18N=ON
       -DKICAD_TEST_XML_OUTPUT=ON
       -DKICAD_BUILD_PNS_DEBUG_TOOL=ON
+      -DKICAD_USE_CMAKE_FINDPROTOBUF=ON
       ../../
     - ninja 2>&1 | tee compilation_log.txt
     - cd ../../
@@ -39,6 +40,7 @@
     when: always
     paths:
       - build/linux/3d-viewer/
+      - build/linux/api/libkiapi.so*
       - build/linux/common/libkicommon.so*
       - build/linux/common/gal/libkigal.so*
       - build/linux/eeschema/_eeschema.kiface
@@ -63,6 +65,8 @@ fedora_build_linux_kicad:
 
 fedora_build_linux_public:
   extends: .fedora_build_linux_base
+  tags:
+    - saas-linux-medium-amd64
   except:    
     variables:
       - $CI_PROJECT_ROOT_NAMESPACE == "kicad"
@@ -150,7 +154,7 @@ fedora_report_metrics_public:
   parallel:
     matrix:
       # The name of the test without the qa_ prefix
-      - TEST: [python, cli, common, gerbview, pcbnew, pns_regressions, eeschema, kimath, sexpr, kicad2step, spice]
+      - TEST: [python, cli, common, gerbview, pcbnew, pns_regressions, eeschema, kimath, sexpr, kicad2step, spice, api]
 
 fedora_qa_kicad:
   extends: .fedora_qa

.gitlab/templates.yml

@@ -18,7 +18,7 @@
   stage: test
   when: on_success
   variables:
-    BOOST_TEST_LOGGER: 'JUNIT,warning,test_results.${TEST}.xml:HRF,warning'
+    BOOST_TEST_LOGGER: 'JUNIT,warning,test_results.${TEST}.xml:HRF,message'
     CTEST_OUTPUT_ON_FAILURE: 1
   script:
     - cd build/linux/qa

3d-viewer/3d_cache/3d_cache.cpp

@@ -381,13 +381,7 @@ bool S3D_CACHE::getSHA1( const wxString& aFileName, unsigned char* aSHA1Sum )
 
     fclose( fp );
     unsigned int digest[5];
-    // V8 only
-    // Boost 1.86 and later changed digest_type from uchar[20] from int[5]
-    // But KiCad 8.99 and later use MurmurHash3 here, so just do a fairly ugly cast to keep
-    // this going for another few months.
-    static_assert( sizeof( digest ) == sizeof( boost::uuids::detail::sha1::digest_type& ),
-                   "SHA1 digest size mismatch" );
-    dblock.get_digest( reinterpret_cast<boost::uuids::detail::sha1::digest_type&>( digest ) );
+    dblock.get_digest( digest );
 
     // ensure MSB order
     for( int i = 0; i < 5; ++i )

3d-viewer/3d_cache/3d_plugin_manager.cpp

@@ -155,13 +155,47 @@ void S3D_PLUGIN_MANAGER::loadPlugins( void )
     fn.AssignDir( PATHS::GetStockPlugins3DPath() );
     checkPluginPath( std::string( fn.GetPathWithSep().ToUTF8() ), searchpaths );
 #else
-   // Search path on OS X is
-   // (1) Machine  /Library/Application Support/kicad/PlugIns/3d
-   checkPluginPath( PATHS::GetOSXKicadMachineDataDir() + wxT( "/PlugIns/3d" ), searchpaths );
+    if( wxGetEnv( wxT( "KICAD_RUN_FROM_BUILD_DIR" ), nullptr ) )
+    {
+    	// Exe will be at <build_dir>/pcbnew/pcbnew.app/Contents/MacOS/pcbnew for standalone
+    	// Plugin will be at <build_dir>/kicad/KiCad.app/Contents/PlugIns/3d
+    	fn.Assign( wxStandardPaths::Get().GetExecutablePath() );
 
-   // (2) Bundle   kicad.app/Contents/PlugIns/3d
-   fn.AssignDir( PATHS::GetStockPlugins3DPath() );
-   checkPluginPath( fn.GetPathWithSep(), searchpaths );
+        if( fn.GetName() == wxT( "kicad" ) )
+        {
+            fn.AppendDir( wxT( ".." ) ); // Contents
+        }
+        else
+        {
+            fn.AppendDir( wxT( ".." ) ); // Contents
+            fn.AppendDir( wxT( ".." ) ); // pcbnew.app
+            fn.AppendDir( wxT( ".." ) ); // pcbnew
+            fn.AppendDir( wxT( ".." ) ); // Build root
+            fn.AppendDir( wxT( "kicad" ) );
+            fn.AppendDir( wxT( "KiCad.app" ) );
+            fn.AppendDir( wxT( "Contents" ) );
+        }
+
+    	fn.AppendDir( wxT( "PlugIns" ) );
+    	fn.AppendDir( wxT( "3d" ) );
+    	fn.MakeAbsolute();
+
+    	std::string testpath = std::string( fn.GetPathWithSep().ToUTF8() );
+    	checkPluginPath( testpath, searchpaths );
+
+        // Also check when running KiCad manager from build dir
+
+    }
+    else
+    {
+    	// Search path on OS X is
+    	// (1) Machine  /Library/Application Support/kicad/PlugIns/3d
+    	checkPluginPath( PATHS::GetOSXKicadMachineDataDir() + wxT( "/PlugIns/3d" ), searchpaths );
+
+    	// (2) Bundle   kicad.app/Contents/PlugIns/3d
+    	fn.AssignDir( PATHS::GetStockPlugins3DPath() );
+    	checkPluginPath( fn.GetPathWithSep(), searchpaths );
+    }
 #endif
 
     std::list< wxString >::iterator sPL = searchpaths.begin();
@@ -202,7 +236,7 @@ void S3D_PLUGIN_MANAGER::loadPlugins( void )
                 char const* cp = pp->GetFileFilter( i );
 
                 if( cp )
-                    addFilterString( wxString::FromUTF8Unchecked( cp ) );
+                    addFilterString( cp );
             }
 
             addExtensionMap( pp );
@@ -294,7 +328,7 @@ void S3D_PLUGIN_MANAGER::checkPluginName( const wxString& aPath,
         ++bl;
     }
 
-    // prevent loading non-plugin dlls 
+    // prevent loading non-plugin dlls
     if( wxGetEnv( wxT( "KICAD_RUN_FROM_BUILD_DIR" ), nullptr ) )
     {
         if( !path.GetName().StartsWith( "s3d_plugin" )
@@ -382,7 +416,7 @@ void S3D_PLUGIN_MANAGER::addExtensionMap( KICAD_PLUGIN_LDR_3D* aPlugin )
         wxString ws;
 
         if( cp )
-            ws = wxString::FromUTF8Unchecked( cp );
+            ws = wxString( cp );
 
         if( !ws.empty() )
         {

3d-viewer/3d_cache/sg/ifsg_api.cpp

@@ -476,7 +476,7 @@ SGVECTOR S3D::CalcTriNorm( const SGPOINT& p1, const SGPOINT& p2, const SGPOINT&
 
     // normal
     tri = glm::cross( pts[1] - pts[0], pts[2] - pts[0] );
-    glm::normalize( tri );
+    (void)glm::normalize( tri );
 
     return SGVECTOR( tri.x, tri.y, tri.z );
 }

3d-viewer/3d_canvas/board_adapter.cpp

@@ -344,7 +344,7 @@ void BOARD_ADAPTER::InitSettings( REPORTER* aStatusReporter, REPORTER* aWarningR
     BOX2I bbbox;
 
     if( m_board )
-        bbbox = m_board->ComputeBoundingBox( !m_board->IsFootprintHolder() && haveOutline );
+        bbbox = m_board->ComputeBoundingBox( !m_board->IsFootprintHolder() && haveOutline, false );
 
     // Gives a non null size to avoid issues in zoom / scale calculations
     if( ( bbbox.GetWidth() == 0 ) && ( bbbox.GetHeight() == 0 ) )
@@ -698,6 +698,10 @@ std::map<int, COLOR4D> BOARD_ADAPTER::GetLayerColors() const
     }
 
     colors[ LAYER_3D_COPPER_BOTTOM ] = colors[ LAYER_3D_COPPER_TOP ];
+
+    for( const auto& [layer, val] : m_ColorOverrides )
+        colors[layer] = val;
+
     return colors;
 }
 

3d-viewer/3d_canvas/board_adapter.h

@@ -3,7 +3,7 @@
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
  * Copyright (C) 2023 CERN
- * Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -32,7 +32,7 @@
 #include "../3d_rendering/raytracing/accelerators/container_3d.h"
 #include "../3d_rendering/raytracing/shapes3D/bbox_3d.h"
 #include <gal/3d/camera.h>
-#include "../3d_enums.h"
+#include <3d_enums.h>
 #include "../3d_cache/3d_cache.h"
 #include "../common_ogl/ogl_attr_list.h"
 #include "../3d_viewer/eda_3d_viewer_settings.h"
@@ -42,6 +42,8 @@
 #include <pcb_track.h>
 #include <pcb_base_frame.h>
 #include <pcb_text.h>
+#include <pcb_textbox.h>
+#include <pcb_table.h>
 #include <pcb_shape.h>
 #include <pcb_dimension.h>
 #include <zone.h>
@@ -377,6 +379,9 @@ private:
     void addShape( const PCB_TEXTBOX* aTextBox, CONTAINER_2D_BASE* aContainer,
                    const BOARD_ITEM* aOwner );
 
+    void addTable( const PCB_TABLE* aTable, CONTAINER_2D_BASE* aContainer,
+                   const BOARD_ITEM* aOwner );
+
     void addSolidAreasShapes( const ZONE* aZone, CONTAINER_2D_BASE* aDstContainer,
                               PCB_LAYER_ID aLayerId );
 
@@ -425,6 +430,8 @@ public:
     SFVEC4F           m_ECO1Color;
     SFVEC4F           m_ECO2Color;
 
+    std::map<int, COLOR4D> m_ColorOverrides;  ///< allows to override color scheme colors
+
 private:
     BOARD*            m_board;
     S3D_CACHE*        m_3dModelManager;

3d-viewer/3d_canvas/create_3Dgraphic_brd_items.cpp

@@ -34,10 +34,12 @@
 #include "../3d_rendering/raytracing/shapes2D/round_segment_2d.h"
 #include "../3d_rendering/raytracing/shapes2D/triangle_2d.h"
 #include <board_adapter.h>
+#include <board.h>
 #include <footprint.h>
 #include <pad.h>
 #include <pcb_text.h>
 #include <pcb_textbox.h>
+#include <pcb_table.h>
 #include <board_design_settings.h>
 #include <pcb_painter.h>        // for PCB_RENDER_SETTINGS
 #include <zone.h>
@@ -225,12 +227,17 @@ void BOARD_ADAPTER::addFootprintShapes( const FOOTPRINT* aFootprint, CONTAINER_2
             PCB_TEXTBOX* textbox = static_cast<PCB_TEXTBOX*>( item );
 
             if( textbox->GetLayer() == aLayerId )
-            {
-                if( textbox->IsBorderEnabled() )
-                    addShape( textbox, aContainer, aFootprint );
+                addShape( textbox, aContainer, aFootprint );
 
-                addText( textbox, aContainer, aFootprint );
-            }
+            break;
+        }
+
+        case PCB_TABLE_T:
+        {
+            PCB_TABLE* table = static_cast<PCB_TABLE*>( item );
+
+            if( table->GetLayer() == aLayerId )
+                addTable( table, aContainer, aFootprint );
 
             break;
         }
@@ -374,13 +381,6 @@ void BOARD_ADAPTER::createPadWithMargin( const PAD* aPad, CONTAINER_2D_BASE* aCo
         // Remove group membership from dummy item before deleting
         dummy.SetParentGroup( nullptr );
     }
-    else if( aPad->GetShape() == PAD_SHAPE::CUSTOM )
-    {
-        // A custom pad can have many complex subshape items. To avoid issues, use its
-        // final polygon shape, not its basic shape set. One cannot apply the clearance
-        // to each subshape: it does no work
-        aPad->TransformShapeToPolygon( poly, aLayer, 0, maxError );
-    }
     else
     {
         auto padShapes = std::static_pointer_cast<SHAPE_COMPOUND>( aPad->GetEffectiveShape() );
@@ -429,7 +429,7 @@ void BOARD_ADAPTER::createPadWithMargin( const PAD* aPad, CONTAINER_2D_BASE* aCo
                 break;
 
             case SH_POLY_SET:
-                poly.Append( *static_cast<const SHAPE_POLY_SET*>( shape ) );
+                poly = *(SHAPE_POLY_SET*) shape;
                 break;
 
             case SH_ARC:
@@ -733,7 +733,9 @@ void BOARD_ADAPTER::addShape( const PCB_TEXTBOX* aTextBox, CONTAINER_2D_BASE* aC
     // So for polygon, we use PCB_SHAPE::TransformShapeToPolygon
 
     if( aTextBox->GetShape() == SHAPE_T::RECTANGLE )
+    {
         addShape( static_cast<const PCB_SHAPE*>( aTextBox ), aContainer, aOwner );
+    }
     else
     {
         SHAPE_POLY_SET polyList;
@@ -746,6 +748,17 @@ void BOARD_ADAPTER::addShape( const PCB_TEXTBOX* aTextBox, CONTAINER_2D_BASE* aC
 }
 
 
+void BOARD_ADAPTER::addTable( const PCB_TABLE* aTable, CONTAINER_2D_BASE* aContainer,
+                              const BOARD_ITEM* aOwner )
+{
+    // JEY TODO: tables
+    // add borders
+
+    for( PCB_TABLECELL* cell : aTable->GetCells() )
+        addText( cell, aContainer, aOwner );
+}
+
+
 void BOARD_ADAPTER::addSolidAreasShapes( const ZONE* aZone, CONTAINER_2D_BASE* aContainer,
                                          PCB_LAYER_ID aLayerId )
 {

3d-viewer/3d_canvas/create_layer_items.cpp

@@ -36,10 +36,12 @@
 #include "../3d_rendering/raytracing/shapes2D/filled_circle_2d.h"
 #include "raytracing/shapes2D/triangle_2d.h"
 #include <board_design_settings.h>
+#include <board.h>
 #include <footprint.h>
 #include <pad.h>
 #include <pcb_text.h>
 #include <pcb_textbox.h>
+#include <pcb_table.h>
 #include <pcb_shape.h>
 #include <zone.h>
 #include <convert_basic_shapes_to_polygon.h>
@@ -185,12 +187,8 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
 
     for( PCB_TRACK* track : m_board->Tracks() )
     {
-        // Skip tracks (not vias that are on more than one layer ) on disabled layers
-        if( track->Type() != PCB_VIA_T
-            && !Is3dLayerEnabled( track->GetLayer(), visibilityFlags ) )
-        {
+        if( !Is3dLayerEnabled( track->GetLayer(), visibilityFlags ) ) // Skip non enabled layers
             continue;
-        }
 
         // Note: a PCB_TRACK holds normal segment tracks and also vias circles (that have also
         // drill values)
@@ -626,6 +624,10 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                 addShape( static_cast<PCB_TEXTBOX*>( item ), layerContainer, item );
                 break;
 
+            case PCB_TABLE_T:
+                addTable( static_cast<PCB_TABLE*>( item ), layerContainer, item );
+                break;
+
             case PCB_DIM_ALIGNED_T:
             case PCB_DIM_CENTER_T:
             case PCB_DIM_RADIAL_T:
@@ -690,6 +692,10 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                     break;
                 }
 
+                case PCB_TABLE_T:
+                    // JEY TODO: tables
+                    break;
+
                 default:
                     wxLogTrace( m_logTrace, wxT( "createLayers: item type: %d not implemented" ),
                                 item->Type() );
@@ -851,6 +857,10 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                     addShape( static_cast<PCB_TEXTBOX*>( item ), layerContainer, item );
                     break;
 
+                case PCB_TABLE_T:
+                    // JEY TODO: tables
+                    break;
+
                 case PCB_DIM_ALIGNED_T:
                 case PCB_DIM_CENTER_T:
                 case PCB_DIM_RADIAL_T:
@@ -865,14 +875,15 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
             }
 
             // Add via tech layers
-            if( ( layer == F_Mask || layer == B_Mask ) && !m_board->GetTentVias() )
+            if( ( layer == F_Mask || layer == B_Mask ) )
             {
                 int maskExpansion = GetBoard()->GetDesignSettings().m_SolderMaskExpansion;
 
                 for( PCB_TRACK* track : m_board->Tracks() )
                 {
                     if( track->Type() == PCB_VIA_T
-                            && static_cast<const PCB_VIA*>( track )->FlashLayer( layer )  )
+                            && static_cast<const PCB_VIA*>( track )->FlashLayer( layer )
+                            && !static_cast<const PCB_VIA*>( track )->IsTented( layer ) )
                     {
                         createViaWithMargin( track, layerContainer, maskExpansion );
                     }
@@ -946,20 +957,25 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                     break;
                 }
 
+                case PCB_TABLE_T:
+                    // JEY TODO: tables
+                    break;
+
                 default:
                     break;
                 }
             }
 
             // NON-TENTED VIAS
-            if( ( layer == F_Mask || layer == B_Mask ) && !m_board->GetTentVias() )
+            if( ( layer == F_Mask || layer == B_Mask ) )
             {
                 int maskExpansion = GetBoard()->GetDesignSettings().m_SolderMaskExpansion;
 
                 for( PCB_TRACK* track : m_board->Tracks() )
                 {
                     if( track->Type() == PCB_VIA_T
-                            && static_cast<const PCB_VIA*>( track )->FlashLayer( layer )  )
+                            && static_cast<const PCB_VIA*>( track )->FlashLayer( layer )
+                            && !static_cast<const PCB_VIA*>( track )->IsTented( layer ) )
                     {
                         track->TransformShapeToPolygon( *layerPoly, layer, maskExpansion, maxError,
                                                         ERROR_INSIDE );

3d-viewer/3d_canvas/eda_3d_canvas.cpp

@@ -29,7 +29,7 @@
 #include "../common_ogl/ogl_utils.h"
 #include "eda_3d_canvas.h"
 #include <eda_3d_viewer_frame.h>
-#include <3d_rendering/raytracing/render_3d_raytrace.h>
+#include <3d_rendering/raytracing/render_3d_raytrace_gl.h>
 #include <3d_rendering/opengl/render_3d_opengl.h>
 #include <3d_viewer_id.h>
 #include <advanced_config.h>
@@ -73,6 +73,11 @@ BEGIN_EVENT_TABLE( EDA_3D_CANVAS, HIDPI_GL_3D_CANVAS )
     EVT_MOTION( EDA_3D_CANVAS::OnMouseMove )
     EVT_MAGNIFY( EDA_3D_CANVAS::OnMagnify )
 
+    // touch gesture events
+    EVT_GESTURE_ZOOM( wxID_ANY, EDA_3D_CANVAS::OnZoomGesture )
+    EVT_GESTURE_PAN( wxID_ANY, EDA_3D_CANVAS::OnPanGesture )
+    EVT_GESTURE_ROTATE( wxID_ANY, EDA_3D_CANVAS::OnRotateGesture )
+
     // other events
     EVT_ERASE_BACKGROUND( EDA_3D_CANVAS::OnEraseBackground )
     EVT_CUSTOM(wxEVT_REFRESH_CUSTOM_COMMAND, ID_CUSTOM_EVENT_1, EDA_3D_CANVAS::OnRefreshRequest )
@@ -82,11 +87,11 @@ BEGIN_EVENT_TABLE( EDA_3D_CANVAS, HIDPI_GL_3D_CANVAS )
 END_EVENT_TABLE()
 
 
-EDA_3D_CANVAS::EDA_3D_CANVAS( wxWindow* aParent, const int* aAttribList,
+EDA_3D_CANVAS::EDA_3D_CANVAS( wxWindow* aParent, const wxGLAttributes& aGLAttribs,
                               BOARD_ADAPTER& aBoardAdapter, CAMERA& aCamera,
                               S3D_CACHE* a3DCachePointer ) :
-        HIDPI_GL_3D_CANVAS( EDA_DRAW_PANEL_GAL::GetVcSettings(), aCamera, aParent, wxID_ANY,
-                            aAttribList, wxDefaultPosition,
+        HIDPI_GL_3D_CANVAS( EDA_DRAW_PANEL_GAL::GetVcSettings(), aCamera, aParent, aGLAttribs,
+                            wxID_ANY, wxDefaultPosition,
                             wxDefaultSize, wxFULL_REPAINT_ON_RESIZE ),
         m_eventDispatcher( nullptr ),
         m_parentStatusBar( nullptr ),
@@ -120,7 +125,7 @@ EDA_3D_CANVAS::EDA_3D_CANVAS( wxWindow* aParent, const int* aAttribList,
 
     m_is_currently_painting.clear();
 
-    m_3d_render_raytracing = new RENDER_3D_RAYTRACE( this, m_boardAdapter, m_camera );
+    m_3d_render_raytracing = new RENDER_3D_RAYTRACE_GL( this, m_boardAdapter, m_camera );
     m_3d_render_opengl = new RENDER_3D_OPENGL( this, m_boardAdapter, m_camera );
 
     wxASSERT( m_3d_render_raytracing != nullptr );
@@ -144,6 +149,10 @@ EDA_3D_CANVAS::EDA_3D_CANVAS( wxWindow* aParent, const int* aAttribList,
     wxASSERT( a3DCachePointer != nullptr );
     m_boardAdapter.Set3dCacheManager( a3DCachePointer );
 
+#ifdef __WXMSW__
+    EnableTouchEvents( wxTOUCH_ZOOM_GESTURE | wxTOUCH_PAN_GESTURES | wxTOUCH_ROTATE_GESTURE );
+#endif
+
     const wxEventType events[] =
     {
         // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
@@ -631,6 +640,75 @@ void EDA_3D_CANVAS::OnMagnify( wxMouseEvent& event )
 }
 
 
+void EDA_3D_CANVAS::OnZoomGesture( wxZoomGestureEvent& aEvent )
+{
+    SetFocus();
+
+    if( aEvent.IsGestureStart() )
+    {
+        m_gestureLastZoomFactor = 1.0;
+        m_camera.SetCurMousePosition( aEvent.GetPosition() );
+    }
+
+    if( m_camera_is_moving )
+        return;
+
+    restart_editingTimeOut_Timer();
+
+    m_camera.Pan( aEvent.GetPosition() );
+    m_camera.SetCurMousePosition( aEvent.GetPosition() );
+
+    m_camera.Zoom( aEvent.GetZoomFactor() / m_gestureLastZoomFactor );
+
+    m_gestureLastZoomFactor = aEvent.GetZoomFactor();
+
+    DisplayStatus();
+    Request_refresh();
+}
+
+
+void EDA_3D_CANVAS::OnPanGesture( wxPanGestureEvent& aEvent )
+{
+    SetFocus();
+
+    if( aEvent.IsGestureStart() )
+        m_camera.SetCurMousePosition( aEvent.GetPosition() );
+
+    if( m_camera_is_moving )
+        return;
+
+    m_camera.Pan( aEvent.GetPosition() );
+    m_camera.SetCurMousePosition( aEvent.GetPosition() );
+
+    DisplayStatus();
+    Request_refresh();
+}
+
+
+void EDA_3D_CANVAS::OnRotateGesture( wxRotateGestureEvent& aEvent )
+{
+    SetFocus();
+
+    if( aEvent.IsGestureStart() )
+    {
+        m_gestureLastAngle = 0;
+        m_camera.SetCurMousePosition( aEvent.GetPosition() );
+
+        // We don't want to process the first angle
+        return;
+    }
+
+    if( m_camera_is_moving )
+        return;
+
+    m_camera.RotateScreen( m_gestureLastAngle - aEvent.GetRotationAngle() );
+    m_gestureLastAngle = aEvent.GetRotationAngle();
+
+    DisplayStatus();
+    Request_refresh();
+}
+
+
 void EDA_3D_CANVAS::OnMouseMove( wxMouseEvent& event )
 {
     if( m_3d_render && m_3d_render->IsReloadRequestPending() )
@@ -752,11 +830,6 @@ void EDA_3D_CANVAS::OnLeftDown( wxMouseEvent& event )
     SetFocus();
     stop_editingTimeOut_Timer();
 
-    // Ensure m_camera.m_lastPosition (current mouse position) is up to date for
-    // future drag events (can be not the case when left clicking after
-    // opening a context menu)
-    OnMouseMoveCamera( event );
-
     if( !event.Dragging() && ( m_3d_render_raytracing != nullptr ) )
     {
         RAY mouseRay = getRayAtCurrentMousePosition();
@@ -988,66 +1061,24 @@ bool EDA_3D_CANVAS::SetView3D( VIEW3D_TYPE aRequestedView )
         return true;
 
     case VIEW3D_TYPE::VIEW3D_RIGHT:
-        m_camera.SetInterpolateMode( CAMERA_INTERPOLATION::BEZIER );
-        m_camera.SetT0_and_T1_current_T();
-        m_camera.Reset_T1();
-        m_camera.RotateZ_T1( glm::radians( -90.0f ) );
-        m_camera.RotateX_T1( glm::radians( -90.0f ) );
-        request_start_moving_camera();
-        return true;
-
     case VIEW3D_TYPE::VIEW3D_LEFT:
-        m_camera.SetInterpolateMode( CAMERA_INTERPOLATION::BEZIER );
-        m_camera.SetT0_and_T1_current_T();
-        m_camera.Reset_T1();
-        m_camera.RotateZ_T1( glm::radians(  90.0f ) );
-        m_camera.RotateX_T1( glm::radians( -90.0f ) );
-        request_start_moving_camera();
-        return true;
-
     case VIEW3D_TYPE::VIEW3D_FRONT:
-        m_camera.SetInterpolateMode( CAMERA_INTERPOLATION::BEZIER );
-        m_camera.SetT0_and_T1_current_T();
-        m_camera.Reset_T1();
-        m_camera.RotateX_T1( glm::radians( -90.0f ) );
-        request_start_moving_camera();
-        return true;
-
     case VIEW3D_TYPE::VIEW3D_BACK:
+    case VIEW3D_TYPE::VIEW3D_FLIP:
         m_camera.SetInterpolateMode( CAMERA_INTERPOLATION::BEZIER );
         m_camera.SetT0_and_T1_current_T();
-        m_camera.Reset_T1();
-        m_camera.RotateX_T1( glm::radians( -90.0f ) );
-
-        // The rotation angle should be 180.
-        // We use 179.999 (180 - epsilon) to avoid a full 360 deg rotation when
-        // using 180 deg if the previous rotated position was already 180 deg
-        m_camera.RotateZ_T1( glm::radians( 179.999f ) );
+        m_camera.ViewCommand_T1( aRequestedView );
         request_start_moving_camera();
         return true;
 
     case VIEW3D_TYPE::VIEW3D_TOP:
-        m_camera.SetInterpolateMode( CAMERA_INTERPOLATION::BEZIER );
-        m_camera.SetT0_and_T1_current_T();
-        m_camera.Reset_T1();
-        request_start_moving_camera( glm::min( glm::max( m_camera.GetZoom(), 0.5f ), 1.125f ) );
-        return true;
-
     case VIEW3D_TYPE::VIEW3D_BOTTOM:
         m_camera.SetInterpolateMode( CAMERA_INTERPOLATION::BEZIER );
         m_camera.SetT0_and_T1_current_T();
-        m_camera.Reset_T1();
-        m_camera.RotateY_T1( glm::radians( 179.999f ) );    // Rotation = 180 - epsilon
+        m_camera.ViewCommand_T1( aRequestedView );
         request_start_moving_camera( glm::min( glm::max( m_camera.GetZoom(), 0.5f ), 1.125f ) );
         return true;
 
-    case VIEW3D_TYPE::VIEW3D_FLIP:
-        m_camera.SetInterpolateMode( CAMERA_INTERPOLATION::BEZIER );
-        m_camera.SetT0_and_T1_current_T();
-        m_camera.RotateY_T1( glm::radians( 179.999f ) );
-        request_start_moving_camera();
-        return true;
-
     default:
         return false;
     }

3d-viewer/3d_canvas/eda_3d_canvas.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -38,7 +38,7 @@
 class WX_INFOBAR;
 class wxStatusBar;
 class BOARD;
-class RENDER_3D_RAYTRACE;
+class RENDER_3D_RAYTRACE_GL;
 class RENDER_3D_OPENGL;
 
 
@@ -52,12 +52,12 @@ public:
      *  Create a new 3D Canvas with an attribute list.
      *
      *  @param aParent the parent creator of this canvas.
-     *  @param aAttribList a list of openGL options created by GetOpenGL_AttributesList.
+     *  @param aGLAttribs openGL attributes created by #OGL_ATT_LIST::GetAttributesList.
      *  @param aBoard The board.
      *  @param aSettings the settings options to be used by this canvas.
      */
-    EDA_3D_CANVAS( wxWindow* aParent, const int* aAttribList,
-                   BOARD_ADAPTER& aSettings, CAMERA& aCamera, S3D_CACHE* a3DCachePointer );
+    EDA_3D_CANVAS( wxWindow* aParent, const wxGLAttributes& aGLAttribs, BOARD_ADAPTER& aSettings,
+                   CAMERA& aCamera, S3D_CACHE* a3DCachePointer );
 
     ~EDA_3D_CANVAS();
 
@@ -97,7 +97,7 @@ public:
     }
 
     /**
-     * @return the current render ( a RENDER_3D_RAYTRACE* or a RENDER_3D_OPENGL* render )
+     * @return the current render ( a RENDER_3D_RAYTRACE_GL* or a RENDER_3D_OPENGL* render )
      */
     RENDER_3D_BASE* GetCurrentRender() const { return m_3d_render; }
 
@@ -237,6 +237,10 @@ private:
     void OnResize( wxSizeEvent& event );
     void OnTimerTimeout_Redraw( wxTimerEvent& event );
 
+    void OnZoomGesture( wxZoomGestureEvent& event );
+    void OnPanGesture( wxPanGestureEvent& event );
+    void OnRotateGesture( wxRotateGestureEvent& event );
+
     DECLARE_EVENT_TABLE()
 
     /**
@@ -311,7 +315,7 @@ private:
 
     BOARD_ADAPTER&         m_boardAdapter;            // Pre-computed 3D info and settings
     RENDER_3D_BASE*        m_3d_render;
-    RENDER_3D_RAYTRACE*    m_3d_render_raytracing;
+    RENDER_3D_RAYTRACE_GL* m_3d_render_raytracing;
     RENDER_3D_OPENGL*      m_3d_render_opengl;
 
     bool                   m_opengl_supports_raytracing;
@@ -324,6 +328,10 @@ private:
     bool    m_render3dmousePivot = false; // Render the 3dmouse pivot
     SFVEC3F m_3dmousePivotPos;            // The position of the 3dmouse pivot
 
+    ///< Used to track gesture events.
+    double   m_gestureLastZoomFactor = 1.0;
+    double   m_gestureLastAngle = 0.0;
+
     /**
      *  Trace mask used to enable or disable the trace output of this class.
      *  The debug output can be turned on by setting the WXTRACE environment variable to

3d-viewer/3d_model_viewer/eda_3d_model_viewer.cpp

@@ -86,9 +86,9 @@ END_EVENT_TABLE()
 #define RANGE_SCALE_3D 8.0f
 
 
-EDA_3D_MODEL_VIEWER::EDA_3D_MODEL_VIEWER( wxWindow* aParent, const int* aAttribList,
+EDA_3D_MODEL_VIEWER::EDA_3D_MODEL_VIEWER( wxWindow* aParent, const wxGLAttributes& aGLAttribs,
                                           S3D_CACHE* aCacheManager ) :
-        HIDPI_GL_CANVAS( EDA_DRAW_PANEL_GAL::GetVcSettings(), aParent, wxID_ANY, aAttribList,
+        HIDPI_GL_CANVAS( EDA_DRAW_PANEL_GAL::GetVcSettings(), aParent, aGLAttribs, wxID_ANY,
                          wxDefaultPosition, wxDefaultSize,
                          wxFULL_REPAINT_ON_RESIZE ),
         m_trackBallCamera( RANGE_SCALE_3D * 4.0f ),
@@ -301,7 +301,7 @@ void EDA_3D_MODEL_VIEWER::OnPaint( wxPaintEvent& event )
 
     // clear color and depth buffers
     glEnable( GL_DEPTH_TEST );
-    glClearColor( 0.0f, 0.0f, 0.0f, 1.0f );
+    glClearColor( 0.0f, 0.0f, 0.0f, 0.0f );
     glClearDepth( 1.0f );
     glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT );
 

3d-viewer/3d_model_viewer/eda_3d_model_viewer.h

@@ -49,9 +49,9 @@ public:
      *  Create a new 3D Canvas with a attribute list.
      *
      *  @param aParent the parent creator of this canvas.
-     *  @param aAttribList a list of openGL options created by #OGL_ATT_LIST::GetAttributesList.
+     *  @param aGLAttribs openGL attributes created by #OGL_ATT_LIST::GetAttributesList.
      */
-    EDA_3D_MODEL_VIEWER( wxWindow* aParent, const int* aAttribList  = nullptr,
+    EDA_3D_MODEL_VIEWER( wxWindow* aParent, const wxGLAttributes& aGLAttribs,
                          S3D_CACHE* aCacheManager = nullptr );
 
     ~EDA_3D_MODEL_VIEWER();

3d-viewer/3d_navlib/CMakeLists.txt

@@ -1,8 +1,6 @@
     add_library(3d-viewer_navlib STATIC
 	    "nl_3d_viewer_plugin.cpp"
 	    "nl_3d_viewer_plugin_impl.cpp"
-        "nl_footprint_properties_plugin.cpp"
-        "nl_footprint_properties_plugin_impl.cpp"
     )
 
     # 3d-viewer_navlib depends on make_lexer outputs in common

3d-viewer/3d_navlib/nl_3d_viewer_plugin.cpp

@@ -25,17 +25,20 @@
 
 
 NL_3D_VIEWER_PLUGIN::NL_3D_VIEWER_PLUGIN( EDA_3D_CANVAS* aViewport )
+ : m_impl( nullptr )
 {
     if( ADVANCED_CFG::GetCfg().m_Use3DConnexionDriver
         && KIPLATFORM::DRIVERS::Valid3DConnexionDriverVersion() )
     {
-        m_impl = std::make_unique<NL_3D_VIEWER_PLUGIN_IMPL>( aViewport, "KiCAD 3D" );
-        m_impl->Connect();
+        m_impl = new NL_3D_VIEWER_PLUGIN_IMPL( aViewport );
     }
 }
 
 
-NL_3D_VIEWER_PLUGIN::~NL_3D_VIEWER_PLUGIN() = default;
+NL_3D_VIEWER_PLUGIN::~NL_3D_VIEWER_PLUGIN()
+{
+    delete m_impl;
+}
 
 
 void NL_3D_VIEWER_PLUGIN::SetFocus( bool focus )

3d-viewer/3d_navlib/nl_3d_viewer_plugin.h

@@ -26,8 +26,6 @@
 #ifndef NL_3D_VIEWER_PLUGIN_H_
 #define NL_3D_VIEWER_PLUGIN_H_
 
-#include <memory>
-
 // Forward declarations.
 class EDA_3D_CANVAS;
 class NL_3D_VIEWER_PLUGIN_IMPL;
@@ -56,7 +54,7 @@ public:
     void SetFocus( bool aFocus = true );
 
 private:
-    std::unique_ptr<NL_3D_VIEWER_PLUGIN_IMPL> m_impl;
+    NL_3D_VIEWER_PLUGIN_IMPL* m_impl;
 };
 
 #endif // NL_3D_VIEWER_PLUGIN_H_

3d-viewer/3d_navlib/nl_3d_viewer_plugin_impl.cpp

@@ -1,8 +1,8 @@
 /*
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
- * Copyright (C) 2024 3Dconnexion
- * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2021 3Dconnexion
+ * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -27,7 +27,6 @@
 // KiCAD includes
 #include <tool/action_manager.h>
 #include <tool/tool_manager.h>
-#include <tool/tools_holder.h>
 
 // stdlib
 #include <map>
@@ -73,7 +72,7 @@ bool equals( glm::mat<L, C, T, Q> const& aFirst, glm::mat<L, C, T, Q> const& aSe
 }
 
 
-NL_3D_VIEWER_PLUGIN_IMPL::NL_3D_VIEWER_PLUGIN_IMPL( EDA_3D_CANVAS* aCanvas, const std::string& aProfileHint ) :
+NL_3D_VIEWER_PLUGIN_IMPL::NL_3D_VIEWER_PLUGIN_IMPL( EDA_3D_CANVAS* aCanvas ) :
         NAV_3D( false, false ),
         m_canvas( aCanvas ),
         m_capIsMoving( false ),
@@ -81,7 +80,12 @@ NL_3D_VIEWER_PLUGIN_IMPL::NL_3D_VIEWER_PLUGIN_IMPL( EDA_3D_CANVAS* aCanvas, cons
 {
     m_camera = dynamic_cast<TRACK_BALL*>( m_canvas->GetCamera() );
 
-    PutProfileHint( aProfileHint );
+    PutProfileHint( "KiCAD 3D" );
+
+    EnableNavigation( true );
+    PutFrameTimingSource( TimingSource::SpaceMouse );
+
+    exportCommandsAndImages();
 }
 
 
@@ -97,19 +101,8 @@ void NL_3D_VIEWER_PLUGIN_IMPL::SetFocus( bool aFocus )
     NAV_3D::Write( navlib::focus_k, aFocus );
 }
 
-
-EDA_3D_CANVAS* NL_3D_VIEWER_PLUGIN_IMPL::GetCanvas() const
-{
-    return m_canvas;
-}
-
-
-void NL_3D_VIEWER_PLUGIN_IMPL::Connect()
-{
-   EnableNavigation(true);
-   PutFrameTimingSource(TimingSource::SpaceMouse);
-   exportCommandsAndImages();
-}
+// temporary store for the categories
+typedef std::map<std::string, TDx::CCommandTreeNode*> CATEGORY_STORE;
 
 /**
  * Add a category to the store.
@@ -578,7 +571,7 @@ long NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand( std::string commandId )
 
         if( parent->IsEnabled() )
         {
-            TOOL_MANAGER* tool_manager = dynamic_cast<TOOLS_HOLDER*>( parent )->GetToolManager();
+            TOOL_MANAGER* tool_manager = static_cast<PCB_BASE_FRAME*>( parent )->GetToolManager();
 
             if( tool_manager == nullptr )
             {

3d-viewer/3d_navlib/nl_3d_viewer_plugin_impl.h

@@ -1,8 +1,8 @@
 /*
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
- * Copyright (C) 2024 3Dconnexion
- * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2021 3Dconnexion
+ * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -42,11 +42,6 @@
 class EDA_3D_CANVAS;
 class TRACK_BALL;
 
-// temporary store for the categories
-typedef std::map<std::string, TDx::CCommandTreeNode*> CATEGORY_STORE;
-
-CATEGORY_STORE::iterator add_category( std::string aCategoryPath, CATEGORY_STORE& aCategoryStore );
-
 // Convenience typedef.
 typedef TDx::SpaceMouse::Navigation3D::CNavigation3D NAV_3D;
 
@@ -61,9 +56,8 @@ public:
      * Initializes a new instance of the NL_3DVIEWER_PLUGIN.
      *
      *  @param aCanvas is the viewport to be navigated.
-     *  @param aProfileHint tells the 3DConnexion UI which profile to use.
      */
-    NL_3D_VIEWER_PLUGIN_IMPL( EDA_3D_CANVAS* aCanvas, const std::string& aProfileHint );
+    NL_3D_VIEWER_PLUGIN_IMPL( EDA_3D_CANVAS* aCanvas );
 
     virtual ~NL_3D_VIEWER_PLUGIN_IMPL();
 
@@ -75,21 +69,11 @@ public:
      */
     void SetFocus( bool aFocus = true );
 
-    /**
-     * Get the m_canvas pointer.
-     */
-    EDA_3D_CANVAS* GetCanvas() const;
-
-    /**
-     * Connect plugin implementation to the driver.
-     */
-    void Connect();
-
 private:
     /**
       * Export the invocable actions and images to the 3Dconnexion UI.
       */
-    virtual void exportCommandsAndImages();
+    void exportCommandsAndImages();
 
     long GetCameraMatrix( navlib::matrix_t& aMatrix ) const override;
     long GetPointerPosition( navlib::point_t& aPosition ) const override;
@@ -127,7 +111,6 @@ private:
     long GetCoordinateSystem( navlib::matrix_t& aMatrix ) const override;
     long GetIsViewRotatable( navlib::bool_t& isRotatable ) const override;
 
-
 private:
     EDA_3D_CANVAS* m_canvas;
     TRACK_BALL*    m_camera;

3d-viewer/3d_navlib/nl_footprint_properties_plugin.h

@@ -1,62 +0,0 @@
-/*
- * This program source code file is part of KiCad, a free EDA CAD application.
- *
- * Copyright (C) 2024 3Dconnexion
- * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
- *
- * This program is free software: you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the
- * Free Software Foundation, either version 3 of the License, or (at your
- * option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-/**
- * @file  nl_footprint_properties_plugin.h
- * @brief declaration of the nl_footprint_properties_plugin class
- */
-
-#ifndef NL_FOOTPRINT_PROPERTIES_PLUGIN_H_
-#define NL_FOOTPRINT_PROPERTIES_PLUGIN_H_
-
-#include <memory>
-
-// Forward declarations.
-class EDA_3D_CANVAS;
-class NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL;
-
-/**
- * The class that implements the public interface to the SpaceMouse plug-in.
- */
-class NL_FOOTPRINT_PROPERTIES_PLUGIN
-{
-public:
-    /**
-     * Initializes a new instance of the NL_FOOTPRINT_PROPERTIES_PLUGIN.
-     *
-     *  @param aViewport is the viewport to be navigated.
-     */
-    NL_FOOTPRINT_PROPERTIES_PLUGIN( EDA_3D_CANVAS* aViewport );
-
-    virtual ~NL_FOOTPRINT_PROPERTIES_PLUGIN();
-
-    /**
-     * Set the connection to the 3Dconnexion driver to the focus state so that
-     * 3DMouse data is routed here.
-     *
-     * @param aFocus is true to set the connection active.
-     */
-    void SetFocus( bool aFocus = true );
-
-private:
-    std::unique_ptr<NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL> m_impl;
-};
-
-#endif // NL_FOOTPRINT_PROPERTIES_PLUGIN_H_

3d-viewer/3d_navlib/nl_footprint_properties_plugin_impl.cpp

@@ -1,162 +0,0 @@
-/*
- * This program source code file is part of KiCad, a free EDA CAD application.
- *
- * Copyright (C) 2024 3Dconnexion
- * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
- *
- * This program is free software: you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the
- * Free Software Foundation, either version 3 of the License, or (at your
- * option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#include "nl_footprint_properties_plugin_impl.h"
-#include <3d-viewer/3d_canvas/eda_3d_canvas.h>
-
-// KiCAD includes
-#include <tool/action_manager.h>
-#include <tool/tool_manager.h>
-#include <tool/tools_holder.h>
-
-#include <wx/mstream.h>
-
-#define BOUNDING_BOX_SCALE_FACTOR 1.3f
-
-/**
- * Flag to enable the NL_FOOTPRINT_PROPERTIES_PLUGIN debug tracing.
- *
- * Use "KI_TRACE_NL_FOOTPRINT_PROPERTIES_PLUGIN" to enable.
- *
- * @ingroup trace_env_vars
- */
-const wxChar* NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::m_logTrace =
-        wxT( "KI_TRACE_NL_FOOTPRINT_PROPERTIES_PLUGIN" );
-
-
-NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL(EDA_3D_CANVAS* aCanvas) :
-  NL_3D_VIEWER_PLUGIN_IMPL(aCanvas, "KiCAD Footprint Properties")
-{}
-
-
-long NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::GetModelExtents( navlib::box_t& extents ) const
-{
-    SFVEC3F min = NL_3D_VIEWER_PLUGIN_IMPL::GetCanvas()->GetBoardAdapter().GetBBox().Min();
-    SFVEC3F max = NL_3D_VIEWER_PLUGIN_IMPL::GetCanvas()->GetBoardAdapter().GetBBox().Max();
-
-    SFVEC3F diff = ( BOUNDING_BOX_SCALE_FACTOR - 1.f ) / 2.f * ( max - min );
-
-    min -= diff;
-    max += diff;
-
-    extents = { min.x, min.y, min.z, max.x, max.y, max.z };
-
-    return 0;
-}
-
-
-void NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::exportCommandsAndImages()
-{
-    std::list<TOOL_ACTION*> actions = ACTION_MANAGER::GetActionList();
-
-    if( actions.size() == 0 )
-    {
-        return;
-    }
-
-    using TDx::SpaceMouse::CCommand;
-    using TDx::SpaceMouse::CCommandSet;
-
-    // The root action set node
-    CCommandSet commandSet( "EDA_3D_CANVAS", "3D Viewer" );
-
-    // Activate the command set
-    NAV_3D::PutActiveCommands( commandSet.GetId() );
-
-    // temporary store for the categories
-    CATEGORY_STORE categoryStore;
-
-    std::vector<TDx::CImage> vImages;
-
-    // add the action set to the category_store
-    categoryStore.insert( categoryStore.end(), CATEGORY_STORE::value_type( ".", &commandSet ) );
-
-    std::list<TOOL_ACTION*>::const_iterator it;
-
-    for( it = actions.begin(); it != actions.end(); ++it )
-    {
-        const TOOL_ACTION* action = *it;
-        std::string        label = action->GetMenuLabel().ToStdString();
-
-        if( label.empty() )
-        {
-            continue;
-        }
-
-        std::string name = action->GetName();
-
-        // Do no export commands for the pcbnew app.
-        if( name.rfind( "pcbnew.", 0 ) == 0 )
-        {
-            continue;
-        }
-
-        // Exclude commands which can't be used in the footprint properties.
-        if( name.rfind( "3DViewer.Control.pivotCenter", 0 ) == 0
-            || name.rfind( "3DViewer.Control.material", 0 ) == 0
-            || name.rfind( "3DViewer.Control.attribute", 0 ) == 0
-            || name.rfind( "3DViewer.Control.show", 0 ) == 0 )
-        {
-            continue;
-        }
-
-        std::string              strCategory = action->GetToolName();
-        CATEGORY_STORE::iterator iter = categoryStore.find( strCategory );
-
-        if( iter == categoryStore.end() )
-        {
-            iter = add_category( std::move( strCategory ), categoryStore );
-        }
-
-        std::string description = action->GetDescription().ToStdString();
-
-        // Arbitrary 8-bit data stream
-        wxMemoryOutputStream imageStream;
-
-        if( action->GetIcon() != BITMAPS::INVALID_BITMAP )
-        {
-            wxImage image = KiBitmap( action->GetIcon() ).ConvertToImage();
-            image.SaveFile( imageStream, wxBitmapType::wxBITMAP_TYPE_PNG );
-            image.Destroy();
-
-            if( imageStream.GetSize() )
-            {
-                wxStreamBuffer* streamBuffer = imageStream.GetOutputStreamBuffer();
-                TDx::CImage     tdxImage = TDx::CImage::FromData( "", 0, name.c_str() );
-                tdxImage.AssignImage( std::string( reinterpret_cast<const char*>(
-                                                           streamBuffer->GetBufferStart() ),
-                                                   streamBuffer->GetBufferSize() ),
-                                      0 );
-
-                wxLogTrace( m_logTrace, wxT( "Adding image for : %s" ), name );
-                vImages.push_back( std::move( tdxImage ) );
-            }
-        }
-
-        wxLogTrace( m_logTrace, wxT( "Inserting command: %s,  description: %s,  in category:  %s" ),
-                    name, description, iter->first );
-
-        iter->second->push_back(
-                CCommand( std::move( name ), std::move( label ), std::move( description ) ) );
-    }
-
-    NAV_3D::AddCommandSet( commandSet );
-    NAV_3D::AddImages( vImages );
-}

3d-viewer/3d_navlib/nl_footprint_properties_plugin_impl.h

@@ -1,68 +0,0 @@
-/*
- * This program source code file is part of KiCad, a free EDA CAD application.
- *
- * Copyright (C) 2024 3Dconnexion
- * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
- *
- * This program is free software: you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the
- * Free Software Foundation, either version 3 of the License, or (at your
- * option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-/**
- * @file  nl_footprint_properties_plugin_impl.h
- * @brief declaration of the nl_footprint_properties_plugin_impl class
- */
-
-#ifndef NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL_H_
-#define NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL_H_
-
-#include "nl_3d_viewer_plugin_impl.h"
-// TDxWare SDK.
-#include <SpaceMouse/CNavigation3D.hpp>
-
-/**
- * The class that adjusts NL_3D_VIEWER_PLUGIN_IMPL implementation for 3D Model preview in footprint properties dialog.
- */
-class NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL : public NL_3D_VIEWER_PLUGIN_IMPL
-{
-public:
-    /**
-     * Initializes a new instance of the NL_FOOTPRINT_PROPERTIES_PLUGIN.
-     *
-     *  @param aCanvas is the viewport to be navigated.
-     */
-    NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL( EDA_3D_CANVAS* aCanvas );
-
-private:
-    /**
-     * Get Footprint 3D Model extents.
-     *
-     *  @param extents is the box around the 3D model.
-     */
-    long GetModelExtents( navlib::box_t& extents ) const override;
-
-    /**
-     * Export the invocable actions and images to the 3Dconnexion UI.
-     */
-    void exportCommandsAndImages() override;
-
-private:
-    /**
-     *  Trace mask used to enable or disable the trace output of this class.
-     *  The debug output can be turned on by setting the WXTRACE environment variable to
-     *  "KI_TRACE_NL_FOOTPRINT_PROPERTIES_PLUGIN".  See the wxWidgets documentation on wxLogTrace for
-     *  more information.
-     */
-    static const wxChar* m_logTrace;
-};
-#endif // NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL_H_

3d-viewer/3d_rendering/buffers_debug.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2016-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2016-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -46,6 +46,19 @@ static void dbg_save_rgb_buffer( const wxString& aFileName, unsigned char *aRGBp
 }
 
 
+static void dbg_save_rgb_a_buffer( const wxString& aFileName, unsigned char* aRGBpixelBuffer,
+                                   unsigned char* aAlphaBuffer, unsigned int aXSize,
+                                   unsigned int aYSize )
+{
+    wxImage image( aXSize, aYSize );
+    image.SetData( aRGBpixelBuffer );
+    image.SetAlpha( aAlphaBuffer );
+    image = image.Mirror( false );
+    image.SaveFile( aFileName + wxT( ".png" ), wxBITMAP_TYPE_PNG );
+    image.Destroy();
+}
+
+
 void DBG_SaveBuffer( const wxString& aFileName, const unsigned char *aInBuffer,
                      unsigned int aXSize, unsigned int aYSize )
 {
@@ -110,6 +123,31 @@ void DBG_SaveBuffer( const wxString& aFileName, const SFVEC3F *aInBuffer,
 }
 
 
+void DBG_SaveBuffer( const wxString& aFileName, const SFVEC4F *aInBuffer,
+                     unsigned int aXSize, unsigned int aYSize )
+{
+    const unsigned int wxh = aXSize * aYSize;
+
+    unsigned char *pixelbuffer = (unsigned char*) malloc( wxh * 4 );
+    unsigned char *alphabuffer = (unsigned char*) malloc( wxh );
+
+    for( unsigned int i = 0; i < wxh; ++i )
+    {
+        const SFVEC4F &v = aInBuffer[i];
+        const unsigned int ix3 = i * 3;
+
+        // Set RGB value with all same values intensities
+        pixelbuffer[ix3 + 0] = (unsigned char) glm::min( (int) ( v.r * 255.0f ), 255 );
+        pixelbuffer[ix3 + 1] = (unsigned char) glm::min( (int) ( v.g * 255.0f ), 255 );
+        pixelbuffer[ix3 + 2] = (unsigned char) glm::min( (int) ( v.b * 255.0f ), 255 );
+
+        alphabuffer[i] = (unsigned char) glm::min( (int) ( v.a * 255.0f ), 255 );
+    }
+
+    dbg_save_rgb_a_buffer( aFileName, pixelbuffer, alphabuffer, aXSize, aYSize );
+}
+
+
 void DBG_SaveNormalsBuffer( const wxString& aFileName, const SFVEC3F *aInNormalsBuffer,
                             unsigned int aXSize, unsigned int aYSize )
 {

3d-viewer/3d_rendering/buffers_debug.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2016-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2016-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -42,6 +42,9 @@ void DBG_SaveBuffer( const wxString& aFileName, const float *aInBuffer,
 void DBG_SaveBuffer( const wxString& aFileName, const SFVEC3F *aInBuffer,
                      unsigned int aXSize, unsigned int aYSize );
 
+void DBG_SaveBuffer( const wxString& aFileName, const SFVEC4F *aInBuffer,
+                     unsigned int aXSize, unsigned int aYSize );
+
 void DBG_SaveNormalsBuffer( const wxString& aFileName, const SFVEC3F *aInNormalsBuffer,
                             unsigned int aXSize, unsigned int aYSize );
 

3d-viewer/3d_rendering/color_rgba.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -23,47 +23,60 @@
  */
 
  /**
- * @file color_rgb.cpp
+ * @file color_rgba.cpp
  */
 
 
-#include "color_rgb.h"
+#include "color_rgba.h"
 
 
-COLOR_RGB::COLOR_RGB( const SFVEC3F& aColor )
+COLOR_RGBA::COLOR_RGBA( const SFVEC3F& aColor )
 {
     r = (unsigned int) glm::clamp( (int) ( aColor.r * 255 ), 0, 255 );
     g = (unsigned int) glm::clamp( (int) ( aColor.g * 255 ), 0, 255 );
     b = (unsigned int) glm::clamp( (int) ( aColor.b * 255 ), 0, 255 );
+    a = 255;
 }
 
 
-COLOR_RGB BlendColor( const COLOR_RGB& aC1, const COLOR_RGB& aC2 )
+COLOR_RGBA::COLOR_RGBA( const SFVEC4F& aColor )
+{
+    r = (unsigned int) glm::clamp( (int) ( aColor.r * 255 ), 0, 255 );
+    g = (unsigned int) glm::clamp( (int) ( aColor.g * 255 ), 0, 255 );
+    b = (unsigned int) glm::clamp( (int) ( aColor.b * 255 ), 0, 255 );
+    a = (unsigned int) glm::clamp( (int) ( aColor.a * 255 ), 0, 255 );
+}
+
+
+COLOR_RGBA BlendColor( const COLOR_RGBA& aC1, const COLOR_RGBA& aC2 )
 {
     const unsigned int r = aC1.r + aC2.r;
     const unsigned int g = aC1.g + aC2.g;
     const unsigned int b = aC1.b + aC2.b;
+    const unsigned int a = aC1.a + aC2.a;
 
-    return COLOR_RGB( ( r >> 1 ), ( g >> 1 ), ( b >> 1 ) );
+    return COLOR_RGBA( ( r >> 1 ), ( g >> 1 ), ( b >> 1 ), ( a >> 1 ) );
 }
 
 
-COLOR_RGB BlendColor( const COLOR_RGB& aC1, const COLOR_RGB& aC2, const COLOR_RGB& aC3 )
+COLOR_RGBA BlendColor( const COLOR_RGBA& aC1, const COLOR_RGBA& aC2, const COLOR_RGBA& aC3 )
 {
     const unsigned int r = aC1.r + aC2.r + aC3.r;
     const unsigned int g = aC1.g + aC2.g + aC3.g;
     const unsigned int b = aC1.b + aC2.b + aC3.b;
+    const unsigned int a = aC1.a + aC2.a + aC3.a;
 
-    return COLOR_RGB( ( r / 3 ), ( g / 3 ), ( b / 3 ) );
+    return COLOR_RGBA( ( r / 3 ), ( g / 3 ), ( b / 3 ), ( a / 3 ) );
 }
 
 
-COLOR_RGB BlendColor( const COLOR_RGB& aC1, const COLOR_RGB& aC2, const COLOR_RGB& aC3,
-                      const COLOR_RGB& aC4 )
+COLOR_RGBA BlendColor( const COLOR_RGBA& aC1, const COLOR_RGBA& aC2, const COLOR_RGBA& aC3,
+                      const COLOR_RGBA& aC4 )
 {
     const unsigned int r = aC1.r + aC2.r + aC3.r + aC4.r;
     const unsigned int g = aC1.g + aC2.g + aC3.g + aC4.g;
     const unsigned int b = aC1.b + aC2.b + aC3.b + aC4.b;
+    const unsigned int a = aC1.a + aC2.a + aC3.a + aC4.a;
 
-    return COLOR_RGB( ( r >> 2 ), ( g >> 2 ), ( b >> 2 ) );
+    return COLOR_RGBA( ( r >> 2 ), ( g >> 2 ), ( b >> 2 ), ( a >> 2 ) );
 }

3d-viewer/3d_rendering/color_rgba.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -23,39 +23,49 @@
  */
 
 /**
- * @file color_rgb.h
+ * @file color_rgba.h
  */
 
-#ifndef COLOR_RGB_H
-#define COLOR_RGB_H
+#ifndef COLOR_RGBA_H
+#define COLOR_RGBA_H
 
 #include <plugins/3dapi/xv3d_types.h>
 
-union COLOR_RGB
+union COLOR_RGBA
 {
-    unsigned char c[3];
+    unsigned char c[4];
 
     struct
     {
         unsigned char r;
         unsigned char g;
         unsigned char b;
+        unsigned char a;
     };
 
-    COLOR_RGB( const SFVEC3F& aColor );
-    COLOR_RGB() { r = 0; g = 0; b = 0; }
-    COLOR_RGB( unsigned char aR, unsigned char aG, unsigned char aB )
+    COLOR_RGBA( const SFVEC3F& aColor );
+    COLOR_RGBA( const SFVEC4F& aColor );
+    COLOR_RGBA() { r = 0; g = 0; b = 0; a = 0; }
+    COLOR_RGBA( unsigned char aR, unsigned char aG, unsigned char aB )
     {
         r = aR;
         g = aG;
         b = aB;
     }
+
+    COLOR_RGBA( unsigned char aR, unsigned char aG, unsigned char aB, unsigned char aA )
+    {
+        r = aR;
+        g = aG;
+        b = aB;
+        a = aA;
+    }
 };
 
 
-COLOR_RGB BlendColor( const COLOR_RGB& aC1, const COLOR_RGB& aC2 );
-COLOR_RGB BlendColor( const COLOR_RGB& aC1, const COLOR_RGB& aC2, const COLOR_RGB& aC3 );
-COLOR_RGB BlendColor( const COLOR_RGB& aC1, const COLOR_RGB& aC2, const COLOR_RGB& aC3,
-                      const COLOR_RGB& aC4 );
+COLOR_RGBA BlendColor( const COLOR_RGBA& aC1, const COLOR_RGBA& aC2 );
+COLOR_RGBA BlendColor( const COLOR_RGBA& aC1, const COLOR_RGBA& aC2, const COLOR_RGBA& aC3 );
+COLOR_RGBA BlendColor( const COLOR_RGBA& aC1, const COLOR_RGBA& aC2, const COLOR_RGBA& aC3,
+                       const COLOR_RGBA& aC4 );
 
-#endif   // COLOR_RGB_H
+#endif   // COLOR_RGBA_H

3d-viewer/3d_rendering/opengl/3d_model.h

@@ -3,7 +3,7 @@
  *
  * Copyright (C) 2020 Oleg Endo <olegendo@gcc.gnu.org>
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -30,7 +30,7 @@
 #include <plugins/3dapi/c3dmodel.h>
 #include "../../common_ogl/openGL_includes.h"
 #include "../raytracing/shapes3D/bbox_3d.h"
-#include "../../3d_enums.h"
+#include <3d_enums.h>
 
 #include <wx/chartype.h>
 

3d-viewer/3d_rendering/opengl/render_3d_opengl.cpp

@@ -3,7 +3,7 @@
  *
  * Copyright (C) 2015-2020 Mario Luzeiro <mrluzeiro@ua.pt>
  * Copyright (C) 2023 CERN
- * Copyright (C) 2015-2023 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -30,6 +30,7 @@
 #include "render_3d_opengl.h"
 #include "opengl_utils.h"
 #include "common_ogl/ogl_utils.h"
+#include <board.h>
 #include <footprint.h>
 #include <3d_math.h>
 #include <glm/geometric.hpp>
@@ -47,7 +48,8 @@
 
 RENDER_3D_OPENGL::RENDER_3D_OPENGL( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& aAdapter,
                                     CAMERA& aCamera ) :
-        RENDER_3D_BASE( aCanvas, aAdapter, aCamera )
+        RENDER_3D_BASE( aAdapter, aCamera ),
+        m_canvas( aCanvas )
 {
     wxLogTrace( m_logTrace, wxT( "RENDER_3D_OPENGL::RENDER_3D_OPENGL" ) );
 
@@ -444,11 +446,17 @@ void RENDER_3D_OPENGL::renderBoardBody( bool aSkipRenderHoles )
 }
 
 
+static inline SFVEC4F premultiplyAlpha( const SFVEC4F& aInput )
+{
+    return SFVEC4F( aInput.r * aInput.a, aInput.g * aInput.a, aInput.b * aInput.a, aInput.a );
+}
+
+
 bool RENDER_3D_OPENGL::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
                                REPORTER* aWarningReporter )
 {
     // Initialize OpenGL
-    if( !m_is_opengl_initialized )
+    if( !m_canvasInitialized )
     {
         if( !initializeOpenGL() )
             return false;
@@ -495,7 +503,7 @@ bool RENDER_3D_OPENGL::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
         glEnable( GL_MULTISAMPLE );
 
     // clear color and depth buffers
-    glClearColor( 0.0f, 0.0f, 0.0f, 1.0f );
+    glClearColor( 0.0f, 0.0f, 0.0f, 0.0f );
     glClearDepth( 1.0f );
     glClearStencil( 0x00 );
     glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT );
@@ -503,8 +511,8 @@ bool RENDER_3D_OPENGL::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
     OglResetTextureState();
 
     // Draw the background ( rectangle with color gradient)
-    OglDrawBackground( SFVEC3F( m_boardAdapter.m_BgColorTop ),
-                       SFVEC3F( m_boardAdapter.m_BgColorBot ) );
+    OglDrawBackground( premultiplyAlpha( m_boardAdapter.m_BgColorTop ),
+                       premultiplyAlpha( m_boardAdapter.m_BgColorBot ) );
 
     glEnable( GL_DEPTH_TEST );
 
@@ -817,7 +825,7 @@ bool RENDER_3D_OPENGL::initializeOpenGL()
 
     // Use this mode if you want see the triangle lines (debug proposes)
     //glPolygonMode( GL_FRONT_AND_BACK,  GL_LINE );
-    m_is_opengl_initialized = true;
+    m_canvasInitialized = true;
 
     return true;
 }
@@ -1015,7 +1023,7 @@ void RENDER_3D_OPENGL::get3dModelsFromFootprint( std::list<MODELTORENDER> &aDstR
                     const SFVEC3F offset = SFVEC3F( sM.m_Offset.x, sM.m_Offset.y, sM.m_Offset.z );
                     const SFVEC3F rotation = SFVEC3F( sM.m_Rotation.x, sM.m_Rotation.y, sM.m_Rotation.z );
                     const SFVEC3F scale = SFVEC3F( sM.m_Scale.x, sM.m_Scale.y, sM.m_Scale.z );
-                    
+
                     std::vector<float> key = { offset.x, offset.y, offset.z,
                                                rotation.x, rotation.y, rotation.z,
                                                scale.x, scale.y, scale.z };
@@ -1128,7 +1136,7 @@ void RENDER_3D_OPENGL::renderTransparentModels( const glm::mat4 &aCameraViewMatr
         const SFVEC3F bBoxWorld = mtr.m_modelWorldMat * glm::vec4( bBoxCenter, 1.0f );
 
         const float distanceToCamera = glm::length( cameraPos - bBoxWorld );
-        
+
         transparentModelList.emplace_back( &mtr, distanceToCamera );
     }
 
@@ -1218,7 +1226,7 @@ void RENDER_3D_OPENGL::renderModel( const glm::mat4 &aCameraViewMatrix,
         aModelToRender.m_model->DrawBbox();
 
         glEnable( GL_LIGHTING );
-        
+
         if( !wasBlendEnabled )
             glDisable( GL_BLEND );
     }

3d-viewer/3d_rendering/opengl/render_3d_opengl.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2021 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -208,6 +208,8 @@ private:
         SMATERIAL m_GrayMaterial;
     } m_materials;
 
+    EDA_3D_CANVAS* m_canvas;
+
     MAP_OGL_DISP_LISTS  m_layers;
     OPENGL_RENDER_LIST* m_platedPadsFront;
     OPENGL_RENDER_LIST* m_platedPadsBack;

3d-viewer/3d_rendering/post_shader.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -63,7 +63,7 @@ void POST_SHADER::UpdateSize( unsigned int xSize, unsigned int ySize )
     const unsigned int n_elements = xSize * ySize;
 
     m_normals = new SFVEC3F[n_elements];
-    m_color   = new SFVEC3F[n_elements];
+    m_color   = new SFVEC4F[n_elements];
     m_depth   = new float[n_elements];
     m_wc_hitposition = new SFVEC3F[n_elements];
     m_shadow_att_factor = new float[n_elements];
@@ -77,7 +77,7 @@ void POST_SHADER::UpdateSize( const SFVEC2UI& aSize )
 
 
 void POST_SHADER::SetPixelData( unsigned int x, unsigned int y, const SFVEC3F& aNormal,
-                                const SFVEC3F& aColor, const SFVEC3F& aHitPosition,
+                                const SFVEC4F& aColor, const SFVEC3F& aHitPosition,
                                 float aDepth, float aShadowAttFactor )
 {
     wxASSERT( x < m_size.x );
@@ -125,7 +125,7 @@ const SFVEC3F& POST_SHADER::GetNormalAt( const SFVEC2F& aPos ) const
 }
 
 
-const SFVEC3F& POST_SHADER::GetColorAt( const SFVEC2F& aPos ) const
+const SFVEC4F& POST_SHADER::GetColorAt( const SFVEC2F& aPos ) const
 {
     return m_color[GetIndex( aPos )];
 }
@@ -149,13 +149,13 @@ const SFVEC3F& POST_SHADER::GetNormalAt( const SFVEC2I& aPos ) const
 }
 
 
-const SFVEC3F& POST_SHADER::GetColorAt( const SFVEC2I& aPos ) const
+const SFVEC4F& POST_SHADER::GetColorAt( const SFVEC2I& aPos ) const
 {
     return m_color[GetIndex( aPos )];
 }
 
 
-const SFVEC3F& POST_SHADER::GetColorAtNotProtected( const SFVEC2I& aPos ) const
+const SFVEC4F& POST_SHADER::GetColorAtNotProtected( const SFVEC2I& aPos ) const
 {
     return m_color[ aPos.x + m_size.x * aPos.y ];
 }

3d-viewer/3d_rendering/post_shader.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -46,7 +46,7 @@ public:
      * @param aShadeColor The result of the shader.
      * @return the result of the shade process
      */
-    virtual SFVEC3F ApplyShadeColor( const SFVEC2I& aShaderPos, const SFVEC3F& aInputColor,
+    virtual SFVEC4F ApplyShadeColor( const SFVEC2I& aShaderPos, const SFVEC4F& aInputColor,
                                      const SFVEC3F& aShadeColor ) const = 0;
 
     void UpdateSize( const SFVEC2UI& aSize );
@@ -56,10 +56,10 @@ public:
     void InitFrame() { m_tmin = FLT_MAX; m_tmax = 0.0f; }
 
     void SetPixelData( unsigned int x, unsigned int y, const SFVEC3F& aNormal,
-                       const SFVEC3F& aColor, const SFVEC3F& aHitPosition,
+                       const SFVEC4F& aColor, const SFVEC3F& aHitPosition,
                        float aDepth, float aShadowAttFactor );
 
-    const SFVEC3F& GetColorAtNotProtected( const SFVEC2I& aPos ) const;
+    const SFVEC4F& GetColorAtNotProtected( const SFVEC2I& aPos ) const;
 
     void DebugBuffersOutputAsImages() const;
 
@@ -88,12 +88,12 @@ public:
 
 protected:
     const SFVEC3F& GetNormalAt( const SFVEC2F& aPos ) const;
-    const SFVEC3F& GetColorAt( const SFVEC2F& aPos ) const;
+    const SFVEC4F& GetColorAt( const SFVEC2F& aPos ) const;
     const SFVEC3F& GetPositionAt( const SFVEC2F& aPos ) const;
     float GetDepthAt( const SFVEC2F& aPos ) const;
 
     const SFVEC3F& GetNormalAt( const SFVEC2I& aPos ) const;
-    const SFVEC3F& GetColorAt( const SFVEC2I& aPos ) const;
+    const SFVEC4F& GetColorAt( const SFVEC2I& aPos ) const;
     const SFVEC3F& GetPositionAt( const SFVEC2I& aPos ) const;
     const float& GetShadowFactorAt( const SFVEC2I& aPos ) const;
 
@@ -109,7 +109,7 @@ protected:
 
     SFVEC2UI m_size;
     SFVEC3F* m_normals;
-    SFVEC3F* m_color;
+    SFVEC4F* m_color;
     SFVEC3F* m_wc_hitposition;
     float*   m_depth;
     float*   m_shadow_att_factor;

3d-viewer/3d_rendering/post_shader_ssao.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -187,21 +187,21 @@ SFVEC3F POST_SHADER_SSAO::Shade( const SFVEC2I& aShaderPos ) const
             ao += aoFF( aShaderPos, ddiff8, n, shadowAt8, shadowAt0, -npw,   ph );
 
             gi += giFF( aShaderPos, ddiff , n, shadowAt1, npw,  nph) *
-                    giColorCurve( GetColorAt( aShaderPos + SFVEC2I(  npw, nph ) ) );
+                    giColorCurveShade( GetColorAt( aShaderPos + SFVEC2I(  npw, nph ) ) );
             gi += giFF( aShaderPos, ddiff2, n, shadowAt2, npw, -nph) *
-                    giColorCurve( GetColorAt( aShaderPos + SFVEC2I(  npw,-nph ) ) );
+                    giColorCurveShade( GetColorAt( aShaderPos + SFVEC2I(  npw,-nph ) ) );
             gi += giFF( aShaderPos, ddiff3, n, shadowAt3, -npw,  nph) *
-                    giColorCurve( GetColorAt( aShaderPos + SFVEC2I( -npw, nph ) ) );
+                    giColorCurveShade( GetColorAt( aShaderPos + SFVEC2I( -npw, nph ) ) );
             gi += giFF( aShaderPos, ddiff4, n, shadowAt4, -npw, -nph) *
-                    giColorCurve( GetColorAt( aShaderPos + SFVEC2I( -npw,-nph ) ) );
+                    giColorCurveShade( GetColorAt( aShaderPos + SFVEC2I( -npw,-nph ) ) );
             gi += giFF( aShaderPos, ddiff5, n, shadowAt5 , pw, nph) *
-                    giColorCurve( GetColorAt( aShaderPos + SFVEC2I(   pw, nph ) ) );
+                    giColorCurveShade( GetColorAt( aShaderPos + SFVEC2I(   pw, nph ) ) );
             gi += giFF( aShaderPos, ddiff6, n, shadowAt6,  pw,-nph) *
-                    giColorCurve( GetColorAt( aShaderPos + SFVEC2I(   pw,-nph ) ) );
+                    giColorCurveShade( GetColorAt( aShaderPos + SFVEC2I(   pw,-nph ) ) );
             gi += giFF( aShaderPos, ddiff7, n, shadowAt7,  npw, ph) *
-                    giColorCurve( GetColorAt( aShaderPos + SFVEC2I(  npw,  ph ) ) );
+                    giColorCurveShade( GetColorAt( aShaderPos + SFVEC2I(  npw,  ph ) ) );
             gi += giFF( aShaderPos, ddiff8, n, shadowAt8, -npw, ph) *
-                    giColorCurve( GetColorAt( aShaderPos + SFVEC2I( -npw,  ph ) ) );
+                    giColorCurveShade( GetColorAt( aShaderPos + SFVEC2I( -npw,  ph ) ) );
         }
 
         // If it received direct light, it shouldn't consider much AO
@@ -227,18 +227,20 @@ SFVEC3F POST_SHADER_SSAO::Shade( const SFVEC2I& aShaderPos ) const
 }
 
 
-SFVEC3F POST_SHADER_SSAO::ApplyShadeColor( const SFVEC2I& aShaderPos, const SFVEC3F& aInputColor,
+SFVEC4F POST_SHADER_SSAO::ApplyShadeColor( const SFVEC2I& aShaderPos, const SFVEC4F& aInputColor,
                                            const SFVEC3F& aShadeColor ) const
 {
-    SFVEC3F outColor;
+    SFVEC4F outColor;
+    SFVEC3F inColor( aInputColor );
 
-    const SFVEC3F subtracted = aInputColor - aShadeColor;
-    const SFVEC3F mixed = glm::mix( aInputColor, aInputColor * 0.50f - aShadeColor * 0.05f,
+    const SFVEC3F subtracted = inColor - aShadeColor;
+    const SFVEC3F mixed = glm::mix( inColor, inColor * 0.50f - aShadeColor * 0.05f,
                                     glm::min( aShadeColor, 1.0f ) );
 
     outColor.r = ( aShadeColor.r < 0.0f ) ? subtracted.r : mixed.r;
     outColor.g = ( aShadeColor.g < 0.0f ) ? subtracted.g : mixed.g;
     outColor.b = ( aShadeColor.b < 0.0f ) ? subtracted.b : mixed.b;
+    outColor.a = std::max( aInputColor.a, ( aShadeColor.r + aShadeColor.g + aShadeColor.b ) / 3 );
 
     return outColor;
 }
@@ -256,6 +258,18 @@ SFVEC3F POST_SHADER_SSAO::giColorCurve( const SFVEC3F& aColor ) const
 }
 
 
+SFVEC4F POST_SHADER_SSAO::giColorCurve( const SFVEC4F& aColor ) const
+{
+    return SFVEC4F( giColorCurve( SFVEC3F( aColor ) ), aColor.a );
+}
+
+
+SFVEC3F POST_SHADER_SSAO::giColorCurveShade( const SFVEC4F& aColor ) const
+{
+    return giColorCurve( SFVEC3F( aColor ) );
+}
+
+
 SFVEC3F POST_SHADER_SSAO::Blur( const SFVEC2I& aShaderPos ) const
 {
     const float dCenter = GetDepthAt( aShaderPos );

3d-viewer/3d_rendering/post_shader_ssao.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -40,7 +40,7 @@ public:
     explicit POST_SHADER_SSAO( const CAMERA& aCamera );
 
     SFVEC3F Shade(const SFVEC2I& aShaderPos ) const override;
-    SFVEC3F ApplyShadeColor( const SFVEC2I& aShaderPos, const SFVEC3F& aInputColor,
+    SFVEC4F ApplyShadeColor( const SFVEC2I& aShaderPos, const SFVEC4F& aInputColor,
                              const SFVEC3F& aShadeColor ) const override;
 
     SFVEC3F Blur( const SFVEC2I& aShaderPos ) const;
@@ -77,6 +77,8 @@ private:
      * @return transformed color.
      */
     SFVEC3F giColorCurve( const SFVEC3F& aColor ) const;
+    SFVEC4F giColorCurve( const SFVEC4F& aColor ) const;
+    SFVEC3F giColorCurveShade( const SFVEC4F& aColor ) const;
 
     SFVEC3F* m_shadedBuffer;
 

3d-viewer/3d_rendering/raytracing/create_scene.cpp

@@ -3,7 +3,7 @@
  *
  * Copyright (C) 2015-2022 Mario Luzeiro <mrluzeiro@ua.pt>
  * Copyright (C) 2023 CERN
- * Copyright (C) 2015-2023 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -23,7 +23,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  */
 
-#include "render_3d_raytrace.h"
+#include "render_3d_raytrace_base.h"
 #include "shapes3D/plane_3d.h"
 #include "shapes3D/round_segment_3d.h"
 #include "shapes3D/layer_item_3d.h"
@@ -72,7 +72,7 @@ static float TransparencyControl( float aGrayColorValue, float aTransparency )
 #define UNITS3D_TO_UNITSPCB ( pcbIUScale.IU_PER_MM )
 
 
-void RENDER_3D_RAYTRACE::setupMaterials()
+void RENDER_3D_RAYTRACE_BASE::setupMaterials()
 {
     MATERIAL::SetDefaultRefractionRayCount( m_boardAdapter.m_Cfg->m_Render.raytrace_nrsamples_refractions );
     MATERIAL::SetDefaultReflectionRayCount( m_boardAdapter.m_Cfg->m_Render.raytrace_nrsamples_reflections );
@@ -170,13 +170,13 @@ void RENDER_3D_RAYTRACE::setupMaterials()
 
     m_materials.m_Floor = BLINN_PHONG_MATERIAL( bgTop * 0.125f, SFVEC3F( 0.0f, 0.0f, 0.0f ),
                                                 ( SFVEC3F( 1.0f ) - bgTop ) / 3.0f,
-                                                0.10f * 128.0f, 0.0f, 0.50f );
+                                                0.10f * 128.0f, 1.0f, 0.50f );
     m_materials.m_Floor.SetCastShadows( false );
     m_materials.m_Floor.SetReflectionRecursionCount( 1 );
 }
 
 
-void RENDER_3D_RAYTRACE::createObject( CONTAINER_3D& aDstContainer, const OBJECT_2D* aObject2D,
+void RENDER_3D_RAYTRACE_BASE::createObject( CONTAINER_3D& aDstContainer, const OBJECT_2D* aObject2D,
                                        float aZMin, float aZMax, const MATERIAL* aMaterial,
                                        const SFVEC3F& aObjColor )
 {
@@ -227,7 +227,7 @@ void RENDER_3D_RAYTRACE::createObject( CONTAINER_3D& aDstContainer, const OBJECT
 }
 
 
-void RENDER_3D_RAYTRACE::createItemsFromContainer( const BVH_CONTAINER_2D* aContainer2d,
+void RENDER_3D_RAYTRACE_BASE::createItemsFromContainer( const BVH_CONTAINER_2D* aContainer2d,
                                                    PCB_LAYER_ID aLayer_id,
                                                    const MATERIAL* aMaterialLayer,
                                                    const SFVEC3F& aLayerColor,
@@ -358,7 +358,7 @@ void RENDER_3D_RAYTRACE::createItemsFromContainer( const BVH_CONTAINER_2D* aCont
 extern void buildBoardBoundingBoxPoly( const BOARD* aBoard, SHAPE_POLY_SET& aOutline );
 
 
-void RENDER_3D_RAYTRACE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningReporter,
+void RENDER_3D_RAYTRACE_BASE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningReporter,
                                  bool aOnlyLoadCopperAndShapes )
 {
     m_reloadRequested = false;
@@ -817,7 +817,7 @@ void RENDER_3D_RAYTRACE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningRe
                     const SFVEC3F v2 = SFVEC3F( v1.x, v3.y, v1.z );
                     const SFVEC3F v4 = SFVEC3F( v3.x, v1.y, v1.z );
 
-                    SFVEC3F backgroundColor = ConvertSRGBToLinear( m_boardAdapter.m_BgColorTop );
+                    SFVEC3F floorColor = ConvertSRGBToLinear( m_boardAdapter.m_BgColorTop );
 
                     TRIANGLE* newTriangle1 = new TRIANGLE( v1, v2, v3 );
                     TRIANGLE* newTriangle2 = new TRIANGLE( v3, v4, v1 );
@@ -828,8 +828,8 @@ void RENDER_3D_RAYTRACE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningRe
                     newTriangle1->SetMaterial( &m_materials.m_Floor );
                     newTriangle2->SetMaterial( &m_materials.m_Floor );
 
-                    newTriangle1->SetColor( backgroundColor );
-                    newTriangle2->SetColor( backgroundColor );
+                    newTriangle1->SetColor( floorColor );
+                    newTriangle2->SetColor( floorColor );
 
                     // Ceiling triangles
                     const float maxZ = glm::max( containerBBox.Max().z, boardBBox.Max().z );
@@ -848,8 +848,8 @@ void RENDER_3D_RAYTRACE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningRe
                     newTriangle3->SetMaterial( &m_materials.m_Floor );
                     newTriangle4->SetMaterial( &m_materials.m_Floor );
 
-                    newTriangle3->SetColor( backgroundColor );
-                    newTriangle4->SetColor( backgroundColor );
+                    newTriangle3->SetColor( floorColor );
+                    newTriangle4->SetColor( floorColor );
                 }
             }
         }
@@ -962,7 +962,7 @@ void RENDER_3D_RAYTRACE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningRe
 }
 
 
-void RENDER_3D_RAYTRACE::insertHole( const PCB_VIA* aVia )
+void RENDER_3D_RAYTRACE_BASE::insertHole( const PCB_VIA* aVia )
 {
     PCB_LAYER_ID top_layer, bottom_layer;
     int          radiusBUI = ( aVia->GetDrillValue() / 2 );
@@ -993,7 +993,7 @@ void RENDER_3D_RAYTRACE::insertHole( const PCB_VIA* aVia )
 }
 
 
-void RENDER_3D_RAYTRACE::insertHole( const PAD* aPad )
+void RENDER_3D_RAYTRACE_BASE::insertHole( const PAD* aPad )
 {
     const OBJECT_2D* object2d_A = nullptr;
 
@@ -1164,7 +1164,7 @@ void RENDER_3D_RAYTRACE::insertHole( const PAD* aPad )
 }
 
 
-void RENDER_3D_RAYTRACE::addPadsAndVias()
+void RENDER_3D_RAYTRACE_BASE::addPadsAndVias()
 {
     if( !m_boardAdapter.GetBoard() )
         return;
@@ -1193,7 +1193,7 @@ void RENDER_3D_RAYTRACE::addPadsAndVias()
 }
 
 
-void RENDER_3D_RAYTRACE::load3DModels( CONTAINER_3D& aDstContainer, bool aSkipMaterialInformation )
+void RENDER_3D_RAYTRACE_BASE::load3DModels( CONTAINER_3D& aDstContainer, bool aSkipMaterialInformation )
 {
     if( !m_boardAdapter.GetBoard() )
         return;
@@ -1315,7 +1315,7 @@ void RENDER_3D_RAYTRACE::load3DModels( CONTAINER_3D& aDstContainer, bool aSkipMa
 }
 
 
-MODEL_MATERIALS* RENDER_3D_RAYTRACE::getModelMaterial( const S3DMODEL* a3DModel )
+MODEL_MATERIALS* RENDER_3D_RAYTRACE_BASE::getModelMaterial( const S3DMODEL* a3DModel )
 {
     MODEL_MATERIALS* materialVector;
 
@@ -1418,7 +1418,7 @@ MODEL_MATERIALS* RENDER_3D_RAYTRACE::getModelMaterial( const S3DMODEL* a3DModel
 }
 
 
-void RENDER_3D_RAYTRACE::addModels( CONTAINER_3D& aDstContainer, const S3DMODEL* a3DModel,
+void RENDER_3D_RAYTRACE_BASE::addModels( CONTAINER_3D& aDstContainer, const S3DMODEL* a3DModel,
                                     const glm::mat4& aModelMatrix, float aFPOpacity,
                                     bool aSkipMaterialInformation, BOARD_ITEM* aBoardItem )
 {

3d-viewer/3d_rendering/raytracing/render_3d_raytrace_base.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2020 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2023 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -22,32 +22,28 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  */
 
-#include <gal/opengl/kiglew.h>    // Must be included first
-
 #include <algorithm>
 #include <atomic>
 #include <chrono>
 #include <thread>
 
-#include "render_3d_raytrace.h"
+#include "render_3d_raytrace_base.h"
 #include "mortoncodes.h"
-#include "../color_rgb.h"
+#include "../color_rgba.h"
 #include "3d_fastmath.h"
 #include "3d_math.h"
-#include "../common_ogl/ogl_utils.h"
 #include <core/profile.h>        // To use GetRunningMicroSecs or another profiling utility
 #include <wx/log.h>
 
 
-RENDER_3D_RAYTRACE::RENDER_3D_RAYTRACE( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& aAdapter, CAMERA& aCamera ) :
-    RENDER_3D_BASE( aCanvas, aAdapter, aCamera ),
-    m_postShaderSsao( aCamera )
+RENDER_3D_RAYTRACE_BASE::RENDER_3D_RAYTRACE_BASE( BOARD_ADAPTER& aAdapter, CAMERA& aCamera ) :
+        RENDER_3D_BASE( aAdapter, aCamera ),
+        m_postShaderSsao( aCamera )
 {
-    wxLogTrace( m_logTrace, wxT( "RENDER_3D_RAYTRACE::RENDER_3D_RAYTRACE" ) );
+    wxLogTrace( m_logTrace, wxT( "RENDER_3D_RAYTRACE_BASE::RENDER_3D_RAYTRACE_BASE" ) );
 
-    m_openglSupportsVertexBufferObjects = false;
-    m_pboId       = GL_NONE;
-    m_pboDataSize = 0;
+    //m_pboId       = GL_NONE;
+    //m_pboDataSize = 0;
     m_accelerator = nullptr;
     m_convertedDummyBlockCount = 0;
     m_converted2dRoundSegmentCount = 0;
@@ -62,6 +58,7 @@ RENDER_3D_RAYTRACE::RENDER_3D_RAYTRACE( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& a
     m_xoffset = 0;
     m_yoffset = 0;
 
+    m_is_canvas_initialized = false;
     m_isPreview = false;
     m_renderState = RT_RENDER_STATE_MAX; // Set to an initial invalid state
     m_renderStartTime = 0;
@@ -69,9 +66,9 @@ RENDER_3D_RAYTRACE::RENDER_3D_RAYTRACE( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& a
 }
 
 
-RENDER_3D_RAYTRACE::~RENDER_3D_RAYTRACE()
+RENDER_3D_RAYTRACE_BASE::~RENDER_3D_RAYTRACE_BASE()
 {
-    wxLogTrace( m_logTrace, wxT( "RENDER_3D_RAYTRACE::~RENDER_3D_RAYTRACE" ) );
+    wxLogTrace( m_logTrace, wxT( "RENDER_3D_RAYTRACE_BASE::~RENDER_3D_RAYTRACE_BASE" ) );
 
     delete m_accelerator;
     m_accelerator = nullptr;
@@ -84,43 +81,16 @@ RENDER_3D_RAYTRACE::~RENDER_3D_RAYTRACE()
 
     delete[] m_shaderBuffer;
     m_shaderBuffer = nullptr;
-
-    deletePbo();
 }
 
 
-int RENDER_3D_RAYTRACE::GetWaitForEditingTimeOut()
+int RENDER_3D_RAYTRACE_BASE::GetWaitForEditingTimeOut()
 {
     return 200; // ms
 }
 
 
-void RENDER_3D_RAYTRACE::deletePbo()
-{
-    // Delete PBO if it was created
-    if( m_openglSupportsVertexBufferObjects )
-    {
-        if( glIsBufferARB( m_pboId ) )
-            glDeleteBuffers( 1, &m_pboId );
-
-        m_pboId = GL_NONE;
-    }
-}
-
-
-void RENDER_3D_RAYTRACE::SetCurWindowSize( const wxSize& aSize )
-{
-    if( m_windowSize != aSize )
-    {
-        m_windowSize = aSize;
-        glViewport( 0, 0, m_windowSize.x, m_windowSize.y );
-
-        initializeNewWindowSize();
-    }
-}
-
-
-void RENDER_3D_RAYTRACE::restartRenderState()
+void RENDER_3D_RAYTRACE_BASE::restartRenderState()
 {
     m_renderStartTime = GetRunningMicroSecs();
 
@@ -136,154 +106,22 @@ void RENDER_3D_RAYTRACE::restartRenderState()
 }
 
 
-static inline void SetPixel( GLubyte* p, const COLOR_RGB& v )
+static inline void SetPixel( GLubyte* p, const COLOR_RGBA& v )
 {
     p[0] = v.c[0];
     p[1] = v.c[1];
     p[2] = v.c[2];
-    p[3] = 255;
+    p[3] = v.c[3];
 }
 
 
-bool RENDER_3D_RAYTRACE::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
-                                 REPORTER* aWarningReporter )
+SFVEC4F RENDER_3D_RAYTRACE_BASE::premultiplyAlpha( const SFVEC4F& aInput )
 {
-    bool requestRedraw = false;
-
-    // Initialize openGL if need
-    if( !m_is_opengl_initialized )
-    {
-        if( !initializeOpenGL() )
-            return false;
-
-        //aIsMoving = true;
-        requestRedraw = true;
-
-        // It will assign the first time the windows size, so it will now
-        // revert to preview mode the first time the Redraw is called
-        m_oldWindowsSize = m_windowSize;
-        initializeBlockPositions();
-    }
-
-    std::unique_ptr<BUSY_INDICATOR> busy = CreateBusyIndicator();
-
-    // Reload board if it was requested
-    if( m_reloadRequested )
-    {
-        if( aStatusReporter )
-            aStatusReporter->Report( _( "Loading..." ) );
-
-        //aIsMoving = true;
-        requestRedraw = true;
-        Reload( aStatusReporter, aWarningReporter, false );
-    }
-
-
-    // Recalculate constants if windows size was changed
-    if( m_windowSize != m_oldWindowsSize )
-    {
-        m_oldWindowsSize = m_windowSize;
-        aIsMoving = true;
-        requestRedraw = true;
-
-        initializeBlockPositions();
-    }
-
-
-    // Clear buffers
-    glClearColor( 0.0f, 0.0f, 0.0f, 1.0f );
-    glClearDepth( 1.0f );
-    glClearStencil( 0x00 );
-    glClear( GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT );
-
-    // 4-byte pixel alignment
-    glPixelStorei( GL_UNPACK_ALIGNMENT, 4 );
-
-    glDisable( GL_STENCIL_TEST );
-    glDisable( GL_LIGHTING );
-    glDisable( GL_COLOR_MATERIAL );
-    glDisable( GL_DEPTH_TEST );
-    glDisable( GL_TEXTURE_2D );
-    glDisable( GL_BLEND );
-    glDisable( GL_MULTISAMPLE );
-
-    const bool was_camera_changed = m_camera.ParametersChanged();
-
-    if( requestRedraw || aIsMoving || was_camera_changed )
-        m_renderState = RT_RENDER_STATE_MAX; // Set to an invalid state,
-                                             // so it will restart again latter
-
-    // This will only render if need, otherwise it will redraw the PBO on the screen again
-    if( aIsMoving || was_camera_changed )
-    {
-        // Set head light (camera view light) with the opposite direction of the camera
-        if( m_cameraLight )
-            m_cameraLight->SetDirection( -m_camera.GetDir() );
-
-        OglDrawBackground( SFVEC3F( m_boardAdapter.m_BgColorTop),
-                           SFVEC3F( m_boardAdapter.m_BgColorBot) );
-
-        // Bind PBO
-        glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, m_pboId );
-
-        // Get the PBO pixel pointer to write the data
-        GLubyte* ptrPBO = (GLubyte *)glMapBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB,
-                                                     GL_WRITE_ONLY_ARB );
-
-        if( ptrPBO )
-        {
-            renderPreview( ptrPBO );
-
-            // release pointer to mapping buffer, this initialize the coping to PBO
-            glUnmapBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB );
-        }
-
-        glWindowPos2i( m_xoffset, m_yoffset );
-    }
-    else
-    {
-        // Bind PBO
-        glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, m_pboId );
-
-        if( m_renderState != RT_RENDER_STATE_FINISH )
-        {
-            // Get the PBO pixel pointer to write the data
-            GLubyte* ptrPBO = (GLubyte *)glMapBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB,
-                                                         GL_WRITE_ONLY_ARB );
-
-            if( ptrPBO )
-            {
-                render( ptrPBO, aStatusReporter );
-
-                if( m_renderState != RT_RENDER_STATE_FINISH )
-                    requestRedraw = true;
-
-                // release pointer to mapping buffer, this initialize the coping to PBO
-                glUnmapBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB );
-            }
-        }
-
-        if( m_renderState == RT_RENDER_STATE_FINISH )
-        {
-            glClear( GL_COLOR_BUFFER_BIT );
-        }
-
-        glWindowPos2i( m_xoffset, m_yoffset );
-    }
-
-    // This way it will blend the progress rendering with the last buffer. eg:
-    // if it was called after a openGL.
-    glEnable( GL_BLEND );
-    glBlendFunc( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA );
-    glEnable( GL_ALPHA_TEST );
-    glDrawPixels( m_realBufferSize.x, m_realBufferSize.y, GL_RGBA, GL_UNSIGNED_BYTE, 0 );
-    glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, 0 );
-
-    return requestRedraw;
+    return SFVEC4F( aInput.r * aInput.a, aInput.g * aInput.a, aInput.b * aInput.a, aInput.a );
 }
 
 
-void RENDER_3D_RAYTRACE::render( GLubyte* ptrPBO, REPORTER* aStatusReporter )
+void RENDER_3D_RAYTRACE_BASE::render( GLubyte* ptrPBO, REPORTER* aStatusReporter )
 {
     if( ( m_renderState == RT_RENDER_STATE_FINISH ) || ( m_renderState >= RT_RENDER_STATE_MAX ) )
     {
@@ -307,8 +145,10 @@ void RENDER_3D_RAYTRACE::render( GLubyte* ptrPBO, REPORTER* aStatusReporter )
             }
         }
 
-        m_backgroundColorTop = ConvertSRGBToLinear( (SFVEC3F)m_boardAdapter.m_BgColorTop );
-        m_backgroundColorBottom = ConvertSRGBToLinear( (SFVEC3F)m_boardAdapter.m_BgColorBot );
+        m_backgroundColorTop =
+                ConvertSRGBAToLinear( premultiplyAlpha( m_boardAdapter.m_BgColorTop ) );
+        m_backgroundColorBottom =
+                ConvertSRGBAToLinear( premultiplyAlpha( m_boardAdapter.m_BgColorBot ) );
     }
 
     switch( m_renderState )
@@ -334,14 +174,14 @@ void RENDER_3D_RAYTRACE::render( GLubyte* ptrPBO, REPORTER* aStatusReporter )
     if( aStatusReporter && ( m_renderState == RT_RENDER_STATE_FINISH ) )
     {
         // Calculation time in seconds
-        const double elapsed_time = (double)( GetRunningMicroSecs() - m_renderStartTime ) / 1e6;
+        const double elapsed_time = (double) ( GetRunningMicroSecs() - m_renderStartTime ) / 1e6;
 
         aStatusReporter->Report( wxString::Format( _( "Rendering time %.3f s" ), elapsed_time ) );
     }
 }
 
 
-void RENDER_3D_RAYTRACE::renderTracing( GLubyte* ptrPBO, REPORTER* aStatusReporter )
+void RENDER_3D_RAYTRACE_BASE::renderTracing( GLubyte* ptrPBO, REPORTER* aStatusReporter )
 {
     m_isPreview = false;
 
@@ -356,6 +196,8 @@ void RENDER_3D_RAYTRACE::renderTracing( GLubyte* ptrPBO, REPORTER* aStatusReport
             std::max<size_t>( std::thread::hardware_concurrency(), 2 ),
             m_blockPositions.size() );
 
+    const int timeLimit = m_blockPositions.size() > 40000 ? 500 : 200;
+
     for( size_t ii = 0; ii < parallelThreadCount; ++ii )
     {
         std::thread t = std::thread( [&]()
@@ -372,8 +214,10 @@ void RENDER_3D_RAYTRACE::renderTracing( GLubyte* ptrPBO, REPORTER* aStatusReport
 
                     // Check if it spend already some time render and request to exit
                     // to display the progress
-                    if( std::chrono::duration_cast<std::chrono::milliseconds>(
-                            std::chrono::steady_clock::now() - startTime ).count() > 150 )
+                    auto diff = std::chrono::duration_cast<std::chrono::milliseconds>(
+                            std::chrono::steady_clock::now() - startTime );
+
+                    if( diff.count() > timeLimit )
                         breakLoop = true;
                 }
             }
@@ -424,6 +268,11 @@ static SFVEC3F convertLinearToSRGB( const SFVEC3F& aRGBcolor )
                      glm::lessThan( clampedColor, SFVEC3F(0.0031308f) ) );
 }
 
+static SFVEC4F convertLinearToSRGBA( const SFVEC4F& aRGBAcolor )
+{
+    return SFVEC4F( convertLinearToSRGB( SFVEC3F( aRGBAcolor ) ), aRGBAcolor.a );
+}
+
 
 // This function implements the conversion from sRGB to linear RGB
 // https://github.com/g-truc/glm/blob/master/glm/gtc/color_space.inl#L35
@@ -438,13 +287,18 @@ SFVEC3F ConvertSRGBToLinear( const SFVEC3F& aSRGBcolor )
                      glm::lessThanEqual( aSRGBcolor, SFVEC3F( 0.04045f ) ) );
 }
 
+SFVEC4F ConvertSRGBAToLinear( const SFVEC4F& aSRGBAcolor )
+{
+    return SFVEC4F( ConvertSRGBToLinear( SFVEC3F( aSRGBAcolor ) ), aSRGBAcolor.a );
+}
+
 #endif
 
 
-void RENDER_3D_RAYTRACE::renderFinalColor( GLubyte* ptrPBO, const SFVEC3F& rgbColor,
+void RENDER_3D_RAYTRACE_BASE::renderFinalColor( GLubyte* ptrPBO, const SFVEC4F& rgbColor,
                                          bool applyColorSpaceConversion )
 {
-    SFVEC3F color = rgbColor;
+    SFVEC4F color = rgbColor;
 
 #ifdef USE_SRGB_SPACE
     /// @note This should be used in future when the KiCad support a greater version of glm lib.
@@ -458,7 +312,7 @@ void RENDER_3D_RAYTRACE::renderFinalColor( GLubyte* ptrPBO, const SFVEC3F& rgbCo
     ptrPBO[0] = (unsigned int) glm::clamp( (int) ( color.r * 255 ), 0, 255 );
     ptrPBO[1] = (unsigned int) glm::clamp( (int) ( color.g * 255 ), 0, 255 );
     ptrPBO[2] = (unsigned int) glm::clamp( (int) ( color.b * 255 ), 0, 255 );
-    ptrPBO[3] = 255;
+    ptrPBO[3] = (unsigned int) glm::clamp( (int) ( color.a * 255 ), 0, 255 );
 }
 
 
@@ -476,9 +330,9 @@ static void HITINFO_PACKET_init( HITINFO_PACKET* aHitPacket )
 }
 
 
-void RENDER_3D_RAYTRACE::renderRayPackets( const SFVEC3F* bgColorY, const RAY* aRayPkt,
+void RENDER_3D_RAYTRACE_BASE::renderRayPackets( const SFVEC4F* bgColorY, const RAY* aRayPkt,
                                            HITINFO_PACKET* aHitPacket, bool is_testShadow,
-                                           SFVEC3F* aOutHitColor )
+                                           SFVEC4F* aOutHitColor )
 {
     for( unsigned int y = 0, i = 0; y < RAYPACKET_DIM; ++y )
     {
@@ -498,10 +352,10 @@ void RENDER_3D_RAYTRACE::renderRayPackets( const SFVEC3F* bgColorY, const RAY* a
 }
 
 
-void RENDER_3D_RAYTRACE::renderAntiAliasPackets( const SFVEC3F* aBgColorY,
+void RENDER_3D_RAYTRACE_BASE::renderAntiAliasPackets( const SFVEC4F* aBgColorY,
                                                  const HITINFO_PACKET* aHitPck_X0Y0,
                                                  const HITINFO_PACKET* aHitPck_AA_X1Y1,
-                                                 const RAY* aRayPck, SFVEC3F* aOutHitColor )
+                                                 const RAY* aRayPck, SFVEC4F* aOutHitColor )
 {
     const bool is_testShadow =  m_boardAdapter.m_Cfg->m_Render.raytrace_shadows;
 
@@ -622,7 +476,7 @@ void RENDER_3D_RAYTRACE::renderAntiAliasPackets( const SFVEC3F* aBgColorY,
 #define DISP_FACTOR 0.075f
 
 
-void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock )
+void RENDER_3D_RAYTRACE_BASE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock )
 {
     // Initialize ray packets
     const SFVEC2UI& blockPos = m_blockPositions[iBlock];
@@ -637,14 +491,14 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
     HITINFO_PACKET_init( hitPacket_X0Y0 );
 
     // Calculate background gradient color
-    SFVEC3F bgColor[RAYPACKET_DIM];// Store a vertical gradient color
+    SFVEC4F bgColor[RAYPACKET_DIM];// Store a vertical gradient color
 
     for( unsigned int y = 0; y < RAYPACKET_DIM; ++y )
     {
         const float posYfactor = (float) ( blockPosI.y + y ) / (float) m_windowSize.y;
 
-        bgColor[y] = m_backgroundColorTop * SFVEC3F(posYfactor) +
-                     m_backgroundColorBottom * ( SFVEC3F(1.0f) - SFVEC3F(posYfactor) );
+        bgColor[y] = m_backgroundColorTop * SFVEC4F(posYfactor) +
+                     m_backgroundColorBottom * ( SFVEC4F(1.0f) - SFVEC4F(posYfactor) );
     }
 
     // Intersect ray packets (calculate the intersection with rays and objects)
@@ -655,7 +509,7 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
         {
             for( unsigned int y = 0; y < RAYPACKET_DIM; ++y )
             {
-                const SFVEC3F& outColor = bgColor[y];
+                const SFVEC4F& outColor = bgColor[y];
 
                 const unsigned int yBlockPos = blockPos.y + y;
 
@@ -675,7 +529,7 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
 
         for( unsigned int y = 0; y < RAYPACKET_DIM; ++y )
         {
-            const SFVEC3F& outColor = bgColor[y];
+            const SFVEC4F& outColor = bgColor[y];
 
             const unsigned int yConst = blockPos.x + ( ( y + blockPos.y ) * m_realBufferSize.x );
 
@@ -692,7 +546,7 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
         return;
     }
 
-    SFVEC3F hitColor_X0Y0[RAYPACKET_RAYS_PER_PACKET];
+    SFVEC4F hitColor_X0Y0[RAYPACKET_RAYS_PER_PACKET];
 
     // Shade original (0, 0) hits ("paint" the intersected objects)
     renderRayPackets( bgColor, blockPacket.m_ray, hitPacket_X0Y0,
@@ -700,7 +554,7 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
 
     if( m_boardAdapter.m_Cfg->m_Render.raytrace_anti_aliasing )
     {
-        SFVEC3F hitColor_AA_X1Y1[RAYPACKET_RAYS_PER_PACKET];
+        SFVEC4F hitColor_AA_X1Y1[RAYPACKET_RAYS_PER_PACKET];
 
         // Intersect one blockPosI + (0.5, 0.5) used for anti aliasing calculation
         HITINFO_PACKET hitPacket_AA_X1Y1[RAYPACKET_RAYS_PER_PACKET];
@@ -714,7 +568,7 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
             // Missed all the package
             for( unsigned int y = 0, i = 0; y < RAYPACKET_DIM; ++y )
             {
-                const SFVEC3F& outColor = bgColor[y];
+                const SFVEC4F& outColor = bgColor[y];
 
                 for( unsigned int x = 0; x < RAYPACKET_DIM; ++x, ++i )
                     hitColor_AA_X1Y1[i] = outColor;
@@ -726,13 +580,13 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
                               m_boardAdapter.m_Cfg->m_Render.raytrace_shadows, hitColor_AA_X1Y1 );
         }
 
-        SFVEC3F hitColor_AA_X1Y0[RAYPACKET_RAYS_PER_PACKET];
-        SFVEC3F hitColor_AA_X0Y1[RAYPACKET_RAYS_PER_PACKET];
-        SFVEC3F hitColor_AA_X0Y1_half[RAYPACKET_RAYS_PER_PACKET];
+        SFVEC4F hitColor_AA_X1Y0[RAYPACKET_RAYS_PER_PACKET];
+        SFVEC4F hitColor_AA_X0Y1[RAYPACKET_RAYS_PER_PACKET];
+        SFVEC4F hitColor_AA_X0Y1_half[RAYPACKET_RAYS_PER_PACKET];
 
         for( unsigned int i = 0; i < RAYPACKET_RAYS_PER_PACKET; ++i )
         {
-            SFVEC3F color_average = ( hitColor_X0Y0[i] + hitColor_AA_X1Y1[i] ) * SFVEC3F( 0.5f );
+            SFVEC4F color_average = ( hitColor_X0Y0[i] + hitColor_AA_X1Y1[i] ) * SFVEC4F( 0.5f );
 
             hitColor_AA_X1Y0[i] = color_average;
             hitColor_AA_X0Y1[i] = color_average;
@@ -769,7 +623,7 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
         {
             hitColor_X0Y0[i] = ( hitColor_X0Y0[i] + hitColor_AA_X1Y1[i] + hitColor_AA_X1Y0[i] +
                                  hitColor_AA_X0Y1[i] + hitColor_AA_X0Y1_half[i] ) *
-                    SFVEC3F( 1.0f / 5.0f );
+                    SFVEC4F( 1.0f / 5.0f );
         }
     }
 
@@ -789,7 +643,7 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
 
             for( unsigned int x = 0; x < RAYPACKET_DIM; ++x, ++i )
             {
-                const SFVEC3F& hColor = hitColor_X0Y0[i];
+                const SFVEC4F& hColor = hitColor_X0Y0[i];
 
                 if( hitPacket_X0Y0[i].m_hitresult == true )
                 {
@@ -833,7 +687,7 @@ void RENDER_3D_RAYTRACE::renderBlockTracing( GLubyte* ptrPBO, signed int iBlock
 }
 
 
-void RENDER_3D_RAYTRACE::postProcessShading( GLubyte* /* ptrPBO */, REPORTER* aStatusReporter )
+void RENDER_3D_RAYTRACE_BASE::postProcessShading( GLubyte* /* ptrPBO */, REPORTER* aStatusReporter )
 {
     if( m_boardAdapter.m_Cfg->m_Render.raytrace_post_processing )
     {
@@ -885,7 +739,7 @@ void RENDER_3D_RAYTRACE::postProcessShading( GLubyte* /* ptrPBO */, REPORTER* aS
 }
 
 
-void RENDER_3D_RAYTRACE::postProcessBlurFinish( GLubyte* ptrPBO, REPORTER* /* aStatusReporter */ )
+void RENDER_3D_RAYTRACE_BASE::postProcessBlurFinish( GLubyte* ptrPBO, REPORTER* /* aStatusReporter */ )
 {
     if( m_boardAdapter.m_Cfg->m_Render.raytrace_post_processing )
     {
@@ -909,13 +763,13 @@ void RENDER_3D_RAYTRACE::postProcessBlurFinish( GLubyte* ptrPBO, REPORTER* /* aS
                         const SFVEC3F bluredShadeColor = m_postShaderSsao.Blur( SFVEC2I( x, y ) );
 
 #ifdef USE_SRGB_SPACE
-                        const SFVEC3F originColor = convertLinearToSRGB(
+                        const SFVEC4F originColor = convertLinearToSRGBA(
                                 m_postShaderSsao.GetColorAtNotProtected( SFVEC2I( x, y ) ) );
 #else
-                        const SFVEC3F originColor =
+                        const SFVEC4F originColor =
                                 m_postShaderSsao.GetColorAtNotProtected( SFVEC2I( x, y ) );
 #endif
-                        const SFVEC3F shadedColor = m_postShaderSsao.ApplyShadeColor(
+                        const SFVEC4F shadedColor = m_postShaderSsao.ApplyShadeColor(
                                 SFVEC2I( x, y ), originColor, bluredShadeColor );
 
                         renderFinalColor( ptr, shadedColor, false );
@@ -942,7 +796,7 @@ void RENDER_3D_RAYTRACE::postProcessBlurFinish( GLubyte* ptrPBO, REPORTER* /* aS
 }
 
 
-void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
+void RENDER_3D_RAYTRACE_BASE::renderPreview( GLubyte* ptrPBO )
 {
     m_isPreview = true;
 
@@ -980,45 +834,47 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                 m_accelerator->Intersect( blockPacket, hitPacket );
 
                 // Calculate background gradient color
-                SFVEC3F bgColor[RAYPACKET_DIM];
+                SFVEC4F bgColor[RAYPACKET_DIM];
+
+                SFVEC4F bgTopColor = premultiplyAlpha( m_boardAdapter.m_BgColorTop );
+                SFVEC4F bgBotColor = premultiplyAlpha( m_boardAdapter.m_BgColorBot );
 
                 for( unsigned int y = 0; y < RAYPACKET_DIM; ++y )
                 {
                     const float posYfactor =
                             (float) ( windowsPos.y + y * 4.0f ) / (float) m_windowSize.y;
 
-                    bgColor[y] = (SFVEC3F) m_boardAdapter.m_BgColorTop * SFVEC3F( posYfactor )
-                                 + (SFVEC3F) m_boardAdapter.m_BgColorBot
-                                           * ( SFVEC3F( 1.0f ) - SFVEC3F( posYfactor ) );
+                    bgColor[y] = bgTopColor * SFVEC4F( posYfactor )
+                                 + bgBotColor * ( SFVEC4F( 1.0f ) - SFVEC4F( posYfactor ) );
                 }
 
-                COLOR_RGB hitColorShading[RAYPACKET_RAYS_PER_PACKET];
+                COLOR_RGBA hitColorShading[RAYPACKET_RAYS_PER_PACKET];
 
                 for( unsigned int i = 0; i < RAYPACKET_RAYS_PER_PACKET; ++i )
                 {
-                    const SFVEC3F bhColorY = bgColor[i / RAYPACKET_DIM];
+                    const SFVEC4F bhColorY = bgColor[i / RAYPACKET_DIM];
 
                     if( hitPacket[i].m_hitresult == true )
                     {
-                        const SFVEC3F hitColor = shadeHit( bhColorY, blockPacket.m_ray[i],
+                        const SFVEC4F hitColor = shadeHit( bhColorY, blockPacket.m_ray[i],
                                                            hitPacket[i].m_HitInfo, false,
                                                            0, false );
 
-                        hitColorShading[i] = COLOR_RGB( hitColor );
+                        hitColorShading[i] = COLOR_RGBA( hitColor );
                     }
                     else
                         hitColorShading[i] = bhColorY;
                 }
 
-                COLOR_RGB cLRB_old[(RAYPACKET_DIM - 1)];
+                COLOR_RGBA cLRB_old[(RAYPACKET_DIM - 1)];
 
                 for( unsigned int y = 0; y < (RAYPACKET_DIM - 1); ++y )
                 {
-                    const SFVEC3F     bgColorY = bgColor[y];
-                    const COLOR_RGB   bgColorYRGB = COLOR_RGB( bgColorY );
+                    const SFVEC4F    bgColorY = bgColor[y];
+                    const COLOR_RGBA bgColorYRGB = COLOR_RGBA( bgColorY );
 
                     // This stores cRTB from the last block to be reused next time in a cLTB pixel
-                    COLOR_RGB cRTB_old;
+                    COLOR_RGBA cRTB_old;
 
                     //RAY       cRTB_ray;
                     //HITINFO   cRTB_hitInfo;
@@ -1041,13 +897,13 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                         const unsigned int iRB = ( ( x + 1 ) + RAYPACKET_DIM * ( y + 1 ) );
 
                         // !TODO: skip when there are no hits
-                        const COLOR_RGB& cLT = hitColorShading[ iLT ];
-                        const COLOR_RGB& cRT = hitColorShading[ iRT ];
-                        const COLOR_RGB& cLB = hitColorShading[ iLB ];
-                        const COLOR_RGB& cRB = hitColorShading[ iRB ];
+                        const COLOR_RGBA& cLT = hitColorShading[ iLT ];
+                        const COLOR_RGBA& cRT = hitColorShading[ iRT ];
+                        const COLOR_RGBA& cLB = hitColorShading[ iLB ];
+                        const COLOR_RGBA& cRB = hitColorShading[ iRB ];
 
                         // Trace and shade cC
-                        COLOR_RGB cC = bgColorYRGB;
+                        COLOR_RGBA cC = bgColorYRGB;
 
                         const SFVEC3F& oriLT = blockPacket.m_ray[ iLT ].m_Origin;
                         const SFVEC3F& oriRB = blockPacket.m_ray[ iRB ].m_Origin;
@@ -1099,7 +955,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
 
                             if( hittedC )
                             {
-                                cC = COLOR_RGB( shadeHit( bgColorY, centerRay, centerHitInfo,
+                                cC = COLOR_RGBA( shadeHit( bgColorY, centerRay, centerHitInfo,
                                                           false, 0, false ) );
                             }
                             else
@@ -1108,13 +964,13 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                 hittedC = m_accelerator->Intersect( centerRay, centerHitInfo );
 
                                 if( hittedC )
-                                    cC = COLOR_RGB( shadeHit( bgColorY, centerRay, centerHitInfo,
+                                    cC = COLOR_RGBA( shadeHit( bgColorY, centerRay, centerHitInfo,
                                                               false, 0, false ) );
                             }
                         }
 
                         // Trace and shade cLRT
-                        COLOR_RGB cLRT = bgColorYRGB;
+                        COLOR_RGBA cLRT = bgColorYRGB;
 
                         const SFVEC3F& oriRT = blockPacket.m_ray[ iRT ].m_Origin;
                         const SFVEC3F& dirRT = blockPacket.m_ray[ iRT ].m_Dir;
@@ -1140,7 +996,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                         glm::normalize( ( hitPacket[ iLT ].m_HitInfo.m_HitNormal +
                                                           hitPacket[ iRT ].m_HitInfo.m_HitNormal ) * 0.5f );
 
-                                cLRT = COLOR_RGB( shadeHit( bgColorY, rayLRT, hitInfoLRT, false,
+                                cLRT = COLOR_RGBA( shadeHit( bgColorY, rayLRT, hitInfoLRT, false,
                                                             0, false ) );
                                 cLRT = BlendColor( cLRT, BlendColor( cLT, cRT ) );
                             }
@@ -1165,14 +1021,14 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                                                                nodeRT );
 
                                     if( hittedLRT )
-                                        cLRT = COLOR_RGB( shadeHit( bgColorY, rayLRT, hitInfoLRT,
+                                        cLRT = COLOR_RGBA( shadeHit( bgColorY, rayLRT, hitInfoLRT,
                                                                     false, 0, false ) );
                                     else
                                     {
                                         hitInfoLRT.m_tHit = std::numeric_limits<float>::infinity();
 
                                         if( m_accelerator->Intersect( rayLRT,hitInfoLRT ) )
-                                            cLRT = COLOR_RGB( shadeHit( bgColorY, rayLRT,
+                                            cLRT = COLOR_RGBA( shadeHit( bgColorY, rayLRT,
                                                                         hitInfoLRT, false,
                                                                         0, false ) );
                                     }
@@ -1185,7 +1041,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                         }
 
                         // Trace and shade cLTB
-                        COLOR_RGB cLTB = bgColorYRGB;
+                        COLOR_RGBA cLTB = bgColorYRGB;
 
                         if( x == 0 )
                         {
@@ -1210,7 +1066,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                 hitInfoLTB.m_HitNormal =
                                         glm::normalize( ( hitPacket[ iLT ].m_HitInfo.m_HitNormal +
                                                           hitPacket[ iLB ].m_HitInfo.m_HitNormal ) * 0.5f );
-                                cLTB = COLOR_RGB( shadeHit( bgColorY, rayLTB, hitInfoLTB, false,
+                                cLTB = COLOR_RGBA( shadeHit( bgColorY, rayLTB, hitInfoLTB, false,
                                                             0, false ) );
                                 cLTB = BlendColor( cLTB, BlendColor( cLT, cLB) );
                             }
@@ -1235,14 +1091,14 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                                                                nodeLB );
 
                                     if( hittedLTB )
-                                        cLTB = COLOR_RGB( shadeHit( bgColorY, rayLTB, hitInfoLTB,
+                                        cLTB = COLOR_RGBA( shadeHit( bgColorY, rayLTB, hitInfoLTB,
                                                                     false, 0, false ) );
                                     else
                                     {
                                         hitInfoLTB.m_tHit = std::numeric_limits<float>::infinity();
 
                                         if( m_accelerator->Intersect( rayLTB, hitInfoLTB ) )
-                                            cLTB = COLOR_RGB( shadeHit( bgColorY, rayLTB,
+                                            cLTB = COLOR_RGBA( shadeHit( bgColorY, rayLTB,
                                                                         hitInfoLTB, false,
                                                                         0, false ) );
                                     }
@@ -1255,7 +1111,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                         }
 
                         // Trace and shade cRTB
-                        COLOR_RGB cRTB = bgColorYRGB;
+                        COLOR_RGBA cRTB = bgColorYRGB;
 
                         // Trace the center ray
                         RAY rayRTB;
@@ -1278,7 +1134,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                     glm::normalize( ( hitPacket[ iRT ].m_HitInfo.m_HitNormal +
                                                       hitPacket[ iRB ].m_HitInfo.m_HitNormal ) * 0.5f );
 
-                            cRTB = COLOR_RGB( shadeHit( bgColorY, rayRTB, hitInfoRTB, false, 0,
+                            cRTB = COLOR_RGBA( shadeHit( bgColorY, rayRTB, hitInfoRTB, false, 0,
                                                         false ) );
                             cRTB = BlendColor( cRTB, BlendColor( cRT, cRB ) );
                         }
@@ -1304,7 +1160,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
 
                                 if( hittedRTB )
                                 {
-                                    cRTB = COLOR_RGB( shadeHit( bgColorY, rayRTB, hitInfoRTB,
+                                    cRTB = COLOR_RGBA( shadeHit( bgColorY, rayRTB, hitInfoRTB,
                                                                 false, 0, false) );
                                 }
                                 else
@@ -1312,7 +1168,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                     hitInfoRTB.m_tHit = std::numeric_limits<float>::infinity();
 
                                     if( m_accelerator->Intersect( rayRTB, hitInfoRTB ) )
-                                        cRTB = COLOR_RGB( shadeHit( bgColorY, rayRTB, hitInfoRTB,
+                                        cRTB = COLOR_RGBA( shadeHit( bgColorY, rayRTB, hitInfoRTB,
                                                                     false, 0, false ) );
                                 }
                             }
@@ -1321,7 +1177,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                         cRTB_old = cRTB;
 
                         // Trace and shade cLRB
-                        COLOR_RGB cLRB = bgColorYRGB;
+                        COLOR_RGBA cLRB = bgColorYRGB;
 
                         const SFVEC3F& oriLB = blockPacket.m_ray[ iLB ].m_Origin;
                         const SFVEC3F& dirLB = blockPacket.m_ray[ iLB ].m_Dir;
@@ -1347,7 +1203,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                     glm::normalize( ( hitPacket[ iLB ].m_HitInfo.m_HitNormal +
                                                       hitPacket[ iRB ].m_HitInfo.m_HitNormal ) * 0.5f );
 
-                            cLRB = COLOR_RGB( shadeHit( bgColorY, rayLRB, hitInfoLRB, false, 0,
+                            cLRB = COLOR_RGBA( shadeHit( bgColorY, rayLRB, hitInfoLRB, false, 0,
                                                         false ) );
                             cLRB = BlendColor( cLRB, BlendColor( cLB, cRB ) );
                         }
@@ -1373,7 +1229,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
 
                                 if( hittedLRB )
                                 {
-                                    cLRB = COLOR_RGB( shadeHit( bgColorY, rayLRB, hitInfoLRB,
+                                    cLRB = COLOR_RGBA( shadeHit( bgColorY, rayLRB, hitInfoLRB,
                                                                 false, 0, false ) );
                                 }
                                 else
@@ -1381,7 +1237,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                     hitInfoLRB.m_tHit = std::numeric_limits<float>::infinity();
 
                                     if( m_accelerator->Intersect( rayLRB, hitInfoLRB ) )
-                                        cLRB = COLOR_RGB( shadeHit( bgColorY, rayLRB, hitInfoLRB,
+                                        cLRB = COLOR_RGBA( shadeHit( bgColorY, rayLRB, hitInfoLRB,
                                                                     false, 0, false ) );
                                 }
                             }
@@ -1390,7 +1246,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                         cLRB_old[x] = cLRB;
 
                         // Trace and shade cLTC
-                        COLOR_RGB cLTC = BlendColor( cLT , cC );
+                        COLOR_RGBA cLTC = BlendColor( cLT , cC );
 
                         if( hitPacket[ iLT ].m_hitresult || hittedC )
                         {
@@ -1412,12 +1268,12 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                         hitInfoLTC );
 
                             if( hitted )
-                                cLTC = COLOR_RGB( shadeHit( bgColorY, rayLTC, hitInfoLTC, false,
+                                cLTC = COLOR_RGBA( shadeHit( bgColorY, rayLTC, hitInfoLTC, false,
                                                             0, false ) );
                         }
 
                         // Trace and shade cRTC
-                        COLOR_RGB cRTC = BlendColor( cRT , cC );
+                        COLOR_RGBA cRTC = BlendColor( cRT , cC );
 
                         if( hitPacket[ iRT ].m_hitresult || hittedC )
                         {
@@ -1438,12 +1294,12 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                                                                            hitInfoRTC );
 
                             if( hitted )
-                                cRTC = COLOR_RGB( shadeHit( bgColorY, rayRTC, hitInfoRTC, false,
+                                cRTC = COLOR_RGBA( shadeHit( bgColorY, rayRTC, hitInfoRTC, false,
                                                             0, false ) );
                         }
 
                         // Trace and shade cLBC
-                        COLOR_RGB cLBC = BlendColor( cLB , cC );
+                        COLOR_RGBA cLBC = BlendColor( cLB , cC );
 
                         if( hitPacket[ iLB ].m_hitresult || hittedC )
                         {
@@ -1464,12 +1320,12 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                                                                            hitInfoLBC );
 
                             if( hitted )
-                                cLBC = COLOR_RGB( shadeHit( bgColorY, rayLBC, hitInfoLBC, false,
+                                cLBC = COLOR_RGBA( shadeHit( bgColorY, rayLBC, hitInfoLBC, false,
                                                             0, false ) );
                         }
 
                         // Trace and shade cRBC
-                        COLOR_RGB cRBC = BlendColor( cRB , cC );
+                        COLOR_RGBA cRBC = BlendColor( cRB , cC );
 
                         if( hitPacket[ iRB ].m_hitresult || hittedC )
                         {
@@ -1490,7 +1346,7 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
                                                                                            hitInfoRBC );
 
                             if( hitted )
-                                cRBC = COLOR_RGB( shadeHit( bgColorY, rayRBC, hitInfoRBC, false,
+                                cRBC = COLOR_RGBA( shadeHit( bgColorY, rayRBC, hitInfoRBC, false,
                                                             0, false ) );
                         }
 
@@ -1538,14 +1394,15 @@ void RENDER_3D_RAYTRACE::renderPreview( GLubyte* ptrPBO )
 
 #define USE_EXPERIMENTAL_SOFT_SHADOWS 1
 
-SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay, HITINFO& aHitInfo,
+SFVEC4F RENDER_3D_RAYTRACE_BASE::shadeHit( const SFVEC4F& aBgColor, const RAY& aRay, HITINFO& aHitInfo,
                                       bool aIsInsideObject, unsigned int aRecursiveLevel,
                                       bool is_testShadow ) const
 {
     const MATERIAL* objMaterial = aHitInfo.pHitObject->GetMaterial();
     wxASSERT( objMaterial != nullptr );
 
-    SFVEC3F outColor = objMaterial->GetEmissiveColor() + objMaterial->GetAmbientColor();
+    SFVEC4F outColor =
+            SFVEC4F( objMaterial->GetEmissiveColor() + objMaterial->GetAmbientColor(), 1.0f );
 
     if( aRecursiveLevel > 7 )
         return outColor;
@@ -1554,7 +1411,8 @@ SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay,
 
     hitPoint += aHitInfo.m_HitNormal * m_boardAdapter.GetNonCopperLayerThickness() * 0.6f;
 
-    const SFVEC3F diffuseColorObj = aHitInfo.pHitObject->GetDiffuseColor( aHitInfo );
+    const SFVEC4F diffuseColorObj =
+            SFVEC4F( aHitInfo.pHitObject->GetDiffuseColor( aHitInfo ), 1.0f );
 
 #if USE_EXPERIMENTAL_SOFT_SHADOWS
     bool is_aa_enabled = m_boardAdapter.m_Cfg->m_Render.raytrace_anti_aliasing && !m_isPreview;
@@ -1638,8 +1496,10 @@ SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay,
                 shadow_att_factor_sum += shadow_att_factor_light;
             }
 
-            outColor += objMaterial->Shade( aRay, aHitInfo, NdotL, diffuseColorObj, vectorToLight,
-                                            colorOfLight, shadow_att_factor_light );
+            outColor += SFVEC4F( objMaterial->Shade( aRay, aHitInfo, NdotL, diffuseColorObj,
+                                                     vectorToLight, colorOfLight,
+                                                     shadow_att_factor_light ),
+                                 1.0 );
         }
 
         // Only use the headlight for preview
@@ -1659,7 +1519,7 @@ SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay,
     }
 
     // Clamp color to not be brighter than 1.0f
-    outColor = glm::min( outColor, SFVEC3F( 1.0f ) );
+    outColor = glm::min( outColor, SFVEC4F( 1.0f ) );
 
     if( !m_isPreview )
     {
@@ -1671,7 +1531,7 @@ SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay,
             const unsigned int reflection_number_of_samples =
                     objMaterial->GetReflectionRayCount();
 
-            SFVEC3F sum_color = SFVEC3F( 0.0f );
+            SFVEC4F sum_color = SFVEC4F( 0.0f );
 
             const SFVEC3F reflectVector = aRay.m_Dir - 2.0f *
                     glm::dot( aRay.m_Dir, aHitInfo.m_HitNormal ) * aHitInfo.m_HitNormal;
@@ -1700,17 +1560,19 @@ SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay,
 
                 if( m_accelerator->Intersect( reflectedRay, reflectedHit ) )
                 {
-                    sum_color += ( diffuseColorObj + objMaterial->GetSpecularColor() ) *
+                    SFVEC4F add = ( diffuseColorObj + SFVEC4F( objMaterial->GetSpecularColor(), 1.0f ) ) *
                                  shadeHit( aBgColor, reflectedRay, reflectedHit, false,
                                            aRecursiveLevel + 1, is_testShadow ) *
-                                 SFVEC3F( objMaterial->GetReflection() *
+                                 SFVEC4F( objMaterial->GetReflection() *
                                           // Falloff factor
                                           (1.0f / ( 1.0f + 0.75f * reflectedHit.m_tHit *
                                                     reflectedHit.m_tHit) ) );
+
+                    sum_color += add;
                 }
             }
 
-            outColor += (sum_color / SFVEC3F( (float)reflection_number_of_samples) );
+            outColor += (sum_color / SFVEC4F( (float)reflection_number_of_samples) );
         }
 
         // Refraction
@@ -1739,7 +1601,7 @@ SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay,
                 const unsigned int refractions_number_of_samples =
                         objMaterial->GetRefractionRayCount();
 
-                SFVEC3F sum_color = SFVEC3F(0.0f);
+                SFVEC4F sum_color = SFVEC4F( 0.0f );
 
                 for( unsigned int i = 0; i < refractions_number_of_samples; ++i )
                 {
@@ -1763,19 +1625,19 @@ SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay,
                     HITINFO refractedHit;
                     refractedHit.m_tHit = std::numeric_limits<float>::infinity();
 
-                    SFVEC3F refractedColor = aBgColor;
+                    SFVEC4F refractedColor = aBgColor;
 
                     if( m_accelerator->Intersect( refractedRay, refractedHit ) )
                     {
                         refractedColor = shadeHit( aBgColor, refractedRay, refractedHit,
                                                    !aIsInsideObject, aRecursiveLevel + 1, false );
 
-                        const SFVEC3F absorbance = ( SFVEC3F(1.0f) - diffuseColorObj ) *
+                        const SFVEC4F absorbance = ( SFVEC4F(1.0f) - diffuseColorObj ) *
                                                    (1.0f - objTransparency ) *
                                                    objMaterial->GetAbsorvance() *
                                                    refractedHit.m_tHit;
 
-                        const SFVEC3F transparency = 1.0f / ( absorbance + 1.0f );
+                        const SFVEC4F transparency = 1.0f / ( absorbance + 1.0f );
 
                         sum_color += refractedColor * transparency;
                     }
@@ -1786,7 +1648,7 @@ SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay,
                 }
 
                 outColor = outColor * ( 1.0f - objTransparency ) + objTransparency * sum_color
-                         / SFVEC3F( (float) refractions_number_of_samples );
+                         / SFVEC4F( (float) refractions_number_of_samples );
             }
             else
             {
@@ -1799,49 +1661,6 @@ SFVEC3F RENDER_3D_RAYTRACE::shadeHit( const SFVEC3F& aBgColor, const RAY& aRay,
 }
 
 
-void RENDER_3D_RAYTRACE::initializeNewWindowSize()
-{
-    initPbo();
-}
-
-
-void RENDER_3D_RAYTRACE::initPbo()
-{
-    if( GLEW_ARB_pixel_buffer_object )
-    {
-        m_openglSupportsVertexBufferObjects = true;
-
-        // Try to delete vbo if it was already initialized
-        deletePbo();
-
-        // Learn about Pixel buffer objects at:
-        // http://www.songho.ca/opengl/gl_pbo.html
-        // http://web.eecs.umich.edu/~sugih/courses/eecs487/lectures/25-PBO+Mipmapping.pdf
-        // "create 2 pixel buffer objects, you need to delete them when program exits.
-        // glBufferDataARB with NULL pointer reserves only memory space."
-
-        // This sets the number of RGBA pixels
-        m_pboDataSize =  m_realBufferSize.x * m_realBufferSize.y * 4;
-
-        glGenBuffersARB( 1, &m_pboId );
-        glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, m_pboId );
-        glBufferDataARB( GL_PIXEL_UNPACK_BUFFER_ARB, m_pboDataSize, 0, GL_STREAM_DRAW_ARB );
-        glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, 0 );
-
-        wxLogTrace( m_logTrace,
-                    wxT( "RENDER_3D_RAYTRACE:: GLEW_ARB_pixel_buffer_object is supported" ) );
-    }
-}
-
-
-bool RENDER_3D_RAYTRACE::initializeOpenGL()
-{
-    m_is_opengl_initialized = true;
-
-    return true;
-}
-
-
 static float distance( const SFVEC2UI& a, const SFVEC2UI& b )
 {
     const float dx = (float) a.x - (float) b.x;
@@ -1850,7 +1669,7 @@ static float distance( const SFVEC2UI& a, const SFVEC2UI& b )
 }
 
 
-void RENDER_3D_RAYTRACE::initializeBlockPositions()
+void RENDER_3D_RAYTRACE_BASE::initializeBlockPositions()
 {
     m_realBufferSize = SFVEC2UI( 0 );
 
@@ -1933,7 +1752,7 @@ void RENDER_3D_RAYTRACE::initializeBlockPositions()
 }
 
 
-BOARD_ITEM* RENDER_3D_RAYTRACE::IntersectBoardItem( const RAY& aRay )
+BOARD_ITEM* RENDER_3D_RAYTRACE_BASE::IntersectBoardItem( const RAY& aRay )
 {
     HITINFO hitInfo;
     hitInfo.m_tHit = std::numeric_limits<float>::infinity();

3d-viewer/3d_rendering/raytracing/render_3d_raytrace_base.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2020 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2021 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -22,10 +22,9 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  */
 
-#ifndef RENDER_3D_RAYTRACE_H
-#define RENDER_3D_RAYTRACE_H
+#ifndef RENDER_3D_RAYTRACE_BASE_H
+#define RENDER_3D_RAYTRACE_BASE_H
 
-#include "../../common_ogl/openGL_includes.h"
 #include "accelerators/container_3d.h"
 #include "accelerators/accelerator_3d.h"
 #include "../render_3d_base.h"
@@ -52,19 +51,16 @@ typedef enum
 } RT_RENDER_STATE;
 
 
-class RENDER_3D_RAYTRACE : public RENDER_3D_BASE
+class RENDER_3D_RAYTRACE_BASE : public RENDER_3D_BASE
 {
 public:
     // TODO: Take into account board thickness so that the camera won't move inside of the board
     // when facing it perpendicularly.
     static constexpr float MIN_DISTANCE_IU = 4 * PCB_IU_PER_MM;
 
-    explicit RENDER_3D_RAYTRACE( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& aAdapter, CAMERA& aCamera );
+    explicit RENDER_3D_RAYTRACE_BASE( BOARD_ADAPTER& aAdapter, CAMERA& aCamera );
 
-    ~RENDER_3D_RAYTRACE();
-
-    void SetCurWindowSize( const wxSize& aSize ) override;
-    bool Redraw( bool aIsMoving, REPORTER* aStatusReporter, REPORTER* aWarningReporter ) override;
+    ~RENDER_3D_RAYTRACE_BASE();
 
     int GetWaitForEditingTimeOut() override;
 
@@ -73,11 +69,9 @@ public:
 
     BOARD_ITEM *IntersectBoardItem( const RAY& aRay );
 
-private:
-    bool initializeOpenGL();
-    void initializeNewWindowSize();
-    void initPbo();
-    void deletePbo();
+protected:
+    virtual void initPbo() = 0;
+    virtual void deletePbo() = 0;
     void createItemsFromContainer( const BVH_CONTAINER_2D* aContainer2d, PCB_LAYER_ID aLayer_id,
                                    const MATERIAL* aMaterialLayer, const SFVEC3F& aLayerColor,
                                    float aLayerZOffset );
@@ -87,20 +81,20 @@ private:
     void postProcessShading( GLubyte* ptrPBO, REPORTER* aStatusReporter );
     void postProcessBlurFinish( GLubyte* ptrPBO, REPORTER* aStatusReporter );
     void renderBlockTracing( GLubyte* ptrPBO , signed int iBlock );
-    void renderFinalColor( GLubyte* ptrPBO, const SFVEC3F& rgbColor,
+    void renderFinalColor( GLubyte* ptrPBO, const SFVEC4F& rgbColor,
                            bool applyColorSpaceConversion );
 
-    void renderRayPackets( const SFVEC3F* bgColorY, const RAY* aRayPkt, HITINFO_PACKET* aHitPacket,
-                           bool is_testShadow, SFVEC3F* aOutHitColor );
+    void renderRayPackets( const SFVEC4F* bgColorY, const RAY* aRayPkt, HITINFO_PACKET* aHitPacket,
+                           bool is_testShadow, SFVEC4F* aOutHitColor );
 
-    void renderAntiAliasPackets( const SFVEC3F* aBgColorY, const HITINFO_PACKET* aHitPck_X0Y0,
+    void renderAntiAliasPackets( const SFVEC4F* aBgColorY, const HITINFO_PACKET* aHitPck_X0Y0,
                                  const HITINFO_PACKET* aHitPck_AA_X1Y1, const RAY* aRayPck,
-                                 SFVEC3F* aOutHitColor );
+                                 SFVEC4F* aOutHitColor );
 
     // Materials
     void setupMaterials();
 
-    SFVEC3F shadeHit( const SFVEC3F& aBgColor, const RAY& aRay, HITINFO& aHitInfo,
+    SFVEC4F shadeHit( const SFVEC4F& aBgColor, const RAY& aRay, HITINFO& aHitInfo,
                       bool aIsInsideObject, unsigned int aRecursiveLevel,
                       bool is_testShadow ) const;
 
@@ -128,6 +122,8 @@ private:
     void render( GLubyte* ptrPBO, REPORTER* aStatusReporter );
     void renderPreview( GLubyte* ptrPBO );
 
+    static SFVEC4F premultiplyAlpha( const SFVEC4F& aInput );
+
     struct
     {
         BLINN_PHONG_MATERIAL m_Paste;
@@ -148,6 +144,7 @@ private:
     BRUSHED_METAL_NORMAL m_brushedMetalMaterial;
     SILK_SCREEN_NORMAL   m_silkScreenMaterial;
 
+    bool m_is_canvas_initialized;
     bool m_isPreview;
 
     /// State used on quality render
@@ -165,10 +162,8 @@ private:
 
     DIRECTIONAL_LIGHT* m_cameraLight;
 
-    bool m_openglSupportsVertexBufferObjects;
-
-    GLuint m_pboId;
-    GLuint m_pboDataSize;
+    /*GLuint m_pboId;
+    GLuint m_pboDataSize;*/
 
     CONTAINER_3D m_objectContainer;
 
@@ -180,8 +175,8 @@ private:
 
     ACCELERATOR_3D* m_accelerator;
 
-    SFVEC3F m_backgroundColorTop;
-    SFVEC3F m_backgroundColorBottom;
+    SFVEC4F m_backgroundColorTop;
+    SFVEC4F m_backgroundColorBottom;
 
     ///< Used to see if the windows size changed.
     wxSize m_oldWindowsSize;
@@ -218,8 +213,10 @@ private:
 
 #ifdef USE_SRGB_SPACE
 extern SFVEC3F ConvertSRGBToLinear( const SFVEC3F& aSRGBcolor );
+extern SFVEC4F ConvertSRGBAToLinear( const SFVEC4F& aSRGBAcolor );
 #else
 #define ConvertSRGBToLinear( v ) ( v )
+#define ConvertSRGBAToLinear( v ) ( v )
 #endif
 
-#endif // RENDER_3D_RAYTRACE_H
+#endif // RENDER_3D_RAYTRACE_BASE_H

3d-viewer/3d_rendering/raytracing/render_3d_raytrace_gl.cpp

@@ -0,0 +1,243 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2015-2020 Mario Luzeiro <mrluzeiro@ua.pt>
+ * Copyright (C) 2024 Alex Shvartzkop <dudesuchamazing@gmail.com>
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+#include <gal/opengl/kiglew.h>    // Must be included first
+
+#include <algorithm>
+#include <atomic>
+#include <chrono>
+#include <thread>
+
+#include "render_3d_raytrace_gl.h"
+#include "../common_ogl/ogl_utils.h"
+#include <core/profile.h>        // To use GetRunningMicroSecs or another profiling utility
+#include <wx/log.h>
+
+
+RENDER_3D_RAYTRACE_GL::RENDER_3D_RAYTRACE_GL( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& aAdapter, CAMERA& aCamera ) :
+    RENDER_3D_RAYTRACE_BASE( aAdapter, aCamera )
+{
+    wxLogTrace( m_logTrace, wxT( "RENDER_3D_RAYTRACE_GL::RENDER_3D_RAYTRACE_GL" ) );
+
+    m_openglSupportsVertexBufferObjects = false;
+    m_pboId       = GL_NONE;
+    m_pboDataSize = 0;
+}
+
+
+RENDER_3D_RAYTRACE_GL::~RENDER_3D_RAYTRACE_GL()
+{
+    deletePbo();
+}
+
+
+void RENDER_3D_RAYTRACE_GL::deletePbo()
+{
+    // Delete PBO if it was created
+    if( m_openglSupportsVertexBufferObjects )
+    {
+        if( glIsBufferARB( m_pboId ) )
+            glDeleteBuffers( 1, &m_pboId );
+
+        m_pboId = GL_NONE;
+    }
+}
+
+
+void RENDER_3D_RAYTRACE_GL::SetCurWindowSize( const wxSize& aSize )
+{
+    if( m_windowSize != aSize )
+    {
+        m_windowSize = aSize;
+        glViewport( 0, 0, m_windowSize.x, m_windowSize.y );
+
+        initPbo();
+    }
+}
+
+
+bool RENDER_3D_RAYTRACE_GL::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
+                                 REPORTER* aWarningReporter )
+{
+    bool requestRedraw = false;
+
+    // Initialize openGL if need
+    if( !m_canvasInitialized )
+    {
+        m_canvasInitialized = true;
+
+        //aIsMoving = true;
+        requestRedraw = true;
+
+        // It will assign the first time the windows size, so it will now
+        // revert to preview mode the first time the Redraw is called
+        m_oldWindowsSize = m_windowSize;
+        initializeBlockPositions();
+    }
+
+    std::unique_ptr<BUSY_INDICATOR> busy = CreateBusyIndicator();
+
+    // Reload board if it was requested
+    if( m_reloadRequested )
+    {
+        if( aStatusReporter )
+            aStatusReporter->Report( _( "Loading..." ) );
+
+        //aIsMoving = true;
+        requestRedraw = true;
+        Reload( aStatusReporter, aWarningReporter, false );
+    }
+
+
+    // Recalculate constants if windows size was changed
+    if( m_windowSize != m_oldWindowsSize )
+    {
+        m_oldWindowsSize = m_windowSize;
+        aIsMoving = true;
+        requestRedraw = true;
+
+        initializeBlockPositions();
+    }
+
+    // Clear buffers
+    glClearColor( 0.0f, 0.0f, 0.0f, 0.0f );
+    glClearDepth( 1.0f );
+    glClearStencil( 0x00 );
+    glClear( GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT );
+
+    // 4-byte pixel alignment
+    glPixelStorei( GL_UNPACK_ALIGNMENT, 4 );
+
+    glDisable( GL_STENCIL_TEST );
+    glDisable( GL_LIGHTING );
+    glDisable( GL_COLOR_MATERIAL );
+    glDisable( GL_DEPTH_TEST );
+    glDisable( GL_TEXTURE_2D );
+    glDisable( GL_BLEND );
+    glDisable( GL_MULTISAMPLE );
+
+    const bool was_camera_changed = m_camera.ParametersChanged();
+
+    if( requestRedraw || aIsMoving || was_camera_changed )
+        m_renderState = RT_RENDER_STATE_MAX; // Set to an invalid state,
+                                             // so it will restart again latter
+
+    // This will only render if need, otherwise it will redraw the PBO on the screen again
+    if( aIsMoving || was_camera_changed )
+    {
+        // Set head light (camera view light) with the opposite direction of the camera
+        if( m_cameraLight )
+            m_cameraLight->SetDirection( -m_camera.GetDir() );
+
+        OglDrawBackground( premultiplyAlpha( m_boardAdapter.m_BgColorTop ),
+                           premultiplyAlpha( m_boardAdapter.m_BgColorBot ) );
+
+        // Bind PBO
+        glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, m_pboId );
+
+        // Get the PBO pixel pointer to write the data
+        GLubyte* ptrPBO = (GLubyte *)glMapBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB,
+                                                     GL_WRITE_ONLY_ARB );
+
+        if( ptrPBO )
+        {
+            renderPreview( ptrPBO );
+
+            // release pointer to mapping buffer, this initialize the coping to PBO
+            glUnmapBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB );
+        }
+
+        glWindowPos2i( m_xoffset, m_yoffset );
+    }
+    else
+    {
+        // Bind PBO
+        glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, m_pboId );
+
+        if( m_renderState != RT_RENDER_STATE_FINISH )
+        {
+            // Get the PBO pixel pointer to write the data
+            GLubyte* ptrPBO = (GLubyte *)glMapBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB,
+                                                         GL_WRITE_ONLY_ARB );
+
+            if( ptrPBO )
+            {
+                render( ptrPBO, aStatusReporter );
+
+                if( m_renderState != RT_RENDER_STATE_FINISH )
+                    requestRedraw = true;
+
+                // release pointer to mapping buffer, this initialize the coping to PBO
+                glUnmapBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB );
+            }
+        }
+
+        if( m_renderState == RT_RENDER_STATE_FINISH )
+        {
+            glClear( GL_COLOR_BUFFER_BIT );
+        }
+
+        glWindowPos2i( m_xoffset, m_yoffset );
+    }
+
+    // This way it will blend the progress rendering with the last buffer. eg:
+    // if it was called after a openGL.
+    glEnable( GL_BLEND );
+    glBlendFunc( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA );
+    glEnable( GL_ALPHA_TEST );
+    glDrawPixels( m_realBufferSize.x, m_realBufferSize.y, GL_RGBA, GL_UNSIGNED_BYTE, 0 );
+    glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, 0 );
+
+    return requestRedraw;
+}
+
+
+void RENDER_3D_RAYTRACE_GL::initPbo()
+{
+    if( GLEW_ARB_pixel_buffer_object )
+    {
+        m_openglSupportsVertexBufferObjects = true;
+
+        // Try to delete vbo if it was already initialized
+        deletePbo();
+
+        // Learn about Pixel buffer objects at:
+        // http://www.songho.ca/opengl/gl_pbo.html
+        // http://web.eecs.umich.edu/~sugih/courses/eecs487/lectures/25-PBO+Mipmapping.pdf
+        // "create 2 pixel buffer objects, you need to delete them when program exits.
+        // glBufferDataARB with NULL pointer reserves only memory space."
+
+        // This sets the number of RGBA pixels
+        m_pboDataSize =  m_realBufferSize.x * m_realBufferSize.y * 4;
+
+        glGenBuffersARB( 1, &m_pboId );
+        glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, m_pboId );
+        glBufferDataARB( GL_PIXEL_UNPACK_BUFFER_ARB, m_pboDataSize, 0, GL_STREAM_DRAW_ARB );
+        glBindBufferARB( GL_PIXEL_UNPACK_BUFFER_ARB, 0 );
+
+        wxLogTrace( m_logTrace,
+                    wxT( "RENDER_3D_RAYTRACE_GL:: GLEW_ARB_pixel_buffer_object is supported" ) );
+    }
+}

3d-viewer/3d_rendering/raytracing/render_3d_raytrace_gl.h

@@ -0,0 +1,54 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2015-2020 Mario Luzeiro <mrluzeiro@ua.pt>
+ * Copyright (C) 2024 Alex Shvartzkop <dudesuchamazing@gmail.com>
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+#ifndef RENDER_3D_RAYTRACE_GL_H
+#define RENDER_3D_RAYTRACE_GL_H
+
+#include "../../common_ogl/openGL_includes.h"
+#include "render_3d_raytrace_base.h"
+
+
+class RENDER_3D_RAYTRACE_GL : public RENDER_3D_RAYTRACE_BASE
+{
+public:
+    explicit RENDER_3D_RAYTRACE_GL( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& aAdapter,
+                                    CAMERA& aCamera );
+
+    ~RENDER_3D_RAYTRACE_GL();
+
+    void SetCurWindowSize( const wxSize& aSize ) override;
+    bool Redraw( bool aIsMoving, REPORTER* aStatusReporter, REPORTER* aWarningReporter ) override;
+
+protected:
+    void initPbo() override;
+    void deletePbo() override;
+
+    bool   m_openglSupportsVertexBufferObjects;
+    GLuint m_pboId;
+    GLuint m_pboDataSize;
+};
+
+
+#endif // RENDER_3D_RAYTRACE_GL_H

3d-viewer/3d_rendering/raytracing/render_3d_raytrace_ram.cpp

@@ -0,0 +1,159 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2015-2020 Mario Luzeiro <mrluzeiro@ua.pt>
+ * Copyright (C) 2024 Alex Shvartzkop <dudesuchamazing@gmail.com>
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+#include "render_3d_raytrace_ram.h"
+#include <wx/log.h>
+
+
+RENDER_3D_RAYTRACE_RAM::RENDER_3D_RAYTRACE_RAM( BOARD_ADAPTER& aAdapter, CAMERA& aCamera ) :
+        RENDER_3D_RAYTRACE_BASE( aAdapter, aCamera ),
+    m_outputBuffer( nullptr ),
+    m_pboDataSize( 0 )
+{
+}
+
+
+RENDER_3D_RAYTRACE_RAM::~RENDER_3D_RAYTRACE_RAM()
+{
+    deletePbo();
+}
+
+
+GLubyte* RENDER_3D_RAYTRACE_RAM::GetBuffer()
+{
+    return m_outputBuffer;
+}
+
+
+wxSize RENDER_3D_RAYTRACE_RAM::GetRealBufferSize()
+{
+    return wxSize( m_realBufferSize.x, m_realBufferSize.y );
+}
+
+
+void RENDER_3D_RAYTRACE_RAM::deletePbo()
+{
+    delete[] m_outputBuffer;
+    m_outputBuffer = nullptr;
+}
+
+
+void RENDER_3D_RAYTRACE_RAM::SetCurWindowSize( const wxSize& aSize )
+{
+    if( m_windowSize != aSize )
+    {
+        m_windowSize = aSize;
+
+        initPbo();
+    }
+}
+
+
+bool RENDER_3D_RAYTRACE_RAM::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
+                                     REPORTER* aWarningReporter )
+{
+    bool requestRedraw = false;
+
+    // Initialize openGL if need
+    if( !m_canvasInitialized )
+    {
+        m_canvasInitialized = true;
+
+        //aIsMoving = true;
+        requestRedraw = true;
+
+        // It will assign the first time the windows size, so it will now
+        // revert to preview mode the first time the Redraw is called
+        m_oldWindowsSize = m_windowSize;
+        initializeBlockPositions();
+    }
+
+    std::unique_ptr<BUSY_INDICATOR> busy = CreateBusyIndicator();
+
+    // Reload board if it was requested
+    if( m_reloadRequested )
+    {
+        if( aStatusReporter )
+            aStatusReporter->Report( _( "Loading..." ) );
+
+        //aIsMoving = true;
+        requestRedraw = true;
+        Reload( aStatusReporter, aWarningReporter, false );
+    }
+
+
+    // Recalculate constants if windows size was changed
+    if( m_windowSize != m_oldWindowsSize )
+    {
+        m_oldWindowsSize = m_windowSize;
+        aIsMoving = true;
+        requestRedraw = true;
+
+        initializeBlockPositions();
+    }
+
+    const bool was_camera_changed = m_camera.ParametersChanged();
+
+    if( requestRedraw || aIsMoving || was_camera_changed )
+        m_renderState = RT_RENDER_STATE_MAX; // Set to an invalid state,
+                                             // so it will restart again latter
+
+    // This will only render if need, otherwise it will redraw the PBO on the screen again
+    if( aIsMoving || was_camera_changed )
+    {
+        // Set head light (camera view light) with the opposite direction of the camera
+        if( m_cameraLight )
+            m_cameraLight->SetDirection( -m_camera.GetDir() );
+
+        if( m_outputBuffer )
+        {
+            renderPreview( m_outputBuffer );
+        }
+    }
+    else
+    {
+        if( m_renderState != RT_RENDER_STATE_FINISH )
+        {
+            if( m_outputBuffer )
+            {
+                render( m_outputBuffer, aStatusReporter );
+
+                if( m_renderState != RT_RENDER_STATE_FINISH )
+                    requestRedraw = true;
+            }
+        }
+    }
+
+    return requestRedraw;
+}
+
+
+void RENDER_3D_RAYTRACE_RAM::initPbo()
+{
+    deletePbo();
+
+    m_pboDataSize = m_realBufferSize.x * m_realBufferSize.y * 4;
+    m_outputBuffer = new GLubyte[m_pboDataSize]();
+}

3d-viewer/3d_rendering/raytracing/render_3d_raytrace_ram.h

@@ -0,0 +1,58 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2015-2020 Mario Luzeiro <mrluzeiro@ua.pt>
+ * Copyright (C) 2024 Alex Shvartzkop <dudesuchamazing@gmail.com>
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+#ifndef RENDER_3D_RAYTRACE_RAM_H
+#define RENDER_3D_RAYTRACE_RAM_H
+
+#include "render_3d_raytrace_base.h"
+
+
+class RENDER_3D_RAYTRACE_RAM : public RENDER_3D_RAYTRACE_BASE
+{
+public:
+    // TODO: Take into account board thickness so that the camera won't move inside of the board
+    // when facing it perpendicularly.
+    static constexpr float MIN_DISTANCE_IU = 4 * PCB_IU_PER_MM;
+
+    explicit RENDER_3D_RAYTRACE_RAM( BOARD_ADAPTER& aAdapter, CAMERA& aCamera );
+
+    ~RENDER_3D_RAYTRACE_RAM();
+
+    GLubyte* GetBuffer();
+    wxSize   GetRealBufferSize();
+
+    void SetCurWindowSize( const wxSize& aSize ) override;
+    bool Redraw( bool aIsMoving, REPORTER* aStatusReporter, REPORTER* aWarningReporter ) override;
+
+private:
+    void initPbo() override;
+    void deletePbo() override;
+
+    GLubyte* m_outputBuffer;
+    GLuint   m_pboDataSize;
+};
+
+
+#endif // RENDER_3D_RAYTRACE_RAM_H

3d-viewer/3d_rendering/raytracing/shapes3D/bbox_3d.h

@@ -31,6 +31,7 @@
 #define _BBOX_3D_H_
 
 #include <plugins/3dapi/xv3d_types.h>   // SFVEC2F
+#include <glm/mat4x4.hpp>
 
 struct RAY;
 

3d-viewer/3d_rendering/render_3d_base.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -44,13 +44,12 @@
 const wxChar* RENDER_3D_BASE::m_logTrace = wxT( "KI_TRACE_3D_RENDER" );
 
 
-RENDER_3D_BASE::RENDER_3D_BASE( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& aBoardAdapter, CAMERA& aCamera ) :
+RENDER_3D_BASE::RENDER_3D_BASE( BOARD_ADAPTER& aBoardAdapter, CAMERA& aCamera ) :
         m_boardAdapter( aBoardAdapter ),
         m_camera( aCamera )
 {
     wxLogTrace( m_logTrace, wxT( "RENDER_3D_BASE::RENDER_3D_BASE" ) );
-    m_canvas                = aCanvas;
-    m_is_opengl_initialized = false;
+    m_canvasInitialized     = false;
     m_windowSize            = wxSize( -1, -1 );
     m_reloadRequested       = true;
 }

3d-viewer/3d_rendering/render_3d_base.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -42,7 +42,7 @@
 class RENDER_3D_BASE
 {
 public:
-    explicit RENDER_3D_BASE( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& aBoardAdapter, CAMERA& aCamera );
+    explicit RENDER_3D_BASE( BOARD_ADAPTER& aBoardAdapter, CAMERA& aCamera );
 
     virtual ~RENDER_3D_BASE() = 0;
 
@@ -98,16 +98,13 @@ protected:
      */
     std::unique_ptr<BUSY_INDICATOR> CreateBusyIndicator() const;
 
-    ///< the canvas to display the scene
-    EDA_3D_CANVAS* m_canvas;
-
     ///< Settings reference in use for this render.
     BOARD_ADAPTER& m_boardAdapter;
 
     CAMERA&        m_camera;
 
-    ///< Flag if the opengl specific for this render was already initialized.
-    bool m_is_opengl_initialized;
+    ///< Flag if the canvas specific for this render was already initialized.
+    bool m_canvasInitialized;
 
     ///< @todo This must be reviewed in order to flag change types.
     bool m_reloadRequested;

3d-viewer/3d_rendering/track_ball.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -38,11 +38,24 @@
 // stdlib
 #include <algorithm>
 
-TRACK_BALL::TRACK_BALL( float aInitialDistance ) :
-    CAMERA( aInitialDistance )
+
+TRACK_BALL::TRACK_BALL( float aInitialDistance ) : CAMERA( aInitialDistance )
 {
     wxLogTrace( m_logTrace, wxT( "TRACK_BALL::TRACK_BALL" ) );
+    initQuat();
+}
 
+
+TRACK_BALL::TRACK_BALL( SFVEC3F aInitPos, SFVEC3F aLookat, PROJECTION_TYPE aProjectionType ) :
+        CAMERA( aInitPos, aLookat, aProjectionType )
+{
+    wxLogTrace( m_logTrace, wxT( "TRACK_BALL::TRACK_BALL" ) );
+    initQuat();
+}
+
+
+void TRACK_BALL::initQuat()
+{
     memset( m_quat_t0, 0, sizeof( m_quat_t0 ) );
     memset( m_quat_t1, 0, sizeof( m_quat_t1 ) );
 
@@ -50,6 +63,7 @@ TRACK_BALL::TRACK_BALL( float aInitialDistance ) :
     trackball( m_quat_t1, 0.0, 0.0, 0.0, 0.0 );
 }
 
+
 void TRACK_BALL::Drag( const wxPoint& aNewMousePosition )
 {
     m_parametersChanged = true;

3d-viewer/3d_rendering/track_ball.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 2015-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2015-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -37,6 +37,7 @@ class TRACK_BALL : public CAMERA
 {
 public:
     explicit TRACK_BALL( float aInitialDistance );
+    explicit TRACK_BALL( SFVEC3F aInitPos, SFVEC3F aLookat, PROJECTION_TYPE aProjectionType );
 
     virtual ~TRACK_BALL()
     {
@@ -57,6 +58,8 @@ public:
     void Interpolate( float t ) override;
 
 private:
+    void initQuat();
+
     /**
      *  interpolate quaternions of the trackball
      */

3d-viewer/3d_viewer/3d_toolbar.cpp

@@ -5,7 +5,7 @@
  * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
  * Copyright (C) 2013 Wayne Stambaugh <stambaughw@gmail.com>
  * Copyright (C) 2023 CERN
- * Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -54,16 +54,17 @@ void EDA_3D_VIEWER_FRAME::ReCreateMainToolbar()
 
     // Set up toolbar
     m_mainToolBar->AddTool( ID_RELOAD3D_BOARD, wxEmptyString,
-                            KiScaledBitmap( BITMAPS::import3d, this ), _( "Reload board" ) );
+                            KiBitmapBundle( BITMAPS::import3d ),
+                            _( "Reload board" ) );
 
     m_mainToolBar->AddScaledSeparator( this );
     m_mainToolBar->AddTool( ID_TOOL_SCREENCOPY_TOCLIBBOARD, wxEmptyString,
-                            KiScaledBitmap( BITMAPS::copy, this ),
+                            KiBitmapBundle( BITMAPS::copy ),
                             _( "Copy 3D image to clipboard" ) );
 
     m_mainToolBar->AddScaledSeparator( this );
     m_mainToolBar->AddTool( ID_RENDER_CURRENT_VIEW, wxEmptyString,
-                            KiScaledBitmap( BITMAPS::render_mode, this ),
+                            KiBitmapBundle( BITMAPS::render_mode ),
                             _( "Render current view using Raytracing" ), wxITEM_CHECK );
 
     m_mainToolBar->AddScaledSeparator( this );

3d-viewer/3d_viewer/eda_3d_viewer_frame.cpp

@@ -38,6 +38,7 @@
 #include <3d_viewer/tools/eda_3d_actions.h>
 #include <3d_viewer/tools/eda_3d_controller.h>
 #include <3d_viewer/tools/eda_3d_conditions.h>
+#include <board.h>
 #include <advanced_config.h>
 #include <bitmaps.h>
 #include <board_design_settings.h>
@@ -116,8 +117,8 @@ EDA_3D_VIEWER_FRAME::EDA_3D_VIEWER_FRAME( KIWAY* aKiway, PCB_BASE_FRAME* aParent
     EDA_3D_VIEWER_SETTINGS* cfg = mgr.GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
     ANTIALIASING_MODE       aaMode = static_cast<ANTIALIASING_MODE>( cfg->m_Render.opengl_AA_mode );
 
-    m_canvas = new EDA_3D_CANVAS( this, OGL_ATT_LIST::GetAttributesList( aaMode ), m_boardAdapter,
-                                  m_currentCamera,
+    m_canvas = new EDA_3D_CANVAS( this, OGL_ATT_LIST::GetAttributesList( aaMode, true ),
+                                  m_boardAdapter, m_currentCamera,
                                   PROJECT_PCB::Get3DCacheManager( &Prj() ) );
 
     m_appearancePanel = new APPEARANCE_CONTROLS_3D( this, GetCanvas() );
@@ -570,9 +571,6 @@ void EDA_3D_VIEWER_FRAME::LoadSettings( APP_SETTINGS_BASE *aCfg )
     {
         applySettings( cfg );
 
-        if( !GetBoard()->GetProject() )
-            GetBoard()->SetProject( &Prj() );
-
         m_boardAdapter.SetBoard( GetBoard() );
 
         // When opening the 3D viewer, we use the OpenGL mode, never the ray tracing engine
@@ -661,8 +659,6 @@ void EDA_3D_VIEWER_FRAME::ShowChangedLanguage()
     {
         wxAuiPaneInfo& lm_pane_info = m_auimgr.GetPane( m_appearancePanel );
         lm_pane_info.Caption( _( "Appearance" ) );
-
-        m_appearancePanel->OnLanguageChanged();
     }
 
     SetStatusText( wxEmptyString, ACTIVITY );

3d-viewer/3d_viewer/eda_3d_viewer_settings.cpp

@@ -382,7 +382,7 @@ EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS() :
     m_params.emplace_back( new PARAM_LAYER_PRESET_3D( "layer_presets",
                                                       &m_LayerPresets ) );
     m_params.emplace_back( new PARAM<wxString>( "current_layer_preset",
-                                                &m_CurrentPreset, LEGACY_PRESET_FLAG ) );
+                                                &m_CurrentPreset, FOLLOW_PLOT_SETTINGS ) );
 
     registerMigration( 0, 1, std::bind( &EDA_3D_VIEWER_SETTINGS::migrateSchema0to1, this ) );
 

3d-viewer/3d_viewer/eda_3d_viewer_settings.h

@@ -3,7 +3,7 @@
  *
  * Copyright (C) 2020 Jon Evans <jon@craftyjon.com>
  * Copyright (C) 2023 CERN
- * Copyright (C) 2020-2023 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2020-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -23,7 +23,6 @@
 #define EDA_3D_VIEWER_SETTINGS_H_
 
 #include <3d_enums.h>
-#include <common_ogl/ogl_attr_list.h>
 #include <plugins/3dapi/xv3d_types.h>
 #include <settings/app_settings.h>
 #include <settings/parameters.h>
@@ -34,6 +33,8 @@
 #define FOLLOW_PLOT_SETTINGS wxT( "follow_plot_settings" )
 #define LEGACY_PRESET_FLAG   wxT( "legacy_preset_flag" )
 
+enum class ANTIALIASING_MODE;
+
 
 struct LAYER_PRESET_3D
 {

3d-viewer/CMakeLists.txt

@@ -45,7 +45,9 @@ set(3D-VIEWER_SRCS
     ${DIR_RAY_ACC}/container_2d.cpp
     ${DIR_RAY}/PerlinNoise.cpp
     ${DIR_RAY}/create_scene.cpp
-    ${DIR_RAY}/render_3d_raytrace.cpp
+    ${DIR_RAY}/render_3d_raytrace_base.cpp
+    ${DIR_RAY}/render_3d_raytrace_gl.cpp
+    ${DIR_RAY}/render_3d_raytrace_ram.cpp
     ${DIR_RAY}/frustum.cpp
     ${DIR_RAY}/material.cpp
     ${DIR_RAY}/mortoncodes.cpp
@@ -71,7 +73,7 @@ set(3D-VIEWER_SRCS
     ${DIR_RAY_3D}/triangle_3d.cpp
     3d_rendering/buffers_debug.cpp
     3d_rendering/render_3d_base.cpp
-    3d_rendering/color_rgb.cpp
+    3d_rendering/color_rgba.cpp
     3d_rendering/image.cpp
     3d_rendering/post_shader.cpp
     3d_rendering/post_shader_ssao.cpp

3d-viewer/common_ogl/ogl_attr_list.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -33,94 +33,45 @@
 #include <core/arraydim.h>
 
 
-const int OGL_ATT_LIST::m_openGL_attributes_list[] = {
-
-    // Boolean attributes (using itself at padding):
-
-    // 0                    1
-    WX_GL_RGBA,             WX_GL_RGBA,
-    // 2                    3
-    WX_GL_DOUBLEBUFFER,     WX_GL_DOUBLEBUFFER,
-
-
-    // Normal attributes with values:
-
-    // 4                    5
-    WX_GL_DEPTH_SIZE,       16,
-    // 6                    7
-    WX_GL_STENCIL_SIZE,     8,
-
-
-    // This ones need to be the last in the list (as the tags will set to 0 if AA fails)
-
-    // 8                    9
-    WX_GL_SAMPLES,          0,  // Disable AA for the start.
-    //10                    11
-    WX_GL_SAMPLE_BUFFERS,   1,  // Enable multisampling support (antialiasing).
-
-    0,                      0   // NULL termination
-};
-
-#define ATT_WX_GL_SAMPLES_OFFSET 8
-#define ATT_WX_GL_SAMPLES_OFFSET_DATA 9
-#define ATT_WX_GL_SAMPLE_BUFFERS_OFFSET 10
-#define ATT_WX_GL_SAMPLE_BUFFERS_DATA 11
-
-int OGL_ATT_LIST::m_openGL_attributes_list_to_use[
-                                        arrayDim( OGL_ATT_LIST::m_openGL_attributes_list ) ] = { 0 };
-
-
-const int* OGL_ATT_LIST::GetAttributesList( ANTIALIASING_MODE aAntiAliasingMode )
+const wxGLAttributes OGL_ATT_LIST::GetAttributesList( ANTIALIASING_MODE aAntiAliasingMode,
+                                                      bool              aAlpha )
 {
     wxASSERT( aAntiAliasingMode <= ANTIALIASING_MODE::AA_8X );
 
-    memcpy( m_openGL_attributes_list_to_use, m_openGL_attributes_list,
-            sizeof( m_openGL_attributes_list_to_use ) );
+    auto makeAttribs = [aAlpha]( int aSamplers )
+    {
+        wxGLAttributes dispAttrs;
+
+        dispAttrs.RGBA()
+                .DoubleBuffer()
+                .Depth( 16 )
+                .Stencil( 8 )
+                .Samplers( aSamplers )
+                .SampleBuffers( aSamplers >= 0 ? 1 : -1 )
+                .MinRGBA( 8, 8, 8, aAlpha ? 8 : -1 )
+                .EndList();
+
+        return dispAttrs;
+    };
+
+    int maxSamples = -1;
 
     if( aAntiAliasingMode > ANTIALIASING_MODE::AA_NONE )
     {
-        // There is a bug on wxGLCanvas that makes IsDisplaySupported fail
-        // while testing for antialiasing.
-        // http://trac.wxwidgets.org/ticket/16909
-        // this next code will only work after this bug is fixed
-        //
-        // On my experience (Mario) it was only working on Linux but failing on
-        // Windows, so there was no AA.
-
-
         // Check if the canvas supports multisampling.
-        if( wxGLCanvas::IsDisplaySupported( m_openGL_attributes_list_to_use ) )
+        if( wxGLCanvas::IsDisplaySupported( makeAttribs( 0 ) ) )
         {
-            static const int aaSamples[4] = {0, 2, 4, 8};
+            static const int aaSamples[4] = { 0, 2, 4, 8 };
 
             // Check for possible sample sizes, start form the requested.
-            int maxSamples = aaSamples[static_cast<int>( aAntiAliasingMode )];
+            maxSamples = aaSamples[static_cast<int>( aAntiAliasingMode )];
 
-            m_openGL_attributes_list_to_use[ATT_WX_GL_SAMPLES_OFFSET_DATA] = maxSamples;
-
-            for( ; (maxSamples > 0) &&
-                   ( !wxGLCanvas::IsDisplaySupported( m_openGL_attributes_list_to_use ) );
-                maxSamples = maxSamples >> 1 )
+            while( maxSamples > 0 && !wxGLCanvas::IsDisplaySupported( makeAttribs( maxSamples ) ) )
             {
-                m_openGL_attributes_list_to_use[ATT_WX_GL_SAMPLES_OFFSET_DATA] = maxSamples;
+                maxSamples = maxSamples >> 1;
             }
         }
-        else
-        {
-            aAntiAliasingMode = ANTIALIASING_MODE::AA_NONE;
-        }
     }
 
-    // Disable antialiasing if it failed or was not requested
-    if( aAntiAliasingMode == ANTIALIASING_MODE::AA_NONE )
-    {
-        // Remove multisampling information
-        // (hoping that the GPU driver will decide what is best)
-        m_openGL_attributes_list_to_use[ATT_WX_GL_SAMPLES_OFFSET]        = 0;
-        m_openGL_attributes_list_to_use[ATT_WX_GL_SAMPLES_OFFSET_DATA]   = 0;
-        m_openGL_attributes_list_to_use[ATT_WX_GL_SAMPLE_BUFFERS_OFFSET] = 0;
-        m_openGL_attributes_list_to_use[ATT_WX_GL_SAMPLE_BUFFERS_DATA]   = 0;
-    }
-
-    return m_openGL_attributes_list_to_use;
+    return makeAttribs( maxSamples );
 }

3d-viewer/common_ogl/ogl_attr_list.h

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
- * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -30,6 +30,8 @@
 #ifndef _OGL_ATT_LIST_H
 #define _OGL_ATT_LIST_H
 
+#include <wx/glcanvas.h>
+
 /// Anti-aliasing options
 enum class ANTIALIASING_MODE
 {
@@ -51,29 +53,12 @@ public:
      *  Get a list of attributes to pass to wxGLCanvas.
      *
      *  @param aAntiAliasingMode = 0 - disabled; try to initialize (if is supported) the
-     *  list with anti aliasing capabilities
-     *  @return a list of options to be passed in the creation of a EDA_3D_CANVAS class
+     *  list with anti aliasing capabilities.
+     *  @param aAlpha set to enable alpha channel.
+     *  @return wxGLAttributes to be passed in the creation of a EDA_3D_CANVAS class
      */
-    static const int* GetAttributesList( ANTIALIASING_MODE aAntiAliasingMode );
-
-private:
-    /**
-     *  Attributes list to be passed to a wxGLCanvas creation.
-     *
-     *  This array should be 2*n+1
-     *  Sadly wxwidgets / glx < 13 allowed
-     *  a thing named "boolean attributes" that don't take a value.
-     *  (See src/unix/glx11.cpp -> wxGLCanvasX11::ConvertWXAttrsToGL() ).
-     *  To avoid problems due to this, just specify those attributes twice.
-     *  Only WX_GL_RGBA, WX_GL_DOUBLEBUFFER, WX_GL_STEREO are such boolean
-     *  attributes.
-     */
-    static const int m_openGL_attributes_list[];
-
-    /**
-     * Attributes list that was (eventually) changed and are passed to creation.
-     */
-    static int m_openGL_attributes_list_to_use[];
+    static const wxGLAttributes GetAttributesList( ANTIALIASING_MODE aAntiAliasingMode,
+                                                   bool              aAlpha = false );
 };
 
 #endif // _OGL_ATT_LIST_H

3d-viewer/common_ogl/ogl_utils.cpp

@@ -46,7 +46,7 @@ void OglGetScreenshot( wxImage& aDstImage )
 
     glGetIntegerv( GL_VIEWPORT, (GLint*) &viewport );
 
-    unsigned char* pixelbuffer = (unsigned char*) malloc( viewport.x * viewport.y * 3 );
+    unsigned char* pixelbuffer = (unsigned char*) malloc( viewport.x * viewport.y * 4 );
 
     // Call glFinish before screenshot to ensure everything is fully drawn.
     glFinish();
@@ -54,15 +54,40 @@ void OglGetScreenshot( wxImage& aDstImage )
     glPixelStorei( GL_PACK_ALIGNMENT, 1 );
     glReadBuffer( GL_BACK_LEFT );
 
-    glReadPixels( viewport.originX, viewport.originY, viewport.x, viewport.y, GL_RGB,
+    glReadPixels( viewport.originX, viewport.originY, viewport.x, viewport.y, GL_RGBA,
                   GL_UNSIGNED_BYTE, pixelbuffer );
 
+    unsigned char* rgbBuffer = (unsigned char*) malloc( viewport.x * viewport.y * 3 );
+    unsigned char* alphaBuffer = (unsigned char*) malloc( viewport.x * viewport.y );
+
+    unsigned char* rgbaPtr = pixelbuffer;
+    unsigned char* rgbPtr = rgbBuffer;
+    unsigned char* alphaPtr = alphaBuffer;
+
+    for( int y = 0; y < viewport.y; y++ )
+    {
+        for( int x = 0; x < viewport.x; x++ )
+        {
+            rgbPtr[0] = rgbaPtr[0];
+            rgbPtr[1] = rgbaPtr[1];
+            rgbPtr[2] = rgbaPtr[2];
+            alphaPtr[0] = rgbaPtr[3];
+
+            rgbaPtr += 4;
+            rgbPtr += 3;
+            alphaPtr += 1;
+        }
+    }
+
     // "Sets the image data without performing checks.
     //  The data given must have the size (width*height*3)
     //  The data must have been allocated with malloc()
     //  If static_data is false, after this call the pointer to the data is owned
     //  by the wxImage object, that will be responsible for deleting it."
-    aDstImage.SetData( pixelbuffer, viewport.x, viewport.y, false );
+    aDstImage.SetData( rgbBuffer, viewport.x, viewport.y, false );
+    aDstImage.SetAlpha( alphaBuffer, false );
+
+    free( pixelbuffer );
 
     aDstImage = aDstImage.Mirror( false );
 }
@@ -157,7 +182,7 @@ void OglSetDiffuseMaterial( const SFVEC3F &aMaterialDiffuse, float aOpacity,
 }
 
 
-void OglDrawBackground( const SFVEC3F& aTopColor, const SFVEC3F& aBotColor )
+void OglDrawBackground( const SFVEC4F& aTopColor, const SFVEC4F& aBotColor )
 {
     glMatrixMode( GL_PROJECTION );
     glLoadIdentity();
@@ -173,14 +198,14 @@ void OglDrawBackground( const SFVEC3F& aTopColor, const SFVEC3F& aBotColor )
     glDisable( GL_ALPHA_TEST );
 
     glBegin( GL_QUADS );
-    glColor4f( aTopColor.x, aTopColor.y, aTopColor.z, 1.0f );
+    glColor4f( aTopColor.r, aTopColor.g, aTopColor.b, aTopColor.a );
     glVertex2f( -1.0, 1.0 );    // Top left corner
 
-    glColor4f( aBotColor.x, aBotColor.y, aBotColor.z, 1.0f );
+    glColor4f( aBotColor.r, aBotColor.g, aBotColor.b, aBotColor.a );
     glVertex2f( -1.0,-1.0 );    // bottom left corner
     glVertex2f( 1.0,-1.0 );     // bottom right corner
 
-    glColor4f( aTopColor.x, aTopColor.y, aTopColor.z, 1.0f );
+    glColor4f( aTopColor.r, aTopColor.g, aTopColor.b, aTopColor.a);
     glVertex2f( 1.0, 1.0 );     // top right corner
     glEnd();
 }

3d-viewer/common_ogl/ogl_utils.h

@@ -71,7 +71,7 @@ GLuint OglLoadTexture( const IMAGE& aImage );
  */
 void OglGetScreenshot( wxImage& aDstImage );
 
-void OglDrawBackground( const SFVEC3F& aTopColor, const SFVEC3F& aBotColor );
+void OglDrawBackground( const SFVEC4F& aTopColor, const SFVEC4F& aBotColor );
 
 /**
  * Reset to default state the texture settings.

3d-viewer/dialogs/appearance_controls_3D.cpp

@@ -100,7 +100,6 @@ APPEARANCE_CONTROLS_3D::APPEARANCE_CONTROLS_3D( EDA_3D_VIEWER_FRAME* aParent,
 {
     DPI_SCALING_COMMON dpi( nullptr, m_frame );
 
-    int indicatorSize = ConvertDialogToPixels( wxSize( 6, 6 ) ).x / dpi.GetContentScaleFactor();
     int screenHeight  = wxSystemSettings::GetMetric( wxSYS_SCREEN_Y );
     m_pointSize       = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT ).GetPointSize();
 
@@ -153,18 +152,21 @@ APPEARANCE_CONTROLS_3D::APPEARANCE_CONTROLS_3D( EDA_3D_VIEWER_FRAME* aParent,
                                                  KeyNameFromKeyCode( VIEWPORT_SWITCH_KEY ),
                                                  KeyNameFromKeyCode( VIEWPORT_SWITCH_KEY ) ) );
 
-    if( screenHeight <= 900 && m_pointSize >= indicatorSize )
+    if( screenHeight <= 900 && m_pointSize >= FromDIP( KIUI::c_IndicatorSizeDIP ) )
         m_pointSize = m_pointSize * 8 / 10;
 
     m_cbLayerPresets->Bind( wxEVT_CHOICE, &APPEARANCE_CONTROLS_3D::onLayerPresetChanged, this );
 
-    m_toggleGridRenderer = new GRID_BITMAP_TOGGLE_RENDERER( KiBitmap( BITMAPS::visibility ),
-                                                            KiBitmap( BITMAPS::visibility_off ) );
+    m_toggleGridRenderer = new GRID_BITMAP_TOGGLE_RENDERER(
+            KiBitmapBundle( BITMAPS::visibility ), KiBitmapBundle( BITMAPS::visibility_off ) );
+
+    m_frame->Bind( EDA_LANG_CHANGED, &APPEARANCE_CONTROLS_3D::OnLanguageChanged, this );
 }
 
 
 APPEARANCE_CONTROLS_3D::~APPEARANCE_CONTROLS_3D()
 {
+    m_frame->Unbind( EDA_LANG_CHANGED, &APPEARANCE_CONTROLS_3D::OnLanguageChanged, this );
 }
 
 
@@ -199,7 +201,7 @@ void APPEARANCE_CONTROLS_3D::OnSize( wxSizeEvent& aEvent )
 }
 
 
-void APPEARANCE_CONTROLS_3D::OnLanguageChanged()
+void APPEARANCE_CONTROLS_3D::rebuildControls()
 {
     Freeze();
 
@@ -213,6 +215,14 @@ void APPEARANCE_CONTROLS_3D::OnLanguageChanged()
 }
 
 
+void APPEARANCE_CONTROLS_3D::OnLanguageChanged( wxCommandEvent& aEvent )
+{
+    rebuildControls();
+
+    aEvent.Skip();
+}
+
+
 void APPEARANCE_CONTROLS_3D::OnDarkModeToggle()
 {
     // This is essentially a list of hacks because DarkMode isn't yet implemented inside
@@ -236,7 +246,7 @@ void APPEARANCE_CONTROLS_3D::OnDarkModeToggle()
 
 void APPEARANCE_CONTROLS_3D::CommonSettingsChanged()
 {
-    OnLanguageChanged();
+    rebuildControls();
 
     UpdateLayerCtls();
     syncLayerPresetSelection();
@@ -510,10 +520,9 @@ void APPEARANCE_CONTROLS_3D::rebuildLayers()
                 }
                 else
                 {
-                    BITMAP_TOGGLE* btn_visible = new BITMAP_TOGGLE( m_windowLayers, layer,
-                                                                    KiBitmap( BITMAPS::visibility ),
-                                                                    KiBitmap( BITMAPS::visibility_off ),
-                                                                    aSetting->m_Visible );
+                    BITMAP_TOGGLE* btn_visible = new BITMAP_TOGGLE(
+                            m_windowLayers, layer, KiBitmapBundle( BITMAPS::visibility ),
+                            KiBitmapBundle( BITMAPS::visibility_off ), aSetting->m_Visible );
 
                     btn_visible->Bind( TOGGLE_CHANGED,
                             [this]( wxCommandEvent& aEvent )

3d-viewer/dialogs/appearance_controls_3D.h

@@ -114,8 +114,6 @@ public:
     ~APPEARANCE_CONTROLS_3D();
 
     wxSize GetBestSize() const;
-
-    void OnLanguageChanged();
     void OnDarkModeToggle();
     void OnLayerVisibilityChanged( int aLayer, bool isVisible );
 
@@ -140,8 +138,11 @@ public:
 protected:
     void OnSetFocus( wxFocusEvent& aEvent ) override;
     void OnSize( wxSizeEvent& aEvent ) override;
+    void OnLanguageChanged( wxCommandEvent& aEvent );
 
 private:
+    void rebuildControls();
+
     void rebuildLayers();
 
     void rebuildLayerPresetsWidget();

3d-viewer/dialogs/panel_preview_3d_model.cpp

@@ -41,11 +41,10 @@
 #include <settings/common_settings.h>
 #include <settings/settings_manager.h>
 #include <widgets/wx_infobar.h>
+#include <widgets/std_bitmap_button.h>
 #include <eda_3d_viewer_settings.h>
 #include <board_design_settings.h>
 
-#include <3d_navlib/nl_footprint_properties_plugin.h>
-
 PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL( wxWindow* aParent, PCB_BASE_FRAME* aFrame,
                                                 FOOTPRINT* aFootprint,
                                                 std::vector<FP_3DMODEL>* aParentModelList ) :
@@ -125,10 +124,8 @@ PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL( wxWindow* aParent, PCB_BASE_FRAM
     // Create the 3D canvas
     m_previewPane = new EDA_3D_CANVAS( this,
                                        OGL_ATT_LIST::GetAttributesList( ANTIALIASING_MODE::AA_8X ),
-                                       m_boardAdapter, m_currentCamera, PROJECT_PCB::Get3DCacheManager( &aFrame->Prj() ) );
-
-    m_spaceMouse = new NL_FOOTPRINT_PROPERTIES_PLUGIN( m_previewPane );
-    m_spaceMouse->SetFocus( true );
+                                       m_boardAdapter, m_currentCamera,
+                                       PROJECT_PCB::Get3DCacheManager( &aFrame->Prj() ) );
 
     m_boardAdapter.SetBoard( m_dummyBoard );
     m_boardAdapter.m_IsBoardView = false;
@@ -166,28 +163,6 @@ PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL( wxWindow* aParent, PCB_BASE_FRAM
     aFrame->Connect( EDA_EVT_UNITS_CHANGED,
                      wxCommandEventHandler( PANEL_PREVIEW_3D_MODEL::onUnitsChanged ),
                      nullptr, this );
-
-    Bind( wxCUSTOM_PANEL_SHOWN_EVENT, &PANEL_PREVIEW_3D_MODEL::onPanelShownEvent, this );
-
-#ifdef __WXOSX__
-    // Call layout once to get the proper button sizes after the bitmaps have been set
-    Layout();
-
-    // The rounded-button style used has a small border on the left/right sides.
-    // This is automatically fixed in wx for buttons with a bitmap < 20, but not
-    // when the bitmap is set to be 26x26.
-    wxSize borderFix = wxSize( 4, 4 );
-
-    m_bpvTop->SetMinSize( m_bpvTop->GetSize() + borderFix );
-    m_bpvFront->SetMinSize( m_bpvFront->GetSize() + borderFix );
-    m_bpvBack->SetMinSize( m_bpvBack->GetSize() + borderFix );
-    m_bpvLeft->SetMinSize( m_bpvLeft->GetSize() + borderFix );
-    m_bpvRight->SetMinSize( m_bpvRight->GetSize() + borderFix );
-    m_bpvBottom->SetMinSize( m_bpvBottom->GetSize() + borderFix );
-    m_bpvISO->SetMinSize( m_bpvISO->GetSize() + borderFix );
-    m_bpUpdate->SetMinSize( m_bpUpdate->GetSize() + borderFix );
-    m_bpSettings->SetMinSize( m_bpSettings->GetSize() + borderFix );
-#endif
 }
 
 
@@ -197,7 +172,6 @@ PANEL_PREVIEW_3D_MODEL::~PANEL_PREVIEW_3D_MODEL()
     if( m_boardAdapter.m_Cfg )
         m_boardAdapter.m_Cfg->m_Render = m_initialRender;
 
-    delete m_spaceMouse;
     delete m_dummyBoard;
     delete m_previewPane;
 }
@@ -279,6 +253,10 @@ wxString PANEL_PREVIEW_3D_MODEL::formatScaleValue( double aValue )
 
 wxString PANEL_PREVIEW_3D_MODEL::formatRotationValue( double aValue )
 {
+    // Sigh.  Did we really need differentiated +/- 0.0?
+    if( aValue == -0.0 )
+        aValue = 0.0;
+
     return wxString::Format( wxT( "%.2f%s" ),
                              aValue,
                              EDA_UNIT_UTILS::GetText( EDA_UNITS::DEGREES ) );
@@ -312,9 +290,11 @@ void PANEL_PREVIEW_3D_MODEL::SetSelectedModel( int idx )
         yscale->ChangeValue( formatScaleValue( modelInfo.m_Scale.y ) );
         zscale->ChangeValue( formatScaleValue( modelInfo.m_Scale.z ) );
 
-        xrot->ChangeValue( formatRotationValue( modelInfo.m_Rotation.x ) );
-        yrot->ChangeValue( formatRotationValue( modelInfo.m_Rotation.y ) );
-        zrot->ChangeValue( formatRotationValue( modelInfo.m_Rotation.z ) );
+        // Rotation is stored in the file as postive-is-CW, but we use postive-is-CCW in the GUI
+        // to match the rest of KiCad
+        xrot->ChangeValue( formatRotationValue( -modelInfo.m_Rotation.x ) );
+        yrot->ChangeValue( formatRotationValue( -modelInfo.m_Rotation.y ) );
+        zrot->ChangeValue( formatRotationValue( -modelInfo.m_Rotation.z ) );
 
         xoff->ChangeValue( formatOffsetValue( modelInfo.m_Offset.x ) );
         yoff->ChangeValue( formatOffsetValue( modelInfo.m_Offset.y ) );
@@ -357,9 +337,11 @@ void PANEL_PREVIEW_3D_MODEL::updateOrientation( wxCommandEvent &event )
         modelInfo->m_Scale.z = EDA_UNIT_UTILS::UI::DoubleValueFromString(
                 pcbIUScale, EDA_UNITS::UNSCALED, zscale->GetValue() );
 
-        modelInfo->m_Rotation.x = rotationFromString( xrot->GetValue() );
-        modelInfo->m_Rotation.y = rotationFromString( yrot->GetValue() );
-        modelInfo->m_Rotation.z = rotationFromString( zrot->GetValue() );
+        // Rotation is stored in the file as postive-is-CW, but we use postive-is-CCW in the GUI
+        // to match the rest of KiCad
+        modelInfo->m_Rotation.x = -rotationFromString( xrot->GetValue() );
+        modelInfo->m_Rotation.y = -rotationFromString( yrot->GetValue() );
+        modelInfo->m_Rotation.z = -rotationFromString( zrot->GetValue() );
 
         modelInfo->m_Offset.x = EDA_UNIT_UTILS::UI::DoubleValueFromString( pcbIUScale, m_userUnits,
                                                                            xoff->GetValue() )
@@ -628,17 +610,6 @@ void PANEL_PREVIEW_3D_MODEL::onUnitsChanged( wxCommandEvent& aEvent )
 }
 
 
-void PANEL_PREVIEW_3D_MODEL::onPanelShownEvent( wxCommandEvent& aEvent )
-{
-    if( m_spaceMouse != nullptr )
-    {
-        m_spaceMouse->SetFocus( static_cast<bool>( aEvent.GetInt() ) );
-    }
-
-    aEvent.Skip();
-}
-
-
 void PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint( bool aReloadRequired )
 {
     m_dummyFootprint->Models().clear();

3d-viewer/dialogs/panel_preview_3d_model.h

@@ -34,7 +34,6 @@
 #include <3d_canvas/eda_3d_canvas.h>
 #include <3d_viewer_id.h>
 #include <3d_rendering/track_ball.h>
-#include <wx/event.h>
 
 // Define min and max parameter values
 #define MAX_SCALE          10000.0
@@ -53,7 +52,6 @@
 #define OFFSET_INCREMENT_MIL       25.0
 #define OFFSET_INCREMENT_MIL_FINE  5.0
 
-wxDECLARE_EVENT( wxCUSTOM_PANEL_SHOWN_EVENT, wxCommandEvent );
 
 // Declared classes to create pointers
 class WX_INFOBAR;
@@ -62,7 +60,6 @@ class FILENAME_RESOLVER;
 class BOARD;
 class BOARD_ADAPTER;
 class FOOTPRINT;
-class NL_FOOTPRINT_PROPERTIES_PLUGIN;
 
 class PANEL_PREVIEW_3D_MODEL: public EDA_3D_BOARD_HOLDER, public TOOLS_HOLDER, public PANEL_PREVIEW_3D_MODEL_BASE
 {
@@ -142,7 +139,6 @@ private:
     void doIncrementOffset( wxSpinEvent& aEvent, double aSign );
 
     void onUnitsChanged( wxCommandEvent& aEvent );
-    void onPanelShownEvent( wxCommandEvent& aEvent );
 
     wxString formatScaleValue( double aValue );
     wxString formatRotationValue( double aValue );
@@ -215,8 +211,6 @@ private:
     bool                     m_bodyStyleShowAll;    /// true if the board body is show
     /// The 3d viewer Render initial settings (must be saved and restored)
     EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS m_initialRender;
-
-    NL_FOOTPRINT_PROPERTIES_PLUGIN*     m_spaceMouse;
 };
 
 #endif  // PANEL_PREVIEW_3D_MODEL_H

3d-viewer/dialogs/panel_preview_3d_model_base.cpp

@@ -1,10 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-282-g1fa54006)
+// C++ code generated with wxFormBuilder (version 4.0.0-0-g0efcecf)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!
 ///////////////////////////////////////////////////////////////////////////
 
+#include "widgets/std_bitmap_button.h"
+
 #include "panel_preview_3d_model_base.h"
 
 ///////////////////////////////////////////////////////////////////////////
@@ -21,7 +23,7 @@ PANEL_PREVIEW_3D_MODEL_BASE::PANEL_PREVIEW_3D_MODEL_BASE( wxWindow* parent, wxWi
 	sbSizerScale = new wxStaticBoxSizer( new wxStaticBox( this, wxID_ANY, _("Scale") ), wxVERTICAL );
 
 	wxFlexGridSizer* fgSizerScale;
-	fgSizerScale = new wxFlexGridSizer( 0, 3, 2, 3 );
+	fgSizerScale = new wxFlexGridSizer( 0, 3, 1, 3 );
 	fgSizerScale->AddGrowableCol( 1 );
 	fgSizerScale->SetFlexibleDirection( wxBOTH );
 	fgSizerScale->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
@@ -57,16 +59,16 @@ PANEL_PREVIEW_3D_MODEL_BASE::PANEL_PREVIEW_3D_MODEL_BASE( wxWindow* parent, wxWi
 	fgSizerScale->Add( m_spinZscale, 0, wxALIGN_CENTER_VERTICAL, 5 );
 
 
-	sbSizerScale->Add( fgSizerScale, 0, wxBOTTOM|wxEXPAND|wxRIGHT, 5 );
+	sbSizerScale->Add( fgSizerScale, 0, wxBOTTOM|wxEXPAND|wxRIGHT, 2 );
 
 
-	bSizerLeft->Add( sbSizerScale, 0, wxLEFT|wxRIGHT|wxEXPAND, 5 );
+	bSizerLeft->Add( sbSizerScale, 0, wxEXPAND|wxTOP|wxRIGHT|wxLEFT, 5 );
 
 	wxStaticBoxSizer* sbSizerRotation;
 	sbSizerRotation = new wxStaticBoxSizer( new wxStaticBox( this, wxID_ANY, _("Rotation") ), wxVERTICAL );
 
 	wxFlexGridSizer* fgSizerRotate;
-	fgSizerRotate = new wxFlexGridSizer( 0, 3, 2, 3 );
+	fgSizerRotate = new wxFlexGridSizer( 0, 3, 1, 3 );
 	fgSizerRotate->AddGrowableCol( 1 );
 	fgSizerRotate->SetFlexibleDirection( wxBOTH );
 	fgSizerRotate->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
@@ -102,7 +104,7 @@ PANEL_PREVIEW_3D_MODEL_BASE::PANEL_PREVIEW_3D_MODEL_BASE( wxWindow* parent, wxWi
 	fgSizerRotate->Add( m_spinZrot, 0, wxALIGN_CENTER_VERTICAL, 5 );
 
 
-	sbSizerRotation->Add( fgSizerRotate, 0, wxBOTTOM|wxRIGHT|wxEXPAND, 5 );
+	sbSizerRotation->Add( fgSizerRotate, 0, wxBOTTOM|wxRIGHT|wxEXPAND, 2 );
 
 
 	bSizerLeft->Add( sbSizerRotation, 0, wxLEFT|wxRIGHT|wxEXPAND, 5 );
@@ -111,7 +113,7 @@ PANEL_PREVIEW_3D_MODEL_BASE::PANEL_PREVIEW_3D_MODEL_BASE( wxWindow* parent, wxWi
 	sbSizerOffset = new wxStaticBoxSizer( new wxStaticBox( this, wxID_ANY, _("Offset") ), wxVERTICAL );
 
 	wxFlexGridSizer* fgSizerOffset;
-	fgSizerOffset = new wxFlexGridSizer( 0, 3, 2, 3 );
+	fgSizerOffset = new wxFlexGridSizer( 0, 3, 1, 3 );
 	fgSizerOffset->AddGrowableCol( 1 );
 	fgSizerOffset->SetFlexibleDirection( wxBOTH );
 	fgSizerOffset->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
@@ -147,7 +149,7 @@ PANEL_PREVIEW_3D_MODEL_BASE::PANEL_PREVIEW_3D_MODEL_BASE( wxWindow* parent, wxWi
 	fgSizerOffset->Add( m_spinZoffset, 0, wxALIGN_CENTER_VERTICAL, 5 );
 
 
-	sbSizerOffset->Add( fgSizerOffset, 0, wxBOTTOM|wxRIGHT|wxEXPAND, 5 );
+	sbSizerOffset->Add( fgSizerOffset, 0, wxBOTTOM|wxRIGHT|wxEXPAND, 2 );
 
 
 	bSizerLeft->Add( sbSizerOffset, 0, wxLEFT|wxRIGHT|wxEXPAND, 5 );
@@ -155,8 +157,8 @@ PANEL_PREVIEW_3D_MODEL_BASE::PANEL_PREVIEW_3D_MODEL_BASE( wxWindow* parent, wxWi
 	wxStaticBoxSizer* sbSizer4;
 	sbSizer4 = new wxStaticBoxSizer( new wxStaticBox( this, wxID_ANY, _("Opacity") ), wxVERTICAL );
 
-	m_opacity = new wxSlider( sbSizer4->GetStaticBox(), wxID_ANY, 50, 0, 100, wxDefaultPosition, wxDefaultSize, wxSL_HORIZONTAL|wxSL_LABELS );
-	sbSizer4->Add( m_opacity, 0, wxBOTTOM|wxEXPAND|wxLEFT|wxRIGHT, 5 );
+	m_opacity = new wxSlider( sbSizer4->GetStaticBox(), wxID_ANY, 50, 0, 100, wxDefaultPosition, wxDefaultSize, wxSL_HORIZONTAL );
+	sbSizer4->Add( m_opacity, 0, wxRIGHT|wxLEFT, 2 );
 
 
 	bSizerLeft->Add( sbSizer4, 1, wxEXPAND|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
@@ -174,7 +176,7 @@ PANEL_PREVIEW_3D_MODEL_BASE::PANEL_PREVIEW_3D_MODEL_BASE( wxWindow* parent, wxWi
 	m_previewLabel->Wrap( -1 );
 	m_previewLabel->SetFont( wxFont( 11, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL, false, wxEmptyString ) );
 
-	bSizer6->Add( m_previewLabel, 1, wxEXPAND|wxLEFT|wxRIGHT, 10 );
+	bSizer6->Add( m_previewLabel, 1, wxEXPAND|wxTOP|wxRIGHT|wxLEFT, 5 );
 
 
 	bSizerRight->Add( bSizer6, 0, wxEXPAND, 5 );
@@ -193,53 +195,53 @@ PANEL_PREVIEW_3D_MODEL_BASE::PANEL_PREVIEW_3D_MODEL_BASE( wxWindow* parent, wxWi
 
 	bSizer3DButtons->Add( 0, 10, 0, 0, 5 );
 
-	m_bpvISO = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+	m_bpvISO = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
 	m_bpvISO->SetToolTip( _("Enable/disable orthographic projection") );
 
 	bSizer3DButtons->Add( m_bpvISO, 0, wxTOP, 5 );
 
-	m_bpvBodyStyle = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+	m_bpvBodyStyle = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
 	m_bpvBodyStyle->SetToolTip( _("Show or hide the board body\nIf hidden, show only copper and silkscreen layers.") );
 
-	bSizer3DButtons->Add( m_bpvBodyStyle, 0, wxTOP|wxBOTTOM, 5 );
+	bSizer3DButtons->Add( m_bpvBodyStyle, 0, wxTOP, 5 );
 
 
 	bSizer3DButtons->Add( 0, 0, 1, wxEXPAND, 5 );
 
-	m_bpvLeft = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+	m_bpvLeft = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
 	bSizer3DButtons->Add( m_bpvLeft, 0, wxBOTTOM, 5 );
 
-	m_bpvRight = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+	m_bpvRight = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
 	bSizer3DButtons->Add( m_bpvRight, 0, wxBOTTOM, 5 );
 
-	m_bpvFront = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+	m_bpvFront = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
 	bSizer3DButtons->Add( m_bpvFront, 0, wxBOTTOM, 5 );
 
-	m_bpvBack = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+	m_bpvBack = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
 	bSizer3DButtons->Add( m_bpvBack, 0, wxBOTTOM, 5 );
 
-	m_bpvTop = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+	m_bpvTop = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
 	bSizer3DButtons->Add( m_bpvTop, 0, wxBOTTOM, 5 );
 
-	m_bpvBottom = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+	m_bpvBottom = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
 	bSizer3DButtons->Add( m_bpvBottom, 0, 0, 5 );
 
 
 	bSizer3DButtons->Add( 0, 0, 1, wxEXPAND, 5 );
 
-	m_bpUpdate = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+	m_bpUpdate = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
 	m_bpUpdate->SetToolTip( _("Reload board and 3D models") );
 
-	bSizer3DButtons->Add( m_bpUpdate, 0, wxBOTTOM, 5 );
+	bSizer3DButtons->Add( m_bpUpdate, 0, wxTOP, 5 );
 
-	m_bpSettings = new wxBitmapButton( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxDefaultSize, wxBU_AUTODRAW|0 );
-	bSizer3DButtons->Add( m_bpSettings, 0, wxBOTTOM, 5 );
+	m_bpSettings = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxDefaultSize, wxBU_AUTODRAW|0 );
+	bSizer3DButtons->Add( m_bpSettings, 0, wxTOP, 5 );
 
 
 	bSizer3DButtons->Add( 0, 10, 0, 0, 5 );
 
 
-	bSizermain->Add( bSizer3DButtons, 0, wxBOTTOM|wxLEFT|wxRIGHT|wxEXPAND, 5 );
+	bSizermain->Add( bSizer3DButtons, 0, wxEXPAND|wxTOP, 5 );
 
 
 	this->SetSizer( bSizermain );

3d-viewer/dialogs/panel_preview_3d_model_base.h

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-282-g1fa54006)
+// C++ code generated with wxFormBuilder (version 4.0.0-0-g0efcecf)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!
@@ -10,6 +10,8 @@
 #include <wx/artprov.h>
 #include <wx/xrc/xmlres.h>
 #include <wx/intl.h>
+class STD_BITMAP_BUTTON;
+
 #include <wx/string.h>
 #include <wx/stattext.h>
 #include <wx/gdicmn.h>
@@ -68,16 +70,16 @@ class PANEL_PREVIEW_3D_MODEL_BASE : public wxPanel
 		wxSlider* m_opacity;
 		wxStaticText* m_previewLabel;
 		wxBoxSizer* m_SizerPanelView;
-		wxBitmapButton* m_bpvISO;
-		wxBitmapButton* m_bpvBodyStyle;
-		wxBitmapButton* m_bpvLeft;
-		wxBitmapButton* m_bpvRight;
-		wxBitmapButton* m_bpvFront;
-		wxBitmapButton* m_bpvBack;
-		wxBitmapButton* m_bpvTop;
-		wxBitmapButton* m_bpvBottom;
-		wxBitmapButton* m_bpUpdate;
-		wxBitmapButton* m_bpSettings;
+		STD_BITMAP_BUTTON* m_bpvISO;
+		STD_BITMAP_BUTTON* m_bpvBodyStyle;
+		STD_BITMAP_BUTTON* m_bpvLeft;
+		STD_BITMAP_BUTTON* m_bpvRight;
+		STD_BITMAP_BUTTON* m_bpvFront;
+		STD_BITMAP_BUTTON* m_bpvBack;
+		STD_BITMAP_BUTTON* m_bpvTop;
+		STD_BITMAP_BUTTON* m_bpvBottom;
+		STD_BITMAP_BUTTON* m_bpUpdate;
+		STD_BITMAP_BUTTON* m_bpSettings;
 
 		// Virtual event handlers, override them in your derived class
 		virtual void onMouseWheelScale( wxMouseEvent& event ) { event.Skip(); }

AUTHORS.txt

@@ -51,6 +51,7 @@ Thomas Pointhuber <thomas.pointhuber[at]gmx-dot-at>
 Roberto Fernandez Bautista <roberto.fer.bau[at]gmail-dot-com>
 Mikołaj Wielgus <wielgusmikolaj[at]gmail-dot-com>
 Mike Williams <mike[at]mikebwilliams-dot-com>
+Emile Cormier <emile.cormier.jr[at]gmail-dot-com>
 
 See git repo on GitLab for contributors at
 https://gitlab.com/kicad/code/kicad/-/graphs/master

CMakeLists.txt

@@ -31,6 +31,11 @@ cmake_policy( SET CMP0116 OLD )
 # The current structure requires the add_custom_command to get called twice, the NEW behavior deduplicates it
 cmake_policy( SET CMP0113 OLD )
 
+#  Enable CMAKE_MSVC_DEBUG_INFORMATION_FORMAT to override the cmake pdb flags easily
+if (POLICY CMP0141)
+  cmake_policy(SET CMP0141 NEW)
+endif (POLICY CMP0141)
+
 # Default to CMAKE_BUILD_TYPE = Release unless overridden on command line
 # http://www.cmake.org/pipermail/cmake/2008-September/023808.html
 if( DEFINED CMAKE_BUILD_TYPE )
@@ -160,6 +165,17 @@ cmake_dependent_option( KICAD_APPLE_MAKE_RELOCATEABLE_BUNDLE
     "On macOS, post-process the build to make it relocateable (default ON)"
     ON "APPLE" OFF )
 
+# CMake's FindProtobuf module doesn't work correctly on MacOS or Windows but is
+# required for Linux
+if( UNIX_NOT_APPLE )
+    set( KICAD_CMAKE_PROTOBUF_DEFAULT ON )
+else()
+    set( KICAD_CMAKE_PROTOBUF_DEFAULT OFF )
+endif()
+
+option( KICAD_USE_CMAKE_FINDPROTOBUF "Use FindProtobuf provided by CMake" ${KICAD_CMAKE_PROTOBUF_DEFAULT} )
+mark_as_advanced( KICAD_USE_CMAKE_FINDPROTOBUF )
+
 ####################################
 # Installation options
 ####################################
@@ -247,6 +263,14 @@ option( KICAD_GAL_PROFILE
     "Enable profiling info for GAL"
     OFF )
 
+option( KICAD_IPC_API
+    "Enable experimental IPC API"
+    OFF )
+
+option( KICAD_IDF_TOOLS
+    "Build additional idf tools"
+    ON )
+
 # Global setting: exports are explicit
 set( CMAKE_CXX_VISIBILITY_PRESET "hidden" )
 set( CMAKE_VISIBILITY_INLINES_HIDDEN ON )
@@ -254,8 +278,8 @@ set( CMAKE_VISIBILITY_INLINES_HIDDEN ON )
 # Global setting: build everything position independent
 set( CMAKE_POSITION_INDEPENDENT_CODE ON )
 
-# Global setting: Use C++17
-set(CMAKE_CXX_STANDARD 17)
+# Global setting: Use C++20
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
@@ -278,6 +302,10 @@ if( KICAD_WAYLAND )
     add_compile_definitions( KICAD_WAYLAND )
 endif()
 
+if( KICAD_IPC_API )
+    add_definitions( -DKICAD_IPC_API )
+endif()
+
 # Ensure DEBUG is defined for all platforms in Debug builds
 add_compile_definitions( $<$<CONFIG:Debug>:DEBUG> )
 
@@ -331,13 +359,9 @@ add_compile_definitions( $<$<BOOL:${KICAD_BUILD_ARCH_ARM64}>:KICAD_BUILD_ARCH_AR
 if (USE_CCACHE)
   find_program(CCACHE_FOUND ccache)
   if(CCACHE_FOUND)
-    get_property(RULE_LAUNCH_COMPILE GLOBAL PROPERTY RULE_LAUNCH_COMPILE)
-    set(RULE_LAUNCH_COMPILE "${RULE_LAUNCH_COMPILE} ${CCACHE_FOUND}")
-    set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${RULE_LAUNCH_COMPILE})
-
-    get_property(RULE_LAUNCH_LINK GLOBAL PROPERTY RULE_LAUNCH_LINK)
-    set(RULE_LAUNCH_LINK "${RULE_LAUNCH_LINK} ${CCACHE_FOUND}")
-    set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ${RULE_LAUNCH_LINK})
+    # Set ccache on the actual lang
+    list(PREPEND CMAKE_C_COMPILER_LAUNCHER ${CCACHE_FOUND})
+    list(PREPEND CMAKE_CXX_COMPILER_LAUNCHER ${CCACHE_FOUND})
 
     message(STATUS "Used ${CCACHE_FOUND} for compilation.")
   else(CCACHE_FOUND)
@@ -352,9 +376,9 @@ endif(USE_CCACHE)
 if (USE_DISTCC)
   find_program(DISTCC_FOUND distcc)
   if(DISTCC_FOUND)
-    get_property(RULE_LAUNCH_COMPILE GLOBAL PROPERTY RULE_LAUNCH_COMPILE)
-    set(RULE_LAUNCH_COMPILE "${RULE_LAUNCH_COMPILE} ${DISTCC_FOUND}")
-    set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${RULE_LAUNCH_COMPILE})
+    list(APPEND CMAKE_C_COMPILER_LAUNCHER ${DISTCC_FOUND})
+    list(APPEND CMAKE_CXX_COMPILER_LAUNCHER ${DISTCC_FOUND})
+    
     message(STATUS "Using ${DISTCC_FOUND} for distributed build.")
   else(DISTCC_FOUND)
     message(INFO "Distcc was requested but not found.")
@@ -512,8 +536,18 @@ if( MSVC )
     string( APPEND CMAKE_CXX_FLAGS " /wd4290" )
     # C4800: non-bool is explicitly cast to bool, forcing value of 0 or 1
     string( APPEND CMAKE_CXX_FLAGS " /wd4800" )
-    # /Zi: create PDB
-    string( APPEND CMAKE_CXX_FLAGS " /Zi" )
+    
+    # cmake 3.25 or higher requried for MSVC, should be fine
+    if( USE_CCACHE AND CCACHE_FOUND )
+        # Equivalent to /Z7, ensures cmake doesn't fight over the default
+        # ccache may encounter external PDB file write errors due to paralleism
+        # Using the embedded PDB mode is ok for development use of ccache
+        set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "Embedded")
+    else()
+        # Equivalent to /Zi, ensures cmake doesn't fight over the default
+        set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "ProgramDatabase")
+    endif()
+
     # /Zc:__cplusplus: define this macro according to C++ standard version
     string( APPEND CMAKE_CXX_FLAGS " /Zc:__cplusplus" )
     # /GF: enable string pooling
@@ -842,6 +876,27 @@ if( OCC_VERSION_STRING VERSION_LESS 7.5.0 )
 endif()
 include_directories( SYSTEM ${OCC_INCLUDE_DIR} )
 
+if( KICAD_USE_CMAKE_FINDPROTOBUF )
+    include( FindProtobuf )
+    find_package( Protobuf REQUIRED )
+else()
+    find_package( Protobuf REQUIRED CONFIG )
+    set( Protobuf_LIBRARY "protobuf::libprotobuf" )
+endif()
+
+if( NOT Protobuf_PROTOC_EXECUTABLE )
+if( NOT KICAD_USE_CMAKE_FINDPROTOBUF)
+    set( Protobuf_PROTOC_EXECUTABLE "protobuf::protoc" )
+else()
+    MESSAGE( FATAL_ERROR "Protobuf compiler not found. Please install protobuf-compiler." )
+endif()
+endif()
+
+if( NOT Protobuf_INCLUDE_DIR )
+    get_target_property( Protobuf_INCLUDE_DIR protobuf::libprotobuf INTERFACE_INCLUDE_DIRECTORIES )
+endif()
+
+
 # Assist with header file searching optimization:
 # INC_BEFORE and INC_AFTER are two lists which go at the front and back of the
 # header file search lists, respectively.
@@ -1003,6 +1058,25 @@ find_package( wxWidgets ${wxWidgets_REQ_VERSION} COMPONENTS gl aui adv html core
 # Include wxWidgets macros.
 include( ${wxWidgets_USE_FILE} )
 
+# Detect wxWidgets port being used
+if( wxWidgets_FIND_STYLE STREQUAL "win32" )
+    string(REGEX MATCH "^[msw|qt|gtk]*" KICAD_WX_PORT "${WX_CONFIGURATION}")
+
+    if( KICAD_WX_PORT STREQUAL "qt" )
+        add_compile_definitions( __WXQT__ )
+    elseif( KICAD_WX_PORT STREQUAL "gtk" )
+        add_compile_definitions( __WXGTK__ )
+    endif()
+elseif( _wx_selected_config )
+    string(REGEX MATCH "^[msw|qt|gtk|osx]*" KICAD_WX_PORT "${_wx_selected_config}")
+endif()
+
+if( KICAD_WX_PORT )
+    message( STATUS "Detected wxWidgets port: ${KICAD_WX_PORT}")
+else()
+    message( FATAL_ERROR "Unable to detect wxWidgets port")
+endif()
+
 if( NOT MSVC )
     if( ${wxWidgets_VERSION_STRING} VERSION_LESS 3.2 )
         message( FATAL_ERROR "wxWidgets 3.2.0 or greater is required" )
@@ -1051,6 +1125,10 @@ if( KICAD_USE_SENTRY )
     add_compile_definitions( KICAD_USE_SENTRY )
 endif()
 
+if( KICAD_IPC_API )
+    find_package( nng REQUIRED )
+endif()
+
 #================================================
 # Add the doxygen target
 #================================================
@@ -1089,6 +1167,7 @@ list( APPEND CMAKE_CTEST_ARGUMENTS "--output-on-failure" )
 #================================================
 
 # Binaries ( CMake targets )
+add_subdirectory( api )
 add_subdirectory( resources )
 add_subdirectory( thirdparty )
 add_subdirectory( libs )
@@ -1103,7 +1182,7 @@ add_subdirectory( bitmap2component )
 add_subdirectory( pcb_calculator )
 add_subdirectory( plugins )             # 3D plugins must be built before kicad
 add_subdirectory( cvpcb )               # must be after pcbnew
-add_subdirectory( kicad )               # should follow pcbnew, eeschema
+add_subdirectory( kicad )               # should follow pcbnew, eeschema, api
 add_subdirectory( tools )
 add_subdirectory( utils )
 

CMakePresets.json.sample

@@ -0,0 +1,56 @@
+{
+  "version": 3,
+  "configurePresets": [
+    {
+      "name": "base",
+      "hidden": true,
+      "generator": "Ninja",
+      "binaryDir": "${sourceDir}/build",
+      "toolchainFile": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Windows"
+      },
+      "cacheVariables": {
+        "KICAD_BUILD_QA_TESTS": "OFF",
+        "KICAD_BUILD_I18N": "ON",
+        "KICAD_SCRIPTING_WXPYTHON": "ON"
+      }
+    },
+    {
+      "name": "win64",
+      "hidden": true,
+      "cacheVariables": {
+        "KICAD_WIN32_DPI_AWARE": "ON",
+        "CMAKE_INSTALL_PREFIX": "out",
+        "CMAKE_PDB_OUTPUT_DIRECTORY": "out/pdb"
+      },
+      "architecture": {
+        "value": "x64",
+        "strategy": "external"
+      },
+      "inherits": [
+        "base"
+      ]
+    },
+    {
+      "name": "x64-debug",
+      "displayName": "x64 Debug",
+      "description": "Sets debug build type and x64 arch",
+      "inherits": "win64",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug"
+      }
+    },
+    {
+      "name": "x64-release",
+      "displayName": "x64 Release",
+      "description": "Sets release build type",
+      "inherits": "win64",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "RelWithDebInfo"
+      }
+    }
+  ]
+}

api/CMakeLists.txt

@@ -0,0 +1,133 @@
+# This program source code file is part of KiCad, a free EDA CAD application.
+#
+# Copyright (C) 2023 KiCad Developers, see AUTHORS.TXT for contributors.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Search paths for protoc when generating code
+set( Protobuf_IMPORT_DIRS ${Protobuf_INCLUDE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/proto )
+
+set( KIAPI_PROTO_SRCS
+    common/envelope.proto
+
+    common/types/base_types.proto
+    common/types/enums.proto
+    common/types/project_settings.proto
+
+    common/commands/base_commands.proto
+    common/commands/editor_commands.proto
+    common/commands/project_commands.proto
+
+    board/board.proto
+    board/board_commands.proto
+    board/board_types.proto
+
+    schematic/schematic_types.proto
+    schematic/schematic_commands.proto
+    )
+
+# Generated C++ code must be in the build dir; it is dependent on the version of protoc installed
+set( KIAPI_CPP_BASEPATH ${CMAKE_CURRENT_BINARY_DIR}/cpp/api )
+
+foreach( PROTO_SRC ${KIAPI_PROTO_SRCS} )
+    string( REGEX REPLACE "\.proto$" ".pb.cc" CPP_SRC ${PROTO_SRC} )
+    string( REGEX REPLACE "\.proto$" ".pb.h" CPP_HEADER ${PROTO_SRC} )
+    set( KIAPI_CPP_SRCS ${KIAPI_CPP_SRCS} ${KIAPI_CPP_BASEPATH}/${CPP_SRC} )
+    set( KIAPI_CPP_HEADERS ${KIAPI_CPP_HEADERS} ${KIAPI_CPP_BASEPATH}/${CPP_HEADER} )
+    set( KIAPI_PROTO_SRC_FULLPATHS ${KIAPI_PROTO_SRC_FULLPATHS} ${CMAKE_CURRENT_SOURCE_DIR}/proto/${PROTO_SRC} )
+endforeach ()
+
+add_custom_command( COMMAND ${CMAKE_COMMAND} -E make_directory ${KIAPI_CPP_BASEPATH}
+    COMMAND ${Protobuf_PROTOC_EXECUTABLE}
+    --cpp_out=dllexport_decl=KIAPI_IMPORTEXPORT:${KIAPI_CPP_BASEPATH}
+    --proto_path=${CMAKE_CURRENT_SOURCE_DIR}/proto
+    ${KIAPI_PROTO_SRCS}
+    COMMENT "Generating API protobuf source files from proto definitions..."
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+    DEPENDS ${KIAPI_PROTO_SRC_FULLPATHS}
+    OUTPUT ${KIAPI_CPP_SRCS} ${KIAPI_CPP_HEADERS}
+    )
+
+# kiapi must be a shared DLL because the protobuf messages can only be initialized once
+add_library( kiapi SHARED
+    ${CMAKE_CURRENT_SOURCE_DIR}/../include/import_export.h
+    ${KIAPI_CPP_SRCS}
+    ${KIAPI_CPP_HEADERS}
+    )
+
+target_compile_definitions( kiapi PRIVATE KIAPI_IMPORTEXPORT=APIEXPORT )
+target_compile_definitions( kiapi INTERFACE KIAPI_IMPORTEXPORT=APIIMPORT )
+
+# https://groups.google.com/g/protobuf/c/PDR1bqRazts
+if(MSVC)
+    target_compile_options( kiapi PRIVATE /FI${CMAKE_CURRENT_SOURCE_DIR}/../include/import_export.h )
+else()
+    add_definitions( -include ${CMAKE_CURRENT_SOURCE_DIR}/../include/import_export.h )
+endif()
+
+if( APPLE )
+    # puts library into the main kicad.app bundle in build tree
+    set_target_properties( kiapi PROPERTIES
+            LIBRARY_OUTPUT_DIRECTORY "${OSX_BUNDLE_BUILD_LIB_DIR}"
+            INSTALL_NAME_DIR "${OSX_BUNDLE_BUILD_LIB_DIR}"
+            )
+endif()
+
+install( TARGETS
+    kiapi
+    RUNTIME DESTINATION ${KICAD_LIB}
+    LIBRARY DESTINATION ${KICAD_LIB}
+    COMPONENT binary
+    )
+
+if( KICAD_WIN32_INSTALL_PDBS )
+    # Get the PDBs to copy over for MSVC
+    install(FILES $<TARGET_PDB_FILE:kiapi> DESTINATION ${KICAD_BIN})
+endif()
+
+# Because CMake doesn't guess this from the .cc extension generated by protoc
+set_target_properties( kiapi PROPERTIES LINKER_LANGUAGE CXX )
+
+include( ${KICAD_CMAKE_MODULE_PATH}/KiCadVersion.cmake )
+
+# Extract the major and minor build version as a string
+string( REGEX MATCH
+        "([0-9]+)\\.([0-9]+)\\.([0-9]+)"
+        KICAD_MAJOR_MINOR_PATCH_VERSION
+        "${KICAD_VERSION}"
+    )
+
+set_target_properties( kiapi PROPERTIES SOVERSION ${KICAD_MAJOR_MINOR_PATCH_VERSION} )
+
+target_include_directories( kiapi SYSTEM PUBLIC ${Protobuf_INCLUDE_DIRS} )
+
+target_link_libraries( kiapi protobuf::libprotobuf )
+
+target_include_directories( kiapi INTERFACE
+    ${CMAKE_CURRENT_BINARY_DIR}/cpp     # Leaving off the /api/ to make #include statments less ambiguous
+    )
+
+# Because when building internally, the generated files do not include the "api" base path
+target_include_directories( kiapi PUBLIC ${KIAPI_CPP_BASEPATH} )
+
+if( APPLE )
+    # puts library into the main kicad.app bundle in build tree
+    set_target_properties( kiapi PROPERTIES
+        LIBRARY_OUTPUT_DIRECTORY "${OSX_BUNDLE_BUILD_LIB_DIR}"
+        INSTALL_NAME_DIR "${OSX_BUNDLE_BUILD_LIB_DIR}"
+    )
+    set_target_properties( kiapi PROPERTIES INSTALL_RPATH
+            "@executable_path/../Frameworks" )
+    set_target_properties( kiapi PROPERTIES BUILD_WITH_INSTALL_RPATH 1 )
+endif()

api/proto/board/board.proto

@@ -0,0 +1,116 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 Jon Evans <jon@craftyjon.com>
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+syntax = "proto3";
+
+package kiapi.board;
+
+import "common/types/base_types.proto";
+import "board/board_types.proto";
+
+message BoardFinish
+{
+  string type_name = 1;
+}
+
+message BoardImpedanceControl
+{
+  bool is_controlled = 1;
+}
+
+message BoardEdgeConnector
+{
+}
+
+message Castellation
+{
+  bool has_castellated_pads = 1;
+}
+
+message EdgePlating
+{
+  bool has_edge_plating = 1;
+}
+
+message BoardEdgeSettings
+{
+  BoardEdgeConnector connector = 1;
+  Castellation castellation = 2;
+  EdgePlating plating = 3;
+}
+
+message BoardStackupCopperLayer
+{
+
+}
+
+message BoardStackupLayer
+{
+  kiapi.common.types.Distance thickness = 1;
+  kiapi.board.types.BoardLayer layer = 2;
+  bool enabled = 3;
+  oneof item {
+    BoardStackupCopperLayer copper = 4;
+  }
+}
+
+message BoardStackup
+{
+  BoardFinish finish = 1;
+  BoardImpedanceControl impedance = 2;
+  // NOTE: m_HasThicknessConstrains appears to be unused
+  BoardEdgeSettings edge = 3;
+  repeated BoardStackupLayer layers = 4;
+}
+
+// LAYER_CLASS_* in BOARD_DESIGN_SETTINGS -- needs to become an enum class
+enum BoardLayerClass
+{
+  BLC_UNKNOWN = 0;
+  BLC_SILKSCREEN = 1;
+  BLC_COPPER = 2;
+  BLC_EDGES = 3;
+  BLC_COURTYARD = 4;
+  BLC_FABRICATION = 5;
+  BLC_OTHER = 6;
+}
+
+message BoardLayerGraphicsDefaults
+{
+  BoardLayerClass layer = 1;
+  kiapi.common.types.TextAttributes text = 2;
+  kiapi.common.types.Distance line_thickness = 3;
+}
+
+message GraphicsDefaults
+{
+  repeated BoardLayerGraphicsDefaults layers = 1;
+}
+
+// Anything that isn't stackup or design rules
+message BoardSettings
+{
+  GraphicsDefaults graphics_defaults = 1;
+  // Dimension default settings
+}
+
+message BoardDesignRules
+{
+}

api/proto/board/board_commands.proto

@@ -0,0 +1,151 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 Jon Evans <jon@craftyjon.com>
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+syntax = "proto3";
+
+package kiapi.board.commands;
+
+import "common/types/base_types.proto";
+import "common/types/enums.proto";
+import "board/board.proto";
+import "board/board_types.proto";
+
+/*
+ * Board stackup and properties
+ */
+
+message GetBoardStackup
+{
+  kiapi.common.types.DocumentSpecifier board = 1;
+}
+
+message BoardStackupResponse
+{
+  kiapi.board.BoardStackup stackup = 1;
+}
+
+message UpdateBoardStackup
+{
+  kiapi.common.types.DocumentSpecifier board = 1;
+  kiapi.board.BoardStackup stackup = 2;
+}
+
+message GetGraphicsDefaults
+{
+  kiapi.common.types.DocumentSpecifier board = 1;
+}
+
+message GraphicsDefaultsResponse
+{
+  kiapi.board.GraphicsDefaults defaults = 1;
+}
+
+/*
+ * Net management
+ */
+
+message GetNets
+{
+  kiapi.common.types.DocumentSpecifier board = 1;
+
+  // If provided, will only return nets that belong to the given netclass.
+  // If more than one netclass_filter is given, nets belonging to any of the given classes will
+  // be returned.
+  repeated string netclass_filter = 2;
+}
+
+message NetsResponse
+{
+  repeated kiapi.board.types.Net nets = 1;
+}
+
+// Retrieve all the copper items belonging to a certain net or set of nets
+// returns kiapi.common.commands.GetItemsResponse
+message GetItemsByNet
+{
+  // Specifies which document to query, which fields to return, etc.
+  kiapi.common.types.ItemHeader header = 1;
+
+  // List of one or more types of items to retreive
+  repeated kiapi.common.types.KiCadObjectType types = 2;
+
+  // A list of net codes to filter items by
+  repeated kiapi.board.types.NetCode net_codes = 3;
+}
+
+// Retrieve all the copper items belonging to a certain net class or set of net classes
+// returns kiapi.common.commands.GetItemsResponse
+message GetItemsByNetClass
+{
+  // Specifies which document to query, which fields to return, etc.
+  kiapi.common.types.ItemHeader header = 1;
+
+  // List of one or more types of items to retreive
+  repeated kiapi.common.types.KiCadObjectType types = 2;
+
+  // A list of net class names to filter items by
+  repeated string net_classes = 3;
+}
+
+/*
+ * Blocking operations
+ */
+
+// Refills some or all zones on the board.
+// This is a blocking operation; it will return Empty immediately, but KiCad will return
+// ApiStatusCode.AS_BUSY to all future API requests until the zone fill has completed.
+message RefillZones
+{
+  kiapi.common.types.DocumentSpecifier board = 1;
+
+  // A list of zones to refill.  If empty, all zones are refilled.
+  repeated kiapi.common.types.KIID zones = 2;
+}
+
+/*
+ * Utilities
+ */
+
+// returns kiapi.common.commands.BoundingBoxResponse
+message GetTextExtents
+{
+  // A temporary text item to calculate the bounding box for
+  kiapi.board.types.Text text = 1;
+}
+
+//// Interactive commands ////
+// These commands begin an interactive operation in the editor.
+// They return a response immediately, but the editor will become busy
+// and will not reply to further API commands until the user has finished
+// the operation.
+// These commands will return an error if received in a non-interactive context.
+
+// Selects and begins an interactive move of the given item(s).
+// NOTE: Takes ownership of the active commit, if one exists:
+//       the move tool will push the commit when the user confirms the move,
+//       or roll back the commit if the user cancels the move.  Keep this in
+//       mind if using this command in combination with commands that create
+//       or modify items using an explicit commit.
+message InteractiveMoveItems
+{
+  kiapi.common.types.DocumentSpecifier board = 1;
+
+  repeated kiapi.common.types.KIID items = 2;
+}

api/proto/board/board_types.proto

@@ -0,0 +1,515 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+syntax = "proto3";
+
+package kiapi.board.types;
+
+import "google/protobuf/any.proto";
+import "common/types/base_types.proto";
+
+enum BoardLayer
+{
+  BL_UNKNOWN = 0;
+  BL_UNDEFINED = 1;
+  BL_UNSELECTED = 2;
+  BL_F_Cu = 3;
+  BL_In1_Cu = 4;
+  BL_In2_Cu = 5;
+  BL_In3_Cu = 6;
+  BL_In4_Cu = 7;
+  BL_In5_Cu = 8;
+  BL_In6_Cu = 9;
+  BL_In7_Cu = 10;
+  BL_In8_Cu = 11;
+  BL_In9_Cu = 12;
+  BL_In10_Cu = 13;
+  BL_In11_Cu = 14;
+  BL_In12_Cu = 15;
+  BL_In13_Cu = 16;
+  BL_In14_Cu = 17;
+  BL_In15_Cu = 18;
+  BL_In16_Cu = 19;
+  BL_In17_Cu = 20;
+  BL_In18_Cu = 21;
+  BL_In19_Cu = 22;
+  BL_In20_Cu = 23;
+  BL_In21_Cu = 24;
+  BL_In22_Cu = 25;
+  BL_In23_Cu = 26;
+  BL_In24_Cu = 27;
+  BL_In25_Cu = 28;
+  BL_In26_Cu = 29;
+  BL_In27_Cu = 30;
+  BL_In28_Cu = 31;
+  BL_In29_Cu = 32;
+  BL_In30_Cu = 33;
+  BL_B_Cu = 34;
+  BL_B_Adhes = 35;
+  BL_F_Adhes = 36;
+  BL_B_Paste = 37;
+  BL_F_Paste = 38;
+  BL_B_SilkS = 39;
+  BL_F_SilkS = 40;
+  BL_B_Mask = 41;
+  BL_F_Mask = 42;
+  BL_Dwgs_User = 43;
+  BL_Cmts_User = 44;
+  BL_Eco1_User = 45;
+  BL_Eco2_User = 46;
+  BL_Edge_Cuts = 47;
+  BL_Margin = 48;
+  BL_B_CrtYd = 49;
+  BL_F_CrtYd = 50;
+  BL_B_Fab = 51;
+  BL_F_Fab = 52;
+  BL_User_1 = 53;
+  BL_User_2 = 54;
+  BL_User_3 = 55;
+  BL_User_4 = 56;
+  BL_User_5 = 57;
+  BL_User_6 = 58;
+  BL_User_7 = 59;
+  BL_User_8 = 60;
+  BL_User_9 = 61;
+}
+
+message NetCode
+{
+  int32 value = 1;
+}
+
+// Describes a copper item's net
+message Net
+{
+  // A unique code representing this net
+  NetCode code = 1;
+
+  // Human-readable net name
+  string name = 2;
+}
+
+// Represents a track segment on a board
+message Track
+{
+  kiapi.common.types.KIID        id     = 1;
+  kiapi.common.types.Vector2     start  = 2;
+  kiapi.common.types.Vector2     end    = 3;
+  kiapi.common.types.Distance    width  = 4;
+  kiapi.common.types.LockedState locked = 5;
+  BoardLayer                     layer  = 6;
+  Net                            net    = 7;
+}
+
+// Represents an arc track (not a PCB_SHAPE in arc shape)
+// Arc tracks in KiCad store start, midpoint, and end.
+// All other values (center point, angles, etc) are inferred.
+message Arc
+{
+  kiapi.common.types.KIID        id     = 1;
+  kiapi.common.types.Vector2     start  = 2;
+  kiapi.common.types.Vector2     mid    = 3;  // Arc midpoint
+  kiapi.common.types.Vector2     end    = 4;
+  kiapi.common.types.Distance    width  = 5;
+  kiapi.common.types.LockedState locked = 6;
+  BoardLayer                     layer  = 7;
+  Net                            net    = 8;
+}
+
+// What copper layer shape mode the padstack uses
+enum PadStackType
+{
+  PST_UNKNOWN = 0;
+
+  // The same shape is used on all copper layers
+  PST_NORMAL = 1;
+
+  // The padstack uses up to three different shapes (F_Cu, inner layers, B_Cu)
+  PST_TOP_INNER_BOTTOM = 2;
+
+  // The padstack's shape may differ on arbitrary copper layers
+  PST_CUSTOM = 3;
+}
+
+enum UnconnectedLayerRemoval
+{
+  ULR_UNKNOWN = 0;
+
+  // Keep annular rings on all layers
+  ULR_KEEP = 1;
+
+  // Remove annular rings on unconnected layers, including start and end layers.
+  ULR_REMOVE = 2;
+
+  // Remove annular rings on unconnected layers, but preserve start and end layers even if unconnected.
+  ULR_REMOVE_EXCEPT_START_AND_END = 3;
+}
+
+// The shape of a pad on a given layer
+enum PadStackShape
+{
+  PSS_UNKNOWN = 0;
+  PSS_CIRCLE = 1;
+  PSS_RECTANGLE = 2;
+  PSS_OVAL = 3;
+  PSS_TRAPEZOID = 4;
+  PSS_ROUNDRECT = 5;
+  PSS_CHAMFEREDRECT = 6;
+  PSS_CUSTOM = 7;
+}
+
+// Which corners are chamfered in a PSS_CHAMFEREDRECT
+message ChamferedRectCorners
+{
+  bool top_left = 1;
+  bool top_right = 2;
+  bool bottom_left = 3;
+  bool bottom_right = 4;
+}
+
+// The defintion of a padstack on a single layer
+message PadStackLayer
+{
+  // The board layers of this padstack entry
+  repeated BoardLayer layers = 1;
+
+  // The shape of the pad on this layer
+  PadStackShape shape = 2;
+
+  // The size (x and y) of the shape on this layer
+  kiapi.common.types.Vector2 size = 3;
+
+  // How much to round the corners of the shape by, as a fraction of min(size.x, size.y)
+  // Only used for PSS_ROUNDRECT or PSS_CHAMFEREDRECT
+  double corner_rounding_ratio = 4;
+
+  // How much to round the corners of the shape by, as a fraction of min(size.x, size.y)
+  // Only used for PSS_CHAMFEREDRECT
+  double chamfer_ratio = 5;
+
+  ChamferedRectCorners chamfered_corners = 6;
+
+  repeated GraphicShape custom_shapes = 7;
+
+  // If shape == PSS_CUSTOM, defines the shape of the anchor (only PSS_CIRCLE and PSS_RECTANGLE supported at present)
+  PadStackShape custom_anchor_shape = 8;
+}
+
+// A pad stack definition for a multilayer pad or via.
+message PadStack
+{
+  // What type of pad stack this represents.
+  PadStackType type = 1;
+
+  // Lowest (closest to F_Cu) layer this stack exists on.  Ignored if type == PST_THROUGH.
+  BoardLayer start_layer = 2;
+
+  // Highest (closest to B_Cu) layer this stack exists on.  Ignored if type == PST_THROUGH.
+  BoardLayer end_layer   = 3;
+
+  // How to treat pad shapes on unconnected layers.
+  UnconnectedLayerRemoval unconnected_layer_removal = 4;
+
+  // The diameter, in x and y, of the pad's drilled hole, if this pad has a hole.
+  // x and y will be the same value if the hole is round.
+  kiapi.common.types.Vector2 drill_diameter = 5;
+
+  repeated PadStackLayer layers = 6;
+
+  // The overall rotation of this padstack (affects all layers)
+  kiapi.common.types.Angle angle = 7;
+}
+
+enum ViaType
+{
+  VT_UNKNOWN = 0;
+
+  // Through vias always start on F_Cu and end on B_Cu
+  VT_THROUGH = 1;
+
+  // Blind/buried vias can have arbitrary start and end layers
+  VT_BLIND_BURIED = 2;
+
+  // Microvias, blind/buried vias, can have arbitrary start and end layers, but also have different
+  // size defaults and design rules
+  VT_MICRO = 3;
+}
+
+// Represents a via
+message Via
+{
+  // The unique identifier of the via
+  kiapi.common.types.KIID id = 1;
+
+  // The location of the via's center point
+  kiapi.common.types.Vector2  position = 2;
+
+  // The pad stack definition for this via.
+  PadStack pad_stack = 3;
+
+  kiapi.common.types.LockedState locked = 4;
+
+  Net net = 5;
+
+  ViaType type = 6;
+}
+
+message GraphicSegmentAttributes
+{
+  kiapi.common.types.Vector2  start = 1;
+  kiapi.common.types.Vector2  end   = 2;
+}
+
+message GraphicRectangleAttributes
+{
+  kiapi.common.types.Vector2  top_left     = 1;
+  kiapi.common.types.Vector2  bottom_right = 2;
+}
+
+message GraphicArcAttributes
+{
+  kiapi.common.types.Vector2  start = 1;
+  kiapi.common.types.Vector2  mid   = 2;
+  kiapi.common.types.Vector2  end   = 3;
+}
+
+message GraphicCircleAttributes
+{
+  kiapi.common.types.Vector2  center = 1;
+
+  // A point on the radius of the circle.  This is stored instead of just a radius so that the point
+  // by which the user can adjust the circle radius is persisted.
+  kiapi.common.types.Vector2  radius_point = 2;
+}
+
+message GraphicBezierAttributes
+{
+  kiapi.common.types.Vector2  start    = 1;
+  kiapi.common.types.Vector2  control1 = 2;
+  kiapi.common.types.Vector2  control2 = 3;
+  kiapi.common.types.Vector2  end      = 4;
+}
+
+message GraphicShape
+{
+  kiapi.common.types.KIID              id         = 1;
+  kiapi.common.types.LockedState       locked     = 2;
+  BoardLayer                           layer      = 3;
+  Net                                  net        = 4;
+  kiapi.common.types.GraphicAttributes attributes = 5;
+
+  oneof geometry {
+    GraphicSegmentAttributes     segment    = 6;
+    GraphicRectangleAttributes   rectangle  = 7;
+    GraphicArcAttributes         arc        = 8;
+    GraphicCircleAttributes      circle     = 9;
+    kiapi.common.types.PolySet   polygon    = 10;
+    GraphicBezierAttributes      bezier     = 11;
+  }
+}
+
+// A board-specific text object, existing on a board layer
+message Text
+{
+  kiapi.common.types.Text text = 1;
+  BoardLayer layer = 2;
+}
+
+// A board-specific textbox, existing on a board layer
+message TextBox
+{
+  kiapi.common.types.TextBox textbox = 1;
+  BoardLayer layer = 2;
+}
+
+// NOTE: There has been some discussion about what to do with pad attributes and properties.
+// This may be considered somewhat unstable until we decide what to do with the KiCad side.
+// It is not clear what the set of mutually-exclusive pad types will be at the end of the day,
+// versus what will be non-exclusive attributes/properties.
+// For now, this maps to PAD_ATTRIB in KiCad.
+enum PadType
+{
+  PT_UNKNOWN = 0;
+  PT_PTH = 1;
+  PT_SMD = 2;
+  PT_EDGE_CONNECTOR = 3;
+  PT_NPTH = 4;
+}
+
+enum CustomPadShapeZoneFillStrategy
+{
+  CPSZ_UNKNOWN = 0;
+  CPSZ_OUTLINE = 1;
+  CPSZ_CONVEXHULL = 2;
+}
+
+message ThermalSpokeSettings
+{
+  int64 width = 1;
+  kiapi.common.types.Angle angle = 2;
+  int64 gap = 3;
+}
+
+message Pad
+{
+  kiapi.common.types.KIID id = 1;
+  kiapi.common.types.LockedState locked = 2;
+  string number = 3;
+  Net net = 4;
+  PadType type = 5;
+  PadStack pad_stack = 6;
+
+  // A pad's position is always relative to the parent footprint's origin
+  kiapi.common.types.Vector2 position = 7;
+
+  DesignRuleOverrides overrides = 8;
+
+  ThermalSpokeSettings thermal_spokes = 9;
+}
+
+// Copper zone, non-copper zone, or rule area
+message Zone
+{
+  // TODO
+}
+
+message Dimension
+{
+  // TODO
+}
+
+message ReferenceImage
+{
+  // TODO
+}
+
+message Group
+{
+  // TODO
+}
+
+message FieldId
+{
+  int32 id = 1;
+}
+
+message Field
+{
+  FieldId id = 1;
+  string name = 2;
+  Text text = 3;
+}
+
+message Model3D
+{
+  // TODO
+}
+
+
+enum FootprintMountingStyle
+{
+  FMS_UNKNOWN = 0;
+  FMS_THROUGH_HOLE = 1;
+  FMS_SMD = 2;
+  FMS_UNSPECIFIED = 3;
+}
+
+
+message FootprintAttributes
+{
+  string description = 1;
+  string keywords = 2;
+  bool not_in_schematic = 3;
+  bool exclude_from_position_files = 4;
+  bool exclude_from_bill_of_materials = 5;
+  bool exempt_from_courtyard_requirement = 6;
+  bool do_not_populate = 7;
+  FootprintMountingStyle mounting_style = 8;
+}
+
+// enum class ZONE_CONNECTION
+enum ZoneConnectionStyle
+{
+  ZCS_UNKNOWN     = 0;
+  ZCS_INHERITED   = 1;
+  ZCS_NONE        = 2;
+  ZCS_THERMAL     = 3;
+  ZCS_FULL        = 4;
+  ZCS_PTH_THERMAL = 5;  // Thermal reliefs for plated through holes, solid for SMD pads
+}
+
+message DesignRuleOverrides
+{
+  // Copper-to-copper clearance override
+  kiapi.common.types.Distance clearance = 1;
+
+  // Solder mask expansion/contraction
+  kiapi.common.types.Distance solder_mask_margin = 2;
+
+  // Solder paste expansion/contraction
+  kiapi.common.types.Distance solder_paste_margin = 3;
+
+  // Solder paste expansion/contraction ratio
+  kiapi.common.types.Ratio solder_paste_margin_ratio = 4;
+
+  ZoneConnectionStyle zone_connection = 5;
+}
+
+message NetTieDefinition
+{
+  repeated string pad_number = 1;
+}
+
+// A footprint definition (i.e. what would be in a library)
+message Footprint
+{
+  kiapi.common.types.LibraryIdentifier id         = 1;
+  kiapi.common.types.Vector2           anchor     = 2;
+  FootprintAttributes                  attributes = 3;
+  DesignRuleOverrides                  overrides  = 4;
+  repeated NetTieDefinition            net_ties   = 5;
+  repeated BoardLayer                  private_layers = 6;
+
+  Field reference_field = 7;
+  Field value_field = 8;
+  Field datasheet_field = 9;
+  Field description_field = 10;
+
+  // All footprint items except for mandatory fields
+  repeated google.protobuf.Any items = 11;
+}
+
+// An instance of a footprint on a board
+message FootprintInstance
+{
+  kiapi.common.types.KIID id = 1;
+  kiapi.common.types.Vector2  position = 2;
+  kiapi.common.types.Angle orientation = 3;
+  BoardLayer layer = 4;
+  kiapi.common.types.LockedState locked = 5;
+  Footprint definition = 6;
+
+  Field reference_field = 7;
+  Field value_field = 8;
+  Field datasheet_field = 9;
+  Field description_field = 10;
+
+  FootprintAttributes attributes = 11;
+  DesignRuleOverrides overrides  = 12;
+}

api/proto/common/commands/base_commands.proto

@@ -1,7 +1,6 @@
 /*
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
- * Copyright (C) 2024 3Dconnexion
  * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software: you can redistribute it and/or modify it
@@ -18,28 +17,22 @@
  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "nl_footprint_properties_plugin.h"
-#include "nl_footprint_properties_plugin_impl.h"
-#include <advanced_config.h>
-#include <kiplatform/drivers.h>
+syntax = "proto3";
 
+package kiapi.common.commands;
 
-NL_FOOTPRINT_PROPERTIES_PLUGIN::NL_FOOTPRINT_PROPERTIES_PLUGIN( EDA_3D_CANVAS* aViewport )
+import "common/types/base_types.proto";
+
+message GetVersion
 {
-    if( ADVANCED_CFG::GetCfg().m_Use3DConnexionDriver
-        && KIPLATFORM::DRIVERS::Valid3DConnexionDriverVersion() )
-    {
-        m_impl = std::make_unique<NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL>( aViewport );
-        m_impl->Connect();
-    }
 }
 
-
-NL_FOOTPRINT_PROPERTIES_PLUGIN::~NL_FOOTPRINT_PROPERTIES_PLUGIN() = default;
-
-
-void NL_FOOTPRINT_PROPERTIES_PLUGIN::SetFocus( bool focus )
+message GetVersionResponse
+{
+  kiapi.common.types.KiCadVersion version = 1;
+}
+
+// A command to check if the connection to KiCad is OK
+message Ping
 {
-    if( m_impl )
-        m_impl->SetFocus( focus );
 }

api/proto/common/commands/editor_commands.proto

@@ -0,0 +1,299 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * Commands and responses related to manipulating editor windows
+ */
+
+syntax = "proto3";
+
+package kiapi.common.commands;
+
+import "google/protobuf/any.proto";
+import "common/types/base_types.proto";
+import "common/types/enums.proto";
+
+// Refreshes the given frame, if that frame is open
+message RefreshEditor
+{
+  kiapi.common.types.FrameType frame = 1;
+}
+
+// Retrieves a list of open documents of the given type
+message GetOpenDocuments
+{
+  // Which type of documents to query
+  kiapi.common.types.DocumentType type = 1;
+}
+
+message GetOpenDocumentsResponse
+{
+  repeated kiapi.common.types.DocumentSpecifier documents = 1;
+}
+
+/*
+ * Runs a TOOL_ACTION using the TOOL_MANAGER of a given frame.
+ * WARNING: The TOOL_ACTIONs are specifically *not* an API.
+ * Command names may change as code is refactored, and commands may disappear.
+ * This API method is provided for low-level prototyping purposes only.
+ */
+message RunAction
+{
+  string action = 1;  // Action name, like "eeschema.InteractiveSelection.ClearSelection"
+}
+
+enum RunActionStatus
+{
+  RAS_UNKNOWN        = 0;
+  RAS_OK             = 1;  // The action was submitted successfully.
+  RAS_INVALID        = 2;  // The action was unknown for the targeted frame.
+  RAS_FRAME_NOT_OPEN = 3;  // The targeted frame was not open when the call was submitted.
+}
+
+/*
+ * NOTE: At the moment, RAS_FRAME_NOT_OPEN won't be returned as the handler is inside the frame.
+ */
+message RunActionResponse
+{
+  RunActionStatus status = 1;
+}
+
+
+/*
+ * Begins a staged set of changes.  Any modifications made to a document through the API after this
+ * call will be saved to a pending commit, and will not appear in KiCad until a matching call to
+ * END_COMMIT.
+ */
+message BeginCommit
+{
+}
+
+
+message BeginCommitResponse
+{
+  // Opaque identifier tracking a commit
+  kiapi.common.types.KIID id = 1;
+}
+
+
+enum CommitAction
+{
+  CMA_UNKNOWN = 0;
+  CMA_COMMIT  = 1; // Commit the changes to the design
+  CMA_DROP    = 2; // Cancel this commit
+}
+
+
+message EndCommit
+{
+  // The ID that was given by BeginCommit
+  kiapi.common.types.KIID id = 1;
+
+  // What to do with this commit
+  CommitAction action = 2;
+
+  // Optional message describing this changeset
+  string message = 3;
+}
+
+
+message EndCommitResponse
+{
+}
+
+// Creates new items on a given document
+message CreateItems
+{
+  // Specifies which document to create on, which fields are included, etc.
+  kiapi.common.types.ItemHeader header = 1;
+
+  // List of items to create
+  repeated google.protobuf.Any items = 2;
+
+  // Items may be created on a top-level document (sheet, board, etc) or inside a container
+  // (symbol, footprint).  If this field is not empty, it holds the ID of a symbol or footprint
+  // that the items should be added to.  This ID must be an existing symbol (for schematic
+  // documents) or footprint (for board documents).  If the given container does not exist or is
+  // not the correct item type, the CreateItems call will fail.
+  kiapi.common.types.KIID container = 3;
+}
+
+enum ItemStatusCode
+{
+  ISC_UNKNOWN      = 0;
+  ISC_OK           = 1; // The item was created or updated
+  ISC_INVALID_TYPE = 2; // The item's type is not valid for the given document
+  ISC_EXISTING     = 3; // The item to be created had a specified KIID and that KIID was already in use
+  ISC_NONEXISTENT  = 4; // The item to be updated did not exist in the given document
+  ISC_IMMUTABLE    = 5; // The item to be updated is not allowed to be modified by the API
+  ISC_INVALID_DATA = 7; // The item to be created does not have valid data for the given document
+}
+
+// Per-item status feedback for creation and update calls
+message ItemStatus
+{
+  ItemStatusCode code = 1;
+
+  string error_message = 2;
+}
+
+message ItemCreationResult
+{
+  ItemStatus status = 1;
+
+  // The created version of the item, including an updated KIID as applicable
+  google.protobuf.Any item = 2;
+}
+
+message CreateItemsResponse
+{
+  // Specifies which document was modified, which fields are included in created_items, etc.
+  kiapi.common.types.ItemHeader header = 1;
+
+  // Status of the overall request; may return IRS_OK even if no items were created
+  kiapi.common.types.ItemRequestStatus status = 2;
+
+  // Status of each item to be created
+  repeated ItemCreationResult created_items = 3;
+}
+
+message GetItems
+{
+  // Specifies which document to query, which fields to return, etc.
+  kiapi.common.types.ItemHeader header = 1;
+
+  // List of one or more types of items to retreive
+  repeated kiapi.common.types.KiCadObjectType types = 2;
+}
+
+message GetItemsResponse
+{
+  // Specifies which document was modified, which fields are included in items, etc.
+  kiapi.common.types.ItemHeader header = 1;
+
+  // Status of the overall request; may return IRS_OK even if no items were retrieved
+  kiapi.common.types.ItemRequestStatus status = 2;
+
+  repeated google.protobuf.Any items = 3;
+}
+
+// Updates items in a given document
+message UpdateItems
+{
+  // Specifies which document to modify, which fields are included, etc.
+  kiapi.common.types.ItemHeader header = 1;
+
+  // List of items to modify
+  repeated google.protobuf.Any items = 2;
+}
+
+
+message ItemUpdateResult
+{
+  ItemStatus status = 1;
+
+  // The update version of the item
+  google.protobuf.Any item = 2;
+}
+
+message UpdateItemsResponse
+{
+  // Specifies which document was modified, which fields are included in updated_items, etc.
+  kiapi.common.types.ItemHeader header = 1;
+
+  // Status of the overall request; may return IRS_OK even if no items were modified
+  kiapi.common.types.ItemRequestStatus status = 2;
+
+  // Status of each item to be created
+  repeated ItemUpdateResult updated_items = 3;
+}
+
+// Deletes items in a given document
+message DeleteItems
+{
+  // Specifies which document to modify
+  kiapi.common.types.ItemHeader header = 1;
+
+  // List of item KIIDs to delete
+  repeated kiapi.common.types.KIID item_ids = 2;
+}
+
+enum ItemDeletionStatus
+{
+  IDS_UNKNOWN      = 0;
+  IDS_OK           = 1;
+  IDS_NONEXISTENT  = 2; // The item did not exist in the given document
+  IDS_IMMUTABLE    = 3; // The item is not allowed to be modified by the API
+}
+
+message ItemDeletionResult
+{
+  kiapi.common.types.KIID id = 1;
+
+  ItemDeletionStatus status = 2;
+}
+
+message DeleteItemsResponse
+{
+  // Specifies which document was modified, etc.
+  kiapi.common.types.ItemHeader header = 1;
+
+  // Status of the overall request; may return IRS_OK even if no items were deleted
+  kiapi.common.types.ItemRequestStatus status = 2;
+
+  // Status of each item requested to be deleted
+  repeated ItemDeletionResult deleted_items = 3;
+}
+
+message GetItemBoundingBox
+{
+  kiapi.common.types.ItemHeader header = 1;
+
+  kiapi.common.types.KIID id = 2;
+}
+
+message BoundingBoxResponse
+{
+  kiapi.common.types.Vector2 position = 1;
+  kiapi.common.types.Vector2 size = 2;
+}
+
+// Tests if a certain point falls within tolerance of an item's geometry
+message HitTest
+{
+  kiapi.common.types.ItemHeader header = 1;
+
+  kiapi.common.types.KIID id = 2;
+
+  kiapi.common.types.Vector2 position = 3;
+
+  int32 tolerance = 4;
+}
+
+enum HitTestResult
+{
+  HTR_UNKNOWN = 0;
+  HTR_NO_HIT  = 1;
+  HTR_HIT     = 2;
+}
+
+message HitTestResponse
+{
+  HitTestResult result = 1;
+}

api/proto/common/commands/project_commands.proto

@@ -1,8 +1,7 @@
 /*
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
- * Copyright (C) 2024 3Dconnexion
- * Copyright (C) 2022 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -18,35 +17,18 @@
  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "nl_gerbview_plugin.h"
-#include "nl_gerbview_plugin_impl.h"
+syntax = "proto3";
 
-#include <advanced_config.h>
-#include <kiplatform/drivers.h>
+package kiapi.common.commands;
+
+import "common/types/project_settings.proto";
 
 
-NL_GERBVIEW_PLUGIN::NL_GERBVIEW_PLUGIN()
+message GetNetClasses
 {
-    if( ADVANCED_CFG::GetCfg().m_Use3DConnexionDriver
-        && KIPLATFORM::DRIVERS::Valid3DConnexionDriverVersion() )
-    {
-        m_impl = std::make_unique<NL_GERBVIEW_PLUGIN_IMPL>();
-    }
 }
 
-
-NL_GERBVIEW_PLUGIN::~NL_GERBVIEW_PLUGIN() = default;
-
-
-void NL_GERBVIEW_PLUGIN::SetFocus( bool focus )
+message NetClassesResponse
 {
-    if( m_impl )
-        m_impl->SetFocus( focus );
-}
-
-
-void NL_GERBVIEW_PLUGIN::SetCanvas( EDA_DRAW_PANEL_GAL* aViewport )
-{
-    if( m_impl )
-        m_impl->SetCanvas( aViewport );
+  repeated kiapi.common.project.NetClass net_classes = 1;
 }

api/proto/common/envelope.proto

@@ -0,0 +1,92 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+syntax = "proto3";
+
+package kiapi.common;
+
+import "google/protobuf/any.proto";
+
+enum ApiStatusCode
+{
+  AS_UNKNOWN        = 0;
+  AS_OK             = 1; // Request succeeded
+  AS_TIMEOUT        = 2; // Request timed out
+  AS_BAD_REQUEST    = 3; // The request had invalid parameters or otherwise was illegal
+  AS_NOT_READY      = 4; // KiCad has recently started and cannot handle API requests yet
+  AS_UNHANDLED      = 5; // The request was not handled by KiCad
+  AS_TOKEN_MISMATCH = 6; // The kicad_token in the request didn't match this KiCad's token
+  AS_BUSY           = 7; // KiCad is busy performing an operation and can't accept API commands
+  AS_UNIMPLEMENTED  = 8; // The requested API call has not yet been implemented
+}
+
+/*
+ * For future expansion: any header fields that should be sent with a request
+ */
+message ApiRequestHeader
+{
+  // An opaque string identifying a running instance of KiCad.  If this is set to a non-empty
+  // string in an API request, KiCad will reject the request if the value doesn't match its own
+  // token.  This can be used to let API clients make sure they are still talking to the same
+  // instance of KiCad if they are long-running.
+  string kicad_token = 1;
+
+  // A string identifying an API client.  Should be set by the client to a value that is unique
+  // to a specific instance of a client, for example the package name of the client plus its
+  // process ID or a random string, e.g. "com.github.me.my_awesome_plugin-73951".  The main purpose
+  // of this name is to identify the client in debug logs.
+  string client_name = 2;
+}
+
+/*
+ * The top-level envelope container for an API request (message from a client to the KiCad API server)
+ */
+message ApiRequest
+{
+  ApiRequestHeader header = 1;
+
+  google.protobuf.Any message = 2;
+}
+
+/*
+ * For future expansion: any header fields that should be sent with a response
+ */
+message ApiResponseHeader
+{
+  /// An opaque string identifying a running instance of KiCad.
+  string kicad_token = 1;
+}
+
+message ApiResponse
+{
+  ApiResponseHeader header = 1;
+
+  ApiResponseStatus status = 2;
+
+  google.protobuf.Any message = 3;
+}
+
+message ApiResponseStatus
+{
+  /// A code describing the category of error (or AS_OK if no error)
+  ApiStatusCode status = 1;
+
+  /// A human-readable description of the error, if any
+  string error_message = 2;
+}

api/proto/common/types/base_types.proto

@@ -0,0 +1,334 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * base_types.proto
+ * Includes types used in many parts of the API
+ */
+
+syntax = "proto3";
+
+package kiapi.common.types;
+
+import "google/protobuf/field_mask.proto";
+import "common/types/enums.proto";
+
+enum CommandStatus
+{
+  CS_UNKNOWN      = 0;
+  CS_OK           = 1;   // Command succeeded
+  CS_FAILED       = 2;   // Command failed
+}
+
+message CommandStatusResponse
+{
+  CommandStatus status = 1;
+}
+
+/**
+ * Describes a particular version of KiCad
+ */
+message KiCadVersion
+{
+  uint32 major = 1;
+  uint32 minor = 2;
+  uint32 patch = 3;
+
+  // Full identifier string, potentially containing git hashes, packager-added info, etc.
+  string full_version = 4;
+}
+
+/**
+ * Some commands are specific to a KiCad window (frame).  This list contains all addressable frames.
+ */
+enum FrameType
+{
+  FT_UNKNOWN              = 0;
+  FT_PROJECT_MANAGER      = 1;
+  FT_SCHEMATIC_EDITOR     = 2;
+  FT_PCB_EDITOR           = 3;
+  FT_SPICE_SIMULATOR      = 4;
+  FT_SYMBOL_EDITOR        = 5;
+  FT_FOOTPRINT_EDITOR     = 6;
+  FT_DRAWING_SHEET_EDITOR = 7;
+}
+
+/**
+ * Describes a KIID, or UUID of an object in a KiCad editor model.
+ */
+message KIID
+{
+  // The KIID's value in standard UUID format, stored as a string for easy portability
+  string value = 1;
+}
+
+/**
+ * Identifier for the type of document being targeted by a request
+ */
+enum DocumentType
+{
+  DOCTYPE_UNKNOWN       = 0;
+  DOCTYPE_SCHEMATIC     = 1;
+  DOCTYPE_SYMBOL        = 2;
+  DOCTYPE_PCB           = 3;
+  DOCTYPE_FOOTPRINT     = 4;
+  DOCTYPE_DRAWING_SHEET = 5;
+}
+
+/**
+ * Describes a KiCad LIB_ID; a unique identifier for a loaded symbol or footprint
+ */
+message LibraryIdentifier
+{
+  // The library portion of the LIB_ID
+  string library_nickname = 1;
+
+  // The symbol or footprint name
+  string entry_name = 2;
+}
+
+/**
+ * Describes a unique sheet in a schematic
+ */
+message SheetPath
+{
+  // The canonical path to the sheet.  The first KIID will be the root sheet, etc.
+  repeated KIID path = 1;
+
+  // The path converted to a human readable form such as "/", "/child", or "/child/grandchild"
+  string path_human_readable = 2;
+}
+
+/**
+ * Describes a KiCad project
+ */
+message ProjectSpecifier
+{
+  // The name of the project (without the kicad_pro extension)
+  string name = 1;
+
+  // The path to the project directory
+  string path = 2;
+}
+
+/**
+ * Describes a document that will be the target of a request
+ */
+message DocumentSpecifier
+{
+  DocumentType type = 1;
+
+  oneof identifier
+  {
+    // If type == DT_SYMBOL or DT_FOOTPRINT, identifies a certain library entry
+    LibraryIdentifier lib_id = 2;
+
+    // If type == DT_SCHEMATIC, identifies a sheet with a given path
+    SheetPath sheet_path = 3;
+
+    // If type == DT_PCB, identifies a PCB with a given filename, e.g. "board.kicad_pcb"
+    string board_filename = 4;
+  }
+
+  ProjectSpecifier project = 5;
+}
+
+/**
+ * This header is included in requests and responses about item(s) in a document
+ */
+message ItemHeader
+{
+  // Which document is this request targeting?
+  DocumentSpecifier document = 1;
+
+  // Which container within the document is this request targeting?
+  // If container is omitted or empty, the document is used as the container.
+  KIID container = 2;
+
+  // Which fields on the item(s) are included with this request or response
+  google.protobuf.FieldMask field_mask = 3;
+}
+
+/**
+ * Status of a request that included an ItemHeader
+ */
+enum ItemRequestStatus
+{
+  IRS_UNKNOWN            = 0;
+  IRS_OK                 = 1;
+  IRS_DOCUMENT_NOT_FOUND = 2;   // The given document is not open in KiCad
+  IRS_FIELD_MASK_INVALID = 3;   // The given field_mask contains invalid specifiers
+}
+
+// Describes a point or distance in 2D space.  All coordinates are in nanometers.
+message Vector2
+{
+  int64 x_nm = 1;
+  int64 y_nm = 2;
+}
+
+// Describes a point or distance in 3D space.  All coordinates are in nanometers.
+message Vector3
+{
+  int64 x_nm = 1;
+  int64 y_nm = 2;
+  int64 z_nm = 3;
+}
+
+// Describes a quantity of distance (size, length, etc).  All coordinates are in nanometers.
+message Distance
+{
+  int64 value_nm = 1;
+}
+
+// Corresponds to EDA_ANGLE, where the underlying storage is degrees
+message Angle
+{
+  double value_degrees = 1;
+}
+
+// Represents a value from 0.0 to 1.0
+message Ratio
+{
+  double value = 1;
+}
+
+// Corresponds to COLOR4D.  Each color channel is a double from 0.0 to 1.0.
+message Color
+{
+  double r = 1;
+  double g = 2;
+  double b = 3;
+  double a = 4;
+}
+
+// The formulation of arc that is used in KiCad core geometry code.
+// Start, midpoint (on the arc) and end are stored.  Angle, center point, etc are calculated.
+message ArcStartMidEnd
+{
+  Vector2 start = 1;
+  Vector2 mid   = 2;
+  Vector2 end   = 3;
+}
+
+message PolyLineNode
+{
+  oneof geometry {
+    Vector2        point = 1;
+    ArcStartMidEnd arc   = 2;
+  }
+}
+
+// Corresponds to class SHAPE_LINE_CHAIN: A closed or open polyline that can include arcs.
+// For non-arc cases, each node is a point along the line.  An implicit line segment exists
+// between the last and first node if closed is true.  When arcs are present, the arc start and
+// end points are not duplicated by point nodes (meaning, for example, a rectangle with rounded
+// corners could be represented with four arc nodes and no point nodes).
+message PolyLine
+{
+  repeated PolyLineNode nodes  = 1;
+  bool                  closed = 2;
+}
+
+message PolygonWithHoles
+{
+  PolyLine          outline = 1;
+  repeated PolyLine holes   = 2;
+}
+
+// Corresponds to SHAPE_POLY_SET: a set of polygons or polylines
+message PolySet
+{
+  repeated PolygonWithHoles polygons = 1;
+}
+
+// Describes whether or not an item is locked for editing or movement
+enum LockedState
+{
+  LS_UNKNOWN  = 0;
+  LS_UNLOCKED = 1;
+  LS_LOCKED   = 2;
+}
+
+message TextAttributes
+{
+  string                      font_name            = 1;
+  HorizontalAlignment         horizontal_alignment = 2;
+  VerticalAlignment           vertical_alignment   = 3;
+  kiapi.common.types.Angle    angle                = 4;
+  double                      line_spacing         = 5;
+  kiapi.common.types.Distance stroke_width         = 6;
+  bool                        italic               = 7;
+  bool                        bold                 = 8;
+  bool                        underlined           = 9;
+  bool                        visible              = 10;
+  bool                        mirrored             = 11;
+  bool                        multiline            = 12;
+  bool                        keep_upright         = 13;
+  kiapi.common.types.Vector2  size                 = 14;
+}
+
+message Text
+{
+  kiapi.common.types.KIID           id         = 1;
+  kiapi.common.types.Vector2        position   = 2;
+  kiapi.common.types.TextAttributes attributes = 3;
+  kiapi.common.types.LockedState    locked     = 4;
+  string                            text       = 5;
+  string                            hyperlink  = 6;
+  bool                              knockout   = 7;
+}
+
+message TextBox
+{
+  kiapi.common.types.KIID           id           = 1;
+  kiapi.common.types.Vector2        top_left     = 2;
+  kiapi.common.types.Vector2        bottom_right = 3;
+  kiapi.common.types.TextAttributes attributes   = 4;
+  kiapi.common.types.LockedState    locked       = 5;
+  string                            text         = 6;
+}
+
+message StrokeAttributes
+{
+  Distance width = 1;
+  StrokeLineStyle style = 2;
+  Color color = 3;
+}
+
+enum GraphicFillType
+{
+  GFT_UNKNOWN  = 0;
+  GFT_UNFILLED = 1;
+  GFT_FILLED   = 2;
+}
+
+message GraphicFillAttributes
+{
+  GraphicFillType fill_type = 1;
+
+  // Color of the fill (not used in board and footprints)
+  Color color = 2;
+}
+
+message GraphicAttributes
+{
+  StrokeAttributes stroke = 1;
+  GraphicFillAttributes fill = 2;
+}

api/proto/common/types/enums.proto

@@ -0,0 +1,119 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * enums.proto
+ * Includes protobuf versions of common KiCad enums
+ */
+
+syntax = "proto3";
+
+package kiapi.common.types;
+
+// The set of object types (from KICAD_T) that are exposed to the API.
+enum KiCadObjectType
+{
+  KOT_UNKNOWN = 0;
+
+  KOT_PCB_FOOTPRINT = 1;
+  KOT_PCB_PAD = 2;
+  KOT_PCB_SHAPE = 3;
+  KOT_PCB_REFERENCE_IMAGE = 4;
+  KOT_PCB_FIELD = 5;
+  KOT_PCB_GENERATOR = 6;
+  KOT_PCB_TEXT = 7;
+  KOT_PCB_TEXTBOX = 8;
+  KOT_PCB_TABLE = 9;
+  KOT_PCB_TABLECELL = 10;
+  KOT_PCB_TRACE = 11;
+  KOT_PCB_VIA = 12;
+  KOT_PCB_ARC = 13;
+  KOT_PCB_MARKER = 14;
+  KOT_PCB_DIMENSION = 15;
+  KOT_PCB_ZONE = 16;
+  KOT_PCB_GROUP = 17;
+
+  KOT_SCH_MARKER = 18;
+  KOT_SCH_JUNCTION = 19;
+  KOT_SCH_NO_CONNECT = 20;
+  KOT_SCH_BUS_WIRE_ENTRY = 21;
+  KOT_SCH_BUS_BUS_ENTRY = 22;
+  KOT_SCH_LINE = 23;
+  KOT_SCH_SHAPE = 24;
+  KOT_SCH_BITMAP = 25;
+  KOT_SCH_TEXTBOX = 26;
+  KOT_SCH_TEXT = 27;
+  KOT_SCH_TABLE = 28;
+  KOT_SCH_TABLECELL = 29;
+  KOT_SCH_LABEL = 30;
+  KOT_SCH_GLOBAL_LABEL = 31;
+  KOT_SCH_HIER_LABEL = 32;
+  KOT_SCH_DIRECTIVE_LABEL = 33;
+  KOT_SCH_FIELD = 34;
+  KOT_SCH_SYMBOL = 35;
+  KOT_SCH_SHEET_PIN = 36;
+  KOT_SCH_SHEET = 37;
+  KOT_SCH_PIN = 38;
+
+  KOT_LIB_SYMBOL = 39;
+//  KOT_LIB_SHAPE = 40;
+//  KOT_LIB_TEXT = 41;
+//  KOT_LIB_TEXTBOX = 42;
+//  KOT_LIB_PIN = 43;
+//  KOT_LIB_FIELD = 44;
+
+  KOT_WSG_LINE = 45;
+  KOT_WSG_RECT = 46;
+  KOT_WSG_POLY = 47;
+  KOT_WSG_TEXT = 48;
+  KOT_WSG_BITMAP = 49;
+  KOT_WSG_PAGE = 50;
+}
+
+// Mapped to GR_TEXT_H_ALIGN_T
+enum HorizontalAlignment
+{
+  HA_UNKNOWN       = 0;
+  HA_LEFT          = 1;
+  HA_CENTER        = 2;
+  HA_RIGHT         = 3;
+  HA_INDETERMINATE = 4;
+}
+
+// Mapped to GR_TEXT_V_ALIGN_T
+enum VerticalAlignment
+{
+  VA_UNKNOWN       = 0;
+  VA_TOP           = 1;
+  VA_CENTER        = 2;
+  VA_BOTTOM        = 3;
+  VA_INDETERMINATE = 4;
+}
+
+// Mapped to LINE_STYLE
+enum StrokeLineStyle
+{
+  SLS_UNKNOWN    = 0;
+  SLS_DEFAULT    = 1;
+  SLS_SOLID      = 2;
+  SLS_DASH       = 3;
+  SLS_DOT        = 4;
+  SLS_DASHDOT    = 5;
+  SLS_DASHDOTDOT = 6;
+}

api/proto/common/types/project_settings.proto

@@ -0,0 +1,35 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * project_settings.proto
+ * Messages that describes project settings shared between schematics and boards
+ */
+
+syntax = "proto3";
+
+package kiapi.common.project;
+
+
+message NetClass
+{
+  // The name of the netclass (the literal string "Default" for the default netclass)
+  string name = 1;
+
+}

api/proto/schematic/schematic_commands.proto

@@ -0,0 +1,24 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+syntax = "proto3";
+
+package kiapi.schematic.types;
+
+

api/proto/schematic/schematic_types.proto

@@ -0,0 +1,75 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+syntax = "proto3";
+
+package kiapi.schematic.types;
+
+import "common/types/base_types.proto";
+
+enum SchematicLayer
+{
+  SL_UNKNOWN = 0;
+}
+
+/// Represents a schematic line segment, which may be a wire, bus, or graphical line
+message Line
+{
+  kiapi.common.types.KIID    id     = 1;
+  kiapi.common.types.Vector2 start  = 2;
+  kiapi.common.types.Vector2 end    = 3;
+
+  /**
+   * One of: LAYER_BUS, LAYER_WIRE, LAYER_NOTES
+   */
+  SchematicLayer layer = 4;
+}
+
+message Text
+{
+  kiapi.common.types.Text text = 1;
+}
+
+message LocalLabel
+{
+  kiapi.common.types.KIID    id       = 1;
+  kiapi.common.types.Vector2 position = 2;
+  Text                       text     = 3;
+}
+
+message GlobalLabel
+{
+  kiapi.common.types.KIID    id       = 1;
+  kiapi.common.types.Vector2 position = 2;
+  Text                       text     = 3;
+}
+
+message HierarchicalLabel
+{
+  kiapi.common.types.KIID    id       = 1;
+  kiapi.common.types.Vector2 position = 2;
+  Text                       text     = 3;
+}
+
+message DirectiveLabel
+{
+  kiapi.common.types.KIID    id       = 1;
+  kiapi.common.types.Vector2 position = 2;
+  Text                       text     = 3;
+}

bitmap2component/CMakeLists.txt

@@ -52,6 +52,7 @@ add_executable( bitmap2component WIN32 MACOSX_BUNDLE
 
 target_link_libraries( bitmap2component
     common
+    kicommon
     ${wxWidgets_LIBRARIES}
     potrace
     )

bitmap2component/bitmap2cmp_main.cpp

@@ -69,8 +69,6 @@ static struct IFACE : public KIFACE_BASE
 
 using namespace BMP2CMP;
 
-static PGM_BASE* process;
-
 
 KIFACE_BASE& Kiface()
 {
@@ -82,27 +80,10 @@ KIFACE_BASE& Kiface()
 // KIFACE_GETTER will not have name mangling due to declaration in kiway.h.
 KIFACE* KIFACE_GETTER( int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram )
 {
-    process = (PGM_BASE*) aProgram;
     return &kiface;
 }
 
 
-#if defined(BUILD_KIWAY_DLLS)
-PGM_BASE& Pgm()
-{
-    wxASSERT( process );    // KIFACE_GETTER has already been called.
-    return *process;
-}
-
-
-// Similar to PGM_BASE& Pgm(), but return nullptr when a *.ki_face is run from a python script.
-PGM_BASE* PgmOrNull()
-{
-    return process;
-}
-#endif
-
-
 bool IFACE::OnKifaceStart( PGM_BASE* aProgram, int aCtlBits, KIWAY* aKiway )
 {
     return start_common( aCtlBits );

cmake/BuildSteps/CreateDocsetDoxyfile.cmake

@@ -36,7 +36,9 @@ endfunction()
 get_kicad_doc_version(KICAD_DOC_VERSION)
 
 # copy and modify the "normal" Doxyfile
-file(COPY ${SRC_DOXYFILE} DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
+cmake_path(GET DOCSET_DOXYFILE PARENT_PATH OUTPUT_DIR)
+file(MAKE_DIRECTORY ${OUTPUT_DIR})
+file(COPY_FILE ${SRC_DOXYFILE} ${DOCSET_DOXYFILE})
 file(APPEND ${DOCSET_DOXYFILE} "
 
 # Added for DocSet generation

cmake/ConfigurePlatform.cmake

@@ -53,6 +53,9 @@ if( MSVC )
     # This is a workaround borrowed from https://github.com/dotnet/runtime/blob/main/eng/native/configurecompiler.cmake
     # CMake currently cannot handle the fact that "armasm" is used in combination with standard MSVC "cl" for ARM targets
     # So this is basically a hack (incombination with the MSVCAssemblyHelper.cmake) to make this all work
+
+    # This workaround can be removed when https://gitlab.kitware.com/cmake/cmake/-/merge_requests/9326 is finally part of a
+    # cmake release AND when MSVC ships said cmake release
     if(KICAD_BUILD_ARCH_ARM)
         message( "Configuring ARM assembler" )
         # Explicitly specify the assembler to be used for Arm32 compile

cmake/FindOCC.cmake

@@ -86,6 +86,7 @@ set( OCC_LIBS_POST_78
     TKDEGLTF
     TKDESTEP
     TKDESTL
+    TKDEVRML
 )
 
 set(OCC_TYPE "OpenCASCADE Standard Edition")

cmake/FindSWIG.cmake

@@ -55,7 +55,7 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-find_program(SWIG_EXECUTABLE NAMES swig4.2 swig4.1 swig4.0 swig3.0 swig2.0 swig)
+find_program(SWIG_EXECUTABLE NAMES swig4.0 swig3.0 swig2.0 swig)
 
 if(SWIG_EXECUTABLE)
   execute_process(COMMAND ${SWIG_EXECUTABLE} -swiglib

cmake/Findnng.cmake

@@ -0,0 +1,26 @@
+find_package(PkgConfig)
+
+if(PKG_CONFIG_FOUND)
+    pkg_check_modules(_NNG nng)
+endif (PKG_CONFIG_FOUND)
+
+FIND_PATH(NNG_INCLUDE_DIR
+    NAMES
+        nng/nng.h
+    PATH_SUFFIXES
+        include
+    )
+
+FIND_LIBRARY(NNG_LIBRARY
+    NAMES
+        nng
+    PATH_SUFFIXES
+        "lib"
+        "local/lib"
+    )
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(nng
+        REQUIRED_VARS NNG_INCLUDE_DIR NNG_LIBRARY)
+
+MARK_AS_ADVANCED(NNG_INCLUDE_DIR NNG_LIBRARY)

cmake/FindwxWidgets.cmake

@@ -523,6 +523,8 @@ if(wxWidgets_FIND_STYLE STREQUAL "win32")
     if(BUILD_SHARED_LIBS)
       find_path(wxWidgets_LIB_DIR
       NAMES
+        qtu/wx/setup.h
+        qtud/wx/setup.h
         msw/wx/setup.h
         mswd/wx/setup.h
         mswu/wx/setup.h
@@ -540,6 +542,8 @@ if(wxWidgets_FIND_STYLE STREQUAL "win32")
     else()
       find_path(wxWidgets_LIB_DIR
       NAMES
+        qtu/wx/setup.h
+        qtud/wx/setup.h
         msw/wx/setup.h
         mswd/wx/setup.h
         mswu/wx/setup.h
@@ -571,7 +575,7 @@ if(wxWidgets_FIND_STYLE STREQUAL "win32")
       endif()
 
       # Search for available configuration types.
-      foreach(CFG mswunivud mswunivd mswud mswd mswunivu mswuniv mswu msw)
+      foreach(CFG mswunivud mswunivd mswud mswd mswunivu mswuniv mswu msw qt qtd qtu qtud)
         set(WX_${CFG}_FOUND FALSE)
         if(EXISTS ${WX_LIB_DIR}/${CFG})
           list(APPEND WX_CONFIGURATION_LIST ${CFG})

cmake/KiCadQABuildUtils.cmake

@@ -62,7 +62,7 @@ if( KICAD_TEST_XML_OUTPUT )
     # Due to Boost issue in 1.62, have to use the --logger parameter, rather than
     # separate --log_format, --log_sink, etc parameter
     # https://svn.boost.org/trac10/ticket/12507
-    set(BOOST_TEST_PARAMS --logger=JUNIT,warning,${TEST_NAME}.boost-results.xml:HRF,warning)
+    set(BOOST_TEST_PARAMS --logger=JUNIT,warning,${TEST_NAME}.boost-results.xml:HRF,message)
 endif()
 
 # Add the test to the CTest registry

cmake/KiCadVersion.cmake

@@ -2,7 +2,7 @@
 #  This program source code file is part of KICAD, a free EDA CAD application.
 #
 #  Copyright (C) 2016 Wayne Stambaugh <stambaughw@gmail.com>
-#  Copyright (C) 2016-2024 KiCad Developers, see AUTHORS.txt for contributors.
+#  Copyright (C) 2016-2023 KiCad Developers, see AUTHORS.txt for contributors.
 #
 #  This program is free software; you can redistribute it and/or
 #  modify it under the terms of the GNU General Public License
@@ -37,7 +37,7 @@
 # KiCad.
 #
 # Note: This version string should follow the semantic versioning system
-set( KICAD_SEMANTIC_VERSION "8.0.7" )
+set( KICAD_SEMANTIC_VERSION "8.99.0-unknown" )
 
 # Default the version to the semantic version.
 # This is overridden by the git repository tag though (if using git)

cmake/Warnings.cmake

@@ -272,4 +272,6 @@ if( MSVC )
     string( APPEND WARN_FLAGS_CXX " /wd4668" )
     # disable "definition of implicit copy constructor for 'X' is deprecated because it has a user-provided destructor"
     string( APPEND WARN_FLAGS_CXX " /wd5267" )
+    # disable "reinterpret_cast used between related classes"
+    string( APPEND WARN_FLAGS_CXX " /wd4946" )
 endif()

common/CMakeLists.txt

@@ -41,24 +41,11 @@ add_custom_target(
         -DSRC_PATH=${PROJECT_SOURCE_DIR}
         -DKICAD_CMAKE_MODULE_PATH=${KICAD_CMAKE_MODULE_PATH}
         -P ${KICAD_CMAKE_MODULE_PATH}/BuildSteps/WriteVersionHeader.cmake
-    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
-    BYPRODUCTS ${CMAKE_BINARY_DIR}/kicad_build_version.h
+    WORKING_DIRECTORY ${CMAKE_BINARY_DIR} BYPRODUCTS ${CMAKE_BINARY_DIR}/kicad_build_version.h
     DEPENDS ${KICAD_CMAKE_MODULE_PATH}/BuildSteps/WriteVersionHeader.cmake
     COMMENT "Generating version string header"
     )
 
-# A shared library subsetted from common which restricts what can go into
-# a single_top link image.  By not linking to common, we control what does
-# statically go into single_top link images.  My current thinking is that only
-# wxWidgets should be a shared link from single top, everything else should be
-# statically bound into it. Otherwise you will have DSO loading probs. After it
-# sets the LIB PATHS however, we want the *.kiface modules to use shared linking.
-add_library( singletop STATIC EXCLUDE_FROM_ALL
-    eda_doc.cpp
-    kiway.cpp
-    kiway_holder.cpp )
-
-
 # A shared library used by multiple *.kiface files and one or two program
 # launchers.  Object files can migrate into here over time, but only if they are
 # surely needed and certainly used from more than one place without recompilation.
@@ -88,6 +75,7 @@ set( KICOMMON_SRCS
     jobs/job_export_sch_pythonbom.cpp
     jobs/job_fp_export_svg.cpp
     jobs/job_fp_upgrade.cpp
+    jobs/job_pcb_render.cpp
     jobs/job_pcb_drc.cpp
     jobs/job_sch_erc.cpp
     jobs/job_sym_export_svg.cpp
@@ -96,45 +84,111 @@ set( KICOMMON_SRCS
     kicad_curl/kicad_curl.cpp
     kicad_curl/kicad_curl_easy.cpp
 
+    settings/app_settings.cpp
+    settings/aui_settings.cpp
+    settings/bom_settings.cpp
+    settings/color_settings.cpp
+    settings/common_settings.cpp
+    settings/grid_settings.cpp
+    settings/json_settings.cpp
+    settings/kicad_settings.cpp
+    settings/nested_settings.cpp
+    settings/parameters.cpp
+    settings/settings_manager.cpp
+
+    project/board_project_settings.cpp
+    project/net_settings.cpp
+    project/project_archiver.cpp
+    project/project_file.cpp
+    project/project_local_settings.cpp
+
+    dialogs/dialog_migrate_settings.cpp
+    dialogs/dialog_migrate_settings_base.cpp
+
+    widgets/bitmap_button.cpp
+    widgets/kistatusbar.cpp
     widgets/progress_reporter_base.cpp
     widgets/std_bitmap_button.cpp
+    widgets/ui_common.cpp
+
+    database/database_lib_settings.cpp
 
     advanced_config.cpp
     asset_archive.cpp
     array_axis.cpp
     array_options.cpp
+    background_jobs_monitor.cpp
+    bitmap.cpp
     bitmap_info.cpp
+    bitmap_store.cpp
     build_version.cpp
+    common.cpp
     config_params.cpp
     confirm.cpp
+    dialog_shim.cpp
     dsnlexer.cpp
     eda_pattern_match.cpp
     eda_units.cpp
+    env_vars.cpp
     exceptions.cpp
+    gestfich.cpp
+    json_conversions.cpp
+    kidialog.cpp
     kiid.cpp
+    kiway.cpp
+    kiway_express.cpp
+    kiway_holder.cpp
+    launch_ext.cpp
+    lib_table_base.cpp
     layer_id.cpp
     lib_id.cpp
     locale_io.cpp
     lset.cpp
     markup_parser.cpp
     netclass.cpp
+    notifications_manager.cpp
     page_info.cpp
     paths.cpp
+    project.cpp
     richio.cpp
+    search_stack.cpp
+    searchhelpfilefullpath.cpp
     string_utils.cpp
+    systemdirsappend.cpp
+    ui_events.cpp
     trace_helpers.cpp
     wildcards_and_files_ext.cpp
     wx_filename.cpp
 
+    pgm_base.cpp
+
+    ../scripting/python_scripting.cpp
+
     io/kicad/kicad_io_utils.cpp    # needed by richio
     )
 
+if( KICAD_IPC_API )
+    set( KICOMMON_SRCS
+        ${KICOMMON_SRCS}
+        api/api_handler.cpp
+        api/api_handler_common.cpp
+        api/api_plugin.cpp
+        api/api_plugin_manager.cpp
+        api/api_server.cpp
+
+        ../scripting/python_manager.cpp
+    )
+endif()
+
 add_library( kicommon SHARED
     ${KICOMMON_SRCS}
     )
 
+set_target_properties(kicommon PROPERTIES CXX_VISIBILITY_PRESET hidden)
+
 target_link_libraries( kicommon
     core
+    kiapi
     kimath
     kiplatform
     nlohmann_json
@@ -150,8 +204,25 @@ target_link_libraries( kicommon
    	${FREETYPE_LIBRARIES}
    	${HarfBuzz_LIBRARIES}
 	${Fontconfig_LIBRARIES}
+
+    # needed because of python_scripting.cpp
+    ${PYTHON_LIBRARIES}
     )
 
+
+if( KICAD_USE_SENTRY )
+    target_link_libraries( kicommon
+        sentry )
+
+    set_property(SOURCE pgm_base.cpp APPEND PROPERTY COMPILE_DEFINITIONS KICAD_SENTRY_DSN="${KICAD_SENTRY_DSN}")
+endif()
+
+if( KICAD_IPC_API )
+    target_link_libraries( kicommon
+        kinng
+        )
+endif()
+
 include( ${KICAD_CMAKE_MODULE_PATH}/KiCadVersion.cmake )
 include( ${KICAD_CMAKE_MODULE_PATH}/CreateGitVersionHeader.cmake )
 create_git_version_header(${CMAKE_SOURCE_DIR})
@@ -191,7 +262,10 @@ target_include_directories( kicommon
     PUBLIC
         .
         ${CMAKE_BINARY_DIR}
+        $<TARGET_PROPERTY:magic_enum,INTERFACE_INCLUDE_DIRECTORIES>
         $<TARGET_PROPERTY:pegtl,INTERFACE_INCLUDE_DIRECTORIES>
+        $<TARGET_PROPERTY:expected,INTERFACE_INCLUDE_DIRECTORIES>
+        $<TARGET_PROPERTY:kiapi,INTERFACE_INCLUDE_DIRECTORIES>
     )
 
 add_dependencies( kicommon pegtl version_header )
@@ -239,8 +313,6 @@ set( COMMON_DLG_SRCS
     dialogs/dialog_import_choose_project_base.cpp
     dialogs/dialog_locked_items_query.cpp
     dialogs/dialog_locked_items_query_base.cpp
-    dialogs/dialog_migrate_settings.cpp
-    dialogs/dialog_migrate_settings_base.cpp
     dialogs/dialog_page_settings_base.cpp
     dialogs/dialog_paste_special.cpp
     dialogs/dialog_paste_special_base.cpp
@@ -275,6 +347,8 @@ set( COMMON_DLG_SRCS
     dialogs/panel_mouse_settings_base.cpp
     dialogs/panel_packages_and_updates.cpp
     dialogs/panel_packages_and_updates_base.cpp
+    dialogs/panel_plugin_settings.cpp
+    dialogs/panel_plugin_settings_base.cpp
     dialogs/panel_setup_netclasses.cpp
     dialogs/panel_setup_netclasses_base.cpp
     dialogs/panel_setup_severities.cpp
@@ -290,7 +364,6 @@ endif()
 
 set( COMMON_WIDGET_SRCS
     widgets/app_progress_dialog.cpp
-    widgets/bitmap_button.cpp
     widgets/bitmap_toggle.cpp
     widgets/button_row_panel.cpp
     widgets/color_swatch.cpp
@@ -311,7 +384,6 @@ set( COMMON_WIDGET_SRCS
     widgets/html_window.cpp
     widgets/indicator_icon.cpp
     widgets/wx_infobar.cpp
-    widgets/kistatusbar.cpp
     widgets/layer_box_selector.cpp
     widgets/lib_tree.cpp
     widgets/mathplot.cpp
@@ -325,7 +397,6 @@ set( COMMON_WIDGET_SRCS
     widgets/split_button.cpp
     widgets/stepped_slider.cpp
     widgets/text_ctrl_eval.cpp
-    widgets/ui_common.cpp
     widgets/unit_binder.cpp
     widgets/widget_save_restore.cpp
     widgets/widget_hotkey_list.cpp
@@ -444,17 +515,12 @@ set( COMMON_SRCS
     ${COMMON_IMPORT_GFX_SRCS}
     ${COMMON_GIT_SRCS}
     jobs/job_dispatcher.cpp
-    background_jobs_monitor.cpp
     base_screen.cpp
     bin_mod.cpp
-    bitmap.cpp
     bitmap_base.cpp
-    bitmap_store.cpp
     board_printout.cpp
     cli_progress_reporter.cpp
     commit.cpp
-    common.cpp
-    dialog_shim.cpp
     dpi_scaling_common.cpp
     draw_panel_gal.cpp
     gal_display_options_common.cpp
@@ -468,7 +534,6 @@ set( COMMON_SRCS
     eda_text.cpp
     eda_tools.cpp
     env_paths.cpp
-    env_vars.cpp
     executable_names.cpp
     filename_resolver.cpp
     file_history.cpp
@@ -476,38 +541,27 @@ set( COMMON_SRCS
     footprint_filter.cpp
     footprint_info.cpp
     gbr_metadata.cpp
-    gestfich.cpp
     gr_basic.cpp
     grid_tricks.cpp
     hotkey_store.cpp
     hotkeys_basic.cpp
     kiface_base.cpp
-    kiway.cpp
-    kiway_express.cpp
-    kiway_holder.cpp
     kiway_player.cpp
-    launch_ext.cpp
-    lib_table_base.cpp
     lib_table_grid_tricks.cpp
     lib_tree_model.cpp
     lib_tree_model_adapter.cpp
     marker_base.cpp
-    notifications_manager.cpp
     origin_transforms.cpp
     printout.cpp
-    project.cpp
     ptree.cpp
     rc_item.cpp
     refdes_utils.cpp
     render_settings.cpp
     reporter.cpp
     scintilla_tricks.cpp
-    search_stack.cpp
-    searchhelpfilefullpath.cpp
     status_popup.cpp
     string_utf8_map.cpp
     stroke_params.cpp
-    systemdirsappend.cpp
     template_fieldnames.cpp
     textentry_tricks.cpp
     title_block.cpp
@@ -518,16 +572,6 @@ set( COMMON_SRCS
     view/wx_view_controls.cpp
     )
 
-if( TRUE OR NOT USE_KIWAY_DLLS )
-#if( NOT USE_KIWAY_DLLS )
-    # We DO NOT want pgm_base.cpp linked into the KIFACE, only into the KIWAY.
-    # Check the map files to verify eda_pgm.o not being linked in.
-    list( APPEND COMMON_SRCS pgm_base.cpp )
-    if( KICAD_USE_SENTRY )
-        set_property(SOURCE pgm_base.cpp APPEND PROPERTY COMPILE_DEFINITIONS KICAD_SENTRY_DSN="${KICAD_SENTRY_DSN}")
-    endif()
-endif()
-
 set( COMMON_SRCS
     ${COMMON_SRCS}
 
@@ -538,6 +582,7 @@ set( COMMON_SRCS
     tool/action_toolbar.cpp
     tool/actions.cpp
     tool/common_control.cpp
+    tool/library_editor_control.cpp
     tool/common_tools.cpp
     tool/conditional_menu.cpp
     tool/edit_constraints.cpp
@@ -561,24 +606,7 @@ set( COMMON_SRCS
     tool/zoom_menu.cpp
     tool/zoom_tool.cpp
 
-    settings/app_settings.cpp
-    settings/aui_settings.cpp
-    settings/bom_settings.cpp
-    settings/color_settings.cpp
     settings/cvpcb_settings.cpp
-    settings/common_settings.cpp
-    settings/grid_settings.cpp
-    settings/json_settings.cpp
-    settings/nested_settings.cpp
-    settings/parameters.cpp
-    settings/settings_manager.cpp
-    settings/kicad_settings.cpp
-
-    project/board_project_settings.cpp
-    project/net_settings.cpp
-    project/project_archiver.cpp
-    project/project_file.cpp
-    project/project_local_settings.cpp
 
     properties/color4d_variant.cpp
     properties/eda_angle_variant.cpp
@@ -589,13 +617,21 @@ set( COMMON_SRCS
     properties/std_optional_variants.cpp
 
     database/database_connection.cpp
-    database/database_lib_settings.cpp
 
     http_lib/http_lib_connection.cpp
     http_lib/http_lib_settings.cpp
 
+    api/api_enums.cpp
+    api/api_utils.cpp
     )
 
+if( KICAD_IPC_API )
+    set( COMMON_SRCS
+        ${COMMON_SRCS}
+        api/api_handler_editor.cpp
+    )
+endif()
+
 add_library( common STATIC
     ${COMMON_SRCS}
     )
@@ -635,28 +671,32 @@ if( KICAD_USE_SENTRY )
         sentry )
 endif()
 
+if( KICAD_IPC_API )
+    target_link_libraries( common
+        kinng
+        )
+endif()
+
 target_include_directories( common
     PUBLIC
         .
         ${CMAKE_BINARY_DIR}
         $<TARGET_PROPERTY:argparse::argparse,INTERFACE_INCLUDE_DIRECTORIES>
+        $<TARGET_PROPERTY:kiapi,INTERFACE_INCLUDE_DIRECTORIES>
     )
 
 # text markup support
 add_dependencies( common pegtl )
+
 target_include_directories( common PUBLIC
     $<TARGET_PROPERTY:pegtl,INTERFACE_INCLUDE_DIRECTORIES>
+    $<TARGET_PROPERTY:magic_enum,INTERFACE_INCLUDE_DIRECTORIES>
     )
 
 target_include_directories( common SYSTEM PUBLIC
     $<TARGET_PROPERTY:nanodbc,INTERFACE_INCLUDE_DIRECTORIES>
     )
 
-target_include_directories( common PUBLIC
-    $<TARGET_PROPERTY:magic_enum,INTERFACE_INCLUDE_DIRECTORIES>
-    )
-
-
 set( PCB_COMMON_SRCS
     fp_lib_table.cpp
     hash_eda.cpp
@@ -679,9 +719,12 @@ set( PCB_COMMON_SRCS
     ${CMAKE_SOURCE_DIR}/pcbnew/netinfo_item.cpp
     ${CMAKE_SOURCE_DIR}/pcbnew/netinfo_list.cpp
     ${CMAKE_SOURCE_DIR}/pcbnew/pad.cpp
+    ${CMAKE_SOURCE_DIR}/pcbnew/padstack.cpp
     ${CMAKE_SOURCE_DIR}/pcbnew/pcb_target.cpp
     ${CMAKE_SOURCE_DIR}/pcbnew/pcb_reference_image.cpp
     ${CMAKE_SOURCE_DIR}/pcbnew/pcb_field.cpp
+    ${CMAKE_SOURCE_DIR}/pcbnew/pcb_table.cpp
+    ${CMAKE_SOURCE_DIR}/pcbnew/pcb_tablecell.cpp
     ${CMAKE_SOURCE_DIR}/pcbnew/pcb_text.cpp
     ${CMAKE_SOURCE_DIR}/pcbnew/pcb_textbox.cpp
     ${CMAKE_SOURCE_DIR}/pcbnew/project_pcb.cpp
@@ -742,6 +785,12 @@ set( PCB_COMMON_SRCS
     widgets/net_selector.cpp
 )
 
+set( PCB_COMMON_SRCS
+    ${PCB_COMMON_SRCS}
+    ${CMAKE_SOURCE_DIR}/pcbnew/api/api_pcb_enums.cpp
+    ${CMAKE_SOURCE_DIR}/pcbnew/api/api_pcb_utils.cpp
+)
+
 # add -DPCBNEW to compilation of these PCBNEW sources
 set_source_files_properties( ${PCB_COMMON_SRCS} PROPERTIES
     COMPILE_DEFINITIONS "PCBNEW"
@@ -768,7 +817,7 @@ add_dependencies( pcbcommon delaunator )
 
 # The lemon grammar for the numeric evaluator
 generate_lemon_grammar(
-    common
+    kicommon
     libeval
     libeval/numeric_evaluator.cpp
     libeval/grammar.lemon
@@ -776,7 +825,7 @@ generate_lemon_grammar(
 
 # The lemon grammar for the expression compiler
 generate_lemon_grammar(
-    common
+    kicommon
     libeval_compiler
     libeval_compiler/libeval_compiler.cpp
     libeval_compiler/grammar.lemon

common/advanced_config.cpp

@@ -100,6 +100,7 @@ static const wxChar V3DRT_BevelExtentFactor[] = wxT( "V3DRT_BevelExtentFactor" )
 static const wxChar UseClipper2[] = wxT( "UseClipper2" );
 static const wxChar EnableGenerators[] = wxT( "EnableGenerators" );
 static const wxChar EnableGit[] = wxT( "EnableGit" );
+static const wxChar EnableLibWithText[] = wxT( "EnableLibWithText" );
 static const wxChar EnableEeschemaPrintCairo[] = wxT( "EnableEeschemaPrintCairo" );
 static const wxChar DisambiguationTime[] = wxT( "DisambiguationTime" );
 static const wxChar PcbSelectionVisibilityRatio[] = wxT( "PcbSelectionVisibilityRatio" );
@@ -109,7 +110,9 @@ static const wxChar OcePluginAngularDeflection[] = wxT( "OcePluginAngularDeflect
 static const wxChar TriangulateSimplificationLevel[] = wxT( "TriangulateSimplificationLevel" );
 static const wxChar TriangulateMinimumArea[] = wxT( "TriangulateMinimumArea" );
 static const wxChar EnableCacheFriendlyFracture[] = wxT( "EnableCacheFriendlyFracture" );
-static const wxChar MinParallelAngle[] = wxT( "MinParallelAngle" );
+static const wxChar EnableAPILogging[] = wxT( "EnableAPILogging" );
+static const wxChar MaxFileSystemWatchers[] = wxT( "MaxFileSystemWatchers" );
+static const wxChar MinorSchematicGraphSize[] = wxT( "MinorSchematicGraphSize" );
 } // namespace KEYS
 
 
@@ -236,6 +239,7 @@ ADVANCED_CFG::ADVANCED_CFG()
     m_ShowRepairSchematic       = false;
     m_EnableGenerators          = false;
     m_EnableGit                 = false;
+    m_EnableLibWithText         = false;
 
     m_EnableEeschemaPrintCairo  = true;
 
@@ -243,6 +247,7 @@ ADVANCED_CFG::ADVANCED_CFG()
     m_3DRT_BevelExtentFactor    = 1.0 / 16.0;
 
     m_UseClipper2               = true;
+    m_EnableAPILogging          = false;
 
     m_Use3DConnexionDriver      = true;
 
@@ -262,7 +267,9 @@ ADVANCED_CFG::ADVANCED_CFG()
 
     m_EnableCacheFriendlyFracture = true;
 
-    m_MinParallelAngle = 0.001;
+    m_MaxFilesystemWatchers = 16384;
+
+    m_MinorSchematicGraphSize = 10000;
 
     loadFromConfigFile();
 }
@@ -445,9 +452,15 @@ void ADVANCED_CFG::loadSettings( wxConfigBase& aCfg )
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableGenerators,
                                                 &m_EnableGenerators, m_EnableGenerators ) );
 
+    configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableAPILogging,
+                                                &m_EnableAPILogging, m_EnableAPILogging ) );
+
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableGit,
                                                 &m_EnableGit, m_EnableGit ) );
 
+    configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableLibWithText,
+                                                &m_EnableLibWithText, m_EnableLibWithText ) );
+
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableEeschemaPrintCairo,
                                                 &m_EnableEeschemaPrintCairo,
                                                 m_EnableEeschemaPrintCairo ) );
@@ -480,9 +493,13 @@ void ADVANCED_CFG::loadSettings( wxConfigBase& aCfg )
                                                 &m_EnableCacheFriendlyFracture,
                                                 m_EnableCacheFriendlyFracture ) );
 
-    configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MinParallelAngle,
-                                                  &m_MinParallelAngle, m_MinParallelAngle,
-                                                  0.0, 45.0 ) );
+    configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::MaxFileSystemWatchers,
+                                                  &m_MaxFilesystemWatchers, m_MaxFilesystemWatchers,
+                                                  0, 2147483647 ) );
+
+    configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::MinorSchematicGraphSize,
+                                                  &m_MinorSchematicGraphSize, m_MinorSchematicGraphSize,
+                                                  0, 2147483647 ) );
 
     // Special case for trace mask setting...we just grab them and set them immediately
     // Because we even use wxLogTrace inside of advanced config

common/api/api_enums.cpp

@@ -0,0 +1,426 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <api/api_enums.h>
+#include <import_export.h>
+#include <api/common/types/enums.pb.h>
+#include <api/board/board_types.pb.h>
+#include <api/schematic/schematic_types.pb.h>
+
+#include <core/typeinfo.h>
+#include <font/text_attributes.h>
+#include <layer_ids.h>
+#include <stroke_params.h>
+
+using namespace kiapi;
+using namespace kiapi::common;
+
+template<>
+KICAD_T FromProtoEnum( types::KiCadObjectType aValue )
+{
+    switch( aValue )
+    {
+    case types::KiCadObjectType::KOT_PCB_FOOTPRINT:         return PCB_FOOTPRINT_T;
+    case types::KiCadObjectType::KOT_PCB_PAD:               return PCB_PAD_T;
+    case types::KiCadObjectType::KOT_PCB_SHAPE:             return PCB_SHAPE_T;
+    case types::KiCadObjectType::KOT_PCB_REFERENCE_IMAGE:   return PCB_REFERENCE_IMAGE_T;
+    case types::KiCadObjectType::KOT_PCB_FIELD:             return PCB_FIELD_T;
+    case types::KiCadObjectType::KOT_PCB_GENERATOR:         return PCB_GENERATOR_T;
+    case types::KiCadObjectType::KOT_PCB_TEXT:              return PCB_TEXT_T;
+    case types::KiCadObjectType::KOT_PCB_TEXTBOX:           return PCB_TEXTBOX_T;
+    case types::KiCadObjectType::KOT_PCB_TABLE:             return PCB_TABLE_T;
+    case types::KiCadObjectType::KOT_PCB_TABLECELL:         return PCB_TABLECELL_T;
+    case types::KiCadObjectType::KOT_PCB_TRACE:             return PCB_TRACE_T;
+    case types::KiCadObjectType::KOT_PCB_VIA:               return PCB_VIA_T;
+    case types::KiCadObjectType::KOT_PCB_ARC:               return PCB_ARC_T;
+    case types::KiCadObjectType::KOT_PCB_MARKER:            return PCB_MARKER_T;
+    case types::KiCadObjectType::KOT_PCB_DIMENSION:         return PCB_DIMENSION_T;
+    case types::KiCadObjectType::KOT_PCB_ZONE:              return PCB_ZONE_T;
+    case types::KiCadObjectType::KOT_PCB_GROUP:             return PCB_GROUP_T;
+    case types::KiCadObjectType::KOT_SCH_MARKER:            return SCH_MARKER_T;
+    case types::KiCadObjectType::KOT_SCH_JUNCTION:          return SCH_JUNCTION_T;
+    case types::KiCadObjectType::KOT_SCH_NO_CONNECT:        return SCH_NO_CONNECT_T;
+    case types::KiCadObjectType::KOT_SCH_BUS_WIRE_ENTRY:    return SCH_BUS_WIRE_ENTRY_T;
+    case types::KiCadObjectType::KOT_SCH_BUS_BUS_ENTRY:     return SCH_BUS_BUS_ENTRY_T;
+    case types::KiCadObjectType::KOT_SCH_LINE:              return SCH_LINE_T;
+    case types::KiCadObjectType::KOT_SCH_SHAPE:             return SCH_SHAPE_T;
+    case types::KiCadObjectType::KOT_SCH_BITMAP:            return SCH_BITMAP_T;
+    case types::KiCadObjectType::KOT_SCH_TEXTBOX:           return SCH_TEXTBOX_T;
+    case types::KiCadObjectType::KOT_SCH_TEXT:              return SCH_TEXT_T;
+    case types::KiCadObjectType::KOT_SCH_TABLE:             return SCH_TABLE_T;
+    case types::KiCadObjectType::KOT_SCH_TABLECELL:         return SCH_TABLECELL_T;
+    case types::KiCadObjectType::KOT_SCH_LABEL:             return SCH_LABEL_T;
+    case types::KiCadObjectType::KOT_SCH_GLOBAL_LABEL:      return SCH_GLOBAL_LABEL_T;
+    case types::KiCadObjectType::KOT_SCH_HIER_LABEL:        return SCH_HIER_LABEL_T;
+    case types::KiCadObjectType::KOT_SCH_DIRECTIVE_LABEL:   return SCH_DIRECTIVE_LABEL_T;
+    case types::KiCadObjectType::KOT_SCH_FIELD:             return SCH_FIELD_T;
+    case types::KiCadObjectType::KOT_SCH_SYMBOL:            return SCH_SYMBOL_T;
+    case types::KiCadObjectType::KOT_SCH_SHEET_PIN:         return SCH_SHEET_PIN_T;
+    case types::KiCadObjectType::KOT_SCH_SHEET:             return SCH_SHEET_T;
+    case types::KiCadObjectType::KOT_SCH_PIN:               return SCH_PIN_T;
+    case types::KiCadObjectType::KOT_LIB_SYMBOL:            return LIB_SYMBOL_T;
+    case types::KiCadObjectType::KOT_WSG_LINE:              return WSG_LINE_T;
+    case types::KiCadObjectType::KOT_WSG_RECT:              return WSG_RECT_T;
+    case types::KiCadObjectType::KOT_WSG_POLY:              return WSG_POLY_T;
+    case types::KiCadObjectType::KOT_WSG_TEXT:              return WSG_TEXT_T;
+    case types::KiCadObjectType::KOT_WSG_BITMAP:            return WSG_BITMAP_T;
+    case types::KiCadObjectType::KOT_WSG_PAGE:              return WSG_PAGE_T;
+
+    case types::KiCadObjectType::KOT_UNKNOWN:               return TYPE_NOT_INIT;
+    default:
+        wxCHECK_MSG( false, TYPE_NOT_INIT,
+                     "Unhandled case in FromProtoEnum<types::KiCadObjectType>" );
+    }
+}
+
+
+template<>
+types::KiCadObjectType ToProtoEnum( KICAD_T aValue )
+{
+    switch( aValue )
+    {
+    case PCB_FOOTPRINT_T:        return types::KiCadObjectType::KOT_PCB_FOOTPRINT;
+    case PCB_PAD_T:              return types::KiCadObjectType::KOT_PCB_PAD;
+    case PCB_SHAPE_T:            return types::KiCadObjectType::KOT_PCB_SHAPE;
+    case PCB_REFERENCE_IMAGE_T:  return types::KiCadObjectType::KOT_PCB_REFERENCE_IMAGE;
+    case PCB_FIELD_T:            return types::KiCadObjectType::KOT_PCB_FIELD;
+    case PCB_GENERATOR_T:        return types::KiCadObjectType::KOT_PCB_GENERATOR;
+    case PCB_TEXT_T:             return types::KiCadObjectType::KOT_PCB_TEXT;
+    case PCB_TEXTBOX_T:          return types::KiCadObjectType::KOT_PCB_TEXTBOX;
+    case PCB_TABLE_T:            return types::KiCadObjectType::KOT_PCB_TABLE;
+    case PCB_TABLECELL_T:        return types::KiCadObjectType::KOT_PCB_TABLECELL;
+    case PCB_TRACE_T:            return types::KiCadObjectType::KOT_PCB_TRACE;
+    case PCB_VIA_T:              return types::KiCadObjectType::KOT_PCB_VIA;
+    case PCB_ARC_T:              return types::KiCadObjectType::KOT_PCB_ARC;
+    case PCB_MARKER_T:           return types::KiCadObjectType::KOT_PCB_MARKER;
+    case PCB_DIMENSION_T:        return types::KiCadObjectType::KOT_PCB_DIMENSION;
+    case PCB_ZONE_T:             return types::KiCadObjectType::KOT_PCB_ZONE;
+    case PCB_GROUP_T:            return types::KiCadObjectType::KOT_PCB_GROUP;
+    case SCH_MARKER_T:           return types::KiCadObjectType::KOT_SCH_MARKER;
+    case SCH_JUNCTION_T:         return types::KiCadObjectType::KOT_SCH_JUNCTION;
+    case SCH_NO_CONNECT_T:       return types::KiCadObjectType::KOT_SCH_NO_CONNECT;
+    case SCH_BUS_WIRE_ENTRY_T:   return types::KiCadObjectType::KOT_SCH_BUS_WIRE_ENTRY;
+    case SCH_BUS_BUS_ENTRY_T:    return types::KiCadObjectType::KOT_SCH_BUS_BUS_ENTRY;
+    case SCH_LINE_T:             return types::KiCadObjectType::KOT_SCH_LINE;
+    case SCH_SHAPE_T:            return types::KiCadObjectType::KOT_SCH_SHAPE;
+    case SCH_BITMAP_T:           return types::KiCadObjectType::KOT_SCH_BITMAP;
+    case SCH_TEXTBOX_T:          return types::KiCadObjectType::KOT_SCH_TEXTBOX;
+    case SCH_TEXT_T:             return types::KiCadObjectType::KOT_SCH_TEXT;
+    case SCH_TABLE_T:            return types::KiCadObjectType::KOT_SCH_TABLE;
+    case SCH_TABLECELL_T:        return types::KiCadObjectType::KOT_SCH_TABLECELL;
+    case SCH_LABEL_T:            return types::KiCadObjectType::KOT_SCH_LABEL;
+    case SCH_GLOBAL_LABEL_T:     return types::KiCadObjectType::KOT_SCH_GLOBAL_LABEL;
+    case SCH_HIER_LABEL_T:       return types::KiCadObjectType::KOT_SCH_HIER_LABEL;
+    case SCH_DIRECTIVE_LABEL_T:  return types::KiCadObjectType::KOT_SCH_DIRECTIVE_LABEL;
+    case SCH_FIELD_T:            return types::KiCadObjectType::KOT_SCH_FIELD;
+    case SCH_SYMBOL_T:           return types::KiCadObjectType::KOT_SCH_SYMBOL;
+    case SCH_SHEET_PIN_T:        return types::KiCadObjectType::KOT_SCH_SHEET_PIN;
+    case SCH_SHEET_T:            return types::KiCadObjectType::KOT_SCH_SHEET;
+    case SCH_PIN_T:              return types::KiCadObjectType::KOT_SCH_PIN;
+    case LIB_SYMBOL_T:           return types::KiCadObjectType::KOT_LIB_SYMBOL;
+    case WSG_LINE_T:             return types::KiCadObjectType::KOT_WSG_LINE;
+    case WSG_RECT_T:             return types::KiCadObjectType::KOT_WSG_RECT;
+    case WSG_POLY_T:             return types::KiCadObjectType::KOT_WSG_POLY;
+    case WSG_TEXT_T:             return types::KiCadObjectType::KOT_WSG_TEXT;
+    case WSG_BITMAP_T:           return types::KiCadObjectType::KOT_WSG_BITMAP;
+    case WSG_PAGE_T:             return types::KiCadObjectType::KOT_WSG_PAGE;
+    default:
+        wxCHECK_MSG( false, types::KiCadObjectType::KOT_UNKNOWN,
+                     "Unhandled case in ToProtoEnum<KICAD_T>");
+    }
+}
+
+
+template<>
+PCB_LAYER_ID FromProtoEnum( board::types::BoardLayer aValue )
+{
+    switch( aValue )
+    {
+    case board::types::BoardLayer::BL_UNDEFINED:   return UNDEFINED_LAYER;
+    case board::types::BoardLayer::BL_UNSELECTED:  return UNSELECTED_LAYER;
+    case board::types::BoardLayer::BL_F_Cu:        return F_Cu;
+    case board::types::BoardLayer::BL_In1_Cu:      return In1_Cu;
+    case board::types::BoardLayer::BL_In2_Cu:      return In2_Cu;
+    case board::types::BoardLayer::BL_In3_Cu:      return In3_Cu;
+    case board::types::BoardLayer::BL_In4_Cu:      return In4_Cu;
+    case board::types::BoardLayer::BL_In5_Cu:      return In5_Cu;
+    case board::types::BoardLayer::BL_In6_Cu:      return In6_Cu;
+    case board::types::BoardLayer::BL_In7_Cu:      return In7_Cu;
+    case board::types::BoardLayer::BL_In8_Cu:      return In8_Cu;
+    case board::types::BoardLayer::BL_In9_Cu:      return In9_Cu;
+    case board::types::BoardLayer::BL_In10_Cu:     return In10_Cu;
+    case board::types::BoardLayer::BL_In11_Cu:     return In11_Cu;
+    case board::types::BoardLayer::BL_In12_Cu:     return In12_Cu;
+    case board::types::BoardLayer::BL_In13_Cu:     return In13_Cu;
+    case board::types::BoardLayer::BL_In14_Cu:     return In14_Cu;
+    case board::types::BoardLayer::BL_In15_Cu:     return In15_Cu;
+    case board::types::BoardLayer::BL_In16_Cu:     return In16_Cu;
+    case board::types::BoardLayer::BL_In17_Cu:     return In17_Cu;
+    case board::types::BoardLayer::BL_In18_Cu:     return In18_Cu;
+    case board::types::BoardLayer::BL_In19_Cu:     return In19_Cu;
+    case board::types::BoardLayer::BL_In20_Cu:     return In20_Cu;
+    case board::types::BoardLayer::BL_In21_Cu:     return In21_Cu;
+    case board::types::BoardLayer::BL_In22_Cu:     return In22_Cu;
+    case board::types::BoardLayer::BL_In23_Cu:     return In23_Cu;
+    case board::types::BoardLayer::BL_In24_Cu:     return In24_Cu;
+    case board::types::BoardLayer::BL_In25_Cu:     return In25_Cu;
+    case board::types::BoardLayer::BL_In26_Cu:     return In26_Cu;
+    case board::types::BoardLayer::BL_In27_Cu:     return In27_Cu;
+    case board::types::BoardLayer::BL_In28_Cu:     return In28_Cu;
+    case board::types::BoardLayer::BL_In29_Cu:     return In29_Cu;
+    case board::types::BoardLayer::BL_In30_Cu:     return In30_Cu;
+    case board::types::BoardLayer::BL_B_Cu:        return B_Cu;
+    case board::types::BoardLayer::BL_B_Adhes:     return B_Adhes;
+    case board::types::BoardLayer::BL_F_Adhes:     return F_Adhes;
+    case board::types::BoardLayer::BL_B_Paste:     return B_Paste;
+    case board::types::BoardLayer::BL_F_Paste:     return F_Paste;
+    case board::types::BoardLayer::BL_B_SilkS:     return B_SilkS;
+    case board::types::BoardLayer::BL_F_SilkS:     return F_SilkS;
+    case board::types::BoardLayer::BL_B_Mask:      return B_Mask;
+    case board::types::BoardLayer::BL_F_Mask:      return F_Mask;
+    case board::types::BoardLayer::BL_Dwgs_User:   return Dwgs_User;
+    case board::types::BoardLayer::BL_Cmts_User:   return Cmts_User;
+    case board::types::BoardLayer::BL_Eco1_User:   return Eco1_User;
+    case board::types::BoardLayer::BL_Eco2_User:   return Eco2_User;
+    case board::types::BoardLayer::BL_Edge_Cuts:   return Edge_Cuts;
+    case board::types::BoardLayer::BL_Margin:      return Margin;
+    case board::types::BoardLayer::BL_B_CrtYd:     return B_CrtYd;
+    case board::types::BoardLayer::BL_F_CrtYd:     return F_CrtYd;
+    case board::types::BoardLayer::BL_B_Fab:       return B_Fab;
+    case board::types::BoardLayer::BL_F_Fab:       return F_Fab;
+    case board::types::BoardLayer::BL_User_1:      return User_1;
+    case board::types::BoardLayer::BL_User_2:      return User_2;
+    case board::types::BoardLayer::BL_User_3:      return User_3;
+    case board::types::BoardLayer::BL_User_4:      return User_4;
+    case board::types::BoardLayer::BL_User_5:      return User_5;
+    case board::types::BoardLayer::BL_User_6:      return User_6;
+    case board::types::BoardLayer::BL_User_7:      return User_7;
+    case board::types::BoardLayer::BL_User_8:      return User_8;
+    case board::types::BoardLayer::BL_User_9:      return User_9;
+
+    case board::types::BoardLayer::BL_UNKNOWN:     return UNDEFINED_LAYER;
+    default:
+        wxCHECK_MSG( false, UNDEFINED_LAYER,
+                     "Unhandled case in FromProtoEnum<board::types::BoardLayer>" );
+    }
+}
+
+
+template<>
+board::types::BoardLayer ToProtoEnum( PCB_LAYER_ID aValue )
+{
+    switch( aValue )
+    {
+    case UNDEFINED_LAYER:   return board::types::BoardLayer::BL_UNDEFINED;
+    case UNSELECTED_LAYER:  return board::types::BoardLayer::BL_UNSELECTED;
+    case F_Cu:              return board::types::BoardLayer::BL_F_Cu;
+    case In1_Cu:            return board::types::BoardLayer::BL_In1_Cu;
+    case In2_Cu:            return board::types::BoardLayer::BL_In2_Cu;
+    case In3_Cu:            return board::types::BoardLayer::BL_In3_Cu;
+    case In4_Cu:            return board::types::BoardLayer::BL_In4_Cu;
+    case In5_Cu:            return board::types::BoardLayer::BL_In5_Cu;
+    case In6_Cu:            return board::types::BoardLayer::BL_In6_Cu;
+    case In7_Cu:            return board::types::BoardLayer::BL_In7_Cu;
+    case In8_Cu:            return board::types::BoardLayer::BL_In8_Cu;
+    case In9_Cu:            return board::types::BoardLayer::BL_In9_Cu;
+    case In10_Cu:           return board::types::BoardLayer::BL_In10_Cu;
+    case In11_Cu:           return board::types::BoardLayer::BL_In11_Cu;
+    case In12_Cu:           return board::types::BoardLayer::BL_In12_Cu;
+    case In13_Cu:           return board::types::BoardLayer::BL_In13_Cu;
+    case In14_Cu:           return board::types::BoardLayer::BL_In14_Cu;
+    case In15_Cu:           return board::types::BoardLayer::BL_In15_Cu;
+    case In16_Cu:           return board::types::BoardLayer::BL_In16_Cu;
+    case In17_Cu:           return board::types::BoardLayer::BL_In17_Cu;
+    case In18_Cu:           return board::types::BoardLayer::BL_In18_Cu;
+    case In19_Cu:           return board::types::BoardLayer::BL_In19_Cu;
+    case In20_Cu:           return board::types::BoardLayer::BL_In20_Cu;
+    case In21_Cu:           return board::types::BoardLayer::BL_In21_Cu;
+    case In22_Cu:           return board::types::BoardLayer::BL_In22_Cu;
+    case In23_Cu:           return board::types::BoardLayer::BL_In23_Cu;
+    case In24_Cu:           return board::types::BoardLayer::BL_In24_Cu;
+    case In25_Cu:           return board::types::BoardLayer::BL_In25_Cu;
+    case In26_Cu:           return board::types::BoardLayer::BL_In26_Cu;
+    case In27_Cu:           return board::types::BoardLayer::BL_In27_Cu;
+    case In28_Cu:           return board::types::BoardLayer::BL_In28_Cu;
+    case In29_Cu:           return board::types::BoardLayer::BL_In29_Cu;
+    case In30_Cu:           return board::types::BoardLayer::BL_In30_Cu;
+    case B_Cu:              return board::types::BoardLayer::BL_B_Cu;
+    case B_Adhes:           return board::types::BoardLayer::BL_B_Adhes;
+    case F_Adhes:           return board::types::BoardLayer::BL_F_Adhes;
+    case B_Paste:           return board::types::BoardLayer::BL_B_Paste;
+    case F_Paste:           return board::types::BoardLayer::BL_F_Paste;
+    case B_SilkS:           return board::types::BoardLayer::BL_B_SilkS;
+    case F_SilkS:           return board::types::BoardLayer::BL_F_SilkS;
+    case B_Mask:            return board::types::BoardLayer::BL_B_Mask;
+    case F_Mask:            return board::types::BoardLayer::BL_F_Mask;
+    case Dwgs_User:         return board::types::BoardLayer::BL_Dwgs_User;
+    case Cmts_User:         return board::types::BoardLayer::BL_Cmts_User;
+    case Eco1_User:         return board::types::BoardLayer::BL_Eco1_User;
+    case Eco2_User:         return board::types::BoardLayer::BL_Eco2_User;
+    case Edge_Cuts:         return board::types::BoardLayer::BL_Edge_Cuts;
+    case Margin:            return board::types::BoardLayer::BL_Margin;
+    case B_CrtYd:           return board::types::BoardLayer::BL_B_CrtYd;
+    case F_CrtYd:           return board::types::BoardLayer::BL_F_CrtYd;
+    case B_Fab:             return board::types::BoardLayer::BL_B_Fab;
+    case F_Fab:             return board::types::BoardLayer::BL_F_Fab;
+    case User_1:            return board::types::BoardLayer::BL_User_1;
+    case User_2:            return board::types::BoardLayer::BL_User_2;
+    case User_3:            return board::types::BoardLayer::BL_User_3;
+    case User_4:            return board::types::BoardLayer::BL_User_4;
+    case User_5:            return board::types::BoardLayer::BL_User_5;
+    case User_6:            return board::types::BoardLayer::BL_User_6;
+    case User_7:            return board::types::BoardLayer::BL_User_7;
+    case User_8:            return board::types::BoardLayer::BL_User_8;
+    case User_9:            return board::types::BoardLayer::BL_User_9;
+    default:
+        wxCHECK_MSG( false, board::types::BoardLayer::BL_UNKNOWN,
+                     "Unhandled case in ToProtoEnum<PCB_LAYER_ID>");
+    }
+}
+
+
+template<>
+SCH_LAYER_ID FromProtoEnum( schematic::types::SchematicLayer aValue )
+{
+    switch( aValue )
+    {
+
+    default:
+        wxCHECK_MSG( false, SCH_LAYER_ID_START,
+                     "Unhandled case in FromProtoEnum<schematic::types::SchematicLayer>" );
+    }
+}
+
+
+template<>
+schematic::types::SchematicLayer ToProtoEnum( SCH_LAYER_ID aValue )
+{
+    switch( aValue )
+    {
+
+    default:
+        wxCHECK_MSG( false, schematic::types::SchematicLayer::SL_UNKNOWN,
+                     "Unhandled case in ToProtoEnum<SCH_LAYER_ID>");
+    }
+}
+
+
+template<>
+GR_TEXT_H_ALIGN_T FromProtoEnum( types::HorizontalAlignment aValue )
+{
+    switch( aValue )
+    {
+    case types::HorizontalAlignment::HA_LEFT:          return GR_TEXT_H_ALIGN_LEFT;
+    case types::HorizontalAlignment::HA_CENTER:        return GR_TEXT_H_ALIGN_CENTER;
+    case types::HorizontalAlignment::HA_RIGHT:         return GR_TEXT_H_ALIGN_RIGHT;
+    case types::HorizontalAlignment::HA_INDETERMINATE: return GR_TEXT_H_ALIGN_INDETERMINATE;
+
+    case types::HorizontalAlignment::HA_UNKNOWN:       return GR_TEXT_H_ALIGN_CENTER;
+    default:
+        wxCHECK_MSG( false, GR_TEXT_H_ALIGN_CENTER,
+                     "Unhandled case in FromProtoEnum<types::HorizontalAlignment>" );
+    }
+}
+
+
+template<>
+types::HorizontalAlignment ToProtoEnum( GR_TEXT_H_ALIGN_T aValue )
+{
+    switch( aValue )
+    {
+    case GR_TEXT_H_ALIGN_LEFT:          return types::HorizontalAlignment::HA_LEFT;
+    case GR_TEXT_H_ALIGN_CENTER:        return types::HorizontalAlignment::HA_CENTER;
+    case GR_TEXT_H_ALIGN_RIGHT:         return types::HorizontalAlignment::HA_RIGHT;
+    case GR_TEXT_H_ALIGN_INDETERMINATE: return types::HorizontalAlignment::HA_INDETERMINATE;
+    default:
+        wxCHECK_MSG( false, types::HorizontalAlignment::HA_UNKNOWN,
+                     "Unhandled case in ToProtoEnum<GR_TEXT_H_ALIGN_T>");
+    }
+}
+
+
+template<>
+GR_TEXT_V_ALIGN_T FromProtoEnum( types::VerticalAlignment aValue )
+{
+    switch( aValue )
+    {
+    case types::VerticalAlignment::VA_TOP:           return GR_TEXT_V_ALIGN_TOP;
+    case types::VerticalAlignment::VA_CENTER:        return GR_TEXT_V_ALIGN_CENTER;
+    case types::VerticalAlignment::VA_BOTTOM:        return GR_TEXT_V_ALIGN_BOTTOM;
+    case types::VerticalAlignment::VA_INDETERMINATE: return GR_TEXT_V_ALIGN_INDETERMINATE;
+
+    case types::VerticalAlignment::VA_UNKNOWN:       return GR_TEXT_V_ALIGN_CENTER;
+    default:
+        wxCHECK_MSG( false, GR_TEXT_V_ALIGN_CENTER,
+                     "Unhandled case in FromProtoEnum<types::VerticalAlignment>" );
+    }
+}
+
+
+template<>
+types::VerticalAlignment ToProtoEnum( GR_TEXT_V_ALIGN_T aValue )
+{
+    switch( aValue )
+    {
+    case GR_TEXT_V_ALIGN_TOP:           return types::VerticalAlignment::VA_TOP;
+    case GR_TEXT_V_ALIGN_CENTER:        return types::VerticalAlignment::VA_CENTER;
+    case GR_TEXT_V_ALIGN_BOTTOM:        return types::VerticalAlignment::VA_BOTTOM;
+    case GR_TEXT_V_ALIGN_INDETERMINATE: return types::VerticalAlignment::VA_INDETERMINATE;
+    default:
+        wxCHECK_MSG( false, types::VerticalAlignment::VA_UNKNOWN,
+                     "Unhandled case in ToProtoEnum<GR_TEXT_V_ALIGN_T>");
+    }
+}
+
+
+template<>
+LINE_STYLE FromProtoEnum( types::StrokeLineStyle aValue )
+{
+    switch( aValue )
+    {
+    case types::StrokeLineStyle::SLS_DEFAULT:    return LINE_STYLE::DEFAULT;
+    case types::StrokeLineStyle::SLS_SOLID:      return LINE_STYLE::SOLID;
+    case types::StrokeLineStyle::SLS_DASH:       return LINE_STYLE::DASH;
+    case types::StrokeLineStyle::SLS_DOT:        return LINE_STYLE::DOT;
+    case types::StrokeLineStyle::SLS_DASHDOT:    return LINE_STYLE::DASHDOT;
+    case types::StrokeLineStyle::SLS_DASHDOTDOT: return LINE_STYLE::DASHDOTDOT;
+    case types::StrokeLineStyle::SLS_UNKNOWN:
+    default:
+        wxCHECK_MSG( false, LINE_STYLE::DEFAULT,
+                     "Unhandled case in FromProtoEnum<types::StrokeLineStyle>" );
+    }
+}
+
+
+template<>
+types::StrokeLineStyle ToProtoEnum( LINE_STYLE aValue )
+{
+    switch( aValue )
+    {
+    case LINE_STYLE::DEFAULT:    return types::StrokeLineStyle::SLS_DEFAULT;
+    case LINE_STYLE::SOLID:      return types::StrokeLineStyle::SLS_SOLID;
+    case LINE_STYLE::DASH:       return types::StrokeLineStyle::SLS_DASH;
+    case LINE_STYLE::DOT:        return types::StrokeLineStyle::SLS_DOT;
+    case LINE_STYLE::DASHDOT:    return types::StrokeLineStyle::SLS_DASHDOT;
+    case LINE_STYLE::DASHDOTDOT: return types::StrokeLineStyle::SLS_DASHDOTDOT;
+    default:
+        wxCHECK_MSG( false, types::StrokeLineStyle::SLS_UNKNOWN,
+                     "Unhandled case in ToProtoEnum<LINE_STYLE>");
+    }
+}

common/api/api_handler.cpp

@@ -0,0 +1,61 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2023 Jon Evans <jon@craftyjon.com>
+ * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <api/api_handler.h>
+#include <wx/wx.h>
+
+using kiapi::common::ApiRequest, kiapi::common::ApiResponse, kiapi::common::ApiResponseStatus;
+
+
+const wxString API_HANDLER::m_defaultCommitMessage = _( "Modification from API" );
+
+
+API_RESULT API_HANDLER::Handle( ApiRequest& aMsg )
+{
+    ApiResponseStatus status;
+
+    if( !aMsg.has_message() )
+    {
+        status.set_status( ApiStatusCode::AS_BAD_REQUEST );
+        status.set_error_message( "request has no inner message" );
+        return tl::unexpected( status );
+    }
+
+    std::string typeName;
+
+    if( !google::protobuf::Any::ParseAnyTypeUrl( aMsg.message().type_url(), &typeName ) )
+    {
+        status.set_status( ApiStatusCode::AS_BAD_REQUEST );
+        status.set_error_message( "could not parse inner message type" );
+        return tl::unexpected( status );
+    }
+
+    auto it = m_handlers.find( typeName );
+
+    if( it != m_handlers.end() )
+    {
+        REQUEST_HANDLER& handler = it->second;
+        return handler( aMsg );
+    }
+
+    status.set_status( ApiStatusCode::AS_UNHANDLED );
+    // This response is used internally; no need for an error message
+    return tl::unexpected( status );
+}

common/api/api_handler_common.cpp

@@ -0,0 +1,82 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2023 Jon Evans <jon@craftyjon.com>
+ * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <tuple>
+
+#include <api/api_handler_common.h>
+#include <build_version.h>
+#include <google/protobuf/empty.pb.h>
+#include <pgm_base.h>
+#include <project/net_settings.h>
+#include <project/project_file.h>
+#include <settings/settings_manager.h>
+#include <wx/string.h>
+
+using namespace kiapi::common::commands;
+using namespace kiapi::common::types;
+using google::protobuf::Empty;
+
+
+API_HANDLER_COMMON::API_HANDLER_COMMON() :
+        API_HANDLER()
+{
+    registerHandler<commands::GetVersion, GetVersionResponse>( &API_HANDLER_COMMON::handleGetVersion );
+    registerHandler<GetNetClasses, NetClassesResponse>( &API_HANDLER_COMMON::handleGetNetClasses );
+    registerHandler<Ping, Empty>( &API_HANDLER_COMMON::handlePing );
+}
+
+
+HANDLER_RESULT<GetVersionResponse> API_HANDLER_COMMON::handleGetVersion( commands::GetVersion&,
+                                                                         const HANDLER_CONTEXT& )
+{
+    GetVersionResponse reply;
+
+    reply.mutable_version()->set_full_version( GetBuildVersion().ToStdString() );
+
+    std::tuple<int, int, int> version = GetMajorMinorPatchTuple();
+    reply.mutable_version()->set_major( std::get<0>( version ) );
+    reply.mutable_version()->set_minor( std::get<1>( version ) );
+    reply.mutable_version()->set_patch( std::get<2>( version ) );
+
+    return reply;
+}
+
+
+HANDLER_RESULT<NetClassesResponse> API_HANDLER_COMMON::handleGetNetClasses( GetNetClasses& aMsg,
+        const HANDLER_CONTEXT& aCtx )
+{
+    NetClassesResponse reply;
+
+    std::shared_ptr<NET_SETTINGS>& netSettings =
+            Pgm().GetSettingsManager().Prj().GetProjectFile().m_NetSettings;
+
+    for( const auto& [name, netClass] : netSettings->m_NetClasses )
+    {
+        reply.add_net_classes()->set_name( name.ToStdString() );
+    }
+
+    return reply;
+}
+
+
+HANDLER_RESULT<Empty> API_HANDLER_COMMON::handlePing( Ping& aMsg, const HANDLER_CONTEXT& aCtx )
+{
+    return Empty();
+}

common/api/api_handler_editor.cpp

@@ -0,0 +1,353 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 Jon Evans <jon@craftyjon.com>
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <api/api_handler_editor.h>
+#include <api/api_utils.h>
+#include <eda_base_frame.h>
+#include <eda_item.h>
+#include <wx/wx.h>
+
+using namespace kiapi::common::commands;
+
+
+API_HANDLER_EDITOR::API_HANDLER_EDITOR( EDA_BASE_FRAME* aFrame ) :
+        API_HANDLER(),
+        m_frame( aFrame )
+{
+    registerHandler<BeginCommit, BeginCommitResponse>( &API_HANDLER_EDITOR::handleBeginCommit );
+    registerHandler<EndCommit, EndCommitResponse>( &API_HANDLER_EDITOR::handleEndCommit );
+    registerHandler<CreateItems, CreateItemsResponse>( &API_HANDLER_EDITOR::handleCreateItems );
+    registerHandler<UpdateItems, UpdateItemsResponse>( &API_HANDLER_EDITOR::handleUpdateItems );
+    registerHandler<DeleteItems, DeleteItemsResponse>( &API_HANDLER_EDITOR::handleDeleteItems );
+    registerHandler<HitTest, HitTestResponse>( &API_HANDLER_EDITOR::handleHitTest );
+}
+
+
+HANDLER_RESULT<BeginCommitResponse> API_HANDLER_EDITOR::handleBeginCommit( BeginCommit& aMsg,
+        const HANDLER_CONTEXT& aCtx )
+{
+    if( std::optional<ApiResponseStatus> busy = checkForBusy() )
+        return tl::unexpected( *busy );
+
+    if( m_commits.count( aCtx.ClientName ) )
+    {
+        ApiResponseStatus e;
+        e.set_status( ApiStatusCode::AS_BAD_REQUEST );
+        e.set_error_message( fmt::format( "the client {} already has a commit in progress",
+                                          aCtx.ClientName ) );
+        return tl::unexpected( e );
+    }
+
+    wxASSERT( !m_activeClients.count( aCtx.ClientName ) );
+
+    BeginCommitResponse response;
+
+    KIID id;
+    m_commits[aCtx.ClientName] = std::make_pair( id, createCommit() );
+    response.mutable_id()->set_value( id.AsStdString() );
+
+    m_activeClients.insert( aCtx.ClientName );
+
+    return response;
+}
+
+
+HANDLER_RESULT<EndCommitResponse> API_HANDLER_EDITOR::handleEndCommit( EndCommit& aMsg,
+                                                                       const HANDLER_CONTEXT& aCtx )
+{
+    if( std::optional<ApiResponseStatus> busy = checkForBusy() )
+        return tl::unexpected( *busy );
+
+    if( !m_commits.count( aCtx.ClientName ) )
+    {
+        ApiResponseStatus e;
+        e.set_status( ApiStatusCode::AS_BAD_REQUEST );
+        e.set_error_message( fmt::format( "the client {} does not has a commit in progress",
+                                          aCtx.ClientName ) );
+        return tl::unexpected( e );
+    }
+
+    wxASSERT( m_activeClients.count( aCtx.ClientName ) );
+
+    const std::pair<KIID, std::unique_ptr<COMMIT>>& pair = m_commits.at( aCtx.ClientName );
+    const KIID& id = pair.first;
+    const std::unique_ptr<COMMIT>& commit = pair.second;
+
+    EndCommitResponse response;
+
+    // Do not check IDs with drop; it is a safety net in case the id was lost on the client side
+    switch( aMsg.action() )
+    {
+    case kiapi::common::commands::CMA_DROP:
+    {
+        commit->Revert();
+        m_commits.erase( aCtx.ClientName );
+        m_activeClients.erase( aCtx.ClientName );
+        break;
+    }
+
+    case kiapi::common::commands::CMA_COMMIT:
+    {
+        if( aMsg.id().value().compare( id.AsStdString() ) != 0 )
+        {
+            ApiResponseStatus e;
+            e.set_status( ApiStatusCode::AS_BAD_REQUEST );
+            e.set_error_message( fmt::format( "the id {} does not match the commit in progress",
+                                              aMsg.id().value() ) );
+            return tl::unexpected( e );
+        }
+
+        pushCurrentCommit( aCtx, wxString( aMsg.message().c_str(), wxConvUTF8 ) );
+        break;
+    }
+
+    default:
+        break;
+    }
+
+    return response;
+}
+
+
+COMMIT* API_HANDLER_EDITOR::getCurrentCommit( const HANDLER_CONTEXT& aCtx )
+{
+    if( !m_commits.count( aCtx.ClientName ) )
+    {
+        KIID id;
+        m_commits[aCtx.ClientName] = std::make_pair( id, createCommit() );
+    }
+
+    return m_commits.at( aCtx.ClientName ).second.get();
+}
+
+
+void API_HANDLER_EDITOR::pushCurrentCommit( const HANDLER_CONTEXT& aCtx, const wxString& aMessage )
+{
+    auto it = m_commits.find( aCtx.ClientName );
+
+    if( it == m_commits.end() )
+        return;
+
+    it->second.second->Push( aMessage.IsEmpty() ? m_defaultCommitMessage : aMessage );
+    m_commits.erase( it );
+    m_activeClients.erase( aCtx.ClientName );
+}
+
+
+HANDLER_RESULT<bool> API_HANDLER_EDITOR::validateDocument(
+        const kiapi::common::types::DocumentSpecifier& aDocument )
+{
+    if( !validateDocumentInternal( aDocument ) )
+    {
+        ApiResponseStatus e;
+        e.set_status( ApiStatusCode::AS_BAD_REQUEST );
+        e.set_error_message( fmt::format( "the requested document {} is not open",
+                                          aDocument.board_filename() ) );
+        return tl::unexpected( e );
+    }
+
+    return true;
+}
+
+
+HANDLER_RESULT<std::optional<KIID>> API_HANDLER_EDITOR::validateItemHeaderDocument(
+        const kiapi::common::types::ItemHeader& aHeader )
+{
+    if( !aHeader.has_document() || aHeader.document().type() != thisDocumentType() )
+    {
+        ApiResponseStatus e;
+        e.set_status( ApiStatusCode::AS_UNHANDLED );
+        // No error message, this is a flag that the server should try a different handler
+        return tl::unexpected( e );
+    }
+
+    HANDLER_RESULT<bool> documentValidation = validateDocument( aHeader.document() );
+
+    if( !documentValidation )
+        return tl::unexpected( documentValidation.error() );
+
+    if( !validateDocumentInternal( aHeader.document() ) )
+    {
+        ApiResponseStatus e;
+        e.set_status( ApiStatusCode::AS_BAD_REQUEST );
+        e.set_error_message( fmt::format( "the requested document {} is not open",
+                                          aHeader.document().board_filename() ) );
+        return tl::unexpected( e );
+    }
+
+    if( aHeader.has_container() )
+    {
+        return KIID( aHeader.container().value() );
+    }
+
+    // Valid header, but no container provided
+    return std::nullopt;
+}
+
+
+std::optional<ApiResponseStatus> API_HANDLER_EDITOR::checkForBusy()
+{
+    if( !m_frame->CanAcceptApiCommands() )
+    {
+        ApiResponseStatus e;
+        e.set_status( ApiStatusCode::AS_BUSY );
+        e.set_error_message( "KiCad is busy and cannot respond to API requests right now" );
+        return e;
+    }
+
+    return std::nullopt;
+}
+
+
+HANDLER_RESULT<CreateItemsResponse> API_HANDLER_EDITOR::handleCreateItems( CreateItems& aMsg,
+        const HANDLER_CONTEXT& aCtx )
+{
+    if( std::optional<ApiResponseStatus> busy = checkForBusy() )
+        return tl::unexpected( *busy );
+
+    CreateItemsResponse response;
+
+    HANDLER_RESULT<ItemRequestStatus> result = handleCreateUpdateItemsInternal( true, aCtx,
+            aMsg.header(), aMsg.items(),
+            [&]( const ItemStatus& aStatus, const google::protobuf::Any& aItem )
+            {
+                ItemCreationResult itemResult;
+                itemResult.mutable_status()->CopyFrom( aStatus );
+                itemResult.mutable_item()->CopyFrom( aItem );
+                response.mutable_created_items()->Add( std::move( itemResult ) );
+            } );
+
+    if( !result.has_value() )
+        return tl::unexpected( result.error() );
+
+    response.set_status( *result );
+    return response;
+}
+
+
+HANDLER_RESULT<UpdateItemsResponse> API_HANDLER_EDITOR::handleUpdateItems( UpdateItems& aMsg,
+        const HANDLER_CONTEXT& aCtx )
+{
+    if( std::optional<ApiResponseStatus> busy = checkForBusy() )
+        return tl::unexpected( *busy );
+
+    UpdateItemsResponse response;
+
+    HANDLER_RESULT<ItemRequestStatus> result = handleCreateUpdateItemsInternal( false, aCtx,
+            aMsg.header(), aMsg.items(),
+            [&]( const ItemStatus& aStatus, const google::protobuf::Any& aItem )
+            {
+                ItemUpdateResult itemResult;
+                itemResult.mutable_status()->CopyFrom( aStatus );
+                itemResult.mutable_item()->CopyFrom( aItem );
+                response.mutable_updated_items()->Add( std::move( itemResult ) );
+            } );
+
+    if( !result.has_value() )
+        return tl::unexpected( result.error() );
+
+    response.set_status( *result );
+    return response;
+}
+
+
+HANDLER_RESULT<DeleteItemsResponse> API_HANDLER_EDITOR::handleDeleteItems( DeleteItems& aMsg,
+        const HANDLER_CONTEXT& aCtx )
+{
+    if( std::optional<ApiResponseStatus> busy = checkForBusy() )
+        return tl::unexpected( *busy );
+
+    if( !validateItemHeaderDocument( aMsg.header() ) )
+    {
+        ApiResponseStatus e;
+        // No message needed for AS_UNHANDLED; this is an internal flag for the API server
+        e.set_status( ApiStatusCode::AS_UNHANDLED );
+        return tl::unexpected( e );
+    }
+
+    std::map<KIID, ItemDeletionStatus> itemsToDelete;
+
+    for( const kiapi::common::types::KIID& kiidBuf : aMsg.item_ids() )
+    {
+        if( !kiidBuf.value().empty() )
+        {
+            KIID kiid( kiidBuf.value() );
+            itemsToDelete[kiid] = ItemDeletionStatus::IDS_NONEXISTENT;
+        }
+    }
+
+    if( itemsToDelete.empty() )
+    {
+        ApiResponseStatus e;
+        e.set_status( ApiStatusCode::AS_BAD_REQUEST );
+        e.set_error_message( "no valid items to delete were given" );
+        return tl::unexpected( e );
+    }
+
+    deleteItemsInternal( itemsToDelete, aCtx );
+
+    DeleteItemsResponse response;
+
+    for( const auto& [id, status] : itemsToDelete )
+    {
+        ItemDeletionResult result;
+        result.mutable_id()->set_value( id.AsStdString() );
+        result.set_status( status );
+    }
+
+    response.set_status( kiapi::common::types::ItemRequestStatus::IRS_OK );
+    return response;
+}
+
+
+HANDLER_RESULT<HitTestResponse> API_HANDLER_EDITOR::handleHitTest( HitTest& aMsg,
+                                                                   const HANDLER_CONTEXT& aCtx )
+{
+    if( std::optional<ApiResponseStatus> busy = checkForBusy() )
+        return tl::unexpected( *busy );
+
+    if( !validateItemHeaderDocument( aMsg.header() ) )
+    {
+        ApiResponseStatus e;
+        // No message needed for AS_UNHANDLED; this is an internal flag for the API server
+        e.set_status( ApiStatusCode::AS_UNHANDLED );
+        return tl::unexpected( e );
+    }
+
+    HitTestResponse response;
+
+    std::optional<EDA_ITEM*> item = getItemFromDocument( aMsg.header().document(),
+                                                         KIID( aMsg.id().value() ) );
+
+    if( !item )
+    {
+        ApiResponseStatus e;
+        e.set_status( ApiStatusCode::AS_BAD_REQUEST );
+        e.set_error_message( "the requested item ID is not present in the given document" );
+        return tl::unexpected( e );
+    }
+
+    if( ( *item )->HitTest( kiapi::common::UnpackVector2( aMsg.position() ), aMsg.tolerance() ) )
+        response.set_result( HitTestResult::HTR_HIT );
+    else
+        response.set_result( HitTestResult::HTR_NO_HIT );
+
+    return response;
+}

common/api/api_plugin.cpp

@@ -0,0 +1,332 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 Jon Evans <jon@craftyjon.com>
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <magic_enum.hpp>
+#include <nlohmann/json.hpp>
+#include <wx/log.h>
+#include <wx/regex.h>
+#include <wx/stdstream.h>
+#include <wx/wfstream.h>
+
+#include <api/api_plugin.h>
+#include <api/api_plugin_manager.h>
+#include <json_conversions.h>
+
+
+bool PLUGIN_RUNTIME::FromJson( const nlohmann::json& aJson )
+{
+    // TODO move to tl::expected and give user feedback about parse errors
+
+    try
+    {
+        type = magic_enum::enum_cast<PLUGIN_RUNTIME_TYPE>( aJson.at( "type" ).get<std::string>(),
+                                                           magic_enum::case_insensitive )
+                       .value_or( PLUGIN_RUNTIME_TYPE::INVALID );
+
+
+    }
+    catch( ... )
+    {
+        return false;
+    }
+
+    return type != PLUGIN_RUNTIME_TYPE::INVALID;
+}
+
+
+struct API_PLUGIN_CONFIG
+{
+    API_PLUGIN_CONFIG( API_PLUGIN& aParent, const wxFileName& aConfigFile );
+
+    bool valid;
+    wxString identifier;
+    wxString name;
+    wxString description;
+    PLUGIN_RUNTIME runtime;
+    std::vector<PLUGIN_ACTION> actions;
+
+    API_PLUGIN& parent;
+};
+
+
+API_PLUGIN_CONFIG::API_PLUGIN_CONFIG( API_PLUGIN& aParent, const wxFileName& aConfigFile ) :
+        parent( aParent )
+{
+    valid = false;
+
+    if( !aConfigFile.IsFileReadable() )
+        return;
+
+    wxLogTrace( traceApi, "Plugin: parsing config file" );
+
+    wxFFileInputStream fp( aConfigFile.GetFullPath(), wxT( "rt" ) );
+    wxStdInputStream fstream( fp );
+
+    nlohmann::json js;
+
+    try
+    {
+        js = nlohmann::json::parse( fstream, nullptr,
+                                    /* allow_exceptions = */ true,
+                                    /* ignore_comments  = */ true );
+    }
+    catch( ... )
+    {
+        wxLogTrace( traceApi, "Plugin: exception during parse" );
+        return;
+    }
+
+    // TODO add schema and validate
+
+    // All of these are required; any exceptions here leave us with valid == false
+    try
+    {
+        identifier = js.at( "identifier" ).get<wxString>();
+        name = js.at( "name" ).get<wxString>();
+        description = js.at( "description" ).get<wxString>();
+
+        if( !runtime.FromJson( js.at( "runtime" ) ) )
+        {
+            wxLogTrace( traceApi, "Plugin: error parsing runtime section" );
+            return;
+        }
+    }
+    catch( ... )
+    {
+        wxLogTrace( traceApi, "Plugin: exception while parsing required keys" );
+        return;
+    }
+
+    // At minimum, we need a reverse-DNS style identifier with two dots and a 2+ character TLD
+    wxRegEx identifierRegex( wxS( "[\\w\\d]{2,}\\.[\\w\\d]+\\.[\\w\\d]+" ) );
+
+    if( !identifierRegex.Matches( identifier ) )
+    {
+        wxLogTrace( traceApi, wxString::Format( "Plugin: identifier %s does not meet requirements",
+                                                identifier ) );
+        return;
+    }
+
+    wxLogTrace( traceApi, wxString::Format( "Plugin: %s (%s)", identifier, name ) );
+
+    try
+    {
+        const nlohmann::json& actionsJs = js.at( "actions" );
+
+        if( actionsJs.is_array() )
+        {
+            for( const nlohmann::json& actionJs : actionsJs )
+            {
+                if( std::optional<PLUGIN_ACTION> a = parent.createActionFromJson( actionJs ) )
+                {
+                    a->identifier = wxString::Format( "%s.%s", identifier, a->identifier );
+                    wxLogTrace( traceApi, wxString::Format( "Plugin: loaded action %s",
+                                                            a->identifier ) );
+                    actions.emplace_back( *a );
+                }
+            }
+        }
+    }
+    catch( ... )
+    {
+        wxLogTrace( traceApi, "Plugin: exception while parsing actions" );
+    }
+
+    valid = true;
+}
+
+
+API_PLUGIN::API_PLUGIN( const wxFileName& aConfigFile ) :
+        m_configFile( aConfigFile ),
+        m_config( std::make_unique<API_PLUGIN_CONFIG>( *this, aConfigFile ) )
+{
+}
+
+
+API_PLUGIN::~API_PLUGIN()
+{
+}
+
+
+bool API_PLUGIN::IsOk() const
+{
+    return m_config->valid;
+}
+
+
+const wxString& API_PLUGIN::Identifier() const
+{
+    return m_config->identifier;
+}
+
+
+const wxString& API_PLUGIN::Name() const
+{
+    return m_config->name;
+}
+
+
+const wxString& API_PLUGIN::Description() const
+{
+    return m_config->description;
+}
+
+
+const PLUGIN_RUNTIME& API_PLUGIN::Runtime() const
+{
+    return m_config->runtime;
+}
+
+
+const std::vector<PLUGIN_ACTION>& API_PLUGIN::Actions() const
+{
+    return m_config->actions;
+}
+
+
+wxString API_PLUGIN::BasePath() const
+{
+    return m_configFile.GetPath();
+}
+
+
+std::optional<PLUGIN_ACTION> API_PLUGIN::createActionFromJson( const nlohmann::json& aJson )
+{
+    // TODO move to tl::expected and give user feedback about parse errors
+    PLUGIN_ACTION action( *this );
+
+    try
+    {
+        action.identifier = aJson.at( "identifier" ).get<wxString>();
+        wxLogTrace( traceApi, wxString::Format( "Plugin: load action %s", action.identifier ) );
+        action.name = aJson.at( "name" ).get<wxString>();
+        action.description = aJson.at( "description" ).get<wxString>();
+        action.entrypoint = aJson.at( "entrypoint" ).get<wxString>();
+        action.show_button = aJson.contains( "show-button" ) && aJson.at( "show-button" ).get<bool>();
+    }
+    catch( ... )
+    {
+        wxLogTrace( traceApi, "Plugin: exception while parsing action required keys" );
+        return std::nullopt;
+    }
+
+    wxFileName f( action.entrypoint );
+
+    if( !f.IsRelative() )
+    {
+        wxLogTrace( traceApi, wxString::Format( "Plugin: action contains abs path %s; skipping",
+                                                action.entrypoint ) );
+        return std::nullopt;
+    }
+
+    f.Normalize( wxPATH_NORM_ABSOLUTE, m_configFile.GetPath() );
+
+    if( !f.IsFileReadable() )
+    {
+        wxLogTrace( traceApi, wxString::Format( "WARNING: action entrypoint %s is not readable",
+                                                f.GetFullPath() ) );
+    }
+
+    if( aJson.contains( "args" ) && aJson.at( "args" ).is_array() )
+    {
+        for( const nlohmann::json& argJs : aJson.at( "args" ) )
+        {
+            try
+            {
+                action.args.emplace_back( argJs.get<wxString>() );
+            }
+            catch( ... )
+            {
+                wxLogTrace( traceApi, "Plugin: exception while parsing action args" );
+                continue;
+            }
+        }
+    }
+
+    if( aJson.contains( "scopes" ) && aJson.at( "scopes" ).is_array() )
+    {
+        for( const nlohmann::json& scopeJs : aJson.at( "scopes" ) )
+        {
+            try
+            {
+                action.scopes.insert( magic_enum::enum_cast<PLUGIN_ACTION_SCOPE>(
+                        scopeJs.get<std::string>(), magic_enum::case_insensitive )
+                       .value_or( PLUGIN_ACTION_SCOPE::INVALID ) );
+            }
+            catch( ... )
+            {
+                wxLogTrace( traceApi, "Plugin: exception while parsing action scopes" );
+                continue;
+            }
+        }
+    }
+
+    auto handleBitmap =
+            [&]( const std::string& aKey, wxBitmapBundle& aDest )
+            {
+                if( aJson.contains( aKey ) && aJson.at( aKey ).is_array() )
+                {
+                    wxVector<wxBitmap> bitmaps;
+
+                    for( const nlohmann::json& iconJs : aJson.at( aKey ) )
+                    {
+                        wxFileName iconFile;
+
+                        try
+                        {
+                            iconFile = iconJs.get<wxString>();
+                        }
+                        catch( ... )
+                        {
+                            continue;
+                        }
+
+                        iconFile.Normalize( wxPATH_NORM_ABSOLUTE, m_configFile.GetPath() );
+
+                        wxLogTrace( traceApi,
+                                    wxString::Format( "Plugin: action %s: loading icon %s",
+                                                      action.identifier, iconFile.GetFullPath() ) );
+
+
+                        if( !iconFile.IsFileReadable() )
+                        {
+                            wxLogTrace( traceApi, "Plugin: icon file could not be read" );
+                            continue;
+                        }
+
+                        wxBitmap bmp;
+                        // TODO: If necessary; support types other than PNG
+                        bmp.LoadFile( iconFile.GetFullPath(), wxBITMAP_TYPE_PNG );
+
+                        if( bmp.IsOk() )
+                            bitmaps.push_back( bmp );
+                        else
+                            wxLogTrace( traceApi, "Plugin: icon file not a valid bitmap" );
+                    }
+
+                    aDest = wxBitmapBundle::FromBitmaps( bitmaps );
+                }
+            };
+
+    handleBitmap( "icons-light", action.icon_light );
+    handleBitmap( "icons-dark", action.icon_dark );
+
+    return action;
+}

common/api/api_plugin_manager.cpp

@@ -0,0 +1,420 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2024 Jon Evans <jon@craftyjon.com>
+ * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <fmt/format.h>
+#include <wx/dir.h>
+#include <wx/log.h>
+#include <wx/utils.h>
+
+#include <api/api_plugin_manager.h>
+#include <api/api_server.h>
+#include <paths.h>
+#include <pgm_base.h>
+#include <python_manager.h>
+#include <settings/settings_manager.h>
+#include <settings/common_settings.h>
+
+const wxChar* const traceApi = wxT( "KICAD_API" );
+
+
+wxDEFINE_EVENT( EDA_EVT_PLUGIN_MANAGER_JOB_FINISHED, wxCommandEvent );
+wxDEFINE_EVENT( EDA_EVT_PLUGIN_AVAILABILITY_CHANGED, wxCommandEvent );
+
+
+API_PLUGIN_MANAGER::API_PLUGIN_MANAGER( wxEvtHandler* aEvtHandler ) :
+        wxEvtHandler(),
+        m_parent( aEvtHandler )
+{
+    Bind( EDA_EVT_PLUGIN_MANAGER_JOB_FINISHED, &API_PLUGIN_MANAGER::processNextJob, this );
+}
+
+
+class PLUGIN_TRAVERSER : public wxDirTraverser
+{
+private:
+    std::function<void( const wxFileName& )> m_action;
+
+public:
+    explicit PLUGIN_TRAVERSER( std::function<void( const wxFileName& )> aAction )
+            : m_action( std::move( aAction ) )
+    {
+    }
+
+    wxDirTraverseResult OnFile( const wxString& aFilePath ) override
+    {
+        wxFileName file( aFilePath );
+
+        if( file.GetFullName() == wxS( "plugin.json" ) )
+            m_action( file );
+
+        return wxDIR_CONTINUE;
+    }
+
+    wxDirTraverseResult OnDir( const wxString& dirPath ) override
+    {
+        return wxDIR_CONTINUE;
+    }
+};
+
+
+void API_PLUGIN_MANAGER::ReloadPlugins()
+{
+    m_plugins.clear();
+    m_pluginsCache.clear();
+    m_actionsCache.clear();
+    m_environmentCache.clear();
+    m_buttonBindings.clear();
+    m_menuBindings.clear();
+    m_readyPlugins.clear();
+
+    // TODO support system-provided plugins
+    wxDir userPluginsDir( PATHS::GetUserPluginsPath() );
+
+    PLUGIN_TRAVERSER loader(
+            [&]( const wxFileName& aFile )
+            {
+                wxLogTrace( traceApi, wxString::Format( "Manager: loading plugin from %s",
+                                                        aFile.GetFullPath() ) );
+
+                auto plugin = std::make_unique<API_PLUGIN>( aFile );
+
+                if( plugin->IsOk() )
+                {
+                    if( m_pluginsCache.count( plugin->Identifier() ) )
+                    {
+                        wxLogTrace( traceApi,
+                                    wxString::Format( "Manager: identifier %s already present!",
+                                                      plugin->Identifier() ) );
+                        return;
+                    }
+                    else
+                    {
+                        m_pluginsCache[plugin->Identifier()] = plugin.get();
+                    }
+
+                    for( const PLUGIN_ACTION& action : plugin->Actions() )
+                        m_actionsCache[action.identifier] = &action;
+
+                    m_plugins.insert( std::move( plugin ) );
+                }
+                else
+                {
+                    wxLogTrace( traceApi, "Manager: loading failed" );
+                }
+            } );
+
+    if( userPluginsDir.IsOpened() )
+    {
+        wxLogTrace( traceApi, wxString::Format( "Manager: scanning user path (%s) for plugins...",
+                                                userPluginsDir.GetName() ) );
+        userPluginsDir.Traverse( loader );
+        processPluginDependencies();
+    }
+
+    wxCommandEvent* evt = new wxCommandEvent( EDA_EVT_PLUGIN_AVAILABILITY_CHANGED, wxID_ANY );
+    m_parent->QueueEvent( evt );
+}
+
+
+void API_PLUGIN_MANAGER::InvokeAction( const wxString& aIdentifier )
+{
+    if( !m_actionsCache.count( aIdentifier ) )
+        return;
+
+    const PLUGIN_ACTION* action = m_actionsCache.at( aIdentifier );
+    const API_PLUGIN& plugin = action->plugin;
+
+    if( !m_readyPlugins.count( plugin.Identifier() ) )
+    {
+        wxLogTrace( traceApi, wxString::Format( "Manager: Plugin %s is not ready",
+                                                plugin.Identifier() ) );
+        return;
+    }
+
+    wxFileName pluginFile( plugin.BasePath(), action->entrypoint );
+    pluginFile.Normalize( wxPATH_NORM_ABSOLUTE | wxPATH_NORM_SHORTCUT | wxPATH_NORM_DOTS
+                          | wxPATH_NORM_TILDE, plugin.BasePath() );
+    wxString pluginPath = pluginFile.GetFullPath();
+
+    std::vector<const wchar_t*> args;
+    std::optional<wxString> py;
+
+    switch( plugin.Runtime().type )
+    {
+    case PLUGIN_RUNTIME_TYPE::PYTHON:
+    {
+        py = PYTHON_MANAGER::GetVirtualPython( plugin.Identifier() );
+
+        if( !py )
+        {
+            wxLogTrace( traceApi, wxString::Format( "Manager: Python interpreter for %s not found",
+                                                    plugin.Identifier() ) );
+            return;
+        }
+
+        args.push_back( py->wc_str() );
+
+        if( !pluginFile.IsFileReadable() )
+        {
+            wxLogTrace( traceApi, wxString::Format( "Manager: Python entrypoint %s is not readable",
+                                                    pluginFile.GetFullPath() ) );
+            return;
+        }
+
+        break;
+    }
+
+    case PLUGIN_RUNTIME_TYPE::EXEC:
+    {
+        if( !pluginFile.IsFileExecutable() )
+        {
+            wxLogTrace( traceApi, wxString::Format( "Manager: Exec entrypoint %s is not executable",
+                                                    pluginFile.GetFullPath() ) );
+            return;
+        }
+
+        break;
+    };
+
+    default:
+        wxLogTrace( traceApi, wxString::Format( "Manager: unhandled runtime for action %s",
+                                                action->identifier ) );
+        return;
+    }
+
+    args.emplace_back( pluginPath.wc_str() );
+
+    for( const wxString& arg : action->args )
+        args.emplace_back( arg.wc_str() );
+
+    args.emplace_back( nullptr );
+
+    wxExecuteEnv env;
+    wxGetEnvMap( &env.env );
+    env.env[ wxS( "KICAD_API_SOCKET" ) ] = Pgm().GetApiServer().SocketPath();
+    env.env[ wxS( "KICAD_API_TOKEN" ) ] = Pgm().GetApiServer().Token();
+    env.cwd = pluginFile.GetPath();
+
+    long p = wxExecute( const_cast<wchar_t**>( args.data() ), wxEXEC_ASYNC, nullptr, &env );
+
+    if( !p )
+    {
+        wxLogTrace( traceApi, wxString::Format( "Manager: launching action %s failed",
+                                                action->identifier ) );
+    }
+    else
+    {
+        wxLogTrace( traceApi, wxString::Format( "Manager: launching action %s -> pid %ld",
+                                                action->identifier, p ) );
+    }
+}
+
+
+std::vector<const PLUGIN_ACTION*> API_PLUGIN_MANAGER::GetActionsForScope( PLUGIN_ACTION_SCOPE aScope )
+{
+    std::vector<const PLUGIN_ACTION*> actions;
+
+    for( auto& [identifier, action] : m_actionsCache )
+    {
+        if( !m_readyPlugins.count( action->plugin.Identifier() ) )
+            continue;
+
+        if( action->scopes.count( aScope ) )
+            actions.emplace_back( action );
+    }
+
+    return actions;
+}
+
+
+void API_PLUGIN_MANAGER::processPluginDependencies()
+{
+    for( const std::unique_ptr<API_PLUGIN>& plugin : m_plugins )
+    {
+        m_environmentCache[plugin->Identifier()] = wxEmptyString;
+
+        if( plugin->Runtime().type != PLUGIN_RUNTIME_TYPE::PYTHON )
+        {
+            m_readyPlugins.insert( plugin->Identifier() );
+            continue;
+        }
+
+        std::optional<wxString> env = PYTHON_MANAGER::GetPythonEnvironment( plugin->Identifier() );
+
+        if( !env )
+        {
+            wxLogTrace( traceApi, wxString::Format( "Manager: could not create env for %s",
+                                                     plugin->Identifier() ) );
+            continue;
+        }
+
+        wxFileName envConfigPath( *env, wxS( "pyvenv.cfg" ) );
+
+        if( envConfigPath.IsFileReadable() )
+        {
+            wxLogTrace( traceApi, wxString::Format( "Manager: Python env for %s exists at %s",
+                                                    plugin->Identifier(), *env ) );
+            JOB job;
+            job.type = JOB_TYPE::INSTALL_REQUIREMENTS;
+            job.identifier = plugin->Identifier();
+            job.plugin_path = plugin->BasePath();
+            job.env_path = *env;
+            m_jobs.emplace_back( job );
+            continue;
+        }
+
+        wxLogTrace( traceApi, wxString::Format( "Manager: will create Python env for %s at %s",
+                                                plugin->Identifier(), *env ) );
+        JOB job;
+        job.type = JOB_TYPE::CREATE_ENV;
+        job.identifier = plugin->Identifier();
+        job.plugin_path = plugin->BasePath();
+        job.env_path = *env;
+        m_jobs.emplace_back( job );
+    }
+
+    wxCommandEvent evt;
+    processNextJob( evt );
+}
+
+
+void API_PLUGIN_MANAGER::processNextJob( wxCommandEvent& aEvent )
+{
+    if( m_jobs.empty() )
+    {
+        wxLogTrace( traceApi, "Manager: cleared job queue" );
+        return;
+    }
+
+    wxLogTrace( traceApi, wxString::Format( "Manager: begin processing; %zu jobs left in queue",
+                                            m_jobs.size() ) );
+
+    JOB& job = m_jobs.front();
+
+    if( job.type == JOB_TYPE::CREATE_ENV )
+    {
+        wxLogTrace( traceApi, "Manager: Python exe '%s'",
+                    Pgm().GetCommonSettings()->m_Api.python_interpreter );
+        wxLogTrace( traceApi, wxString::Format( "Manager: creating Python env at %s",
+                                                job.env_path ) );
+        PYTHON_MANAGER manager( Pgm().GetCommonSettings()->m_Api.python_interpreter );
+
+        manager.Execute(
+                wxString::Format( wxS( "-m venv %s" ), job.env_path ),
+                [this]( int aRetVal, const wxString& aOutput, const wxString& aError )
+                {
+                    wxLogTrace( traceApi,
+                                wxString::Format( "Manager: venv (%d): %s", aRetVal, aOutput ) );
+
+                    if( !aError.IsEmpty() )
+                        wxLogTrace( traceApi, wxString::Format( "Manager: venv err: %s", aError ) );
+
+                    wxCommandEvent* evt =
+                            new wxCommandEvent( EDA_EVT_PLUGIN_MANAGER_JOB_FINISHED, wxID_ANY );
+                    QueueEvent( evt );
+                } );
+    }
+    else if( job.type == JOB_TYPE::INSTALL_REQUIREMENTS )
+    {
+        wxLogTrace( traceApi, wxString::Format( "Manager: installing dependencies for %s",
+                                                job.plugin_path ) );
+
+        std::optional<wxString> pythonHome = PYTHON_MANAGER::GetPythonEnvironment( job.identifier );
+        std::optional<wxString> python = PYTHON_MANAGER::GetVirtualPython( job.identifier );
+        wxFileName reqs = wxFileName( job.plugin_path, "requirements.txt" );
+
+        if( !python )
+        {
+            wxLogTrace( traceApi, wxString::Format( "Manager: error: python not found at %s",
+                                                    job.env_path ) );
+        }
+        else if( !reqs.IsFileReadable() )
+        {
+            wxLogTrace( traceApi,
+                        wxString::Format( "Manager: error: requirements.txt not found at %s",
+                                          job.plugin_path ) );
+        }
+        else
+        {
+            wxLogTrace( traceApi, "Manager: Python exe '%s'", *python );
+
+            PYTHON_MANAGER manager( *python );
+            wxExecuteEnv env;
+
+            if( pythonHome )
+                env.env[wxS( "VIRTUAL_ENV" )] = *pythonHome;
+
+            wxString cmd = wxS( "-m ensurepip" );
+            wxLogTrace( traceApi, "Manager: calling python `%s`", cmd );
+
+            manager.Execute( cmd,
+                [=]( int aRetVal, const wxString& aOutput, const wxString& aError )
+                {
+                    wxLogTrace( traceApi, wxString::Format( "Manager: ensurepip (%d): %s",
+                                                            aRetVal, aOutput ) );
+
+                    if( !aError.IsEmpty() )
+                    {
+                        wxLogTrace( traceApi,
+                                    wxString::Format( "Manager: ensurepip err: %s", aError ) );
+                    }
+                }, &env );
+
+            cmd = wxString::Format(
+                    wxS( "-m pip install --no-input --isolated --require-virtualenv "
+                         "--exists-action i -r '%s'" ),
+                    reqs.GetFullPath() );
+
+            wxLogTrace( traceApi, "Manager: calling python `%s`", cmd );
+
+            manager.Execute( cmd,
+                [this, job]( int aRetVal, const wxString& aOutput, const wxString& aError )
+                {
+                    wxLogTrace( traceApi, wxString::Format( "Manager: pip (%d): %s",
+                                                            aRetVal, aOutput ) );
+
+                    if( !aError.IsEmpty() )
+                        wxLogTrace( traceApi, wxString::Format( "Manager: pip err: %s", aError ) );
+
+                    if( aRetVal == 0 )
+                    {
+                        wxLogTrace( traceApi, wxString::Format( "Manager: marking %s as ready",
+                                                                job.identifier ) );
+                        m_readyPlugins.insert( job.identifier );
+                        wxCommandEvent* availabilityEvt =
+                                new wxCommandEvent( EDA_EVT_PLUGIN_AVAILABILITY_CHANGED, wxID_ANY );
+                        wxTheApp->QueueEvent( availabilityEvt );
+                    }
+
+                    wxCommandEvent* evt = new wxCommandEvent( EDA_EVT_PLUGIN_MANAGER_JOB_FINISHED,
+                                                              wxID_ANY );
+
+                    QueueEvent( evt );
+                }, &env );
+        }
+
+        wxCommandEvent* evt = new wxCommandEvent( EDA_EVT_PLUGIN_MANAGER_JOB_FINISHED, wxID_ANY );
+        QueueEvent( evt );
+    }
+
+    m_jobs.pop_front();
+    wxLogTrace( traceApi, wxString::Format( "Manager: done processing; %zu jobs left in queue",
+                                            m_jobs.size() ) );
+}

common/api/api_server.cpp

@@ -0,0 +1,274 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2023 Jon Evans <jon@craftyjon.com>
+ * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <wx/app.h>
+#include <wx/datetime.h>
+#include <wx/event.h>
+#include <wx/stdpaths.h>
+
+#include <advanced_config.h>
+#include <api/api_plugin_manager.h> // traceApi
+#include <api/api_server.h>
+#include <api/api_handler_common.h>
+#include <kiid.h>
+#include <kinng.h>
+#include <paths.h>
+#include <pgm_base.h>
+#include <settings/common_settings.h>
+#include <string_utils.h>
+
+#include <api/common/envelope.pb.h>
+
+using kiapi::common::ApiRequest, kiapi::common::ApiResponse, kiapi::common::ApiStatusCode;
+
+
+wxString KICAD_API_SERVER::s_logFileName = "api.log";
+
+
+wxDEFINE_EVENT( API_REQUEST_EVENT, wxCommandEvent );
+
+
+KICAD_API_SERVER::KICAD_API_SERVER() :
+        wxEvtHandler(),
+        m_token( KIID().AsStdString() ),
+        m_readyToReply( false )
+{
+    m_commonHandler = std::make_unique<API_HANDLER_COMMON>();
+    RegisterHandler( m_commonHandler.get() );
+
+    if( !Pgm().GetCommonSettings()->m_Api.enable_server )
+    {
+        wxLogTrace( traceApi, "Server: disabled by user preferences." );
+        return;
+    }
+
+    Start();
+}
+
+
+KICAD_API_SERVER::~KICAD_API_SERVER()
+{
+}
+
+
+void KICAD_API_SERVER::Start()
+{
+    if( Running() )
+        return;
+
+    wxFileName socket;
+#ifdef __WXMAC__
+    socket.AssignDir( wxS( "/tmp" ) );
+#else
+    socket.AssignDir( wxStandardPaths::Get().GetTempDir() );
+#endif
+    socket.AppendDir( wxS( "kicad" ) );
+    socket.SetFullName( wxS( "api.sock" ) );
+
+    if( !PATHS::EnsurePathExists( socket.GetPath() ) )
+    {
+        wxLogTrace( traceApi, wxString::Format( "Server: socket path %s could not be created",
+                                                socket.GetPath() ) );
+        return;
+    }
+
+    if( socket.FileExists() )
+    {
+        socket.SetFullName( wxString::Format( wxS( "api-%ul.sock" ), ::wxGetProcessId() ) );
+
+        if( socket.FileExists() )
+        {
+            wxLogTrace( traceApi, wxString::Format( "Server: PID socket path %s already exists!",
+                                                    socket.GetFullPath() ) );
+            return;
+        }
+    }
+
+    m_server = std::make_unique<KINNG_REQUEST_SERVER>(
+            fmt::format( "ipc://{}", socket.GetFullPath().ToStdString() ) );
+    m_server->SetCallback( [&]( std::string* aRequest ) { onApiRequest( aRequest ); } );
+
+    m_logFilePath.AssignDir( PATHS::GetLogsPath() );
+    m_logFilePath.SetName( s_logFileName );
+
+    if( ADVANCED_CFG::GetCfg().m_EnableAPILogging )
+    {
+        PATHS::EnsurePathExists( PATHS::GetLogsPath() );
+        log( fmt::format( "--- KiCad API server started at {} ---\n", SocketPath() ) );
+    }
+
+    wxLogTrace( traceApi, wxString::Format( "Server: listening at %s", SocketPath() ) );
+
+    Bind( API_REQUEST_EVENT, &KICAD_API_SERVER::handleApiEvent, this );
+}
+
+
+void KICAD_API_SERVER::Stop()
+{
+    if( !Running() )
+        return;
+
+    wxLogTrace( traceApi, "Stopping server" );
+    Unbind( API_REQUEST_EVENT, &KICAD_API_SERVER::handleApiEvent, this );
+
+    m_server->Stop();
+    m_server.reset( nullptr );
+}
+
+
+bool KICAD_API_SERVER::Running() const
+{
+    return m_server && m_server->Running();
+}
+
+
+void KICAD_API_SERVER::RegisterHandler( API_HANDLER* aHandler )
+{
+    wxCHECK( aHandler, /* void */ );
+    m_handlers.insert( aHandler );
+}
+
+
+void KICAD_API_SERVER::DeregisterHandler( API_HANDLER* aHandler )
+{
+    m_handlers.erase( aHandler );
+}
+
+
+std::string KICAD_API_SERVER::SocketPath() const
+{
+    return m_server ? m_server->SocketPath() : "";
+}
+
+
+void KICAD_API_SERVER::onApiRequest( std::string* aRequest )
+{
+    if( !m_readyToReply )
+    {
+        ApiResponse notHandled;
+        notHandled.mutable_status()->set_status( ApiStatusCode::AS_NOT_READY );
+        notHandled.mutable_status()->set_error_message( "KiCad is not ready to reply" );
+        m_server->Reply( notHandled.SerializeAsString() );
+        log( "Got incoming request but was not yet ready to reply." );
+        return;
+    }
+
+    wxCommandEvent* evt = new wxCommandEvent( API_REQUEST_EVENT );
+
+    // We don't actually need write access to this string, but client data is non-const
+    evt->SetClientData( static_cast<void*>( aRequest ) );
+
+    // Takes ownership and frees the wxCommandEvent
+    QueueEvent( evt );
+}
+
+
+void KICAD_API_SERVER::handleApiEvent( wxCommandEvent& aEvent )
+{
+    std::string& requestString = *static_cast<std::string*>( aEvent.GetClientData() );
+    ApiRequest request;
+
+    if( !request.ParseFromString( requestString ) )
+    {
+        ApiResponse error;
+        error.mutable_header()->set_kicad_token( m_token );
+        error.mutable_status()->set_status( ApiStatusCode::AS_BAD_REQUEST );
+        error.mutable_status()->set_error_message( "request could not be parsed" );
+        m_server->Reply( error.SerializeAsString() );
+
+        if( ADVANCED_CFG::GetCfg().m_EnableAPILogging )
+            log( "Response (ERROR): " + error.Utf8DebugString() );
+    }
+
+    if( ADVANCED_CFG::GetCfg().m_EnableAPILogging )
+        log( "Request: " + request.Utf8DebugString() );
+
+    if( !request.header().kicad_token().empty() &&
+        request.header().kicad_token().compare( m_token ) != 0 )
+    {
+        ApiResponse error;
+        error.mutable_header()->set_kicad_token( m_token );
+        error.mutable_status()->set_status( ApiStatusCode::AS_TOKEN_MISMATCH );
+        error.mutable_status()->set_error_message(
+                "the provided kicad_token did not match this KiCad instance's token" );
+        m_server->Reply( error.SerializeAsString() );
+
+        if( ADVANCED_CFG::GetCfg().m_EnableAPILogging )
+            log( "Response (ERROR): " + error.Utf8DebugString() );
+    }
+
+    API_RESULT result;
+
+    for( API_HANDLER* handler : m_handlers )
+    {
+        result = handler->Handle( request );
+
+        if( result.has_value() )
+            break;
+        else if( result.error().status() != ApiStatusCode::AS_UNHANDLED )
+            break;
+    }
+
+    // Note: at the point we call Reply(), we no longer own requestString.
+
+    if( result.has_value() )
+    {
+        result->mutable_header()->set_kicad_token( m_token );
+        m_server->Reply( result->SerializeAsString() );
+
+        if( ADVANCED_CFG::GetCfg().m_EnableAPILogging )
+            log( "Response: " + result->Utf8DebugString() );
+    }
+    else
+    {
+        ApiResponse error;
+        error.mutable_status()->CopyFrom( result.error() );
+        error.mutable_header()->set_kicad_token( m_token );
+
+        if( result.error().status() == ApiStatusCode::AS_UNHANDLED )
+        {
+            std::string type = "<unparseable Any>";
+            google::protobuf::Any::ParseAnyTypeUrl( request.message().type_url(), &type );
+            std::string msg = fmt::format( "no handler available for request of type {}", type );
+            error.mutable_status()->set_error_message( msg );
+        }
+
+        m_server->Reply( error.SerializeAsString() );
+
+        if( ADVANCED_CFG::GetCfg().m_EnableAPILogging )
+            log( "Response (ERROR): " + error.Utf8DebugString() );
+    }
+}
+
+
+void KICAD_API_SERVER::log( const std::string& aOutput )
+{
+    FILE* fp = wxFopen( m_logFilePath.GetFullPath(), wxT( "a" ) );
+
+    if( !fp )
+        return;
+
+    wxString out;
+    wxDateTime now = wxDateTime::Now();
+
+    fprintf( fp, "%s", TO_UTF8( out.Format( wxS( "%s: %s" ),
+                                            now.FormatISOCombined(), aOutput ) ) );
+    fclose( fp );
+}

common/api/api_utils.cpp

@@ -0,0 +1,135 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2023 Jon Evans <jon@craftyjon.com>
+ * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <magic_enum.hpp>
+#include <api/api_utils.h>
+
+namespace kiapi::common
+{
+
+std::optional<KICAD_T> TypeNameFromAny( const google::protobuf::Any& aMessage )
+{
+    static const std::map<std::string, KICAD_T> s_types = {
+        { "type.googleapis.com/kiapi.board.types.Track", PCB_TRACE_T },
+        { "type.googleapis.com/kiapi.board.types.Arc", PCB_ARC_T },
+        { "type.googleapis.com/kiapi.board.types.Via", PCB_VIA_T },
+        { "type.googleapis.com/kiapi.board.types.Text", PCB_TEXT_T },
+        { "type.googleapis.com/kiapi.board.types.TextBox", PCB_TEXTBOX_T },
+        { "type.googleapis.com/kiapi.board.types.GraphicShape", PCB_SHAPE_T },
+        { "type.googleapis.com/kiapi.board.types.Pad", PCB_PAD_T },
+        { "type.googleapis.com/kiapi.board.types.Zone", PCB_ZONE_T },
+        { "type.googleapis.com/kiapi.board.types.Dimension", PCB_DIMENSION_T },
+        { "type.googleapis.com/kiapi.board.types.ReferenceImage", PCB_REFERENCE_IMAGE_T },
+        { "type.googleapis.com/kiapi.board.types.Group", PCB_GROUP_T },
+        { "type.googleapis.com/kiapi.board.types.Field", PCB_FIELD_T },
+        { "type.googleapis.com/kiapi.board.types.FootprintInstance", PCB_FOOTPRINT_T },
+    };
+
+    auto it = s_types.find( aMessage.type_url() );
+
+    if( it != s_types.end() )
+        return it->second;
+
+    return std::nullopt;
+}
+
+
+LIB_ID LibIdFromProto( const types::LibraryIdentifier& aId )
+{
+    return LIB_ID( aId.library_nickname(), aId.entry_name() );
+}
+
+
+types::LibraryIdentifier LibIdToProto( const LIB_ID& aId )
+{
+    types::LibraryIdentifier msg;
+    msg.set_library_nickname( aId.GetLibNickname() );
+    msg.set_entry_name( aId.GetLibItemName() );
+    return msg;
+}
+
+
+void PackVector2( kiapi::common::types::Vector2& aOutput, const VECTOR2I aInput )
+{
+    aOutput.set_x_nm( aInput.x );
+    aOutput.set_y_nm( aInput.y );
+}
+
+VECTOR2I UnpackVector2( const types::Vector2& aInput )
+{
+    return VECTOR2I( aInput.x_nm(), aInput.y_nm() );
+}
+
+
+void PackPolyLine( kiapi::common::types::PolyLine& aOutput, const SHAPE_LINE_CHAIN& aSlc )
+{
+    for( int vertex = 0; vertex < aSlc.PointCount(); vertex = aSlc.NextShape( vertex ) )
+    {
+        if( vertex < 0 )
+            break;
+
+        kiapi::common::types::PolyLineNode* node = aOutput.mutable_nodes()->Add();
+
+        if( aSlc.IsPtOnArc( vertex ) )
+        {
+            const SHAPE_ARC& arc = aSlc.Arc( aSlc.ArcIndex( vertex ) );
+            node->mutable_arc()->mutable_start()->set_x_nm( arc.GetP0().x );
+            node->mutable_arc()->mutable_start()->set_y_nm( arc.GetP0().y );
+            node->mutable_arc()->mutable_mid()->set_x_nm( arc.GetArcMid().x );
+            node->mutable_arc()->mutable_mid()->set_y_nm( arc.GetArcMid().y );
+            node->mutable_arc()->mutable_end()->set_x_nm( arc.GetP1().x );
+            node->mutable_arc()->mutable_end()->set_y_nm( arc.GetP1().y );
+        }
+        else
+        {
+            node->mutable_point()->set_x_nm( aSlc.CPoint( vertex ).x );
+            node->mutable_point()->set_y_nm( aSlc.CPoint( vertex ).y );
+        }
+    }
+
+    aOutput.set_closed( aSlc.IsClosed() );
+}
+
+
+SHAPE_LINE_CHAIN UnpackPolyLine( const kiapi::common::types::PolyLine& aInput )
+{
+    SHAPE_LINE_CHAIN slc;
+
+    for( const kiapi::common::types::PolyLineNode& node : aInput.nodes() )
+    {
+        if( node.has_point() )
+        {
+            slc.Append( VECTOR2I( node.point().x_nm(), node.point().y_nm() ) );
+        }
+        else if( node.has_arc() )
+        {
+            slc.Append( SHAPE_ARC( VECTOR2I( node.arc().start().x_nm(), node.arc().start().y_nm() ),
+                                   VECTOR2I( node.arc().mid().x_nm(), node.arc().mid().y_nm() ),
+                                   VECTOR2I( node.arc().end().x_nm(), node.arc().end().y_nm() ),
+                                   0 /* don't care about width here */ ) );
+        }
+    }
+
+    slc.SetClosed( aInput.closed() );
+
+    return slc;
+}
+
+} // namespace kiapi::common

common/base_screen.cpp

@@ -86,9 +86,9 @@ const wxString& BASE_SCREEN::GetPageNumber() const
 void BASE_SCREEN::Show( int nestLevel, std::ostream& os ) const
 {
     // for now, make it look like XML, expand on this later.
-    NestedSpace( nestLevel, os ) << '<' << GetClass().Lower().mb_str() << wxS( ">\n" );
+    NestedSpace( nestLevel, os ) << '<' << GetClass().Lower().mb_str() << ">\n";
 
-    NestedSpace( nestLevel, os ) << "</" << GetClass().Lower().mb_str() << wxS( ">\n" );
+    NestedSpace( nestLevel, os ) << "</" << GetClass().Lower().mb_str() << ">\n";
 }
 
 #endif

common/bitmap_base.cpp

@@ -455,7 +455,7 @@ void BITMAP_BASE::Rotate( bool aRotateCCW )
         m_image->SetOption( wxIMAGE_OPTION_RESOLUTIONX, resX);
         m_image->SetOption( wxIMAGE_OPTION_RESOLUTIONY, resY);
 
-        m_rotation += ( aRotateCCW ? -ANGLE_90 : ANGLE_90 );
+        m_rotation += ( aRotateCCW ? ANGLE_90 : -ANGLE_90 );
         rebuildBitmap( false );
         UpdateImageDataBuffer();
     }