Initial jobset creation and running within the CLI and GUI.

Incomplete, just pushing this before feature freeze, much fixing left

.clang-format

@@ -0,0 +1,57 @@
+# minimum clang-format 10
+BasedOnStyle: LLVM
+AccessModifierOffset: -4
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: true
+AlignOperands: true
+AlignTrailingComments: true
+AllowAllConstructorInitializersOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: InlineOnly
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: None
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: true
+BinPackParameters: true
+BreakBeforeBinaryOperators: NonAssignment
+BreakBeforeBraces: Allman
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: AfterColon
+BreakConstructorInitializersBeforeComma: false
+BreakStringLiterals: true
+ColumnLimit: 100
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 8
+ContinuationIndentWidth: 8
+Cpp11BracedListStyle: false
+DerivePointerAlignment: false
+DisableFormat: false
+ForEachMacros: [ BOOST_FOREACH ]
+IndentCaseLabels: false
+IndentWidth: 4
+IndentWrappedFunctionNames: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+Language: Cpp
+MaxEmptyLinesToKeep: 2
+NamespaceIndentation: Inner
+PointerAlignment: Left
+ReflowComments: false
+SortIncludes: false
+SpaceAfterCStyleCast: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: Never
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: true
+SpacesInSquareBrackets: false
+Standard: c++11
+TabWidth: 4
+UseTab: Never

.gitattributes

@@ -30,3 +30,7 @@ bitmaps_png/cpp_*/*.cpp     generated
 # Lemon grammars
 common/libeval/grammar.c    generated
 common/libeval/grammar.h    generated
+
+# Scripts
+*.sh    text eol=lf
+*.bat   text eol=crlf

.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
@@ -58,6 +56,7 @@ qa/tests/output/**
 demos/**/*-bak
 demos/**/_autosave-*
 demos/**/fp-info-cache
+demos/**/~*.lck
 
 # MacOS package info created by CMake
 bitmap2component/Info.plist
@@ -103,6 +102,9 @@ __pycache__
 .editorconfig
 CMakeSettings.json
 .vscode/
+compile_commands.json
+/vcpkg_installed
+CMakePresets.json
 
 # Sublime Text
 *.sublime-*
@@ -111,6 +113,10 @@ CMakeSettings.json
 .kdev4/
 *.kdev4
 
+# Qt Creator
+CMakeLists.txt.user
+*.autosave
+
 # Translations
 *.mo
 i18n_status.svg

.gitlab-ci.yml

@@ -3,9 +3,12 @@ stages:
   - test
   - report
 
+variables:
+  DEFAULT_FEDORA_IMAGE: registry.gitlab.com/kicad/kicad-ci/source_containers/master/fedora:40
+
 default:
   image:
-    name: registry.gitlab.com/kicad/kicad-ci/source_containers/master/fedora:36
+    name: $DEFAULT_FEDORA_IMAGE
     entrypoint: ["/bin/sh", "-c"]
 
 include:

.gitlab/Fedora-Linux-CI.yml

@@ -6,7 +6,7 @@
 # Don't tag until we have separate CI for MRs
 #  tags:
 #    - kicad-fedora
-  image: registry.gitlab.com/kicad/kicad-ci/source_containers/master/fedora:38
+  image: $DEFAULT_FEDORA_IMAGE
   extends: .only_code
   interruptible: false
   cache:
@@ -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,8 +40,9 @@
     when: always
     paths:
       - build/linux/3d-viewer/
+      - build/linux/api/libkiapi.so*
       - build/linux/common/libkicommon.so*
-      - build/linux/common/gal/libgal.so*
+      - build/linux/common/gal/libkigal.so*
       - build/linux/eeschema/_eeschema.kiface
       - build/linux/kicad/kicad-cli
       - build/linux/pcbnew/pcbnew.py
@@ -57,16 +59,18 @@ fedora_build_linux_kicad:
   extends: .fedora_build_linux_base
   tags:
     - kicad-fedora
-  only:    
+  only:
     variables:
       - $CI_PROJECT_ROOT_NAMESPACE == "kicad"
 
 fedora_build_linux_public:
   extends: .fedora_build_linux_base
-  except:    
+  tags:
+    - saas-linux-medium-amd64
+  except:
     variables:
       - $CI_PROJECT_ROOT_NAMESPACE == "kicad"
-  
+
 
 # Upload the compilation log in an easily downloadable form
 .fedora_report_build_warn:
@@ -90,7 +94,7 @@ fedora_report_build_warn_kicad:
   needs:
     - job: fedora_build_linux_kicad
       artifacts: true
-  only:    
+  only:
     variables:
       - $CI_PROJECT_ROOT_NAMESPACE == "kicad"
 
@@ -99,10 +103,10 @@ fedora_report_build_warn_public:
   needs:
     - job: fedora_build_linux_public
       artifacts: true
-  except:    
+  except:
     variables:
       - $CI_PROJECT_ROOT_NAMESPACE == "kicad"
-  
+
 
 # Report on the metrics of the code
 .fedora_report_metrics:
@@ -123,7 +127,7 @@ fedora_report_metrics_kicad:
   needs:
     - job: fedora_build_linux_kicad
       artifacts: true
-  only:    
+  only:
     variables:
       - $CI_PROJECT_ROOT_NAMESPACE == "kicad"
 
@@ -132,7 +136,7 @@ fedora_report_metrics_public:
   needs:
     - job: fedora_build_linux_public
       artifacts: true
-  except:    
+  except:
     variables:
       - $CI_PROJECT_ROOT_NAMESPACE == "kicad"
 
@@ -140,17 +144,17 @@ fedora_report_metrics_public:
 # Run the code unit tests.
 ##########################################################################
 .fedora_qa:
-  image: registry.gitlab.com/kicad/kicad-ci/source_containers/master/fedora:38
+  image: $DEFAULT_FEDORA_IMAGE
   extends:
     - .unit_test
     - .only_code
-  before_script: 
+  before_script:
     - if [ "$TEST" == "cli" ] || [ "$TEST" == "python" ]; then python3 -m pip install -r qa/tests/requirements.txt; fi
     - if [ "$TEST" == "cli" ]; then sudo dnf -y install gerbv; fi
   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
@@ -159,7 +163,7 @@ fedora_qa_kicad:
   needs:
     - job: fedora_build_linux_kicad
       artifacts: true
-  only:    
+  only:
     variables:
       - $CI_PROJECT_ROOT_NAMESPACE == "kicad"
 
@@ -168,6 +172,6 @@ fedora_qa_public:
   needs:
     - job: fedora_build_linux_public
       artifacts: true
-  except:    
+  except:
     variables:
       - $CI_PROJECT_ROOT_NAMESPACE == "kicad"

.gitlab/Windows-CI.yml

@@ -8,7 +8,9 @@ win64_build:
   interruptible: false
   image: registry.gitlab.com/kicad/kicad-ci/windows-build-image/win1809-msvc:latest
   variables:
-    VCPKG_BINARY_SOURCES: 'nuget,kicad,readwrite'
+    # Switch the compressor to fastzip and reduce the compression level
+    FF_USE_FASTZIP: "true"
+    CACHE_COMPRESSION_LEVEL: "fast"
   cache:
     key: win64-vcpkg-"$CI_COMMIT_REF_SLUG"
     paths:
@@ -17,12 +19,10 @@ win64_build:
   rules:
     - if: $CI_PIPELINE_SOURCE == "schedule"
       when: never
-    - if: $CI_PROJECT_ROOT_NAMESPACE == "kicad" && $CI_COMMIT_REF_PROTECTED == "true"
+    - if: $CI_PROJECT_ROOT_NAMESPACE == "kicad"
   script:
     - C:\builder\build.ps1 -Env -Arch x64
     - $vcpkgCache=Join-Path -Path (Get-Location) -ChildPath ".vcpkgCache";$env:VCPKG_DEFAULT_BINARY_CACHE=$vcpkgCache;New-Item -ItemType Directory -Force -Path $vcpkgCache
-    - nuget.exe sources add -Name kicad -Source "https://nuget.kicad.org:443/v3/index.json"
-    - nuget.exe setapikey $env:KICAD_NUGET_KEY -Source "https://nuget.kicad.org:443/v3/index.json"
     - mkdir -p build/windows -Force
     - cd build/windows
     - cmake `

.gitlab/coverity.yml

@@ -42,7 +42,7 @@ Coverity:
   tags:
     - coverity
   stage: build
-  image: registry.gitlab.com/kicad/kicad-ci/source_containers/master/fedora:38
+  image: registry.gitlab.com/kicad/kicad-ci/source_containers/master/fedora:40
   rules:
     - if: $CI_PIPELINE_SOURCE == "schedule" && $SCHEDULED_JOB_NAME == "coverity"
   cache:

.gitlab/doxygen.yml

@@ -6,7 +6,7 @@ build_doxygen_docker:
   rules:
     - if: $CI_PIPELINE_SOURCE == "schedule" && $SCHEDULED_JOB_NAME == "doxygen"
   tags:
-    - docker
+    - gitlab-org-docker
   before_script:
     - docker info
     - docker login -u gitlab-ci-token -p "$CI_JOB_TOKEN" "$CI_REGISTRY"

.gitlab/linux-metadata-validate.yml

@@ -5,8 +5,7 @@ validate_linux_metadata:
   stage: test
   needs: []
   interruptible: false
-  # This is the only CI image with the utilities needed for this test
-  image: registry.gitlab.com/kicad/kicad-ci/source_containers/master/fedora:38
+  image: $DEFAULT_FEDORA_IMAGE
   # Due to bug https://github.com/hughsie/appstream-glib/issues/381, this doesn't think our description tag
   # is localized even though it actually is.
   allow_failure: true

.gitlab/macOS-CI.yml

@@ -9,31 +9,13 @@ macos_build:
   rules:
     - if: $CI_PIPELINE_SOURCE == "schedule"
       when: never
-    - if: $CI_PROJECT_ROOT_NAMESPACE == "kicad" && $CI_COMMIT_REF_PROTECTED == "true"
+    - if: $CI_PROJECT_ROOT_NAMESPACE == "kicad"
   script:
     - mkdir -p build/macos
     - cd build/macos
     - cmake
       -G Ninja
-      -DCMAKE_BUILD_TYPE=RelWithDebInfo
-      -DDEFAULT_INSTALL_PATH=/Library/Application\ Support /kicad
-      -DOCC_INCLUDE_DIR=/opt/homebrew/Cellar/opencascade/7.7.2_2/include/opencascade
-      -DOCC_LIBRARY_DIR=/opt/homebrew/Cellar/opencascade/7.7.2_2/Lib
-      -DCMAKE_INSTALL_PREFIX=/Users/ci/kicad-mac-builder/build/kicad-dest
-      -DCMAKE_C_COMPILER=/usr/bin/clang
-      -DCMAKE_CXX_COMPILER=/usr/bin/clang++
-      -DwxWidgets_CONFIG_EXECUTABLE=/Users/ci/kicad-mac-builder/build/wxwidgets-dest/bin/wx-config
-      -DKICAD_BUILD_I18N=ON
-      -DKICAD_SCRIPTING_WXPYTHON=ON
-      -DKICAD_BUILD_PNS_DEBUG_TOOL=ON
-      -DPYTHON_EXECUTABLE=/Users/ci/kicad-mac-builder/build/python-dest/Library/Frameworks/Python.framework/Versions/Current/bin/python3
-      -DPYTHON_INCLUDE_DIR=/Users/ci/kicad-mac-builder/build/python-dest/Library/Frameworks/Python.framework/Versions/Current/include/python3.9/
-      -DPYTHON_LIBRARY=/Users/ci/kicad-mac-builder/build/python-dest/Library/Frameworks/Python.framework/Versions/Current/lib/libpython3.9.dylib
-      -DPYTHON_SITE_PACKAGE_PATH=/Users/ci/kicad-mac-builder/build/python-dest/Library/Frameworks/Python.framework/Versions/Current/lib/python3.9/site-packages
-      -DPYTHON_FRAMEWORK=/Users/ci/kicad-mac-builder/build/python-dest/Library/Frameworks/Python.framework
-      -DNGSPICE_INCLUDE_DIR=/Users/ci/kicad-mac-builder/build/ngspice-dest/include
-      -DNGSPICE_LIBRARY=/Users/ci/kicad-mac-builder/build/ngspice-dest/lib/libngspice.dylib
-      -DKICAD_USE_3DCONNEXION=ON
+      -DCMAKE_TOOLCHAIN_FILE=/Users/ci/kicad-mac-builder/toolchain/kicad-mac-builder.cmake
       ../../
     - cmake --build . 2>&1 | tee compilation_log.txt
     - cd ../../

.gitlab/templates.yml

@@ -18,7 +18,7 @@
   stage: test
   when: on_success
   variables:
-    BOOST_TEST_LOGGER: 'JUNIT,all,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

@@ -33,14 +33,6 @@
 #include <wx/log.h>
 #include <wx/stdpaths.h>
 
-#include <boost/version.hpp>
-
-#if BOOST_VERSION >= 106800
-#include <boost/uuid/detail/sha1.hpp>
-#else
-#include <boost/uuid/sha1.hpp>
-#endif
-
 #include "3d_cache.h"
 #include "3d_info.h"
 #include "3d_plugin_manager.h"
@@ -50,6 +42,7 @@
 #include <advanced_config.h>
 #include <common.h>     // For ExpandEnvVarSubstitutions
 #include <filename_resolver.h>
+#include <mmh3_hash.h>
 #include <paths.h>
 #include <pgm_base.h>
 #include <project.h>
@@ -63,18 +56,6 @@
 static std::mutex mutex3D_cache;
 
 
-static bool isSHA1Same( const unsigned char* shaA, const unsigned char* shaB ) noexcept
-{
-    for( int i = 0; i < 20; ++i )
-    {
-        if( shaA[i] != shaB[i] )
-            return false;
-    }
-
-    return true;
-}
-
-
 static bool checkTag( const char* aTag, void* aPluginMgrPtr )
 {
     if( nullptr == aTag || nullptr == aPluginMgrPtr )
@@ -86,51 +67,17 @@ static bool checkTag( const char* aTag, void* aPluginMgrPtr )
 }
 
 
-static const wxString sha1ToWXString( const unsigned char* aSHA1Sum )
-{
-    unsigned char uc;
-    unsigned char tmp;
-    char          sha1[41];
-    int           j = 0;
-
-    for( int i = 0; i < 20; ++i )
-    {
-        uc = aSHA1Sum[i];
-        tmp = uc / 16;
-
-        if( tmp > 9 )
-            tmp += 87;
-        else
-            tmp += 48;
-
-        sha1[j++] = tmp;
-        tmp = uc % 16;
-
-        if( tmp > 9 )
-            tmp += 87;
-        else
-            tmp += 48;
-
-        sha1[j++] = tmp;
-    }
-
-    sha1[j] = 0;
-
-    return wxString::FromUTF8Unchecked( sha1 );
-}
-
-
 class S3D_CACHE_ENTRY
 {
 public:
     S3D_CACHE_ENTRY();
     ~S3D_CACHE_ENTRY();
 
-    void SetSHA1( const unsigned char* aSHA1Sum );
+    void SetHash( const HASH_128& aHash );
     const wxString GetCacheBaseName();
 
     wxDateTime    modTime;      // file modification time
-    unsigned char sha1sum[20];
+    HASH_128      m_hash;
     std::string   pluginInfo;   // PluginName:Version string
     SCENEGRAPH*   sceneData;
     S3DMODEL*     renderData;
@@ -140,7 +87,7 @@ private:
     S3D_CACHE_ENTRY( const S3D_CACHE_ENTRY& source );
     S3D_CACHE_ENTRY& operator=( const S3D_CACHE_ENTRY& source );
 
-    wxString m_CacheBaseName;  // base name of cache file (a SHA1 digest)
+    wxString m_CacheBaseName;  // base name of cache file
 };
 
 
@@ -148,7 +95,7 @@ S3D_CACHE_ENTRY::S3D_CACHE_ENTRY()
 {
     sceneData = nullptr;
     renderData = nullptr;
-    memset( sha1sum, 0, 20 );
+    m_hash.Clear();
 }
 
 
@@ -161,24 +108,16 @@ S3D_CACHE_ENTRY::~S3D_CACHE_ENTRY()
 }
 
 
-void S3D_CACHE_ENTRY::SetSHA1( const unsigned char* aSHA1Sum )
+void S3D_CACHE_ENTRY::SetHash( const HASH_128& aHash )
 {
-    if( nullptr == aSHA1Sum )
-    {
-        wxLogTrace( MASK_3D_CACHE, wxT( "%s:%s:%d\n * [BUG] NULL passed for aSHA1Sum" ),
-                    __FILE__, __FUNCTION__, __LINE__ );
-
-        return;
-    }
-
-    memcpy( sha1sum, aSHA1Sum, 20 );
+    m_hash = aHash;
 }
 
 
 const wxString S3D_CACHE_ENTRY::GetCacheBaseName()
 {
     if( m_CacheBaseName.empty() )
-        m_CacheBaseName = sha1ToWXString( sha1sum );
+        m_CacheBaseName = m_hash.ToString();
 
     return m_CacheBaseName;
 }
@@ -202,12 +141,12 @@ S3D_CACHE::~S3D_CACHE()
 
 
 SCENEGRAPH* S3D_CACHE::load( const wxString& aModelFile, const wxString& aBasePath,
-                             S3D_CACHE_ENTRY** aCachePtr )
+                             S3D_CACHE_ENTRY** aCachePtr, const EMBEDDED_FILES* aEmbeddedFiles )
 {
     if( aCachePtr )
         *aCachePtr = nullptr;
 
-    wxString full3Dpath = m_FNResolver->ResolvePath( aModelFile, aBasePath );
+    wxString full3Dpath = m_FNResolver->ResolvePath( aModelFile, aBasePath, aEmbeddedFiles );
 
     if( full3Dpath.empty() )
     {
@@ -234,13 +173,13 @@ SCENEGRAPH* S3D_CACHE::load( const wxString& aModelFile, const wxString& aBasePa
 
             if( fmdate != mi->second->modTime )
             {
-                unsigned char hashSum[20];
-                getSHA1( full3Dpath, hashSum );
+                HASH_128 hashSum;
+                getHash( full3Dpath, hashSum );
                 mi->second->modTime = fmdate;
 
-                if( !isSHA1Same( hashSum, mi->second->sha1sum ) )
+                if( hashSum != mi->second->m_hash )
                 {
-                    mi->second->SetSHA1( hashSum );
+                    mi->second->SetHash( hashSum );
                     reload = true;
                 }
             }
@@ -272,9 +211,9 @@ SCENEGRAPH* S3D_CACHE::load( const wxString& aModelFile, const wxString& aBasePa
 }
 
 
-SCENEGRAPH* S3D_CACHE::Load( const wxString& aModelFile, const wxString& aBasePath )
+SCENEGRAPH* S3D_CACHE::Load( const wxString& aModelFile, const wxString& aBasePath, const EMBEDDED_FILES* aEmbeddedFiles )
 {
-    return load( aModelFile, aBasePath );
+    return load( aModelFile, aBasePath, nullptr, aEmbeddedFiles );
 }
 
 
@@ -283,13 +222,13 @@ SCENEGRAPH* S3D_CACHE::checkCache( const wxString& aFileName, S3D_CACHE_ENTRY**
     if( aCachePtr )
         *aCachePtr = nullptr;
 
-    unsigned char    sha1sum[20];
+    HASH_128    hashSum;
     S3D_CACHE_ENTRY* ep = new S3D_CACHE_ENTRY;
     m_CacheList.push_back( ep );
     wxFileName fname( aFileName );
     ep->modTime = fname.GetModificationTime();
 
-    if( !getSHA1( aFileName, sha1sum ) || m_CacheDir.empty() )
+    if( !getHash( aFileName, hashSum ) || m_CacheDir.empty() )
     {
         // just in case we can't get a hash digest (for example, on access issues)
         // or we do not have a configured cache file directory, we create an
@@ -327,7 +266,7 @@ SCENEGRAPH* S3D_CACHE::checkCache( const wxString& aFileName, S3D_CACHE_ENTRY**
     if( aCachePtr )
         *aCachePtr = ep;
 
-    ep->SetSHA1( sha1sum );
+    ep->SetHash( hashSum );
 
     wxString bname = ep->GetCacheBaseName();
     wxString cachename = m_CacheDir + bname + wxT( ".3dc" );
@@ -345,7 +284,7 @@ SCENEGRAPH* S3D_CACHE::checkCache( const wxString& aFileName, S3D_CACHE_ENTRY**
 }
 
 
-bool S3D_CACHE::getSHA1( const wxString& aFileName, unsigned char* aSHA1Sum )
+bool S3D_CACHE::getHash( const wxString& aFileName, HASH_128& aHash )
 {
     if( aFileName.empty() )
     {
@@ -355,14 +294,6 @@ bool S3D_CACHE::getSHA1( const wxString& aFileName, unsigned char* aSHA1Sum )
         return false;
     }
 
-    if( nullptr == aSHA1Sum )
-    {
-        wxLogTrace( MASK_3D_CACHE, wxT( "%s\n * [BUG] NULL pointer passed for aMD5Sum" ),
-                    __FILE__, __FUNCTION__, __LINE__ );
-
-        return false;
-    }
-
 #ifdef _WIN32
     FILE* fp = _wfopen( aFileName.wc_str(), L"rb" );
 #else
@@ -372,31 +303,15 @@ bool S3D_CACHE::getSHA1( const wxString& aFileName, unsigned char* aSHA1Sum )
     if( nullptr == fp )
         return false;
 
-    boost::uuids::detail::sha1 dblock;
-    unsigned char block[4096];
+    MMH3_HASH dblock( 0xA1B2C3D4 );
+    std::vector<char> block( 4096 );
     size_t bsize = 0;
 
-    while( ( bsize = fread( &block, 1, 4096, fp ) ) > 0 )
-        dblock.process_bytes( block, bsize );
+    while( ( bsize = fread( block.data(), 1, 4096, fp ) ) > 0 )
+        dblock.add( block );
 
     fclose( fp );
-    unsigned int digest[5];
-    dblock.get_digest( digest );
-
-    // ensure MSB order
-    for( int i = 0; i < 5; ++i )
-    {
-        int idx = i << 2;
-        unsigned int tmp = digest[i];
-        aSHA1Sum[idx+3] = tmp & 0xff;
-        tmp >>= 8;
-        aSHA1Sum[idx+2] = tmp & 0xff;
-        tmp >>= 8;
-        aSHA1Sum[idx+1] = tmp & 0xff;
-        tmp >>= 8;
-        aSHA1Sum[idx] = tmp & 0xff;
-    }
-
+    aHash = dblock.digest();
     return true;
 }
 
@@ -631,10 +546,11 @@ void S3D_CACHE::ClosePlugins()
 }
 
 
-S3DMODEL* S3D_CACHE::GetModel( const wxString& aModelFileName, const wxString& aBasePath )
+S3DMODEL* S3D_CACHE::GetModel( const wxString& aModelFileName, const wxString& aBasePath,
+                               const EMBEDDED_FILES* aEmbeddedFiles )
 {
     S3D_CACHE_ENTRY* cp = nullptr;
-    SCENEGRAPH*      sp = load( aModelFileName, aBasePath,&cp );
+    SCENEGRAPH*      sp = load( aModelFileName, aBasePath, &cp, aEmbeddedFiles );
 
     if( !sp )
         return nullptr;

3d-viewer/3d_cache/3d_cache.h

@@ -32,12 +32,14 @@
 #include "3d_info.h"
 #include <core/typeinfo.h>
 #include "string_utils.h"
+#include <hash_128.h>
 #include <list>
 #include <map>
 #include "plugins/3dapi/c3dmodel.h"
 #include <project.h>
 #include <wx/string.h>
 
+class  EMBEDDED_FILES;
 class  PGM_BASE;
 class  S3D_CACHE_ENTRY;
 class  SCENEGRAPH;
@@ -55,9 +57,9 @@ public:
     S3D_CACHE();
     virtual ~S3D_CACHE();
 
-    KICAD_T Type() noexcept override
+    PROJECT::ELEM ProjectElementType() noexcept override
     {
-        return S3D_CACHE_T;
+        return PROJECT::ELEM::S3DCACHE;
     }
 
     /**
@@ -93,9 +95,10 @@ public:
      *
      * @param aModelFile is the partial or full path to the model to be loaded.
      * @param aBasePath is the path to search for any relative files
+     * @param aEmbeddedFiles is a pointer to the embedded files list.
      * @return true if the model was successfully loaded, otherwise false.
      */
-    SCENEGRAPH* Load( const wxString& aModelFile, const wxString& aBasePath );
+    SCENEGRAPH* Load( const wxString& aModelFile, const wxString& aBasePath, const EMBEDDED_FILES* aEmbeddedFiles );
 
     FILENAME_RESOLVER* GetResolver() noexcept;
 
@@ -123,9 +126,11 @@ public:
      * structure for display by a renderer.
      *
      * @param aModelFileName is the full path to the model to be loaded.
+     * @param aBasePath is the path to search for any relative files.
+     * @param aEmbeddedFiles is a pointer to the embedded files list.
      * @return is a pointer to the render data or NULL if not available.
      */
-    S3DMODEL* GetModel( const wxString& aModelFileName, const wxString& aBasePath );
+    S3DMODEL* GetModel( const wxString& aModelFileName, const wxString& aBasePath, const EMBEDDED_FILES* aEmbeddedFiles );
 
     /**
      * Delete up old cache files in cache directory.
@@ -153,10 +158,10 @@ private:
      * Calculate the SHA1 hash of the given file.
      *
      * @param aFileName file name (full path).
-     * @param aSHA1Sum a 20 byte character array to hold the SHA1 hash.
+     * @param aHash a 128 bit hash to hold the hash.
      * @return true on  success, otherwise false.
      */
-    bool getSHA1( const wxString& aFileName, unsigned char* aSHA1Sum );
+    bool getHash( const wxString& aFileName, HASH_128& aHash );
 
     // load scene data from a cache file
     bool loadCacheData( S3D_CACHE_ENTRY* aCacheItem );
@@ -165,7 +170,9 @@ private:
     bool saveCacheData( S3D_CACHE_ENTRY* aCacheItem );
 
     // the real load function (can supply a cache entry pointer to member functions)
-    SCENEGRAPH* load( const wxString& aModelFile, const wxString& aBasePath, S3D_CACHE_ENTRY** aCachePtr = nullptr );
+    SCENEGRAPH* load( const wxString& aModelFile, const wxString& aBasePath,
+                      S3D_CACHE_ENTRY** aCachePtr = nullptr,
+                      const EMBEDDED_FILES*   aEmbeddedFiles = nullptr );
 
     /// cache entries
     std::list< S3D_CACHE_ENTRY* > m_CacheList;

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

@@ -3,7 +3,7 @@
  *
  * Copyright (C) 2015-2023 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
@@ -31,9 +31,11 @@
 #include <3d_rendering/raytracing/shapes2D/polygon_2d.h>
 #include <board.h>
 #include <dialogs/dialog_color_picker.h>
+#include <layer_range.h>
 #include <3d_math.h>
 #include "3d_fastmath.h"
 #include <geometry/geometry_utils.h>
+#include <lset.h>
 #include <pgm_base.h>
 #include <settings/settings_manager.h>
 #include <wx/log.h>
@@ -95,8 +97,6 @@ BOARD_ADAPTER::BOARD_ADAPTER() :
 {
     wxLogTrace( m_logTrace, wxT( "BOARD_ADAPTER::BOARD_ADAPTER" ) );
 
-    ReloadColorSettings();
-
     m_boardPos = VECTOR2I();
     m_boardSize = VECTOR2I();
     m_boardCenter = SFVEC3F( 0.0f );
@@ -142,11 +142,13 @@ BOARD_ADAPTER::BOARD_ADAPTER() :
     m_offboardPadsFront = nullptr;
     m_offboardPadsBack = nullptr;
 
-    m_frontPlatedPadPolys = nullptr;
-    m_backPlatedPadPolys = nullptr;
+    m_frontPlatedPadAndGraphicPolys = nullptr;
+    m_backPlatedPadAndGraphicPolys = nullptr;
     m_frontPlatedCopperPolys = nullptr;
     m_backPlatedCopperPolys = nullptr;
 
+    ReloadColorSettings();
+
     if( !g_ColorsLoaded )
     {
 #define ADD_COLOR( list, r, g, b, a, name ) \
@@ -229,7 +231,7 @@ void BOARD_ADAPTER::ReloadColorSettings() noexcept
 
     try
     {
-        cfg = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
+        cfg = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" );
     }
     catch( const std::runtime_error& e )
     {
@@ -239,6 +241,7 @@ void BOARD_ADAPTER::ReloadColorSettings() noexcept
     if( cfg )
     {
         m_colors = Pgm().GetSettingsManager().GetColorSettings( cfg->m_ColorTheme );
+        GetBoardEditorCopperLayerColors( cfg );
     }
 }
 
@@ -371,6 +374,8 @@ void BOARD_ADAPTER::InitSettings( REPORTER* aStatusReporter, REPORTER* aWarningR
     if( !m_board || !m_board->IsFootprintHolder() )
         m_biuTo3Dunits *= 1.6f;
 
+    ReloadColorSettings();
+
     m_boardBodyThickness3DU        = DEFAULT_BOARD_THICKNESS      * m_biuTo3Dunits;
     m_frontCopperThickness3DU      = DEFAULT_COPPER_THICKNESS     * m_biuTo3Dunits;
     m_backCopperThickness3DU       = DEFAULT_COPPER_THICKNESS     * m_biuTo3Dunits;
@@ -397,13 +402,18 @@ void BOARD_ADAPTER::InitSettings( REPORTER* aStatusReporter, REPORTER* aWarningR
                     break;
 
                 case BS_ITEM_TYPE_COPPER:
-                    if( item->GetBrdLayerId() == F_Cu )
-                        m_frontCopperThickness3DU = item->GetThickness() * m_biuTo3Dunits;
-                    else if( item->GetBrdLayerId() == B_Cu )
-                        m_backCopperThickness3DU = item->GetThickness() * m_biuTo3Dunits;
-                    else if( item->IsEnabled() )
-                        thickness += item->GetThickness();
+                {
+                    // The copper thickness must be > 0 to avoid draw issues (divide by 0 for instance)
+                    // We use a minimal arbitrary value = 1 micrometer here:
+                    int copper_thickness = std::max( item->GetThickness(), pcbIUScale.mmToIU( 0.001 ) );
 
+                    if( item->GetBrdLayerId() == F_Cu )
+                        m_frontCopperThickness3DU = copper_thickness * m_biuTo3Dunits;
+                    else if( item->GetBrdLayerId() == B_Cu )
+                        m_backCopperThickness3DU = copper_thickness * m_biuTo3Dunits;
+                    else if( item->IsEnabled() )
+                        thickness += copper_thickness;
+                }
                     break;
 
                 default:
@@ -417,8 +427,8 @@ void BOARD_ADAPTER::InitSettings( REPORTER* aStatusReporter, REPORTER* aWarningR
 
     // Init  Z position of each layer
     // calculate z position for each copper layer
-    // Zstart = -m_epoxyThickness / 2.0 is the z position of the back (bottom layer) (layer id = 31)
-    // Zstart = +m_epoxyThickness / 2.0 is the z position of the front (top layer) (layer id = 0)
+    // Zstart = -m_epoxyThickness / 2.0 is the z position of the back (bottom layer) (layer id = B_Cu)
+    // Zstart = +m_epoxyThickness / 2.0 is the z position of the front (top layer) (layer id = F_Cu)
 
     //  ____==__________==________==______ <- Bottom = +m_epoxyThickness / 2.0,
     // |                                  |   Top = Bottom + m_copperThickness
@@ -426,39 +436,54 @@ void BOARD_ADAPTER::InitSettings( REPORTER* aStatusReporter, REPORTER* aWarningR
     //   ==         ==         ==     ==   <- Bottom = -m_epoxyThickness / 2.0,
     //                                        Top = Bottom - m_copperThickness
 
-    unsigned int layer;
-
-    for( layer = 0; layer < m_copperLayersCount; ++layer )
+    // Generate the Z position of copper layers
+    // A copper layer Z position has 2 values: its top Z position and its bottom Z position
+    for( auto layer_id : LAYER_RANGE( F_Cu, B_Cu, m_copperLayersCount ) )
     {
         // This approximates internal layer positions (because we're treating all the dielectric
         // layers as having the same thickness).  But we don't render them anyway so it doesn't
         // really matter.
-        m_layerZcoordBottom[layer] = m_boardBodyThickness3DU / 2.0f -
-                                     (m_boardBodyThickness3DU * layer / (m_copperLayersCount - 1) );
+        int layer_pos;      // the position of the copper layer from board top to bottom
 
-        if( layer < (m_copperLayersCount / 2) )
-            m_layerZcoordTop[layer] = m_layerZcoordBottom[layer] + m_frontCopperThickness3DU;
+        switch( layer_id )
+        {
+            case F_Cu: layer_pos = 0; break;
+            case B_Cu: layer_pos =  m_copperLayersCount - 1; break;
+            default: layer_pos = ( layer_id - B_Cu )/2; break;
+        };
+
+        m_layerZcoordBottom[layer_id] = m_boardBodyThickness3DU / 2.0
+                                        - ( m_boardBodyThickness3DU * layer_pos
+                                            / ( m_copperLayersCount - 1 ) );
+
+        if( layer_pos < (m_copperLayersCount / 2) )
+            m_layerZcoordTop[layer_id] = m_layerZcoordBottom[layer_id] + m_frontCopperThickness3DU;
         else
-            m_layerZcoordTop[layer] = m_layerZcoordBottom[layer] - m_backCopperThickness3DU;
+            m_layerZcoordTop[layer_id] = m_layerZcoordBottom[layer_id] - m_backCopperThickness3DU;
     }
 
     #define layerThicknessMargin 1.1
     const float zpos_offset = m_nonCopperLayerThickness3DU * layerThicknessMargin;
 
-    // Fill remaining unused copper layers and back layer zpos with -m_boardBodyThickness / 2.0
-    for( ; layer < MAX_CU_LAYERS; layer++ )
-    {
-        m_layerZcoordBottom[layer] = -( m_boardBodyThickness3DU / 2.0f );
-        m_layerZcoordTop[layer]    = -( m_boardBodyThickness3DU / 2.0f ) - m_backCopperThickness3DU;
-    }
-
     // This is the top of the copper layer thickness.
     const float zpos_copperTop_back  = m_layerZcoordTop[B_Cu];
     const float zpos_copperTop_front = m_layerZcoordTop[F_Cu];
 
-    // calculate z position for each non copper layer
+    // Fill not copper layers zpos with a dummy position
+    // (m_layerZcoordTop[B_Cu]with a small margin)
+    // Some important layer position will be set later
+    for( int layer_id = 0; layer_id < PCB_LAYER_ID_COUNT; layer_id++ )
+    {
+        if( IsCopperLayer( (PCB_LAYER_ID)layer_id ) )
+            continue;
+
+        m_layerZcoordBottom[(PCB_LAYER_ID)layer_id] = zpos_copperTop_back - 2.0f * zpos_offset;
+        m_layerZcoordTop[(PCB_LAYER_ID)layer_id]    = m_layerZcoordBottom[(PCB_LAYER_ID)layer_id] - m_backCopperThickness3DU;
+    }
+
+    // calculate z position for each technical layer
     // Solder mask and Solder paste have the same Z position
-    for( int layer_id = MAX_CU_LAYERS; layer_id < PCB_LAYER_ID_COUNT; ++layer_id )
+    for( PCB_LAYER_ID layer_id : { B_Adhes, B_Mask, B_Paste, F_Adhes, F_Mask, F_Paste, B_SilkS, F_SilkS } )
     {
         float zposTop;
         float zposBottom;
@@ -505,14 +530,11 @@ void BOARD_ADAPTER::InitSettings( REPORTER* aStatusReporter, REPORTER* aWarningR
             zposTop    = zposBottom + m_nonCopperLayerThickness3DU;
             break;
 
-        // !TODO: review
         default:
-            zposTop = zpos_copperTop_front + (layer_id - MAX_CU_LAYERS + 3.0f) * zpos_offset;
-            zposBottom = zposTop - m_nonCopperLayerThickness3DU;
             break;
         }
 
-        m_layerZcoordTop[layer_id]    = zposTop;
+        m_layerZcoordTop[layer_id] = zposTop;
         m_layerZcoordBottom[layer_id] = zposBottom;
     }
 
@@ -531,7 +553,7 @@ void BOARD_ADAPTER::InitSettings( REPORTER* aStatusReporter, REPORTER* aWarningR
     m_boardBoundingBox = BBOX_3D( boardMin, boardMax );
 
 #ifdef PRINT_STATISTICS_3D_VIEWER
-    unsigned stats_startCreateBoardPolyTime = GetRunningMicroSecs();
+    int64_t stats_startCreateBoardPolyTime = GetRunningMicroSecs();
 #endif
 
     if( aStatusReporter )
@@ -586,17 +608,42 @@ std::map<int, COLOR4D> BOARD_ADAPTER::GetDefaultColors() const
 }
 
 
+void BOARD_ADAPTER::GetBoardEditorCopperLayerColors( PCBNEW_SETTINGS* aCfg )
+{
+    m_BoardEditorColors.clear();
+
+    if( m_copperLayersCount <= 0 )
+        return;
+
+    COLOR_SETTINGS* settings = Pgm().GetSettingsManager().GetColorSettings( aCfg->m_ColorTheme );
+
+    LSET copperLayers = LSET::AllCuMask();
+
+    for( auto layer : LAYER_RANGE( F_Cu, B_Cu, m_copperLayersCount ) )
+    {
+        m_BoardEditorColors[ layer ] = settings->GetColor( layer );
+    }
+}
+
+
 std::map<int, COLOR4D> BOARD_ADAPTER::GetLayerColors() const
 {
     std::map<int, COLOR4D> colors;
 
-    if( m_Cfg->m_CurrentPreset == FOLLOW_PCB || m_Cfg->m_CurrentPreset == FOLLOW_PLOT_SETTINGS )
+    if( LAYER_PRESET_3D* preset = m_Cfg->FindPreset( m_Cfg->m_CurrentPreset ) )
     {
-        colors = GetDefaultColors();
+        colors = preset->colors;
+    }
+    else
+    {
+        COLOR_SETTINGS* settings = Pgm().GetSettingsManager().GetColorSettings();
 
-        if( !m_board )
-            return colors;
+        for( const auto& [ layer, defaultColor /* unused */ ] : GetDefaultColors() )
+            colors[ layer ] = settings->GetColor( layer );
+    }
 
+    if( m_Cfg->m_UseStackupColors && m_board )
+    {
         const BOARD_STACKUP& stackup = m_board->GetDesignSettings().GetStackupDescriptor();
         KIGFX::COLOR4D       bodyColor( 0, 0, 0, 0 );
 
@@ -684,29 +731,13 @@ std::map<int, COLOR4D> BOARD_ADAPTER::GetLayerColors() const
         {
             colors[ LAYER_3D_COPPER_TOP ] = findColor( wxT( "Silver" ), g_FinishColors );
         }
-
-        SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
-        PCBNEW_SETTINGS*  pcbnewSettings = mgr.GetAppSettings<PCBNEW_SETTINGS>();
-        COLOR_SETTINGS*   pcbnewColors = mgr.GetColorSettings( pcbnewSettings->m_ColorTheme );
-
-        colors[ LAYER_3D_USER_DRAWINGS ] = pcbnewColors->GetColor( Dwgs_User );
-        colors[ LAYER_3D_USER_COMMENTS ] = pcbnewColors->GetColor( Cmts_User );
-        colors[ LAYER_3D_USER_ECO1 ]     = pcbnewColors->GetColor( Eco1_User );
-        colors[ LAYER_3D_USER_ECO2 ]     = pcbnewColors->GetColor( Eco2_User );
-    }
-    else if( LAYER_PRESET_3D* preset = m_Cfg->FindPreset( m_Cfg->m_CurrentPreset ) )
-    {
-        return preset->colors;
-    }
-    else
-    {
-        COLOR_SETTINGS* settings = Pgm().GetSettingsManager().GetColorSettings();
-
-        for( const auto& [ layer, color ] : GetDefaultColors() )
-            colors[ layer ] = settings->GetColor( layer );
     }
 
     colors[ LAYER_3D_COPPER_BOTTOM ] = colors[ LAYER_3D_COPPER_TOP ];
+
+    for( const auto& [layer, val] : m_ColorOverrides )
+        colors[layer] = val;
+
     return colors;
 }
 
@@ -717,6 +748,8 @@ void BOARD_ADAPTER::SetLayerColors( const std::map<int, COLOR4D>& aColors )
 
     for( const auto& [ layer, color ] : aColors )
         settings->SetColor( layer, color );
+
+    Pgm().GetSettingsManager().SaveColorSettings( settings, "3d_viewer" );
 }
 
 
@@ -861,6 +894,42 @@ std::bitset<LAYER_3D_END> BOARD_ADAPTER::GetVisibleLayers() const
 }
 
 
+std::bitset<LAYER_3D_END> BOARD_ADAPTER::GetDefaultVisibleLayers() const
+{
+    std::bitset<LAYER_3D_END> ret;
+
+    ret.set( LAYER_3D_BOARD,             true );
+    ret.set( LAYER_3D_COPPER_TOP,        true );
+    ret.set( LAYER_3D_COPPER_BOTTOM,     true );
+    ret.set( LAYER_3D_SILKSCREEN_TOP,    true );
+    ret.set( LAYER_3D_SILKSCREEN_BOTTOM, true );
+    ret.set( LAYER_3D_SOLDERMASK_TOP,    true );
+    ret.set( LAYER_3D_SOLDERMASK_BOTTOM, true );
+    ret.set( LAYER_3D_SOLDERPASTE,       true );
+    ret.set( LAYER_3D_ADHESIVE,          true );
+    ret.set( LAYER_3D_USER_COMMENTS,     false );
+    ret.set( LAYER_3D_USER_DRAWINGS,     false );
+    ret.set( LAYER_3D_USER_ECO1,         false );
+    ret.set( LAYER_3D_USER_ECO2,         false );
+
+    ret.set( LAYER_FP_REFERENCES,        true );
+    ret.set( LAYER_FP_VALUES,            true );
+    ret.set( LAYER_FP_TEXT,              true );
+
+    ret.set( LAYER_3D_TH_MODELS,         true );
+    ret.set( LAYER_3D_SMD_MODELS,        true );
+    ret.set( LAYER_3D_VIRTUAL_MODELS,    true );
+    ret.set( LAYER_3D_MODELS_NOT_IN_POS, false );
+    ret.set( LAYER_3D_MODELS_MARKED_DNP, false );
+
+    ret.set( LAYER_3D_BOUNDING_BOXES,    false );
+    ret.set( LAYER_3D_OFF_BOARD_SILK,    false );
+    ret.set( LAYER_3D_AXES,              true );
+
+    return ret;
+}
+
+
 bool BOARD_ADAPTER::createBoardPolygon( wxString* aErrorMsg )
 {
     m_board_poly.RemoveAllContours();
@@ -911,9 +980,17 @@ bool BOARD_ADAPTER::createBoardPolygon( wxString* aErrorMsg )
 float BOARD_ADAPTER::GetFootprintZPos( bool aIsFlipped ) const
 {
     if( aIsFlipped )
-        return m_layerZcoordBottom[B_Paste];
+    {
+        if( auto it = m_layerZcoordBottom.find( B_Paste ); it != m_layerZcoordBottom.end() )
+            return it->second;
+    }
     else
-        return m_layerZcoordTop[F_Paste];
+    {
+        if( auto it = m_layerZcoordTop.find( F_Paste ); it != m_layerZcoordTop.end() )
+            return it->second;
+    }
+
+    return 0.0;
 }
 
 

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>
@@ -105,11 +107,21 @@ public:
 
     void ReloadColorSettings() noexcept;
 
+    /**
+     * Build a color list which is used to store colors layers
+     */
     std::map<int, COLOR4D> GetLayerColors() const;
+
+    /**
+     * Build the copper color list used by the board editor, and store it in m_BoardEditorColors
+     */
+    void GetBoardEditorCopperLayerColors( PCBNEW_SETTINGS* aCfg );
+
     std::map<int, COLOR4D> GetDefaultColors() const;
     void SetLayerColors( const std::map<int, COLOR4D>& aColors );
 
     std::bitset<LAYER_3D_END> GetVisibleLayers() const;
+    std::bitset<LAYER_3D_END> GetDefaultVisibleLayers() const;
     void SetVisibleLayers( const std::bitset<LAYER_3D_END>& aLayers );
 
     /**
@@ -224,7 +236,12 @@ public:
      */
     float GetLayerTopZPos( PCB_LAYER_ID aLayerId ) const noexcept
     {
-        return m_layerZcoordTop[aLayerId];
+        auto it = m_layerZcoordTop.find( aLayerId );
+
+        if( it != m_layerZcoordTop.end() )
+            return it->second;
+        else
+            return -( m_boardBodyThickness3DU / 2.0f );
     }
 
     /**
@@ -235,7 +252,12 @@ public:
      */
     float GetLayerBottomZPos( PCB_LAYER_ID aLayerId ) const noexcept
     {
-        return m_layerZcoordBottom[aLayerId];
+        auto it = m_layerZcoordBottom.find( aLayerId );
+
+        if( it != m_layerZcoordBottom.end() )
+            return it->second;
+        else
+            return -( m_boardBodyThickness3DU / 2.0f ) - m_backCopperThickness3DU;
     }
 
     /**
@@ -330,8 +352,8 @@ public:
      */
     const MAP_POLY& GetPolyMap() const noexcept { return m_layers_poly; }
 
-    const SHAPE_POLY_SET* GetFrontPlatedPadPolys() { return m_frontPlatedPadPolys;  }
-    const SHAPE_POLY_SET* GetBackPlatedPadPolys() { return m_backPlatedPadPolys; }
+    const SHAPE_POLY_SET* GetFrontPlatedPadAndGraphicPolys() { return m_frontPlatedPadAndGraphicPolys;  }
+    const SHAPE_POLY_SET* GetBackPlatedPadAndGraphicPolys() { return m_backPlatedPadAndGraphicPolys; }
     const MAP_POLY& GetHoleIdPolysMap() const noexcept { return m_layerHoleIdPolys; }
     const MAP_POLY& GetHoleOdPolysMap() const noexcept { return m_layerHoleOdPolys; }
 
@@ -376,6 +398,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 );
 
@@ -424,6 +449,9 @@ public:
     SFVEC4F           m_ECO1Color;
     SFVEC4F           m_ECO2Color;
 
+    std::map<int, COLOR4D> m_ColorOverrides;  ///< allows to override color scheme colors
+    std::map<int, COLOR4D> m_BoardEditorColors; ///< list of colors used by the board editor
+
 private:
     BOARD*            m_board;
     S3D_CACHE*        m_3dModelManager;
@@ -437,8 +465,8 @@ private:
     MAP_POLY          m_layers_poly;          ///< Amalgamated polygon contours for various types
                                               ///<   of items
 
-    SHAPE_POLY_SET*   m_frontPlatedPadPolys;
-    SHAPE_POLY_SET*   m_backPlatedPadPolys;
+    SHAPE_POLY_SET*   m_frontPlatedPadAndGraphicPolys;
+    SHAPE_POLY_SET*   m_backPlatedPadAndGraphicPolys;
     SHAPE_POLY_SET*   m_frontPlatedCopperPolys;
     SHAPE_POLY_SET*   m_backPlatedCopperPolys;
 
@@ -470,11 +498,11 @@ private:
     double            m_biuTo3Dunits;         ///< Scale factor to convert board internal units
                                               ///<  to 3D units normalized between -1.0 and 1.0.
 
-    std::array<float, PCB_LAYER_ID_COUNT> m_layerZcoordTop;    ///< Top (End) Z position of each
-                                                               ///< layer in 3D units.
+    std::map<PCB_LAYER_ID, float> m_layerZcoordTop;    ///< Top (End) Z position of each
+                                                       ///< layer in 3D units.
 
-    std::array<float, PCB_LAYER_ID_COUNT> m_layerZcoordBottom; ///< Bottom (Start) Z position of
-                                                               ///< each layer in 3D units.
+    std::map<PCB_LAYER_ID, float> m_layerZcoordBottom; ///< Bottom (Start) Z position of
+                                                       ///< each layer in 3D units.
 
     float             m_frontCopperThickness3DU;
     float             m_backCopperThickness3DU;

3d-viewer/3d_canvas/create_3Dgraphic_brd_items.cpp

@@ -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
@@ -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,6 +381,13 @@ 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() );
@@ -422,7 +436,7 @@ void BOARD_ADAPTER::createPadWithMargin( const PAD* aPad, CONTAINER_2D_BASE* aCo
                 break;
 
             case SH_POLY_SET:
-                poly = *(SHAPE_POLY_SET*) shape;
+                poly.Append( *static_cast<const SHAPE_POLY_SET*>( shape ) );
                 break;
 
             case SH_ARC:
@@ -610,7 +624,7 @@ void BOARD_ADAPTER::addShape( const PCB_SHAPE* aShape, CONTAINER_2D_BASE* aConta
             float   innerR3DU = TO_3DU( aShape->GetRadius() ) - linewidth3DU / 2.0;
             float   outerR3DU = TO_3DU( aShape->GetRadius() ) + linewidth3DU / 2.0;
 
-            if( aShape->IsFilled() )
+            if( aShape->IsFilled() || innerR3DU <= 0.0 )
                 addFILLED_CIRCLE_2D( aContainer, center3DU, outerR3DU, *aOwner );
             else
                 addRING_2D( aContainer, center3DU, innerR3DU, outerR3DU, *aOwner );
@@ -726,7 +740,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;
@@ -739,6 +755,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

@@ -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
@@ -36,10 +36,14 @@
 #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 <layer_range.h>
+#include <lset.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>
@@ -117,8 +121,8 @@ void BOARD_ADAPTER::destroyLayers()
 
     DELETE_AND_FREE_MAP( m_layers_poly );
 
-    DELETE_AND_FREE( m_frontPlatedPadPolys )
-    DELETE_AND_FREE( m_backPlatedPadPolys )
+    DELETE_AND_FREE( m_frontPlatedPadAndGraphicPolys )
+    DELETE_AND_FREE( m_backPlatedPadAndGraphicPolys )
     DELETE_AND_FREE( m_frontPlatedCopperPolys )
     DELETE_AND_FREE( m_backPlatedCopperPolys )
 
@@ -154,14 +158,11 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
     //    https://github.com/KiCad/kicad-source-mirror/blob/master/3d-viewer/3d_draw.cpp#L692
 
 #ifdef PRINT_STATISTICS_3D_VIEWER
-    unsigned stats_startCopperLayersTime = GetRunningMicroSecs();
+    int64_t stats_startCopperLayersTime = GetRunningMicroSecs();
 
-    unsigned start_Time = stats_startCopperLayersTime;
+    int64_t start_Time = stats_startCopperLayersTime;
 #endif
 
-    PCB_LAYER_ID cu_seq[MAX_CU_LAYERS];
-    LSET         cu_set = LSET::AllCuMask( m_copperLayersCount );
-
     EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS& cfg = m_Cfg->m_Render;
 
     std::bitset<LAYER_3D_END> visibilityFlags = GetVisibleLayers();
@@ -185,8 +186,12 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
 
     for( PCB_TRACK* track : m_board->Tracks() )
     {
-        if( !Is3dLayerEnabled( track->GetLayer(), visibilityFlags ) ) // Skip non enabled layers
+         // Skip tracks (not vias theyt are on more than one layer ) on disabled layers
+        if( track->Type() != PCB_VIA_T
+            && !Is3dLayerEnabled( track->GetLayer(), visibilityFlags ) )
+        {
             continue;
+        }
 
         // Note: a PCB_TRACK holds normal segment tracks and also vias circles (that have also
         // drill values)
@@ -217,13 +222,8 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
     layer_ids.clear();
     layer_ids.reserve( m_copperLayersCount );
 
-    for( unsigned i = 0; i < arrayDim( cu_seq ); ++i )
-        cu_seq[i] = ToLAYER_ID( B_Cu - i );
-
-    for( LSEQ cu = cu_set.Seq( cu_seq, arrayDim( cu_seq ) ); cu; ++cu )
+    for( PCB_LAYER_ID layer : LAYER_RANGE( F_Cu,B_Cu, m_copperLayersCount) )
     {
-        const PCB_LAYER_ID layer = *cu;
-
         if( !Is3dLayerEnabled( layer, visibilityFlags ) ) // Skip non enabled layers
             continue;
 
@@ -239,10 +239,10 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
         }
     }
 
-    if( cfg.differentiate_plated_copper )
+    if( cfg.DifferentiatePlatedCopper() )
     {
-        m_frontPlatedPadPolys = new SHAPE_POLY_SET;
-        m_backPlatedPadPolys = new SHAPE_POLY_SET;
+        m_frontPlatedPadAndGraphicPolys = new SHAPE_POLY_SET;
+        m_backPlatedPadAndGraphicPolys = new SHAPE_POLY_SET;
         m_frontPlatedCopperPolys = new SHAPE_POLY_SET;
         m_backPlatedCopperPolys = new SHAPE_POLY_SET;
 
@@ -353,12 +353,12 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                 }
             }
 
-            if( cfg.differentiate_plated_copper && layer == F_Cu )
+            if( cfg.DifferentiatePlatedCopper() && layer == F_Cu )
             {
                 track->TransformShapeToPolygon( *m_frontPlatedCopperPolys, F_Cu, 0, maxError,
                                                 ERROR_INSIDE );
             }
-            else if( cfg.differentiate_plated_copper && layer == B_Cu )
+            else if( cfg.DifferentiatePlatedCopper() && layer == B_Cu )
             {
                 track->TransformShapeToPolygon( *m_backPlatedCopperPolys, B_Cu, 0, maxError,
                                                 ERROR_INSIDE );
@@ -553,7 +553,7 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
         // ADD PADS
         for( FOOTPRINT* footprint : m_board->Footprints() )
         {
-            addPads( footprint, layerContainer, layer, cfg.differentiate_plated_copper, false );
+            addPads( footprint, layerContainer, layer, cfg.DifferentiatePlatedCopper(), false );
 
             // Micro-wave footprints may have items on copper layers
             addFootprintShapes( footprint, layerContainer, layer, visibilityFlags );
@@ -575,21 +575,21 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                 // Note: NPTH pads are not drawn on copper layers when the pad has same shape as
                 // its hole
                 footprint->TransformPadsToPolySet( *layerPoly, layer, 0, maxError, ERROR_INSIDE,
-                                                   true, cfg.differentiate_plated_copper, false );
+                                                   true, cfg.DifferentiatePlatedCopper(), false );
 
                 transformFPShapesToPolySet( footprint, layer, *layerPoly, maxError, ERROR_INSIDE );
             }
         }
 
-        if( cfg.differentiate_plated_copper )
+        if( cfg.DifferentiatePlatedCopper() )
         {
             // ADD PLATED PADS contours
             for( FOOTPRINT* footprint : m_board->Footprints() )
             {
-                footprint->TransformPadsToPolySet( *m_frontPlatedPadPolys, F_Cu, 0, maxError,
+                footprint->TransformPadsToPolySet( *m_frontPlatedPadAndGraphicPolys, F_Cu, 0, maxError,
                                                    ERROR_INSIDE, true, false, true );
 
-                footprint->TransformPadsToPolySet( *m_backPlatedPadPolys, B_Cu, 0, maxError,
+                footprint->TransformPadsToPolySet( *m_backPlatedPadAndGraphicPolys, B_Cu, 0, maxError,
                                                    ERROR_INSIDE, true, false, true );
             }
         }
@@ -622,6 +622,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:
@@ -635,6 +639,17 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                             item->Type() );
                 break;
             }
+
+            // add also this shape to the plated copper polygon list if required
+            if( cfg.DifferentiatePlatedCopper() )
+            {
+                if( layer == F_Cu )
+                    item->TransformShapeToPolygon( *m_frontPlatedCopperPolys, F_Cu,
+                                                    0, maxError, ERROR_INSIDE );
+                else if( layer == B_Cu )
+                    item->TransformShapeToPolygon( *m_backPlatedCopperPolys, B_Cu,
+                                                    0, maxError, ERROR_INSIDE );
+            }
         }
     }
 
@@ -675,6 +690,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() );
@@ -699,12 +718,12 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                 zones.emplace_back( std::make_pair( zone, layer ) );
                 layer_lock.emplace( layer, std::make_unique<std::mutex>() );
 
-                if( cfg.differentiate_plated_copper && layer == F_Cu )
+                if( cfg.DifferentiatePlatedCopper() && layer == F_Cu )
                 {
                     zone->TransformShapeToPolygon( *m_frontPlatedCopperPolys, F_Cu, 0, maxError,
                                                    ERROR_INSIDE );
                 }
-                else if( cfg.differentiate_plated_copper && layer == B_Cu )
+                else if( cfg.DifferentiatePlatedCopper() && layer == B_Cu )
                 {
                     zone->TransformShapeToPolygon( *m_backPlatedCopperPolys, B_Cu, 0, maxError,
                                                    ERROR_INSIDE );
@@ -775,7 +794,7 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
 
     // draw graphic items, on technical layers
 
-    static const PCB_LAYER_ID techLayerList[] = {
+    LSEQ techLayerList = LSET::AllNonCuMask().Seq( {
             B_Adhes,
             F_Adhes,
             B_Paste,
@@ -790,17 +809,17 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
             Cmts_User,
             Eco1_User,
             Eco2_User
-        };
+        } );
 
     std::bitset<LAYER_3D_END> enabledFlags = visibilityFlags;
 
-    if( cfg.subtract_mask_from_silk || cfg.differentiate_plated_copper )
+    if( cfg.subtract_mask_from_silk || cfg.DifferentiatePlatedCopper() )
     {
         enabledFlags.set( LAYER_3D_SOLDERMASK_TOP );
         enabledFlags.set( LAYER_3D_SOLDERMASK_BOTTOM );
     }
 
-    for( PCB_LAYER_ID layer : LSET::AllNonCuMask().Seq( techLayerList, arrayDim( techLayerList ) ) )
+    for( PCB_LAYER_ID layer : techLayerList )
     {
         if( aStatusReporter )
             aStatusReporter->Report( wxString::Format( _( "Build Tech layer %d" ), (int) layer ) );
@@ -836,6 +855,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:
@@ -850,14 +873,18 @@ 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;
 
+                // Only vias on a external copper layer can have a solder mask
                 for( PCB_TRACK* track : m_board->Tracks() )
                 {
+                    PCB_LAYER_ID copper_layer = layer == F_Mask ? F_Cu : B_Cu;
+
                     if( track->Type() == PCB_VIA_T
-                            && static_cast<const PCB_VIA*>( track )->FlashLayer( layer )  )
+                            && static_cast<const PCB_VIA*>( track )->FlashLayer( copper_layer )
+                            && !static_cast<const PCB_VIA*>( track )->IsTented( layer ) )
                     {
                         createViaWithMargin( track, layerContainer, maskExpansion );
                     }
@@ -901,7 +928,7 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
         // Add item contours.  We need these if we're building vertical walls or if this is a
         // mask layer and we're differentiating copper from plated copper.
         if( ( cfg.engine == RENDER_ENGINE::OPENGL && cfg.opengl_copper_thickness )
-                || ( cfg.differentiate_plated_copper && ( layer == F_Mask || layer == B_Mask ) ) )
+                || ( cfg.DifferentiatePlatedCopper() && ( layer == F_Mask || layer == B_Mask ) ) )
         {
             // DRAWINGS
             for( BOARD_ITEM* item : m_board->Drawings() )
@@ -931,20 +958,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 );
@@ -1021,7 +1053,7 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
     if( aStatusReporter )
         aStatusReporter->Report( _( "Simplifying copper layer polygons" ) );
 
-    if( cfg.differentiate_plated_copper )
+    if( cfg.DifferentiatePlatedCopper() )
     {
         if( aStatusReporter )
             aStatusReporter->Report( _( "Calculating plated copper" ) );
@@ -1039,21 +1071,33 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                                                           SHAPE_POLY_SET::PM_FAST );
         }
 
-        // SUBTRACT PLATED COPPER FROM (UNPLATED) COPPER
+        // Subtract plated copper from unplated copper
+        bool hasF_Cu = false;
+        bool hasB_Cu = false;
+
         if( m_layers_poly.find( F_Cu ) != m_layers_poly.end() )
         {
-            m_layers_poly[F_Cu]->BooleanSubtract( *m_frontPlatedPadPolys, SHAPE_POLY_SET::PM_FAST );
+            m_layers_poly[F_Cu]->BooleanSubtract( *m_frontPlatedPadAndGraphicPolys, SHAPE_POLY_SET::PM_FAST );
             m_layers_poly[F_Cu]->BooleanSubtract( *m_frontPlatedCopperPolys, SHAPE_POLY_SET::PM_FAST );
+            hasF_Cu = true;
         }
 
         if( m_layers_poly.find( B_Cu ) != m_layers_poly.end() )
         {
-            m_layers_poly[B_Cu]->BooleanSubtract( *m_backPlatedPadPolys, SHAPE_POLY_SET::PM_FAST );
+            m_layers_poly[B_Cu]->BooleanSubtract( *m_backPlatedPadAndGraphicPolys, SHAPE_POLY_SET::PM_FAST );
             m_layers_poly[B_Cu]->BooleanSubtract( *m_backPlatedCopperPolys, SHAPE_POLY_SET::PM_FAST );
+            hasB_Cu = true;
         }
 
-        m_frontPlatedPadPolys->Simplify( SHAPE_POLY_SET::PM_FAST );
-        m_backPlatedPadPolys->Simplify( SHAPE_POLY_SET::PM_FAST );
+        // Add plated graphic items to build vertical walls
+        if( hasF_Cu && m_frontPlatedCopperPolys->OutlineCount() )
+            m_frontPlatedPadAndGraphicPolys->Append( *m_frontPlatedCopperPolys );
+
+        if( hasB_Cu && m_backPlatedCopperPolys->OutlineCount() )
+            m_backPlatedPadAndGraphicPolys->Append( *m_backPlatedCopperPolys );
+
+        m_frontPlatedPadAndGraphicPolys->Simplify( SHAPE_POLY_SET::PM_FAST );
+        m_backPlatedPadAndGraphicPolys->Simplify( SHAPE_POLY_SET::PM_FAST );
         m_frontPlatedCopperPolys->Simplify( SHAPE_POLY_SET::PM_FAST );
         m_backPlatedCopperPolys->Simplify( SHAPE_POLY_SET::PM_FAST );
 
@@ -1080,7 +1124,7 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
         std::vector<PCB_LAYER_ID> &selected_layer_id = layer_ids;
         std::vector<PCB_LAYER_ID> layer_id_without_F_and_B;
 
-        if( cfg.differentiate_plated_copper )
+        if( cfg.DifferentiatePlatedCopper() )
         {
             layer_id_without_F_and_B.clear();
             layer_id_without_F_and_B.reserve( layer_ids.size() );
@@ -1123,6 +1167,7 @@ void BOARD_ADAPTER::createLayers( REPORTER* aStatusReporter )
                                 if( layerPoly != m_layers_poly.end() )
                                 {
                                     // This will make a union of all added contours
+                                    layerPoly->second->ClearArcs();
                                     layerPoly->second->Simplify( SHAPE_POLY_SET::PM_FAST );
                                 }
                             }

3d-viewer/3d_canvas/eda_3d_canvas.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-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
@@ -29,10 +29,11 @@
 #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>
+#include <build_version.h>
 #include <board.h>
 #include <reporter.h>
 #include <gal/opengl/gl_context_mgr.h>
@@ -72,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 )
@@ -81,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 ),
@@ -119,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 );
@@ -143,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,
@@ -229,6 +239,9 @@ bool  EDA_3D_CANVAS::initializeOpenGL()
                     From_UTF8( (char*) glewGetString( GLEW_VERSION ) ) );
     }
 
+    SetOpenGLInfo( (const char*) glGetString( GL_VENDOR ), (const char*) glGetString( GL_RENDERER ),
+                   (const char*) glGetString( GL_VERSION ) );
+
     wxString version = From_UTF8( (char *) glGetString( GL_VERSION ) );
 
     wxLogTrace( m_logTrace, wxT( "EDA_3D_CANVAS::%s OpenGL version string %s." ),
@@ -366,13 +379,10 @@ void EDA_3D_CANVAS::DoRePaint()
     if( !GetParent()->GetParent()->IsShownOnScreen() )
         return; // The parent board editor frame is no more alive
 
-    wxString err_messages;
-
-    // !TODO: implement error reporter
+    wxString           err_messages;
     INFOBAR_REPORTER   warningReporter( m_parentInfoBar );
     STATUSBAR_REPORTER activityReporter( m_parentStatusBar, EDA_3D_VIEWER_STATUSBAR::ACTIVITY );
-
-    unsigned strtime = GetRunningMicroSecs();
+    int64_t            start_time = GetRunningMicroSecs();
 
     // "Makes the OpenGL state that is represented by the OpenGL rendering
     //  context context current, i.e. it will be used by all subsequent OpenGL calls.
@@ -464,7 +474,7 @@ void EDA_3D_CANVAS::DoRePaint()
 
     if( m_camera_is_moving )
     {
-        const unsigned curtime_delta = GetRunningMicroSecs() - m_strtime_camera_movement;
+        const int64_t curtime_delta = GetRunningMicroSecs() - m_strtime_camera_movement;
         curtime_delta_s = (curtime_delta / 1e6) * m_camera_moving_speed;
         m_camera.Interpolate( curtime_delta_s );
 
@@ -548,7 +558,7 @@ void EDA_3D_CANVAS::DoRePaint()
     if( m_mouse_was_moved || m_camera_is_moving )
     {
         // Calculation time in milliseconds
-        const double calculation_time = (double)( GetRunningMicroSecs() - strtime) / 1e3;
+        const double calculation_time = (double)( GetRunningMicroSecs() - start_time ) / 1e3;
 
         activityReporter.Report( wxString::Format( _( "Last render time %.0f ms" ),
                                  calculation_time ) );
@@ -630,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() )
@@ -841,7 +920,7 @@ void EDA_3D_CANVAS::OnTimerTimeout_Redraw( wxTimerEvent& aEvent )
 
 void EDA_3D_CANVAS::OnRefreshRequest( wxEvent& aEvent )
 {
-   DoRePaint();
+    Refresh();
 }
 
 
@@ -982,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; }
 
@@ -208,12 +208,6 @@ public:
         m_3dmousePivotPos = aPos;
     }
 
-private:
-    /**
-     * Called by a wxPaintEvent event
-     */
-    void OnPaint( wxPaintEvent& aEvent );
-
     /**
      * The actual function to repaint the canvas.
      *
@@ -222,6 +216,10 @@ private:
      */
     void DoRePaint();
 
+private:
+    // The wxPaintEvent event. mainly calls DoRePaint()
+    void OnPaint( wxPaintEvent& aEvent );
+
     void OnEraseBackground( wxEraseEvent& event );
 
     void OnRefreshRequest( wxEvent& aEvent );
@@ -239,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()
 
     /**
@@ -307,13 +309,13 @@ private:
 
     bool                   m_render_pivot;            // Render the pivot while camera moving
     float                  m_camera_moving_speed;     // 1.0f will be 1:1
-    unsigned               m_strtime_camera_movement; // Ticktime of camera movement start
+    int64_t                m_strtime_camera_movement; // Ticktime of camera movement start
     bool                   m_animation_enabled;       // Camera animation enabled
     int                    m_moving_speed_multiplier; // Camera animation speed multiplier option
 
     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;
@@ -326,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

@@ -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
@@ -35,6 +35,7 @@
 #include "../3d_cache/3d_cache.h"
 #include <wx/dcclient.h>
 #include <base_units.h>
+#include <build_version.h>
 #include <gal/opengl/gl_context_mgr.h>
 #include <settings/common_settings.h>
 #include <pgm_base.h>
@@ -85,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 ),
@@ -102,11 +103,6 @@ EDA_3D_MODEL_VIEWER::EDA_3D_MODEL_VIEWER( wxWindow* aParent, const int* aAttribL
     m_BiuTo3dUnits = 1.0;
 
     m_glRC = nullptr;
-
-    COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
-
-    const DPI_SCALING_COMMON dpi{ settings, this };
-    SetScaleFactor( dpi.GetScaleFactor() );
 }
 
 
@@ -160,7 +156,7 @@ void EDA_3D_MODEL_VIEWER::Set3DModel( const wxString& aModelPathName)
 
     if( m_cacheManager )
     {
-        const S3DMODEL* model = m_cacheManager->GetModel( aModelPathName, wxEmptyString );
+        const S3DMODEL* model = m_cacheManager->GetModel( aModelPathName, wxEmptyString, nullptr );
 
         if( model )
             Set3DModel( (const S3DMODEL &)*model );
@@ -200,6 +196,9 @@ void EDA_3D_MODEL_VIEWER::ogl_initialize()
                     From_UTF8( (char*) glewGetString( GLEW_VERSION ) ) );
     }
 
+    SetOpenGLInfo( (const char*) glGetString( GL_VENDOR ), (const char*) glGetString( GL_RENDERER ),
+                   (const char*) glGetString( GL_VERSION ) );
+
     glHint( GL_PERSPECTIVE_CORRECTION_HINT, GL_NICEST );
     glHint( GL_LINE_SMOOTH_HINT, GL_NICEST );
     glHint( GL_POLYGON_SMOOTH_HINT, GL_NICEST );
@@ -302,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();
@@ -66,7 +66,9 @@ public:
     /**
      * Set this model to be displayed.
      *
-     * @param aModelPathName 3D model path name.
+     * N.B. This will not load a model from the internal cache.  Only from on disk.
+     *
+     * @param aModelPathName 3D model path name.  Must be a file on disk.
      */
     void Set3DModel( const wxString& aModelPathName );
 

3d-viewer/3d_navlib/CMakeLists.txt

@@ -1,6 +1,8 @@
     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,20 +25,17 @@
 
 
 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 = new NL_3D_VIEWER_PLUGIN_IMPL( aViewport );
+        m_impl = std::make_unique<NL_3D_VIEWER_PLUGIN_IMPL>( aViewport, "KiCAD 3D" );
+        m_impl->Connect();
     }
 }
 
 
-NL_3D_VIEWER_PLUGIN::~NL_3D_VIEWER_PLUGIN()
-{
-    delete m_impl;
-}
+NL_3D_VIEWER_PLUGIN::~NL_3D_VIEWER_PLUGIN() = default;
 
 
 void NL_3D_VIEWER_PLUGIN::SetFocus( bool focus )

3d-viewer/3d_navlib/nl_3d_viewer_plugin.h

@@ -26,6 +26,8 @@
 #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;
@@ -54,7 +56,7 @@ public:
     void SetFocus( bool aFocus = true );
 
 private:
-    NL_3D_VIEWER_PLUGIN_IMPL* m_impl;
+    std::unique_ptr<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) 2021 3Dconnexion
- * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
+ * 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
@@ -27,6 +27,7 @@
 // KiCAD includes
 #include <tool/action_manager.h>
 #include <tool/tool_manager.h>
+#include <tool/tools_holder.h>
 
 // stdlib
 #include <map>
@@ -72,7 +73,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 ) :
+NL_3D_VIEWER_PLUGIN_IMPL::NL_3D_VIEWER_PLUGIN_IMPL( EDA_3D_CANVAS* aCanvas, const std::string& aProfileHint ) :
         NAV_3D( false, false ),
         m_canvas( aCanvas ),
         m_capIsMoving( false ),
@@ -80,12 +81,7 @@ NL_3D_VIEWER_PLUGIN_IMPL::NL_3D_VIEWER_PLUGIN_IMPL( EDA_3D_CANVAS* aCanvas ) :
 {
     m_camera = dynamic_cast<TRACK_BALL*>( m_canvas->GetCamera() );
 
-    PutProfileHint( "KiCAD 3D" );
-
-    EnableNavigation( true );
-    PutFrameTimingSource( TimingSource::SpaceMouse );
-
-    exportCommandsAndImages();
+    PutProfileHint( aProfileHint );
 }
 
 
@@ -101,8 +97,19 @@ void NL_3D_VIEWER_PLUGIN_IMPL::SetFocus( bool aFocus )
     NAV_3D::Write( navlib::focus_k, aFocus );
 }
 
-// temporary store for the categories
-typedef std::map<std::string, TDx::CCommandTreeNode*> CATEGORY_STORE;
+
+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();
+}
 
 /**
  * Add a category to the store.
@@ -568,10 +575,11 @@ long NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand( std::string commandId )
 
         // Only allow command execution if the window is enabled. i.e. there is not a modal dialog
         // currently active.
+        TOOLS_HOLDER* tools_holder = nullptr;
 
-        if( parent->IsEnabled() )
+        if( parent->IsEnabled() && ( tools_holder = dynamic_cast<TOOLS_HOLDER*>( parent ) ) )
         {
-            TOOL_MANAGER* tool_manager = static_cast<PCB_BASE_FRAME*>( parent )->GetToolManager();
+            TOOL_MANAGER* tool_manager = tools_holder->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) 2021 3Dconnexion
- * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
+ * 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
@@ -42,6 +42,11 @@
 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;
 
@@ -56,8 +61,9 @@ 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 );
+    NL_3D_VIEWER_PLUGIN_IMPL( EDA_3D_CANVAS* aCanvas, const std::string& aProfileHint );
 
     virtual ~NL_3D_VIEWER_PLUGIN_IMPL();
 
@@ -69,11 +75,21 @@ 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.
       */
-    void exportCommandsAndImages();
+    virtual void exportCommandsAndImages();
 
     long GetCameraMatrix( navlib::matrix_t& aMatrix ) const override;
     long GetPointerPosition( navlib::point_t& aPosition ) const override;
@@ -111,6 +127,7 @@ 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.cpp

@@ -0,0 +1,45 @@
+/*
+ * 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.h"
+#include "nl_footprint_properties_plugin_impl.h"
+#include <advanced_config.h>
+#include <kiplatform/drivers.h>
+
+
+NL_FOOTPRINT_PROPERTIES_PLUGIN::NL_FOOTPRINT_PROPERTIES_PLUGIN( EDA_3D_CANVAS* aViewport )
+{
+    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 )
+{
+    if( m_impl )
+        m_impl->SetFocus( focus );
+}

3d-viewer/3d_navlib/nl_footprint_properties_plugin.h

@@ -0,0 +1,62 @@
+/*
+ * 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

@@ -0,0 +1,162 @@
+/*
+ * 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

@@ -0,0 +1,68 @@
+/*
+ * 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/create_scene.cpp

@@ -28,6 +28,7 @@
 #include <footprint.h>
 #include "../../3d_math.h"
 #include "convert_basic_shapes_to_polygon.h"
+#include <lset.h>
 #include <trigo.h>
 #include <project.h>
 #include <core/profile.h>        // To use GetRunningMicroSecs or another profiling utility
@@ -454,7 +455,7 @@ void RENDER_3D_OPENGL::reload( REPORTER* aStatusReporter, REPORTER* aWarningRepo
 
     OBJECT_2D_STATS::Instance().ResetStats();
 
-    unsigned stats_startReloadTime = GetRunningMicroSecs();
+    int64_t stats_startReloadTime = GetRunningMicroSecs();
 
     m_boardAdapter.InitSettings( aStatusReporter, aWarningReporter );
 
@@ -611,14 +612,14 @@ void RENDER_3D_OPENGL::reload( REPORTER* aStatusReporter, REPORTER* aWarningRepo
             m_layers[layer] = oglList;
     }
 
-    if( m_boardAdapter.m_Cfg->m_Render.differentiate_plated_copper )
+    if( m_boardAdapter.m_Cfg->m_Render.DifferentiatePlatedCopper() )
     {
-        const SHAPE_POLY_SET* frontPlatedPadPolys = m_boardAdapter.GetFrontPlatedPadPolys();
-        const SHAPE_POLY_SET* backPlatedPadPolys = m_boardAdapter.GetBackPlatedPadPolys();
+        const SHAPE_POLY_SET* frontPlatedPadAndGraphicPolys = m_boardAdapter.GetFrontPlatedPadAndGraphicPolys();
+        const SHAPE_POLY_SET* backPlatedPadAndGraphicPolys = m_boardAdapter.GetBackPlatedPadAndGraphicPolys();
 
-        if( frontPlatedPadPolys )
+        if( frontPlatedPadAndGraphicPolys )
         {
-            SHAPE_POLY_SET poly = frontPlatedPadPolys->CloneDropTriangulation();
+            SHAPE_POLY_SET poly = frontPlatedPadAndGraphicPolys->CloneDropTriangulation();
             poly.BooleanIntersection( m_boardAdapter.GetBoardPoly(), SHAPE_POLY_SET::PM_FAST );
             poly.BooleanSubtract( m_boardAdapter.GetTH_ODPolys(), SHAPE_POLY_SET::PM_FAST );
             poly.BooleanSubtract( m_boardAdapter.GetNPTH_ODPolys(), SHAPE_POLY_SET::PM_FAST );
@@ -630,9 +631,9 @@ void RENDER_3D_OPENGL::reload( REPORTER* aStatusReporter, REPORTER* aWarningRepo
                 m_layers[F_Cu] = generateEmptyLayerList( F_Cu );
         }
 
-        if( backPlatedPadPolys )
+        if( backPlatedPadAndGraphicPolys )
         {
-            SHAPE_POLY_SET poly = backPlatedPadPolys->CloneDropTriangulation();
+            SHAPE_POLY_SET poly = backPlatedPadAndGraphicPolys->CloneDropTriangulation();
             poly.BooleanIntersection( m_boardAdapter.GetBoardPoly(), SHAPE_POLY_SET::PM_FAST );
             poly.BooleanSubtract( m_boardAdapter.GetTH_ODPolys(), SHAPE_POLY_SET::PM_FAST );
             poly.BooleanSubtract( m_boardAdapter.GetNPTH_ODPolys(), SHAPE_POLY_SET::PM_FAST );
@@ -917,6 +918,10 @@ void RENDER_3D_OPENGL::load3dModels( REPORTER* aStatusReporter )
     if( !m_boardAdapter.GetBoard() )
         return;
 
+    // Building the 3D models late crashes on recent versions of macOS
+    // Unclear the exact mechanism, but as a workaround, just build them
+    // all the time.  See https://gitlab.com/kicad/code/kicad/-/issues/17198
+#ifndef __WXMAC__
     if( !m_boardAdapter.m_IsPreviewer
           && !m_boardAdapter.m_Cfg->m_Render.show_footprints_normal
           && !m_boardAdapter.m_Cfg->m_Render.show_footprints_insert
@@ -924,6 +929,7 @@ void RENDER_3D_OPENGL::load3dModels( REPORTER* aStatusReporter )
     {
         return;
     }
+#endif
 
     // Go for all footprints
     for( const FOOTPRINT* footprint : m_boardAdapter.GetBoard()->Footprints() )
@@ -968,7 +974,7 @@ void RENDER_3D_OPENGL::load3dModels( REPORTER* aStatusReporter )
                 {
                     // It is not present, try get it from cache
                     const S3DMODEL* modelPtr =
-                            m_boardAdapter.Get3dCacheManager()->GetModel( fp_model.m_Filename, footprintBasePath );
+                            m_boardAdapter.Get3dCacheManager()->GetModel( fp_model.m_Filename, footprintBasePath, footprint );
 
                     // only add it if the return is not NULL
                     if( modelPtr )

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,9 +30,12 @@
 #include "render_3d_opengl.h"
 #include "opengl_utils.h"
 #include "common_ogl/ogl_utils.h"
+#include <board.h>
 #include <footprint.h>
+#include <gal/opengl/gl_context_mgr.h>
 #include <3d_math.h>
 #include <glm/geometric.hpp>
+#include <lset.h>
 #include <math/util.h>      // for KiROUND
 #include <utility>
 #include <vector>
@@ -47,7 +50,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" ) );
 
@@ -266,6 +270,20 @@ void RENDER_3D_OPENGL::setupMaterials()
 
 void RENDER_3D_OPENGL::setLayerMaterial( PCB_LAYER_ID aLayerID )
 {
+    EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS& cfg = m_boardAdapter.m_Cfg->m_Render;
+
+    if( cfg.use_board_editor_copper_colors && IsCopperLayer( aLayerID ) )
+    {
+        COLOR4D copper_color = m_boardAdapter.m_BoardEditorColors[aLayerID];
+        m_materials.m_Copper.m_Diffuse = SFVEC3F( copper_color.r, copper_color.g,
+                                                  copper_color.b );
+        OglSetMaterial( m_materials.m_Copper, 1.0f );
+        m_materials.m_NonPlatedCopper.m_Diffuse = m_materials.m_Copper.m_Diffuse;
+        OglSetMaterial( m_materials.m_NonPlatedCopper, 1.0f );
+
+        return;
+    }
+
     switch( aLayerID )
     {
     case F_Mask:
@@ -444,11 +462,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;
@@ -463,7 +487,13 @@ bool RENDER_3D_OPENGL::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
         if( aStatusReporter )
             aStatusReporter->Report( _( "Loading..." ) );
 
-        reload( aStatusReporter, aWarningReporter );
+        // Careful here!
+        // We are in the middle of rendering and the reload method may show
+        // a dialog box that requires the opengl context for a redraw
+        GL_CONTEXT_MANAGER::Get().RunWithoutCtxLock( [this, aStatusReporter, aWarningReporter]()
+        {
+            reload( aStatusReporter, aWarningReporter );
+        } );
 
         // generate a new 3D grid as the size of the board may had changed
         m_lastGridType = static_cast<GRID3D_TYPE>( cfg.grid_type );
@@ -495,7 +525,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 +533,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 );
 
@@ -562,7 +592,6 @@ bool RENDER_3D_OPENGL::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
         bool  isSilkLayer = layer == F_SilkS || layer == B_SilkS;
         bool  isMaskLayer = layer == F_Mask || layer == B_Mask;
         bool  isPasteLayer = layer == F_Paste || layer == B_Paste;
-        bool  isCopperLayer = layer >= F_Cu && layer <= B_Cu;
 
         // Mask layers are not processed here because they are a special case
         if( isMaskLayer )
@@ -575,7 +604,10 @@ bool RENDER_3D_OPENGL::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
 
         if( layerFlags.test( LAYER_3D_BOARD ) && m_boardAdapter.m_BoardBodyColor.a > opacity_min )
         {
-            if( layer > F_Cu && layer < B_Cu )
+            // generating internal copper layers is time consumming. so skip them
+            // if the board body is masking them (i.e. if the opacity is near 1.0)
+            // B_Cu is layer 2 and all inner layers are higher values
+            if( layer > B_Cu && IsCopperLayer( layer ) )
                 continue;
         }
 
@@ -583,9 +615,9 @@ bool RENDER_3D_OPENGL::Redraw( bool aIsMoving, REPORTER* aStatusReporter,
 
         OPENGL_RENDER_LIST* pLayerDispList = static_cast<OPENGL_RENDER_LIST*>( ii->second );
 
-        if( isCopperLayer )
+        if( IsCopperLayer( layer ) )
         {
-            if( cfg.differentiate_plated_copper )
+            if( cfg.DifferentiatePlatedCopper() )
                 setCopperMaterial();
             else
                 setLayerMaterial( layer );
@@ -817,7 +849,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 +1047,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 +1160,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 +1250,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/accelerators/bvh_pbrt.cpp

@@ -437,7 +437,7 @@ BVHBuildNode *BVH_PBRT::recursiveBuild ( std::vector<BVHPrimitiveInfo>& primitiv
 
     (*totalNodes)++;
 
-    // !TODO: implement an memory Arena
+    // !TODO: implement a memory arena
     BVHBuildNode *node = static_cast<BVHBuildNode *>( malloc( sizeof( BVHBuildNode ) ) );
     m_nodesToFree.push_back( node );
 

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;
@@ -368,7 +368,7 @@ void RENDER_3D_RAYTRACE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningRe
     OBJECT_2D_STATS::Instance().ResetStats();
     OBJECT_3D_STATS::Instance().ResetStats();
 
-    unsigned stats_startReloadTime = GetRunningMicroSecs();
+    int64_t stats_startReloadTime = GetRunningMicroSecs();
 
     if( !aOnlyLoadCopperAndShapes )
     {
@@ -771,8 +771,8 @@ void RENDER_3D_RAYTRACE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningRe
     }
 
 #ifdef PRINT_STATISTICS_3D_VIEWER
-    unsigned stats_endConvertTime        = GetRunningMicroSecs();
-    unsigned stats_startLoad3DmodelsTime = stats_endConvertTime;
+    int64_t stats_endConvertTime = GetRunningMicroSecs();
+    int64_t stats_startLoad3DmodelsTime = stats_endConvertTime;
 #endif
 
     if( aStatusReporter )
@@ -781,7 +781,7 @@ void RENDER_3D_RAYTRACE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningRe
     load3DModels( m_objectContainer, aOnlyLoadCopperAndShapes );
 
 #ifdef PRINT_STATISTICS_3D_VIEWER
-    unsigned stats_endLoad3DmodelsTime = GetRunningMicroSecs();
+    int64_t stats_endLoad3DmodelsTime = GetRunningMicroSecs();
 #endif
 
     if( !aOnlyLoadCopperAndShapes )
@@ -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 );
                 }
             }
         }
@@ -955,14 +955,14 @@ void RENDER_3D_RAYTRACE::Reload( REPORTER* aStatusReporter, REPORTER* aWarningRe
     if( aStatusReporter )
     {
         // Calculation time in seconds
-        double calculation_time = (double) GetRunningMicroSecs() - stats_startReloadTime / 1e6;
+        double calculation_time = (double) ( GetRunningMicroSecs() - stats_startReloadTime ) / 1e6;
 
         aStatusReporter->Report( wxString::Format( _( "Reload time %.3f s" ), calculation_time ) );
     }
 }
 
 
-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;
@@ -1243,12 +1243,8 @@ void RENDER_3D_RAYTRACE::load3DModels( CONTAINER_3D& aDstContainer, bool aSkipMa
                     fpMatrix, SFVEC3F( modelunit_to_3d_units_factor, modelunit_to_3d_units_factor,
                                        modelunit_to_3d_units_factor ) );
 
-            BOARD_ITEM* boardItem = dynamic_cast<BOARD_ITEM*>( fp );
-
             // Get the list of model files for this model
             S3D_CACHE* cacheMgr = m_boardAdapter.Get3dCacheManager();
-            auto       sM       = fp->Models().begin();
-            auto       eM       = fp->Models().end();
 
             wxString                libraryName = fp->GetFPID().GetLibNickname();
 
@@ -1271,51 +1267,45 @@ void RENDER_3D_RAYTRACE::load3DModels( CONTAINER_3D& aDstContainer, bool aSkipMa
                 }
             }
 
-            while( sM != eM )
+            for( FP_3DMODEL& model : fp->Models() )
             {
-                if( ( static_cast<float>( sM->m_Opacity ) > FLT_EPSILON )
-                  && ( sM->m_Show && !sM->m_Filename.empty() ) )
+                // get it from cache
+                const S3DMODEL* modelPtr =
+                        cacheMgr->GetModel( model.m_Filename, footprintBasePath, fp );
+
+                // only add it if the return is not NULL.
+                if( modelPtr )
                 {
-                    // get it from cache
-                    const S3DMODEL* modelPtr =
-                            cacheMgr->GetModel( sM->m_Filename, footprintBasePath );
+                    glm::mat4 modelMatrix = fpMatrix;
 
-                    // only add it if the return is not NULL.
-                    if( modelPtr )
-                    {
-                        glm::mat4 modelMatrix = fpMatrix;
+                    modelMatrix = glm::translate( modelMatrix,
+                            SFVEC3F( model.m_Offset.x, model.m_Offset.y, model.m_Offset.z ) );
 
-                        modelMatrix = glm::translate( modelMatrix,
-                                SFVEC3F( sM->m_Offset.x, sM->m_Offset.y, sM->m_Offset.z ) );
+                    modelMatrix = glm::rotate( modelMatrix,
+                            (float) -( model.m_Rotation.z / 180.0f ) * glm::pi<float>(),
+                            SFVEC3F( 0.0f, 0.0f, 1.0f ) );
 
-                        modelMatrix = glm::rotate( modelMatrix,
-                                (float) -( sM->m_Rotation.z / 180.0f ) * glm::pi<float>(),
-                                SFVEC3F( 0.0f, 0.0f, 1.0f ) );
+                    modelMatrix = glm::rotate( modelMatrix,
+                            (float) -( model.m_Rotation.y / 180.0f ) * glm::pi<float>(),
+                            SFVEC3F( 0.0f, 1.0f, 0.0f ) );
 
-                        modelMatrix = glm::rotate( modelMatrix,
-                                (float) -( sM->m_Rotation.y / 180.0f ) * glm::pi<float>(),
-                                SFVEC3F( 0.0f, 1.0f, 0.0f ) );
+                    modelMatrix = glm::rotate( modelMatrix,
+                            (float) -( model.m_Rotation.x / 180.0f ) * glm::pi<float>(),
+                            SFVEC3F( 1.0f, 0.0f, 0.0f ) );
 
-                        modelMatrix = glm::rotate( modelMatrix,
-                                (float) -( sM->m_Rotation.x / 180.0f ) * glm::pi<float>(),
-                                SFVEC3F( 1.0f, 0.0f, 0.0f ) );
+                    modelMatrix = glm::scale( modelMatrix,
+                            SFVEC3F( model.m_Scale.x, model.m_Scale.y, model.m_Scale.z ) );
 
-                        modelMatrix = glm::scale( modelMatrix,
-                                SFVEC3F( sM->m_Scale.x, sM->m_Scale.y, sM->m_Scale.z ) );
-
-                        addModels( aDstContainer, modelPtr, modelMatrix, (float) sM->m_Opacity,
-                                   aSkipMaterialInformation, boardItem );
-                    }
+                    addModels( aDstContainer, modelPtr, modelMatrix, (float) model.m_Opacity,
+                               aSkipMaterialInformation, fp );
                 }
-
-                ++sM;
             }
         }
     }
 }
 
 
-MODEL_MATERIALS* RENDER_3D_RAYTRACE::getModelMaterial( const S3DMODEL* a3DModel )
+MODEL_MATERIALS* RENDER_3D_RAYTRACE_BASE::getModelMaterial( const S3DMODEL* a3DModel )
 {
     MODEL_MATERIALS* materialVector;
 
@@ -1418,7 +1408,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 )
 {
@@ -1432,13 +1422,12 @@ void RENDER_3D_RAYTRACE::addModels( CONTAINER_3D& aDstContainer, const S3DMODEL*
     wxASSERT( a3DModel->m_Meshes != nullptr );
     wxASSERT( a3DModel->m_MaterialsSize > 0 );
     wxASSERT( a3DModel->m_MeshesSize > 0 );
-    wxASSERT( aFPOpacity > 0.0f );
-    wxASSERT( aFPOpacity <= 1.0f );
 
     if( aFPOpacity > 1.0f )
-    {
         aFPOpacity = 1.0f;
-    }
+
+    if( aFPOpacity < 0.0f )
+        aFPOpacity = 0.0f;
 
     if( ( a3DModel->m_Materials != nullptr ) && ( a3DModel->m_Meshes != nullptr )
       && ( a3DModel->m_MaterialsSize > 0 ) && ( a3DModel->m_MeshesSize > 0 ) )

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,34 +69,32 @@ 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 );
 
     void restartRenderState();
-    void renderTracing( GLubyte* ptrPBO, REPORTER* aStatusReporter );
-    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 renderTracing( uint8_t* ptrPBO, REPORTER* aStatusReporter );
+    void postProcessShading( uint8_t* ptrPBO, REPORTER* aStatusReporter );
+    void postProcessBlurFinish( uint8_t* ptrPBO, REPORTER* aStatusReporter );
+    void renderBlockTracing( uint8_t* ptrPBO , signed int iBlock );
+    void renderFinalColor( uint8_t* 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;
 
@@ -125,8 +119,10 @@ private:
 
     void initializeBlockPositions();
 
-    void render( GLubyte* ptrPBO, REPORTER* aStatusReporter );
-    void renderPreview( GLubyte* ptrPBO );
+    void render( uint8_t* ptrPBO, REPORTER* aStatusReporter );
+    void renderPreview( uint8_t* ptrPBO );
+
+    static SFVEC4F premultiplyAlpha( const SFVEC4F& aInput );
 
     struct
     {
@@ -148,13 +144,14 @@ private:
     BRUSHED_METAL_NORMAL m_brushedMetalMaterial;
     SILK_SCREEN_NORMAL   m_silkScreenMaterial;
 
+    bool m_is_canvas_initialized;
     bool m_isPreview;
 
     /// State used on quality render
     RT_RENDER_STATE m_renderState;
 
     /// Time that the render starts
-    unsigned long int m_renderStartTime;
+    int64_t m_renderStartTime;
 
     /// Save the number of blocks progress of the render
     size_t m_blockRenderProgressCount;
@@ -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
+        uint8_t* ptrPBO = (uint8_t *)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
+            uint8_t* ptrPBO = (uint8_t *)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

@@ -1,8 +1,9 @@
 /*
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
- * Copyright (C) 2015-2016 Cirilo Bernardo <cirilo.bernardo@gmail.com>
- * Copyright (C) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
+ * 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
@@ -22,31 +23,32 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  */
 
-#include <dialogs/dialog_configure_paths.h>
+#ifndef RENDER_3D_RAYTRACE_GL_H
+#define RENDER_3D_RAYTRACE_GL_H
 
-#include "3d_info.h"
-#include "3d_cache.h"
-#include "3d_cache_dialogs.h"
-#include "dialog_select_3d_model.h"
+#include "../../common_ogl/openGL_includes.h"
+#include "render_3d_raytrace_base.h"
 
 
-bool S3D::Select3DModel( wxWindow* aParent, S3D_CACHE* aCache, wxString& prevModelSelectDir,
-                         int& prevModelWildcard, FP_3DMODEL* aModel )
+class RENDER_3D_RAYTRACE_GL : public RENDER_3D_RAYTRACE_BASE
 {
-    if( nullptr == aModel )
-        return false;
+public:
+    explicit RENDER_3D_RAYTRACE_GL( EDA_3D_CANVAS* aCanvas, BOARD_ADAPTER& aAdapter,
+                                    CAMERA& aCamera );
 
-    DIALOG_SELECT_3DMODEL dm( aParent, aCache, aModel, prevModelSelectDir, prevModelWildcard );
+    ~RENDER_3D_RAYTRACE_GL();
 
-    // Use QuasiModal so that Configure3DPaths (and its help window) will work
-    return dm.ShowQuasiModal() == wxID_OK;
-}
+    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;
+};
 
 
-bool S3D::Configure3DPaths( wxWindow* aParent, FILENAME_RESOLVER* aResolver )
-{
-    DIALOG_CONFIGURE_PATHS dlg( aParent );
-
-    // Use QuasiModal so that HTML help window will work
-    return( dlg.ShowQuasiModal() == wxID_OK );
-}
+#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();
+}
+
+
+uint8_t* 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 uint8_t[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();
+
+    uint8_t* 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;
+
+    uint8_t* m_outputBuffer;
+    uint32_t 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

@@ -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
@@ -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>
@@ -113,11 +114,11 @@ EDA_3D_VIEWER_FRAME::EDA_3D_VIEWER_FRAME( KIWAY* aKiway, PCB_BASE_FRAME* aParent
     SetStatusWidths( arrayDim( status_dims ), status_dims );
 
     SETTINGS_MANAGER&       mgr = Pgm().GetSettingsManager();
-    EDA_3D_VIEWER_SETTINGS* cfg = mgr.GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
+    EDA_3D_VIEWER_SETTINGS* cfg = mgr.GetAppSettings<EDA_3D_VIEWER_SETTINGS>( "3d_viewer" );
     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() );
@@ -388,12 +389,13 @@ void EDA_3D_VIEWER_FRAME::handleIconizeEvent( wxIconizeEvent& aEvent )
 
 void EDA_3D_VIEWER_FRAME::ReloadRequest()
 {
-    if( m_appearancePanel )
-        m_appearancePanel->UpdateLayerCtls();
-
     // This will schedule a request to load later
+    // ReloadRequest also updates the board pointer so always call it first
     if( m_canvas )
         m_canvas->ReloadRequest( GetBoard(), PROJECT_PCB::Get3DCacheManager( &Prj() ) );
+
+    if( m_appearancePanel )
+        m_appearancePanel->UpdateLayerCtls();
 }
 
 
@@ -478,7 +480,7 @@ void EDA_3D_VIEWER_FRAME::Process_Special_Functions( wxCommandEvent &event )
 
     case ID_MENU3D_RESET_DEFAULTS:
     {
-        auto cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
+        auto cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>( "3d_viewer" );
         cfg->ResetToDefaults();
         LoadSettings( cfg );
 
@@ -560,14 +562,15 @@ void EDA_3D_VIEWER_FRAME::LoadSettings( APP_SETTINGS_BASE *aCfg )
 {
     EDA_BASE_FRAME::LoadSettings( aCfg );
 
-    EDA_3D_VIEWER_SETTINGS* cfg = dynamic_cast<EDA_3D_VIEWER_SETTINGS*>( aCfg );
-    wxASSERT( cfg );
+    // Dynamic_cast here will fail on Mac when called from CvPCB.
+    EDA_3D_VIEWER_SETTINGS* cfg = static_cast<EDA_3D_VIEWER_SETTINGS*>( aCfg );
 
     wxLogTrace( m_logTrace, wxT( "EDA_3D_VIEWER_FRAME::LoadSettings" ) );
 
     if( cfg )
     {
-        m_boardAdapter.m_Cfg = cfg;
+        applySettings( cfg );
+
         m_boardAdapter.SetBoard( GetBoard() );
 
         // When opening the 3D viewer, we use the OpenGL mode, never the ray tracing engine
@@ -575,28 +578,20 @@ void EDA_3D_VIEWER_FRAME::LoadSettings( APP_SETTINGS_BASE *aCfg )
         // (freeze window) with large boards.
         m_boardAdapter.m_Cfg->m_Render.engine = RENDER_ENGINE::OPENGL;
 
-        m_canvas->SetAnimationEnabled( cfg->m_Camera.animation_enabled );
-        m_canvas->SetMovingSpeedMultiplier( cfg->m_Camera.moving_speed_multiplier );
-        m_canvas->SetProjectionMode( cfg->m_Camera.projection_mode );
-
-
-        m_canvas->SetVcSettings( EDA_DRAW_PANEL_GAL::GetVcSettings() );
-
         if( cfg->m_CurrentPreset == LEGACY_PRESET_FLAG )
         {
             wxString legacyColorsPresetName = _( "legacy colors" );
 
+            cfg->m_UseStackupColors = false;
+
             if( !cfg->FindPreset( legacyColorsPresetName ) )
             {
                 cfg->m_LayerPresets.emplace_back( legacyColorsPresetName,
-                                                  GetAdapter().GetVisibleLayers(),
-                                                  GetAdapter().GetLayerColors() );
+                                                  GetAdapter().GetDefaultVisibleLayers(),
+                                                  GetAdapter().GetDefaultColors() );
             }
 
-            if( Pgm().GetSettingsManager().GetColorSettings()->GetUseBoardStackupColors() )
-                cfg->m_CurrentPreset = FOLLOW_PCB;
-            else
-                cfg->m_CurrentPreset = legacyColorsPresetName;
+            cfg->m_CurrentPreset = FOLLOW_PLOT_SETTINGS;
         }
 
         m_boardAdapter.InitSettings( nullptr, nullptr );
@@ -609,7 +604,7 @@ void EDA_3D_VIEWER_FRAME::LoadSettings( APP_SETTINGS_BASE *aCfg )
 
 void EDA_3D_VIEWER_FRAME::SaveSettings( APP_SETTINGS_BASE *aCfg )
 {
-    auto cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
+    auto cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>( "3d_viewer" );
 
     EDA_BASE_FRAME::SaveSettings( cfg );
 
@@ -645,7 +640,7 @@ void EDA_3D_VIEWER_FRAME::CommonSettingsChanged( bool aEnvVarsChanged, bool aTex
     ReCreateMainToolbar();
 
     loadCommonSettings();
-    LoadSettings( Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>() );
+    applySettings( Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>( "3d_viewer" ) );
 
     m_appearancePanel->CommonSettingsChanged();
 
@@ -664,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 );
@@ -676,7 +669,7 @@ void EDA_3D_VIEWER_FRAME::ShowChangedLanguage()
 void EDA_3D_VIEWER_FRAME::ToggleAppearanceManager()
 {
     SETTINGS_MANAGER&       mgr = Pgm().GetSettingsManager();
-    EDA_3D_VIEWER_SETTINGS* cfg = mgr.GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
+    EDA_3D_VIEWER_SETTINGS* cfg = mgr.GetAppSettings<EDA_3D_VIEWER_SETTINGS>( "3d_viewer" );
     wxAuiPaneInfo&          layersManager = m_auimgr.GetPane( "LayersManager" );
 
     // show auxiliary Vertical layers and visibility manager toolbar
@@ -756,8 +749,13 @@ void EDA_3D_VIEWER_FRAME::takeScreenshot( wxCommandEvent& event )
     }
 
     // Be sure we have the latest 3D view (remember 3D view is buffered)
-    m_canvas->Request_refresh( true );
-    wxYield();
+    // Also ensure any highlighted item is not highlighted when creating screen shot
+    EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS& cfg = m_boardAdapter.m_Cfg->m_Render;
+    bool allow_highlight = cfg.highlight_on_rollover;
+    cfg.highlight_on_rollover = false;
+
+    m_canvas->DoRePaint();      // init first buffer
+    m_canvas->DoRePaint();      // init second buffer
 
     // Build image from the 3D buffer
     wxWindowUpdateLocker noUpdates( this );
@@ -767,6 +765,8 @@ void EDA_3D_VIEWER_FRAME::takeScreenshot( wxCommandEvent& event )
     if( m_canvas )
         m_canvas->GetScreenshot( screenshotImage );
 
+    cfg.highlight_on_rollover = allow_highlight;
+
     if( event.GetId() == ID_TOOL_SCREENCOPY_TOCLIBBOARD )
     {
         wxBitmap bitmap( screenshotImage );
@@ -811,9 +811,18 @@ void EDA_3D_VIEWER_FRAME::loadCommonSettings()
 
     COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
 
-    const DPI_SCALING_COMMON dpi{ settings, this };
-    m_canvas->SetScaleFactor( dpi.GetScaleFactor() );
-
     // TODO(JE) use all control options
     m_boardAdapter.m_MousewheelPanning = settings->m_Input.scroll_modifier_zoom != 0;
 }
+
+
+void EDA_3D_VIEWER_FRAME::applySettings( EDA_3D_VIEWER_SETTINGS* cfg )
+{
+    m_boardAdapter.m_Cfg = cfg;
+
+    m_canvas->SetAnimationEnabled( cfg->m_Camera.animation_enabled );
+    m_canvas->SetMovingSpeedMultiplier( cfg->m_Camera.moving_speed_multiplier );
+    m_canvas->SetProjectionMode( cfg->m_Camera.projection_mode );
+
+    m_canvas->SetVcSettings( EDA_DRAW_PANEL_GAL::GetVcSettings() );
+}

3d-viewer/3d_viewer/eda_3d_viewer_frame.h

@@ -5,7 +5,7 @@
  * Copyright (C) 2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
  * Copyright (C) 2011 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
@@ -41,11 +41,6 @@
 #include <dialogs/dialog_color_picker.h>  // for CUSTOM_COLORS_LIST definition
 
 
-/// A variable name whose value holds the path of 3D shape files.
-/// Currently an environment variable, eventually a project variable.
-#define KICAD7_3DMODEL_DIR wxT( "KICAD7_3DMODEL_DIR" )
-
-
 #define KICAD_DEFAULT_3D_DRAWFRAME_STYLE    (wxDEFAULT_FRAME_STYLE | wxWANTS_CHARS)
 
 // Forward declarations
@@ -172,6 +167,8 @@ private:
      */
     void loadCommonSettings();
 
+    void applySettings( EDA_3D_VIEWER_SETTINGS* aSettings );
+
 private:
     wxFileName                     m_defaultSaveScreenshotFileName;
 

3d-viewer/3d_viewer/eda_3d_viewer_settings.cpp

@@ -339,7 +339,7 @@ EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS() :
     m_params.emplace_back( new PARAM<bool>( "render.show_footprints_not_in_posfile",
                                             &m_Render.show_footprints_not_in_posfile, true ) );
     m_params.emplace_back( new PARAM<bool>( "render.show_footprints_dnp",
-                                            &m_Render.show_footprints_dnp, true ) );
+                                            &m_Render.show_footprints_dnp, false ) );
     m_params.emplace_back( new PARAM<bool>( "render.show_silkscreen_top",
                                             &m_Render.show_silkscreen_top, true ) );
     m_params.emplace_back( new PARAM<bool>( "render.show_silkscreen_bottom",
@@ -368,6 +368,8 @@ EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS() :
                                             &m_Render.clip_silk_on_via_annuli, false ) );
     m_params.emplace_back( new PARAM<bool>( "render.plated_and_bare_copper",
                                             &m_Render.differentiate_plated_copper, false ) );
+    m_params.emplace_back( new PARAM<bool>( "render.use_board_editor_copper_colors",
+                                            &m_Render.use_board_editor_copper_colors, false ) );
     m_params.emplace_back( new PARAM<bool>( "camera.animation_enabled",
                                             &m_Camera.animation_enabled, true ) );
     m_params.emplace_back( new PARAM<int>( "camera.moving_speed_multiplier",
@@ -377,6 +379,8 @@ EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS() :
     m_params.emplace_back( new PARAM<int>( "camera.projection_mode",
                                            &m_Camera.projection_mode, 1 ) );
 
+    m_params.emplace_back( new PARAM<bool>( "use_stackup_colors",
+                                            &m_UseStackupColors, true ) );
     m_params.emplace_back( new PARAM_LAYER_PRESET_3D( "layer_presets",
                                                       &m_LayerPresets ) );
     m_params.emplace_back( new PARAM<wxString>( "current_layer_preset",

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
 {
@@ -146,6 +147,22 @@ public:
         bool subtract_mask_from_silk;
         bool clip_silk_on_via_annuli;
         bool differentiate_plated_copper;
+        // Board editor copper colors are used only in OpenGL mode if
+        // use_board_editor_copper_colors is true
+        bool use_board_editor_copper_colors;
+
+        /**
+         * return true if platted copper aeras and non platted copper areas must be drawn
+         * using a different color
+         * in OPENGL mode, if use_board_editor_copper_colors, always false
+         * in RAYTRACING mode, use_board_editor_copper_colors is ignored (board editor copper
+         * colors are ignored)
+         */
+        bool DifferentiatePlatedCopper()
+        {
+            return engine == RENDER_ENGINE::RAYTRACING ? differentiate_plated_copper
+                                : differentiate_plated_copper && !use_board_editor_copper_colors;
+        }
     };
 
     struct CAMERA_SETTINGS
@@ -169,6 +186,7 @@ public:
     RENDER_SETTINGS m_Render;
     CAMERA_SETTINGS m_Camera;
 
+    bool                         m_UseStackupColors;
     std::vector<LAYER_PRESET_3D> m_LayerPresets;
     wxString                     m_CurrentPreset;
 

3d-viewer/3d_viewer/tools/eda_3d_actions.cpp

@@ -53,7 +53,6 @@ TOOL_ACTION EDA_3D_ACTIONS::rotateXCW( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.rotateXclockwise" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "Rotate X Clockwise" ) )
-        .Tooltip( _( "Rotate X Clockwise" ) )
         .Icon( BITMAPS::rotate_cw_x )
         .Flags( AF_NONE )
         .Parameter( ROTATION_DIR::X_CW ) );
@@ -62,7 +61,6 @@ TOOL_ACTION EDA_3D_ACTIONS::rotateXCCW( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.rotateXcounterclockwise" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "Rotate X Counterclockwise" ) )
-        .Tooltip( _( "Rotate X Counterclockwise" ) )
         .Icon( BITMAPS::rotate_ccw_x )
         .Flags( AF_NONE )
         .Parameter( ROTATION_DIR::X_CCW ) );
@@ -71,7 +69,6 @@ TOOL_ACTION EDA_3D_ACTIONS::rotateYCW( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.rotateYclockwise" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "Rotate Y Clockwise" ) )
-        .Tooltip( _( "Rotate Y Clockwise" ) )
         .Icon( BITMAPS::rotate_cw_y )
         .Flags( AF_NONE )
         .Parameter( ROTATION_DIR::Y_CW ) );
@@ -80,7 +77,6 @@ TOOL_ACTION EDA_3D_ACTIONS::rotateYCCW( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.rotateYcounterclockwise" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "Rotate Y Counterclockwise" ) )
-        .Tooltip( _( "Rotate Y Counterclockwise" ) )
         .Icon( BITMAPS::rotate_ccw_y )
         .Flags( AF_NONE )
         .Parameter( ROTATION_DIR::Y_CCW ) );
@@ -89,7 +85,6 @@ TOOL_ACTION EDA_3D_ACTIONS::rotateZCW( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.rotateZclockwise" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "Rotate Z Clockwise" ) )
-        .Tooltip( _( "Rotate Z Clockwise" ) )
         .Icon( BITMAPS::rotate_cw_z )
         .Flags( AF_NONE )
         .Parameter( ROTATION_DIR::Z_CW ) );
@@ -98,7 +93,6 @@ TOOL_ACTION EDA_3D_ACTIONS::rotateZCCW( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.rotateZcounterclockwise" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "Rotate Z Counterclockwise" ) )
-        .Tooltip( _( "Rotate Z Counterclockwise" ) )
         .Icon( BITMAPS::rotate_ccw_z )
         .Flags( AF_NONE )
         .Parameter( ROTATION_DIR::Z_CCW ) );
@@ -108,7 +102,6 @@ TOOL_ACTION EDA_3D_ACTIONS::moveLeft( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( WXK_LEFT )
         .FriendlyName( _( "Move Board Left" ) )
-        .Tooltip( _( "Move board Left" ) )
         .Icon( BITMAPS::left )
         .Flags( AF_NONE )
         .Parameter( CURSOR_LEFT ) );
@@ -118,7 +111,6 @@ TOOL_ACTION EDA_3D_ACTIONS::moveRight( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( WXK_RIGHT )
         .FriendlyName( _( "Move Board Right" ) )
-        .Tooltip( _( "Move board Right" ) )
         .Icon( BITMAPS::right )
         .Flags( AF_NONE )
         .Parameter( CURSOR_RIGHT ) );
@@ -128,7 +120,6 @@ TOOL_ACTION EDA_3D_ACTIONS::moveUp( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( WXK_UP )
         .FriendlyName( _( "Move Board Up" ) )
-        .Tooltip( _( "Move board Up" ) )
         .Icon( BITMAPS::up )
         .Flags( AF_NONE )
         .Parameter( CURSOR_UP ) );
@@ -138,7 +129,6 @@ TOOL_ACTION EDA_3D_ACTIONS::moveDown( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( WXK_DOWN )
         .FriendlyName( _( "Move Board Down" ) )
-        .Tooltip( _( "Move board Down" ) )
         .Icon( BITMAPS::down )
         .Flags( AF_NONE )
         .Parameter( CURSOR_DOWN ) );
@@ -148,7 +138,7 @@ TOOL_ACTION EDA_3D_ACTIONS::homeView( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( WXK_HOME )
         .FriendlyName ( _( "Home View" ) )
-        .Tooltip( _( "Home view" ) )
+        .Tooltip( _( "Redraw at the home position and zoom" ) )
         .Flags( AF_NONE )
         .Parameter( VIEW3D_TYPE::VIEW3D_FIT_SCREEN ) );
 
@@ -174,7 +164,6 @@ TOOL_ACTION EDA_3D_ACTIONS::viewFront( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( 'Y' )
         .FriendlyName( _( "View Front" ) )
-        .Tooltip( _( "View Front" ) )
         .Icon( BITMAPS::axis3d_front )
         .Flags( AF_NONE )
         .Parameter( VIEW3D_TYPE::VIEW3D_FRONT ) );
@@ -184,7 +173,6 @@ TOOL_ACTION EDA_3D_ACTIONS::viewBack( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( MD_SHIFT + 'Y' )
         .FriendlyName( _( "View Back" ) )
-        .Tooltip( _( "View Back" ) )
         .Icon( BITMAPS::axis3d_back )
         .Flags( AF_NONE )
         .Parameter( VIEW3D_TYPE::VIEW3D_BACK ) );
@@ -194,7 +182,6 @@ TOOL_ACTION EDA_3D_ACTIONS::viewLeft( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( MD_SHIFT + 'X' )
         .FriendlyName( _( "View Left" ) )
-        .Tooltip( _( "View Left" ) )
         .Icon( BITMAPS::axis3d_left )
         .Flags( AF_NONE )
         .Parameter( VIEW3D_TYPE::VIEW3D_LEFT ) );
@@ -204,7 +191,6 @@ TOOL_ACTION EDA_3D_ACTIONS::viewRight( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( 'X' )
         .FriendlyName( _( "View Right" ) )
-        .Tooltip( _( "View Right" ) )
         .Icon( BITMAPS::axis3d_right )
         .Flags( AF_NONE )
         .Parameter( VIEW3D_TYPE::VIEW3D_RIGHT ) );
@@ -214,7 +200,6 @@ TOOL_ACTION EDA_3D_ACTIONS::viewTop( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( 'Z' )
         .FriendlyName( _( "View Top" ) )
-        .Tooltip( _( "View Top" ) )
         .Icon( BITMAPS::axis3d_top )
         .Flags( AF_NONE )
         .Parameter( VIEW3D_TYPE::VIEW3D_TOP ) );
@@ -224,7 +209,6 @@ TOOL_ACTION EDA_3D_ACTIONS::viewBottom( TOOL_ACTION_ARGS()
         .Scope( AS_ACTIVE )
         .DefaultHotkey( MD_SHIFT + 'Z' )
         .FriendlyName( _( "View Bottom" ) )
-        .Tooltip( _( "View Bottom" ) )
         .Icon( BITMAPS::axis3d_bottom )
         .Flags( AF_NONE )
         .Parameter( VIEW3D_TYPE::VIEW3D_BOTTOM ) );
@@ -233,7 +217,6 @@ TOOL_ACTION EDA_3D_ACTIONS::noGrid( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.noGrid" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "No 3D Grid" ) )
-        .Tooltip( _( "No 3D Grid" ) )
         .Flags( AF_NONE )
         .Parameter( GRID3D_TYPE::NONE ) );
 
@@ -241,7 +224,6 @@ TOOL_ACTION EDA_3D_ACTIONS::show10mmGrid( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.show10mmGrid" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "3D Grid 10mm" ) )
-        .Tooltip( _( "3D Grid 10mm" ) )
         .Flags( AF_NONE )
         .Parameter( GRID3D_TYPE::GRID_10MM ) );
 
@@ -249,7 +231,6 @@ TOOL_ACTION EDA_3D_ACTIONS::show5mmGrid( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.show5mmGrid" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "3D Grid 5mm" ) )
-        .Tooltip( _( "3D Grid 5mm" ) )
         .Flags( AF_NONE )
         .Parameter( GRID3D_TYPE::GRID_5MM ) );
 
@@ -257,7 +238,6 @@ TOOL_ACTION EDA_3D_ACTIONS::show2_5mmGrid( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.show2_5mmGrid" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "3D Grid 2.5mm" ) )
-        .Tooltip( _( "3D Grid 2.5mm" ) )
         .Flags( AF_NONE )
         .Parameter( GRID3D_TYPE::GRID_2P5MM ) );
 
@@ -265,7 +245,6 @@ TOOL_ACTION EDA_3D_ACTIONS::show1mmGrid( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.show1mmGrid" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "3D Grid 1mm" ) )
-        .Tooltip( _( "3D Grid 1mm" ) )
         .Flags( AF_NONE )
         .Parameter( GRID3D_TYPE::GRID_1MM ) );
 
@@ -350,7 +329,6 @@ TOOL_ACTION EDA_3D_ACTIONS::showAxis( TOOL_ACTION_ARGS()
         .Name( "3DViewer.Control.showAxis" )
         .Scope( AS_GLOBAL )
         .FriendlyName( _( "Show 3D Axis" ) )
-        .Tooltip( _( "Show 3D Axis" ) )
         .Icon( BITMAPS::axis3d_front )
         .Flags( AF_NONE ) );
 

3d-viewer/3d_viewer/tools/eda_3d_controller.cpp

@@ -37,7 +37,7 @@
 
 bool EDA_3D_CONTROLLER::Init()
 {
-    CONDITIONAL_MENU& ctxMenu = m_menu.GetMenu();
+    CONDITIONAL_MENU& ctxMenu = m_menu->GetMenu();
 
     ctxMenu.AddItem( ACTIONS::zoomInCenter,       SELECTION_CONDITIONS::ShowAlways );
     ctxMenu.AddItem( ACTIONS::zoomOutCenter,      SELECTION_CONDITIONS::ShowAlways );
@@ -118,12 +118,9 @@ int EDA_3D_CONTROLLER::Main( const TOOL_EVENT& aEvent )
         if( evt->IsCancelInteractive() )
         {
             wxWindow* canvas = m_toolMgr->GetToolHolder()->GetToolCanvas();
-            wxWindow* topLevelParent = wxGetTopLevelParent( canvas->GetParent() );
 
-            if( topLevelParent && dynamic_cast<DIALOG_SHIM*>( topLevelParent ) )
+            if( DIALOG_SHIM* dialog = dynamic_cast<DIALOG_SHIM*>( wxGetTopLevelParent( canvas ) ) )
             {
-                DIALOG_SHIM* dialog = static_cast<DIALOG_SHIM*>( topLevelParent );
-
                 if( dialog->IsQuasiModal() )
                     dialog->EndQuasiModal( wxID_CANCEL );
                 else
@@ -136,7 +133,7 @@ int EDA_3D_CONTROLLER::Main( const TOOL_EVENT& aEvent )
         }
         else if( evt->IsClick( BUT_RIGHT ) )
         {
-            m_menu.ShowContextMenu();
+            m_menu->ShowContextMenu();
         }
         else
         {

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
@@ -89,7 +91,6 @@ set(3D-VIEWER_SRCS
     common_ogl/ogl_utils.cpp
     3d_fastmath.cpp
     3d_math.cpp
-    dialogs/3d_cache_dialogs.cpp
     dialogs/appearance_controls_3D.cpp
     dialogs/appearance_controls_3D_base.cpp
     dialogs/dialog_select_3d_model_base.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

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2023 CERN
- * Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2023-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
@@ -41,6 +41,7 @@
 #include <wx/bmpbuttn.h>
 #include <wx/sizer.h>
 #include <wx/textdlg.h>
+#include <wx/checkbox.h>
 
 #include <../3d_rendering/opengl/render_3d_opengl.h>
 
@@ -82,6 +83,13 @@ const APPEARANCE_CONTROLS_3D::APPEARANCE_SETTING_3D APPEARANCE_CONTROLS_3D::s_la
     RR( _HKI( "Background End" ),         LAYER_3D_BACKGROUND_BOTTOM, _HKI( "Background gradient end color" ) ),
 };
 
+// The list of IDs that can have colors coming from the board stackup, and cannot be
+// modified if use colors from stackup is activated
+static std::vector<int> inStackupColors{ LAYER_3D_BOARD, LAYER_3D_COPPER_TOP,
+                                         LAYER_3D_COPPER_BOTTOM, LAYER_3D_SOLDERPASTE,
+                                         LAYER_3D_SILKSCREEN_TOP, LAYER_3D_SILKSCREEN_BOTTOM,
+                                         LAYER_3D_SOLDERMASK_TOP, LAYER_3D_SOLDERMASK_BOTTOM
+                                        };
 
 APPEARANCE_CONTROLS_3D::APPEARANCE_CONTROLS_3D( EDA_3D_VIEWER_FRAME* aParent,
                                                 wxWindow* aFocusOwner ) :
@@ -92,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();
 
@@ -112,6 +119,43 @@ APPEARANCE_CONTROLS_3D::APPEARANCE_CONTROLS_3D( EDA_3D_VIEWER_FRAME* aParent,
     m_presetsLabel->SetFont( infoFont );
     m_viewportsLabel->SetFont( infoFont );
 
+    // Create display options
+    m_cbUseBoardStackupColors = new wxCheckBox( m_panelLayers, wxID_ANY,
+                                                _( "Use board stackup colors" ) );
+    m_cbUseBoardStackupColors->SetFont( infoFont );
+
+    m_cbUseBoardStackupColors->Bind( wxEVT_CHECKBOX,
+            [this]( wxCommandEvent& aEvent )
+            {
+                EDA_3D_VIEWER_SETTINGS* cfg = m_frame->GetAdapter().m_Cfg;
+                cfg->m_UseStackupColors = aEvent.IsChecked();
+
+                UpdateLayerCtls();
+                syncLayerPresetSelection();
+                m_frame->NewDisplay( true );
+            } );
+
+    m_cbUseBoardEditorCopperColors = new wxCheckBox( m_panelLayers, wxID_ANY,
+                                                _( "Use board editor copper colors" ) );
+    m_cbUseBoardEditorCopperColors->SetFont( infoFont );
+    m_cbUseBoardEditorCopperColors->SetToolTip(
+                _( "Use the board editor copper colors (openGL only)" ) );
+
+    m_cbUseBoardEditorCopperColors->Bind( wxEVT_CHECKBOX,
+            [this]( wxCommandEvent& aEvent )
+            {
+                EDA_3D_VIEWER_SETTINGS* cfg = m_frame->GetAdapter().m_Cfg;
+                cfg->m_Render.use_board_editor_copper_colors = aEvent.IsChecked();
+
+                UpdateLayerCtls();
+                syncLayerPresetSelection();
+                m_frame->NewDisplay( true );
+            } );
+
+
+    m_panelLayersSizer->Add( m_cbUseBoardStackupColors, 0, wxEXPAND | wxTOP | wxLEFT | wxRIGHT, 7 );
+    m_panelLayersSizer->Add( m_cbUseBoardEditorCopperColors, 0, wxEXPAND | wxTOP | wxLEFT | wxRIGHT, 7 );
+
     m_cbLayerPresets->SetToolTip( wxString::Format( _( "Save and restore color and visibility "
                                                        "combinations.\n"
                                                        "Use %s+Tab to activate selector.\n"
@@ -127,18 +171,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 );
 }
 
 
@@ -173,10 +220,12 @@ void APPEARANCE_CONTROLS_3D::OnSize( wxSizeEvent& aEvent )
 }
 
 
-void APPEARANCE_CONTROLS_3D::OnLanguageChanged()
+void APPEARANCE_CONTROLS_3D::rebuildControls()
 {
     Freeze();
+
     rebuildLayers();
+    m_cbUseBoardStackupColors->SetLabel( _( "Use board stackup colors" ) );
     rebuildLayerPresetsWidget();
     rebuildViewportsWidget();
 
@@ -185,6 +234,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
@@ -208,7 +265,10 @@ void APPEARANCE_CONTROLS_3D::OnDarkModeToggle()
 
 void APPEARANCE_CONTROLS_3D::CommonSettingsChanged()
 {
-    OnLanguageChanged();
+    rebuildControls();
+
+    UpdateLayerCtls();
+    syncLayerPresetSelection();
 }
 
 
@@ -437,6 +497,19 @@ void APPEARANCE_CONTROLS_3D::rebuildLayers()
                                                              SWATCH_SMALL );
                     swatch->SetToolTip( _( "Left double click or middle click to change color" ) );
 
+                    swatch->SetReadOnlyCallback(
+                            [this]()
+                            {
+                                WX_INFOBAR* infobar = m_frame->GetInfoBar();
+
+                                infobar->RemoveAllButtons();
+                                infobar->AddCloseButton();
+
+                                infobar->ShowMessageFor( _( "Uncheck 'Use board stackup colors' to "
+                                                            "allow color editing." ),
+                                                         10000, wxICON_INFORMATION );
+                            } );
+
                     sizer->Add( swatch, 0,  wxALIGN_CENTER_VERTICAL, 0 );
                     aSetting->m_Ctl_color = swatch;
 
@@ -466,10 +539,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 )
@@ -515,6 +587,7 @@ void APPEARANCE_CONTROLS_3D::rebuildLayers()
 
 void APPEARANCE_CONTROLS_3D::UpdateLayerCtls()
 {
+    EDA_3D_VIEWER_SETTINGS*   cfg = m_frame->GetAdapter().m_Cfg;
     std::bitset<LAYER_3D_END> visibleLayers = m_frame->GetAdapter().GetVisibleLayers();
     std::map<int, COLOR4D>    colors = m_frame->GetAdapter().GetLayerColors();
 
@@ -527,7 +600,24 @@ void APPEARANCE_CONTROLS_3D::UpdateLayerCtls()
             setting->m_Ctl_visibility->SetValue( visibleLayers.test( setting->m_Id ) );
 
         if( setting->m_Ctl_color )
+        {
             setting->m_Ctl_color->SetSwatchColor( colors[ setting->m_Id ], false );
+
+            // if cfg->m_UseStackupColors is set, board colors cannot be modified locally, but
+            // other colors can be
+            if( std::find( inStackupColors.begin(), inStackupColors.end(), setting->m_Id )
+                != inStackupColors.end() )
+            {
+                if( cfg )
+                    setting->m_Ctl_color->SetReadOnly( cfg->m_UseStackupColors );
+            }
+        }
+    }
+
+    if( cfg )
+    {
+        m_cbUseBoardStackupColors->SetValue( cfg->m_UseStackupColors );
+        m_cbUseBoardEditorCopperColors->SetValue( cfg->m_Render.use_board_editor_copper_colors );
     }
 }
 
@@ -563,9 +653,16 @@ void APPEARANCE_CONTROLS_3D::syncLayerPresetSelection()
     std::bitset<LAYER_3D_END>     visibleLayers = m_frame->GetAdapter().GetVisibleLayers();
     std::map<int, COLOR4D>        colors = m_frame->GetAdapter().GetLayerColors();
 
-    auto it = std::find_if( presets.begin(), presets.end(),
+    auto it = std::find_if(
+            presets.begin(), presets.end(),
             [&]( const LAYER_PRESET_3D& aPreset )
             {
+                if( aPreset.name.Lower() == _( "legacy colors" )
+                    && m_cbUseBoardStackupColors->GetValue() )
+                {
+                    return false;
+                }
+
                 for( int layer = LAYER_3D_BOARD; layer < LAYER_3D_END; ++layer )
                 {
                     if( aPreset.layers.test( layer ) != visibleLayers.test( layer ) )
@@ -578,9 +675,12 @@ void APPEARANCE_CONTROLS_3D::syncLayerPresetSelection()
                         return false;
                 }
 
-                for( int layer = LAYER_3D_BOARD; layer < LAYER_3D_ADHESIVE; ++layer )
+                for( int layer = LAYER_3D_START + 1; layer < LAYER_3D_END; ++layer )
                 {
-                    if( aPreset.colors.at( layer ) != colors.at( layer ) )
+                    auto it1 = aPreset.colors.find( layer );
+                    auto it2 = colors.find( layer );
+
+                    if( it1 != aPreset.colors.end() && it2 != colors.end() && *it1 != *it2 )
                         return false;
                 }
 
@@ -645,7 +745,8 @@ void APPEARANCE_CONTROLS_3D::onLayerPresetChanged( wxCommandEvent& aEvent )
     }
     else if( index == count - 2 )
     {
-        wxTextEntryDialog dlg( this, _( "Layer preset name:" ), _( "Save Layer Preset" ) );
+        wxTextEntryDialog dlg( wxGetTopLevelParent( this ), _( "Layer preset name:" ),
+                               _( "Save Layer Preset" ) );
 
         if( dlg.ShowModal() != wxID_OK )
         {
@@ -660,7 +761,7 @@ void APPEARANCE_CONTROLS_3D::onLayerPresetChanged( wxCommandEvent& aEvent )
 
         if( LAYER_PRESET_3D* preset = cfg->FindPreset( name ) )
         {
-            if( !IsOK( this, _( "Overwrite existing preset?" ) ) )
+            if( !IsOK( wxGetTopLevelParent( this ), _( "Overwrite existing preset?" ) ) )
             {
                 resetSelection();
                 return;
@@ -744,6 +845,9 @@ void APPEARANCE_CONTROLS_3D::doApplyLayerPreset( const LAYER_PRESET_3D& aPreset
     adapter.SetVisibleLayers( aPreset.layers );
     adapter.SetLayerColors( aPreset.colors );
 
+    if( aPreset.name.Lower() == _( "legacy colors" ) )
+        adapter.m_Cfg->m_UseStackupColors = false;
+
     UpdateLayerCtls();
     m_frame->NewDisplay( true );
 }
@@ -792,7 +896,8 @@ void APPEARANCE_CONTROLS_3D::onViewportChanged( wxCommandEvent& aEvent )
         // Save current state to new preset
         wxString name;
 
-        wxTextEntryDialog dlg( this, _( "Viewport name:" ), _( "Save Viewport" ), name );
+        wxTextEntryDialog dlg( wxGetTopLevelParent( this ), _( "Viewport name:" ),
+                               _( "Save Viewport" ), name );
 
         if( dlg.ShowModal() != wxID_OK )
         {

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();
@@ -166,26 +167,27 @@ private:
     void passOnFocus();
 
 private:
-    EDA_3D_VIEWER_FRAME* m_frame;
-    wxWindow*            m_focusOwner;
-
     static const APPEARANCE_SETTING_3D s_layerSettings[];
 
-    GRID_BITMAP_TOGGLE_RENDERER* m_toggleGridRenderer;
+    EDA_3D_VIEWER_FRAME*           m_frame;
+    wxWindow*                      m_focusOwner;
 
     std::vector<std::unique_ptr<APPEARANCE_SETTING_3D>> m_layerSettings;
     std::map<int, APPEARANCE_SETTING_3D*>               m_layerSettingsMap;
 
-    wxArrayString                       m_presetMRU;
+    wxArrayString                  m_presetMRU;
 
-    std::map<wxString, VIEWPORT3D>      m_viewports;
-    VIEWPORT3D*                         m_lastSelectedViewport;
-    wxArrayString                       m_viewportMRU;
+    std::map<wxString, VIEWPORT3D> m_viewports;
+    VIEWPORT3D*                    m_lastSelectedViewport;
+    wxArrayString                  m_viewportMRU;
 
-    wxBoxSizer* m_layersOuterSizer;
-    wxBoxSizer* m_envOuterSizer;
-    int         m_pointSize;
-    wxColour    m_layerPanelColour;
+    wxBoxSizer*                    m_layersOuterSizer;
+    wxBoxSizer*                    m_envOuterSizer;
+    int                            m_pointSize;
+    wxColour                       m_layerPanelColour;
+    GRID_BITMAP_TOGGLE_RENDERER*   m_toggleGridRenderer;
+    wxCheckBox*                    m_cbUseBoardStackupColors;
+    wxCheckBox*                    m_cbUseBoardEditorCopperColors;
 };
 
 #endif

3d-viewer/dialogs/appearance_controls_3D_base.cpp

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b3)
+// C++ code generated with wxFormBuilder (version 4.0.0-0-g0efcecf)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!
@@ -25,11 +25,14 @@ APPEARANCE_CONTROLS_3D_BASE::APPEARANCE_CONTROLS_3D_BASE( wxWindow* parent, wxWi
 	m_panelLayers->SetSizer( m_panelLayersSizer );
 	m_panelLayers->Layout();
 	m_panelLayersSizer->Fit( m_panelLayers );
-	m_sizerOuter->Add( m_panelLayers, 1, wxEXPAND|wxBOTTOM, 5 );
+	m_sizerOuter->Add( m_panelLayers, 1, wxEXPAND, 5 );
 
 	wxBoxSizer* bBottomMargin;
 	bBottomMargin = new wxBoxSizer( wxVERTICAL );
 
+	m_staticline1 = new wxStaticLine( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLI_HORIZONTAL );
+	bBottomMargin->Add( m_staticline1, 0, wxEXPAND|wxBOTTOM, 3 );
+
 	wxBoxSizer* bPresets;
 	bPresets = new wxBoxSizer( wxVERTICAL );
 
@@ -44,7 +47,7 @@ APPEARANCE_CONTROLS_3D_BASE::APPEARANCE_CONTROLS_3D_BASE( wxWindow* parent, wxWi
 	bPresets->Add( m_cbLayerPresets, 0, wxALL|wxEXPAND, 2 );
 
 
-	bBottomMargin->Add( bPresets, 0, wxEXPAND|wxRIGHT|wxLEFT, 5 );
+	bBottomMargin->Add( bPresets, 0, wxEXPAND|wxTOP|wxRIGHT|wxLEFT, 5 );
 
 
 	bBottomMargin->Add( 0, 2, 0, wxEXPAND, 5 );

3d-viewer/dialogs/appearance_controls_3D_base.h

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b3)
+// C++ code generated with wxFormBuilder (version 4.0.0-0-g0efcecf)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!
@@ -20,6 +20,7 @@
 #include <wx/string.h>
 #include <wx/sizer.h>
 #include <wx/panel.h>
+#include <wx/statline.h>
 #include <wx/stattext.h>
 #include <wx/choice.h>
 
@@ -38,6 +39,7 @@ class APPEARANCE_CONTROLS_3D_BASE : public WX_PANEL
 		wxPanel* m_panelLayers;
 		wxBoxSizer* m_panelLayersSizer;
 		wxScrolledCanvas* m_windowLayers;
+		wxStaticLine* m_staticline1;
 		wxStaticText* m_presetsLabel;
 		wxChoice* m_cbLayerPresets;
 		wxStaticText* m_viewportsLabel;

3d-viewer/dialogs/dialog_select_3d_model.cpp

@@ -3,7 +3,7 @@
  *
  * Copyright (C) 2016 Mario Luzeiro <mrluzeiro@ua.pt>
  * Copyright (C) 2016 Cirilo Bernardo <cirilo.bernardo@gmail.com>
- * Copyright (C) 2017-2022 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2017-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
@@ -29,9 +29,9 @@
 #include "project.h"
 #include "3d_cache/3d_info.h"
 #include "3d_cache/3d_cache.h"
-#include "3d_cache_dialogs.h"
 #include <3d_model_viewer/eda_3d_model_viewer.h>
 #include <common_ogl/ogl_attr_list.h>
+#include <dialogs/dialog_configure_paths.h>
 #include <filename_resolver.h>
 #include <pcbnew/footprint.h>
 #include <wx_filename.h>
@@ -191,13 +191,18 @@ void DIALOG_SELECT_3DMODEL::OnFileActivated( wxCommandEvent& event )
 void DIALOG_SELECT_3DMODEL::SetRootDir( wxCommandEvent& event )
 {
     if( m_FileTree && m_dirChoices->GetSelection() > 0 )
+    {
         m_FileTree->SetPath( m_dirChoices->GetString( m_dirChoices->GetSelection() ) );
+        m_FileTree->UnselectAll();  // Ensure no unwanted selection
+    }
 }
 
 
 void DIALOG_SELECT_3DMODEL::Cfg3DPaths( wxCommandEvent& event )
 {
-    if( S3D::Configure3DPaths( this, m_resolver ) )
+    DIALOG_CONFIGURE_PATHS dlg( this );
+
+    if( dlg.ShowQuasiModal() == wxID_OK )
         updateDirChoiceList();
 }
 

3d-viewer/dialogs/dialog_select_3d_model.h

@@ -44,6 +44,11 @@ public:
     void SetRootDir( wxCommandEvent& event ) override;
     void Cfg3DPaths( wxCommandEvent& event ) override;
 
+    bool IsEmbedded3DModel() const
+    {
+        return m_EmbedModelCb->IsChecked();
+    }
+
 private:
     void updateDirChoiceList( void );
 

3d-viewer/dialogs/dialog_select_3d_model_base.cpp

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b)
+// C++ code generated with wxFormBuilder (version 4.2.1-0-g80c4cb6)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!
@@ -28,13 +28,19 @@ DIALOG_SELECT_3D_MODEL_BASE::DIALOG_SELECT_3D_MODEL_BASE( wxWindow* parent, wxWi
 	wxBoxSizer* bSizerLeft;
 	bSizerLeft = new wxBoxSizer( wxVERTICAL );
 
-	m_FileTree = new wxGenericDirCtrl( m_panelLeft, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxDIRCTRL_3D_INTERNAL|wxDIRCTRL_EDIT_LABELS|wxDIRCTRL_SELECT_FIRST|wxDIRCTRL_SHOW_FILTERS|wxBORDER_DEFAULT, wxEmptyString, 0 );
+	m_FileTree = new wxGenericDirCtrl( m_panelLeft, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, wxDIRCTRL_3D_INTERNAL|wxDIRCTRL_EDIT_LABELS|wxDIRCTRL_SHOW_FILTERS|wxBORDER_DEFAULT, wxEmptyString, 0 );
 
 	m_FileTree->ShowHidden( false );
 	m_FileTree->SetMinSize( wxSize( 300,-1 ) );
 
 	bSizerLeft->Add( m_FileTree, 1, wxALL|wxEXPAND, 5 );
 
+	wxBoxSizer* bSizer7;
+	bSizer7 = new wxBoxSizer( wxHORIZONTAL );
+
+
+	bSizerLeft->Add( bSizer7, 0, wxEXPAND, 5 );
+
 
 	m_panelLeft->SetSizer( bSizerLeft );
 	m_panelLeft->Layout();
@@ -70,6 +76,15 @@ DIALOG_SELECT_3D_MODEL_BASE::DIALOG_SELECT_3D_MODEL_BASE( wxWindow* parent, wxWi
 
 	bSizerMain->Add( bSizerLower, 0, wxEXPAND, 5 );
 
+	wxBoxSizer* bSizer6;
+	bSizer6 = new wxBoxSizer( wxHORIZONTAL );
+
+	m_EmbedModelCb = new wxCheckBox( this, wxID_ANY, _("Embed Model"), wxDefaultPosition, wxDefaultSize, 0 );
+	bSizer6->Add( m_EmbedModelCb, 0, wxALL, 5 );
+
+
+	bSizer6->Add( 0, 0, 1, wxEXPAND, 5 );
+
 	m_sdbSizer = new wxStdDialogButtonSizer();
 	m_sdbSizerOK = new wxButton( this, wxID_OK );
 	m_sdbSizer->AddButton( m_sdbSizerOK );
@@ -77,7 +92,10 @@ DIALOG_SELECT_3D_MODEL_BASE::DIALOG_SELECT_3D_MODEL_BASE( wxWindow* parent, wxWi
 	m_sdbSizer->AddButton( m_sdbSizerCancel );
 	m_sdbSizer->Realize();
 
-	bSizerMain->Add( m_sdbSizer, 0, wxEXPAND|wxALL, 5 );
+	bSizer6->Add( m_sdbSizer, 0, wxEXPAND|wxALL, 5 );
+
+
+	bSizerMain->Add( bSizer6, 0, wxEXPAND, 5 );
 
 
 	this->SetSizer( bSizerMain );

3d-viewer/dialogs/dialog_select_3d_model_base.h

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b)
+// C++ code generated with wxFormBuilder (version 4.2.1-0-g80c4cb6)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!
@@ -26,11 +26,11 @@
 #include <wx/bitmap.h>
 #include <wx/image.h>
 #include <wx/icon.h>
+#include <wx/checkbox.h>
 #include <wx/dialog.h>
 
 ///////////////////////////////////////////////////////////////////////////
 
-
 ///////////////////////////////////////////////////////////////////////////////
 /// Class DIALOG_SELECT_3D_MODEL_BASE
 ///////////////////////////////////////////////////////////////////////////////
@@ -47,6 +47,7 @@ class DIALOG_SELECT_3D_MODEL_BASE : public DIALOG_SHIM
 		wxStaticText* m_stDirChoice;
 		wxChoice* m_dirChoices;
 		wxButton* m_cfgPathsButt;
+		wxCheckBox* m_EmbedModelCb;
 		wxStdDialogButtonSizer* m_sdbSizer;
 		wxButton* m_sdbSizerOK;
 		wxButton* m_sdbSizerCancel;

3d-viewer/dialogs/panel_preview_3d_model.cpp

@@ -36,14 +36,18 @@
 #include <board.h>
 #include <common_ogl/ogl_attr_list.h>
 #include <dpi_scaling_common.h>
+#include <lset.h>
 #include <pgm_base.h>
 #include <project_pcb.h>
 #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 ) :
@@ -113,7 +117,7 @@ PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL( wxWindow* aParent, PCB_BASE_FRAM
     // Ensure the footprint is shown like in Fp editor: rot 0, not flipped
     // to avoid mistakes when setting the3D shape position/rotation
     if( m_dummyFootprint->IsFlipped() )
-        m_dummyFootprint->Flip( m_dummyFootprint->GetPosition(), false );
+        m_dummyFootprint->Flip( m_dummyFootprint->GetPosition(), FLIP_DIRECTION::TOP_BOTTOM );
 
     m_dummyFootprint->SetOrientation( ANGLE_0 );
 
@@ -123,7 +127,11 @@ 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_boardAdapter, m_currentCamera,
+                                       PROJECT_PCB::Get3DCacheManager( &aFrame->Prj() ) );
+
+    m_spaceMouse = new NL_FOOTPRINT_PROPERTIES_PLUGIN( m_previewPane );
+    m_spaceMouse->SetFocus( true );
 
     m_boardAdapter.SetBoard( m_dummyBoard );
     m_boardAdapter.m_IsBoardView = false;
@@ -162,25 +170,7 @@ PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL( wxWindow* aParent, PCB_BASE_FRAM
                      wxCommandEventHandler( PANEL_PREVIEW_3D_MODEL::onUnitsChanged ),
                      nullptr, 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
+    Bind( wxCUSTOM_PANEL_SHOWN_EVENT, &PANEL_PREVIEW_3D_MODEL::onPanelShownEvent, this );
 }
 
 
@@ -190,6 +180,7 @@ 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;
 }
@@ -210,13 +201,10 @@ void PANEL_PREVIEW_3D_MODEL::loadSettings()
 
     COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
 
-    const DPI_SCALING_COMMON dpi{ settings, this };
-    m_previewPane->SetScaleFactor( dpi.GetScaleFactor() );
-
     // TODO(JE) use all control options
     m_boardAdapter.m_MousewheelPanning = settings->m_Input.scroll_modifier_zoom != 0;
 
-    EDA_3D_VIEWER_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
+    auto* cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>( "3d_viewer" );
 
     if( cfg )
     {
@@ -237,6 +225,7 @@ void PANEL_PREVIEW_3D_MODEL::loadSettings()
         cfg->m_Render.show_solderpaste = m_bodyStyleShowAll;
         cfg->m_Render.show_zones = m_bodyStyleShowAll;
         cfg->m_Render.show_board_body = m_bodyStyleShowAll;
+        cfg->m_Render.use_board_editor_copper_colors = false;
     }
 }
 
@@ -274,6 +263,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 ) );
@@ -307,9 +300,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 ) );
@@ -352,9 +347,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() )
@@ -368,6 +365,7 @@ void PANEL_PREVIEW_3D_MODEL::updateOrientation( wxCommandEvent &event )
 
         // Update the dummy footprint for the preview
         UpdateDummyFootprint( false );
+        onModify();
     }
 }
 
@@ -383,6 +381,7 @@ void PANEL_PREVIEW_3D_MODEL::onOpacitySlider( wxCommandEvent& event )
 
         // Update the dummy footprint for the preview
         UpdateDummyFootprint( false );
+        onModify();
     }
 }
 
@@ -444,10 +443,15 @@ void PANEL_PREVIEW_3D_MODEL::doIncrementScale( wxSpinEvent& event, double aSign
     else if( spinCtrl == m_spinZscale )
         textCtrl = zscale;
 
+    double step = SCALE_INCREMENT;
+
+    if( wxGetMouseState().ShiftDown( ) )
+        step = SCALE_INCREMENT_FINE;
+
     double curr_value = EDA_UNIT_UTILS::UI::DoubleValueFromString( pcbIUScale, EDA_UNITS::UNSCALED,
                                                                    textCtrl->GetValue() );
 
-    curr_value += ( SCALE_INCREMENT * aSign );
+    curr_value += ( step * aSign );
     curr_value = std::max( 1/MAX_SCALE, curr_value );
     curr_value = std::min( curr_value, MAX_SCALE );
 
@@ -465,10 +469,15 @@ void PANEL_PREVIEW_3D_MODEL::doIncrementRotation( wxSpinEvent& aEvent, double aS
     else if( spinCtrl == m_spinZrot )
         textCtrl = zrot;
 
+    double step = ROTATION_INCREMENT;
+
+    if( wxGetMouseState().ShiftDown( ) )
+        step = ROTATION_INCREMENT_FINE;
+
     double curr_value = EDA_UNIT_UTILS::UI::DoubleValueFromString( unityScale, EDA_UNITS::DEGREES,
                                                                    textCtrl->GetValue() );
 
-    curr_value += ( ROTATION_INCREMENT * aSign );
+    curr_value += ( step * aSign );
     curr_value = std::max( -MAX_ROTATION, curr_value );
     curr_value = std::min( curr_value, MAX_ROTATION );
 
@@ -488,16 +497,22 @@ void PANEL_PREVIEW_3D_MODEL::doIncrementOffset( wxSpinEvent& event, double aSign
         textCtrl = zoff;
 
     double step_mm = OFFSET_INCREMENT_MM;
-    double curr_value_mm =
-            EDA_UNIT_UTILS::UI::DoubleValueFromString( pcbIUScale, m_userUnits,
-                                                       textCtrl->GetValue() )
-            / pcbIUScale.IU_PER_MM;
+
+    if( wxGetMouseState().ShiftDown( ) )
+        step_mm = OFFSET_INCREMENT_MM_FINE;
 
     if( m_userUnits == EDA_UNITS::MILS || m_userUnits == EDA_UNITS::INCHES )
     {
         step_mm = 25.4*OFFSET_INCREMENT_MIL/1000;
+
+        if( wxGetMouseState().ShiftDown( ) )
+            step_mm = 25.4*OFFSET_INCREMENT_MIL_FINE/1000;;
     }
 
+    double curr_value_mm = EDA_UNIT_UTILS::UI::DoubleValueFromString( pcbIUScale, m_userUnits,
+                                                                      textCtrl->GetValue() )
+                           / pcbIUScale.IU_PER_MM;
+
     curr_value_mm += ( step_mm * aSign );
     curr_value_mm = std::max( -MAX_OFFSET, curr_value_mm );
     curr_value_mm = std::min( curr_value_mm, MAX_OFFSET );
@@ -533,10 +548,10 @@ void PANEL_PREVIEW_3D_MODEL::onMouseWheelRot( wxMouseEvent& event )
 {
     wxTextCtrl* textCtrl = (wxTextCtrl*) event.GetEventObject();
 
-    double step = ROTATION_INCREMENT_WHEEL;
+    double step = ROTATION_INCREMENT;
 
     if( event.ShiftDown( ) )
-        step = ROTATION_INCREMENT_WHEEL_FINE;
+        step = ROTATION_INCREMENT_FINE;
 
     if( event.GetWheelRotation() >= 0 )
         step = -step;
@@ -607,6 +622,17 @@ 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();
@@ -622,3 +648,10 @@ void PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint( bool aReloadRequired )
 
     m_previewPane->Request_refresh();
 }
+
+
+void PANEL_PREVIEW_3D_MODEL::onModify()
+{
+    if( DIALOG_SHIM* dlg = dynamic_cast<DIALOG_SHIM*>( wxGetTopLevelParent( this ) ) )
+        dlg->OnModify();
+}

3d-viewer/dialogs/panel_preview_3d_model.h

@@ -34,6 +34,7 @@
 #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
@@ -43,9 +44,8 @@
 #define SCALE_INCREMENT_FINE       0.02
 #define SCALE_INCREMENT            0.1
 
-#define ROTATION_INCREMENT 90            // in degrees, for spin button command
-#define ROTATION_INCREMENT_WHEEL 90      // in degrees, for mouse wheel command
-#define ROTATION_INCREMENT_WHEEL_FINE 1  // in degrees, for mouse wheel command
+#define ROTATION_INCREMENT 90      // in degrees
+#define ROTATION_INCREMENT_FINE 1  // in degrees
 
 #define OFFSET_INCREMENT_MM        0.5
 #define OFFSET_INCREMENT_MM_FINE   0.1
@@ -53,6 +53,7 @@
 #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;
@@ -61,6 +62,7 @@ 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
 {
@@ -93,6 +95,12 @@ public:
      */
     void UpdateDummyFootprint( bool aRelaodRequired = true );
 
+    /**
+     * Get the dummy footprint that is used for previewing the 3D model.
+     * We use this to hold the temporary 3D model shapes.
+     */
+    FOOTPRINT* GetDummyFootprint() const { return m_dummyFootprint; }
+
 private:
     /**
      * Load 3D relevant settings from the user configuration
@@ -140,6 +148,7 @@ private:
     void doIncrementOffset( wxSpinEvent& aEvent, double aSign );
 
     void onUnitsChanged( wxCommandEvent& aEvent );
+    void onPanelShownEvent( wxCommandEvent& aEvent );
 
     wxString formatScaleValue( double aValue );
     wxString formatRotationValue( double aValue );
@@ -194,6 +203,8 @@ private:
         m_previewPane->SetView3D( VIEW3D_TYPE::VIEW3D_BOTTOM );
     }
 
+    void onModify();
+
 private:
     PCB_BASE_FRAME*          m_parentFrame;
     EDA_3D_CANVAS*           m_previewPane;
@@ -212,6 +223,8 @@ 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 )
@@ -106,10 +111,9 @@ option( KICAD_SCRIPTING_WXPYTHON
     ON )
 mark_as_advanced( KICAD_SCRIPTING_WXPYTHON )
 
-cmake_dependent_option( KICAD_UPDATE_CHECK
+option( KICAD_UPDATE_CHECK
     "Build in update check"
-    ON "APPLE_OR_WIN32"
-    OFF )
+    ON )
 
 # EGL is only needed on Linux with Wayland
 cmake_dependent_option( KICAD_USE_EGL
@@ -161,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
 ####################################
@@ -210,6 +225,11 @@ cmake_dependent_option( KICAD_WIN32_BUILD_PARALLEL_CL_MP
     OFF "WIN32"
     OFF )
 
+cmake_dependent_option( KICAD_WIN32_LTCG
+    "Enable Whole Program Optimization"
+    OFF "WIN32"
+    OFF )
+
 # Advanced option to make link maps (only available on linux)
 cmake_dependent_option( KICAD_MAKE_LINK_MAPS
     "Create link maps for artifacts"
@@ -243,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 )
@@ -250,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)
 
@@ -274,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> )
 
@@ -327,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)
@@ -348,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.")
@@ -430,7 +458,7 @@ if( CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang" )
 
     if( KICAD_SANITIZE_ADDRESS )
         add_compile_definitions( KICAD_SANITIZE_ADDRESS )
-        set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_GLIBCXX_SANITIZE_VECTOR -fsanitize=address -fno-optimize-sibling-calls -fsanitize-address-use-after-scope -fno-omit-frame-pointer" )
+        set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_GLIBCXX_SANITIZE_VECTOR -fsanitize=address -fsanitize-recover=address -fno-optimize-sibling-calls -fsanitize-address-use-after-scope -fno-omit-frame-pointer" )
 
         # ASAN shouldn't be used with these options (https://github.com/google/sanitizers/wiki/AddressSanitizer#faq)
         set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-stack-protector -U_FORTIFY_SOURCE" )
@@ -508,8 +536,20 @@ 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
     string( APPEND CMAKE_CXX_FLAGS_RELEASE " /GF" )
     string( APPEND CMAKE_CXX_FLAGS_RELWITHDEBINFO " /GF" )
@@ -540,6 +580,12 @@ if( MSVC )
         string( APPEND CMAKE_CXX_FLAGS " /fsanitize=address" )
     endif()
 
+    if( KICAD_WIN32_LTCG )
+        # we are implementing this manually because CMake's LTCG option is incomplete
+        # https://gitlab.kitware.com/cmake/cmake/-/issues/20484
+        string( APPEND CMAKE_CXX_FLAGS_RELEASE " /GL" )
+    endif()
+
     foreach( type EXE SHARED MODULE)
         # /DEBUG: create PDB
         string( APPEND CMAKE_${type}_LINKER_FLAGS " /DEBUG /MANIFEST:NO" )
@@ -549,6 +595,12 @@ if( MSVC )
         # /OPT:ICF: fold common data
         string( APPEND CMAKE_${type}_LINKER_FLAGS_RELEASE " /OPT:ICF /MANIFEST:NO" )
         string( APPEND CMAKE_${type}_LINKER_FLAGS_RELWITHDEBINFO " /OPT:ICF /MANIFEST:NO" )
+
+        if( KICAD_WIN32_LTCG )
+            # we are implementing this manually because CMake's LTCG option is incomplete
+            # https://gitlab.kitware.com/cmake/cmake/-/issues/20484
+            string( APPEND CMAKE_${type}_LINKER_FLAGS_RELEASE " /LTCG" )
+        endif()
     endforeach()
 
     # Let cl.exe parallelize builds
@@ -757,6 +809,11 @@ include_directories( SYSTEM ${GLM_INCLUDE_DIR} )
 #
 find_package(ZLIB REQUIRED)
 
+#
+# Find Zstd library, required
+#
+find_package(ZSTD REQUIRED)
+
 #
 # Find libcurl, required
 #
@@ -824,6 +881,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.
@@ -860,7 +938,14 @@ check_find_package_result( PYTHONINTERP_FOUND "Python Interpreter" )
 # Get the correct Python site package install path from the Python interpreter found by
 # FindPythonInterp unless the user specifically defined a custom path.
 if( NOT PYTHON_SITE_PACKAGE_PATH )
-    execute_process( COMMAND ${PYTHON_EXECUTABLE} -c "import sysconfig;print(\"%s\"%sysconfig.get_path('platlib', vars={'platbase': '.'}))"
+    execute_process( COMMAND ${PYTHON_EXECUTABLE} -c "import sys, sysconfig
+if 'deb_system' in sysconfig.get_scheme_names():
+    scheme = 'deb_system'
+elif sys.version_info > (3, 10):
+    scheme = sysconfig.get_default_scheme()
+else:
+    scheme = sysconfig._get_default_scheme()
+print(\"%s\"%sysconfig.get_path('platlib', vars={'platbase': '.'}, scheme=scheme))"
         OUTPUT_VARIABLE PYTHON_SITE_PACKAGE_PATH
         OUTPUT_STRIP_TRAILING_WHITESPACE
         )
@@ -978,6 +1063,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" )
@@ -1026,6 +1130,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
 #================================================
@@ -1064,6 +1172,7 @@ list( APPEND CMAKE_CTEST_ARGUMENTS "--output-on-failure" )
 #================================================
 
 # Binaries ( CMake targets )
+add_subdirectory( api )
 add_subdirectory( resources )
 add_subdirectory( thirdparty )
 add_subdirectory( libs )
@@ -1078,7 +1187,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"
+      }
+    }
+  ]
+}

CMakeSettings.json.sample

@@ -1,4 +1,4 @@
-{
+{
   "environments": [
     {
       "BuildDir": "${workspaceRoot}\\build",
@@ -7,67 +7,9 @@
     {
       "environment": "vcpkg",
       "VcPkgDir": "D:/vcpkg/"
-    },
-    {
-      "environment": "mingw_64",
-      "MINGW64_ROOT": "D:/msys64/mingw64",
-      "BIN_ROOT": "${env.MINGW64_ROOT}/bin",
-      "FLAVOR": "x86_64-w64-mingw32",
-      "TOOLSET_VERSION": "10.2.0",
-      "PATH": "${env.MINGW64_ROOT}/bin;${env.MINGW64_ROOT}/../usr/local/bin;${env.MINGW64_ROOT}/../usr/bin;${env.MINGW64_ROOT}/../bin;${env.PATH}",
-      "INCLUDE": "${env.INCLUDE};${env.MINGW64_ROOT}/include/c++/${env.TOOLSET_VERSION};${env.MINGW64_ROOT}/include/c++/${env.TOOLSET_VERSION}/tr1;${env.MINGW64_ROOT}/include/c++/${env.TOOLSET_VERSION}/${env.FLAVOR}"
     }
   ],
   "configurations": [
-    {
-      "name": "x86-Debug",
-      "generator": "Ninja",
-      "configurationType": "Debug",
-      "inheritEnvironments": [ "msvc_x86", "vcpkg" ],
-      "buildRoot": "${env.BuildDir}\\${name}",
-      "installRoot": "${env.InstallDir}\\${name}",
-      "addressSanitizerEnabled": false,
-      "cmakeCommandArgs": "",
-      "buildCommandArgs": "-v",
-      "ctestCommandArgs": "",
-      "variables": [
-        {
-          "name": "KICAD_BUILD_QA_TESTS",
-          "value": "False",
-          "type": "BOOL"
-        },
-        {
-          "name": "KICAD_WIN32_DPI_AWARE",
-          "value": "ON",
-          "type": "BOOL"
-        }
-      ],
-      "cmakeToolchain": "${env.VcPkgDir}/scripts/buildsystems/vcpkg.cmake"
-    },
-    {
-      "name": "x86-Release",
-      "generator": "Ninja",
-      "configurationType": "RelWithDebInfo",
-      "inheritEnvironments": [ "msvc_x86", "vcpkg" ],
-      "buildRoot": "${env.BuildDir}\\${name}",
-      "installRoot": "${env.InstallDir}\\${name}",
-      "cmakeCommandArgs": "",
-      "buildCommandArgs": "-v",
-      "ctestCommandArgs": "",
-      "variables": [
-        {
-          "name": "KICAD_BUILD_QA_TESTS",
-          "value": "False",
-          "type": "BOOL"
-        },
-        {
-          "name": "KICAD_WIN32_DPI_AWARE",
-          "value": "ON",
-          "type": "BOOL"
-        }
-      ],
-      "cmakeToolchain": "${env.VcPkgDir}/scripts/buildsystems/vcpkg.cmake"
-    },
     {
       "name": "x64-Debug",
       "generator": "Ninja",
@@ -115,39 +57,6 @@
         }
       ],
       "cmakeToolchain": "${env.VcPkgDir}/scripts/buildsystems/vcpkg.cmake"
-    },
-    {
-      "name": "MSYS2-x64-Debug",
-      "generator": "Ninja",
-      "configurationType": "Debug",
-      "inheritEnvironments": [ "mingw_64" ],
-      "buildRoot": "${env.BuildDir}\\${name}",
-      "installRoot": "${env.InstallDir}\\${name}",
-      "cmakeCommandArgs": "",
-      "buildCommandArgs": "-v",
-      "ctestCommandArgs": "",
-      "intelliSenseMode": "linux-gcc-x64",
-      "cmakeToolchain": "",
-      "variables": [
-        {
-          "name": "CMAKE_C_COMPILER",
-          "value": "${env.BIN_ROOT}/gcc.exe"
-        },
-        {
-          "name": "CMAKE_CXX_COMPILER",
-          "value": "${env.BIN_ROOT}/g++.exe"
-        },
-        {
-          "name": "KICAD_BUILD_QA_TESTS",
-          "value": "False",
-          "type": "BOOL"
-        },
-        {
-          "name": "KICAD_WIN32_DPI_AWARE",
-          "value": "ON",
-          "type": "BOOL"
-        }
-      ]
     }
   ]
 }

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,560 @@
+/*
+ * 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;
+}
+
+// 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 ZoneConnectionSettings
+{
+  ZoneConnectionStyle zone_connection = 1;
+
+  ThermalSpokeSettings thermal_spokes = 2;
+}
+
+message SolderMaskOverrides
+{
+  // Solder mask expansion/contraction
+  kiapi.common.types.Distance solder_mask_margin = 1;
+}
+
+message SolderPasteOverrides
+{
+  // Solder paste expansion/contraction
+  kiapi.common.types.Distance solder_paste_margin = 1;
+
+  // Solder paste expansion/contraction ratio
+  kiapi.common.types.Ratio solder_paste_margin_ratio = 2;
+}
+
+// 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;
+
+  ZoneConnectionSettings zone_settings = 9;
+}
+
+enum SolderMaskMode
+{
+  SMM_UNKOWN = 0;
+  SMM_MASKED = 1;
+  SMM_UNMASKED = 2;
+  SMM_FROM_DESIGN_RULES = 3;
+}
+
+enum SolderPasteMode
+{
+  SPM_UNKOWN = 0;
+  SPM_PASTE = 1;
+  SPM_NO_PASTE = 2;
+  SPM_FROM_DESIGN_RULES = 3;
+}
+
+// Properties for the outer technical layers of a padstack on the top or bottom of the stack
+message PadStackOuterLayer
+{
+  SolderMaskMode solder_mask_mode = 1;
+  SolderPasteMode solder_paste_mode = 2;
+  SolderMaskOverrides solder_mask_settings = 3;
+  SolderPasteOverrides solder_paste_settings = 4;
+}
+
+// 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;
+
+  // Solder mask and paste settings for the front
+  PadStackOuterLayer front_outer_layers = 8;
+
+  // Solder mask and paste settings for the back
+  PadStackOuterLayer back_outer_layers = 9;
+}
+
+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;
+
+  // Copper-to-copper clearance override
+  kiapi.common.types.Distance copper_clearance_override = 8;
+}
+
+// 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;
+}
+
+message NetTieDefinition
+{
+  repeated string pad_number = 1;
+}
+
+message FootprintDesignRuleOverrides
+{
+  SolderMaskOverrides solder_mask = 1;
+  SolderPasteOverrides solder_paste = 2;
+  kiapi.common.types.Distance copper_clearance = 3;
+  ZoneConnectionStyle zone_connection = 4;
+}
+
+// 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;
+  FootprintDesignRuleOverrides         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;
+  FootprintDesignRuleOverrides overrides  = 12;
+}

api/proto/common/commands/base_commands.proto

@@ -0,0 +1,38 @@
+/*
+ * 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.commands;
+
+import "common/types/base_types.proto";
+
+message GetVersion
+{
+}
+
+message GetVersionResponse
+{
+  kiapi.common.types.KiCadVersion version = 1;
+}
+
+// A command to check if the connection to KiCad is OK
+message Ping
+{
+}

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

@@ -0,0 +1,34 @@
+/*
+ * 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.commands;
+
+import "common/types/project_settings.proto";
+
+
+message GetNetClasses
+{
+}
+
+message NetClassesResponse
+{
+  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;
+
+