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>
31 
32 #include <class_board.h>
33 #include <class_module.h>
34 #include <class_track.h>
35 #include <class_marker_pcb.h>
36 #include <pcb_base_frame.h>
37 #include <pcbnew_settings.h>
38 #include <ratsnest/ratsnest_data.h>
40 
41 #include <pgm_base.h>
43 #include <confirm.h>
44 
46 
47 #include <functional>
48 #include <memory>
49 #include <thread>
50 using namespace std::placeholders;
51 
53 {
59 
62 
67 
70 
101 
104 
107 };
108 
109 
110 PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
111  const wxPoint& aPosition, const wxSize& aSize,
112  KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
113  EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
114 {
115  m_view = new KIGFX::PCB_VIEW( true );
116  m_view->SetGAL( m_gal );
117 
118  m_painter = std::make_unique<KIGFX::PCB_PAINTER>( m_gal );
119  m_view->SetPainter( m_painter.get() );
120 
123 
124  // View controls is the first in the event handler chain, so the Tool Framework operates
125  // on updated viewport data.
127 
128  // Load display options (such as filled/outline display of items).
129  // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
130  // which is not always the case (namely when it is used from a wxDialog like the pad editor)
131  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
132 
133  if( frame )
134  static_cast<KIGFX::PCB_VIEW*>( m_view )->UpdateDisplayOptions(
135  frame->GetDisplayOptions() );
136 }
137 
138 
140 {
141 }
142 
143 
145 {
146 
147  m_view->Clear();
148 
149  auto zones = aBoard->Zones();
150  std::atomic<size_t> next( 0 );
151  std::atomic<size_t> count_done( 0 );
152  size_t parallelThreadCount = std::max<size_t>( std::thread::hardware_concurrency(), 2 );
153 
154  for( size_t ii = 0; ii < parallelThreadCount; ++ii )
155  {
156  std::thread t = std::thread( [ &count_done, &next, &zones ]( )
157  {
158  for( size_t i = next.fetch_add( 1 ); i < zones.size(); i = next.fetch_add( 1 ) )
159  zones[i]->CacheTriangulation();
160 
161  count_done++;
162  } );
163 
164  t.detach();
165  }
166 
167  if( m_worksheet )
168  m_worksheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
169 
170  // Load drawings
171  for( auto drawing : const_cast<BOARD*>(aBoard)->Drawings() )
172  m_view->Add( drawing );
173 
174  // Load tracks
175  for( auto track : aBoard->Tracks() )
176  m_view->Add( track );
177 
178  // Load modules and its additional elements
179  for( auto module : aBoard->Modules() )
180  m_view->Add( module );
181 
182  // DRC markers
183  for( auto marker : aBoard->Markers() )
184  m_view->Add( marker );
185 
186  // Finalize the triangulation threads
187  while( count_done < parallelThreadCount )
188  std::this_thread::sleep_for( std::chrono::milliseconds( 10 ) );
189 
190  // Load zones
191  for( auto zone : aBoard->Zones() )
192  m_view->Add( zone );
193 
194  // Ratsnest
195  m_ratsnest = std::make_unique<KIGFX::RATSNEST_VIEWITEM>( aBoard->GetConnectivity() );
196  m_view->Add( m_ratsnest.get() );
197 }
198 
199 
201 {
202  m_worksheet.reset( aWorksheet );
203  m_view->Add( m_worksheet.get() );
204 }
205 
206 
208 {
209  COLOR_SETTINGS* cs = nullptr;
210 
211  auto frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
212 
213  if( frame )
214  {
215  cs = frame->GetColorSettings();
216  }
217  else
218  {
219  PCBNEW_SETTINGS* app = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
220 
221  if( app )
222  cs = Pgm().GetSettingsManager().GetColorSettings( app->m_ColorTheme );
223  else
224  cs = Pgm().GetSettingsManager().GetColorSettings();
225  }
226 
227  wxCHECK_RET( cs, "null COLOR_SETTINGS" );
228 
229  Pgm().GetSettingsManager().SaveColorSettings( cs, "board" );
230 
231  auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
232  rs->LoadColors( cs );
233 
236 }
237 
238 
240 {
241  // Set display settings for high contrast mode
243 
244  SetTopLayer( aLayer );
245 
246  rSettings->ClearActiveLayers();
247  rSettings->SetActiveLayer( aLayer );
248 
249  if( IsCopperLayer( aLayer ) )
250  {
251  // Bring some other layers to the front in case of copper layers and make them colored
252  // fixme do not like the idea of storing the list of layers here,
253  // should be done in some other way I guess..
254  LAYER_NUM layers[] = {
255  GetNetnameLayer( aLayer ),
260  };
261 
262  for( unsigned int i : layers )
263  rSettings->SetActiveLayer( i );
264 
265  // Pads should be shown too
266  if( aLayer == B_Cu )
267  {
268  rSettings->SetActiveLayer( LAYER_PAD_BK );
269  rSettings->SetActiveLayer( LAYER_MOD_BK );
271  }
272  else if( aLayer == F_Cu )
273  {
274  rSettings->SetActiveLayer( LAYER_PAD_FR );
275  rSettings->SetActiveLayer( LAYER_MOD_FR );
277  }
278  }
279 
281 }
282 
283 
285 {
288  m_view->SetTopLayer( aLayer );
289 
290  // Layers that should always have on-top attribute enabled
291  const std::vector<LAYER_NUM> layers = {
296  };
297 
298  for( auto layer : layers )
299  m_view->SetTopLayer( layer );
300 
301  // Extra layers that are brought to the top if a F.* or B.* is selected
302  const std::vector<LAYER_NUM> frontLayers = {
305  };
306 
307  const std::vector<LAYER_NUM> backLayers = {
310  };
311 
312  const std::vector<LAYER_NUM>* extraLayers = NULL;
313 
314  // Bring a few more extra layers to the top depending on the selected board side
315  if( IsFrontLayer( aLayer ) )
316  extraLayers = &frontLayers;
317  else if( IsBackLayer( aLayer ) )
318  extraLayers = &backLayers;
319 
320  if( extraLayers )
321  {
322  for( auto layer : *extraLayers )
323  m_view->SetTopLayer( layer );
324 
325  // Move the active layer to the top
326  if( !IsCopperLayer( aLayer ) )
328  }
329  else if( IsCopperLayer( aLayer ) )
330  {
331  // Display labels for copper layers on the top
332  m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
333  }
334 
335  m_view->EnableTopLayer( true );
337 }
338 
339 
341 {
342  // Load layer & elements visibility settings
343  for( LAYER_NUM i = 0; i < PCB_LAYER_ID_COUNT; ++i )
344  m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
345 
347  m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
348 
349  // Always enable netname layers, as their visibility is controlled by layer dependencies
351  m_view->SetLayerVisible( i, true );
352 
353  // Enable some layers that are GAL specific
359 }
360 
361 
363  std::vector<MSG_PANEL_ITEM>& aList )
364 {
365  BOARD* board = static_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() )->GetBoard();
366  wxString txt;
367  int viasCount = 0;
368  int trackSegmentsCount = 0;
369 
370  for( auto item : board->Tracks() )
371  {
372  if( item->Type() == PCB_VIA_T )
373  viasCount++;
374  else
375  trackSegmentsCount++;
376  }
377 
378  txt.Printf( wxT( "%d" ), board->GetPadCount() );
379  aList.emplace_back( _( "Pads" ), txt, DARKGREEN );
380 
381  txt.Printf( wxT( "%d" ), viasCount );
382  aList.emplace_back( _( "Vias" ), txt, DARKGREEN );
383 
384  txt.Printf( wxT( "%d" ), trackSegmentsCount );
385  aList.emplace_back( _( "Track Segments" ), txt, DARKGREEN );
386 
387  txt.Printf( wxT( "%d" ), board->GetNodesCount() );
388  aList.emplace_back( _( "Nodes" ), txt, DARKCYAN );
389 
390  txt.Printf( wxT( "%d" ), board->GetNetCount() - 1 /* don't include "No Net" in count */ );
391  aList.emplace_back( _( "Nets" ), txt, RED );
392 
393  txt.Printf( wxT( "%d" ), board->GetConnectivity()->GetUnconnectedCount() );
394  aList.emplace_back( _( "Unrouted" ), txt, BLUE );
395 }
396 
397 
399 {
400  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
401 
402  try
403  {
404  // Check if the current rendering backend can be properly initialized
405  m_view->UpdateItems();
406  }
407  catch( const std::runtime_error& e )
408  {
409  // Fallback to software renderer
410  DisplayError( GetParent(), e.what() );
412 
413  if( frame )
414  frame->ActivateGalCanvas();
415  }
416 
417  if( frame )
418  {
419  SetTopLayer( frame->GetActiveLayer() );
420  KIGFX::PAINTER* painter = m_view->GetPainter();
421  auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
422  settings->LoadDisplayOptions( frame->GetDisplayOptions(), frame->ShowPageLimits() );
423  }
424 }
425 
426 
428 {
429  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
430  {
431  LAYER_NUM layer = GAL_LAYER_ORDER[i];
432  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
433 
434  m_view->SetLayerOrder( layer, i );
435  }
436 }
437 
438 
440 {
441  bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
443  m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
444  return rv;
445 }
446 
447 
449 {
450  if( m_ratsnest )
451  m_view->Update( m_ratsnest.get() );
452 }
453 
454 
456 {
458  return m_worksheet->ViewBBox();
459 
460  return BOX2I();
461 }
462 
463 
465 {
466  // caching makes no sense for Cairo and other software renderers
468 
469  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
470  m_view->SetLayerTarget( i, target );
471 
472  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
473  {
474  LAYER_NUM layer = GAL_LAYER_ORDER[i];
475  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
476 
477  // Set layer display dependencies & targets
478  if( IsCopperLayer( layer ) )
479  m_view->SetRequired( GetNetnameLayer( layer ), layer );
480  else if( IsNetnameLayer( layer ) )
481  m_view->SetLayerDisplayOnly( layer );
482  }
483 
486 
487  // Some more required layers settings
493 
494  // Front modules
498 
499  // Back modules
503 
510 
514 }
515 
516 
518 {
519  return static_cast<KIGFX::PCB_VIEW*>( m_view );
520 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
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:522
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
Class that draws missing connections on a PCB.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
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:420
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:668
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:864
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
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.
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.
MARKERS & Markers()
Definition: class_board.h:285
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:931
Add new GAL layers here.
The base class for create windows for drawing purpose.
const wxString & GetFileName() const
Definition: class_board.h:255
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Function GetDisplayOptions Display options control the way tracks, vias, outlines and other things ar...
virtual void EnableTopLayer(bool aEnable)
Function EnableTopLayer() Enables or disables display of the top layer.
Definition: view.cpp:891
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:706
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...
const LAYER_NUM GAL_LAYER_ORDER[]
A single base class (TRACK) represents both tracks and vias, with subclasses for curved tracks (ARC) ...
bool ShowPageLimits() const
Auxiliary rendering target (noncached)
Definition: definitions.h:49
Classes used in Pcbnew, CvPcb and GerbView.
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
show modules on front
std::unique_ptr< KIGFX::RATSNEST_VIEWITEM > m_ratsnest
Ratsnest view item
virtual PCB_LAYER_ID GetActiveLayer() const
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Function SetLayerTarget() Changes the rendering target for a particular layer.
Definition: view.h:434
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
Markers used to show a drc problem on boards.
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:58
virtual void ActivateGalCanvas() override
#define NULL
unsigned GetNodesCount(int aNet=-1)
Function GetNodesCount.
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:775
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
MODULES & Modules()
Definition: class_board.h:266
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:1115
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:355
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
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:1425
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:1544
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
Definition: color4d.h:59
unsigned GetPadCount()
Function GetPadCount.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
BOX2I GetDefaultViewBBox() const override
void UpdateColors()
Updates the color settings in the painter and GAL.
void ClearTopLayers()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:916
virtual void SetHighContrastLayer(int aLayer) override
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
layer for drc markers which have been individually excluded
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.
layer for drc markers with SEVERITY_WARNING
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.
COLOR4D GetColor(int aLayer) const
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: color4d.h:56
ZONE_CONTAINERS & Zones()
Definition: class_board.h:280
smd pads, front layer
see class PGM_BASE
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:180
#define _(s)
Definition: 3d_actions.cpp:33
int GetLayerOrder(int aLayer) const
Function GetLayerOrder() Returns rendering order of a particular layer.
Definition: view.cpp:676
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
currently selected items overlay
#define TO_UTF8(wxstring)
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
Color settings are a bit different than most of the settings objects in that there can be more than o...
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:350
virtual void SetTopLayer(int aLayer) override
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:802
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:523
#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:257
show modules references (when texts are visibles)
layer for drc markers with SEVERITY_ERROR
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
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:157