3d_cache.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Cirilo Bernardo <[email protected]>
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

 
#ifndef CACHE_3D_H
#define CACHE_3D_H
 
#include "3d_info.h"
#include "model_substitution_helpers.h"
#include <core/typeinfo.h>
#include "string_utils.h"
#include <hash_128.h>
#include <list>
#include <map>
#include <mutex>
#include "plugins/3dapi/c3dmodel.h"
#include <project.h>
#include <wx/string.h>
 
class  EMBEDDED_FILES;
class  PGM_BASE;
class  S3D_CACHE_ENTRY;
class  SCENEGRAPH;
class  FILENAME_RESOLVER;
class  S3D_PLUGIN_MANAGER;
 

class S3D_CACHE : public PROJECT::_ELEM
{
public:
    S3D_CACHE();
    virtual ~S3D_CACHE();
 
    PROJECT::ELEM ProjectElementType() noexcept override
    {
        return PROJECT::ELEM::S3DCACHE;
    }

    bool Set3DConfigDir( const wxString& aConfigDir );

    bool SetProject( PROJECT* aProject );

    void SetProgramBase( PGM_BASE* aBase );

    SCENEGRAPH* Load( const wxString& aModelFile, const wxString& aBasePath,
                      std::vector<const EMBEDDED_FILES*> aEmbeddedFilesStack );
 
    FILENAME_RESOLVER* GetResolver() noexcept;

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

    void FlushCache( bool closePlugins = true );

    void ClosePlugins();

    S3DMODEL* GetModel( const wxString& aModelFileName, const wxString& aBasePath,
                        std::vector<const EMBEDDED_FILES*> aEmbeddedFilesStack );

    void CleanCacheDir( int aNumDaysOld );
 
private:
    SCENEGRAPH* checkCache( const wxString& aFileName, S3D_CACHE_ENTRY** aCachePtr = nullptr );

    bool getHash( const wxString& aFileName, HASH_128& aHash );
 
    // load scene data from a cache file
    bool loadCacheData( S3D_CACHE_ENTRY* aCacheItem );
 
    // save scene data to a cache file
    bool saveCacheData( S3D_CACHE_ENTRY* aCacheItem );
 
    // the real load function (can supply a cache entry pointer to member functions)
    SCENEGRAPH* load( const wxString& aModelFile, const wxString& aBasePath,
                      S3D_CACHE_ENTRY** aCachePtr = nullptr,
                      std::vector<const EMBEDDED_FILES*> aEmbeddedFilesStack = {} );

    std::list< S3D_CACHE_ENTRY* > m_CacheList;

    std::map< wxString, S3D_CACHE_ENTRY*, rsort_wxString > m_CacheMap;
 
    FILENAME_RESOLVER*  m_FNResolver;
 
    S3D_PLUGIN_MANAGER* m_Plugins;
 
    PROJECT*            m_project;
    wxString            m_CacheDir;
    wxString            m_ConfigDir; 

    mutable std::mutex                       m_substCatalogMutex;
    mutable bool                             m_substCatalogBuilt = false;
    mutable MODEL_SUBSTITUTION::STEP_CATALOG m_substCatalog;
};
 
#endif  // CACHE_3D_H