GERBER_FILE_IMAGE_LIST is a helper class to handle a list of GERBER_FILE_IMAGE files which are loaded and can be displayed there are 32 images max which can be loaded. More...

#include <gerber_file_image_list.h>

Public Member Functions
	GERBER_FILE_IMAGE_LIST ()

	~GERBER_FILE_IMAGE_LIST ()

GERBER_FILE_IMAGE *	GetGbrImage (int aIdx)

unsigned	ImagesMaxCount ()

int	AddGbrImage (GERBER_FILE_IMAGE *aGbrImage, int aIdx)
	Add a GERBER_FILE_IMAGE* at index aIdx or at the first free location if aIdx < 0. More...

void	DeleteAllImages ()
	Remove all loaded data in list, and delete all images, freeing the memory. More...

void	DeleteImage (unsigned int aIdx)
	Delete the loaded data of image aIdx, freeing the memory. More...

const wxString	GetDisplayName (int aIdx, bool aNameOnly=false, bool aFullName=false)
	Get the display name for the layer at aIdx. More...

std::unordered_map< int, int >	SortImagesByFunction (LayerSortFunction sortFunction)
	Sort loaded images by file extension matching. More...

std::unordered_map< int, int >	SortImagesByFileExtension ()
	Sort loaded images by file extension matching. More...

std::unordered_map< int, int >	SortImagesByZOrder ()
	Sort loaded images by Z order priority, if they have the X2 FileFormat info (SortImagesByZOrder updates the graphic layer of these items) More...

std::unordered_map< int, int >	SwapImages (unsigned int layer1, unsigned int layer2)
	Swap two images and their orders. More...

std::unordered_map< int, int >	RemoveImage (unsigned int layer)
	Removes (and deletes) an image, rotating the removed image to the end. More...

unsigned	GetLoadedImageCount ()
	Get number of loaded images. More...

Static Public Member Functions
static void	GetGerberLayerFromFilename (const wxString &filename, enum GERBER_ORDER_ENUM &order, wxString &matchedExtension)
	Utility function to guess which PCB layer of a gerber/drill file corresponds to based on its file extension. More...

static GERBER_FILE_IMAGE_LIST &	GetImagesList ()

Private Member Functions
std::unordered_map< int, int >	GetLayerRemap ()
	When the image order has changed, call this to get a mapping to pass to the frame's Remap() function to remap the widgets layer order. More...

Private Attributes
std::vector< GERBER_FILE_IMAGE * >	m_GERBER_List

Detailed Description

GERBER_FILE_IMAGE_LIST is a helper class to handle a list of GERBER_FILE_IMAGE files which are loaded and can be displayed there are 32 images max which can be loaded.

Definition at line 86 of file gerber_file_image_list.h.

Constructor & Destructor Documentation

◆ GERBER_FILE_IMAGE_LIST()

GERBER_FILE_IMAGE_LIST::GERBER_FILE_IMAGE_LIST ( )

Definition at line 43 of file gerber_file_image_list.cpp.

{
 m_GERBER_List.reserve( GERBER_DRAWLAYERS_COUNT );
 
 for( unsigned layer = 0; layer < GERBER_DRAWLAYERS_COUNT; ++layer )
 m_GERBER_List.push_back( nullptr );
}

References GERBER_DRAWLAYERS_COUNT, and m_GERBER_List.

◆ ~GERBER_FILE_IMAGE_LIST()

GERBER_FILE_IMAGE_LIST::~GERBER_FILE_IMAGE_LIST ( )

Definition at line 52 of file gerber_file_image_list.cpp.

{
 DeleteAllImages();
}

References DeleteAllImages().

Member Function Documentation

◆ AddGbrImage()

int GERBER_FILE_IMAGE_LIST::AddGbrImage	(	GERBER_FILE_IMAGE *	aGbrImage,
		int	aIdx
	)

Add a GERBER_FILE_IMAGE* at index aIdx or at the first free location if aIdx < 0.

Parameters

aGbrImage	is the image to add.
aIdx	is the location to use ( 0 ... GERBER_DRAWLAYERS_COUNT-1 ).

Returns: true if the index used, or -1 if no room to add image

Definition at line 83 of file gerber_file_image_list.cpp.

