KiCad PCB EDA Suite
stackup_predefined_prms.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2009-2021 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25
26#include <wx/string.h>
27#include <core/arraydim.h>
29#include <i18n_utility.h> // _HKI definition
31
32// A list of copper finish standard type names.
33// They are standard names in .gbdjob files, so avoid changing them or ensure they are
34// compatible with .gbrjob file spec.
35static wxString copperFinishType[] =
36{
37 NotSpecifiedPrm(), // Not specified, not in .gbrjob file
38 _HKI( "ENIG" ), // used in .gbrjob file
39 _HKI( "ENEPIG" ), // used in .gbrjob file
40 _HKI( "HAL SnPb" ), // used in .gbrjob file
41 _HKI( "HAL lead-free" ), // used in .gbrjob file
42 _HKI( "Hard gold" ), // used in .gbrjob file
43 _HKI( "Immersion tin" ), // used in .gbrjob file
44 _HKI( "Immersion nickel" ), // used in .gbrjob file
45 _HKI( "Immersion silver" ), // used in .gbrjob file
46 _HKI( "Immersion gold" ), // used in .gbrjob file
47 _HKI( "HT_OSP" ), // used in .gbrjob file
48 _HKI( "OSP" ), // used in .gbrjob file
49 _HKI( "None" ), // used in .gbrjob file
50 _HKI( "User defined" ) // keep this option at end
51};
52
53
54// A list of available colors for solder mask and silkscreen.
55// These names are used in .gbrjob file, so they are not fully free. Use only what is allowed in
56// .gbrjob files.
57// For other colors (user defined), the defined value is the html color syntax in .kicad_pcb files
58// and R<integer>G<integer>B<integer> in .gbrjob file.
59static std::vector<FAB_LAYER_COLOR> gbrjobColors =
60{
61 { NotSpecifiedPrm(), wxColor( 80, 80, 80 ) }, // Not specified, not in .gbrjob file
62 { _HKI( "Green" ), wxColor( 60, 150, 80 ) }, // used in .gbrjob file
63 { _HKI( "Red" ), wxColor( 128, 0, 0 ) }, // used in .gbrjob file
64 { _HKI( "Blue" ), wxColor( 0, 0, 128 ) }, // used in .gbrjob file
65 { _HKI( "Purple" ), wxColor( 80, 0, 80 ) }, // used in .gbrjob file
66 { _HKI( "Black" ), wxColor( 20, 20, 20 ) }, // used in .gbrjob file
67 { _HKI( "White" ), wxColor( 200, 200, 200 ) }, // used in .gbrjob file
68 { _HKI( "Yellow" ), wxColor( 128, 128, 0 ) }, // used in .gbrjob file
69 { _HKI( "User defined" ), wxColor( 128, 128, 128 ) } // Free; the name is a dummy name here
70};
71
72
73// These are used primarily as a source for the 3D renderer. They are written
74// as R<integer>G<integer>B<integer> to the .gbrjob file.
75static std::vector<FAB_LAYER_COLOR> dielectricColors =
76{
77 { NotSpecifiedPrm(), wxColor( 80, 80, 80, 255 ) },
78 { _HKI( "FR4 natural" ), wxColor( 109, 116, 75, 212 ) },
79 { _HKI( "PTFE natural" ), wxColor( 252, 252, 250, 230 ) },
80 { _HKI( "Polyimide" ), wxColor( 205, 130, 0, 170 ) },
81 { _HKI( "Phenolic natural" ), wxColor( 92, 17, 6, 230 ) },
82 { _HKI( "Aluminum" ), wxColor( 213, 213, 213, 255 ) },
83 { _HKI( "User defined" ), wxColor( 128, 128, 128, 212 ) }
84};
85
86
87wxArrayString GetStandardCopperFinishes( bool aTranslate )
88{
89 wxArrayString list;
90
91 for( unsigned ii = 0; ii < arrayDim( copperFinishType ); ii++ )
92 list.Add( aTranslate ? wxGetTranslation( copperFinishType[ii] ) : copperFinishType[ii] );
93
94 return list;
95}
96
97std::vector<FAB_LAYER_COLOR> dummy;
98const std::vector<FAB_LAYER_COLOR>& GetStandardColors( BOARD_STACKUP_ITEM_TYPE aType )
99{
100 switch( aType )
101 {
105 default: return dummy;
106 }
107}
108
109
111{
112 // this is the last item in list
113 return GetStandardColors( aType ).size() - 1;
114}
115
116
117bool IsColorNameNormalized( const wxString& aName )
118{
119 static std::vector<wxString> list =
120 {
121 wxT( "Green" ), wxT( "Red" ), wxT( "Blue" ),
122 wxT( "Black" ), wxT( "White" ), wxT( "Yellow" )
123 };
124
125 for( wxString& candidate : list )
126 {
127 if( candidate.CmpNoCase( aName ) == 0 )
128 return true;
129 }
130
131 return false;
132}
133
134
136{
138 return m_colorName;
139
140 return wxString::Format( wxT( "R%dG%dB%d" ),
141 int( m_color.r*255 ), int( m_color.g*255 ), int( m_color.b*255 ) );
142}
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
BOARD_STACKUP_ITEM_TYPE
Definition: board_stackup.h:41
@ BS_ITEM_TYPE_SILKSCREEN
Definition: board_stackup.h:49
@ BS_ITEM_TYPE_DIELECTRIC
Definition: board_stackup.h:44
@ BS_ITEM_TYPE_SOLDERMASK
Definition: board_stackup.h:47
const wxString GetColorAsString() const
double r
Red component.
Definition: color4d.h:390
double g
Green component.
Definition: color4d.h:391
double b
Blue component.
Definition: color4d.h:392
#define _HKI(x)
Some functions to handle hotkeys in KiCad.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
std::vector< FAB_LAYER_COLOR > dummy
static std::vector< FAB_LAYER_COLOR > dielectricColors
static std::vector< FAB_LAYER_COLOR > gbrjobColors
const std::vector< FAB_LAYER_COLOR > & GetStandardColors(BOARD_STACKUP_ITEM_TYPE aType)
int GetColorUserDefinedListIdx(BOARD_STACKUP_ITEM_TYPE aType)
bool IsColorNameNormalized(const wxString &aName)
wxArrayString GetStandardCopperFinishes(bool aTranslate)
static wxString copperFinishType[]
wxString NotSpecifiedPrm()