GERBER_FILE_IMAGE_LIST Class Reference

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 (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 >	SortImagesByZOrder ()
	Sort loaded images by Z order priority, if they have the X2 FileFormat info (SortImagesByZOrder updates the graphic layer of these items) More...

Static Public Member Functions
static GERBER_FILE_IMAGE_LIST &	GetImagesList ()

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 63 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 44 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 53 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	= the image to add
aIdx	= 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 78 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] == NULL )
                break;
        }
    }

    if( idx >= (int)m_GERBER_List.size() )
        return -1;  // No room

    m_GERBER_List[idx] = aGbrImage;

    return idx;
}

References m_GERBER_List, and NULL.

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 100 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

(

int

aIdx

)

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

Parameters

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

Definition at line 107 of file gerber_file_image_list.cpp.

{
    // Ensure the index is valid:
    if( aIdx < 0 || aIdx >= int( m_GERBER_List.size() ) )
        return;

    // delete image aIdx
    GERBER_FILE_IMAGE* gbr_image = GetGbrImage( aIdx );

    delete gbr_image;
    m_GERBER_List[ aIdx ] = nullptr;
}

References GetGbrImage(), and m_GERBER_List.

Referenced by DeleteAllImages(), and GERBVIEW_FRAME::Erase_Current_DrawLayer().

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.

Parameters

aIdx	= the index ( 0 ... GERBER_DRAWLAYERS_COUNT-1 )
aNameOnly	= false (default) to add the layer number (for layers manager) or true to return only the name without layer name (status bar)
aFullName	= 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 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

Definition at line 121 of file gerber_file_image_list.cpp.

{
    wxString name;

    GERBER_FILE_IMAGE* gerber = NULL;

    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) + "..." + filename.Right(maxlen-5);
            filename = shortenedfn;
        }

        if( gerber->m_FileFunction )
        {
            if( gerber->m_FileFunction->IsCopper() )
            {
                name.Printf( "%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( "%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( "%s (%s, %s)",
                             filename.GetData(),
                             gerber->m_FileFunction->GetFileType(),
                             gerber->m_FileFunction->GetBrdLayerId() );
            }
        }
        else
            name = filename;

        if( aNameOnly )
            return name;

        wxString fullname;

        fullname.Printf( "%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, name, and NULL.

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

GetGbrImage()

GERBER_FILE_IMAGE * GERBER_FILE_IMAGE_LIST::GetGbrImage

(

int

aIdx

)

Definition at line 65 of file gerber_file_image_list.cpp.

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

    return NULL;
}

References m_GERBER_List, and NULL.

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(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), DIALOG_PRINT_GERBVIEW::TransferDataToWindow(), GERBVIEW_FRAME::updateAperAttributesSelectBox(), GERBVIEW_FRAME::updateComponentListSelectBox(), GERBVIEW_FRAME::updateNetnameListSelectBox(), GERBER_LAYER_WIDGET::useAlternateBitmap(), and GBR_LAYOUT::Visit().

GetImagesList()

GERBER_FILE_IMAGE_LIST & GERBER_FILE_IMAGE_LIST::GetImagesList ( )

static

Definition at line 59 of file gerber_file_image_list.cpp.

{
    return s_GERBER_List;
}

References s_GERBER_List.

Referenced by GBR_LAYOUT::GetImagesList(), GERBER_LAYER_WIDGET::GetImagesList(), GBR_LAYER_BOX_SELECTOR::getLayerName(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), GERBER_DRAW_ITEM::GetSelectMenuText(), GERBVIEW_PRINTOUT::OnPrintPage(), and GBR_LAYER_BOX_SELECTOR::Resync().

ImagesMaxCount()

unsigned GERBER_FILE_IMAGE_LIST::ImagesMaxCount ( )

inline

Definition at line 76 of file gerber_file_image_list.h.

{ 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().

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 225 of file gerber_file_image_list.cpp.

{
    std::sort( m_GERBER_List.begin(), m_GERBER_List.end(), sortZorder );

    // 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, GERBER_FILE_IMAGE::m_GraphicLayer, and sortZorder().

Referenced by GERBVIEW_FRAME::SortLayersByX2Attributes().

Member Data Documentation

m_GERBER_List

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

private

Definition at line 66 of file gerber_file_image_list.h.

Referenced by AddGbrImage(), DeleteAllImages(), DeleteImage(), GERBER_FILE_IMAGE_LIST(), GetDisplayName(), GetGbrImage(), ImagesMaxCount(), and SortImagesByZOrder().

---

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

• gerber_file_image_list.h
• gerber_file_image_list.cpp