{
 int idx = aIdx;
 
 if( idx < 0 )
 {
 for( idx = 0; idx < (int)m_GERBER_List.size(); idx++ )
 {
 if( m_GERBER_List[idx] == nullptr )
 break;
 }
 }
 
 if( idx >= (int)m_GERBER_List.size() )
 return -1; // No room
 
 m_GERBER_List[idx] = aGbrImage;
 
 return idx;
}

References m_GERBER_List.

Referenced by GERBVIEW_FRAME::Read_EXCELLON_File(), and GERBVIEW_FRAME::Read_GERBER_File().

◆ DeleteAllImages()

void GERBER_FILE_IMAGE_LIST::DeleteAllImages ( )

Remove all loaded data in list, and delete all images, freeing the memory.

Definition at line 105 of file gerber_file_image_list.cpp.

{
 for( unsigned idx = 0; idx < m_GERBER_List.size(); ++idx )
 DeleteImage( idx );
}

References DeleteImage(), and m_GERBER_List.

Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), ~GERBER_FILE_IMAGE_LIST(), and GERBVIEW_FRAME::~GERBVIEW_FRAME().

◆ DeleteImage()

void GERBER_FILE_IMAGE_LIST::DeleteImage ( unsigned int aIdx )

Delete the loaded data of image aIdx, freeing the memory.

Parameters

aIdx	is the index ( 0 ... GERBER_DRAWLAYERS_COUNT-1 ).

Definition at line 112 of file gerber_file_image_list.cpp.

{
 // Ensure the index is valid:
 if( aIdx >= m_GERBER_List.size() )
 return;
 
 // delete image aIdx
 GERBER_FILE_IMAGE* gbr_image = GetGbrImage( static_cast<int>( aIdx ) );
 
 delete gbr_image;
 m_GERBER_List[ aIdx ] = nullptr;
}

References GetGbrImage(), and m_GERBER_List.

Referenced by DeleteAllImages(), and RemoveImage().

◆ GetDisplayName()

const wxString GERBER_FILE_IMAGE_LIST::GetDisplayName	(	int	aIdx,
		bool	aNameOnly = `false`,
		bool	aFullName = `false`
	)

Get the display name for the layer at aIdx.

if a file is loaded, the name is: "<aIdx+1> <short filename> <X2 FileFunction info> if a X2 FileFunction info is found" or (if no FileFunction info) "<aIdx+1> <short filename> *" if no file loaded, the name is: "Layer n" with n = aIdx+1

Parameters

aIdx	is the index ( 0 ... GERBER_DRAWLAYERS_COUNT-1 ).
aNameOnly	set to false (default) to add the layer number (for layers manager) or true to return only the name without layer name (status bar)/
aFullName	set to false (default) to ellipsize the name, true to return the full name.

Returns: a name for image aIdx which can be used in layers manager and layer selector or in the status bar

Definition at line 126 of file gerber_file_image_list.cpp.

{
 wxString name;
 
 GERBER_FILE_IMAGE* gerber = nullptr;
 
 if( aIdx >= 0 && aIdx < (int)m_GERBER_List.size() )
 gerber = m_GERBER_List[aIdx];
 
 // if a file is loaded, build the name:
 // <id> <short filename> <X2 FileFunction info> if a X2 FileFunction info is found
 // or (if no FileFunction info)
 // <id> <short filename> *
 if( gerber )
 {
 wxFileName fn( gerber->m_FileName );
 wxString filename = fn.GetFullName();
 
 // If the filename is too long, display a shortened name if requested
 const int maxlen = 30;
 
 if( !aFullName && filename.Length() > maxlen )
 {
 wxString shortenedfn = filename.Left(2) + wxT( "..." ) + filename.Right(maxlen-5);
 filename = shortenedfn;
 }
 
 if( gerber->m_FileFunction )
 {
 if( gerber->m_FileFunction->IsCopper() )
 {
 name.Printf( wxT( "%s (%s, %s, %s)" ),
 filename.GetData(),
 gerber->m_FileFunction->GetFileType(),
 gerber->m_FileFunction->GetBrdLayerId(),
 gerber->m_FileFunction->GetBrdLayerSide() );
 }
 if( gerber->m_FileFunction->IsDrillFile() )
 {
 name.Printf( wxT( "%s (%s,%s,%s,%s)" ),
 filename.GetData(),
 gerber->m_FileFunction->GetFileType(),
 gerber->m_FileFunction->GetDrillLayerPair(),
 gerber->m_FileFunction->GetLPType(),
 gerber->m_FileFunction->GetRouteType() );
 }
 else
 {
 name.Printf( wxT( "%s (%s, %s)" ),
 filename.GetData(),
 gerber->m_FileFunction->GetFileType(),
 gerber->m_FileFunction->GetBrdLayerId() );
 }
 }
 else
 {
 name = filename;
 }
 
 if( aNameOnly )
 return name;
 
 wxString fullname;
 
 fullname.Printf( wxT( "%d " ), aIdx + 1 );
 fullname << name;
 return fullname;
 }
 else
 {
 name.Printf( _( "Graphic layer %d" ), aIdx + 1 );
 }
 
 return name;
}

References _, X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerId(), X2_ATTRIBUTE_FILEFUNCTION::GetBrdLayerSide(), X2_ATTRIBUTE_FILEFUNCTION::GetDrillLayerPair(), X2_ATTRIBUTE_FILEFUNCTION::GetFileType(), X2_ATTRIBUTE_FILEFUNCTION::GetLPType(), X2_ATTRIBUTE_FILEFUNCTION::GetRouteType(), X2_ATTRIBUTE_FILEFUNCTION::IsCopper(), X2_ATTRIBUTE_FILEFUNCTION::IsDrillFile(), GERBER_FILE_IMAGE::m_FileFunction, GERBER_FILE_IMAGE::m_FileName, m_GERBER_List, and name.

Referenced by GERBVIEW_FRAME::GERBVIEW_FRAME(), GERBER_DRAW_ITEM::GetItemDescription(), GBR_LAYER_BOX_SELECTOR::getLayerName(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), and GERBER_LAYER_WIDGET::ReFill().

◆ GetGbrImage()

GERBER_FILE_IMAGE * GERBER_FILE_IMAGE_LIST::GetGbrImage ( int aIdx )

Definition at line 64 of file gerber_file_image_list.cpp.

{
 if( (unsigned)aIdx < m_GERBER_List.size() )
 return m_GERBER_List[aIdx];
 
 return nullptr;
}

References m_GERBER_List.

Referenced by GBR_LAYOUT::ComputeBoundingBox(), DeleteImage(), GBR_TO_PCB_EXPORTER::ExportPcb(), GERBVIEW_CONTROL::ExportToPcbnew(), LAYERS_MAP_DIALOG::findNumAltiumGerbersLoaded(), LAYERS_MAP_DIALOG::findNumKiCadGerbersLoaded(), LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), GERBVIEW_FRAME::GetGbrImage(), LAYERS_MAP_DIALOG::initDialog(), GERBVIEW_PRINTOUT::OnPrintPage(), LAYERS_MAP_DIALOG::OnSelectLayer(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_CONTROL::ReloadAllLayers(), GBR_LAYER_BOX_SELECTOR::Resync(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), DIALOG_PRINT_GERBVIEW::TransferDataToWindow(), GERBVIEW_FRAME::updateAperAttributesSelectBox(), GERBVIEW_FRAME::updateComponentListSelectBox(), GERBVIEW_FRAME::updateNetnameListSelectBox(), and GBR_LAYOUT::Visit().

◆ GetGerberLayerFromFilename()

void GERBER_FILE_IMAGE_LIST::GetGerberLayerFromFilename	(	const wxString &	filename,
		enum GERBER_ORDER_ENUM &	order,
		wxString &	matchedExtension
	)

static

Utility function to guess which PCB layer of a gerber/drill file corresponds to based on its file extension.

Supports many CAD program file extension patterns. Detects gerbers, drills, edge layers, etc.

Parameters

filename	Filename to check against the extension matching table.
order	Returns the order that this layer should be placed in a set of layers.
matchedExtension	The actual extension pattern that this filename matched.

Definition at line 307 of file gerber_file_image_list.cpp.

{
 order = GERBER_ORDER_ENUM::GERBER_LAYER_UNKNOWN;
 matchedExtension = "";
 
 for( struct GERBER_ORDER o : gerberFileExtensionOrder )
 {
 wxString ext = filename.Right( o.m_FilenameMask.length() ).Upper();
 
 if( ext.Matches( o.m_FilenameMask ) )
 {
 order = o.m_Order;
 matchedExtension = ext;
 return;
 }
 }
}

References GERBER_LAYER_UNKNOWN, and gerberFileExtensionOrder.

Referenced by GERBVIEW_FRAME::OpenProjectFiles(), sortFileExtension(), and GERBVIEW_FRAME::unarchiveFiles().

◆ GetImagesList()

GERBER_FILE_IMAGE_LIST & GERBER_FILE_IMAGE_LIST::GetImagesList ( )

static

Definition at line 58 of file gerber_file_image_list.cpp.

{
 return s_GERBER_List;
}

References s_GERBER_List.

Referenced by GERBER_LAYER_WIDGET::GetImagesList(), GBR_LAYOUT::GetImagesList(), GERBER_DRAW_ITEM::GetItemDescription(), GBR_LAYER_BOX_SELECTOR::getLayerName(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), GERBVIEW_CONTROL::LayerNext(), GERBVIEW_CONTROL::MoveLayerDown(), GERBVIEW_CONTROL::MoveLayerUp(), GERBVIEW_PRINTOUT::OnPrintPage(), and GBR_LAYER_BOX_SELECTOR::Resync().

◆ GetLayerRemap()

std::unordered_map< int, int > GERBER_FILE_IMAGE_LIST::GetLayerRemap ( )

private

When the image order has changed, call this to get a mapping to pass to the frame's Remap() function to remap the widgets layer order.

Returns: Map describing the remap.

Definition at line 414 of file gerber_file_image_list.cpp.

{
 // The image order has changed.
 // Graphic layer numbering must be updated to match the widgets layer order
 
 // Store the old/new graphic layer info:
 std::unordered_map<int, int> tab_lyr;
 
 for( unsigned layer = 0; layer < m_GERBER_List.size(); ++layer )
 {
 GERBER_FILE_IMAGE* gerber = m_GERBER_List[layer];
 
 if( !gerber )
 continue;
 
 tab_lyr[gerber->m_GraphicLayer] = layer;
 gerber->m_GraphicLayer = layer ;
 }
 
 return tab_lyr;
}

References m_GERBER_List, and GERBER_FILE_IMAGE::m_GraphicLayer.

Referenced by RemoveImage(), SortImagesByFunction(), and SwapImages().

◆ GetLoadedImageCount()

unsigned GERBER_FILE_IMAGE_LIST::GetLoadedImageCount ( )

Get number of loaded images.

Returns: number of images loaded

Definition at line 73 of file gerber_file_image_list.cpp.

{
 auto notNull = []( GERBER_FILE_IMAGE* image )
 {
 return image != nullptr;
 };
 return std::count_if( m_GERBER_List.begin(), m_GERBER_List.end(), notNull );
}

References image, and m_GERBER_List.

Referenced by GERBVIEW_FRAME::LoadFileOrShowDialog(), and GERBVIEW_CONTROL::MoveLayerDown().

◆ ImagesMaxCount()

unsigned GERBER_FILE_IMAGE_LIST::ImagesMaxCount ( )

inline

Definition at line 108 of file gerber_file_image_list.h.

108{ return m_GERBER_List.size(); }

References m_GERBER_List.

Referenced by GBR_LAYOUT::ComputeBoundingBox(), GBR_TO_PCB_EXPORTER::ExportPcb(), GERBVIEW_CONTROL::ExportToPcbnew(), GERBVIEW_FRAME::ImagesMaxCount(), GERBVIEW_CONTROL::ReloadAllLayers(), GBR_LAYER_BOX_SELECTOR::Resync(), DIALOG_PRINT_GERBVIEW::TransferDataToWindow(), GERBVIEW_FRAME::updateAperAttributesSelectBox(), GERBVIEW_FRAME::updateComponentListSelectBox(), GERBVIEW_FRAME::updateNetnameListSelectBox(), and GBR_LAYOUT::Visit().

◆ RemoveImage()

std::unordered_map< int, int > GERBER_FILE_IMAGE_LIST::RemoveImage ( unsigned int layer )

Removes (and deletes) an image, rotating the removed image to the end.

Returns: a mapping of old to new layer index

Definition at line 467 of file gerber_file_image_list.cpp.

{
 if( layer >= m_GERBER_List.size() )
 return std::unordered_map<int, int>();
 
 DeleteImage( layer );
 // Move deleted image to end of list, move all other images up
 std::rotate( m_GERBER_List.begin() + layer, m_GERBER_List.begin() + layer + 1,
 m_GERBER_List.end() );
 return GetLayerRemap();
}

References DeleteImage(), GetLayerRemap(), and m_GERBER_List.

◆ SortImagesByFileExtension()

std::unordered_map< int, int > GERBER_FILE_IMAGE_LIST::SortImagesByFileExtension ( )

Sort loaded images by file extension matching.

Returns: a mapping of old to new layer index

Definition at line 445 of file gerber_file_image_list.cpp.

{
 return SortImagesByFunction( sortFileExtension );
}

References sortFileExtension(), and SortImagesByFunction().

◆ SortImagesByFunction()

std::unordered_map< int, int > GERBER_FILE_IMAGE_LIST::SortImagesByFunction ( LayerSortFunction sortFunction )

Sort loaded images by file extension matching.

Returns: a mapping of old to new layer index

Definition at line 438 of file gerber_file_image_list.cpp.

{
 std::sort( m_GERBER_List.begin(), m_GERBER_List.end(), sortFunction );
 return GetLayerRemap();
}

References GetLayerRemap(), and m_GERBER_List.

Referenced by SortImagesByFileExtension(), and SortImagesByZOrder().

◆ SortImagesByZOrder()

std::unordered_map< int, int > GERBER_FILE_IMAGE_LIST::SortImagesByZOrder ( )

Sort loaded images by Z order priority, if they have the X2 FileFormat info (SortImagesByZOrder updates the graphic layer of these items)

Returns: a mapping of old to new layer index

Definition at line 451 of file gerber_file_image_list.cpp.

{
 return SortImagesByFunction( sortZorder );
}

References SortImagesByFunction(), and sortZorder().

◆ SwapImages()

std::unordered_map< int, int > GERBER_FILE_IMAGE_LIST::SwapImages	(	unsigned int	layer1,
		unsigned int	layer2
	)

Swap two images and their orders.

Returns: a mapping of old to new layer index

Definition at line 457 of file gerber_file_image_list.cpp.

{
 if( ( layer1 >= m_GERBER_List.size() ) || ( layer2 >= m_GERBER_List.size() ) )
 return std::unordered_map<int, int>();
 
 std::swap( m_GERBER_List[layer1], m_GERBER_List[layer2] );
 return GetLayerRemap();
}

References GetLayerRemap(), and m_GERBER_List.

Referenced by GERBVIEW_CONTROL::MoveLayerDown().

Member Data Documentation

◆ m_GERBER_List

std::vector<GERBER_FILE_IMAGE*> GERBER_FILE_IMAGE_LIST::m_GERBER_List

private

Definition at line 206 of file gerber_file_image_list.h.

Referenced by AddGbrImage(), DeleteAllImages(), DeleteImage(), GERBER_FILE_IMAGE_LIST(), GetDisplayName(), GetGbrImage(), GetLayerRemap(), GetLoadedImageCount(), ImagesMaxCount(), RemoveImage(), SortImagesByFunction(), and SwapImages().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GERBER_FILE_IMAGE_LIST()

◆ ~GERBER_FILE_IMAGE_LIST()

Member Function Documentation

◆ AddGbrImage()

◆ DeleteAllImages()

◆ DeleteImage()

◆ GetDisplayName()

◆ GetGbrImage()

◆ GetGerberLayerFromFilename()

◆ GetImagesList()

◆ GetLayerRemap()

◆ GetLoadedImageCount()

◆ ImagesMaxCount()

◆ RemoveImage()

◆ SortImagesByFileExtension()

◆ SortImagesByFunction()

◆ SortImagesByZOrder()

◆ SwapImages()

Member Data Documentation

◆ m_GERBER_List