KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
PANEL_FP_PROPERTIES_3D_MODEL Class Reference

#include <panel_fp_properties_3d_model.h>

Inheritance diagram for PANEL_FP_PROPERTIES_3D_MODEL:
PANEL_FP_PROPERTIES_3D_MODEL_BASE

Public Member Functions

 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
 
void ReloadModelsFromFootprint ()
 
std::vector< FP_3DMODEL > & GetModelList ()
 
void m_splitter1OnIdle (wxIdleEvent &)
 

Protected Attributes

wxBoxSizer * bSizerMain3D
 
wxSplitterWindow * m_splitter1
 
wxPanel * m_upperPanel
 
WX_GRID * m_modelsGrid
 
STD_BITMAP_BUTTON * m_button3DShapeAdd
 
STD_BITMAP_BUTTON * m_button3DShapeBrowse
 
STD_BITMAP_BUTTON * m_button3DShapeRemove
 
wxButton * m_buttonConfig3DPaths
 
wxPanel * m_lowerPanel
 
wxBoxSizer * m_LowerSizer3D
 

Private Member Functions

void On3DModelSelected (wxGridEvent &) override
 
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 updateValidateStatus (int aRow)
 
MODEL_VALIDATE_ERRORS validateModelExists (const wxString &aFilename)
 
void select3DModel (int aModelIdx)
 
void onModify ()
 
virtual void onDialogActivateEvent (wxActivateEvent &aEvent)
 
virtual void onShowEvent (wxShowEvent &aEvent)
 
void postCustomPanelShownEventWithPredicate (bool predicate)
 

Private Attributes

DIALOG_SHIM * m_parentDialog
 
PCB_BASE_EDIT_FRAME * m_frame
 
FOOTPRINT * m_footprint
 
std::vector< FP_3DMODEL > m_shapes3D_list
 
PANEL_PREVIEW_3D_MODEL * m_previewPane
 
PANEL_EMBEDDED_FILES * m_filesPanel
 
bool m_inSelect
 

Detailed Description

Definition at line 45 of file panel_fp_properties_3d_model.h.

Constructor & Destructor Documentation

◆ PANEL_FP_PROPERTIES_3D_MODEL()

PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL ( PCB_BASE_EDIT_FRAME * aFrame,
FOOTPRINT * aFootprint,
DIALOG_SHIM * aDialogParent,
PANEL_EMBEDDED_FILES * aFilesPanel,
wxWindow * aParent )

Definition at line 65 of file panel_fp_properties_3d_model.cpp.

References COL_FILENAME, COL_PROBLEM, GetAppSettings(), ENV_VAR::GetVersionedEnvVarName(), m_filesPanel, m_footprint, m_frame, m_inSelect, PCBNEW_SETTINGS::m_LastFootprint3dDir, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid, m_parentDialog, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_splitter1, OnAdd3DRow(), PANEL_FP_PROPERTIES_3D_MODEL_BASE::PANEL_FP_PROPERTIES_3D_MODEL_BASE(), result, and GRID_TRICKS::SetTooltipEnable().

◆ ~PANEL_FP_PROPERTIES_3D_MODEL()

PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL ( )
override

Definition at line 152 of file panel_fp_properties_3d_model.cpp.

References S3D_CACHE::FlushCache(), PROJECT_PCB::Get3DCacheManager(), m_frame, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid, m_previewPane, and onShowEvent().

Member Function Documentation

◆ Cfg3DPath()

void PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath ( wxCommandEvent & event)
overrideprivatevirtual

Reimplemented from PANEL_FP_PROPERTIES_3D_MODEL_BASE.

Definition at line 606 of file panel_fp_properties_3d_model.cpp.

References m_previewPane, and DIALOG_SHIM::ShowQuasiModal().

◆ GetModelList()

std::vector< FP_3DMODEL > & PANEL_FP_PROPERTIES_3D_MODEL::GetModelList ( )
inline

Definition at line 60 of file panel_fp_properties_3d_model.h.

References m_shapes3D_list.

◆ m_splitter1OnIdle()

void PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_splitter1OnIdle ( wxIdleEvent & )
inlineinherited

Definition at line 68 of file panel_fp_properties_3d_model_base.h.

References m_splitter1, and m_splitter1OnIdle().

Referenced by m_splitter1OnIdle(), and PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ On3DModelCellChanged()

void PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged ( wxGridEvent & aEvent)
overrideprivatevirtual

