KiCad PCB EDA Suite
FOOTPRINT_PREVIEW_PANEL Class Reference

Panel that renders a single footprint via Cairo GAL, meant to be exported through Kiface. More...

#include <footprint_preview_panel.h>

Inheritance diagram for FOOTPRINT_PREVIEW_PANEL:
PCB_DRAW_PANEL_GAL KIWAY_HOLDER FOOTPRINT_PREVIEW_PANEL_BASE EDA_DRAW_PANEL_GAL

Classes

struct  CACHE_ENTRY
 

Public Types

enum  GAL_TYPE { GAL_TYPE_NONE, GAL_TYPE_OPENGL, GAL_TYPE_CAIRO, GAL_TYPE_LAST }
 

Public Member Functions

virtual ~FOOTPRINT_PREVIEW_PANEL ()
 
virtual void CacheFootprint (LIB_ID const &aFPID) override
 Preload a footprint into the cache. More...
 
virtual void DisplayFootprint (LIB_ID const &aFPID) override
 Set the currently displayed footprint. More...
 
virtual void SetStatusHandler (FOOTPRINT_STATUS_HANDLER aHandler) override
 Set the callback to receive status updates. More...
 
virtual wxWindow * GetWindow () override
 Get the underlying wxWindow. More...
 
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 (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...
 
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...
 
void Refresh (bool aEraseBackground=true, const wxRect *aRect=NULL) override
 Update the board display after modifying it bu 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...
 
void SetCurrentCursor (int aCursor)
 Function SetCurrentCursor Set the current cursor shape for this panel. More...
 
int GetDefaultCursor () const
 Function GetDefaultCursor. More...
 
int GetCurrentCursor () const
 Function GetCurrentCursor. More...
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static FOOTPRINT_PREVIEW_PANELNew (KIWAY *aKiway, wxWindow *aParent)
 
static FOOTPRINT_PREVIEW_PANEL_BASECreate (wxWindow *aParent, KIWAY &aKiway)
 Return a footprint preview panel instance via Kiface. 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...
 
void onPaint (wxPaintEvent &WXUNUSED(aEvent))
 
void onSize (wxSizeEvent &aEvent)
 
void onEvent (wxEvent &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...
 

Private Member Functions

 FOOTPRINT_PREVIEW_PANEL (KIWAY *aKiway, wxWindow *aParent, KIGFX::GAL_DISPLAY_OPTIONS &aOpts, GAL_TYPE aGalType)
 
virtual CACHE_ENTRY CacheAndReturn (LIB_ID const &aFPID)
 
void OnLoaderThreadUpdate (wxCommandEvent &aEvent)
 
void renderFootprint (MODULE *module)
 

Private Attributes

FP_LOADER_THREADm_loader
 
std::shared_ptr< FP_THREAD_IFACEm_iface
 
FOOTPRINT_STATUS_HANDLER m_handler
 
std::unique_ptr< BOARDm_dummyBoard
 
std::unique_ptr< COLORS_DESIGN_SETTINGSm_colorsSettings
 
LIB_ID m_currentFPID
 
bool m_footprintDisplayed
 

Friends

class FP_THREAD_IFACE
 
class FP_LOADER_THREAD
 

Detailed Description

Panel that renders a single footprint via Cairo GAL, meant to be exported through Kiface.

Definition at line 52 of file footprint_preview_panel.h.

Member Enumeration Documentation

Enumerator
GAL_TYPE_NONE 

Not used.

GAL_TYPE_OPENGL 

OpenGL implementation.

GAL_TYPE_CAIRO 

Cairo implementation.

GAL_TYPE_LAST 

Sentinel, do not use as a parameter.

Definition at line 58 of file class_draw_panel_gal.h.

Constructor & Destructor Documentation

FOOTPRINT_PREVIEW_PANEL::~FOOTPRINT_PREVIEW_PANEL ( )
virtual

Definition at line 275 of file footprint_preview_panel.cpp.

References m_iface.

276 {
277  m_iface->SetPanel( nullptr );
278 }
std::shared_ptr< FP_THREAD_IFACE > m_iface
FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL ( KIWAY aKiway,
wxWindow *  aParent,
KIGFX::GAL_DISPLAY_OPTIONS aOpts,
GAL_TYPE  aGalType 
)
private

Definition at line 245 of file footprint_preview_panel.cpp.

References FP_LOADER_THREAD, FRAME_PCB_FOOTPRINT_PREVIEW, m_colorsSettings, m_dummyBoard, m_iface, m_loader, OnLoaderThreadUpdate(), EDA_DRAW_PANEL_GAL::SetStealsFocus(), EDA_DRAW_PANEL_GAL::StartDrawing(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), and PCB_DRAW_PANEL_GAL::UseColorScheme().

Referenced by New().

247  : PCB_DRAW_PANEL_GAL ( aParent, -1, wxPoint( 0, 0 ), wxSize(200, 200), aOpts, aGalType ),
248  KIWAY_HOLDER( aKiway ),
249  m_footprintDisplayed( true )
250 {
251 
252  m_iface = std::make_shared<FP_THREAD_IFACE>();
253  m_iface->SetPanel( this );
255  m_loader->Run();
256 
257  SetStealsFocus( false );
258  ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
259  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
260 
261  m_dummyBoard = std::make_unique<BOARD>();
262  m_colorsSettings = std::make_unique<COLORS_DESIGN_SETTINGS>( FRAME_PCB_FOOTPRINT_PREVIEW );
263 
264  UseColorScheme( m_colorsSettings.get() );
266 
267  Raise();
268  Show(true);
269  StartDrawing();
270 
271  Connect( wxEVT_COMMAND_TEXT_UPDATED, wxCommandEventHandler( FOOTPRINT_PREVIEW_PANEL::OnLoaderThreadUpdate ), NULL, this );
272 }
std::shared_ptr< FP_THREAD_IFACE > m_iface
std::unique_ptr< BOARD > m_dummyBoard
KIWAY_HOLDER(KIWAY *aKiway)
Definition: kiway_player.h:51
void SetStealsFocus(bool aStealsFocus)
Set whether focus is taken on certain events (mouseover, keys, etc).
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)
void SyncLayersVisibility(const BOARD *aBoard)
Function SyncLayersVisibility Updates "visibility" property of each layer of a given BOARD...
void StartDrawing()
Function StartDrawing() Begins drawing if it was stopped previously.
void UseColorScheme(const COLORS_DESIGN_SETTINGS *aSettings)
Function UseColorScheme Applies layer color settings.
void OnLoaderThreadUpdate(wxCommandEvent &aEvent)
std::unique_ptr< COLORS_DESIGN_SETTINGS > m_colorsSettings

Member Function Documentation

FOOTPRINT_PREVIEW_PANEL::CACHE_ENTRY FOOTPRINT_PREVIEW_PANEL::CacheAndReturn ( LIB_ID const &  aFPID)
privatevirtual

Definition at line 281 of file footprint_preview_panel.cpp.

References m_iface.

Referenced by CacheFootprint(), and DisplayFootprint().

282 {
283  auto opt_ent = m_iface->GetFromCache( aFPID );
284 
285  if( opt_ent )
286  return *opt_ent;
287  else
288  return m_iface->AddToQueue( aFPID );
289 }
std::shared_ptr< FP_THREAD_IFACE > m_iface
void FOOTPRINT_PREVIEW_PANEL::CacheFootprint ( LIB_ID const &  aFPID)
overridevirtual

Preload a footprint into the cache.

This must be called prior to DisplayFootprint, and may be called early.

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 293 of file footprint_preview_panel.cpp.

References CacheAndReturn().

294 {
295  (void) CacheAndReturn( aFPID );
296 }
virtual CACHE_ENTRY CacheAndReturn(LIB_ID const &aFPID)
FOOTPRINT_PREVIEW_PANEL_BASE * FOOTPRINT_PREVIEW_PANEL_BASE::Create ( wxWindow *  aParent,
KIWAY aKiway 
)
staticinherited

Return a footprint preview panel instance via Kiface.

May return null if Kiway is not available or there is any error on load.

Definition at line 111 of file footprint_preview_widget.cpp.

References KIFACE::CreateWindow(), KIWAY::FACE_PCB, FRAME_PCB_FOOTPRINT_PREVIEW, kiface, and KIWAY::KiFACE().

Referenced by FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET().

113 {
114  FOOTPRINT_PREVIEW_PANEL_BASE* panel = nullptr;
115 
116  try {
117  KIFACE* kiface = aKiway.KiFACE( KIWAY::FACE_PCB );
118 
119  auto window = kiface->CreateWindow( aParent, FRAME_PCB_FOOTPRINT_PREVIEW, &aKiway );
120 
121  panel = dynamic_cast<FOOTPRINT_PREVIEW_PANEL_BASE*>( window );
122 
123  if( window && !panel )
124  delete window;
125  } catch( ... )
126  {}
127 
128  return panel;
129 }
VTBL_ENTRY wxWindow * CreateWindow(wxWindow *aParent, int aClassId, KIWAY *aKIWAY, int aCtlBits=0)=0
Function CreateWindow creates a wxWindow for the current project.
pcbnew DSO
Definition: kiway.h:266
VTBL_ENTRY KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Function KiFACE returns the KIFACE* given a FACE_T.
Definition: kiway.cpp:150
Base class for the actual viewer panel.
Class KIFACE is used by a participant in the KIWAY alchemy.
Definition: kiway.h:150
return & kiface
Definition: pcbnew.cpp:197
void PCB_DRAW_PANEL_GAL::DisplayBoard ( BOARD aBoard)
inherited

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

References KIGFX::VIEW::Add(), KIGFX::VIEW::Clear(), BOARD::GetConnectivity(), BOARD::GetMARKER(), BOARD::GetMARKERCount(), BOARD::m_Modules, PCB_DRAW_PANEL_GAL::m_ratsnest, BOARD::m_Track, EDA_DRAW_PANEL_GAL::m_view, BOARD::m_Zone, TRACK::Next(), MODULE::Next(), SEGZONE::Next(), and BOARD::Zones().

Referenced by EVT_TOOL(), and PCB_BASE_EDIT_FRAME::SetBoard().

140 {
141  m_view->Clear();
142 
143  // Load zones
144  for( auto zone : aBoard->Zones() )
145  {
146  zone->CacheTriangulation();
147  m_view->Add( zone );
148  }
149 
150  // Load drawings
151  for( auto drawing : const_cast<BOARD*>(aBoard)->Drawings() )
152  m_view->Add( drawing );
153 
154  // Load tracks
155  for( TRACK* track = aBoard->m_Track; track; track = track->Next() )
156  m_view->Add( track );
157 
158  // Load modules and its additional elements
159  for( MODULE* module = aBoard->m_Modules; module; module = module->Next() )
160  m_view->Add( module );
161 
162  // Segzones (equivalent of ZONE_CONTAINER for legacy boards)
163  for( SEGZONE* zone = aBoard->m_Zone; zone; zone = zone->Next() )
164  m_view->Add( zone );
165 
166  // DRC markers
167  for( int marker_idx = 0; marker_idx < aBoard->GetMARKERCount(); ++marker_idx )
168  {
169  m_view->Add( aBoard->GetMARKER( marker_idx ) );
170  }
171 
172  // Ratsnest
173  m_ratsnest.reset( new KIGFX::RATSNEST_VIEWITEM( aBoard->GetConnectivity() ) );
174  m_view->Add( m_ratsnest.get() );
175 }
MARKER_PCB * GetMARKER(int index) const
Function GetMARKER returns the MARKER at a given index.
Definition: class_board.h:321
MODULE * Next() const
Definition: class_module.h:120
DLIST< SEGZONE > m_Zone
Definition: class_board.h:247
SEGZONE * Next() const
Definition: class_track.h:362
std::unique_ptr< KIGFX::RATSNEST_VIEWITEM > m_ratsnest
Ratsnest view item
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:969
ZONE_CONTAINERS & Zones()
Definition: class_board.h:252
TRACK * Next() const
Definition: class_track.h:100
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
DLIST< MODULE > m_Modules
Definition: class_board.h:245
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:312
DLIST< TRACK > m_Track
Definition: class_board.h:246
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:290
int GetMARKERCount() const
Function GetMARKERCount.
Definition: class_board.h:333
void FOOTPRINT_PREVIEW_PANEL::DisplayFootprint ( LIB_ID const &  aFPID)
overridevirtual

Set the currently displayed footprint.

Any footprint passed in here must have been passed to CacheFootprint before.

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 325 of file footprint_preview_panel.cpp.

References CacheAndReturn(), FPS_READY, m_currentFPID, m_footprintDisplayed, m_handler, m_iface, FOOTPRINT_PREVIEW_PANEL::CACHE_ENTRY::module, EDA_DRAW_PANEL_GAL::Refresh(), renderFootprint(), and FOOTPRINT_PREVIEW_PANEL::CACHE_ENTRY::status.

Referenced by OnLoaderThreadUpdate().

326 {
327  m_currentFPID = aFPID;
328  m_iface->SetCurrentFootprint( aFPID );
329  m_footprintDisplayed = false;
330 
331  CACHE_ENTRY fpe = CacheAndReturn ( m_currentFPID );
332 
333  if( m_handler )
334  m_handler( fpe.status );
335 
336  if( fpe.status == FPS_READY )
337  {
338  if ( !m_footprintDisplayed )
339  {
340  renderFootprint( fpe.module );
341  m_footprintDisplayed = true;
342  Refresh();
343  }
344  }
345 }
void renderFootprint(MODULE *module)
virtual CACHE_ENTRY CacheAndReturn(LIB_ID const &aFPID)
std::shared_ptr< FP_THREAD_IFACE > m_iface
void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
FOOTPRINT_STATUS_HANDLER m_handler
void EDA_DRAW_PANEL_GAL::ForceRefresh ( )
inherited

Function ForceRefresh() Forces a redraw.

Definition at line 250 of file draw_panel_gal.cpp.

Referenced by SELECTION_TOOL::findCallback(), EDA_DRAW_PANEL_GAL::Refresh(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), GERBVIEW_SELECTION_TOOL::zoomFitSelection(), and SELECTION_TOOL::zoomFitSelection().

251 {
252  wxPaintEvent redrawEvent;
253  wxPostEvent( this, redrawEvent );
254 }
GAL_TYPE EDA_DRAW_PANEL_GAL::GetBackend ( ) const
inlineinherited

Function GetBackend Returns the type of backend currently used by GAL canvas.

Definition at line 83 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_backend.

Referenced by EVT_TOOL(), EVT_UPDATE_UI(), EDA_DRAW_PANEL_GAL::onPaint(), PCB_BASE_FRAME::OnUpdateSwitchCanvas(), GERBVIEW_FRAME::OnUpdateSwitchCanvas(), and DIALOG_PAD_PROPERTIES::prepareCanvas().

84  {
85  return m_backend;
86  }
GAL_TYPE m_backend
Currently used GAL.
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.

References EDA_DRAW_PANEL_GAL::m_currentCursor.

225 { return m_currentCursor; }
int m_currentCursor
Current mouse cursor shape id.
int EDA_DRAW_PANEL_GAL::GetDefaultCursor ( ) const
inlineinherited

Function GetDefaultCursor.

Returns
the default cursor shape

Definition at line 219 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_defaultCursor.

Referenced by EDA_DRAW_FRAME::SetNoToolSelected().

219 { return m_defaultCursor; }
int m_defaultCursor
The default mouse cursor shape id.
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 321 of file draw_panel_gal.cpp.

References KIGFX::VIEW::GetScale(), KIGFX::GAL::GetWorldScale(), KIGFX::GAL::GetZoomFactor(), EDA_DRAW_PANEL_GAL::m_gal, and EDA_DRAW_PANEL_GAL::m_view.

Referenced by PCB_BASE_FRAME::OnUpdateSelectZoom().

322 {
323  double zoomFactor = m_gal->GetWorldScale() / m_gal->GetZoomFactor();
324  return ( 1.0 / ( zoomFactor * m_view->GetScale() ) );
325 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
double GetWorldScale() const
Get the world scale.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
double GetZoomFactor() const
Get the zoom factor.
double GetScale() const
Function GetScale()
Definition: view.h:265
void PCB_DRAW_PANEL_GAL::GetMsgPanelInfo ( std::vector< MSG_PANEL_ITEM > &  aList)
overridevirtualinherited

>

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 319 of file pcb_draw_panel_gal.cpp.

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

320 {
321  BOARD* board = static_cast<PCB_BASE_FRAME*>( m_parent )->GetBoard();
322  wxString txt;
323  int viasCount = 0;
324  int trackSegmentsCount = 0;
325 
326  for( const BOARD_ITEM* item = board->m_Track; item; item = item->Next() )
327  {
328  if( item->Type() == PCB_VIA_T )
329  viasCount++;
330  else
331  trackSegmentsCount++;
332  }
333 
334  txt.Printf( wxT( "%d" ), board->GetPadCount() );
335  aList.push_back( MSG_PANEL_ITEM( _( "Pads" ), txt, DARKGREEN ) );
336 
337  txt.Printf( wxT( "%d" ), viasCount );
338  aList.push_back( MSG_PANEL_ITEM( _( "Vias" ), txt, DARKGREEN ) );
339 
340  txt.Printf( wxT( "%d" ), trackSegmentsCount );
341  aList.push_back( MSG_PANEL_ITEM( _( "Track Segments" ), txt, DARKGREEN ) );
342 
343  txt.Printf( wxT( "%d" ), board->GetNodesCount() );
344  aList.push_back( MSG_PANEL_ITEM( _( "Nodes" ), txt, DARKCYAN ) );
345 
346  txt.Printf( wxT( "%d" ), board->GetNetCount() );
347  aList.push_back( MSG_PANEL_ITEM( _( "Nets" ), txt, RED ) );
348 
349  txt.Printf( wxT( "%d" ), board->GetConnectivity()->GetUnconnectedCount() );
350  aList.push_back( MSG_PANEL_ITEM( _( "Unconnected" ), txt, BLUE ) );
351 }
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.
Definition: colors.h:60
unsigned GetPadCount() const
Function GetPadCount.
BOARD * GetBoard()
TRACK * Next() const
Definition: class_track.h:100
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
unsigned GetNodesCount() const
Function GetNodesCount.
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
DLIST< TRACK > m_Track
Definition: class_board.h:246
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:290
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:772
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 176 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_edaFrame.

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

177  {
178  return m_edaFrame;
179  }
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
bool EDA_DRAW_PANEL_GAL::GetStealsFocus ( ) const
inlineinherited

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

Definition at line 200 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_stealsFocus.

201  {
202  return m_stealsFocus;
203  }
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
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 103 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_view.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), GRID_HELPER::BestSnapAnchor(), PCB_EDIT_FRAME::Edit_Zone_Params(), EVT_TOOL(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_DRAW_FRAME::GetZoomLevelIndicator(), GRID_HELPER::GRID_HELPER(), GERBVIEW_CONTROL::HighlightControl(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), PCB_EDIT_FRAME::ListNetsAndSelect(), PCB_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerVisible(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnMarkerSelectionEvent(), DIALOG_DISPLAY_OPTIONS::OnOKBUttonClick(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::OnOkClick(), DIALOG_DRC_CONTROL::OnPopupMenu(), PCB_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), EDA_DRAW_FRAME::OnToggleGridState(), PCB_BASE_FRAME::OnTogglePadDrawMode(), DIALOG_DRC_CONTROL::OnUnconnectedSelectionEvent(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_EDIT_FRAME::Process_Config(), GRID_HELPER::queryVisible(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_PAD_PROPERTIES::redraw(), renderFootprint(), GRID_HELPER::SetAuxAxes(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), FOOTPRINT_EDIT_FRAME::setupTools(), DIALOG_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_MODEDIT_DISPLAY_OPTIONS::TransferDataFromWindow(), PCB_BASE_FRAME::UseGalCanvas(), GERBVIEW_FRAME::UseGalCanvas(), EDA_DRAW_FRAME::UseGalCanvas(), COMMON_TOOLS::ZoomInOut(), and COMMON_TOOLS::ZoomPreset().

104  {
105  return m_view;
106  }
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
KIGFX::VIEW_CONTROLS* EDA_DRAW_PANEL_GAL::GetViewControls ( ) const
inlineinherited

Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.

Returns
The instance of VIEW_CONTROLS.

Definition at line 113 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_viewControls.

Referenced by EVT_TOOL(), EDA_DRAW_FRAME::GetCrossHairPosition(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_PANEL::SetEnableAutoPan(), EDA_DRAW_PANEL::SetEnableMousewheelPan(), EDA_DRAW_PANEL::SetEnableZoomNoCenter(), FOOTPRINT_EDIT_FRAME::setupTools(), and EDA_DRAW_FRAME::UseGalCanvas().

114  {
116  }
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
wxWindow * FOOTPRINT_PREVIEW_PANEL::GetWindow ( )
overridevirtual

Get the underlying wxWindow.

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 360 of file footprint_preview_panel.cpp.

361 {
362  return static_cast<wxWindow*>( this );
363 }
KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

References KIWAY_HOLDER::m_kiway.

Referenced by SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), SCH_EDIT_FRAME::ImportFile(), PCB_EDIT_FRAME::ImportFile(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), PCB_EDIT_FRAME::InstallModuleOptionsFrame(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_MODULE::ViewAndSelectFootprint().

61  {
62  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
63  return *m_kiway;
64  }
KIWAY * m_kiway
Definition: kiway_player.h:85
FOOTPRINT_PREVIEW_PANEL * FOOTPRINT_PREVIEW_PANEL::New ( KIWAY aKiway,
wxWindow *  aParent 
)
static

Definition at line 366 of file footprint_preview_panel.cpp.

References FOOTPRINT_PREVIEW_PANEL(), and EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO.

Referenced by PCB::IFACE::CreateWindow().

367 {
369 
370  return new FOOTPRINT_PREVIEW_PANEL(
371  aKiway, aParent, gal_opts, EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO );
372 }
FOOTPRINT_PREVIEW_PANEL(KIWAY *aKiway, wxWindow *aParent, KIGFX::GAL_DISPLAY_OPTIONS &aOpts, GAL_TYPE aGalType)
void EDA_DRAW_PANEL_GAL::onEnter ( wxEvent &  aEvent)
protectedinherited

Definition at line 413 of file draw_panel_gal.cpp.

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

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

414 {
415  // Getting focus is necessary in order to receive key events properly
416  if( m_stealsFocus )
417  SetFocus();
418 
419  aEvent.Skip();
420 }
virtual void SetFocus() override
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
void EDA_DRAW_PANEL_GAL::onEvent ( wxEvent &  aEvent)
protectedinherited

Definition at line 399 of file draw_panel_gal.cpp.

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

400 {
401  if( m_lostFocus && m_stealsFocus )
402  SetFocus();
403 
404  if( !m_eventDispatcher )
405  aEvent.Skip();
406  else
408 
409  Refresh();
410 }
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
void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it bu 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...
void FOOTPRINT_PREVIEW_PANEL::OnLoaderThreadUpdate ( wxCommandEvent &  aEvent)
private

Definition at line 348 of file footprint_preview_panel.cpp.

References DisplayFootprint(), and m_currentFPID.

Referenced by FOOTPRINT_PREVIEW_PANEL().

349 {
351 }
virtual void DisplayFootprint(LIB_ID const &aFPID) override
Set the currently displayed footprint.
void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protectedinherited

Definition at line 423 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_lostFocus.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

424 {
425  m_lostFocus = true;
426 
427  aEvent.Skip();
428 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protectedinherited

Definition at line 148 of file draw_panel_gal.cpp.

References KIGFX::GAL::BeginDrawing(), KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayError(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), KIGFX::GAL::EndDrawing(), EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO, EDA_DRAW_PANEL_GAL::GetBackend(), KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::WX_VIEW_CONTROLS::GetCursorPosition(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::VIEW::IsDirty(), KIGFX::VIEW::IsTargetDirty(), LAYER_CURSOR, 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(), PROF_COUNTER::Stop(), EDA_DRAW_PANEL_GAL::SwitchBackend(), KIGFX::TARGET_NONCACHED, KIGFX::VIEW::UpdateItems(), KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars(), and EDA_DRAW_FRAME::UseGalCanvas().

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

149 {
150  m_pendingRefresh = false;
151 
152  if( m_drawing )
153  return;
154 
155 #ifdef PROFILE
156  PROF_COUNTER totalRealTime;
157 #endif /* PROFILE */
158 
159  wxASSERT( m_painter );
160 
161  m_drawing = true;
162  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
163 
165 
166  m_view->UpdateItems();
167 
168  try
169  {
170  m_gal->BeginDrawing();
171  m_gal->SetClearColor( settings->GetBackgroundColor() );
173  m_gal->ClearScreen( );
174 
175  if( m_view->IsDirty() )
176  {
177  m_view->ClearTargets();
178 
179  // Grid has to be redrawn only when the NONCACHED target is redrawn
181  m_gal->DrawGrid();
182 
183  m_view->Redraw();
184  }
185 
187  m_gal->EndDrawing();
188  }
189  catch( std::runtime_error& err )
190  {
191  assert( GetBackend() != GAL_TYPE_CAIRO );
192 
193  // Cairo is supposed to be the safe backend, there is not a single "throw" in its code
195 
196  if( m_edaFrame )
197  m_edaFrame->UseGalCanvas( true );
198 
199  DisplayError( m_parent, wxString( err.what() ) );
200  }
201 
202 #ifdef PROFILE
203  totalRealTime.Stop();
204  wxLogDebug( "EDA_DRAW_PANEL_GAL::onPaint(): %.1f ms", totalRealTime.msecs() );
205 #endif /* PROFILE */
206 
207  m_lastRefresh = wxGetLocalTimeMillis();
208  m_drawing = false;
209 }
void Stop()
save the time when this function was called, and set the counter stane to stop
Definition: profile.h:82
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)
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
GAL_TYPE GetBackend() const
Function GetBackend Returns the type of backend currently used by GAL canvas.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:539
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:45
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
Definition: painter.h:206
virtual void UseGalCanvas(bool aEnable)
Function UseGalCanvas used to switch between standard and GAL-based canvas.
Auxiliary rendering target (noncached)
Definition: definitions.h:42
void UpdateScrollbars()
Adjusts the scrollbars position to match the current viewport.
bool m_drawing
True if GAL is currently redrawing the view.
wxWindow * m_parent
Pointer to the parent window.
virtual void Redraw()
Function Redraw() Immediately redraws the whole view.
Definition: view.cpp:1003
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
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:556
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them...
Definition: view.cpp:1272
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual void DrawGrid()
>
virtual void ClearScreen()
Clear the screen.
double msecs() const
Definition: profile.h:124
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
Returns the current cursor position in world coordinates.
void ClearTargets()
Function ClearTargets() Clears targets that are marked as dirty.
Definition: view.cpp:984
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
virtual void BeginDrawing()
Begin the drawing, needs to be called for every new frame.
virtual void EndDrawing()
End the drawing, needs to be called for every new frame.
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:73
const COLOR4D & GetBackgroundColor() const
Function GetBackgroundColor Returns current background color settings.
Definition: painter.h:186
void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 431 of file draw_panel_gal.cpp.

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

432 {
433  if( !m_drawingEnabled )
434  {
435  if( m_gal && m_gal->IsInitialized() )
436  {
437  m_drawing = false;
438  m_pendingRefresh = true;
439  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
440  m_drawingEnabled = true;
441  }
442  else
443  {
444  // Try again soon
445  m_refreshTimer.StartOnce( 100 );
446  return;
447  }
448  }
449 
450  wxPaintEvent redrawEvent;
451  wxPostEvent( this, redrawEvent );
452 }
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.
virtual bool IsInitialized() const
Returns the initalization status for the canvas.
bool m_drawing
True if GAL is currently redrawing the view.
void onPaint(wxPaintEvent &WXUNUSED(aEvent))
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
void PCB_DRAW_PANEL_GAL::OnShow ( )
overridevirtualinherited

>

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

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 354 of file pcb_draw_panel_gal.cpp.

References PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetDisplayOptions(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::RecacheAllItems(), and PCB_DRAW_PANEL_GAL::SetTopLayer().

355 {
356  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParent() );
357 
358  if( frame )
359  {
360  SetTopLayer( frame->GetActiveLayer() );
362  static_cast<KIGFX::PCB_RENDER_SETTINGS*>(
363  m_view->GetPainter()->GetSettings() )->LoadDisplayOptions( displ_opts );
364  }
365 
367 }
void RecacheAllItems()
Function RecacheAllItems() Rebuilds GAL display lists.
Definition: view.cpp:1253
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
Class PCB_RENDER_SETTINGS Stores PCB specific render settings.
Definition: pcb_painter.h:62
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:196
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
>
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 455 of file draw_panel_gal.cpp.

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

456 {
457  if( m_gal && m_gal->IsVisible() )
458  {
459  m_onShowTimer.Stop();
460  OnShow();
461  }
462 }
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.
virtual bool IsVisible() const
Returns true if the GAL canvas is visible on the screen.
wxTimer m_onShowTimer
Timer used to execute OnShow() when the window finally appears on the screen.
void EDA_DRAW_PANEL_GAL::onSize ( wxSizeEvent &  aEvent)
protectedinherited

Definition at line 212 of file draw_panel_gal.cpp.

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

213 {
214  wxSize clientSize = GetClientSize();
215  m_gal->ResizeScreen( clientSize.x, clientSize.y );
218 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
Auxiliary rendering target (noncached)
Definition: definitions.h:42
void MarkTargetDirty(int aTarget)
Function MarkTargetDirty() Sets or clears target 'dirty' flag.
Definition: view.h:568
virtual void ResizeScreen(int aWidth, int aHeight)
Resizes the canvas.
Main rendering target (cached)
Definition: definitions.h:41
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 34 of file kiway_holder.cpp.

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::AddAliasOfPart(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_MODULE_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint(), DIALOG_SYMBOL_LIB_TABLE::browseLibrariesHandler(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_MODULE_MODULE_EDITOR::Cfg3DPath(), DIALOG_MODULE_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FP_LIB_TABLE::DIALOG_FP_LIB_TABLE(), DIALOG_MODULE_BOARD_EDITOR::DIALOG_MODULE_BOARD_EDITOR(), DIALOG_MODULE_MODULE_EDITOR::DIALOG_MODULE_MODULE_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), LIB_VIEW_FRAME::DisplayLibInfos(), LIB_EDIT_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_MODULE_MODULE_EDITOR::Edit3DShapeFileName(), DIALOG_MODULE_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), FOOTPRINT_EDIT_FRAME::getLibPath(), LIB_EDIT_FRAME::getLibraryFileName(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), SCH_EDIT_FRAME::ImportFile(), PCB_EDIT_FRAME::ImportFile(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_NETLIST::OnOpenNetlistClick(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_MODULE_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), DIALOG_NETLIST::OnSaveMessagesToFile(), SCH_EDIT_FRAME::OnSaveProject(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), FOOTPRINT_EDIT_FRAME::OnUpdateSelectCurrentLib(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_EDITOR_CONTROL::PlaceModule(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), LIB_VIEW_FRAME::RedrawActiveWindow(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), EDA_3D_VIEWER::takeScreenshot(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), CVPCB_MAINFRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_MODULE_BOARD_EDITOR::~DIALOG_MODULE_BOARD_EDITOR(), and DIALOG_MODULE_MODULE_EDITOR::~DIALOG_MODULE_MODULE_EDITOR().

35 {
36  return Kiway().Prj();
37 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:144
void PCB_DRAW_PANEL_GAL::RedrawRatsnest ( )
inherited

Forces refresh of the ratsnest visual representation

Definition at line 390 of file pcb_draw_panel_gal.cpp.

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

Referenced by BOARD_COMMIT::Push().

391 {
392  if( m_ratsnest )
393  m_view->Update( m_ratsnest.get() );
394 }
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:1385
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
void EDA_DRAW_PANEL_GAL::Refresh ( bool  aEraseBackground = true,
const wxRect *  aRect = NULL 
)
overrideinherited

Update the board display after modifying it bu 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.

Definition at line 221 of file draw_panel_gal.cpp.

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 DisplayFootprint(), GERBVIEW_CONTROL::HighlightControl(), PCB_EDIT_FRAME::ListNetsAndSelect(), MODULE_EDITOR_TOOLS::ModuleEdgeOutlines(), MODULE_EDITOR_TOOLS::ModuleTextOutlines(), EDA_DRAW_PANEL_GAL::onEvent(), PCB_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectHighlightChoice(), PCBNEW_CONTROL::PadDisplayMode(), PCB_EDIT_FRAME::Process_Config(), TOOL_MANAGER::ProcessEvent(), PCB_EDITOR_CONTROL::ratsnestTimer(), DIALOG_PAD_PROPERTIES::redraw(), Refresh(), EDA_DRAW_PANEL::Refresh(), renderFootprint(), GERBVIEW_FRAME::SetActiveLayer(), PCBNEW_CONTROL::TrackDisplayMode(), PCBNEW_CONTROL::ViaDisplayMode(), and PCBNEW_CONTROL::ZoneDisplayMode().

222 {
223  if( m_pendingRefresh )
224  return;
225 
226  m_pendingRefresh = true;
227 
228 #ifdef __WXMAC__
229  // Timers on OS X may have a high latency (seen up to 500ms and more) which
230  // makes repaints jerky. No negative impact seen without throttling, so just
231  // do an unconditional refresh for OS X.
232  ForceRefresh();
233 #else
234  wxLongLong t = wxGetLocalTimeMillis();
235  wxLongLong delta = t - m_lastRefresh;
236 
237  if( delta >= MinRefreshPeriod )
238  {
239  ForceRefresh();
240  }
241  else
242  {
243  // One shot timer
244  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
245  }
246 #endif
247 }
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.
void FOOTPRINT_PREVIEW_PANEL::renderFootprint ( MODULE module)
private

Definition at line 299 of file footprint_preview_panel.cpp.

References KIGFX::VIEW::Add(), KIGFX::ALL, KIGFX::VIEW::Clear(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetSize(), EDA_DRAW_PANEL_GAL::GetView(), m_dummyBoard, BOX2< Vec >::Merge(), MODULE::Reference(), EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::SetParent(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::SetViewport(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), MODULE::Value(), TEXTE_MODULE::ViewBBox(), MODULE::ViewBBox(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DisplayFootprint().

300 {
301  GetView()->Clear();
302  module->SetParent ( &*m_dummyBoard );
303 
304  GetView()->Add ( module );
305  GetView()->SetVisible( module, true );
306  GetView()->Update( module, KIGFX::ALL );
307 
308  BOX2I bbox = module->ViewBBox();
309  bbox.Merge ( module->Value().ViewBBox() );
310  bbox.Merge ( module->Reference().ViewBBox() );
311 
312  if( bbox.GetSize().x > 0 && bbox.GetSize().y > 0 )
313  {
314  // Autozoom
315  GetView()->SetViewport( BOX2D( bbox.GetOrigin(), bbox.GetSize() ) );
316 
317  // Add a margin
318  GetView()->SetScale( GetView()->GetScale() * 0.7 );
319 
320  Refresh();
321  }
322 }
const Vec & GetOrigin() const
Definition: box2.h:181
TEXTE_MODULE & Reference()
Definition: class_module.h:483
void SetViewport(const BOX2D &aViewport)
Function SetViewport() Sets the visible area of the VIEW.
Definition: view.cpp:514
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers. ...
BOX2< VECTOR2D > BOX2D
Definition: box2.h:469
KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
Item is being added to the view.
Definition: view_item.h:60
const Vec & GetSize() const
Definition: box2.h:177
void SetScale(double aScale)
Function SetScale() Sets the scaling factor.
Definition: view.h:247
std::unique_ptr< BOARD > m_dummyBoard
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:240
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:969
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:482
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers. ...
BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
Definition: box2.h:350
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1385
void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Sets the item visibility.
Definition: view.cpp:1331
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:312
void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( int  aCursor)
inlineinherited

Function SetCurrentCursor Set the current cursor shape for this panel.

Definition at line 209 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_currentCursor.

Referenced by EDA_DRAW_FRAME::SetToolID().

210  {
211  m_currentCursor = aCursor;
212  SetCursor( (wxStockCursor) m_currentCursor );
213  }
int m_currentCursor
Current mouse cursor shape id.
void PCB_DRAW_PANEL_GAL::setDefaultLayerDeps ( )
protectedinherited

Sets rendering targets & dependencies for layers.

Definition at line 397 of file pcb_draw_panel_gal.cpp.

References B_Adhes, B_CrtYd, B_Fab, B_Mask, B_Paste, B_SilkS, F_Adhes, F_CrtYd, F_Fab, F_Mask, F_Paste, F_SilkS, 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_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::PCB_DRAW_PANEL_GAL(), and PCB_DRAW_PANEL_GAL::SwitchBackend().

398 {
399  // caching makes no sense for Cairo and other software renderers
401 
402  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
403  m_view->SetLayerTarget( i, target );
404 
405  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
406  {
407  LAYER_NUM layer = GAL_LAYER_ORDER[i];
408  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
409 
410  // Set layer display dependencies & targets
411  if( IsCopperLayer( layer ) )
412  m_view->SetRequired( GetNetnameLayer( layer ), layer );
413  else if( IsNetnameLayer( layer ) )
414  m_view->SetLayerDisplayOnly( layer );
415  }
416 
419 
420  // Some more required layers settings
426 
427  // Front modules
437 
438  // Back modules
448 
453 
457 }
void SetRequired(int aLayerId, int aRequiredId, bool aRequired=true)
Function SetRequired() Marks the aRequiredId layer as required for the aLayerId layer.
Definition: view.cpp:382
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)
show modules on back
to draw via holes (pad holes do not use this layer)
smd pads, back layer
const LAYER_NUM GAL_LAYER_ORDER[]
Auxiliary rendering target (noncached)
Definition: definitions.h:42
show modules on front
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Function SetLayerTarget() Changes the rendering target for a particular layer.
Definition: view.h:424
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Definition: view.h:411
to draw usual through hole vias
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:652
Items that may change while the view stays the same (noncached)
Definition: definitions.h:43
general purpose overlay
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
smd pads, front layer
Main rendering target (cached)
Definition: definitions.h:41
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
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.
void PCB_DRAW_PANEL_GAL::setDefaultLayerOrder ( )
protectedinherited

Reassigns layer order to the initial settings.

Definition at line 370 of file pcb_draw_panel_gal.cpp.

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::PCB_DRAW_PANEL_GAL(), and PCB_DRAW_PANEL_GAL::SetTopLayer().

371 {
372  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
373  {
374  LAYER_NUM layer = GAL_LAYER_ORDER[i];
375  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
376 
377  m_view->SetLayerOrder( layer, i );
378  }
379 }
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:590
const LAYER_NUM GAL_LAYER_ORDER[]
static const int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:652
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.
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 257 of file draw_panel_gal.cpp.

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

Referenced by EVT_TOOL(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_BASE_FRAME::UseGalCanvas(), and GERBVIEW_FRAME::UseGalCanvas().

258 {
259  m_eventDispatcher = aEventDispatcher;
260  const wxEventType eventTypes[] = { wxEVT_TOOL };
261 
262  if( m_eventDispatcher )
263  {
264  for( wxEventType type : eventTypes )
265  {
266  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
267  NULL, m_eventDispatcher );
268  }
269  }
270  else
271  {
272  for( wxEventType type : eventTypes )
273  {
274  // While loop is used to be sure that all event handlers are removed.
275  while( m_parent->Disconnect( type,
276  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
277  NULL, m_eventDispatcher ) );
278  }
279  }
280 }
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...
void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtualinherited

Definition at line 132 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL::GetParent(), and EDA_DRAW_PANEL_GAL::m_lostFocus.

Referenced by EDA_DRAW_PANEL_GAL::onEnter(), EDA_DRAW_PANEL_GAL::onEvent(), and GERBVIEW_FRAME::SetActiveLayer().

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

>

Function SetHighContrastLayer Takes care of display settings for the given layer to be displayed in high contrast mode.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 71 of file pcb_draw_panel_gal.h.

Referenced by PCBNEW_CONTROL::HighContrastMode().

72  {
73  SetHighContrastLayer( static_cast< PCB_LAYER_ID >( aLayer ) );
74  }
virtual void SetHighContrastLayer(int aLayer) override
>
void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( PCB_LAYER_ID  aLayer)
inherited

SetHighContrastLayer(), with some extra smarts for PCB

Definition at line 194 of file pcb_draw_panel_gal.cpp.

References B_Cu, KIGFX::RENDER_SETTINGS::ClearActiveLayers(), F_Cu, GetNetnameLayer(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), IsCopperLayer(), 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_VIA_THROUGH, LAYER_VIAS_HOLES, LAYER_VIAS_NETNAMES, EDA_DRAW_PANEL_GAL::m_view, KIGFX::RENDER_SETTINGS::SetActiveLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersColor().

195 {
196  // Set display settings for high contrast mode
198 
199  SetTopLayer( aLayer );
200 
201  rSettings->ClearActiveLayers();
202  rSettings->SetActiveLayer( aLayer );
203 
204  if( IsCopperLayer( aLayer ) )
205  {
206  // Bring some other layers to the front in case of copper layers and make them colored
207  // fixme do not like the idea of storing the list of layers here,
208  // should be done in some other way I guess..
209  LAYER_NUM layers[] = {
210  GetNetnameLayer( aLayer ),
214  };
215 
216  for( unsigned int i = 0; i < sizeof( layers ) / sizeof( LAYER_NUM ); ++i )
217  rSettings->SetActiveLayer( layers[i] );
218 
219  // Pads should be shown too
220  if( aLayer == B_Cu )
221  {
222  rSettings->SetActiveLayer( LAYER_PAD_BK );
223  rSettings->SetActiveLayer( LAYER_MOD_BK );
225  }
226  else if( aLayer == F_Cu )
227  {
228  rSettings->SetActiveLayer( LAYER_PAD_FR );
229  rSettings->SetActiveLayer( LAYER_MOD_FR );
231  }
232  }
233 
235 }
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)
show modules on back
to draw via holes (pad holes do not use this layer)
smd pads, back layer
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
general purpose overlay
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:196
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.
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:675
Additional netnames layers (not associated with a PCB layer)
void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

Function SetKiway.

Parameters
aDestis the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiwayis often from a parent window, or from KIFACE::CreateWindow().

Definition at line 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

42 {
43 #if defined(DEBUG)
44  // offer a trap point for debugging most any window
45  wxASSERT( aDest );
46  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
47  {
48  int breakhere=1;
49  (void) breakhere;
50  }
51 #endif
52 
53  (void) aDest;
54 
55  m_kiway = aKiway;
56 }
KIWAY * m_kiway
Definition: kiway_player.h:85
const char * name
void FOOTPRINT_PREVIEW_PANEL::SetStatusHandler ( FOOTPRINT_STATUS_HANDLER  aHandler)
overridevirtual

Set the callback to receive status updates.

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 354 of file footprint_preview_panel.cpp.

References m_handler.

355 {
356  m_handler = aHandler;
357 }
FOOTPRINT_STATUS_HANDLER m_handler
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 192 of file class_draw_panel_gal.h.

References EDA_DRAW_PANEL_GAL::m_stealsFocus.

Referenced by FOOTPRINT_PREVIEW_PANEL().

193  {
194  m_stealsFocus = aStealsFocus;
195  }
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over...
virtual void PCB_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
inlineoverridevirtualinherited

>

Function SetTopLayer Moves the selected layer to the top, so it is displayed above all others.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 80 of file pcb_draw_panel_gal.h.

Referenced by PCB_DRAW_PANEL_GAL::OnShow(), and PCB_DRAW_PANEL_GAL::SetHighContrastLayer().

81  {
82  SetTopLayer( static_cast< PCB_LAYER_ID >( aLayer ) );
83  }
virtual void SetTopLayer(int aLayer) override
>
void PCB_DRAW_PANEL_GAL::SetTopLayer ( PCB_LAYER_ID  aLayer)
inherited

SetTopLayer(), with some extra smarts for PCB

Definition at line 238 of file pcb_draw_panel_gal.cpp.

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, KIGFX::VIEW::ClearTopLayers(), 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_VIA_THROUGH, LAYER_VIAS_HOLES, LAYER_VIAS_NETNAMES, EDA_DRAW_PANEL_GAL::m_view, NETNAMES_LAYER_INDEX, PCB_DRAW_PANEL_GAL::setDefaultLayerOrder(), KIGFX::VIEW::SetLayerOrder(), KIGFX::VIEW::SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersOrder().

239 {
242  m_view->SetTopLayer( aLayer );
243 
244  // Layers that should always have on-top attribute enabled
245  const LAYER_NUM layers[] = {
249  LAYER_DRC
250  };
251 
252  for( unsigned int i = 0; i < sizeof( layers ) / sizeof( LAYER_NUM ); ++i )
253  m_view->SetTopLayer( layers[i] );
254 
255  // Extra layers that are brought to the top if a F.* or B.* is selected
256  const LAYER_NUM frontLayers[] = {
259  };
260 
261  const LAYER_NUM backLayers[] = {
264  };
265 
266  const LAYER_NUM* extraLayers = NULL;
267 
268  // Bring a few more extra layers to the top depending on the selected board side
269  if( IsFrontLayer( aLayer ) )
270  extraLayers = frontLayers;
271  else if( IsBackLayer( aLayer ) )
272  extraLayers = backLayers;
273 
274  if( extraLayers )
275  {
276  const LAYER_NUM* l = extraLayers;
277 
278  while( *l >= 0 )
279  m_view->SetTopLayer( *l++ );
280 
281  // Move the active layer to the top
282  if( !IsCopperLayer( aLayer ) )
284  }
285  else if( IsCopperLayer( aLayer ) )
286  {
287  // Display labels for copper layers on the top
288  m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
289  }
290 
292 }
void SetLayerOrder(int aLayer, int aRenderingOrder)
Function SetLayerOrder() Sets rendering order of a particular layer.
Definition: view.cpp:590
virtual void SetTopLayer(int aLayer, bool aEnabled=true)
Function SetTopLayer() Sets given layer to be displayed on the top or sets back the default order of ...
Definition: view.cpp:730
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:797
smd pads, back layer
const LAYER_NUM GAL_LAYER_ORDER[]
int GetLayerOrder(int aLayer) const
Function GetLayerOrder() Returns rendering order of a particular layer.
Definition: view.cpp:598
to draw usual through hole vias
general purpose overlay
void ClearTopLayers()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:782
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
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.
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)
void PCB_DRAW_PANEL_GAL::SetWorksheet ( KIGFX::WORKSHEET_VIEWITEM aWorksheet)
inherited

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

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

Referenced by PCB_EDIT_FRAME::SetPageSettings().

179 {
180  m_worksheet.reset( aWorksheet );
181  m_view->Add( m_worksheet.get() );
182 }
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:312
void EDA_DRAW_PANEL_GAL::StartDrawing ( )
inherited

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

Definition at line 283 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_refreshTimer.

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

284 {
285  // Start querying GAL if it is ready
286  m_refreshTimer.StartOnce( 100 );
287 }
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.
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 290 of file draw_panel_gal.cpp.

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(), FOOTPRINT_EDIT_FRAME::OnCloseWindow(), FOOTPRINT_VIEWER_FRAME::OnCloseWindow(), DIALOG_PAD_PROPERTIES::redraw(), EDA_DRAW_PANEL_GAL::SwitchBackend(), GERBVIEW_FRAME::UseGalCanvas(), and EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL().

291 {
292  m_drawingEnabled = false;
293  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
294  m_pendingRefresh = false;
295  m_refreshTimer.Stop();
296 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer responsible for preventing too frequent refresh.
void onPaint(wxPaintEvent &WXUNUSED(aEvent))
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
bool PCB_DRAW_PANEL_GAL::SwitchBackend ( GAL_TYPE  aGalType)
overridevirtualinherited

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

References PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

Referenced by DIALOG_PAD_PROPERTIES::prepareCanvas().

383 {
384  bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
386  return rv;
387 }
void setDefaultLayerDeps()
Sets rendering targets & dependencies for layers.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
void PCB_DRAW_PANEL_GAL::SyncLayersVisibility ( const BOARD aBoard)
inherited

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

Parameters
aBoardcontains layers visibility settings to be applied.

Definition at line 295 of file pcb_draw_panel_gal.cpp.

References GAL_LAYER_ID_END, GAL_LAYER_ID_START, GetNetnameLayer(), IsCopperLayer(), BOARD::IsElementVisible(), BOARD::IsLayerVisible(), LAYER_GP_OVERLAY, LAYER_PADS_PLATEDHOLES, LAYER_VIAS_HOLES, EDA_DRAW_PANEL_GAL::m_view, PCB_LAYER_ID_COUNT, and KIGFX::VIEW::SetLayerVisible().

Referenced by FOOTPRINT_PREVIEW_PANEL().

296 {
297  // Load layer & elements visibility settings
298  for( LAYER_NUM i = 0; i < PCB_LAYER_ID_COUNT; ++i )
299  {
300  m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
301 
302  // Synchronize netname layers as well
303  if( IsCopperLayer( i ) )
305  }
306 
308  {
309  m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
310  }
311 
312  // Enable some layers that are GAL specific
316 }
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
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:
general purpose overlay
void SetLayerVisible(int aLayer, bool aVisible=true)
Function SetLayerVisible() Controls the visibility of a particular layer.
Definition: view.h:387
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.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:451
void PCB_DRAW_PANEL_GAL::UseColorScheme ( const COLORS_DESIGN_SETTINGS aSettings)
inherited

Function UseColorScheme Applies layer color settings.

Parameters
aSettingsare the new settings.

Definition at line 185 of file pcb_draw_panel_gal.cpp.

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

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

186 {
188  rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
189  rs->ImportLegacyColors( aSettings );
190  m_gal->SetCursorColor( aSettings->GetItemColor( LAYER_CURSOR ) );
191 }
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:73
COLOR4D GetItemColor(int aItemIdx) const
Function GetItemColor.
Class PCB_RENDER_SETTINGS Stores PCB specific render settings.
Definition: pcb_painter.h:62
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:196
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
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.
KIGFX::PCB_VIEW * PCB_DRAW_PANEL_GAL::view ( ) const
protectedinherited

Definition at line 460 of file pcb_draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_view.

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

Friends And Related Function Documentation

friend class FP_LOADER_THREAD
friend

Definition at line 56 of file footprint_preview_panel.h.

Referenced by FOOTPRINT_PREVIEW_PANEL().

friend class FP_THREAD_IFACE
friend

Definition at line 55 of file footprint_preview_panel.h.

Member Data Documentation

std::unique_ptr<COLORS_DESIGN_SETTINGS> FOOTPRINT_PREVIEW_PANEL::m_colorsSettings
private

Definition at line 95 of file footprint_preview_panel.h.

Referenced by FOOTPRINT_PREVIEW_PANEL().

int EDA_DRAW_PANEL_GAL::m_currentCursor
protectedinherited
LIB_ID FOOTPRINT_PREVIEW_PANEL::m_currentFPID
private

Definition at line 97 of file footprint_preview_panel.h.

Referenced by DisplayFootprint(), and OnLoaderThreadUpdate().

int EDA_DRAW_PANEL_GAL::m_defaultCursor
protectedinherited

The default mouse cursor shape id.

Definition at line 242 of file class_draw_panel_gal.h.

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

bool EDA_DRAW_PANEL_GAL::m_drawing
protectedinherited
bool EDA_DRAW_PANEL_GAL::m_drawingEnabled
protectedinherited

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

Definition at line 260 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().

std::unique_ptr<BOARD> FOOTPRINT_PREVIEW_PANEL::m_dummyBoard
private

Definition at line 94 of file footprint_preview_panel.h.

Referenced by FOOTPRINT_PREVIEW_PANEL(), and renderFootprint().

EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::m_edaFrame
protectedinherited
TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protectedinherited

Processes and forwards events to tools.

Definition at line 285 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().

bool FOOTPRINT_PREVIEW_PANEL::m_footprintDisplayed
private

Definition at line 98 of file footprint_preview_panel.h.

Referenced by DisplayFootprint().

FOOTPRINT_STATUS_HANDLER FOOTPRINT_PREVIEW_PANEL::m_handler
private

Definition at line 93 of file footprint_preview_panel.h.

Referenced by DisplayFootprint(), and SetStatusHandler().

std::shared_ptr<FP_THREAD_IFACE> FOOTPRINT_PREVIEW_PANEL::m_iface
private
wxLongLong EDA_DRAW_PANEL_GAL::m_lastRefresh
protectedinherited

Last timestamp when the panel was refreshed.

Definition at line 251 of file class_draw_panel_gal.h.

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

FP_LOADER_THREAD* FOOTPRINT_PREVIEW_PANEL::m_loader
private

Definition at line 91 of file footprint_preview_panel.h.

Referenced by FOOTPRINT_PREVIEW_PANEL().

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

wxTimer EDA_DRAW_PANEL_GAL::m_onShowTimer
protectedinherited

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

Definition at line 266 of file class_draw_panel_gal.h.

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

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_PANEL_GAL::m_options
protectedinherited

Definition at line 282 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

std::unique_ptr<KIGFX::PAINTER> EDA_DRAW_PANEL_GAL::m_painter
protectedinherited
wxWindow* EDA_DRAW_PANEL_GAL::m_parent
protectedinherited
bool EDA_DRAW_PANEL_GAL::m_pendingRefresh
protectedinherited
std::unique_ptr<KIGFX::RATSNEST_VIEWITEM> PCB_DRAW_PANEL_GAL::m_ratsnest
protectedinherited

Ratsnest view item

Definition at line 120 of file pcb_draw_panel_gal.h.

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), and PCB_DRAW_PANEL_GAL::RedrawRatsnest().

wxTimer EDA_DRAW_PANEL_GAL::m_refreshTimer
protectedinherited
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 293 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().

std::unique_ptr<KIGFX::WORKSHEET_VIEWITEM> PCB_DRAW_PANEL_GAL::m_worksheet
protectedinherited

Currently used worksheet

Definition at line 117 of file pcb_draw_panel_gal.h.

Referenced by PCB_DRAW_PANEL_GAL::SetWorksheet().

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotectedinherited

60 FPS.

Definition at line 237 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: