KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eeschema/dialogs/dialog_shape_properties.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 The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
25#include <stroke_params.h>
26#include <sch_edit_frame.h>
27#include <symbol_edit_frame.h>
28#include <sch_shape.h>
29#include <sch_rule_area.h>
33#include <sch_commit.h>
34#include <string_utils.h>
35
36
39 m_frame( aParent ),
40 m_shape( aShape ),
41 m_borderWidth( aParent, m_borderWidthLabel, m_borderWidthCtrl, m_borderWidthUnits, true )
42{
43 SetTitle( wxString::Format( GetTitle(), aShape->GetFriendlyName() ) );
44
45 // DIALOG_SHIM needs a unique hash_key because classname is not sufficient because the
46 // different shapes (and even whether or not we're within the symbol editor) cause different
47 // dialog layouts).
48 m_hash_key = TO_UTF8( GetTitle() + aParent->GetName() );
49
50 m_helpLabel1->SetFont( KIUI::GetInfoFont( this ).Italic() );
51 m_helpLabel2->SetFont( KIUI::GetInfoFont( this ).Italic() );
52
53 COLOR_SETTINGS* colorSettings = m_frame->GetColorSettings();
54 COLOR4D schematicBackground = colorSettings->GetColor( LAYER_SCHEMATIC_BACKGROUND );
55
56 m_borderColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
57 m_borderColorSwatch->SetSwatchBackground( schematicBackground );
58
59 for( const auto& [ lineStyle, lineStyleDesc ] : lineTypeNames )
60 m_borderStyleCombo->Append( lineStyleDesc.name, KiBitmapBundle( lineStyleDesc.bitmap ) );
61
62 m_fillColorSwatch->SetDefaultColor( COLOR4D::UNSPECIFIED );
63 m_fillColorSwatch->SetSwatchBackground( schematicBackground );
64
68
70 m_infoBar->ShowMessage( _( "Note: individual item colors overridden in Preferences." ) );
71
72 m_ruleAreaSizer->Show( dynamic_cast<SCH_RULE_AREA*>( aShape ) != nullptr );
73
75
76 // Required under wxGTK if we want to dismiss the dialog with the ESC key
77 SetFocus();
78
80
81 if( SYMBOL_EDIT_FRAME* symbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame ) )
82 {
83 m_fillBook->SetSelection( 1 );
84
85 if( !symbolEditor->IsSymbolEditable() || symbolEditor->IsSymbolAlias() )
86 {
87 m_sdbSizerCancel->SetDefault();
88 m_sdbSizerOK->SetLabel( _( "Read Only" ) );
89 m_sdbSizerOK->Enable( false );
90 }
91 }
92 else
93 {
94 m_fillBook->SetSelection( 0 );
95 m_symbolEditorSizer->Show( false );
96 }
97
98 m_borderColorSwatch->Bind( COLOR_SWATCH_CHANGED, &DIALOG_SHAPE_PROPERTIES::onBorderSwatch, this );
99 m_customColorSwatch->Bind( COLOR_SWATCH_CHANGED, &DIALOG_SHAPE_PROPERTIES::onCustomColorSwatch, this );
100
101 // Now all widgets have the size fixed, call FinishDialogSettings
103}
104
105
107{
108 m_borderColorSwatch->Unbind( COLOR_SWATCH_CHANGED, &DIALOG_SHAPE_PROPERTIES::onBorderSwatch, this );
109 m_customColorSwatch->Unbind( COLOR_SWATCH_CHANGED, &DIALOG_SHAPE_PROPERTIES::onCustomColorSwatch, this );
110}
111
112
114{
115 if( !wxDialog::TransferDataToWindow() )
116 return false;
117
118 if( SCH_RULE_AREA* ruleArea = dynamic_cast<SCH_RULE_AREA*>( m_shape ) )
119 {
120 m_cbExcludeFromSim->SetValue( ruleArea->GetExcludedFromSim() );
121 m_cbExcludeFromBom->SetValue( ruleArea->GetExcludedFromBOM() );
122 m_cbExcludeFromBoard->SetValue( ruleArea->GetExcludedFromBoard() );
123 m_cbDNP->SetValue( ruleArea->GetDNP() );
124 }
125
126 if( m_shape->GetWidth() >= 0 )
127 {
128 m_borderCheckbox->SetValue( true );
130 }
131 else
132 {
133 m_borderCheckbox->SetValue( false );
134
135 m_borderWidth.Enable( false );
136 m_borderColorLabel->Enable( false );
137 m_borderColorSwatch->Enable( false );
138 m_borderStyleLabel->Enable( false );
139 m_borderStyleCombo->Enable( false );
140 }
141
143
144 int style = static_cast<int>( m_shape->GetStroke().GetLineStyle() );
145
146 if( style == -1 )
147 m_borderStyleCombo->SetStringSelection( DEFAULT_LINE_STYLE_LABEL );
148 else if( style < (int) lineTypeNames.size() )
149 m_borderStyleCombo->SetSelection( style );
150 else
151 wxFAIL_MSG( wxT( "Line type not found in the type lookup map" ) );
152
153 if( SYMBOL_EDIT_FRAME* symbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame ) )
154 {
155 m_rbFillNone->Enable( true );
156 m_rbFillOutline->Enable( true );
157 m_rbFillBackground->Enable( true );
158 m_rbFillCustom->Enable( true );
159 m_customColorSwatch->Enable( true );
160
161 if( m_shape->GetFillMode() == FILL_T::FILLED_SHAPE )
162 {
163 m_rbFillOutline->SetValue( true );
164
166
167 if( color == COLOR4D::UNSPECIFIED )
169
171 }
172 else if( m_shape->GetFillMode() == FILL_T::FILLED_WITH_BG_BODYCOLOR )
173 {
174 m_rbFillBackground->SetValue( true );
175
178 }
179 else if( m_shape->GetFillMode() == FILL_T::FILLED_WITH_COLOR )
180 {
181 m_rbFillCustom->SetValue( true );
183 }
184 else
185 {
186 m_rbFillNone->SetValue( true );
187 m_customColorSwatch->SetSwatchColor( COLOR4D::UNSPECIFIED, false );
188 }
189
190 const SYMBOL* symbol = m_shape->GetParentSymbol();
191
192 m_privateCheckbox->SetValue( m_shape->IsPrivate() );
193 m_checkApplyToAllUnits->SetValue( symbol->GetUnitCount() > 1 && m_shape->GetUnit() == 0 );
194 m_checkApplyToAllUnits->Enable( symbol->GetUnitCount() > 1 );
196
197 bool enableAlternateBodyStyle = symbol->HasAlternateBodyStyle();
198
199 // If a symbol contains no body-style-specific pins or graphic items,
200 // symbol->HasAlternateBodyStyle() will return false.
201 // But when creating a new symbol, with DeMorgan option set, the m_checkApplyToAllBodyStyles
202 // must be enabled in order to be able to create graphic items shared by all body styles.
203 if( symbolEditor->GetShowDeMorgan() )
204 enableAlternateBodyStyle = true;
205
206 m_checkApplyToAllBodyStyles->Enable( enableAlternateBodyStyle );
207 }
208 else
209 {
210 m_fillCtrl->SetSelection( m_shape->GetFillModeProp() );
212 }
213
214 return true;
215}
216
217
218void DIALOG_SHAPE_PROPERTIES::onBorderChecked( wxCommandEvent& event )
219{
220 bool border = m_borderCheckbox->GetValue();
221
222 if( border && m_borderWidth.GetValue() < 0 )
223 {
224 int defaultInMils;
225
226 if( SYMBOL_EDIT_FRAME* symbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame ) )
227 defaultInMils = symbolEditor->libeditconfig()->m_Defaults.line_width;
228 else
230
231 m_borderWidth.SetValue( schIUScale.MilsToIU( defaultInMils ) );
232 }
233
234 m_borderWidth.Enable( border );
235 m_borderColorLabel->Enable( border );
236 m_borderColorSwatch->Enable( border );
237 m_borderStyleLabel->Enable( border );
238 m_borderStyleCombo->Enable( border );
239}
240
241
242void DIALOG_SHAPE_PROPERTIES::onFillChoice( wxCommandEvent& event )
243{
244 m_fillColorLabel->Enable( m_fillCtrl->GetSelection() == UI_FILL_MODE::SOLID );
245 m_fillColorSwatch->Enable( m_fillCtrl->GetSelection() == UI_FILL_MODE::SOLID );
246}
247
248
250{
251 if( event.GetId() == NO_FILL )
252 {
253 m_rbFillNone->SetValue( true );
254 m_customColorSwatch->SetSwatchColor( COLOR4D::UNSPECIFIED, false );
255 }
256 else if( event.GetId() == FILLED_SHAPE )
257 {
258 m_rbFillOutline->SetValue( true );
259
261
262 if( color == COLOR4D::UNSPECIFIED || !m_rbFillOutline->GetValue() )
264
266 }
267 else if( event.GetId() == FILLED_WITH_BG_BODYCOLOR )
268 {
269 m_rbFillBackground->SetValue( true );
270
273 }
274 else if( event.GetId() == FILLED_WITH_COLOR )
275 {
276 m_rbFillCustom->SetValue( true );
278 }
279}
280
281
282void DIALOG_SHAPE_PROPERTIES::onBorderSwatch( wxCommandEvent& aEvent )
283{
284 if( m_rbFillOutline->GetValue() )
286
287 if( m_rbFillOutline->IsEnabled() && m_rbFillOutline->GetValue() )
288 {
289 COLOR4D color = COLOR4D::UNSPECIFIED;
290
291 if( m_rbFillOutline->GetValue() )
293
294 if( color == COLOR4D::UNSPECIFIED )
296
298 }
299}
300
301
303{
304 m_rbFillCustom->SetValue( true );
305}
306
307
309{
310 if( !wxDialog::TransferDataFromWindow() )
311 return false;
312
313 SCH_COMMIT commit( m_frame );
314
315 if( !m_shape->IsNew() )
316 commit.Modify( m_shape, m_frame->GetScreen() );
317
318 if( SCH_RULE_AREA* ruleArea = dynamic_cast<SCH_RULE_AREA*>( m_shape ) )
319 {
320 ruleArea->SetExcludedFromSim( m_cbExcludeFromSim->GetValue() );
321 ruleArea->SetExcludedFromBOM( m_cbExcludeFromBom->GetValue() );
322 ruleArea->SetExcludedFromBoard( m_cbExcludeFromBoard->GetValue() );
323 ruleArea->SetDNP( m_cbDNP->GetValue() );
324 }
325
326 STROKE_PARAMS stroke = m_shape->GetStroke();
327
328 if( m_borderCheckbox->GetValue() )
329 {
331 stroke.SetWidth( std::max( 0, m_borderWidth.GetIntValue() ) );
332 }
333 else
334 {
335 stroke.SetWidth( -1 );
336 }
337
338 auto it = lineTypeNames.begin();
339 std::advance( it, m_borderStyleCombo->GetSelection() );
340
341 if( it == lineTypeNames.end() )
342 stroke.SetLineStyle( LINE_STYLE::SOLID );
343 else
344 stroke.SetLineStyle( it->first );
345
347
348 m_shape->SetStroke( stroke );
349
350 if( SYMBOL_EDIT_FRAME* symbolEditor = dynamic_cast<SYMBOL_EDIT_FRAME*>( m_frame ) )
351 {
352 if( m_rbFillOutline->GetValue() )
353 m_shape->SetFillMode( FILL_T::FILLED_SHAPE );
354 else if( m_rbFillBackground->GetValue() )
355 m_shape->SetFillMode( FILL_T::FILLED_WITH_BG_BODYCOLOR );
356 else if( m_rbFillCustom->GetValue() )
357 m_shape->SetFillMode( FILL_T::FILLED_WITH_COLOR );
358 else
359 m_shape->SetFillMode( FILL_T::NO_FILL );
360
362
363 m_shape->SetPrivate( m_privateCheckbox->GetValue() );
364
365 if( m_checkApplyToAllBodyStyles->IsChecked() )
366 m_shape->SetBodyStyle( 0 );
367 else
368 m_shape->SetBodyStyle( symbolEditor->GetBodyStyle() );
369
370 if( m_checkApplyToAllUnits->IsChecked() )
371 m_shape->SetUnit( 0 );
372 else
373 m_shape->SetUnit( symbolEditor->GetUnit() );
374 }
375 else
376 {
377 m_shape->SetFillModeProp( (UI_FILL_MODE) m_fillCtrl->GetSelection() );
379 }
380
381 if( !commit.Empty() )
382 commit.Push( wxString::Format( _( "Edit %s" ), m_shape->GetFriendlyName() ) );
383
384 return true;
385}
386
387
int color
Definition: DXF_plotter.cpp:63
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:114
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Definition: bitmap.cpp:110
Color settings are a bit different than most of the settings objects in that there can be more than o...
bool GetOverrideSchItemColors() const
COLOR4D GetColor(int aLayer) const
void SetSwatchColor(const KIGFX::COLOR4D &aColor, bool aSendEvent)
Set the current swatch color directly.
void GetNewSwatchColor()
Prompt for a new colour, using the colour picker dialog.
KIGFX::COLOR4D GetSwatchColor() const
void SetDefaultColor(const KIGFX::COLOR4D &aColor)
Sets the color that will be chosen with the "Reset to Default" button in the chooser.
void SetSwatchBackground(const KIGFX::COLOR4D &aBackground)
Set the swatch background color.
bool Empty() const
Definition: commit.h:150
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
Definition: commit.h:107
DIALOG_SHAPE_PROPERTIES(SCH_BASE_FRAME *aParent, SCH_SHAPE *aShape)
void onBorderChecked(wxCommandEvent &aEvent) override
void onFillChoice(wxCommandEvent &event) override
void onFillRadioButton(wxCommandEvent &aEvent) override
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:66
void SetupStandardButtons(std::map< int, wxString > aLabels={})
std::string m_hash_key
Definition: dialog_shim.h:194
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
virtual wxString GetFriendlyName() const
Definition: eda_item.cpp:402
bool IsNew() const
Definition: eda_item.h:123
UI_FILL_MODE GetFillModeProp() const
Definition: eda_shape.cpp:559
void SetFillModeProp(UI_FILL_MODE)
Definition: eda_shape.cpp:546
FILL_T GetFillMode() const
Definition: eda_shape.h:142
void SetFillColor(const COLOR4D &aColor)
Definition: eda_shape.h:153
COLOR4D GetFillColor() const
Definition: eda_shape.h:152
virtual int GetWidth() const
Definition: eda_shape.h:156
void SetFillMode(FILL_T aFill)
Definition: eda_shape.cpp:539
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
wxColour ToColour() const
Definition: color4d.cpp:220
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
SCH_RENDER_SETTINGS * GetRenderSettings()
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
EESCHEMA_SETTINGS * eeconfig() const
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Returns a pointer to the active color theme settings.
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Execute the changes.
Definition: sch_commit.cpp:489
virtual void SetBodyStyle(int aBodyStyle)
Definition: sch_item.h:245
const SYMBOL * GetParentSymbol() const
Definition: sch_item.cpp:218
void SetPrivate(bool aPrivate)
Definition: sch_item.h:249
int GetBodyStyle() const
Definition: sch_item.h:246
int GetUnit() const
Definition: sch_item.h:242
bool IsPrivate() const
Definition: sch_item.h:250
virtual void SetUnit(int aUnit)
Definition: sch_item.h:241
void SetStroke(const STROKE_PARAMS &aStroke) override
Definition: sch_shape.cpp:61
STROKE_PARAMS GetStroke() const override
Definition: sch_shape.h:57
Simple container to manage line stroke parameters.
Definition: stroke_params.h:94
void SetLineStyle(LINE_STYLE aLineStyle)
void SetWidth(int aWidth)
void SetColor(const KIGFX::COLOR4D &aColor)
LINE_STYLE GetLineStyle() const
KIGFX::COLOR4D GetColor() const
The symbol library editor main window.
A base class for LIB_SYMBOL and SCH_SYMBOL.
Definition: symbol.h:63
virtual int GetUnitCount() const =0
virtual bool HasAlternateBodyStyle() const =0
Test if symbol has more than one body conversion type (DeMorgan).
int GetIntValue()
Definition: unit_binder.h:129
virtual long long int GetValue()
Return the current value in Internal Units.
void Enable(bool aEnable)
Enable/disable the label, widget and units label.
bool IsIndeterminate() const
Return true if the control holds the indeterminate value (for instance, if it represents a multiple s...
virtual void SetValue(long long int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: wx_infobar.cpp:154
#define _(s)
UI_FILL_MODE
Definition: eda_shape.h:68
@ LAYER_DEVICE
Definition: layer_ids.h:456
@ LAYER_DEVICE_BACKGROUND
Definition: layer_ids.h:474
@ LAYER_SCHEMATIC_BACKGROUND
Definition: layer_ids.h:478
KICOMMON_API wxFont GetInfoFont(wxWindow *aWindow)
Definition: ui_common.cpp:156
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:429
const std::map< LINE_STYLE, struct LINE_STYLE_DESC > lineTypeNames
Conversion map between LINE_STYLE values and style names displayed.
#define DEFAULT_LINE_STYLE_LABEL
Definition: stroke_params.h:85
constexpr int MilsToIU(int mils) const
Definition: base_units.h:97