Reimplemented from PANEL_FP_PROPERTIES_3D_MODEL_BASE.

Definition at line 248 of file panel_fp_properties_3d_model.cpp.

References COL_FILENAME, COL_SHOWN, PROJECT_PCB::Get3DCacheManager(), S3D_CACHE::GetResolver(), m_frame, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid, m_previewPane, m_shapes3D_list, onModify(), res, and updateValidateStatus().

◆ On3DModelSelected()

void PANEL_FP_PROPERTIES_3D_MODEL::On3DModelSelected ( wxGridEvent & aEvent)
overrideprivatevirtual

Reimplemented from PANEL_FP_PROPERTIES_3D_MODEL_BASE.

Definition at line 241 of file panel_fp_properties_3d_model.cpp.

References m_inSelect, and select3DModel().

◆ OnAdd3DModel()

void PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel ( wxCommandEvent & event)
overrideprivatevirtual

Reimplemented from PANEL_FP_PROPERTIES_3D_MODEL_BASE.

Definition at line 369 of file panel_fp_properties_3d_model.cpp.

References _, COL_FILENAME, COL_SHOWN, filter, FP_LIB_TABLE::FindRow(), PROJECT_PCB::Get3DCacheManager(), LIB_TABLE_ROW::GetFullURI(), PROJECT::GetProjectPath(), S3D_CACHE::GetResolver(), PROJECT::GetRString(), ENV_VAR::GetVersionedEnvVarName(), DIALOG_SELECT_3DMODEL::IsEmbedded3DModel(), FP_3DMODEL::m_Filename, m_filesPanel, m_footprint, m_frame, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid, m_parentDialog, m_previewPane, m_shapes3D_list, FP_3DMODEL::m_Show, onModify(), PROJECT_PCB::PcbFootprintLibs(), res, result, select3DModel(), PROJECT::SetRString(), DIALOG_SHIM::ShowQuasiModal(), updateValidateStatus(), PROJECT::VIEWER_3D_FILTER_INDEX, and PROJECT::VIEWER_3D_PATH.

◆ OnAdd3DRow()

void PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DRow ( wxCommandEvent & event)
overrideprivatevirtual

Reimplemented from PANEL_FP_PROPERTIES_3D_MODEL_BASE.

Definition at line 492 of file panel_fp_properties_3d_model.cpp.

References COL_FILENAME, COL_PROBLEM, COL_SHOWN, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid, m_shapes3D_list, FP_3DMODEL::m_Show, onModify(), select3DModel(), and updateValidateStatus().

Referenced by PANEL_FP_PROPERTIES_3D_MODEL().

◆ onDialogActivateEvent()

void PANEL_FP_PROPERTIES_3D_MODEL::onDialogActivateEvent ( wxActivateEvent & aEvent)
privatevirtual

Definition at line 635 of file panel_fp_properties_3d_model.cpp.

References m_previewPane, and postCustomPanelShownEventWithPredicate().

◆ onModify()

void PANEL_FP_PROPERTIES_3D_MODEL::onModify ( )
private

Definition at line 621 of file panel_fp_properties_3d_model.cpp.

Referenced by On3DModelCellChanged(), OnAdd3DModel(), OnAdd3DRow(), and OnRemove3DModel().

◆ OnRemove3DModel()

void PANEL_FP_PROPERTIES_3D_MODEL::OnRemove3DModel ( wxCommandEvent & event)
overrideprivatevirtual

Reimplemented from PANEL_FP_PROPERTIES_3D_MODEL_BASE.

Definition at line 296 of file panel_fp_properties_3d_model.cpp.

References m_filesPanel, m_inSelect, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid, m_previewPane, m_shapes3D_list, onModify(), and select3DModel().

◆ onShowEvent()

void PANEL_FP_PROPERTIES_3D_MODEL::onShowEvent ( wxShowEvent & aEvent)
privatevirtual

Definition at line 628 of file panel_fp_properties_3d_model.cpp.

References postCustomPanelShownEventWithPredicate().

Referenced by ~PANEL_FP_PROPERTIES_3D_MODEL().

◆ OnUpdateUI()

void PANEL_FP_PROPERTIES_3D_MODEL::OnUpdateUI ( wxUpdateUIEvent & event)
overrideprivatevirtual

Reimplemented from PANEL_FP_PROPERTIES_3D_MODEL_BASE.

