dialog_migrate_3d_models.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <set>
#include <vector>
#include <wx/string.h>
#include <wx/listctrl.h>
 
#include <dialogs/dialog_migrate_3d_models_base.h>
#include <3d_canvas/board_adapter.h>
#include <3d_rendering/track_ball.h>
#include <math/vector3.h>
 
class PCB_EDIT_FRAME;
class BOARD;
class FOOTPRINT;
class EDA_3D_CANVAS;
 

class DIALOG_MIGRATE_3D_MODELS : public DIALOG_MIGRATE_3D_MODELS_BASE
{
public:
    DIALOG_MIGRATE_3D_MODELS( PCB_EDIT_FRAME* aFrame );
    ~DIALOG_MIGRATE_3D_MODELS() override;

    bool HasMissingModels() const { return !m_missing.empty(); }

    static bool BoardHasUnresolvedWrlReferences( PCB_EDIT_FRAME* aFrame );

    static int CountUnresolvedWrlReferences( PCB_EDIT_FRAME* aFrame );

    static int AutoMigrateByFilename( PCB_EDIT_FRAME* aFrame );
 
    bool TransferDataToWindow() override;
 
protected:
    void OnMissingSelected( wxListEvent& event ) override;
    void OnCandidateSelected( wxListEvent& event ) override;
    void OnAddSearchDirectoryClick( wxCommandEvent& event ) override;
    void OnRemoveSearchDirectoryClick( wxCommandEvent& event ) override;
    void OnOpenExternalFileClick( wxCommandEvent& event ) override;
    void OnReplaceClick( wxCommandEvent& event ) override;
    void OnKeepClick( wxCommandEvent& event ) override;
 
private:
    struct CATALOG_ENTRY
    {
        wxString m_absPath;  
        wxString m_stem;     
        wxString m_parent;   
    };

    struct MATCH_CANDIDATE
    {
        wxString m_absPath;  
        wxString m_display;  
        int      m_score;    
    };
 
    void updateAfterCatalogChange();
    void buildCatalog();
    void scanDirectory( const wxString& aDir );
    void populateMissingList();
    void rankAllCandidates();
    std::vector<MATCH_CANDIDATE> rankCandidatesFor( const wxString& aWrlFilename ) const;

    void initPreviewBoard();

    void showPreview( int aMissingIndex, const wxString& aCandAbsPath );
    void populateCandidatesList( int aMissingIndex );

    void updateMissingItemStyle( int aMissingIndex );

    struct MISSING_XFORM
    {
        VECTOR3D m_scale    { 1, 1, 1 };
        VECTOR3D m_rotation { 0, 0, 0 };
        VECTOR3D m_offset   { 0, 0, 0 };
        double   m_opacity  = 1.0;
    };
 
    struct ENTRY
    {
        const FOOTPRINT* m_fp = nullptr;
        MISSING_XFORM    m_xform;
    };
 
    // Accumulate into a map keyed by WRL filename so we can sort afterwards
    // while still tracking the representative footprint and transform captured
    // from the first FP_3DMODEL that referenced it.
    static std::map<wxString, ENTRY> collectMissingWrlModels( PCB_EDIT_FRAME* aFrame );
 
private:
    PCB_EDIT_FRAME*              m_frame;

    BOARD*                       m_dummyBoard;
    FOOTPRINT*                   m_dummyFootprint;   
    BOARD_ADAPTER                m_boardAdapter;
    TRACK_BALL                   m_trackBallCamera;
    EDA_3D_CANVAS*               m_previewPane;

    std::vector<wxString>                        m_missing;
    std::vector<MISSING_XFORM>                   m_missingXform;
    std::vector<const FOOTPRINT*>                m_missingRepFp;
    std::vector<std::vector<MATCH_CANDIDATE>>          m_candidatesPerMissing;
    std::vector<int>                             m_selectedPerMissing;

    std::vector<CATALOG_ENTRY>                   m_catalog;
    std::set<wxString>                           m_scannedDirs;
};