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

#include <project_pcb.h>

Static Public Member Functions

static FP_LIB_TABLE * PcbFootprintLibs (PROJECT *aProject)
 Return the table of footprint libraries without Kiway.
 
static S3D_CACHE * Get3DCacheManager (PROJECT *aProject, bool updateProjDir=false)
 Return a pointer to an instance of the 3D cache manager.
 
static void Cleanup3DCache (PROJECT *aProject)
 
static FILENAME_RESOLVER * Get3DFilenameResolver (PROJECT *aProject)
 Accessor for 3D path resolver.
 

Private Member Functions

 PROJECT_PCB ()
 

Detailed Description

Definition at line 31 of file project_pcb.h.

Constructor & Destructor Documentation

◆ PROJECT_PCB()

PROJECT_PCB::PROJECT_PCB ( )
inlineprivate

Definition at line 54 of file project_pcb.h.

Member Function Documentation

◆ Cleanup3DCache()

void PROJECT_PCB::Cleanup3DCache ( PROJECT *  aProject)
static

Definition at line 113 of file project_pcb.cpp.

References S3D_CACHE::CleanCacheDir(), COMMON_SETTINGS::SYSTEM::clear_3d_cache_interval, PGM_BASE::GetCommonSettings(), PROJECT::GetElem(), COMMON_SETTINGS::m_System, mutex3D_cacheManager, Pgm(), and PROJECT::S3DCACHE.

Referenced by PCB_BASE_FRAME::canCloseWindow().

◆ Get3DCacheManager()

S3D_CACHE * PROJECT_PCB::Get3DCacheManager ( PROJECT *  aProject,
bool  updateProjDir = false 
)
static

Return a pointer to an instance of the 3D cache manager.

An instance is created and initialized if appropriate.

Returns
a pointer to an instance of the 3D cache manager or NULL on failure.

Definition at line 77 of file project_pcb.cpp.

References PROJECT::GetElem(), PATHS::GetUserSettingsPath(), mutex3D_cacheManager, Pgm(), PROJECT::S3DCACHE, S3D_CACHE::Set3DConfigDir(), PROJECT::SetElem(), S3D_CACHE::SetProgramBase(), and S3D_CACHE::SetProject().

Referenced by DIALOG_FOOTPRINT_CHOOSER::build3DCanvas(), FOOTPRINT_CHOOSER_FRAME::build3DCanvas(), EVT_TOOL_RANGE(), PCB_EDIT_FRAME::Export_IDF3(), EXPORTER_PCB_VRML::ExportVRML_File(), Get3DFilenameResolver(), PCBNEW_JOBS_HANDLER::JobExportRender(), EDA_3D_VIEWER_FRAME::NewDisplay(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL().

◆ Get3DFilenameResolver()

FILENAME_RESOLVER * PROJECT_PCB::Get3DFilenameResolver ( PROJECT *  aProject)
static

Accessor for 3D path resolver.

Definition at line 107 of file project_pcb.cpp.

References Get3DCacheManager(), and S3D_CACHE::GetResolver().

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists().

◆ PcbFootprintLibs()

FP_LIB_TABLE * PROJECT_PCB::PcbFootprintLibs ( PROJECT *  aProject)
static

Return the table of footprint libraries without Kiway.

Definition at line 37 of file project_pcb.cpp.

References _, DisplayErrorMessage(), PROJECT::FootprintLibTblName(), PROJECT::FPTBL, PROJECT::GetElem(), GFootprintTable, LIB_TABLE::Load(), FP_LIB_TABLE::ProjectElementType(), PROJECT::SetElem(), and IO_ERROR::What().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), EXPORTER_STEP::buildFootprint3DShapes(), CVPCB_MAINFRAME::BuildLibrariesList(), PCB_BASE_FRAME::CreateNewFootprint(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), BOARD_INSPECTION_TOOL::DiffFootprint(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), GetFootprintLibraryTable(), idf_export_footprint(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), InvokePcbLibTableEditor(), CV::kiface(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), RENDER_3D_RAYTRACE_BASE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), PCB_EDIT_FRAME::LoadFootprints(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), FOOTPRINT_EDITOR_CONTROL::OpenDirectory(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDITOR_CONTROL::OpenWithTextEditor(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), CVPCB_MAINFRAME::readNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), PCB_BASE_EDIT_FRAME::selectLibTable(), PCB_BASE_FRAME::setFPWatcher(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), FOOTPRINT_EDITOR_CONTROL::tryToSaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists().

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