Helper to retrieve bitmaps while handling icon themes and scaling. More...

#include <bitmap_store.h>

Public Member Functions
	BITMAP_STORE ()

	~BITMAP_STORE ()=default

wxBitmap	GetBitmap (BITMAPS aBitmapId, int aHeight=-1)
	Retrieves a bitmap from the given bitmap id. More...

wxBitmap	GetBitmapScaled (BITMAPS aBitmapId, int aScaleFactor, int aHeight=-1)
	Retrieves a bitmap from the given bitmap id, scaled to a given factor. More...

void	ThemeChanged ()
	Notifies the store that the icon theme has been changed by the user, so caches must be invalidated. More...

bool	IsDarkTheme () const

Private Member Functions
wxImage	getImage (BITMAPS aBitmapId, int aHeight=-1)

const wxString &	bitmapName (BITMAPS aBitmapId, int aHeight=-1)

wxString	computeBitmapName (BITMAPS aBitmapId, int aHeight=-1)

void	buildBitmapInfoCache ()

Private Attributes
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

Detailed Description

Helper to retrieve bitmaps while handling icon themes and scaling.

Definition at line 43 of file bitmap_store.h.

Constructor & Destructor Documentation

◆ BITMAP_STORE()

BITMAP_STORE::BITMAP_STORE ( )

Definition at line 104 of file bitmap_store.cpp.

{
 wxFileName path( PATHS::GetStockDataPath() + wxT( "/resources" ), IMAGE_ARCHIVE );
 
 wxLogTrace( traceBitmaps, "Loading bitmaps from " + path.GetFullPath() );
 
 m_archive = std::make_unique<ASSET_ARCHIVE>( path.GetFullPath() );
 
 buildBitmapInfoCache();
 
 ThemeChanged();
}

References buildBitmapInfoCache(), PATHS::GetStockDataPath(), IMAGE_ARCHIVE, m_archive, path, ThemeChanged(), and traceBitmaps.

◆ ~BITMAP_STORE()

BITMAP_STORE::~BITMAP_STORE ( )

default

Member Function Documentation

◆ bitmapName()

const wxString & BITMAP_STORE::bitmapName	(	BITMAPS	aBitmapId,
		int	aHeight = `-1`
	)

private

Definition at line 196 of file bitmap_store.cpp.

{
 std::pair<BITMAPS, int> key = std::make_pair( aBitmapId, aHeight );
 
 if( !m_bitmapNameCache.count( key ) )
 m_bitmapNameCache[key] = computeBitmapName( aBitmapId, aHeight );
 
 return m_bitmapNameCache.at( key );
}

References computeBitmapName(), and m_bitmapNameCache.

Referenced by getImage().

◆ buildBitmapInfoCache()

void BITMAP_STORE::buildBitmapInfoCache ( )

private

Definition at line 240 of file bitmap_store.cpp.

{
 BuildBitmapInfo( m_bitmapInfoCache );
}

References BuildBitmapInfo(), and m_bitmapInfoCache.

Referenced by BITMAP_STORE().

◆ computeBitmapName()

wxString BITMAP_STORE::computeBitmapName	(	BITMAPS	aBitmapId,
		int	aHeight = `-1`
	)

private

Definition at line 207 of file bitmap_store.cpp.

{
 if( !m_bitmapInfoCache.count( aBitmapId ) )
 {
 wxLogTrace( traceBitmaps, "No bitmap info available for %d", aBitmapId );
 return wxEmptyString;
 }
 
 wxString fn;
 
 for( const BITMAP_INFO& info : m_bitmapInfoCache.at( aBitmapId ) )
 {
 if( info.theme != m_theme )
 continue;
 
 if( aHeight < 0 || info.height == aHeight )
 {
 fn = info.filename;
 break;
 }
 }
 
 if( fn.IsEmpty() )
 {
 wxLogTrace( traceBitmaps, "No bitmap found matching ID %d, height %d, theme %s",
 aBitmapId, aHeight, m_theme );
 return m_bitmapInfoCache.at( aBitmapId ).begin()->filename;
 }
 
 return fn;
}

References info, m_bitmapInfoCache, m_theme, and traceBitmaps.

Referenced by bitmapName().

◆ GetBitmap()

wxBitmap BITMAP_STORE::GetBitmap	(	BITMAPS	aBitmapId,
		int	aHeight = `-1`
	)

Retrieves a bitmap from the given bitmap id.

Parameters

aBitmapId	is from the BITMAPS enum in bitmaps_list.h
aHeight	is the requested height in pixels of the source image, or -1 for any height

Definition at line 118 of file bitmap_store.cpp.

{
 return wxBitmap( getImage( aBitmapId, aHeight ) );
}

References getImage().

Referenced by KiBitmap().

◆ GetBitmapScaled()

wxBitmap BITMAP_STORE::GetBitmapScaled	(	BITMAPS	aBitmapId,
		int	aScaleFactor,
		int	aHeight = `-1`
	)

Retrieves a bitmap from the given bitmap id, scaled to a given factor.

This factor is for legacy reasons divided by 4, so a scale factor of 4 will return the original image.

Todo:: this should be improved to take advantage of a number of different resolution PNGs stored in the asset archive, so we take the closest PNG and scale it rather than always starting with a low-resolution version.

