KiCad PCB EDA Suite
Loading...
Searching...
No Matches
symbol_preview_widget.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) 2018-2021 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
21#include <sch_view.h>
24#include <math/vector2wx.h>
25#include <symbol_lib_table.h>
26#include <sch_preview_panel.h>
27#include <pgm_base.h>
28#include <sch_painter.h>
29#include <eda_draw_frame.h>
30#include <project_sch.h>
31#include <eeschema_settings.h>
33#include <wx/log.h>
34#include <wx/stattext.h>
35
36
37SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET( wxWindow* aParent, KIWAY* aKiway, bool aIncludeStatus,
38 EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType ) :
39 wxPanel( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize, 0 ),
40 m_kiway( aKiway ),
41 m_preview( nullptr ),
42 m_status( nullptr ),
43 m_statusPanel( nullptr ),
44 m_statusSizer( nullptr ),
45 m_previewItem( nullptr )
46{
47 auto common_settings = Pgm().GetCommonSettings();
48 auto app_settings = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
49
50 m_galDisplayOptions.ReadConfig( *common_settings, app_settings->m_Window, this );
52
53 EDA_DRAW_PANEL_GAL::GAL_TYPE canvasType = aCanvasType;
54
55 // Allows only a CAIRO or OPENGL canvas:
57 && canvasType != EDA_DRAW_PANEL_GAL::GAL_FALLBACK )
58 {
60 }
61
62 m_preview = new SCH_PREVIEW_PANEL( this, wxID_ANY, wxDefaultPosition, wxSize( -1, -1 ),
63 m_galDisplayOptions, canvasType );
64 m_preview->SetStealsFocus( false );
65 m_preview->ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
66 m_preview->GetGAL()->SetAxesEnabled( false );
67
68 // Do not display the grid: the look is not good for a small canvas area.
69 // But mainly, due to some strange bug I (JPC) was unable to fix, the grid creates
70 // strange artifacts on Windows when Eeschema is run from KiCad manager (but not in
71 // stand alone...).
73
74 // Early initialization of the canvas background color,
75 // before any OnPaint event is fired for the canvas using a wrong bg color
76 KIGFX::VIEW* view = m_preview->GetView();
77 auto settings = static_cast<SCH_RENDER_SETTINGS*>( view->GetPainter()->GetSettings() );
78
79 if( auto* theme = Pgm().GetSettingsManager().GetColorSettings( app_settings->m_ColorTheme ) )
80 settings->LoadColors( theme );
81
82 const COLOR4D& backgroundColor = settings->GetBackgroundColor();
83 const COLOR4D& foregroundColor = settings->GetCursorColor();
84
85 m_preview->GetGAL()->SetClearColor( backgroundColor );
86
87 settings->m_ShowPinsElectricalType = app_settings->m_LibViewPanel.show_pin_electrical_type;
88 settings->m_ShowPinNumbers = app_settings->m_LibViewPanel.show_pin_numbers;
89 settings->m_ShowHiddenPins = false;
90 settings->m_ShowHiddenFields = false;
91
92 m_outerSizer = new wxBoxSizer( wxVERTICAL );
93
94 if( aIncludeStatus )
95 {
96 m_statusPanel = new wxPanel( this );
97 m_statusPanel->SetBackgroundColour( backgroundColor.ToColour() );
98 m_status = new wxStaticText( m_statusPanel, wxID_ANY, wxEmptyString );
99 m_status->SetForegroundColour( settings->GetLayerColor( LAYER_REFERENCEPART ).ToColour() );
100 m_statusSizer = new wxBoxSizer( wxVERTICAL );
101 m_statusSizer->Add( 0, 0, 1 ); // add a spacer
102 m_statusSizer->Add( m_status, 0, wxALIGN_CENTER );
103 m_statusSizer->Add( 0, 0, 1 ); // add a spacer
104 m_statusPanel->SetSizer( m_statusSizer );
105
106 // Give the status panel the same color scheme as the canvas so it isn't jarring when
107 // switched to.
108 m_statusPanel->SetBackgroundColour( backgroundColor.ToColour() );
109 m_statusPanel->SetForegroundColour( foregroundColor.ToColour() );
110
111 // Give the preview panel a small top border to align its top with the status panel,
112 // and give the status panel a small bottom border to align its bottom with the preview
113 // panel.
114 m_outerSizer->Add( m_preview, 1, wxTOP | wxEXPAND, 5 );
115 m_outerSizer->Add( m_statusPanel, 1, wxBOTTOM | wxEXPAND, 5 );
116
117 // Hide the status panel to start
118 m_statusPanel->Hide();
119 }
120 else
121 {
122 m_outerSizer->Add( m_preview, 1, wxEXPAND, 0 );
123 }
124
125 SetSizer( m_outerSizer );
126 Layout();
127
128 Connect( wxEVT_SIZE, wxSizeEventHandler( SYMBOL_PREVIEW_WIDGET::onSize ), nullptr, this );
129}
130
131
133{
134 if( m_previewItem )
136
137 delete m_previewItem;
138}
139
140
141void SYMBOL_PREVIEW_WIDGET::SetStatusText( wxString const& aText )
142{
143 wxCHECK( m_statusPanel, /* void */ );
144
145 m_status->SetLabel( aText );
146 m_preview->Hide();
147 m_statusPanel->Show();
148 Layout();
149}
150
151
152void SYMBOL_PREVIEW_WIDGET::onSize( wxSizeEvent& aEvent )
153{
154 if( m_previewItem )
155 {
158 }
159
160 aEvent.Skip();
161}
162
163
165{
166 if( !m_previewItem )
167 return;
168
169 // set the view scale to fit the item on screen
170 KIGFX::VIEW* view = m_preview->GetView();
171
172 // Calculate the drawing area size, in internal units, for a scaling factor = 1.0
173 view->SetScale( 1.0 );
174 VECTOR2D clientSize = view->ToWorld( ToVECTOR2D( m_preview->GetClientSize() ), false );
175 // Calculate the draw scale to fit the drawing area
176 double scale = std::min( fabs( clientSize.x / m_itemBBox.GetWidth() ),
177 fabs( clientSize.y / m_itemBBox.GetHeight() ) );
178
179 // Above calculation will yield an exact fit; add a bit of whitespace around symbol
180 scale /= 1.2;
181
182 // Now fix the best scale
183 view->SetScale( scale );
184 view->SetCenter( m_itemBBox.Centre() );
185}
186
187
188void SYMBOL_PREVIEW_WIDGET::DisplaySymbol( const LIB_ID& aSymbolID, int aUnit, int aBodyStyle )
189{
190 KIGFX::VIEW* view = m_preview->GetView();
191 auto settings = static_cast<SCH_RENDER_SETTINGS*>( view->GetPainter()->GetSettings() );
192 std::unique_ptr< LIB_SYMBOL > symbol;
193
194 try
195 {
197
198 if( tmp )
199 symbol = tmp->Flatten();
200 }
201 catch( const IO_ERROR& ioe )
202 {
203 wxLogError( _( "Error loading symbol %s from library '%s'." ) + wxS( "\n%s" ),
204 aSymbolID.GetLibItemName().wx_str(),
205 aSymbolID.GetLibNickname().wx_str(),
206 ioe.What() );
207 }
208
209 if( m_previewItem )
210 {
211 view->Remove( m_previewItem );
212 delete m_previewItem;
213 m_previewItem = nullptr;
214 }
215
216 if( symbol )
217 {
218 // This will flatten derived parts so that the correct final symbol can be shown.
219 m_previewItem = symbol.release();
220
221 // Hide fields that were added automatically by the library (for example, when using
222 // database libraries) as they don't have a valid position yet, and we don't support
223 // autoplacing fields on library symbols yet.
224 std::vector<SCH_FIELD*> previewFields;
225 m_previewItem->GetFields( previewFields );
226
227 for( SCH_FIELD* field : previewFields )
228 {
229 if( field->IsAutoAdded() )
230 field->SetVisible( false );
231 }
232
233 // If unit isn't specified for a multi-unit part, pick the first. (Otherwise we'll
234 // draw all of them.)
235 settings->m_ShowUnit = ( m_previewItem->IsMulti() && aUnit == 0 ) ? 1 : aUnit;
236
237 // For symbols having a De Morgan body style, use the first style
238 settings->m_ShowBodyStyle =
239 ( m_previewItem->HasAlternateBodyStyle() && aBodyStyle == 0 ) ? 1 : aBodyStyle;
240
241 view->Add( m_previewItem );
242
243 // Get the symbol size, in internal units
244 m_itemBBox = m_previewItem->GetUnitBoundingBox( settings->m_ShowUnit,
245 settings->m_ShowBodyStyle );
246
247 if( !m_preview->IsShownOnScreen() )
248 {
249 m_preview->Show();
250
251 if( m_statusPanel )
252 m_statusPanel->Hide();
253
254 Layout(); // Ensure panel size is up to date.
255 }
256
257 // Calculate the draw scale to fit the drawing area
259 }
260
262}
263
264
265void SYMBOL_PREVIEW_WIDGET::DisplayPart( LIB_SYMBOL* aSymbol, int aUnit, int aBodyStyle )
266{
267 KIGFX::VIEW* view = m_preview->GetView();
268
269 if( m_previewItem )
270 {
271 view->Remove( m_previewItem );
272 delete m_previewItem;
273 m_previewItem = nullptr;
274 }
275
276 if( aSymbol )
277 {
278 m_previewItem = new LIB_SYMBOL( *aSymbol );
279
280 // For symbols having a De Morgan body style, use the first style
281 auto settings = static_cast<SCH_RENDER_SETTINGS*>( view->GetPainter()->GetSettings() );
282
283 // If unit isn't specified for a multi-unit part, pick the first. (Otherwise we'll
284 // draw all of them.)
285 settings->m_ShowUnit = ( m_previewItem->IsMulti() && aUnit == 0 ) ? 1 : aUnit;
286
287 settings->m_ShowBodyStyle =
288 ( m_previewItem->HasAlternateBodyStyle() && aBodyStyle == 0 ) ? 1 : aBodyStyle;
289
290 view->Add( m_previewItem );
291
292 // Get the symbol size, in internal units
293 m_itemBBox = aSymbol->GetUnitBoundingBox( settings->m_ShowUnit, settings->m_ShowBodyStyle );
294
295 // Calculate the draw scale to fit the drawing area
297 }
298
300 m_preview->Show();
301
302 if( m_statusPanel )
303 m_statusPanel->Hide();
304
305 Layout();
306}
coord_type GetHeight() const
Definition: box2.h:189
coord_type GetWidth() const
Definition: box2.h:188
Vec Centre() const
Definition: box2.h:71
static constexpr GAL_TYPE GAL_FALLBACK
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
void ForceRefresh()
Force a redraw.
@ GAL_TYPE_OPENGL
OpenGL implementation.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void SetStealsFocus(bool aStealsFocus)
Set whether focus is taken on certain events (mouseover, keys, etc).
void ReadConfig(COMMON_SETTINGS &aCommonConfig, WINDOW_SETTINGS &aWindowConfig, wxWindow *aWindow)
Read application and common configs.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
wxColour ToColour() const
Definition: color4d.cpp:220
bool m_forceDisplayCursor
The pixel scale factor (>1 for hi-DPI scaled displays)
void SetAxesEnabled(bool aAxesEnabled)
Enable drawing the axes.
void SetClearColor(const COLOR4D &aColor)
void SetGridVisibility(bool aVisibility)
Set the visibility setting of the grid.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Set the scaling factor, zooming around a given anchor point.
Definition: view.cpp:552
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:315
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:354
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:449
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:215
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:578
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:196
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
const UTF8 & GetLibItemName() const
Definition: lib_id.h:102
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:87
Define a library symbol object.
Definition: lib_symbol.h:78
bool IsMulti() const override
Definition: lib_symbol.h:543
const BOX2I GetUnitBoundingBox(int aUnit, int aBodyStyle, bool aIgnoreHiddenFields=true) const
Get the bounding box for the symbol.
void GetFields(std::vector< SCH_FIELD * > &aList)
Return a list of fields within this symbol.
bool HasAlternateBodyStyle() const override
Test if symbol has more than one body conversion type (DeMorgan).
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
Definition: lib_symbol.cpp:569
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition: pgm_base.cpp:678
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:142
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:51
void LoadColors(const COLOR_SETTINGS *aSettings) override
T * GetAppSettings()
Returns a handle to the a given settings by type If the settings have already been loaded,...
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
LIB_SYMBOL * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_SYMBOL having aName from the library given by aNickname.
LIB_SYMBOL * m_previewItem
A local copy of the LIB_SYMBOL to display on the canvas.
SYMBOL_PREVIEW_WIDGET(wxWindow *aParent, KIWAY *aKiway, bool aIncludeStatus, EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Construct a symbol preview widget.
void SetStatusText(const wxString &aText)
Set the contents of the status label and display it.
EDA_DRAW_PANEL_GAL * m_preview
void onSize(wxSizeEvent &aEvent)
BOX2I m_itemBBox
The bounding box of the current item.
GAL_DISPLAY_OPTIONS_IMPL m_galDisplayOptions
void DisplaySymbol(const LIB_ID &aSymbolID, int aUnit, int aBodyStyle=0)
Set the currently displayed symbol.
void DisplayPart(LIB_SYMBOL *aSymbol, int aUnit, int aBodyStyle=0)
wxString wx_str() const
Definition: utf8.cpp:45
#define _(s)
@ LAYER_REFERENCEPART
Definition: layer_ids.h:364
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1059
see class PGM_BASE
const int scale
VECTOR2D ToVECTOR2D(const wxPoint &aPoint)
Definition: vector2wx.h:40