bitmap_store.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 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 3 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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_BITMAP_STORE_H
#define KICAD_BITMAP_STORE_H
 
#include <memory>
#include <unordered_map>
 
#include <wx/bmpbndl.h>
 
#include <bitmaps/bitmap_info.h>
#include <kicommon.h>
 
class ASSET_ARCHIVE;
class wxImage;
 
 
namespace std
{
    template<> struct KICOMMON_API hash<std::pair<BITMAPS, int>>
    {
        size_t operator()( const std::pair<BITMAPS, int>& aPair ) const;
    };
}
 
class KICOMMON_API BITMAP_STORE
{
public:
    BITMAP_STORE();
 
    ~BITMAP_STORE() = default;
 
    wxBitmap GetBitmap( BITMAPS aBitmapId, int aHeight = -1 );
 
    wxBitmapBundle GetBitmapBundle( BITMAPS aBitmapId );
 
    wxBitmapBundle GetDisabledBitmapBundle( BITMAPS aBitmapId );
 
    wxBitmap GetBitmapScaled( BITMAPS aBitmapId, int aScaleFactor, int aHeight = -1 );
 
    void ThemeChanged();
 
    bool IsDarkTheme() const { return m_theme == wxT( "dark" ); }
 
private:
 
    wxImage getImage( BITMAPS aBitmapId, int aHeight = -1 );
 
    const wxString& bitmapName( BITMAPS aBitmapId, int aHeight = -1 );
 
    wxString computeBitmapName( BITMAPS aBitmapId, int aHeight = -1 );
 
    void buildBitmapInfoCache();
 
    std::unique_ptr<ASSET_ARCHIVE> m_archive;
 
    std::unordered_map<std::pair<BITMAPS, int>, wxString> m_bitmapNameCache;
 
    std::unordered_map<BITMAPS, std::vector<BITMAP_INFO>> m_bitmapInfoCache;
 
    wxString m_theme;
};
 
#endif // KICAD_BITMAP_STORE_H