panel_fp_properties_3d_model.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2010-2015 Jean-Pierre Charras, jean-pierre.charras at wanadoo.fr
 * 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 <footprint.h>
#include <panel_fp_properties_3d_model_base.h>
#include <vector>
 
#include "widgets/wx_grid.h"
 
class DIALOG_SHIM;
class PANEL_EMBEDDED_FILES;
class PANEL_PREVIEW_3D_MODEL;
class PCB_BASE_EDIT_FRAME;
class wxBookCtrlEvent;
 
enum class MODEL_VALIDATE_ERRORS
{
    MODEL_NO_ERROR,
    RESOLVE_FAIL,
    OPEN_FAIL,
    NO_FILENAME,
    ILLEGAL_FILENAME
};
 
class PANEL_FP_PROPERTIES_3D_MODEL : public PANEL_FP_PROPERTIES_3D_MODEL_BASE
{
 
public:
    PANEL_FP_PROPERTIES_3D_MODEL( PCB_BASE_EDIT_FRAME* aFrame, FOOTPRINT* aFootprint,
                                  DIALOG_SHIM* aDialogParent, PANEL_EMBEDDED_FILES* aFilesPanel,
                                  wxWindow* aParent );
 
    ~PANEL_FP_PROPERTIES_3D_MODEL() override;
 
    bool TransferDataToWindow() override;
    bool TransferDataFromWindow() override;
 
    bool Validate() override;
    bool CommitPendingChanges();
 
    void ReloadModelsFromFootprint();
 
    std::vector<FP_3DMODEL>& GetModelList() { return m_shapes3D_list; }
 
private:
    // virtual event functions
    void On3DModelSelected( wxGridEvent&  ) override;
    void on3DModelCellChanging( wxGridEvent& aEvent );
    void On3DModelCellChanged( wxGridEvent& aEvent ) override;
    void OnRemove3DModel( wxCommandEvent& event ) override;
    void OnAdd3DModel( wxCommandEvent& event ) override;
    void OnAdd3DRow( wxCommandEvent& event ) override;
    void Cfg3DPath( wxCommandEvent& event ) override;
 
    void OnUpdateUI( wxUpdateUIEvent& event ) override;
    void OnEnableExtrusion( wxCommandEvent& event ) override;
    void OnExportExtrudedModel( wxCommandEvent& event ) override;
    void onExtrusionControlChanged( wxCommandEvent& event );
    void onExtrusionColorChanged( wxCommandEvent& event );
    void onExtrusionMaterialChanged( wxCommandEvent& event );
 
    void updateExtrusionControls();
    void updateExtrusionPreview();
    bool readExtrusionHeights( const wxString& aTitle, double& aHeight, double& aStandoff );
    void updateValidateStatus( int aRow );
    void cleanupFilename( wxString* aFilename );
    bool pick3DModel( const wxString& aCurrentValue, FP_3DMODEL& aModel );
    void set3DModelRow( int aRow, const FP_3DMODEL& aModel );
    void updateConfiguredPathChoices();
 
    MODEL_VALIDATE_ERRORS validateModelExists( const wxString& aFilename );
 
    void select3DModel( int aModelIdx );
 
    void onModify();
 
    virtual void onDialogActivateEvent( wxActivateEvent& aEvent );
    virtual void onShowEvent( wxShowEvent& aEvent );
    void onSize( wxSizeEvent& aEvent );

    void setDefaultSashPosition();
    void onNotebookPageChanged( wxBookCtrlEvent& aEvent );
 
    // Wrapper on creating and posting custom event
    void postCustomPanelShownEventWithPredicate( bool predicate );
 
private:
    DIALOG_SHIM*              m_parentDialog;
    PCB_BASE_EDIT_FRAME*      m_frame;
    FOOTPRINT*                m_footprint;
 
    std::vector<FP_3DMODEL>   m_shapes3D_list;
    bool                      m_sashPositioned = false;
    PANEL_PREVIEW_3D_MODEL*   m_previewPane;
    PANEL_EMBEDDED_FILES*     m_filesPanel;
 
    bool                      m_inSelect;
    bool                      m_userSetExtrusionColor;
    std::vector<PCB_LAYER_ID> m_extrusionLayers;
};