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::WORKSHEET_VIEWITEM *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_T 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 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::VIEWGetView () const
 Function GetView() Returns a pointer to the VIEW 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...
 
bool GetStealsFocus () const
 Get whether focus is taken on certain events (see SetStealsFocus()). More...
 
virtual void SetDefaultCursor ()
 
virtual void SetCurrentCursor (int aCursor)
 Function SetCurrentCursor Set the current cursor shape for this panel. More...
 
virtual int GetDefaultCursor () const
 Function GetDefaultCursor. More...
 
int GetCurrentCursor () const
 Function GetCurrentCursor. More...
 
void OnEvent (wxEvent &aEvent)
 Used to forward events to the canvas from popups, etc. More...
 

Protected Member Functions

KIGFX::PCB_VIEWview () const
 
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)
 

Protected Attributes

std::unique_ptr< KIGFX::WORKSHEET_VIEWITEMm_worksheet
 

Currently used worksheet

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

Ratsnest view item

More...
 
int m_currentCursor
 Current mouse cursor shape id. More...
 
int m_defaultCursor
 The default mouse cursor shape id. More...
 
wxWindow * m_parent
 Pointer to the parent window. More...
 
EDA_DRAW_FRAMEm_edaFrame
 Parent EDA_DRAW_FRAME (if available) More...
 
wxLongLong m_lastRefresh
 Last timestamp when the panel was refreshed. More...
 
bool m_pendingRefresh
 Is there a redraw event requested? More...
 
bool m_drawing
 True if GAL is currently redrawing the view. More...
 
bool m_drawingEnabled
 Flag that determines if VIEW may use GAL for redrawing the screen. More...
 
wxTimer m_refreshTimer
 Timer responsible for preventing too frequent refresh. 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 60 of file class_draw_panel_gal.h.

60  {
61  GAL_TYPE_UNKNOWN = -1,
62  GAL_TYPE_NONE = 0,
66  };
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 106 of file pcb_draw_panel_gal.cpp.

108  :
109  EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
110 {
111  m_view = new KIGFX::PCB_VIEW( true );
112  m_view->SetGAL( m_gal );
113 
114  m_painter.reset( new KIGFX::PCB_PAINTER( m_gal ) );
115  m_view->SetPainter( m_painter.get() );
116 
119 
120  // View controls is the first in the event handler chain, so the Tool Framework operates
121  // on updated viewport data.
123 
124  // Load display options (such as filled/outline display of items).
125  // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
126  // which is not always the case (namely when it is used from a wxDialog like the pad editor)
128 
129  if( frame )
130  {
131  auto opts = (PCB_DISPLAY_OPTIONS*) frame->GetDisplayOptions();
132  static_cast<KIGFX::PCB_VIEW*>( m_view )->UpdateDisplayOptions( opts );
133  }
134 }
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.)
Class WX_VIEW_CONTROLS is a specific implementation of class VIEW_CONTROLS for wxWidgets library.
void setDefaultLayerOrder()
Reassigns layer order to the initial settings.
The base class for create windows for drawing purpose.
Definition: draw_frame.h:81
Class PCB_PAINTER Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:211
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
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
virtual void * GetDisplayOptions()
A way to pass info to draw functions.
Definition: draw_frame.h:948

References EDA_DRAW_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 137 of file pcb_draw_panel_gal.cpp.

138 {
139 }

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 142 of file pcb_draw_panel_gal.cpp.

