KiCad PCB EDA Suite
pcb_draw_panel_gal.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) 2014-2017 CERN
5  * @author Maciej Suminski <maciej.suminski@cern.ch>
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 #include "pcb_draw_panel_gal.h"
26 #include <pcb_view.h>
27 #include <view/wx_view_controls.h>
28 #include <pcb_painter.h>
29 #include <ws_proxy_view_item.h>
30 #include <ratsnest_viewitem.h>
31 #include <ratsnest_data.h>
33 
34 #include <colors_design_settings.h>
35 #include <class_board.h>
36 #include <class_module.h>
37 #include <class_track.h>
38 #include <class_marker_pcb.h>
39 #include <pcb_base_frame.h>
40 #include <confirm.h>
41 
43 
44 #include <functional>
45 #include <memory>
46 #include <thread>
47 using namespace std::placeholders;
48 
50 {
53  LAYER_DRC,
56 
59 
64 
67 
98 
101 
104 };
105 
106 
107 PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
108  const wxPoint& aPosition, const wxSize& aSize,
109  KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
110  EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
111 {
112  m_view = new KIGFX::PCB_VIEW( true );
113  m_view->SetGAL( m_gal );
114 
115  m_painter = std::make_unique<KIGFX::PCB_PAINTER>( m_gal );
116  m_view->SetPainter( m_painter.get() );
117 
120 
121  // View controls is the first in the event handler chain, so the Tool Framework operates
122  // on updated viewport data.
124 
125  // Load display options (such as filled/outline display of items).
126  // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
127  // which is not always the case (namely when it is used from a wxDialog like the pad editor)
128  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
129 
130  if( frame )
131  static_cast<KIGFX::PCB_VIEW*>( m_view )->UpdateDisplayOptions(
132  frame->GetDisplayOptions() );
133 }
134 
135 
137 {
138 }
139 
140 
142 {
143 
144  m_view->Clear();
145 
146  auto zones = aBoard->Zones();
147  std::atomic<size_t> next( 0 );
148  std::atomic<size_t> count_done( 0 );
149  size_t parallelThreadCount = std::max<size_t>( std::thread::hardware_concurrency(), 2 );
150 
151  for( size_t ii = 0; ii < parallelThreadCount; ++ii )
152  {
153  std::thread t = std::thread( [ &count_done, &next, &zones ]( )
154  {
155  for( size_t i = next.fetch_add( 1 ); i < zones.size(); i = next.fetch_add( 1 ) )
156  zones[i]->CacheTriangulation();
157 
158  count_done++;
159  } );
160 
161  t.detach();
162  }
163 
164  if( m_worksheet )
165  m_worksheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
166 
167  // Load drawings
168  for( auto drawing : const_cast<BOARD*>(aBoard)->Drawings() )
169  m_view->Add( drawing );
170 
171  // Load tracks
172  for( auto track : aBoard->Tracks() )
173  m_view->Add( track );
174 
175  // Load modules and its additional elements
176  for( auto module : aBoard->Modules() )
177  m_view->Add( module );
178 
179  // DRC markers
180  for( int marker_idx = 0; marker_idx < aBoard->GetMARKERCount(); ++marker_idx )
181  {
182  m_view->Add( aBoard->GetMARKER( marker_idx ) );
183  }
184 
185  // Finalize the triangulation threads
186  while( count_done < parallelThreadCount )
187  std::this_thread::sleep_for( std::chrono::milliseconds( 10 ) );
188 
189  // Load zones
190  for( auto zone : aBoard->Zones() )
191  m_view->Add( zone );
192 
193  // Ratsnest
194  m_ratsnest = std::make_unique<KIGFX::RATSNEST_VIEWITEM>( aBoard->GetConnectivity() );
195  m_view->Add( m_ratsnest.get() );
196 }
197 
198 
200 {
201  m_worksheet.reset( aWorksheet );
202  m_view->Add( m_worksheet.get() );
203 }
204 
205 
207 {
209  rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
210  rs->ImportLegacyColors( aSettings );
211  m_gal->SetGridColor( aSettings->GetLayerColor( LAYER_GRID ) );
212  m_gal->SetCursorColor( aSettings->GetItemColor( LAYER_CURSOR ) );
213 }
214 
215 
217 {
218  // Set display settings for high contrast mode
220 
221  SetTopLayer( aLayer );
222 
223  rSettings->ClearActiveLayers();
224  rSettings->SetActiveLayer( aLayer );
225 
226  if( IsCopperLayer( aLayer ) )
227  {
228  // Bring some other layers to the front in case of copper layers and make them colored
229  // fixme do not like the idea of storing the list of layers here,
230  // should be done in some other way I guess..
231  LAYER_NUM layers[] = {
232  GetNetnameLayer( aLayer ),
237  };
238 
239  for( unsigned int i : layers )
240  rSettings->SetActiveLayer( i );
241 
242  // Pads should be shown too
243  if( aLayer == B_Cu )
244  {
245  rSettings->SetActiveLayer( LAYER_PAD_BK );
246  rSettings->SetActiveLayer( LAYER_MOD_BK );
248  }
249  else if( aLayer == F_Cu )
250  {
251  rSettings->SetActiveLayer( LAYER_PAD_FR );
252  rSettings->SetActiveLayer( LAYER_MOD_FR );
254  }
255  }
256 
258 }
259 
260 
262 {
265  m_view->SetTopLayer( aLayer );
266 
267  // Layers that should always have on-top attribute enabled
268  const std::vector<LAYER_NUM> layers = {
273  };
274 
275  for( auto layer : layers )
276  m_view->SetTopLayer( layer );
277 
278  // Extra layers that are brought to the top if a F.* or B.* is selected
279  const std::vector<LAYER_NUM> frontLayers = {
282  };
283 
284  const std::vector<LAYER_NUM> backLayers = {
287  };
288 
289  const std::vector<LAYER_NUM>* extraLayers = NULL;
290 
291  // Bring a few more extra layers to the top depending on the selected board side
292  if( IsFrontLayer( aLayer ) )
293  extraLayers = &frontLayers;
294  else if( IsBackLayer( aLayer ) )
295  extraLayers = &backLayers;
296 
297  if( extraLayers )
298  {
299  for( auto layer : *extraLayers )
300  m_view->SetTopLayer( layer );
301 
302  // Move the active layer to the top
303  if( !IsCopperLayer( aLayer ) )
305  }
306  else if( IsCopperLayer( aLayer ) )
307  {
308  // Display labels for copper layers on the top
309  m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
310  }
311 
312  m_view->EnableTopLayer( true );
314 }
315 
316 
318 {
319  // Load layer & elements visibility settings
320  for( LAYER_NUM i = 0; i < PCB_LAYER_ID_COUNT; ++i )
321  m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
322 
324  m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
325 
326  // Always enable netname layers, as their visibility is controlled by layer dependencies
328  m_view->SetLayerVisible( i, true );
329 
330  // Enable some layers that are GAL specific
336 }
337 
338 
339 void PCB_DRAW_PANEL_GAL::GetMsgPanelInfo( EDA_UNITS aUnits, std::vector<MSG_PANEL_ITEM>& aList )
340 {
341  BOARD* board = static_cast<PCB_BASE_FRAME*>( m_parent )->GetBoard();
342  wxString txt;
343  int viasCount = 0;
344  int trackSegmentsCount = 0;
345 
346  for( auto item : board->Tracks() )
347  {
348  if( item->Type() == PCB_VIA_T )
349  viasCount++;
350  else
351  trackSegmentsCount++;
352  }
353 
354  txt.Printf( wxT( "%d" ), board->GetPadCount() );
355  aList.emplace_back( _( "Pads" ), txt, DARKGREEN );
356 
357  txt.Printf( wxT( "%d" ), viasCount );
358  aList.emplace_back( _( "Vias" ), txt, DARKGREEN );
359 
360  txt.Printf( wxT( "%d" ), trackSegmentsCount );
361  aList.emplace_back( _( "Track Segments" ), txt, DARKGREEN );
362 
363  txt.Printf( wxT( "%d" ), board->GetNodesCount() );
364  aList.emplace_back( _( "Nodes" ), txt, DARKCYAN );
365 
366  txt.Printf( wxT( "%d" ), board->GetNetCount() - 1 /* don't include "No Net" in count */ );
367  aList.emplace_back( _( "Nets" ), txt, RED );
368 
369  txt.Printf( wxT( "%d" ), board->GetConnectivity()->GetUnconnectedCount() );
370  aList.emplace_back( _( "Unrouted" ), txt, BLUE );
371 }
372 
373 
375 {
376  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParent() );
377 
378  try
379  {
380  // Check if the current rendering backend can be properly initialized
381  m_view->UpdateItems();
382  }
383  catch( const std::runtime_error& e )
384  {
385  // Fallback to software renderer
386  DisplayError( frame, e.what() );
388 
389  if( frame )
390  frame->ActivateGalCanvas();
391  }
392 
393  if( frame )
394  {
395  SetTopLayer( frame->GetActiveLayer() );
396  KIGFX::PAINTER* painter = m_view->GetPainter();
397  auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
398  settings->LoadDisplayOptions( frame->GetDisplayOptions(), frame->ShowPageLimits() );
399  }
400 }
401 
402 
404 {
405  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
406  {
407  LAYER_NUM layer = GAL_LAYER_ORDER[i];
408  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
409 
410  m_view->SetLayerOrder( layer, i );
411  }
412 }
413 
414 
416 {
417  bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
419  m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
420  return rv;
421 }
422 
423 
425 {
426  if( m_ratsnest )
427  m_view->Update( m_ratsnest.get() );
428 }
429 
430 
432 {
434  return m_worksheet->ViewBBox();
435 
436  return BOX2I();
437 }
438 
439 
441 {
442  // caching makes no sense for Cairo and other software renderers
444 
445  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
446  m_view->SetLayerTarget( i, target );
447 
448  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
449  {
450  LAYER_NUM layer = GAL_LAYER_ORDER[i];
451  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
452 
453  // Set layer display dependencies & targets
454  if( IsCopperLayer( layer ) )
455  m_view->SetRequired( GetNetnameLayer( layer ), layer );
456  else if( IsNetnameLayer( layer ) )
457  m_view->SetLayerDisplayOnly( layer );
458  }
459 
462 
463  // Some more required layers settings
469 
470  // Front modules
474 
475  // Back modules
479 
486 
491 }
492 
493 
495 {
496  return static_cast<KIGFX::PCB_VIEW*>( m_view );
497 }
Definition: colors.h:57
EDA_UNITS
Definition: common.h:72
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
CITER next(CITER it)
Definition: ptree.cpp:130
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
to draw blind/buried vias
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
Class that draws missing connections on a PCB.
int GetMARKERCount() const
Function GetMARKERCount.
Definition: class_board.h:343
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
void SetRequired(int aLayerId, int aRequiredId, bool aRequired=true)
Function SetRequired() Marks the aRequiredId layer as required for the aLayerId layer.
Definition: view.cpp:416
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:664
GAL_TYPE m_backend
Currently used GAL.
virtual void SetTopLayer(int aLayer, bool aEnabled=true)
Function SetTopLayer() Sets given layer to be displayed on the top or sets back the default order of ...
Definition: view.cpp:860
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
Definition: painter.h:56
multilayer pads, usually with holes
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
This file is part of the common library.
Handle colors used to draw all items or layers.
void GetMsgPanelInfo(EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
WX_VIEW_CONTROLS is a specific implementation of class VIEW_CONTROLS for wxWidgets library.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
handle color for not plated holes (holes, not pads)
anchor of items having an anchor point (texts, footprints)
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
void setDefaultLayerOrder()
Reassigns layer order to the initial settings.
Class that computes missing connections on a PCB.
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
to draw via holes (pad holes do not use this layer)
show modules values (when texts are visibles)
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers.
Definition: view.cpp:927
Add new GAL layers here.
const wxString & GetFileName() const
Definition: class_board.h:215
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Function GetDisplayOptions returns the display options current in use Display options are relative to...
void ImportLegacyColors(const COLORS_DESIGN_SETTINGS *aSettings) override
Function ImportLegacyColors Loads a list of color settings for layers.
Definition: pcb_painter.cpp:79
virtual void EnableTopLayer(bool aEnable)
Function EnableTopLayer() Enables or disables display of the top layer.
Definition: view.cpp:887
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
WX_VIEW_CONTROLS class definition.
void RedrawRatsnest()
Forces refresh of the ratsnest visual representation
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:701
void SetActiveLayer(int aLayerId, bool aEnabled=true)
Function SetActiveLayer Sets the specified layer as active - it means that it can be drawn in a speci...
Definition: painter.h:76
const LAYER_NUM GAL_LAYER_ORDER[]
Definitions for tracks, vias and zones.
bool ShowPageLimits() const
Auxiliary rendering target (noncached)
Definition: definitions.h:49
Classes used in Pcbnew, CvPcb and GerbView.
COLOR4D GetItemColor(int aItemIdx) const
Function GetItemColor.
show modules on front
std::unique_ptr< KIGFX::RATSNEST_VIEWITEM > m_ratsnest
Ratsnest view item
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
PCB_RENDER_SETTINGS Stores PCB specific render settings.
Definition: pcb_painter.h:61
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Function SetLayerTarget() Changes the rendering target for a particular layer.
Definition: view.h:434
COLOR4D GetLayerColor(LAYER_NUM aLayer) const
Function GetLayerColor.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
Markers used to show a drc problem on boards.
wxWindow * m_parent
Current mouse cursor shape id.
PCB_LAYER_ID
A quick note on layer IDs:
PAINTER contains all the knowledge about how to draw graphical object onto any particular output devi...
Definition: painter.h:313
virtual void ActivateGalCanvas() override
#define NULL
unsigned GetNodesCount(int aNet=-1)
Function GetNodesCount.
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:766
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
Definition: painter.h:98
MODULES & Modules()
Definition: class_board.h:226
void DisplayBoard(BOARD *aBoard)
Function DisplayBoard adds all items from the current board to the VIEW, so they can be displayed by ...
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1111
std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEM > m_worksheet
Currently used worksheet
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Definition: view.h:422
to draw usual through hole vias
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:300
PCB_DRAW_PANEL_GAL(wxWindow *aParentWindow, wxWindowID aWindowId, const wxPoint &aPosition, const wxSize &aSize, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType=GAL_TYPE_OPENGL)
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
Definition: colors.h:60
void SetLayerVisible(int aLayer, bool aVisible=true)
Function SetLayerVisible() Controls the visibility of a particular layer.
Definition: view.h:399
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1421
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
void SyncLayersVisibility(const BOARD *aBoard)
Function SyncLayersVisibility Updates "visibility" property of each layer of a given BOARD.
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1540
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
unsigned GetPadCount()
Function GetPadCount.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
BOX2I GetDefaultViewBBox() const override
void UseColorScheme(const COLORS_DESIGN_SETTINGS *aSettings)
Function UseColorScheme Applies layer color settings.
void ClearTopLayers()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:912
virtual void SetHighContrastLayer(int aLayer) override
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
MARKER_PCB * GetMARKER(int index) const
Function GetMARKER returns the MARKER at a given index.
Definition: class_board.h:331
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Function IsElementVisible tests whether a given element category is visible.
bool SwitchBackend(GAL_TYPE aGalType) override
Function SwitchBackend Switches method of rendering graphics.
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:449
ZONE_CONTAINERS & Zones()
Definition: class_board.h:240
smd pads, front layer
void SetWorksheet(KIGFX::WS_PROXY_VIEW_ITEM *aWorksheet)
Function SetWorksheet Sets (or updates) worksheet used by the draw panel.
Main rendering target (cached)
Definition: definitions.h:48
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:160
#define _(s)
Definition: 3d_actions.cpp:31
int GetLayerOrder(int aLayer) const
Function GetLayerOrder() Returns rendering order of a particular layer.
Definition: view.cpp:672
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
currently selected items overlay
COLORS_DESIGN_SETTINGS is a list of color settings for designs in Pcbnew.
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
void SetPainter(PAINTER *aPainter)
Function SetPainter() Sets the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:189
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
virtual void SetTopLayer(int aLayer) override
Module description (excepted pads)
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:798
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:519
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
TRACKS & Tracks()
Definition: class_board.h:217
show modules references (when texts are visibles)
Additional netnames layers (not associated with a PCB layer)
bool IsNetnameLayer(LAYER_NUM aLayer)
Function IsNetnameLayer tests whether a layer is a netname layer.
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible() Returns information about visibility of a particular layer.
Definition: view.h:416