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 <worksheet_viewitem.h>
30 #include <ratsnest_viewitem.h>
31 #include <ratsnest_data.h>
32 #include <connectivity_data.h>
33 
35 #include <class_board.h>
36 #include <class_module.h>
37 #include <class_track.h>
38 #include <class_marker_pcb.h>
39 #include <wxBasePcbFrame.h>
40 
42 
43 #include <functional>
44 using namespace std::placeholders;
45 
47 {
49  LAYER_DRC,
52 
55 
60 
63 
94 
97 
100 };
101 
102 
103 PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId,
104  const wxPoint& aPosition, const wxSize& aSize,
105  KIGFX::GAL_DISPLAY_OPTIONS& aOptions, GAL_TYPE aGalType ) :
106 EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
107 {
108  m_view = new KIGFX::PCB_VIEW( true );
109  m_view->SetGAL( m_gal );
110 
111  m_painter.reset( new KIGFX::PCB_PAINTER( m_gal ) );
112  m_view->SetPainter( m_painter.get() );
113 
116 
117  // View controls is the first in the event handler chain, so the Tool Framework operates
118  // on updated viewport data.
120 
121  // Load display options (such as filled/outline display of items).
122  // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
123  // which is not always the case (namely when it is used from a wxDialog like the pad editor)
125 
126  if( frame )
127  {
128  auto opts = (PCB_DISPLAY_OPTIONS*) frame->GetDisplayOptions();
129  static_cast<KIGFX::PCB_VIEW*>( m_view )->UpdateDisplayOptions( opts );
130  }
131 }
132 
133 
135 {
136 }
137 
138 
140 {
141  m_view->Clear();
142 
143  // Load zones
144  for( auto zone : aBoard->Zones() )
145  {
146  zone->CacheTriangulation();
147  m_view->Add( zone );
148  }
149 
150  // Load drawings
151  for( auto drawing : const_cast<BOARD*>(aBoard)->Drawings() )
152  m_view->Add( drawing );
153 
154  // Load tracks
155  for( TRACK* track = aBoard->m_Track; track; track = track->Next() )
156  m_view->Add( track );
157 
158  // Load modules and its additional elements
159  for( MODULE* module = aBoard->m_Modules; module; module = module->Next() )
160  m_view->Add( module );
161 
162  // Segzones (equivalent of ZONE_CONTAINER for legacy boards)
163  for( SEGZONE* zone = aBoard->m_Zone; zone; zone = zone->Next() )
164  m_view->Add( zone );
165 
166  // DRC markers
167  for( int marker_idx = 0; marker_idx < aBoard->GetMARKERCount(); ++marker_idx )
168  {
169  m_view->Add( aBoard->GetMARKER( marker_idx ) );
170  }
171 
172  // Ratsnest
173  m_ratsnest.reset( new KIGFX::RATSNEST_VIEWITEM( aBoard->GetConnectivity() ) );
174  m_view->Add( m_ratsnest.get() );
175 }
176 
177 
179 {
180  m_worksheet.reset( aWorksheet );
181  m_view->Add( m_worksheet.get() );
182 }
183 
184 
186 {
188  rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
189  rs->ImportLegacyColors( aSettings );
190  m_gal->SetCursorColor( aSettings->GetItemColor( LAYER_CURSOR ) );
191 }
192 
193 
195 {
196  // Set display settings for high contrast mode
198 
199  SetTopLayer( aLayer );
200 
201  rSettings->ClearActiveLayers();
202  rSettings->SetActiveLayer( aLayer );
203 
204  if( IsCopperLayer( aLayer ) )
205  {
206  // Bring some other layers to the front in case of copper layers and make them colored
207  // fixme do not like the idea of storing the list of layers here,
208  // should be done in some other way I guess..
209  LAYER_NUM layers[] = {
210  GetNetnameLayer( aLayer ),
214  };
215 
216  for( unsigned int i = 0; i < sizeof( layers ) / sizeof( LAYER_NUM ); ++i )
217  rSettings->SetActiveLayer( layers[i] );
218 
219  // Pads should be shown too
220  if( aLayer == B_Cu )
221  {
222  rSettings->SetActiveLayer( LAYER_PAD_BK );
223  rSettings->SetActiveLayer( LAYER_MOD_BK );
225  }
226  else if( aLayer == F_Cu )
227  {
228  rSettings->SetActiveLayer( LAYER_PAD_FR );
229  rSettings->SetActiveLayer( LAYER_MOD_FR );
231  }
232  }
233 
235 }
236 
237 
239 {
242  m_view->SetTopLayer( aLayer );
243 
244  // Layers that should always have on-top attribute enabled
245  const LAYER_NUM layers[] = {
249  LAYER_DRC
250  };
251 
252  for( unsigned int i = 0; i < sizeof( layers ) / sizeof( LAYER_NUM ); ++i )
253  m_view->SetTopLayer( layers[i] );
254 
255  // Extra layers that are brought to the top if a F.* or B.* is selected
256  const LAYER_NUM frontLayers[] = {
259  };
260 
261  const LAYER_NUM backLayers[] = {
264  };
265 
266  const LAYER_NUM* extraLayers = NULL;
267 
268  // Bring a few more extra layers to the top depending on the selected board side
269  if( IsFrontLayer( aLayer ) )
270  extraLayers = frontLayers;
271  else if( IsBackLayer( aLayer ) )
272  extraLayers = backLayers;
273 
274  if( extraLayers )
275  {
276  const LAYER_NUM* l = extraLayers;
277 
278  while( *l >= 0 )
279  m_view->SetTopLayer( *l++ );
280 
281  // Move the active layer to the top
282  if( !IsCopperLayer( aLayer ) )
284  }
285  else if( IsCopperLayer( aLayer ) )
286  {
287  // Display labels for copper layers on the top
288  m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
289  }
290 
292 }
293 
294 
296 {
297  // Load layer & elements visibility settings
298  for( LAYER_NUM i = 0; i < PCB_LAYER_ID_COUNT; ++i )
299  {
300  m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
301 
302  // Synchronize netname layers as well
303  if( IsCopperLayer( i ) )
305  }
306 
308  {
309  m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
310  }
311 
312  // Enable some layers that are GAL specific
316 }
317 
318 
319 void PCB_DRAW_PANEL_GAL::GetMsgPanelInfo( std::vector<MSG_PANEL_ITEM>& aList )
320 {
321  BOARD* board = static_cast<PCB_BASE_FRAME*>( m_parent )->GetBoard();
322  wxString txt;
323  int viasCount = 0;
324  int trackSegmentsCount = 0;
325 
326  for( const BOARD_ITEM* item = board->m_Track; item; item = item->Next() )
327  {
328  if( item->Type() == PCB_VIA_T )
329  viasCount++;
330  else
331  trackSegmentsCount++;
332  }
333 
334  txt.Printf( wxT( "%d" ), board->GetPadCount() );
335  aList.push_back( MSG_PANEL_ITEM( _( "Pads" ), txt, DARKGREEN ) );
336 
337  txt.Printf( wxT( "%d" ), viasCount );
338  aList.push_back( MSG_PANEL_ITEM( _( "Vias" ), txt, DARKGREEN ) );
339 
340  txt.Printf( wxT( "%d" ), trackSegmentsCount );
341  aList.push_back( MSG_PANEL_ITEM( _( "Track Segments" ), txt, DARKGREEN ) );
342 
343  txt.Printf( wxT( "%d" ), board->GetNodesCount() );
344  aList.push_back( MSG_PANEL_ITEM( _( "Nodes" ), txt, DARKCYAN ) );
345 
346  txt.Printf( wxT( "%d" ), board->GetNetCount() );
347  aList.push_back( MSG_PANEL_ITEM( _( "Nets" ), txt, RED ) );
348 
349  txt.Printf( wxT( "%d" ), board->GetConnectivity()->GetUnconnectedCount() );
350  aList.push_back( MSG_PANEL_ITEM( _( "Unconnected" ), txt, BLUE ) );
351 }
352 
353 
355 {
356  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParent() );
357 
358  if( frame )
359  {
360  SetTopLayer( frame->GetActiveLayer() );
362  static_cast<KIGFX::PCB_RENDER_SETTINGS*>(
363  m_view->GetPainter()->GetSettings() )->LoadDisplayOptions( displ_opts );
364  }
365 
367 }
368 
369 
371 {
372  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
373  {
374  LAYER_NUM layer = GAL_LAYER_ORDER[i];
375  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
376 
377  m_view->SetLayerOrder( layer, i );
378  }
379 }
380 
381 
383 {
384  bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
386  return rv;
387 }
388 
389 
391 {
392  if( m_ratsnest )
393  m_view->Update( m_ratsnest.get() );
394 }
395 
396 
398 {
399  // caching makes no sense for Cairo and other software renderers
401 
402  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
403  m_view->SetLayerTarget( i, target );
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  // Set layer display dependencies & targets
411  if( IsCopperLayer( layer ) )
412  m_view->SetRequired( GetNetnameLayer( layer ), layer );
413  else if( IsNetnameLayer( layer ) )
414  m_view->SetLayerDisplayOnly( layer );
415  }
416 
419 
420  // Some more required layers settings
426 
427  // Front modules
437 
438  // Back modules
448 
453 
457 }
458 
459 
461 {
462  return static_cast<KIGFX::PCB_VIEW*>( m_view );
463 }
void SetWorksheet(KIGFX::WORKSHEET_VIEWITEM *aWorksheet)
Function SetWorksheet Sets (or updates) worksheet used by the draw panel.
Definition: colors.h:57
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
to draw blind/buried vias
MARKER_PCB * GetMARKER(int index) const
Function GetMARKER returns the MARKER at a given index.
Definition: class_board.h:321
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
Class that draws missing connections on a PCB.
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:382
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:590
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:730
void GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override
>
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
multilayer pads, usually with holes
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Class 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.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
Class BOARD to handle a board.
Class that computes missing connections on a PCB.
void RecacheAllItems()
Function RecacheAllItems() Rebuilds GAL display lists.
Definition: view.cpp:1253
MODULE * Next() const
Definition: class_module.h:120
show modules on back
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)
DLIST< SEGZONE > m_Zone
Definition: class_board.h:247
std::unique_ptr< KIGFX::WORKSHEET_VIEWITEM > m_worksheet
Currently used worksheet
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers...
Definition: view.cpp:797
Add new GAL layers here.
Class EDA_DRAW_FRAME is the base class for create windows for drawing purpose.
Definition: draw_frame.h:54
Class PCB_PAINTER Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:176
void ImportLegacyColors(const COLORS_DESIGN_SETTINGS *aSettings) override
Function ImportLegacyColors Loads a list of color settings for layers.
Definition: pcb_painter.cpp:73
smd pads, back layer
WX_VIEW_CONTROLS class definition.
void RedrawRatsnest()
Forces refresh of the ratsnest visual representation
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[]
Functions relatives to tracks, vias and segments used to fill zones.
KIGFX::PCB_VIEW * view() const
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
Auxiliary rendering target (noncached)
Definition: definitions.h:42
SEGZONE * Next() const
Definition: class_track.h:362
show modules on front
std::unique_ptr< KIGFX::RATSNEST_VIEWITEM > m_ratsnest
Ratsnest view item
COLOR4D GetItemColor(int aItemIdx) const
Function GetItemColor.
Class that handles properties and drawing of worksheet layout.
Class PCB_RENDER_SETTINGS Stores PCB specific render settings.
Definition: pcb_painter.h:62
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Function SetLayerTarget() Changes the rendering target for a particular layer.
Definition: view.h:424
Markers used to show a drc problem on boards.
wxWindow * m_parent
Pointer to the parent window.
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PCB_LAYER_ID
A quick note on layer IDs:
Classes used in Pcbnew, CvPcb and GerbView.
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
Definition: painter.h:98
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:969
int GetLayerOrder(int aLayer) const
Function GetLayerOrder() Returns rendering order of a particular layer.
Definition: view.cpp:598
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:411
to draw usual through hole vias
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:652
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:43
general purpose overlay
Definition: colors.h:60
void SetLayerVisible(int aLayer, bool aVisible=true)
Function SetLayerVisible() Controls the visibility of a particular layer.
Definition: view.h:387
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:196
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:1385
unsigned GetPadCount() const
Function GetPadCount.
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:782
virtual void SetHighContrastLayer(int aLayer) override
>
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
BOARD * GetBoard()
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 IsElementVisible(GAL_LAYER_ID aLayer) const
Function IsElementVisible tests whether a given element category is visible.
ZONE_CONTAINERS & Zones()
Definition: class_board.h:252
TRACK * Next() const
Definition: class_track.h:100
smd pads, front layer
Main rendering target (cached)
Definition: definitions.h:41
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
unsigned GetNodesCount() const
Function GetNodesCount.
DLIST< MODULE > m_Modules
Definition: class_board.h:245
Class 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:186
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:312
DLIST< TRACK > m_Track
Definition: class_board.h:246
virtual void SetTopLayer(int aLayer) override
>
Module description (excepted pads)
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
void OnShow() override
>
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:675
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:485
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
Handle colors used to draw all items or layers.
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:290
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
virtual void * GetDisplayOptions()
Function GetDisplayOptions A way to pass info to draw functions.
Definition: draw_frame.h:879
show modules references (when texts are visibles)
Additional netnames layers (not associated with a PCB layer)
int GetMARKERCount() const
Function GetMARKERCount.
Definition: class_board.h:333
bool IsNetnameLayer(LAYER_NUM aLayer)
Function IsNetnameLayer tests whether a layer is a netname layer.
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:772
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:451