143 {
144 
145  m_view->Clear();
146 
147  auto zones = aBoard->Zones();
148  std::atomic<size_t> next( 0 );
149  std::atomic<size_t> count_done( 0 );
150  size_t parallelThreadCount = std::max<size_t>( std::thread::hardware_concurrency(), 2 );
151 
152  for( size_t ii = 0; ii < parallelThreadCount; ++ii )
153  {
154  std::thread t = std::thread( [ &count_done, &next, &zones ]( )
155  {
156  for( size_t i = next.fetch_add( 1 ); i < zones.size(); i = next.fetch_add( 1 ) )
157  zones[i]->CacheTriangulation();
158 
159  count_done++;
160  } );
161 
162  t.detach();
163  }
164 
165  if( m_worksheet )
166  m_worksheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
167 
168  // Load drawings
169  for( auto drawing : const_cast<BOARD*>(aBoard)->Drawings() )
170  m_view->Add( drawing );
171 
172  // Load tracks
173  for( TRACK* track = aBoard->m_Track; track; track = track->Next() )
174  m_view->Add( track );
175 
176  // Load modules and its additional elements
177  for( MODULE* module = aBoard->m_Modules; module; module = module->Next() )
178  m_view->Add( module );
179 
180  // Segzones (deprecated, equivalent of ZONE_CONTAINERfilled areas for very old boards)
181  for( SEGZONE* zone = aBoard->m_SegZoneDeprecated; zone; zone = zone->Next() )
182  m_view->Add( zone );
183 
184  // DRC markers
185  for( int marker_idx = 0; marker_idx < aBoard->GetMARKERCount(); ++marker_idx )
186  {
187  m_view->Add( aBoard->GetMARKER( marker_idx ) );
188  }
189 
190  // Finalize the triangulation threads
191  while( count_done < parallelThreadCount )
192  std::this_thread::sleep_for( std::chrono::milliseconds( 10 ) );
193 
194  // Load zones
195  for( auto zone : aBoard->Zones() )
196  m_view->Add( zone );
197 
198  // Ratsnest
199  m_ratsnest.reset( new KIGFX::RATSNEST_VIEWITEM( aBoard->GetConnectivity() ) );
200  m_view->Add( m_ratsnest.get() );
201 }
CITER next(CITER it)
Definition: ptree.cpp:130
int GetMARKERCount() const
Function GetMARKERCount.
Definition: class_board.h:340
std::unique_ptr< KIGFX::WORKSHEET_VIEWITEM > m_worksheet
Currently used worksheet
const wxString & GetFileName() const
Definition: class_board.h:238
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:47
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1110
DLIST< SEGZONE > m_SegZoneDeprecated
Definition: class_board.h:251
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:297
MARKER_PCB * GetMARKER(int index) const
Function GetMARKER returns the MARKER at a given index.
Definition: class_board.h:328
ZONE_CONTAINERS & Zones()
Definition: class_board.h:257
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
DLIST< MODULE > m_Modules
Definition: class_board.h:249
size_t i
Definition: json11.cpp:597
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
DLIST< TRACK > m_Track
Definition: class_board.h:250

References KIGFX::VIEW::Add(), KIGFX::VIEW::Clear(), BOARD::GetConnectivity(), BOARD::GetFileName(), BOARD::GetMARKER(), BOARD::GetMARKERCount(), i, BOARD::m_Modules, m_ratsnest, BOARD::m_SegZoneDeprecated, BOARD::m_Track, EDA_DRAW_PANEL_GAL::m_view, m_worksheet, next(), TO_UTF8, and BOARD::Zones().

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

◆ ForceRefresh()

◆ GetBackend()

GAL_TYPE EDA_DRAW_PANEL_GAL::GetBackend ( ) const
inlineinherited

◆ GetCurrentCursor()

int EDA_DRAW_PANEL_GAL::GetCurrentCursor ( ) const
inlineinherited

Function GetCurrentCursor.

Returns
the current cursor shape, depending on the current selected tool

Definition at line 225 of file class_draw_panel_gal.h.

225 { return m_currentCursor; }
int m_currentCursor
Current mouse cursor shape id.

References EDA_DRAW_PANEL_GAL::m_currentCursor.

◆ GetDefaultCursor()

virtual int EDA_DRAW_PANEL_GAL::GetDefaultCursor ( ) const
inlinevirtualinherited

Function GetDefaultCursor.

Returns
the default cursor shape

Definition at line 219 of file class_draw_panel_gal.h.

219 { return m_defaultCursor; }
int m_defaultCursor
The default mouse cursor shape id.

References EDA_DRAW_PANEL_GAL::m_defaultCursor.

Referenced by EDA_DRAW_FRAME::SetNoToolSelected().

◆ GetDefaultViewBBox()

BOX2I PCB_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
overridevirtual

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 437 of file pcb_draw_panel_gal.cpp.

438 {
439  if( m_worksheet )
440  return m_worksheet->ViewBBox();
441 
442  return BOX2I();
443 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
std::unique_ptr< KIGFX::WORKSHEET_VIEWITEM > m_worksheet
Currently used worksheet

References 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 356 of file draw_panel_gal.cpp.

357 {
359 }
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.
Definition: draw_frame.h:471
double GetZoomFactor() const
Get the zoom factor.
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)

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(), PCB_BASE_FRAME::OnUpdateSelectZoom(), EDA_DRAW_FRAME::SetNextZoomAndRedraw(), and EDA_DRAW_FRAME::SetPreviousZoomAndRedraw().

◆ GetMsgPanelInfo()

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

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 344 of file pcb_draw_panel_gal.cpp.

345 {
346  BOARD* board = static_cast<PCB_BASE_FRAME*>( m_parent )->GetBoard();
347  wxString txt;
348  int viasCount = 0;
349  int trackSegmentsCount = 0;
350 
351  for( const BOARD_ITEM* item = board->m_Track; item; item = item->Next() )
352  {
353  if( item->Type() == PCB_VIA_T )
354  viasCount++;
355  else
356  trackSegmentsCount++;
357  }
358 
359  txt.Printf( wxT( "%d" ), board->GetPadCount() );
360  aList.push_back( MSG_PANEL_ITEM( _( "Pads" ), txt, DARKGREEN ) );
361 
362  txt.Printf( wxT( "%d" ), viasCount );
363  aList.push_back( MSG_PANEL_ITEM( _( "Vias" ), txt, DARKGREEN ) );
364 
365  txt.Printf( wxT( "%d" ), trackSegmentsCount );
366  aList.push_back( MSG_PANEL_ITEM( _( "Track Segments" ), txt, DARKGREEN ) );
367 
368  txt.Printf( wxT( "%d" ), board->GetNodesCount() );
369  aList.push_back( MSG_PANEL_ITEM( _( "Nodes" ), txt, DARKCYAN ) );
370 
371  txt.Printf( wxT( "%d" ), board->GetNetCount() - 1 /* don't include "No Net" in count */ );
372  aList.push_back( MSG_PANEL_ITEM( _( "Nets" ), txt, RED ) );
373 
374  txt.Printf( wxT( "%d" ), board->GetConnectivity()->GetUnconnectedCount() );
375  aList.push_back( MSG_PANEL_ITEM( _( "Unrouted" ), txt, BLUE ) );
376 }
Definition: colors.h:57
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
wxWindow * m_parent
Pointer to the parent window.
unsigned GetNodesCount(int aNet=-1)
Function GetNodesCount.
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:785
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:297
Definition: colors.h:60
unsigned GetPadCount()
Function GetPadCount.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:171
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
DLIST< TRACK > m_Track
Definition: class_board.h:250
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53

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

◆ 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 179 of file class_draw_panel_gal.h.

180  {
181  return m_edaFrame;
182  }
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)

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().

◆ GetStealsFocus()

bool EDA_DRAW_PANEL_GAL::GetStealsFocus ( ) const
inlineinherited

Get whether focus is taken on certain events (see SetStealsFocus()).

Definition at line 203 of file class_draw_panel_gal.h.

204  {
205  return m_stealsFocus;
206  }
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.

◆ GetView()

KIGFX::VIEW* EDA_DRAW_PANEL_GAL::GetView ( ) const
inlineinherited

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

Returns
The instance of VIEW.

Definition at line 106 of file class_draw_panel_gal.h.

107  {
108  return m_view;
109  }
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(), GERBVIEW_FRAME::applyDisplaySettingsToGAL(), GRID_HELPER::BestSnapAnchor(), DIALOG_PRINT_PCBNEW::createPrintout(), DIALOG_PRINT_GERBVIEW::createPrintout(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), COMMON_TOOLS::doZoomToPreset(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), EVT_GRID_CMD_CELL_CHANGED(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), EDA_DRAW_FRAME::FocusOnLocation(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), PCB_BASE_FRAME::GetCollectorsGuide(), SCH_BASE_FRAME::GetRenderSettings(), GRID_HELPER::GRID_HELPER(), SCH_EDIT_FRAME::HighlightConnectionAtPosition(), GERBVIEW_CONTROL::HighlightControl(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), FOOTPRINT_PREVIEW_PANEL::New(), DIALOG_PAD_PROPERTIES::onChangePadMode(), GERBVIEW_FRAME::OnCloseWindow(), PCB_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerVisible(), EDA_DRAW_PANEL_GAL::onPaint(), PCB_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), PCB_EDIT_FRAME::OnSelectOptionToolbar(), PCB_BASE_FRAME::OnToggleEdgeDrawMode(), EDA_DRAW_FRAME::OnToggleGridState(), PCB_BASE_FRAME::OnTogglePadDrawMode(), PCB_BASE_FRAME::OnToggleTextDrawMode(), EDA_DRAW_FRAME::OnZoom(), DIALOG_UPDATE_PCB::PerformUpdate(), LIB_EDIT_FRAME::PlaceAnchor(), DIALOG_PAD_PROPERTIES::prepareCanvas(), processBoardItem(), GRID_HELPER::queryVisible(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_PAD_PROPERTIES::redraw(), refreshCallback(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), GRID_HELPER::SetAuxAxes(), PCB_BASE_EDIT_FRAME::SetBoard(), GERBVIEW_FRAME::SetElementVisibility(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), EDA_DRAW_FRAME::SetPresetGrid(), FOOTPRINT_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::SortLayersByX2Attributes(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::Swap_Layers(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), SCH_BASE_FRAME::SyncView(), PANEL_PCBNEW_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_LIBEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), GERBVIEW_FRAME::UpdateDisplayOptions(), PCB_BASE_FRAME::UseGalCanvas(), GERBVIEW_FRAME::UseGalCanvas(), EDA_DRAW_FRAME::UseGalCanvas(), CVPCB_CONTROL::view(), SCH_BASE_FRAME::Window_Zoom(), SCH_BASE_FRAME::Zoom_Automatique(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), and SYMBOL_PREVIEW_WIDGET::~SYMBOL_PREVIEW_WIDGET().

◆ GetViewControls()

KIGFX::VIEW_CONTROLS* EDA_DRAW_PANEL_GAL::GetViewControls ( ) const
inlineinherited

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxEvent &  aEvent)
protectedinherited

Definition at line 461 of file draw_panel_gal.cpp.

462 {
463  // Getting focus is necessary in order to receive key events properly
464  if( m_stealsFocus )
465  SetFocus();
466 
467  aEvent.Skip();
468 }
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 447 of file draw_panel_gal.cpp.

448 {
449  if( m_lostFocus && m_stealsFocus )
450  SetFocus();
451 
452  if( !m_eventDispatcher )
453  aEvent.Skip();
454  else
456 
457  Refresh();
458 }
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 471 of file draw_panel_gal.cpp.

472 {
473  m_lostFocus = true;
474 
475  aEvent.Skip();
476 }
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_DRAW_PANEL, and SCH_PREVIEW_PANEL.

Definition at line 149 of file draw_panel_gal.cpp.

150 {
152 
153  // Update current zoom settings if the canvas is managed by a EDA frame
154  // (i.e. not by a preview panel in a dialog)
155  if( GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
156  {
158 
159  VECTOR2D center = GetView()->GetCenter();
160  GetParentEDAFrame()->SetScrollCenterPosition( wxPoint( center.x, center.y ) );
161  }
162 
163  if( !m_gal->IsVisible() )
164  return;
165 
166  m_pendingRefresh = false;
167 
168  if( m_drawing )
169  return;
170 
171 #ifdef __WXDEBUG__
172  PROF_COUNTER totalRealTime;
173 #endif /* PROFILE */
174 
175  wxASSERT( m_painter );
176 
177  m_drawing = true;
178  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
179 
180  try
181  {
182  m_view->UpdateItems();
183 
185 
186  m_gal->SetClearColor( settings->GetBackgroundColor() );
187  m_gal->SetGridColor( settings->GetGridColor() );
188  m_gal->SetCursorColor( settings->GetCursorColor() );
189 
190  // TODO: find why ClearScreen() must be called here in opengl mode
191  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
192  // when moving the mouse cursor
193  if( m_backend == GAL_TYPE_OPENGL )
194  m_gal->ClearScreen();
195 
196  if( m_view->IsDirty() )
197  {
198  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
200  m_gal->ClearScreen();
201 
202  m_view->ClearTargets();
203 
204  // Grid has to be redrawn only when the NONCACHED target is redrawn
206  m_gal->DrawGrid();
207 
208  m_view->Redraw();
209  }
210 
212  }
213  catch( std::runtime_error& err )
214  {
215  constexpr auto GAL_FALLBACK = GAL_TYPE_CAIRO;
216 
217  if( m_edaFrame )
218  {
219  bool use_gal = m_edaFrame->SwitchCanvas( GAL_FALLBACK );
220  m_edaFrame->UseGalCanvas( use_gal );
221  }
222  else
223  {
224  SwitchBackend( GAL_FALLBACK );
225  }
226 
228  _( "Could not use OpenGL, falling back to software rendering" ),
229  wxString( err.what() ) );
230  }
231 
232 #ifdef __WXDEBUG__
233  totalRealTime.Stop();
234  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
235 #endif /* PROFILE */
236 
237  m_lastRefresh = wxGetLocalTimeMillis();
238  m_drawing = false;
239 }
void Stop()
save the time when this function was called, and set the counter stane to stop
Definition: profile.h:83
bool m_pendingRefresh
Is there a redraw event requested?
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.
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
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.
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates)
Definition: view.h:339
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
void SetScrollCenterPosition(const wxPoint &aPoint)
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:45
virtual void UseGalCanvas(bool aEnable)
Use to switch between standard and GAL-based canvas.
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void UpdateScrollbars()
Adjusts the scrollbars position to match the current viewport.
bool m_drawing
True if GAL is currently redrawing the view.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
wxWindow * m_parent
Pointer to the parent window.
virtual void Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1144
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:585
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 bool SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1420
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
string & err
Definition: json11.cpp:598
virtual void ClearScreen()
Clear the screen.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
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:1125
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
double msecs() const
Definition: profile.h:144
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:275
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: draw_frame.h:404
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:568

References KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayInfoMessage(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), err, 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_edaFrame, 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, 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(), EDA_DRAW_FRAME::SetScrollCenterPosition(), BASE_SCREEN::SetZoom(), PROF_COUNTER::Stop(), EDA_DRAW_PANEL_GAL::SwitchBackend(), EDA_DRAW_FRAME::SwitchCanvas(), KIGFX::TARGET_NONCACHED, KIGFX::VIEW::UpdateItems(), KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars(), EDA_DRAW_FRAME::UseGalCanvas(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_PREVIEW_PANEL::onPaint(), SCH_DRAW_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 479 of file draw_panel_gal.cpp.

480 {
481  if( !m_drawingEnabled )
482  {
483  if( m_gal && m_gal->IsInitialized() )
484  {
485  m_drawing = false;
486  m_pendingRefresh = true;
487  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
488  m_drawingEnabled = true;
489  }
490  else
491  {
492  // Try again soon
493  m_refreshTimer.StartOnce( 100 );
494  return;
495  }
496  }
497 
498  wxPaintEvent redrawEvent;
499  wxPostEvent( this, redrawEvent );
500 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
bool m_drawing
True if GAL is currently redrawing the view.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
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, and EDA_DRAW_PANEL_GAL::onPaint().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ 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 379 of file pcb_draw_panel_gal.cpp.

380 {
381  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParent() );
382 
383  try
384  {
385  // Check if the current rendering backend can be properly initialized
386  m_view->UpdateItems();
387  }
388  catch( const std::runtime_error& e )
389  {
390  // Fallback to software renderer
391  DisplayError( frame, e.what() );
392  bool use_gal = SwitchBackend( GAL_TYPE_CAIRO );
393 
394  if( frame )
395  frame->UseGalCanvas( use_gal );
396  }
397 
398  if( frame )
399  {
400  SetTopLayer( frame->GetActiveLayer() );
402  KIGFX::PAINTER* painter = m_view->GetPainter();
403  auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
404  settings->LoadDisplayOptions( displ_opts, frame->ShowPageLimits() );
405  }
406 }
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
bool ShowPageLimits() const
Definition: draw_frame.h:392
virtual void UseGalCanvas(bool aEnable) override
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
Class PAINTER contains all the knowledge about how to draw graphical object onto any particular outpu...
Definition: painter.h:308
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1420
bool SwitchBackend(GAL_TYPE aGalType) override
Function SwitchBackend Switches method of rendering graphics.
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.
virtual void SetTopLayer(int aLayer) override
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:243
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.

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

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 503 of file draw_panel_gal.cpp.

504 {
505  if( m_gal && m_gal->IsVisible() )
506  {
507  m_onShowTimer.Stop();
508  OnShow();
509  }
510 }
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 242 of file draw_panel_gal.cpp.

243 {
245  wxSize clientSize = GetClientSize();
246  m_gal->ResizeScreen( clientSize.x, clientSize.y );
247 
248  if( m_view )
249  {
252  }
253 }
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:596
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 430 of file pcb_draw_panel_gal.cpp.

431 {
432  if( m_ratsnest )
433  m_view->Update( m_ratsnest.get() );
434 }
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:1539
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().

◆ 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_DRAW_PANEL, and SCH_PREVIEW_PANEL.

Definition at line 256 of file draw_panel_gal.cpp.

257 {
258  if( m_pendingRefresh )
259  return;
260 
261  m_pendingRefresh = true;
262 
263 #ifdef __WXMAC__
264  // Timers on OS X may have a high latency (seen up to 500ms and more) which
265  // makes repaints jerky. No negative impact seen without throttling, so just
266  // do an unconditional refresh for OS X.
267  ForceRefresh();
268 #else
269  wxLongLong t = wxGetLocalTimeMillis();
270  wxLongLong delta = t - m_lastRefresh;
271 
272  if( delta >= MinRefreshPeriod )
273  {
274  ForceRefresh();
275  }
276  else
277  {
278  // One shot timer
279  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
280  }
281 #endif
282 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.
void ForceRefresh()
Function ForceRefresh() Forces a redraw.
static const int delta[8][2]
Definition: solve.cpp:112
static const int MinRefreshPeriod
60 FPS.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.

References delta, 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 FOOTPRINT_VIEWER_FRAME::ApplyDisplaySettingsToGAL(), DISPLAY_FOOTPRINTS_FRAME::ApplyDisplaySettingsToGAL(), SCH_BASE_FRAME::CenterScreen(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCBNEW_CONTROL::GraphicDisplayMode(), SCH_EDIT_FRAME::HighlightConnectionAtPosition(), GERBVIEW_CONTROL::HighlightControl(), GERBVIEW_FRAME::loadListOfGerberAndDrillFiles(), PCBNEW_CONTROL::ModuleEdgeOutlines(), PCBNEW_CONTROL::ModuleTextOutlines(), EDA_DRAW_PANEL_GAL::OnEvent(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), PCBNEW_CONTROL::PadDisplayMode(), PCB_EDITOR_CONTROL::ratsnestTimer(), DIALOG_PAD_PROPERTIES::redraw(), SCH_BASE_FRAME::RedrawScreen2(), SCH_PREVIEW_PANEL::Refresh(), SCH_DRAW_PANEL::Refresh(), refreshCallback(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), GERBVIEW_FRAME::SetActiveLayer(), PCBNEW_CONTROL::TrackDisplayMode(), PCBNEW_CONTROL::ViaDisplayMode(), SCH_BASE_FRAME::Window_Zoom(), PCBNEW_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), ZONE_FILLER_TOOL::ZoneUnfill(), ZONE_FILLER_TOOL::ZoneUnfillAll(), and SCH_BASE_FRAME::Zoom_Automatique().

◆ SetCurrentCursor()

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( int  aCursor)
virtualinherited

Function SetCurrentCursor Set the current cursor shape for this panel.

Definition at line 511 of file draw_panel_gal.cpp.

512 {
513  if ( aCursor > wxCURSOR_NONE && aCursor < wxCURSOR_MAX )
514  {
515  m_currentCursor = aCursor;
516  }
517  else
518  {
519  m_currentCursor = wxCURSOR_ARROW;
520  }
521 
522  SetCursor( (wxStockCursor) m_currentCursor );
523 }
int m_currentCursor
Current mouse cursor shape id.

References EDA_DRAW_PANEL_GAL::m_currentCursor.

Referenced by EDA_DRAW_PANEL_GAL::SetDefaultCursor(), and EDA_DRAW_FRAME::SetToolID().

◆ SetDefaultCursor()

void EDA_DRAW_PANEL_GAL::SetDefaultCursor ( )
virtualinherited

Definition at line 525 of file draw_panel_gal.cpp.

526 {
528 }
int m_defaultCursor
The default mouse cursor shape id.
virtual void SetCurrentCursor(int aCursor)
Function SetCurrentCursor Set the current cursor shape for this panel.

References EDA_DRAW_PANEL_GAL::m_defaultCursor, and EDA_DRAW_PANEL_GAL::SetCurrentCursor().

◆ setDefaultLayerDeps()

void PCB_DRAW_PANEL_GAL::setDefaultLayerDeps ( )
protected

Sets rendering targets & dependencies for layers.

Definition at line 446 of file pcb_draw_panel_gal.cpp.

447 {
448  // caching makes no sense for Cairo and other software renderers
450 
451  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
452  m_view->SetLayerTarget( i, target );
453 
454  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
455  {
456  LAYER_NUM layer = GAL_LAYER_ORDER[i];
457  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
458 
459  // Set layer display dependencies & targets
460  if( IsCopperLayer( layer ) )
461  m_view->SetRequired( GetNetnameLayer( layer ), layer );
462  else if( IsNetnameLayer( layer ) )
463  m_view->SetLayerDisplayOnly( layer );
464  }
465 
468 
469  // Some more required layers settings
475 
476  // Front modules
480 
481  // Back modules
485 
492 
497 }
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:712
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:445
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Definition: view.h:433
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.
size_t i
Definition: json11.cpp:597
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(), i, 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 409 of file pcb_draw_panel_gal.cpp.

410 {
411  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
412  {
413  LAYER_NUM layer = GAL_LAYER_ORDER[i];
414  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
415 
416  m_view->SetLayerOrder( layer, i );
417  }
418 }
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:663
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:712
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.
size_t i
Definition: json11.cpp:597

References GAL_LAYER_ORDER, i, 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 292 of file draw_panel_gal.cpp.

293 {
294  m_eventDispatcher = aEventDispatcher;
295  const wxEventType eventTypes[] = { wxEVT_TOOL };
296 
297  if( m_eventDispatcher )
298  {
299  for( wxEventType type : eventTypes )
300  {
301  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
302  NULL, m_eventDispatcher );
303  }
304  }
305  else
306  {
307  for( wxEventType type : eventTypes )
308  {
309  // While loop is used to be sure that all event handlers are removed.
310  while( m_parent->Disconnect( type,
311  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
312  NULL, m_eventDispatcher ) );
313  }
314  }
315 }
wxWindow * m_parent
Pointer to the parent window.
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, and EDA_DRAW_PANEL_GAL::m_parent.

Referenced by EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_BASE_FRAME::UseGalCanvas(), and GERBVIEW_FRAME::UseGalCanvas().

◆ SetFocus()

void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtualinherited

Definition at line 133 of file draw_panel_gal.cpp.

134 {
135 // Windows has a strange manner on bringing up and activating windows
136 // containing a GAL canvas just after moving the mouse cursor into its area.
137 // Feel free to uncomment or extend the following #ifdef if you experience
138 // similar problems on your platform.
139 #ifdef __WINDOWS__
140  if( !GetParent()->IsDescendant( wxWindow::FindFocus() ) )
141  return;
142 #endif
143 
144  wxScrolledCanvas::SetFocus();
145  m_lostFocus = false;
146 }
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(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), and GERBVIEW_FRAME::SetActiveLayer().

◆ 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 221 of file pcb_draw_panel_gal.cpp.

222 {
223  // Set display settings for high contrast mode
225 
226  SetTopLayer( aLayer );
227 
228  rSettings->ClearActiveLayers();
229  rSettings->SetActiveLayer( aLayer );
230 
231  if( IsCopperLayer( aLayer ) )
232  {
233  // Bring some other layers to the front in case of copper layers and make them colored
234  // fixme do not like the idea of storing the list of layers here,
235  // should be done in some other way I guess..
236  LAYER_NUM layers[] = {
237  GetNetnameLayer( aLayer ),
242  };
243 
244  for( unsigned int i = 0; i < sizeof( layers ) / sizeof( LAYER_NUM ); ++i )
245  rSettings->SetActiveLayer( layers[i] );
246 
247  // Pads should be shown too
248  if( aLayer == B_Cu )
249  {
250  rSettings->SetActiveLayer( LAYER_PAD_BK );
251  rSettings->SetActiveLayer( LAYER_MOD_BK );
253  }
254  else if( aLayer == F_Cu )
255  {
256  rSettings->SetActiveLayer( LAYER_PAD_FR );
257  rSettings->SetActiveLayer( LAYER_MOD_FR );
259  }
260  }
261 
263 }
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.
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.
size_t i
Definition: json11.cpp:597
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:797
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(), i, 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 195 of file class_draw_panel_gal.h.

196  {
197  m_stealsFocus = aStealsFocus;
198  }
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 266 of file pcb_draw_panel_gal.cpp.

267 {
270  m_view->SetTopLayer( aLayer );
271 
272  // Layers that should always have on-top attribute enabled
273  const std::vector<LAYER_NUM> layers = {
278  };
279 
280  for( auto layer : layers )
281  m_view->SetTopLayer( layer );
282 
283  // Extra layers that are brought to the top if a F.* or B.* is selected
284  const std::vector<LAYER_NUM> frontLayers = {
287  };
288 
289  const std::vector<LAYER_NUM> backLayers = {
292  };
293 
294  const std::vector<LAYER_NUM>* extraLayers = NULL;
295 
296  // Bring a few more extra layers to the top depending on the selected board side
297  if( IsFrontLayer( aLayer ) )
298  extraLayers = &frontLayers;
299  else if( IsBackLayer( aLayer ) )
300  extraLayers = &backLayers;
301 
302  if( extraLayers )
303  {
304  for( auto layer : *extraLayers )
305  m_view->SetTopLayer( layer );
306 
307  // Move the active layer to the top
308  if( !IsCopperLayer( aLayer ) )
310  }
311  else if( IsCopperLayer( aLayer ) )
312  {
313  // Display labels for copper layers on the top
314  m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
315  }
316 
317  m_view->EnableTopLayer( true );
319 }
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:663
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:859
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:926
virtual void EnableTopLayer(bool aEnable)
Function EnableTopLayer() Enables or disables display of the top layer.
Definition: view.cpp:886
const LAYER_NUM GAL_LAYER_ORDER[]
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:911
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:671
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_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, KIGFX::VIEW::ClearTopLayers(), KIGFX::VIEW::EnableTopLayer(), F_Adhes, 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, setDefaultLayerOrder(), KIGFX::VIEW::SetLayerOrder(), KIGFX::VIEW::SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersOrder().

◆ SetWorksheet()

void PCB_DRAW_PANEL_GAL::SetWorksheet ( KIGFX::WORKSHEET_VIEWITEM 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 204 of file pcb_draw_panel_gal.cpp.

205 {
206  m_worksheet.reset( aWorksheet );
207  m_view->Add( m_worksheet.get() );
208 }
std::unique_ptr< KIGFX::WORKSHEET_VIEWITEM > 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.

Referenced by PCB_EDIT_FRAME::SetPageSettings().

◆ StartDrawing()

void EDA_DRAW_PANEL_GAL::StartDrawing ( )
inherited

Function StartDrawing() Begins drawing if it was stopped previously.

Definition at line 318 of file draw_panel_gal.cpp.

319 {
320  // Start querying GAL if it is ready
321  m_refreshTimer.StartOnce( 100 );
322 }
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.

References EDA_DRAW_PANEL_GAL::m_refreshTimer.

Referenced by FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), DIALOG_PAD_PROPERTIES::redraw(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), PCB_BASE_FRAME::UseGalCanvas(), and GERBVIEW_FRAME::UseGalCanvas().

◆ 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 325 of file draw_panel_gal.cpp.

326 {
327  m_drawingEnabled = false;
328  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
329  m_pendingRefresh = false;
330  m_refreshTimer.Stop();
331 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
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, 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(), GERBVIEW_FRAME::UseGalCanvas(), 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 421 of file pcb_draw_panel_gal.cpp.

422 {
423  bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
425  m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
426  return rv;
427 }
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 322 of file pcb_draw_panel_gal.cpp.

323 {
324  // Load layer & elements visibility settings
325  for( LAYER_NUM i = 0; i < PCB_LAYER_ID_COUNT; ++i )
327 
329  m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
330 
331  // Always enable netname layers, as their visibility is controlled by layer dependencies
333  m_view->SetLayerVisible( i, true );
334 
335  // Enable some layers that are GAL specific
341 }
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:410
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:458
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
size_t i
Definition: json11.cpp:597
currently selected items overlay

References GAL_LAYER_ID_END, GAL_LAYER_ID_START, i, 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 FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL().

◆ 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 211 of file pcb_draw_panel_gal.cpp.

212 {
214  rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
215  rs->ImportLegacyColors( aSettings );
216  m_gal->SetGridColor( aSettings->GetLayerColor( LAYER_GRID ) );
217  m_gal->SetCursorColor( aSettings->GetItemColor( LAYER_CURSOR ) );
218 }
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:77
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.
Class PCB_RENDER_SETTINGS Stores PCB specific render settings.
Definition: pcb_painter.h:62
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(), and DISPLAY_FOOTPRINTS_FRAME::updateView().

◆ view()

KIGFX::PCB_VIEW * PCB_DRAW_PANEL_GAL::view ( ) const
protected

Definition at line 500 of file pcb_draw_panel_gal.cpp.

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

References EDA_DRAW_PANEL_GAL::m_view.

Member Data Documentation

◆ m_backend

◆ m_currentCursor

int EDA_DRAW_PANEL_GAL::m_currentCursor
protectedinherited

◆ m_defaultCursor

int EDA_DRAW_PANEL_GAL::m_defaultCursor
protectedinherited

◆ m_drawing

bool EDA_DRAW_PANEL_GAL::m_drawing
protectedinherited

◆ 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 274 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 299 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

Last timestamp when the panel was refreshed.

Definition at line 265 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 303 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 280 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 296 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ m_painter

std::unique_ptr<KIGFX::PAINTER> EDA_DRAW_PANEL_GAL::m_painter
protectedinherited

◆ 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 307 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), EDA_DRAW_PANEL_GAL::GetStealsFocus(), 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::WORKSHEET_VIEWITEM> 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 251 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: