131 lines
3.7 KiB
C++
131 lines
3.7 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2009-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 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
|
|
*/
|
|
|
|
/**
|
|
* @file stackup_predefined_prms.h
|
|
*/
|
|
|
|
#ifndef STACKUP_PREDEFINED_PRMS_H
|
|
#define STACKUP_PREDEFINED_PRMS_H
|
|
|
|
|
|
#include <wx/string.h>
|
|
#include <wx/arrstr.h>
|
|
#include <wx/colour.h>
|
|
|
|
#include <layer_ids.h>
|
|
#include <i18n_utility.h> // For _HKI definition
|
|
#include <gal/color4d.h>
|
|
|
|
#include <board_stackup_manager/board_stackup.h>
|
|
|
|
// Keyword used in file to identify the dielectric layer type
|
|
#define KEY_CORE wxT( "core" )
|
|
#define KEY_PREPREG wxT( "prepreg" )
|
|
|
|
#define KEY_COPPER wxT( "copper" )
|
|
|
|
// key string used for not specified parameters
|
|
// Can be translated in dialogs, and is also a keyword outside dialogs
|
|
wxString inline NotSpecifiedPrm()
|
|
{
|
|
return _HKI( "Not specified" );
|
|
}
|
|
|
|
/**
|
|
* @return true if the param value is specified:
|
|
* not empty
|
|
* not NotSpecifiedPrm() value or its translation
|
|
*/
|
|
bool IsPrmSpecified( const wxString& aPrmValue );
|
|
|
|
#define DEFAULT_SOLDERMASK_OPACITY 0.83
|
|
|
|
// A reasonable Epsilon R value for solder mask dielectric
|
|
#define DEFAULT_EPSILON_R_SOLDERMASK 3.3
|
|
|
|
// A default Epsilon R value for silkscreen dielectric
|
|
#define DEFAULT_EPSILON_R_SILKSCREEN 1.0
|
|
|
|
// A minor struct to handle color in gerber job file and dialog
|
|
class FAB_LAYER_COLOR
|
|
{
|
|
public:
|
|
FAB_LAYER_COLOR()
|
|
{}
|
|
|
|
FAB_LAYER_COLOR( const wxString& aColorName, const wxColor& aColor ) :
|
|
m_colorName( aColorName ),
|
|
m_color( aColor )
|
|
{}
|
|
|
|
const wxString& GetName() const
|
|
{
|
|
return m_colorName;
|
|
}
|
|
|
|
wxColor GetColor( BOARD_STACKUP_ITEM_TYPE aItemType ) const
|
|
{
|
|
if( aItemType == BS_ITEM_TYPE_SOLDERMASK )
|
|
return m_color.WithAlpha( DEFAULT_SOLDERMASK_OPACITY ).ToColour();
|
|
else
|
|
return m_color.WithAlpha( 1.0 ).ToColour();
|
|
}
|
|
|
|
private:
|
|
wxString m_colorName; // the name (in job file) of the color
|
|
// User values are the HTML coding #rrggbbaa hexadecimal value.
|
|
KIGFX::COLOR4D m_color;
|
|
};
|
|
|
|
|
|
/**
|
|
* @return a wxArray of standard copper finish names.
|
|
* @param aTranslate = false for the initial names, true for translated names
|
|
*/
|
|
wxArrayString GetCopperFinishStandardList( bool aTranslate );
|
|
|
|
/**
|
|
* @return a list of standard FAB_LAYER_COLOR items for silkscreen and solder mask.
|
|
*/
|
|
const FAB_LAYER_COLOR* GetColorStandardList();
|
|
|
|
/**
|
|
* @return the count of colors in ColorStandardList
|
|
*/
|
|
int GetColorStandardListCount();
|
|
|
|
/**
|
|
* @return the index of the user defined color in ColorStandardList
|
|
*/
|
|
int GetColorUserDefinedListIdx();
|
|
|
|
inline wxColour GetDefaultUserColor( BOARD_STACKUP_ITEM_TYPE aType )
|
|
{
|
|
return GetColorStandardList()[GetColorUserDefinedListIdx()].GetColor( aType );
|
|
}
|
|
|
|
|
|
#endif // #ifndef STACKUP_PREDEFINED_PRMS_H
|