Cache for storing the 3D shapes. More...

#include <3d_cache.h>

Inheritance diagram for S3D_CACHE:

Public Member Functions
	S3D_CACHE ()

virtual	~S3D_CACHE ()

PROJECT::ELEM	ProjectElementType () noexcept override

bool	Set3DConfigDir (const wxString &aConfigDir)
	Sets the configuration directory to be used by the model manager for storing 3D model manager configuration data and the model cache.

bool	SetProject (PROJECT *aProject)
	Set the current project's working directory; this affects the model search path.

void	SetProgramBase (PGM_BASE *aBase)
	Set the filename resolver's pointer to the application's PGM_BASE instance.

SCENEGRAPH *	Load (const wxString &aModelFile, const wxString &aBasePath, const EMBEDDED_FILES *aEmbeddedFiles)
	Attempt to load the scene data for a model.

FILENAME_RESOLVER *	GetResolver () noexcept

std::list< wxString > const *	GetFileFilters () const
	Return the list of file filters retrieved from the plugins.

void	FlushCache (bool closePlugins=true)
	Free all data in the cache and by default closes all plugins.

void	ClosePlugins ()
	Unload plugins to free memory.

S3DMODEL *	GetModel (const wxString &aModelFileName, const wxString &aBasePath, const EMBEDDED_FILES *aEmbeddedFiles)
	Attempt to load the scene data for a model and to translate it into an S3D_MODEL structure for display by a renderer.

void	CleanCacheDir (int aNumDaysOld)
	Delete up old cache files in cache directory.

Private Member Functions
SCENEGRAPH *	checkCache (const wxString &aFileName, S3D_CACHE_ENTRY **aCachePtr=nullptr)
	Find or create cache entry for file name.

bool	getHash (const wxString &aFileName, HASH_128 &aHash)
	Calculate the SHA1 hash of the given file.

bool	loadCacheData (S3D_CACHE_ENTRY *aCacheItem)

bool	saveCacheData (S3D_CACHE_ENTRY *aCacheItem)

SCENEGRAPH *	load (const wxString &aModelFile, const wxString &aBasePath, S3D_CACHE_ENTRY *aCachePtr=nullptr, const EMBEDDED_FILES aEmbeddedFiles=nullptr)

Private Attributes
std::list< S3D_CACHE_ENTRY * >	m_CacheList
	cache entries

std::map< wxString, S3D_CACHE_ENTRY *, rsort_wxString >	m_CacheMap
	mapping of file names to cache names and data

FILENAME_RESOLVER *	m_FNResolver

S3D_PLUGIN_MANAGER *	m_Plugins

PROJECT *	m_project

wxString	m_CacheDir

wxString	m_ConfigDir

Detailed Description

Cache for storing the 3D shapes.

This cache is able to be stored as a project element (since it inherits from PROJECT::_ELEM).

Definition at line 54 of file 3d_cache.h.

Constructor & Destructor Documentation

◆ S3D_CACHE()

S3D_CACHE::S3D_CACHE ( )

Definition at line 126 of file 3d_cache.cpp.

References m_FNResolver, m_Plugins, and m_project.

◆ ~S3D_CACHE()

S3D_CACHE::~S3D_CACHE ( )

virtual

Definition at line 134 of file 3d_cache.cpp.

References FlushCache(), m_FNResolver, and m_Plugins.

Member Function Documentation

◆ checkCache()

SCENEGRAPH * S3D_CACHE::checkCache	(	const wxString &	aFileName,
		S3D_CACHE_ENTRY **	aCachePtr = `nullptr`
	)

private

Find or create cache entry for file name.

Searches the cache list for the given filename and retrieves the cache data; a cache entry is created if one does not already exist.

Parameters

aFileName	is the file name (full or partial path).
aCachePtr	is an optional return address for cache entry pointer.

Returns: SCENEGRAPH object associated with file name or NULL on error.

Definition at line 220 of file 3d_cache.cpp.

References S3D_CACHE_ENTRY::GetCacheBaseName(), ADVANCED_CFG::GetCfg(), getHash(), S3D_PLUGIN_MANAGER::Load3DModel(), loadCacheData(), m_CacheDir, m_CacheList, m_CacheMap, m_Plugins, MASK_3D_CACHE, S3D_CACHE_ENTRY::modTime, S3D_CACHE_ENTRY::pluginInfo, saveCacheData(), S3D_CACHE_ENTRY::sceneData, and S3D_CACHE_ENTRY::SetHash().

Referenced by load().

◆ CleanCacheDir()

void S3D_CACHE::CleanCacheDir ( int aNumDaysOld )

Delete up old cache files in cache directory.

Deletes ".3dc" files in the cache directory that are older than aNumDaysOld.

Parameters

aNumDaysOld is age threshold to delete ".3dc" cache files.

Definition at line 576 of file 3d_cache.cpp.

References m_CacheDir.

Referenced by PROJECT_PCB::Cleanup3DCache().

◆ ClosePlugins()

void S3D_CACHE::ClosePlugins ( )

Unload plugins to free memory.

Definition at line 542 of file 3d_cache.cpp.

References S3D_PLUGIN_MANAGER::ClosePlugins(), and m_Plugins.

Referenced by FlushCache().

◆ FlushCache()

void S3D_CACHE::FlushCache ( bool closePlugins = true )

Free all data in the cache and by default closes all plugins.

Definition at line 523 of file 3d_cache.cpp.

References ClosePlugins(), m_CacheList, and m_CacheMap.

Referenced by DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), and ~S3D_CACHE().

◆ GetFileFilters()

std::list< wxString > const * S3D_CACHE::GetFileFilters ( ) const

Return the list of file filters retrieved from the plugins.

This will contain at least the default "All Files (*.*)|*.*"

Returns: a pointer to the filter list.

Definition at line 517 of file 3d_cache.cpp.

References S3D_PLUGIN_MANAGER::GetFileFilters(), and m_Plugins.

Referenced by DIALOG_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL().

◆ getHash()

bool S3D_CACHE::getHash	(	const wxString &	aFileName,
		HASH_128 &	aHash
	)

private

Calculate the SHA1 hash of the given file.

Parameters

aFileName	file name (full path).
aHash	a 128 bit hash to hold the hash.

Returns: true on success, otherwise false.

Definition at line 287 of file 3d_cache.cpp.

References MMH3_HASH::add(), MMH3_HASH::digest(), and MASK_3D_CACHE.

Referenced by checkCache(), and load().

◆ GetModel()

S3DMODEL * S3D_CACHE::GetModel	(	const wxString &	aModelFileName,
		const wxString &	aBasePath,
		const EMBEDDED_FILES *	aEmbeddedFiles
	)

Attempt to load the scene data for a model and to translate it into an S3D_MODEL structure for display by a renderer.

Parameters

aModelFileName	is the full path to the model to be loaded.
aBasePath	is the path to search for any relative files.
aEmbeddedFiles	is a pointer to the embedded files list.

Returns: is a pointer to the render data or NULL if not available.

Definition at line 549 of file 3d_cache.cpp.

References S3D::GetModel(), load(), MASK_3D_CACHE, and S3D_CACHE_ENTRY::renderData.

Referenced by RENDER_3D_RAYTRACE_BASE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), and EDA_3D_MODEL_VIEWER::Set3DModel().

◆ GetResolver()

FILENAME_RESOLVER * S3D_CACHE::GetResolver ( )

noexcept

Definition at line 511 of file 3d_cache.cpp.

References m_FNResolver.

Referenced by PCB_EDIT_FRAME::Export_IDF3(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), PROJECT_PCB::Get3DFilenameResolver(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), and PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint().

◆ Load()

SCENEGRAPH * S3D_CACHE::Load	(	const wxString &	aModelFile,
		const wxString &	aBasePath,
		const EMBEDDED_FILES *	aEmbeddedFiles
	)

Attempt to load the scene data for a model.

It will consult the internal cache list and load from cache if possible before invoking the load() function of the available plugins. The model may fail to load if, for example, the plugin does not support rendering of the 3D model.

Parameters

aModelFile	is the partial or full path to the model to be loaded.
aBasePath	is the path to search for any relative files
aEmbeddedFiles	is a pointer to the embedded files list.

Returns: true if the model was successfully loaded, otherwise false.

Definition at line 214 of file 3d_cache.cpp.

References load().

Referenced by EXPORTER_PCB_VRML::ExportVrmlFootprint().

◆ load()

SCENEGRAPH * S3D_CACHE::load	(	const wxString &	aModelFile,
		const wxString &	aBasePath,
		S3D_CACHE_ENTRY **	aCachePtr = `nullptr`,
		const EMBEDDED_FILES *	aEmbeddedFiles = `nullptr`
	)