KiCad PCB EDA Suite
Loading...
Searching...
No Matches
footprint_preview_panel.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) 2016-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 * Copyright (C) 2017 Chris Pavlina <[email protected]>
6 * Copyright (C) 2016 Tomasz Wlostowski <[email protected]>
7 *
8 * This program is free software: you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation, either version 3 of the License, or (at your
11 * option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#include <memory>
23#include <utility>
24
25#include "pcbnew_settings.h"
26#include <advanced_config.h>
27#include <base_units.h>
28#include <board.h>
29#include <footprint.h>
30#include <pcb_dimension.h>
31#include <dpi_scaling_common.h>
32#include <eda_draw_frame.h>
34#include <fp_lib_table.h>
36#include <kiway.h>
37#include <math/box2.h>
38#include <pcb_painter.h>
39#include <pcb_draw_panel_gal.h>
40#include <pcb_edit_frame.h>
41#include <pgm_base.h>
43#include <view/view.h>
44#include <wx/stattext.h>
45#include <zoom_defines.h>
46#include <dialog_shim.h>
47#include <project_pcb.h>
48
50 UNITS_PROVIDER* aUnitsProvider,
51 std::unique_ptr<KIGFX::GAL_DISPLAY_OPTIONS> aOpts,
52 GAL_TYPE aGalType ) :
53 PCB_DRAW_PANEL_GAL( aParent, -1, wxPoint( 0, 0 ), wxSize( 200, 200 ), *aOpts, aGalType ),
54 KIWAY_HOLDER( aKiway, KIWAY_HOLDER::PANEL ),
55 m_displayOptions( std::move( aOpts ) ),
56 m_currentFootprint( nullptr )
57{
58 SetStealsFocus( false );
59 ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
60 EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
61
62 m_userUnits = aUnitsProvider->GetUserUnits();
63
64 m_dummyBoard = std::make_unique<BOARD>();
65 m_dummyBoard->SetUserUnits( m_userUnits );
66 m_dummyBoard->SetBoardUse( BOARD_USE::FPHOLDER );
69
70 Raise();
71 Show( true );
73}
74
75
77{
79 {
81 GetView()->Clear();
82 m_currentFootprint->SetParent( nullptr );
83 }
84
86 {
88 GetView()->Clear();
89 m_otherFootprint->SetParent( nullptr );
90 }
91}
92
93
95{
96 KIGFX::PAINTER* painter = GetView()->GetPainter();
97 auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
98
99 return settings->GetBackgroundColor();
100}
101
102
104{
105 KIGFX::PAINTER* painter = GetView()->GetPainter();
106 auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
107
108 return settings->GetLayerColor( F_Fab );
109}
110
111
112void FOOTPRINT_PREVIEW_PANEL::renderFootprint( std::shared_ptr<FOOTPRINT> aFootprint )
113{
114 aFootprint->SetParent( m_dummyBoard.get() );
115
116 INSPECTOR_FUNC inspector =
117 [&]( EDA_ITEM* descendant, void* aTestData )
118 {
119 static_cast<PCB_DIMENSION_BASE*>( descendant )->UpdateUnits();
120 return INSPECT_RESULT::CONTINUE;
121 };
122
123 aFootprint->Visit( inspector, nullptr, { PCB_DIM_LEADER_T,
128
129 // Ensure we are not using the high contrast mode to display the selected footprint
130 KIGFX::PAINTER* painter = GetView()->GetPainter();
131 auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
132 settings->m_ContrastModeDisplay = HIGH_CONTRAST_MODE::NORMAL;
133
134 GetView()->Add( aFootprint.get() );
135 GetView()->SetVisible( aFootprint.get(), true );
136 GetView()->Update( aFootprint.get(), KIGFX::ALL );
137}
138
139
141{
142 BOX2I bbox = m_currentFootprint->GetBoundingBox( true, false );
143
144 if( bbox.GetSize().x > 0 && bbox.GetSize().y > 0 )
145 {
146 // Autozoom
147 GetView()->SetViewport( BOX2D( bbox.GetOrigin(), bbox.GetSize() ) );
148
149 // Add a margin
150 GetView()->SetScale( GetView()->GetScale() * 0.7 );
151
152 Refresh();
153 }
154}
155
156
158{
160 {
162 GetView()->Clear();
163 m_currentFootprint->SetParent( nullptr );
164 }
165
167
168 try
169 {
170 const FOOTPRINT* fp = fptbl->GetEnumeratedFootprint( aFPID.GetLibNickname(),
171 aFPID.GetLibItemName() );
172
173 if( fp )
174 m_currentFootprint.reset( static_cast<FOOTPRINT*>( fp->Duplicate() ) );
175 else
176 m_currentFootprint.reset();
177 }
178 catch( ... )
179 {
180 m_currentFootprint.reset();
181 }
182
184 {
187 }
188
189 ForceRefresh();
190
191 return m_currentFootprint != nullptr;
192}
193
194
195void FOOTPRINT_PREVIEW_PANEL::DisplayFootprints( std::shared_ptr<FOOTPRINT> aFootprintA,
196 std::shared_ptr<FOOTPRINT> aFootprintB )
197{
199 {
201 m_currentFootprint->SetParent( nullptr );
202
203 wxASSERT( m_otherFootprint );
204
205 GetView()->Remove( m_otherFootprint.get() );
206 m_otherFootprint->SetParent( nullptr );
207
208 GetView()->Clear();
209 }
210
211 m_currentFootprint = aFootprintA;
212 m_otherFootprint = aFootprintB;
213
215 {
216 wxASSERT( m_otherFootprint );
217
221 }
222
223 Layout();
224 Show();
225}
226
227
229{
231 ForceRefresh();
232}
233
234
236{
237 return static_cast<wxWindow*>( this );
238}
239
240
242 UNITS_PROVIDER* aUnitsProvider )
243{
244 PCBNEW_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
245
246 if( cfg->m_Window.grid.grids.empty() )
248
249 // Currently values read from config file are not used because the user cannot
250 // change this config
251 //if( cfg->m_Window.zoom_factors.empty() )
252 {
255 else
257 }
258
259 std::unique_ptr<GAL_DISPLAY_OPTIONS_IMPL> gal_opts;
260
261 gal_opts = std::make_unique<GAL_DISPLAY_OPTIONS_IMPL>();
262 gal_opts->ReadConfig( *Pgm().GetCommonSettings(), cfg->m_Window, aParent );
263
264 auto galType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
265 FOOTPRINT_PREVIEW_PANEL* panel = new FOOTPRINT_PREVIEW_PANEL( aKiway, aParent, aUnitsProvider,
266 std::move( gal_opts ), galType );
267
268 panel->UpdateColors();
269
270 const GRID_SETTINGS& gridCfg = cfg->m_Window.grid;
271
272 panel->GetGAL()->SetGridVisibility( gridCfg.show );
273
274 //Bounds checking cannot include number of elements as an index!
275 int gridIdx = alg::clamp( 0, gridCfg.last_size_idx, (int) gridCfg.grids.size() - 1 );
277 gridCfg.grids[gridIdx].x );
279 gridCfg.grids[gridIdx].y );
280 panel->GetGAL()->SetGridSize( VECTOR2D( gridSizeX, gridSizeY ) );
281
282 auto painter = static_cast<KIGFX::PCB_PAINTER*>( panel->GetView()->GetPainter() );
283 auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
284 settings->SetHighlight( false );
285 settings->SetNetColorMode( NET_COLOR_MODE::OFF );
286
287 return panel;
288}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:109
@ OFF
Net (and netclass) colors are not shown.
BOX2< VECTOR2D > BOX2D
Definition: box2.h:854
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
WINDOW_SETTINGS m_Window
Definition: app_settings.h:169
const std::vector< GRID > DefaultGridSizeList() const
const Vec & GetOrigin() const
Definition: box2.h:184
const Vec & GetSize() const
Definition: box2.h:180
void ForceRefresh()
Force a redraw.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void StartDrawing()
Begin drawing if it was stopped previously.
void SetStealsFocus(bool aStealsFocus)
Set whether focus is taken on certain events (mouseover, keys, etc).
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
virtual INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:91
Panel that renders a single footprint via Cairo GAL, meant to be exported through Kiface.
void renderFootprint(std::shared_ptr< FOOTPRINT > aFootprint)
std::shared_ptr< FOOTPRINT > m_currentFootprint
virtual wxWindow * GetWindow() override
Get the underlying wxWindow.
virtual void DisplayFootprints(std::shared_ptr< FOOTPRINT > aFootprintA, std::shared_ptr< FOOTPRINT > aFootprintB) override
Display a pair of footprints.
virtual void RefreshAll() override
Force the redrawing of all contents.
std::shared_ptr< FOOTPRINT > m_otherFootprint
virtual const KIGFX::COLOR4D & GetBackgroundColor() const override
Get the colors to use in a preview widget to match the preview panel.
virtual bool DisplayFootprint(const LIB_ID &aFPID) override
Set the currently displayed footprint.
std::unique_ptr< BOARD > m_dummyBoard
static FOOTPRINT_PREVIEW_PANEL * New(KIWAY *aKiway, wxWindow *aParent, UNITS_PROVIDER *aUnitsProvider)
virtual const KIGFX::COLOR4D & GetForegroundColor() const override
FOOTPRINT_PREVIEW_PANEL(KIWAY *aKiway, wxWindow *aParent, UNITS_PROVIDER *aUnitsProvider, std::unique_ptr< KIGFX::GAL_DISPLAY_OPTIONS > aOpts, GAL_TYPE aGalType)
Create a new panel.
BOARD_ITEM * Duplicate() const override
Create a copy of this BOARD_ITEM.
Definition: footprint.cpp:2097
const FOOTPRINT * GetEnumeratedFootprint(const wxString &aNickname, const wxString &aFootprintName)
A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
void SetGridSize(const VECTOR2D &aGridSize)
Set the grid size.
void SetGridVisibility(bool aVisibility)
Set the visibility setting of the grid.
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition: painter.h:59
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:163
PCB specific render settings.
Definition: pcb_painter.h:76
const COLOR4D & GetBackgroundColor() const override
Return current background color settings.
Definition: pcb_painter.h:104
HIGH_CONTRAST_MODE m_ContrastModeDisplay
Definition: pcb_painter.h:130
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: pcb_view.cpp:77
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Add a VIEW_ITEM to the view.
Definition: pcb_view.cpp:59
virtual void Remove(VIEW_ITEM *aItem) override
Remove a VIEW_ITEM from the view.
Definition: pcb_view.cpp:68
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
void SetHighlight(bool aEnabled, int aNetcode=-1, bool aMulti=false)
Turns on/off highlighting.
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Set the scaling factor, zooming around a given anchor point.
Definition: view.cpp:547
void SetViewport(const BOX2D &aViewport)
Set the visible area of the VIEW.
Definition: view.cpp:519
void Clear()
Remove all items from the view.
Definition: view.cpp:1115
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Definition: view.cpp:1500
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:215
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Set the item visibility.
Definition: view.cpp:1545
A mix in class which holds the location of a wxWindow's KIWAY.
Definition: kiway_holder.h:37
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
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
Abstract dimension API.
void UpdateColors()
Update the color settings in the painter and GAL.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void SyncLayersVisibility(const BOARD *aBoard)
Update "visibility" property of each layer of a given BOARD.
static FP_LIB_TABLE * PcbFootprintLibs(PROJECT *aProject)
Return the table of footprint libraries without Kiway.
Definition: project_pcb.cpp:37
EDA_UNITS GetUserUnits() const
std::function< INSPECT_RESULT(EDA_ITEM *aItem, void *aTestData) > INSPECTOR_FUNC
Used to inspect and possibly collect the (search) results of iterating over a list or tree of KICAD_T...
Definition: eda_item.h:75
bool m_HyperZoom
Slide the zoom steps over for debugging things "up close".
@ F_Fab
Definition: layer_ids.h:121
KICOMMON_API double DoubleValueFromString(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Function DoubleValueFromString converts aTextValue to a double.
Definition: eda_units.cpp:565
@ REPAINT
Item needs to be redrawn.
Definition: view_item.h:57
@ ALL
All except INITIAL_ADD.
Definition: view_item.h:58
T clamp(T min, T value, T max)
Definition: kicad_algo.h:205
STL namespace.
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
see class PGM_BASE
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:119
std::vector< GRID > grids
Definition: grid_settings.h:66
GRID_SETTINGS grid
Definition: app_settings.h:81
std::vector< double > zoom_factors
Definition: app_settings.h:78
@ PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
Definition: typeinfo.h:103
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:100
@ PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
Definition: typeinfo.h:101
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition: typeinfo.h:99
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
Definition: typeinfo.h:102
VECTOR2< double > VECTOR2D
Definition: vector2d.h:587
#define ZOOM_LIST_PCBNEW
Definition: zoom_defines.h:32
#define ZOOM_LIST_PCBNEW_HYPER
Definition: zoom_defines.h:35