Parameters

aBitmapId	is from the BITMAPS enum in bitmaps_list.h
aScaleFactor	is used to scale the bitmap uniformly
aHeight	is the requested height in pixels of the source image to scale from

Definition at line 124 of file bitmap_store.cpp.

{
 wxImage image = getImage( aBitmapId, aHeight );
 
 // Bilinear seems to genuinely look better for these line-drawing icons
 // than bicubic, despite claims in the wx documentation that bicubic is
 // "highest quality". I don't recommend changing this. Bicubic looks
 // blurry and makes me want an eye exam.
 image.Rescale( aScaleFactor * image.GetWidth() / 4, aScaleFactor * image.GetHeight() / 4,
 wxIMAGE_QUALITY_BILINEAR );
 
 return wxBitmap( image );
}

References getImage(), and image.

Referenced by KiScaledBitmap().

◆ getImage()

wxImage BITMAP_STORE::getImage	(	BITMAPS	aBitmapId,
		int	aHeight = `-1`
	)

private

Definition at line 139 of file bitmap_store.cpp.

{
 const unsigned char* data = nullptr;
 long count;
 
 if( aBitmapId == BITMAPS::dummy_item )
 {
 data = s_dummyItem;
 count = sizeof( s_dummyItem );
 }
 else
 {
 count = m_archive->GetFilePointer( bitmapName( aBitmapId, aHeight ), &data );
 
 if( count < 0 )
 {
 wxLogTrace( traceBitmaps, "Bitmap for %d, %d, %s has an info tag with file %s,"
 "but that file could not be found in the archive!",
 aBitmapId, aHeight, m_theme );
 data = s_imageNotFound;
 count = sizeof( s_imageNotFound );
 }
 }
 
 wxMemoryInputStream is( data, count );
 wxImage image( is, wxBITMAP_TYPE_PNG );
 
 return image;
}

References bitmapName(), dummy_item, image, m_archive, m_theme, s_dummyItem, s_imageNotFound, and traceBitmaps.

Referenced by GetBitmap(), and GetBitmapScaled().

◆ IsDarkTheme()

bool BITMAP_STORE::IsDarkTheme ( ) const

inline

Definition at line 79 of file bitmap_store.h.

79{ return m_theme == wxT( "dark" ); }

References m_theme.

◆ ThemeChanged()

void BITMAP_STORE::ThemeChanged ( )

Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.

Definition at line 170 of file bitmap_store.cpp.

{
 COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
 wxString oldTheme = m_theme;
 
 if( settings )
 {
 switch( settings->m_Appearance.icon_theme )
 {
 case ICON_THEME::LIGHT: m_theme = wxT( "light" ); break;
 case ICON_THEME::DARK: m_theme = wxT( "dark" ); break;
 case ICON_THEME::AUTO:
 m_theme = KIPLATFORM::UI::IsDarkTheme() ? wxT( "dark" ) : wxT( "light" );
 break;
 }
 }
 else
 {
 m_theme = wxT( "light" );
 }
 
 if( !oldTheme.IsSameAs( m_theme ) )
 m_bitmapNameCache.clear();
}

References AUTO, DARK, COMMON_SETTINGS::APPEARANCE::icon_theme, KIPLATFORM::UI::IsDarkTheme(), LIGHT, COMMON_SETTINGS::m_Appearance, m_bitmapNameCache, m_theme, and Pgm().

Referenced by BITMAP_STORE(), EDA_BASE_FRAME::CommonSettingsChanged(), EDA_BASE_FRAME::HandleSystemColorChange(), ACTION_TOOLBAR::onThemeChanged(), PANEL_KICAD_LAUNCHER::onThemeChanged(), PROJECT_TREE_PANE::onThemeChanged(), and PCB_CALCULATOR_FRAME::onThemeChanged().

Member Data Documentation

◆ m_archive

std::unique_ptr<ASSET_ARCHIVE> BITMAP_STORE::m_archive

private

Definition at line 91 of file bitmap_store.h.

Referenced by BITMAP_STORE(), and getImage().

◆ m_bitmapInfoCache

std::unordered_map<BITMAPS, std::vector<BITMAP_INFO> > BITMAP_STORE::m_bitmapInfoCache

private

Definition at line 95 of file bitmap_store.h.

Referenced by buildBitmapInfoCache(), and computeBitmapName().

◆ m_bitmapNameCache

std::unordered_map<std::pair<BITMAPS, int>, wxString> BITMAP_STORE::m_bitmapNameCache

private

Definition at line 93 of file bitmap_store.h.

Referenced by bitmapName(), and ThemeChanged().

◆ m_theme

wxString BITMAP_STORE::m_theme

private

Definition at line 97 of file bitmap_store.h.

Referenced by computeBitmapName(), getImage(), IsDarkTheme(), and ThemeChanged().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BITMAP_STORE()

◆ ~BITMAP_STORE()

Member Function Documentation

◆ bitmapName()

◆ buildBitmapInfoCache()

◆ computeBitmapName()

◆ GetBitmap()

◆ GetBitmapScaled()

◆ getImage()

◆ IsDarkTheme()

◆ ThemeChanged()

Member Data Documentation

◆ m_archive

◆ m_bitmapInfoCache

◆ m_bitmapNameCache

◆ m_theme