Definition at line 615 of file panel_fp_properties_3d_model.cpp.

References PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_button3DShapeRemove, and PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid.

◆ postCustomPanelShownEventWithPredicate()

void PANEL_FP_PROPERTIES_3D_MODEL::postCustomPanelShownEventWithPredicate ( bool predicate)
private

Definition at line 642 of file panel_fp_properties_3d_model.cpp.

References m_previewPane.

Referenced by onDialogActivateEvent(), and onShowEvent().

◆ ReloadModelsFromFootprint()

void PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint ( )

Definition at line 181 of file panel_fp_properties_3d_model.cpp.

References COL_FILENAME, COL_SHOWN, PROJECT_PCB::Get3DCacheManager(), S3D_CACHE::GetResolver(), ENV_VAR::GetVersionedEnvVarName(), m_footprint, m_frame, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid, m_previewPane, m_shapes3D_list, res, select3DModel(), and updateValidateStatus().

Referenced by TransferDataToWindow().

◆ select3DModel()

void PANEL_FP_PROPERTIES_3D_MODEL::select3DModel ( int aModelIdx)
private

Definition at line 222 of file panel_fp_properties_3d_model.cpp.

References COL_FILENAME, m_inSelect, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid, and m_previewPane.

Referenced by On3DModelSelected(), OnAdd3DModel(), OnAdd3DRow(), OnRemove3DModel(), and ReloadModelsFromFootprint().

◆ TransferDataFromWindow()

bool PANEL_FP_PROPERTIES_3D_MODEL::TransferDataFromWindow ( )
override

Definition at line 175 of file panel_fp_properties_3d_model.cpp.

References PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid.

◆ TransferDataToWindow()

bool PANEL_FP_PROPERTIES_3D_MODEL::TransferDataToWindow ( )
override

Definition at line 168 of file panel_fp_properties_3d_model.cpp.

References ReloadModelsFromFootprint().

◆ updateValidateStatus()

void PANEL_FP_PROPERTIES_3D_MODEL::updateValidateStatus ( int aRow)
private

Definition at line 516 of file panel_fp_properties_3d_model.cpp.

References _, COL_FILENAME, COL_PROBLEM, ILLEGAL_FILENAME, PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid, MODEL_NO_ERROR, NO_FILENAME, OPEN_FAIL, RESOLVE_FAIL, and validateModelExists().

Referenced by On3DModelCellChanged(), OnAdd3DModel(), OnAdd3DRow(), and ReloadModelsFromFootprint().

◆ validateModelExists()

MODEL_VALIDATE_ERRORS PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists ( const wxString & aFilename)
private

Definition at line 559 of file panel_fp_properties_3d_model.cpp.

References FP_LIB_TABLE::FindRow(), PROJECT_PCB::Get3DFilenameResolver(), LIB_TABLE_ROW::GetFullURI(), ILLEGAL_FILENAME, m_filesPanel, m_footprint, m_frame, MODEL_NO_ERROR, NO_FILENAME, OPEN_FAIL, PROJECT_PCB::PcbFootprintLibs(), RESOLVE_FAIL, FILENAME_RESOLVER::ResolvePath(), and FILENAME_RESOLVER::ValidateFileName().

Referenced by updateValidateStatus().

Member Data Documentation

◆ bSizerMain3D

wxBoxSizer* PANEL_FP_PROPERTIES_3D_MODEL_BASE::bSizerMain3D
protectedinherited

Definition at line 41 of file panel_fp_properties_3d_model_base.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ m_button3DShapeAdd

STD_BITMAP_BUTTON* PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_button3DShapeAdd
protectedinherited

Definition at line 45 of file panel_fp_properties_3d_model_base.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL_BASE(), and ~PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ m_button3DShapeBrowse

STD_BITMAP_BUTTON* PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_button3DShapeBrowse
protectedinherited

Definition at line 46 of file panel_fp_properties_3d_model_base.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL_BASE(), and ~PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ m_button3DShapeRemove

STD_BITMAP_BUTTON* PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_button3DShapeRemove
protectedinherited

Definition at line 47 of file panel_fp_properties_3d_model_base.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::OnUpdateUI(), PANEL_FP_PROPERTIES_3D_MODEL_BASE(), and ~PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ m_buttonConfig3DPaths

wxButton* PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_buttonConfig3DPaths
protectedinherited

Definition at line 48 of file panel_fp_properties_3d_model_base.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL_BASE(), and ~PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ m_filesPanel

PANEL_EMBEDDED_FILES* PANEL_FP_PROPERTIES_3D_MODEL::m_filesPanel
private

Definition at line 94 of file panel_fp_properties_3d_model.h.

Referenced by OnAdd3DModel(), OnRemove3DModel(), PANEL_FP_PROPERTIES_3D_MODEL(), and validateModelExists().

◆ m_footprint

FOOTPRINT* PANEL_FP_PROPERTIES_3D_MODEL::m_footprint
private

Definition at line 90 of file panel_fp_properties_3d_model.h.

Referenced by OnAdd3DModel(), PANEL_FP_PROPERTIES_3D_MODEL(), ReloadModelsFromFootprint(), and validateModelExists().

◆ m_frame

PCB_BASE_EDIT_FRAME* PANEL_FP_PROPERTIES_3D_MODEL::m_frame
private

Definition at line 89 of file panel_fp_properties_3d_model.h.

Referenced by On3DModelCellChanged(), OnAdd3DModel(), PANEL_FP_PROPERTIES_3D_MODEL(), ReloadModelsFromFootprint(), validateModelExists(), and ~PANEL_FP_PROPERTIES_3D_MODEL().

◆ m_inSelect

bool PANEL_FP_PROPERTIES_3D_MODEL::m_inSelect
private

Definition at line 96 of file panel_fp_properties_3d_model.h.

Referenced by On3DModelSelected(), OnRemove3DModel(), PANEL_FP_PROPERTIES_3D_MODEL(), and select3DModel().

◆ m_lowerPanel

wxPanel* PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_lowerPanel
protectedinherited

Definition at line 49 of file panel_fp_properties_3d_model_base.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ m_LowerSizer3D

wxBoxSizer* PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_LowerSizer3D
protectedinherited

Definition at line 50 of file panel_fp_properties_3d_model_base.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ m_modelsGrid

WX_GRID* PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_modelsGrid
protectedinherited

Definition at line 44 of file panel_fp_properties_3d_model_base.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DRow(), PANEL_FP_PROPERTIES_3D_MODEL::OnRemove3DModel(), PANEL_FP_PROPERTIES_3D_MODEL::OnUpdateUI(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_FP_PROPERTIES_3D_MODEL_BASE(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), PANEL_FP_PROPERTIES_3D_MODEL::select3DModel(), PANEL_FP_PROPERTIES_3D_MODEL::TransferDataFromWindow(), PANEL_FP_PROPERTIES_3D_MODEL::updateValidateStatus(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), and ~PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ m_parentDialog

DIALOG_SHIM* PANEL_FP_PROPERTIES_3D_MODEL::m_parentDialog
private

Definition at line 88 of file panel_fp_properties_3d_model.h.

Referenced by OnAdd3DModel(), and PANEL_FP_PROPERTIES_3D_MODEL().

◆ m_previewPane

PANEL_PREVIEW_3D_MODEL* PANEL_FP_PROPERTIES_3D_MODEL::m_previewPane
private

Definition at line 93 of file panel_fp_properties_3d_model.h.

Referenced by Cfg3DPath(), On3DModelCellChanged(), OnAdd3DModel(), onDialogActivateEvent(), OnRemove3DModel(), postCustomPanelShownEventWithPredicate(), ReloadModelsFromFootprint(), select3DModel(), and ~PANEL_FP_PROPERTIES_3D_MODEL().

◆ m_shapes3D_list

std::vector<FP_3DMODEL> PANEL_FP_PROPERTIES_3D_MODEL::m_shapes3D_list
private

Definition at line 92 of file panel_fp_properties_3d_model.h.

Referenced by GetModelList(), On3DModelCellChanged(), OnAdd3DModel(), OnAdd3DRow(), OnRemove3DModel(), and ReloadModelsFromFootprint().

◆ m_splitter1

wxSplitterWindow* PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_splitter1
protectedinherited

Definition at line 42 of file panel_fp_properties_3d_model_base.h.

Referenced by m_splitter1OnIdle(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), and PANEL_FP_PROPERTIES_3D_MODEL_BASE().

◆ m_upperPanel

wxPanel* PANEL_FP_PROPERTIES_3D_MODEL_BASE::m_upperPanel
protectedinherited

Definition at line 43 of file panel_fp_properties_3d_model_base.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL_BASE().

The documentation for this class was generated from the following files: