KiCad PCB EDA Suite
PCB_DRAW_PANEL_GAL Class Reference

#include <pcb_draw_panel_gal.h>

Inheritance diagram for PCB_DRAW_PANEL_GAL:
EDA_DRAW_PANEL_GAL FOOTPRINT_PREVIEW_PANEL

Public Types

enum  GAL_TYPE {
  GAL_TYPE_UNKNOWN = -1, GAL_TYPE_NONE = 0, GAL_TYPE_OPENGL, GAL_TYPE_CAIRO,
  GAL_TYPE_LAST
}
 

Public Member Functions

 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)
 
virtual ~PCB_DRAW_PANEL_GAL ()
 
void DisplayBoard (BOARD *aBoard)
 Function DisplayBoard adds all items from the current board to the VIEW, so they can be displayed by GAL. More...
 
void SetWorksheet (KIGFX::WS_PROXY_VIEW_ITEM *aWorksheet)
 Function SetWorksheet Sets (or updates) worksheet used by the draw panel. More...
 
void UseColorScheme (const COLORS_DESIGN_SETTINGS *aSettings)
 Function UseColorScheme Applies layer color settings. More...
 
virtual void SetHighContrastLayer (int aLayer) override
 

More...
 
void SetHighContrastLayer (PCB_LAYER_ID aLayer)
 

SetHighContrastLayer(), with some extra smarts for PCB

More...
 
virtual void SetTopLayer (int aLayer) override
 

More...
 
void SetTopLayer (PCB_LAYER_ID aLayer)
 

SetTopLayer(), with some extra smarts for PCB

More...
 
void SyncLayersVisibility (const BOARD *aBoard)
 Function SyncLayersVisibility Updates "visibility" property of each layer of a given BOARD. More...
 
void GetMsgPanelInfo (EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
 

More...
 
void OnShow () override
 

More...
 
bool SwitchBackend (GAL_TYPE aGalType) override
 Function SwitchBackend Switches method of rendering graphics. More...
 
void RedrawRatsnest ()
 

Forces refresh of the ratsnest visual representation

More...
 
BOX2I GetDefaultViewBBox () const override
 

More...
 
virtual KIGFX::PCB_VIEWGetView () const override
 Function GetView() Returns a pointer to the VIEW instance used in the panel. More...
 
virtual void SetFocus () override
 
GAL_TYPE GetBackend () const
 Function GetBackend Returns the type of backend currently used by GAL canvas. More...
 
KIGFX::GALGetGAL () const
 Function GetGAL() Returns a pointer to the GAL instance used in the panel. More...
 
KIGFX::VIEW_CONTROLSGetViewControls () const
 Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel. More...
 
virtual void Refresh (bool aEraseBackground=true, const wxRect *aRect=NULL) override
 Update the board display after modifying it by a python script (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins. More...
 
void ForceRefresh ()
 Function ForceRefresh() Forces a redraw. More...
 
void SetEventDispatcher (TOOL_DISPATCHER *aEventDispatcher)
 Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools. More...
 
void StartDrawing ()
 Function StartDrawing() Begins drawing if it was stopped previously. More...
 
void StopDrawing ()
 Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDrawing() is called. More...
 
double GetLegacyZoom () const
 Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas. More...
 
EDA_DRAW_FRAMEGetParentEDAFrame () const
 Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise. More...
 
void SetStealsFocus (bool aStealsFocus)
 Set whether focus is taken on certain events (mouseover, keys, etc). More...
 
void SetCurrentCursor (wxStockCursor aStockCursorID)
 Function SetCurrentCursor Set the current cursor shape for this panel. More...
 
void SetCurrentCursor (const wxCursor &aCursor)
 
void OnEvent (wxEvent &aEvent)
 Used to forward events to the canvas from popups, etc. More...
 

Protected Member Functions

void setDefaultLayerOrder ()
 

Reassigns layer order to the initial settings.

More...
 
void setDefaultLayerDeps ()
 

Sets rendering targets & dependencies for layers.

More...
 
virtual void onPaint (wxPaintEvent &WXUNUSED(aEvent))
 
void onSize (wxSizeEvent &aEvent)
 
void onEnter (wxEvent &aEvent)
 
void onLostFocus (wxFocusEvent &aEvent)
 
void onRefreshTimer (wxTimerEvent &aEvent)
 
void onShowTimer (wxTimerEvent &aEvent)
 
void onSetCursor (wxSetCursorEvent &event)
 

Protected Attributes

std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEMm_worksheet
 

Currently used worksheet

More...
 
std::unique_ptr< KIGFX::RATSNEST_VIEWITEMm_ratsnest
 

Ratsnest view item

More...
 
wxCursor m_currentCursor
 
wxWindow * m_parent
 Current mouse cursor shape id. More...
 
EDA_DRAW_FRAMEm_edaFrame
 Pointer to the parent window. More...
 
wxLongLong m_lastRefresh
 Parent EDA_DRAW_FRAME (if available) More...
 
bool m_pendingRefresh
 Last timestamp when the panel was refreshed. More...
 
wxTimer m_refreshTimer
 Is there a redraw event requested? More...
 
bool m_drawing
 Timer to prevent too-frequent refreshing. More...
 
bool m_drawingEnabled
 Flag that determines if VIEW may use GAL for redrawing the screen. More...
 
wxTimer m_onShowTimer
 Timer used to execute OnShow() when the window finally appears on the screen. More...
 
KIGFX::GALm_gal
 Interface for drawing objects on a 2D-surface. More...
 
KIGFX::VIEWm_view
 Stores view settings (scale, center, etc.) and items to be drawn. More...
 
std::unique_ptr< KIGFX::PAINTERm_painter
 Contains information about how to draw items using GAL. More...
 
KIGFX::WX_VIEW_CONTROLSm_viewControls
 Control for VIEW (moving, zooming, etc.) More...
 
GAL_TYPE m_backend
 Currently used GAL. More...
 
KIGFX::GAL_DISPLAY_OPTIONSm_options
 
TOOL_DISPATCHERm_eventDispatcher
 Processes and forwards events to tools. More...
 
bool m_lostFocus
 Flag to indicate that focus should be regained on the next mouse event. More...
 
bool m_stealsFocus
 Flag to indicate whether the panel should take focus at certain times (when moused over, and on various mouse/key events) More...
 

Static Protected Attributes

static const int MinRefreshPeriod = 17
 60 FPS. More...
 

Detailed Description

Definition at line 40 of file pcb_draw_panel_gal.h.

Member Enumeration Documentation

◆ GAL_TYPE

Enumerator
GAL_TYPE_UNKNOWN 

not specified: a GAL engine must be set by the client

GAL_TYPE_NONE 

GAL not used (the legacy wxDC engine is used)

GAL_TYPE_OPENGL 

OpenGL implementation.

GAL_TYPE_CAIRO 

Cairo implementation.

GAL_TYPE_LAST 

Sentinel, do not use as a parameter.

Definition at line 55 of file class_draw_panel_gal.h.

55  {
56  GAL_TYPE_UNKNOWN = -1,
57  GAL_TYPE_NONE = 0,
61  };
Sentinel, do not use as a parameter.
not specified: a GAL engine must be set by the client
GAL not used (the legacy wxDC engine is used)

Constructor & Destructor Documentation

◆ PCB_DRAW_PANEL_GAL()

PCB_DRAW_PANEL_GAL::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 
)

Definition at line 107 of file pcb_draw_panel_gal.cpp.

109  :
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 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
WX_VIEW_CONTROLS is a specific implementation of class VIEW_CONTROLS for wxWidgets library.
void setDefaultLayerOrder()
Reassigns layer order to the initial settings.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Function GetDisplayOptions returns the display options current in use Display options are relative to...
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
EDA_DRAW_PANEL_GAL(wxWindow *aParentWindow, wxWindowID aWindowId, const wxPoint &aPosition, const wxSize &aSize, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType=GAL_TYPE_OPENGL)
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
void SetPainter(PAINTER *aPainter)
Function SetPainter() Sets the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:189
void SetGAL(GAL *aGal)
Function SetGAL() Assigns a rendering device for the VIEW.
Definition: view.cpp:519
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.

References PCB_BASE_FRAME::GetDisplayOptions(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_painter, EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::m_viewControls, setDefaultLayerDeps(), setDefaultLayerOrder(), KIGFX::VIEW::SetGAL(), and KIGFX::VIEW::SetPainter().

◆ ~PCB_DRAW_PANEL_GAL()

PCB_DRAW_PANEL_GAL::~PCB_DRAW_PANEL_GAL ( )
virtual

Definition at line 136 of file pcb_draw_panel_gal.cpp.

137 {
138 }

Member Function Documentation

◆ DisplayBoard()

void PCB_DRAW_PANEL_GAL::DisplayBoard ( BOARD aBoard)

Function DisplayBoard adds all items from the current board to the VIEW, so they can be displayed by GAL.

Parameters
aBoardis the PCB to be loaded.

Definition at line 141 of file pcb_draw_panel_gal.cpp.

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 }
CITER next(CITER it)
Definition: ptree.cpp:130
int GetMARKERCount() const
Function GetMARKERCount.
Definition: class_board.h:343
const wxString & GetFileName() const
Definition: class_board.h:215
std::unique_ptr< KIGFX::RATSNEST_VIEWITEM > m_ratsnest
Ratsnest view item
#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
MODULES & Modules()
Definition: class_board.h:226
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::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:300
MARKER_PCB * GetMARKER(int index) const
Function GetMARKER returns the MARKER at a given index.
Definition: class_board.h:331
ZONE_CONTAINERS & Zones()
Definition: class_board.h:240
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
TRACKS & Tracks()
Definition: class_board.h:217

References KIGFX::VIEW::Add(), KIGFX::VIEW::Clear(), BOARD::GetConnectivity(), BOARD::GetFileName(), BOARD::GetMARKER(), BOARD::GetMARKERCount(), m_ratsnest, EDA_DRAW_PANEL_GAL::m_view, m_worksheet, BOARD::Modules(), next(), TO_UTF8, BOARD::Tracks(), and BOARD::Zones().

Referenced by PCB_BASE_EDIT_FRAME::SetBoard(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), and FOOTPRINT_EDIT_FRAME::updateView().

◆ ForceRefresh()

◆ GetBackend()

◆ GetDefaultViewBBox()

BOX2I PCB_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
overridevirtual

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 431 of file pcb_draw_panel_gal.cpp.

432 {
434  return m_worksheet->ViewBBox();
435 
436  return BOX2I();
437 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEM > m_worksheet
Currently used worksheet
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible() Returns information about visibility of a particular layer.
Definition: view.h:416

References KIGFX::VIEW::IsLayerVisible(), LAYER_WORKSHEET, EDA_DRAW_PANEL_GAL::m_view, and m_worksheet.

◆ GetGAL()

◆ GetLegacyZoom()

double EDA_DRAW_PANEL_GAL::GetLegacyZoom ( ) const
inherited

Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas.

Definition at line 340 of file draw_panel_gal.cpp.

341 {
343 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
double GetZoomLevelCoeff() const
Return the coefficient to convert internal display scale factor to zoom level.
double GetZoomFactor() const
Get the zoom factor.
EDA_DRAW_FRAME * m_edaFrame
Pointer to the parent window.

References KIGFX::GAL::GetZoomFactor(), EDA_DRAW_FRAME::GetZoomLevelCoeff(), EDA_DRAW_PANEL_GAL::m_edaFrame, and EDA_DRAW_PANEL_GAL::m_gal.

Referenced by COMMON_TOOLS::doZoomInOut(), EDA_DRAW_PANEL_GAL::onPaint(), GERBVIEW_FRAME::OnUpdateSelectZoom(), and PCB_BASE_FRAME::OnUpdateSelectZoom().

◆ GetMsgPanelInfo()

void PCB_DRAW_PANEL_GAL::GetMsgPanelInfo ( EDA_UNITS  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 339 of file pcb_draw_panel_gal.cpp.

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 }
Definition: colors.h:57
wxWindow * m_parent
Current mouse cursor shape id.
unsigned GetNodesCount(int aNet=-1)
Function GetNodesCount.
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:766
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
Definition: colors.h:60
unsigned GetPadCount()
Function GetPadCount.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:160
#define _(s)
Definition: 3d_actions.cpp:31
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
TRACKS & Tracks()
Definition: class_board.h:217

References _, BLUE, DARKCYAN, DARKGREEN, BOARD_ITEM::GetBoard(), BOARD::GetConnectivity(), BOARD::GetNetCount(), BOARD::GetNodesCount(), BOARD::GetPadCount(), EDA_DRAW_PANEL_GAL::m_parent, PCB_VIA_T, RED, and BOARD::Tracks().

◆ GetParentEDAFrame()

EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::GetParentEDAFrame ( ) const
inlineinherited

Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.

Definition at line 165 of file class_draw_panel_gal.h.

165 { return m_edaFrame; }
EDA_DRAW_FRAME * m_edaFrame
Pointer to the parent window.

References EDA_DRAW_PANEL_GAL::m_edaFrame.

Referenced by GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::onPaint(), and PCB_DRAW_PANEL_GAL().

◆ GetView()

KIGFX::PCB_VIEW * PCB_DRAW_PANEL_GAL::GetView ( ) const
overridevirtual

Function GetView() Returns a pointer to the VIEW instance used in the panel.

Returns
The instance of VIEW.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 494 of file pcb_draw_panel_gal.cpp.

495 {
496  return static_cast<KIGFX::PCB_VIEW*>( m_view );
497 }
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

References EDA_DRAW_PANEL_GAL::m_view.

Referenced by FOOTPRINT_VIEWER_FRAME::ApplyDisplaySettingsToGAL(), DISPLAY_FOOTPRINTS_FRAME::ApplyDisplaySettingsToGAL(), GRID_HELPER::BestSnapAnchor(), GRID_HELPER::computeAnchors(), DIALOG_PRINT_PCBNEW::createPrintout(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetCollectorsGuide(), GRID_HELPER::GRID_HELPER(), DIALOG_SELECT_NET_FROM_LIST::HighlightNet(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), FOOTPRINT_PREVIEW_PANEL::New(), DIALOG_PAD_PROPERTIES::onChangePadMode(), PCB_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerVisible(), PCB_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), DIALOG_PAD_PROPERTIES::prepareCanvas(), GRID_HELPER::queryVisible(), PCB_EDIT_FRAME::ReCreateMenuBar(), DIALOG_PAD_PROPERTIES::redraw(), refreshCallback(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GRID_HELPER::SetAuxAxes(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), PCB_BASE_FRAME::SetGridVisibility(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), PANEL_PCBNEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_PREVIEW_PANEL::~FOOTPRINT_PREVIEW_PANEL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ GetViewControls()

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxEvent &  aEvent)
protectedinherited

Definition at line 449 of file draw_panel_gal.cpp.

450 {
451  // Getting focus is necessary in order to receive key events properly
452  if( m_stealsFocus )
453  SetFocus();
454 
455  aEvent.Skip();
456 }
virtual void SetFocus() override
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

References EDA_DRAW_PANEL_GAL::m_stealsFocus, and EDA_DRAW_PANEL_GAL::SetFocus().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ OnEvent()

void EDA_DRAW_PANEL_GAL::OnEvent ( wxEvent &  aEvent)
inherited

Used to forward events to the canvas from popups, etc.

Definition at line 435 of file draw_panel_gal.cpp.

436 {
437  if( m_lostFocus && m_stealsFocus )
438  SetFocus();
439 
440  if( !m_eventDispatcher )
441  aEvent.Skip();
442  else
444 
445  Refresh();
446 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Function DispatchWxEvent() Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs,...
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
virtual void SetFocus() override
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

References TOOL_DISPATCHER::DispatchWxEvent(), EDA_DRAW_PANEL_GAL::m_eventDispatcher, EDA_DRAW_PANEL_GAL::m_lostFocus, EDA_DRAW_PANEL_GAL::m_stealsFocus, EDA_DRAW_PANEL_GAL::Refresh(), and EDA_DRAW_PANEL_GAL::SetFocus().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), and STATUS_POPUP::onCharHook().

◆ onLostFocus()

void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protectedinherited

Definition at line 459 of file draw_panel_gal.cpp.

460 {
461  m_lostFocus = true;
462 
463  aEvent.Skip();
464 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.

References EDA_DRAW_PANEL_GAL::m_lostFocus.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ onPaint()

void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protectedvirtualinherited

Reimplemented in SCH_PREVIEW_PANEL, and SCH_DRAW_PANEL.

Definition at line 143 of file draw_panel_gal.cpp.

144 {
145  // Update current zoom settings if the canvas is managed by a EDA frame
146  // (i.e. not by a preview panel in a dialog)
147  if( GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
148  {
151  }
152 
154 
155  if( !m_gal->IsVisible() )
156  return;
157 
158  m_pendingRefresh = false;
159 
160  if( m_drawing )
161  return;
162 
163 #ifdef PROFILE
164  PROF_COUNTER totalRealTime;
165 #endif /* PROFILE */
166 
167  wxASSERT( m_painter );
168 
169  m_drawing = true;
170  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
171 
172  try
173  {
174  m_view->UpdateItems();
175 
177 
178  m_gal->SetClearColor( settings->GetBackgroundColor() );
179  m_gal->SetGridColor( settings->GetGridColor() );
180  m_gal->SetCursorColor( settings->GetCursorColor() );
181 
182  // TODO: find why ClearScreen() must be called here in opengl mode
183  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
184  // when moving the mouse cursor
185  if( m_backend == GAL_TYPE_OPENGL )
186  m_gal->ClearScreen();
187 
188  if( m_view->IsDirty() )
189  {
190  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
192  m_gal->ClearScreen();
193 
194  m_view->ClearTargets();
195 
196  // Grid has to be redrawn only when the NONCACHED target is redrawn
198  m_gal->DrawGrid();
199 
200  m_view->Redraw();
201  }
202 
204  }
205  catch( std::runtime_error& err )
206  {
207  constexpr auto GAL_FALLBACK = GAL_TYPE_CAIRO;
208 
209  SwitchBackend( GAL_FALLBACK );
210 
212  _( "Could not use OpenGL, falling back to software rendering" ),
213  wxString( err.what() ) );
214  }
215 
216 #ifdef PROFILE
217  totalRealTime.Stop();
218  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
219 #endif /* PROFILE */
220 
221  m_lastRefresh = wxGetLocalTimeMillis();
222  m_drawing = false;
223 }
void Stop()
save the time when this function was called, and set the counter stane to stop
Definition: profile.h:82
bool m_pendingRefresh
Last timestamp when the panel was refreshed.
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void SetClearColor(const COLOR4D &aColor)
virtual const COLOR4D & GetGridColor()=0
Function GetGridColor Returns current grid color settings.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
GAL_TYPE m_backend
Currently used GAL.
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
Definition: painter.h:56
virtual const COLOR4D & GetCursorColor()=0
Function GetCursorColor Returns current cursor color settings.
virtual const COLOR4D & GetBackgroundColor()=0
Function GetBackgroundColor Returns current background color settings.
double msecs(bool aSinceLast=false)
Definition: profile.h:143
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates)
Definition: view.h:328
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:44
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void UpdateScrollbars()
Adjusts the scrollbars position to match the current viewport.
bool m_drawing
Timer to prevent too-frequent refreshing.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
wxWindow * m_parent
Current mouse cursor shape id.
virtual void Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1145
bool IsTargetDirty(int aTarget) const
Function IsTargetDirty() Returns true if any of layers belonging to the target or the target itself s...
Definition: view.h:574
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
double GetLegacyZoom() const
Function GetLegacyZoom() Returns current view scale converted to zoom value used by the legacy canvas...
virtual void DrawGrid()
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1421
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
Definition: base_screen.cpp:88
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual void ClearScreen()
Clear the screen.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
#define _(s)
Definition: 3d_actions.cpp:31
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
Returns the current cursor position in world coordinates.
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
void ClearTargets()
Function ClearTargets() Clears targets that are marked as dirty.
Definition: view.cpp:1126
wxLongLong m_lastRefresh
Parent EDA_DRAW_FRAME (if available)
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:127
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:264
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:557

References _, KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayInfoMessage(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::VIEW::GetCenter(), KIGFX::RENDER_SETTINGS::GetCursorColor(), KIGFX::WX_VIEW_CONTROLS::GetCursorPosition(), KIGFX::RENDER_SETTINGS::GetGridColor(), EDA_DRAW_PANEL_GAL::GetLegacyZoom(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), EDA_DRAW_FRAME::GetScreen(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::IsDirty(), KIGFX::VIEW::IsTargetDirty(), KIGFX::GAL::IsVisible(), EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_drawing, EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_lastRefresh, EDA_DRAW_PANEL_GAL::m_painter, EDA_DRAW_PANEL_GAL::m_parent, EDA_DRAW_PANEL_GAL::m_pendingRefresh, BASE_SCREEN::m_ScrollCenter, EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::m_viewControls, PROF_COUNTER::msecs(), KIGFX::VIEW::Redraw(), KIGFX::GAL::SetClearColor(), KIGFX::GAL::SetCursorColor(), KIGFX::GAL::SetGridColor(), BASE_SCREEN::SetZoom(), PROF_COUNTER::Stop(), EDA_DRAW_PANEL_GAL::SwitchBackend(), KIGFX::TARGET_NONCACHED, KIGFX::VIEW::UpdateItems(), and KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

Referenced by SCH_DRAW_PANEL::onPaint(), SCH_PREVIEW_PANEL::onPaint(), EDA_DRAW_PANEL_GAL::onRefreshTimer(), and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ onRefreshTimer()

void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 467 of file draw_panel_gal.cpp.

468 {
469  if( !m_drawingEnabled )
470  {
471  if( m_gal && m_gal->IsInitialized() )
472  {
473  m_drawing = false;
474  m_pendingRefresh = true;
475  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
476  m_drawingEnabled = true;
477  }
478  else
479  {
480  // Try again soon
481  m_refreshTimer.StartOnce( 100 );
482  return;
483  }
484  }
485 
486  wxPaintEvent redrawEvent;
487  wxPostEvent( this, redrawEvent );
488 }
bool m_pendingRefresh
Last timestamp when the panel was refreshed.
wxTimer m_refreshTimer
Is there a redraw event requested?
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
bool m_drawing
Timer to prevent too-frequent refreshing.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
virtual bool IsInitialized() const
Returns the initalization status for the canvas.

References KIGFX::GAL::IsInitialized(), EDA_DRAW_PANEL_GAL::m_drawing, EDA_DRAW_PANEL_GAL::m_drawingEnabled, EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_pendingRefresh, EDA_DRAW_PANEL_GAL::m_refreshTimer, NULL, and EDA_DRAW_PANEL_GAL::onPaint().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ onSetCursor()

void EDA_DRAW_PANEL_GAL::onSetCursor ( wxSetCursorEvent &  event)
protectedinherited

Definition at line 517 of file draw_panel_gal.cpp.

518 {
519  event.SetCursor( m_currentCursor );
520 }

References EDA_DRAW_PANEL_GAL::m_currentCursor.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ OnShow()

void PCB_DRAW_PANEL_GAL::OnShow ( )
overridevirtual

Function OnShow() Called when the window is shown for the first time.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 374 of file pcb_draw_panel_gal.cpp.

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 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:236
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Function GetDisplayOptions returns the display options current in use Display options are relative to...
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
bool ShowPageLimits() const
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
PAINTER contains all the knowledge about how to draw graphical object onto any particular output devi...
Definition: painter.h:313
virtual void ActivateGalCanvas() override
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1421
bool SwitchBackend(GAL_TYPE aGalType) override
Function SwitchBackend Switches method of rendering graphics.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void SetTopLayer(int aLayer) override
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.

References PCB_BASE_FRAME::ActivateGalCanvas(), DisplayError(), EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetDisplayOptions(), KIGFX::VIEW::GetPainter(), EDA_DRAW_PANEL_GAL::m_view, SetTopLayer(), EDA_DRAW_FRAME::ShowPageLimits(), SwitchBackend(), and KIGFX::VIEW::UpdateItems().

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 491 of file draw_panel_gal.cpp.

492 {
493  if( m_gal && m_gal->IsVisible() )
494  {
495  m_onShowTimer.Stop();
496  OnShow();
497  }
498 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
virtual void OnShow()
Function OnShow() Called when the window is shown for the first time.
wxTimer m_onShowTimer
Timer used to execute OnShow() when the window finally appears on the screen.
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.

References KIGFX::GAL::IsVisible(), EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_onShowTimer, and EDA_DRAW_PANEL_GAL::OnShow().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ onSize()

void EDA_DRAW_PANEL_GAL::onSize ( wxSizeEvent &  aEvent)
protectedinherited

Definition at line 226 of file draw_panel_gal.cpp.

227 {
229  wxSize clientSize = GetClientSize();
230  m_gal->ResizeScreen( clientSize.x, clientSize.y );
231 
232  if( m_view )
233  {
236  }
237 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:585
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
Main rendering target (cached)
Definition: definitions.h:48
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

References EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::MarkTargetDirty(), KIGFX::GAL::ResizeScreen(), KIGFX::TARGET_CACHED, and KIGFX::TARGET_NONCACHED.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ RedrawRatsnest()

void PCB_DRAW_PANEL_GAL::RedrawRatsnest ( )

Forces refresh of the ratsnest visual representation

Definition at line 424 of file pcb_draw_panel_gal.cpp.

425 {
426  if( m_ratsnest )
427  m_view->Update( m_ratsnest.get() );
428 }
std::unique_ptr< KIGFX::RATSNEST_VIEWITEM > m_ratsnest
Ratsnest view item
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
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

References m_ratsnest, EDA_DRAW_PANEL_GAL::m_view, and KIGFX::VIEW::Update().

Referenced by BOARD_COMMIT::Push(), PCB_INSPECTION_TOOL::ratsnestTimer(), and PCBNEW_CONTROL::ToggleRatsnest().

◆ Refresh()

void EDA_DRAW_PANEL_GAL::Refresh ( bool  aEraseBackground = true,
const wxRect *  aRect = NULL 
)
overridevirtualinherited

Update the board display after modifying it by a python script (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins.

Could be deprecated because modifying a board (especially deleting items) outside a action plugin can crash Pcbnew.

Reimplemented in SCH_PREVIEW_PANEL.

Definition at line 240 of file draw_panel_gal.cpp.

241 {
242  if( m_pendingRefresh )
243  return;
244 
245  m_pendingRefresh = true;
246 
247 #ifdef __WXMAC__
248  // Timers on OS X may have a high latency (seen up to 500ms and more) which
249  // makes repaints jerky. No negative impact seen without throttling, so just
250  // do an unconditional refresh for OS X.
251  ForceRefresh();
252 #else
253  wxLongLong t = wxGetLocalTimeMillis();
254  wxLongLong delta = t - m_lastRefresh;
255 
256  if( delta >= MinRefreshPeriod )
257  {
258  ForceRefresh();
259  }
260  else
261  {
262  // One shot timer
263  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
264  }
265 #endif
266 }
bool m_pendingRefresh
Last timestamp when the panel was refreshed.
wxTimer m_refreshTimer
Is there a redraw event requested?
void ForceRefresh()
Function ForceRefresh() Forces a redraw.
static const int MinRefreshPeriod
60 FPS.
wxLongLong m_lastRefresh
Parent EDA_DRAW_FRAME (if available)

References EDA_DRAW_PANEL_GAL::ForceRefresh(), EDA_DRAW_PANEL_GAL::m_lastRefresh, EDA_DRAW_PANEL_GAL::m_pendingRefresh, EDA_DRAW_PANEL_GAL::m_refreshTimer, and EDA_DRAW_PANEL_GAL::MinRefreshPeriod.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AnnotateComponents(), FOOTPRINT_VIEWER_FRAME::ApplyDisplaySettingsToGAL(), DISPLAY_FOOTPRINTS_FRAME::ApplyDisplaySettingsToGAL(), SCH_EDITOR_CONTROL::BackAnnotateFootprints(), SCH_EDIT_TOOL::BreakWire(), SCH_BASE_FRAME::CenterScreen(), ZONE_FILLER_TOOL::CheckAllZones(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), SCH_EDIT_FRAME::DeleteAnnotation(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_EDIT_TOOL::DoDelete(), DIALOG_DRC_CONTROL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_TOOL::editGraphicProperties(), LIB_EDIT_TOOL::editTextProperties(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::Files_io(), ZONE_FILLER_TOOL::FillAllZones(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), DIALOG_DRC_CONTROL::focusOnItem(), PCBNEW_CONTROL::GraphicDisplayMode(), GERBVIEW_CONTROL::HighlightControl(), DIALOG_SELECT_NET_FROM_LIST::HighlightNet(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), SCH_EDIT_FRAME::KiwayMailIn(), GERBVIEW_FRAME::loadListOfGerberAndDrillFiles(), EE_POINT_EDITOR::Main(), PCBNEW_CONTROL::ModuleEdgeOutlines(), PCBNEW_CONTROL::ModuleTextOutlines(), DIALOG_MIGRATE_BUSES::onAcceptClicked(), DIALOG_EDIT_COMPONENTS_LIBID::onApplyButton(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_EXCHANGE_FOOTPRINTS::OnApplyClicked(), DIALOG_ERC::OnEraseDrcMarkersClick(), EDA_DRAW_PANEL_GAL::OnEvent(), PCB_BASE_EDIT_FRAME::OnGridSettings(), SCH_BASE_FRAME::OnGridSettings(), PCB_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerSelect(), GERBER_LAYER_WIDGET::OnLayerSelect(), PCB_LAYER_WIDGET::OnLayerVisible(), GERBER_LAYER_WIDGET::OnLayerVisible(), SCH_EDIT_FRAME::OnModify(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRemapSymbols(), PCB_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBER_LAYER_WIDGET::OnRenderEnable(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnRightUpItem(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectDisplayMode(), EDA_DRAW_FRAME::OnSelectGrid(), GERBVIEW_FRAME::OnSelectHighlightChoice(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), EDA_DRAW_FRAME::OnSelectZoom(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), PCB_BASE_FRAME::OnToggleEdgeDrawMode(), PCB_BASE_FRAME::OnToggleGraphicDrawMode(), PCB_BASE_FRAME::OnTogglePadDrawMode(), PCB_BASE_FRAME::OnToggleTextDrawMode(), PCBNEW_CONTROL::PadDisplayMode(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_TOOL::Properties(), MODULE_EDITOR_TOOLS::Properties(), PCB_INSPECTION_TOOL::ratsnestTimer(), LIB_EDIT_FRAME::RebuildView(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListLib(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), SCH_EDITOR_CONTROL::Redo(), DIALOG_PAD_PROPERTIES::redraw(), DIALOG_ERC::RedrawDrawPanel(), DIALOG_DRC_CONTROL::RedrawDrawPanel(), SCH_BASE_FRAME::RedrawScreen(), SCH_PREVIEW_PANEL::Refresh(), Refresh(), refreshCallback(), EDA_DRAW_FRAME::RefreshCanvas(), SCH_BASE_FRAME::RefreshItem(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SCH_EDIT_FRAME::rescueProject(), DIALOG_EDIT_COMPONENTS_LIBID::revertChanges(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), GERBVIEW_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetGridVisibility(), LIB_VIEW_FRAME::SetSelectedLibrary(), LIB_CONTROL::ShowElectricalTypes(), GERBVIEW_FRAME::SortLayersByX2Attributes(), GLOBAL_EDIT_TOOL::SwapLayers(), SCH_DRAW_PANEL::SwitchBackend(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_ERC::TestErc(), COMMON_TOOLS::ToggleGrid(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PCBNEW_CONTROL::ToggleRatsnest(), PCBNEW_CONTROL::TrackDisplayMode(), PANEL_LIBEDIT_SETTINGS::TransferDataFromWindow(), PANEL_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_EDIT_LINE_STYLE::TransferDataFromWindow(), PANEL_PCBNEW_SETTINGS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_EDIT_SHEET_PIN::TransferDataFromWindow(), DIALOG_UPDATE_FIELDS::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::Undo(), GERBVIEW_FRAME::UpdateDisplayOptions(), SCH_EDIT_TOOL::UpdateFields(), SCH_EDITOR_CONTROL::UpdateFind(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneUnfill(), ZONE_FILLER_TOOL::ZoneUnfillAll(), and DIALOG_FIELDS_EDITOR_GLOBAL::~DIALOG_FIELDS_EDITOR_GLOBAL().

◆ SetCurrentCursor() [1/2]

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( wxStockCursor  aStockCursorID)
inherited

Function SetCurrentCursor Set the current cursor shape for this panel.

Definition at line 501 of file draw_panel_gal.cpp.

502 {
503  if ( aStockCursorID <= wxCURSOR_NONE || aStockCursorID >= wxCURSOR_MAX )
504  aStockCursorID = wxCURSOR_ARROW;
505 
506  SetCurrentCursor( wxCursor( aStockCursorID ) );
507 }
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), ZOOM_TOOL::Main(), SCH_MOVE_TOOL::Main(), LIB_MOVE_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::MeasureTool(), GERBVIEW_SELECTION_TOOL::MeasureTool(), EDIT_TOOL::MeasureTool(), EDIT_TOOL::Move(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), LIB_DRAWING_TOOLS::PlaceAnchor(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), EE_POINT_EDITOR::setEditedPoint(), POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetCurrentCursor() [2/2]

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( const wxCursor &  aCursor)
inherited

Definition at line 510 of file draw_panel_gal.cpp.

511 {
512  m_currentCursor = aCursor;
513  SetCursor( m_currentCursor );
514 }

References EDA_DRAW_PANEL_GAL::m_currentCursor.

◆ setDefaultLayerDeps()

void PCB_DRAW_PANEL_GAL::setDefaultLayerDeps ( )
protected

Sets rendering targets & dependencies for layers.

Definition at line 440 of file pcb_draw_panel_gal.cpp.

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 }
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
GAL_TYPE m_backend
Currently used GAL.
multilayer pads, usually with holes
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
handle color for not plated holes (holes, not pads)
anchor of items having an anchor point (texts, footprints)
to draw via holes (pad holes do not use this layer)
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:701
const LAYER_NUM GAL_LAYER_ORDER[]
Auxiliary rendering target (noncached)
Definition: definitions.h:49
show modules on front
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Function SetLayerTarget() Changes the rendering target for a particular layer.
Definition: view.h:434
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Definition: view.h:422
to draw usual through hole vias
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
smd pads, front layer
Main rendering target (cached)
Definition: definitions.h:48
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
currently selected items overlay
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
Additional netnames layers (not associated with a PCB layer)
bool IsNetnameLayer(LAYER_NUM aLayer)
Function IsNetnameLayer tests whether a layer is a netname layer.

References B_Cu, F_Cu, GAL_LAYER_ORDER, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, GetNetnameLayer(), IsCopperLayer(), IsNetnameLayer(), LAYER_ANCHOR, LAYER_DRC, LAYER_GP_OVERLAY, LAYER_GRID, LAYER_MOD_BK, LAYER_MOD_FR, LAYER_MOD_TEXT_BK, LAYER_MOD_TEXT_FR, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK, LAYER_PAD_BK_NETNAMES, LAYER_PAD_FR, LAYER_PAD_FR_NETNAMES, LAYER_PADS_NETNAMES, LAYER_PADS_PLATEDHOLES, LAYER_PADS_TH, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIA_THROUGH, LAYER_VIAS_HOLES, LAYER_VIAS_NETNAMES, LAYER_WORKSHEET, EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::SetLayerDisplayOnly(), KIGFX::VIEW::SetLayerTarget(), KIGFX::VIEW::SetRequired(), KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by PCB_DRAW_PANEL_GAL(), and SwitchBackend().

◆ setDefaultLayerOrder()

void PCB_DRAW_PANEL_GAL::setDefaultLayerOrder ( )
protected

Reassigns layer order to the initial settings.

Definition at line 403 of file pcb_draw_panel_gal.cpp.

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 }
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:664
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:701
const LAYER_NUM GAL_LAYER_ORDER[]
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

References GAL_LAYER_ORDER, EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::SetLayerOrder(), and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by PCB_DRAW_PANEL_GAL(), and SetTopLayer().

◆ SetEventDispatcher()

void EDA_DRAW_PANEL_GAL::SetEventDispatcher ( TOOL_DISPATCHER aEventDispatcher)
inherited

Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools.

Parameters
aEventDispatcheris the object that will be used for dispatching events. DRAW_PANEL_GAL does not take over the ownership. Passing NULL disconnects all event handlers from the DRAW_PANEL_GAL and parent frame.

Definition at line 276 of file draw_panel_gal.cpp.

277 {
278  m_eventDispatcher = aEventDispatcher;
279  const wxEventType eventTypes[] = { wxEVT_TOOL };
280 
281  if( m_eventDispatcher )
282  {
283  for( wxEventType type : eventTypes )
284  {
285  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
287  }
288  }
289  else
290  {
291  for( wxEventType type : eventTypes )
292  {
293  // While loop is used to be sure that all event handlers are removed.
294  while( m_parent->Disconnect( type,
295  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
296  NULL, m_eventDispatcher ) );
297  }
298  }
299 }
wxWindow * m_parent
Current mouse cursor shape id.
#define NULL
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
virtual void DispatchWxCommand(wxCommandEvent &aEvent)
Function DispatchWxCommand() Processes wxCommands (mostly menu related events) and runs appropriate a...

References TOOL_DISPATCHER::DispatchWxCommand(), EDA_DRAW_PANEL_GAL::m_eventDispatcher, EDA_DRAW_PANEL_GAL::m_parent, and NULL.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), LIB_EDIT_FRAME::setupTools(), and SCH_EDIT_FRAME::setupTools().

◆ SetFocus()

void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtualinherited

Definition at line 127 of file draw_panel_gal.cpp.

128 {
129 // Windows has a strange manner on bringing up and activating windows
130 // containing a GAL canvas just after moving the mouse cursor into its area.
131 // Feel free to uncomment or extend the following #ifdef if you experience
132 // similar problems on your platform.
133 #ifdef __WINDOWS__
134  if( !GetParent()->IsDescendant( wxWindow::FindFocus() ) )
135  return;
136 #endif
137 
138  wxScrolledCanvas::SetFocus();
139  m_lostFocus = false;
140 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.

References EDA_DRAW_PANEL_GAL::m_lostFocus.

Referenced by EDA_DRAW_PANEL_GAL::onEnter(), EDA_DRAW_PANEL_GAL::OnEvent(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), GERBVIEW_FRAME::SetActiveLayer(), and ZONE_FILLER_TOOL::singleShotRefocus().

◆ SetHighContrastLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( int  aLayer)
inlineoverridevirtual

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 72 of file pcb_draw_panel_gal.h.

73  {
74  SetHighContrastLayer( static_cast< PCB_LAYER_ID >( aLayer ) );
75  }
virtual void SetHighContrastLayer(int aLayer) override

Referenced by PCBNEW_CONTROL::HighContrastMode().

◆ SetHighContrastLayer() [2/2]

void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( PCB_LAYER_ID  aLayer)

SetHighContrastLayer(), with some extra smarts for PCB

Definition at line 216 of file pcb_draw_panel_gal.cpp.

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 }
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.
handle color for not plated holes (holes, not pads)
to draw via holes (pad holes do not use this layer)
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
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
show modules on front
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
Definition: painter.h:98
to draw usual through hole vias
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
smd pads, front layer
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
currently selected items overlay
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
virtual void SetTopLayer(int aLayer) override
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:798
Additional netnames layers (not associated with a PCB layer)

References B_Cu, KIGFX::RENDER_SETTINGS::ClearActiveLayers(), F_Cu, GetNetnameLayer(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), IsCopperLayer(), LAYER_CURSOR, LAYER_GP_OVERLAY, LAYER_MOD_BK, LAYER_MOD_FR, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK, LAYER_PAD_BK_NETNAMES, LAYER_PAD_FR, LAYER_PAD_FR_NETNAMES, LAYER_PADS_NETNAMES, LAYER_PADS_PLATEDHOLES, LAYER_PADS_TH, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIA_THROUGH, LAYER_VIAS_HOLES, LAYER_VIAS_NETNAMES, EDA_DRAW_PANEL_GAL::m_view, KIGFX::RENDER_SETTINGS::SetActiveLayer(), SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersColor().

◆ SetStealsFocus()

void EDA_DRAW_PANEL_GAL::SetStealsFocus ( bool  aStealsFocus)
inlineinherited

Set whether focus is taken on certain events (mouseover, keys, etc).

This should be true (and is by default) for any primary canvas, but can be false to make well-behaved preview panes and the like.

Definition at line 178 of file class_draw_panel_gal.h.

178 { m_stealsFocus = aStealsFocus; }
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

References EDA_DRAW_PANEL_GAL::m_stealsFocus.

Referenced by FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

◆ SetTopLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
inlineoverridevirtual

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 81 of file pcb_draw_panel_gal.h.

82  {
83  SetTopLayer( static_cast< PCB_LAYER_ID >( aLayer ) );
84  }
virtual void SetTopLayer(int aLayer) override

Referenced by OnShow(), and SetHighContrastLayer().

◆ SetTopLayer() [2/2]

void PCB_DRAW_PANEL_GAL::SetTopLayer ( PCB_LAYER_ID  aLayer)

SetTopLayer(), with some extra smarts for PCB

Definition at line 261 of file pcb_draw_panel_gal.cpp.

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 }
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:664
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
multilayer pads, usually with holes
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
handle color for not plated holes (holes, not pads)
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
void setDefaultLayerOrder()
Reassigns layer order to the initial settings.
to draw via holes (pad holes do not use this layer)
void UpdateAllLayersOrder()
Function UpdateLayerOrder() Does everything that is needed to apply the rendering order of layers.
Definition: view.cpp:927
virtual void EnableTopLayer(bool aEnable)
Function EnableTopLayer() Enables or disables display of the top layer.
Definition: view.cpp:887
const LAYER_NUM GAL_LAYER_ORDER[]
#define NULL
to draw usual through hole vias
void ClearTopLayers()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:912
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
smd pads, front layer
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
int GetLayerOrder(int aLayer) const
Function GetLayerOrder() Returns rendering order of a particular layer.
Definition: view.cpp:672
currently selected items overlay
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
Additional netnames layers (not associated with a PCB layer)

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, KIGFX::VIEW::ClearTopLayers(), KIGFX::VIEW::EnableTopLayer(), F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, GAL_LAYER_ORDER, KIGFX::VIEW::GetLayerOrder(), GetNetnameLayer(), IsBackLayer(), IsCopperLayer(), IsFrontLayer(), LAYER_DRC, LAYER_GP_OVERLAY, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK, LAYER_PAD_BK_NETNAMES, LAYER_PAD_FR, LAYER_PAD_FR_NETNAMES, LAYER_PADS_NETNAMES, LAYER_PADS_PLATEDHOLES, LAYER_PADS_TH, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIA_THROUGH, LAYER_VIAS_HOLES, LAYER_VIAS_NETNAMES, EDA_DRAW_PANEL_GAL::m_view, NETNAMES_LAYER_INDEX, NULL, setDefaultLayerOrder(), KIGFX::VIEW::SetLayerOrder(), KIGFX::VIEW::SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersOrder().

◆ SetWorksheet()

void PCB_DRAW_PANEL_GAL::SetWorksheet ( KIGFX::WS_PROXY_VIEW_ITEM aWorksheet)

Function SetWorksheet Sets (or updates) worksheet used by the draw panel.

Parameters
aWorksheetis the worksheet to be used. The object is then owned by PCB_DRAW_PANEL_GAL.

Definition at line 199 of file pcb_draw_panel_gal.cpp.

200 {
201  m_worksheet.reset( aWorksheet );
202  m_view->Add( m_worksheet.get() );
203 }
std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEM > m_worksheet
Currently used worksheet
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346

References KIGFX::VIEW::Add(), EDA_DRAW_PANEL_GAL::m_view, and m_worksheet.

◆ StartDrawing()

void EDA_DRAW_PANEL_GAL::StartDrawing ( )
inherited

◆ StopDrawing()

void EDA_DRAW_PANEL_GAL::StopDrawing ( )
inherited

Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDrawing() is called.

Definition at line 309 of file draw_panel_gal.cpp.

310 {
311  m_drawingEnabled = false;
312  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
313  m_pendingRefresh = false;
314  m_refreshTimer.Stop();
315 }
bool m_pendingRefresh
Last timestamp when the panel was refreshed.
wxTimer m_refreshTimer
Is there a redraw event requested?
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.

References EDA_DRAW_PANEL_GAL::m_drawingEnabled, EDA_DRAW_PANEL_GAL::m_pendingRefresh, EDA_DRAW_PANEL_GAL::m_refreshTimer, NULL, and EDA_DRAW_PANEL_GAL::onPaint().

Referenced by DIALOG_PAD_PROPERTIES::OnCancel(), LIB_VIEW_FRAME::OnCloseWindow(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), GERBVIEW_FRAME::OnCloseWindow(), DIALOG_PAD_PROPERTIES::redraw(), EDA_DRAW_PANEL_GAL::SwitchBackend(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ SwitchBackend()

bool PCB_DRAW_PANEL_GAL::SwitchBackend ( GAL_TYPE  aGalType)
overridevirtual

Function SwitchBackend Switches method of rendering graphics.

Parameters
aGalTypeis a type of rendering engine that you want to use.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 415 of file pcb_draw_panel_gal.cpp.

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 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.

References EDA_DRAW_PANEL_GAL::m_gal, setDefaultLayerDeps(), KIGFX::GAL::SetWorldUnitLength(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

Referenced by OnShow(), and DIALOG_PAD_PROPERTIES::prepareCanvas().

◆ SyncLayersVisibility()

void PCB_DRAW_PANEL_GAL::SyncLayersVisibility ( const BOARD aBoard)

Function SyncLayersVisibility Updates "visibility" property of each layer of a given BOARD.

Parameters
aBoardcontains layers visibility settings to be applied.

Definition at line 317 of file pcb_draw_panel_gal.cpp.

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 }
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
to draw via holes (pad holes do not use this layer)
Add new GAL layers here.
PCB_LAYER_ID
A quick note on layer IDs:
void SetLayerVisible(int aLayer, bool aVisible=true)
Function SetLayerVisible() Controls the visibility of a particular layer.
Definition: view.h:399
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Function IsElementVisible tests whether a given element category is visible.
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
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
currently selected items overlay

References GAL_LAYER_ID_END, GAL_LAYER_ID_START, BOARD::IsElementVisible(), BOARD::IsLayerVisible(), LAYER_GP_OVERLAY, LAYER_PADS_PLATEDHOLES, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIAS_HOLES, EDA_DRAW_PANEL_GAL::m_view, NETNAMES_LAYER_ID_END, NETNAMES_LAYER_ID_START, PCB_LAYER_ID_COUNT, and KIGFX::VIEW::SetLayerVisible().

Referenced by PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), and FOOTPRINT_EDIT_FRAME::UpdateUserInterface().

◆ UseColorScheme()

void PCB_DRAW_PANEL_GAL::UseColorScheme ( const COLORS_DESIGN_SETTINGS aSettings)

Function UseColorScheme Applies layer color settings.

Parameters
aSettingsare the new settings.

Definition at line 206 of file pcb_draw_panel_gal.cpp.

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 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void ImportLegacyColors(const COLORS_DESIGN_SETTINGS *aSettings) override
Function ImportLegacyColors Loads a list of color settings for layers.
Definition: pcb_painter.cpp:79
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
COLOR4D GetItemColor(int aItemIdx) const
Function GetItemColor.
PCB_RENDER_SETTINGS Stores PCB specific render settings.
Definition: pcb_painter.h:61
COLOR4D GetLayerColor(LAYER_NUM aLayer) const
Function GetLayerColor.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

References COLORS_DESIGN_SETTINGS::GetItemColor(), COLORS_DESIGN_SETTINGS::GetLayerColor(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), KIGFX::PCB_RENDER_SETTINGS::ImportLegacyColors(), LAYER_CURSOR, LAYER_GRID, EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_view, KIGFX::GAL::SetCursorColor(), and KIGFX::GAL::SetGridColor().

Referenced by FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_BASE_EDIT_FRAME::SetBoard(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), and FOOTPRINT_EDIT_FRAME::updateView().

Member Data Documentation

◆ m_backend

◆ m_currentCursor

wxCursor EDA_DRAW_PANEL_GAL::m_currentCursor
protectedinherited

◆ m_drawing

bool EDA_DRAW_PANEL_GAL::m_drawing
protectedinherited

Timer to prevent too-frequent refreshing.

True if GAL is currently redrawing the view

Definition at line 221 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::onPaint(), EDA_DRAW_PANEL_GAL::onRefreshTimer(), and EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL().

◆ m_drawingEnabled

bool EDA_DRAW_PANEL_GAL::m_drawingEnabled
protectedinherited

Flag that determines if VIEW may use GAL for redrawing the screen.

Definition at line 224 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::onRefreshTimer(), and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ m_edaFrame

EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::m_edaFrame
protectedinherited

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protectedinherited

Processes and forwards events to tools.

Definition at line 246 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::OnEvent(), and EDA_DRAW_PANEL_GAL::SetEventDispatcher().

◆ m_gal

◆ m_lastRefresh

wxLongLong EDA_DRAW_PANEL_GAL::m_lastRefresh
protectedinherited

Parent EDA_DRAW_FRAME (if available)

Definition at line 216 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::onPaint(), and EDA_DRAW_PANEL_GAL::Refresh().

◆ m_lostFocus

bool EDA_DRAW_PANEL_GAL::m_lostFocus
protectedinherited

Flag to indicate that focus should be regained on the next mouse event.

It is a workaround for cases when the panel loses keyboard focus, so it does not react to hotkeys anymore.

Definition at line 250 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::OnEvent(), EDA_DRAW_PANEL_GAL::onLostFocus(), and EDA_DRAW_PANEL_GAL::SetFocus().

◆ m_onShowTimer

wxTimer EDA_DRAW_PANEL_GAL::m_onShowTimer
protectedinherited

Timer used to execute OnShow() when the window finally appears on the screen.

Definition at line 227 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), and EDA_DRAW_PANEL_GAL::onShowTimer().

◆ m_options

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_PANEL_GAL::m_options
protectedinherited

Definition at line 243 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ m_painter

◆ m_parent

wxWindow* EDA_DRAW_PANEL_GAL::m_parent
protectedinherited

◆ m_pendingRefresh

bool EDA_DRAW_PANEL_GAL::m_pendingRefresh
protectedinherited

◆ m_ratsnest

std::unique_ptr<KIGFX::RATSNEST_VIEWITEM> PCB_DRAW_PANEL_GAL::m_ratsnest
protected

Ratsnest view item

Definition at line 124 of file pcb_draw_panel_gal.h.

Referenced by DisplayBoard(), and RedrawRatsnest().

◆ m_refreshTimer

wxTimer EDA_DRAW_PANEL_GAL::m_refreshTimer
protectedinherited

◆ m_stealsFocus

bool EDA_DRAW_PANEL_GAL::m_stealsFocus
protectedinherited

Flag to indicate whether the panel should take focus at certain times (when moused over, and on various mouse/key events)

Definition at line 254 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::onEnter(), EDA_DRAW_PANEL_GAL::OnEvent(), and EDA_DRAW_PANEL_GAL::SetStealsFocus().

◆ m_view

◆ m_viewControls

◆ m_worksheet

std::unique_ptr<KIGFX::WS_PROXY_VIEW_ITEM> PCB_DRAW_PANEL_GAL::m_worksheet
protected

Currently used worksheet

Definition at line 121 of file pcb_draw_panel_gal.h.

Referenced by DisplayBoard(), GetDefaultViewBBox(), and SetWorksheet().

◆ MinRefreshPeriod

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotectedinherited

60 FPS.

Definition at line 209 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::Refresh().


The documentation for this class was generated from the following files: