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_UNKNOWN = -1, GAL_TYPE_NONE = 0, GAL_TYPE_OPENGL, GAL_TYPE_CAIRO,
  GAL_TYPE_LAST
}
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

virtual ~FOOTPRINT_PREVIEW_PANEL ()
 
virtual void CacheFootprint (const LIB_ID &aFPID) override
 Preload a footprint into the cache. More...
 
virtual void DisplayFootprint (const LIB_ID &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 const KIGFX::COLOR4DGetBackgroundColor () override
 Get the colors to use in a preview widget to match the preview panel. More...
 
virtual const KIGFX::COLOR4DGetForegroundColor () override
 
virtual wxWindow * GetWindow () override
 Get the underlying wxWindow. More...
 
BOARDGetBoard ()
 
void DisplayBoard (BOARD *aBoard)
 Function DisplayBoard adds all items from the current board to the VIEW, so they can be displayed by GAL. More...
 
void SetWorksheet (KIGFX::WS_PROXY_VIEW_ITEM *aWorksheet)
 Function SetWorksheet Sets (or updates) worksheet used by the draw panel. More...
 
KIGFX::WS_PROXY_VIEW_ITEMGetWorksheet () const
 
void UpdateColors ()
 Updates the color settings in the painter and GAL. 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_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 

More...
 
void OnShow () override
 

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

Forces refresh of the ratsnest visual representation

More...
 
BOX2I GetDefaultViewBBox () const override
 

More...
 
virtual KIGFX::PCB_VIEWGetView () const override
 Function GetView() Returns a pointer to the VIEW instance used in the panel. More...
 
virtual void SetFocus () override
 
GAL_TYPE GetBackend () const
 Function GetBackend Returns the type of backend currently used by GAL canvas. More...
 
KIGFX::GALGetGAL () const
 Function GetGAL() Returns a pointer to the GAL instance used in the panel. More...
 
KIGFX::VIEW_CONTROLSGetViewControls () const
 Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel. More...
 
virtual void Refresh (bool aEraseBackground=true, const wxRect *aRect=NULL) override
 Update the board display after modifying it by a python script (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins. More...
 
void ForceRefresh ()
 Function ForceRefresh() Forces a redraw. More...
 
void SetEventDispatcher (TOOL_DISPATCHER *aEventDispatcher)
 Function SetEventDispatcher() Sets a dispatcher that processes events and forwards them to tools. More...
 
void StartDrawing ()
 Function StartDrawing() Begins drawing if it was stopped previously. More...
 
void StopDrawing ()
 Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDrawing() is called. More...
 
EDA_DRAW_FRAMEGetParentEDAFrame () const
 Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise. More...
 
bool IsDialogPreview () const
 
void SetStealsFocus (bool aStealsFocus)
 Set whether focus is taken on certain events (mouseover, keys, etc). More...
 
void SetCurrentCursor (wxStockCursor aStockCursorID)
 Function SetCurrentCursor Set the current cursor shape for this panel. More...
 
void SetCurrentCursor (const wxCursor &aCursor)
 
void OnEvent (wxEvent &aEvent)
 Used to forward events to the canvas from popups, etc. More...
 
void DoRePaint ()
 Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do not use a wxPaintDC, it can be called outside a wxPaintEvent. More...
 
HOLDER_TYPE GetType ()
 
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...
 

Static Public Attributes

static constexpr GAL_TYPE GAL_FALLBACK = GAL_TYPE_CAIRO
 

Protected Member Functions

void setDefaultLayerOrder ()
 

Reassigns layer order to the initial settings.

More...
 
void setDefaultLayerDeps ()
 

Sets rendering targets & dependencies for layers.

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

Protected Attributes

std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEMm_worksheet
 

Currently used worksheet

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

Ratsnest view item

More...
 
wxCursor m_currentCursor
 Current 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...
 
wxTimer m_refreshTimer
 Timer to prevent too-frequent refreshing. 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_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, std::unique_ptr< KIGFX::GAL_DISPLAY_OPTIONS > aOpts, GAL_TYPE aGalType)
 Create a new panel. More...
 
virtual CACHE_ENTRY CacheAndReturn (const LIB_ID &aFPID)
 
void OnLoaderThreadUpdate (wxCommandEvent &aEvent)
 
void renderFootprint (std::shared_ptr< MODULE > aModule)
 

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< KIGFX::GAL_DISPLAY_OPTIONSm_displayOptions
 
std::shared_ptr< MODULEm_currentModule
 
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

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

58  {
59  GAL_TYPE_UNKNOWN = -1,
60  GAL_TYPE_NONE = 0,
64  };
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)

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ ~FOOTPRINT_PREVIEW_PANEL()

FOOTPRINT_PREVIEW_PANEL::~FOOTPRINT_PREVIEW_PANEL ( )
virtual

Definition at line 281 of file footprint_preview_panel.cpp.

282 {
283  if( m_currentModule )
284  {
285  GetView()->Remove( m_currentModule.get() );
286  GetView()->Clear();
287  m_currentModule->SetParent( nullptr );
288  }
289 
290  m_iface->SetPanel( nullptr );
291 }
std::shared_ptr< FP_THREAD_IFACE > m_iface
virtual void Remove(VIEW_ITEM *aItem) override
Function Remove() Removes a VIEW_ITEM from the view.
Definition: pcb_view.cpp:76
std::shared_ptr< MODULE > m_currentModule
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1107
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.

References KIGFX::VIEW::Clear(), PCB_DRAW_PANEL_GAL::GetView(), m_currentModule, m_iface, and KIGFX::PCB_VIEW::Remove().

◆ FOOTPRINT_PREVIEW_PANEL()

FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL ( KIWAY aKiway,
wxWindow *  aParent,
std::unique_ptr< KIGFX::GAL_DISPLAY_OPTIONS aOpts,
GAL_TYPE  aGalType 
)
private

Create a new panel.

Parameters
aKiwaythe connected KIWAY
aParentthe owning WX window
aOptsthe GAL options (ownership is assumed)
aGalTypethe displayed GAL type

Definition at line 251 of file footprint_preview_panel.cpp.

253  : PCB_DRAW_PANEL_GAL( aParent, -1, wxPoint( 0, 0 ), wxSize( 200, 200 ), *aOpts, aGalType ),
255  m_displayOptions( std::move( aOpts ) ),
256  m_currentModule( nullptr ),
257  m_footprintDisplayed( true )
258 {
259  m_iface = std::make_shared<FP_THREAD_IFACE>();
260  m_iface->SetPanel( this );
262  m_loader->Run();
263 
264  SetStealsFocus( false );
265  ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
266  EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
267 
268  m_dummyBoard = std::make_unique<BOARD>();
269  UpdateColors();
271 
272  Raise();
273  Show( true );
274  StartDrawing();
275 
276  Connect( wxEVT_COMMAND_TEXT_UPDATED,
277  wxCommandEventHandler( FOOTPRINT_PREVIEW_PANEL::OnLoaderThreadUpdate ), NULL, this );
278 }
std::shared_ptr< FP_THREAD_IFACE > m_iface
std::shared_ptr< MODULE > m_currentModule
#define NULL
std::unique_ptr< BOARD > m_dummyBoard
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)
KIWAY_HOLDER(KIWAY *aKiway, HOLDER_TYPE aType)
Definition: kiway_holder.h:44
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 UpdateColors()
Updates the color settings in the painter and GAL.
void OnLoaderThreadUpdate(wxCommandEvent &aEvent)
std::unique_ptr< KIGFX::GAL_DISPLAY_OPTIONS > m_displayOptions

References FP_LOADER_THREAD, m_dummyBoard, m_iface, m_loader, NULL, OnLoaderThreadUpdate(), EDA_DRAW_PANEL_GAL::SetStealsFocus(), EDA_DRAW_PANEL_GAL::StartDrawing(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), and PCB_DRAW_PANEL_GAL::UpdateColors().

Referenced by New().

Member Function Documentation

◆ CacheAndReturn()

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

Definition at line 312 of file footprint_preview_panel.cpp.

313 {
314  auto opt_ent = m_iface->GetFromCache( aFPID );
315 
316  if( opt_ent )
317  return *opt_ent;
318  else
319  return m_iface->AddToQueue( aFPID );
320 }
std::shared_ptr< FP_THREAD_IFACE > m_iface

References m_iface.

Referenced by CacheFootprint(), and DisplayFootprint().

◆ CacheFootprint()

void FOOTPRINT_PREVIEW_PANEL::CacheFootprint ( const LIB_ID 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 324 of file footprint_preview_panel.cpp.

325 {
326  (void) CacheAndReturn( aFPID );
327 }
virtual CACHE_ENTRY CacheAndReturn(const LIB_ID &aFPID)

References CacheAndReturn().

◆ Create()

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 119 of file footprint_preview_widget.cpp.

121 {
122  FOOTPRINT_PREVIEW_PANEL_BASE* panel = nullptr;
123 
124  try
125  {
126  KIFACE* kiface = aKiway.KiFACE( KIWAY::FACE_PCB );
127 
128  auto window = kiface->CreateWindow( aParent, FRAME_FOOTPRINT_PREVIEW, &aKiway );
129 
130  panel = dynamic_cast<FOOTPRINT_PREVIEW_PANEL_BASE*>( window );
131 
132  if( window && !panel )
133  delete window;
134  }
135  catch( ... )
136  {
137  }
138 
139  return panel;
140 }
BITMAP2CMP_SETTINGS kiface
pcbnew DSO
Definition: kiway.h:282
VTBL_ENTRY KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Function KiFACE returns the KIFACE* given a FACE_T.
Definition: kiway.cpp:179
Base class for the actual viewer panel.
KIFACE is used by a participant in the KIWAY alchemy.
Definition: kiway.h:150

References KIWAY::FACE_PCB, FRAME_FOOTPRINT_PREVIEW, kiface, and KIWAY::KiFACE().

Referenced by FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET().

◆ DisplayBoard()

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

150 {
151 
152  m_view->Clear();
153 
154  auto zones = aBoard->Zones();
155  std::atomic<size_t> next( 0 );
156  std::atomic<size_t> count_done( 0 );
157  size_t parallelThreadCount = std::max<size_t>( std::thread::hardware_concurrency(), 2 );
158 
159  for( size_t ii = 0; ii < parallelThreadCount; ++ii )
160  {
161  std::thread t = std::thread( [ &count_done, &next, &zones ]( )
162  {
163  for( size_t i = next.fetch_add( 1 ); i < zones.size(); i = next.fetch_add( 1 ) )
164  zones[i]->CacheTriangulation();
165 
166  count_done++;
167  } );
168 
169  t.detach();
170  }
171 
172  if( m_worksheet )
173  m_worksheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
174 
175  // Load drawings
176  for( auto drawing : const_cast<BOARD*>(aBoard)->Drawings() )
177  m_view->Add( drawing );
178 
179  // Load tracks
180  for( auto track : aBoard->Tracks() )
181  m_view->Add( track );
182 
183  // Load modules and its additional elements
184  for( auto module : aBoard->Modules() )
185  m_view->Add( module );
186 
187  // DRC markers
188  for( auto marker : aBoard->Markers() )
189  m_view->Add( marker );
190 
191  // Finalize the triangulation threads
192  while( count_done < parallelThreadCount )
193  std::this_thread::sleep_for( std::chrono::milliseconds( 10 ) );
194 
195  // Load zones
196  for( auto zone : aBoard->Zones() )
197  m_view->Add( zone );
198 
199  // Ratsnest
200  m_ratsnest = std::make_unique<KIGFX::RATSNEST_VIEWITEM>( aBoard->GetConnectivity() );
201  m_view->Add( m_ratsnest.get() );
202 }
CITER next(CITER it)
Definition: ptree.cpp:126
MARKERS & Markers()
Definition: class_board.h:257
const wxString & GetFileName() const
Definition: class_board.h:244
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:100
MODULES & Modules()
Definition: class_board.h:249
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1107
std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEM > m_worksheet
Currently used worksheet
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:345
ZONE_CONTAINERS & Zones()
Definition: class_board.h:254
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:345
TRACKS & Tracks()
Definition: class_board.h:246

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

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

◆ DisplayFootprint()

void FOOTPRINT_PREVIEW_PANEL::DisplayFootprint ( const LIB_ID 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 371 of file footprint_preview_panel.cpp.

372 {
373  m_currentFPID = aFPID;
374  m_iface->SetCurrentFootprint( aFPID );
375  m_footprintDisplayed = false;
376 
377  CACHE_ENTRY fpe = CacheAndReturn( m_currentFPID );
378 
379  if( m_handler )
380  m_handler( fpe.status );
381 
382  if( fpe.status == FPS_READY )
383  {
384  if( !m_footprintDisplayed )
385  {
386  renderFootprint( fpe.module );
387  m_footprintDisplayed = true;
388  Refresh();
389  }
390  }
391 }
std::shared_ptr< FP_THREAD_IFACE > m_iface
void renderFootprint(std::shared_ptr< MODULE > aModule)
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...
FOOTPRINT_STATUS_HANDLER m_handler
virtual CACHE_ENTRY CacheAndReturn(const LIB_ID &aFPID)

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

◆ DoRePaint()

void EDA_DRAW_PANEL_GAL::DoRePaint ( )
inherited

Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do not use a wxPaintDC, it can be called outside a wxPaintEvent.

Definition at line 165 of file draw_panel_gal.cpp.

166 {
167  // Repaint the canvas, and fix scrollbar cursors
168  // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
169  // it can be called outside a wxPaintEvent.
170 
171  // Update current zoom settings if the canvas is managed by a EDA frame
172  // (i.e. not by a preview panel in a dialog)
173  if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
175 
177 
178  if( !m_gal->IsVisible() )
179  return;
180 
181  m_pendingRefresh = false;
182 
183  if( m_drawing )
184  return;
185 
186 #ifdef PROFILE
187  PROF_COUNTER totalRealTime;
188 #endif /* PROFILE */
189 
190  wxASSERT( m_painter );
191 
192  m_drawing = true;
193  KIGFX::RENDER_SETTINGS* settings = static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
194 
195  try
196  {
197  m_view->UpdateItems();
198 
200 
203  {
204  m_view->MarkDirty();
205  }
206 
207  m_gal->SetClearColor( settings->GetBackgroundColor() );
208  m_gal->SetGridColor( settings->GetGridColor() );
209  m_gal->SetCursorColor( settings->GetCursorColor() );
210 
211  // TODO: find why ClearScreen() must be called here in opengl mode
212  // and only if m_view->IsDirty() in Cairo mode to avoid distaly artifacts
213  // when moving the mouse cursor
214  if( m_backend == GAL_TYPE_OPENGL )
215  m_gal->ClearScreen();
216 
217  if( m_view->IsDirty() )
218  {
219  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
221  m_gal->ClearScreen();
222 
223  m_view->ClearTargets();
224 
225  // Grid has to be redrawn only when the NONCACHED target is redrawn
227  m_gal->DrawGrid();
228 
229  m_view->Redraw();
230  }
231 
233  }
234  catch( std::runtime_error& err )
235  {
236  if( GAL_FALLBACK != m_backend )
237  {
239 
241  _( "Could not use OpenGL, falling back to software rendering" ),
242  wxString( err.what() ) );
243  }
244  else
245  {
246  // We're well and truly banjaxed if we get here without a fallback.
247  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
248  }
249  }
250 
251 #ifdef PROFILE
252  totalRealTime.Stop();
253  wxLogTrace( "GAL_PROFILE", "EDA_DRAW_PANEL_GAL::DoRePaint(): %.1f ms", totalRealTime.msecs() );
254 #endif /* PROFILE */
255 
256  m_lastRefresh = wxGetLocalTimeMillis();
257  m_drawing = false;
258 }
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)
virtual const COLOR4D & GetGridColor()=0
Function GetGridColor Returns current grid color settings.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
GAL_TYPE m_backend
Currently used GAL.
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
virtual const COLOR4D & GetCursorColor()=0
Function GetCursorColor Returns current cursor color settings.
virtual const COLOR4D & GetBackgroundColor()=0
Function GetBackgroundColor Returns current background color settings.
double msecs(bool aSinceLast=false)
Definition: profile.h:143
const VECTOR2D & GetCenter() const
Function GetCenter() Returns the center point of this VIEW (in world space coordinates)
Definition: view.h:333
virtual bool SwitchBackend(GAL_TYPE aGalType)
Function SwitchBackend Switches method of rendering graphics.
static constexpr GAL_TYPE GAL_FALLBACK
virtual bool HasTarget(RENDER_TARGET aTarget)
Returns true if the target exists.
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:44
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void UpdateScrollbars()
Adjusts the scrollbars position to match the current viewport.
bool m_drawing
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:1141
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:563
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
virtual void DrawGrid()
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1412
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual void ClearScreen()
Clear the screen.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
#define _(s)
Definition: 3d_actions.cpp:33
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:1122
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:75
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
void MarkDirty()
Function MarkDirty() Forces redraw of view on the next rendering.
Definition: view.h:599
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:546

References _, KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayInfoMessage(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), EDA_DRAW_PANEL_GAL::GAL_FALLBACK, 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::GetParentEDAFrame(), EDA_DRAW_FRAME::GetScreen(), EDA_DRAW_PANEL_GAL::GetView(), KIGFX::GAL::HasTarget(), EDA_DRAW_PANEL_GAL::IsDialogPreview(), KIGFX::VIEW::IsDirty(), KIGFX::VIEW::IsTargetDirty(), KIGFX::GAL::IsVisible(), EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_drawing, EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_lastRefresh, EDA_DRAW_PANEL_GAL::m_painter, EDA_DRAW_PANEL_GAL::m_parent, EDA_DRAW_PANEL_GAL::m_pendingRefresh, BASE_SCREEN::m_ScrollCenter, EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::m_viewControls, KIGFX::VIEW::MarkDirty(), PROF_COUNTER::msecs(), KIGFX::VIEW::Redraw(), KIGFX::GAL::SetClearColor(), KIGFX::GAL::SetCursorColor(), KIGFX::GAL::SetGridColor(), PROF_COUNTER::Stop(), EDA_DRAW_PANEL_GAL::SwitchBackend(), KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, KIGFX::VIEW::UpdateItems(), and KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

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

◆ ForceRefresh()

◆ GetBackend()

GAL_TYPE EDA_DRAW_PANEL_GAL::GetBackend ( ) const
inlineinherited

◆ GetBackgroundColor()

const COLOR4D & FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor ( )
overridevirtual

Get the colors to use in a preview widget to match the preview panel.

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 294 of file footprint_preview_panel.cpp.

295 {
296  KIGFX::PAINTER* painter = GetView()->GetPainter();
297  auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
298 
299  return settings->GetBackgroundColor();
300 }
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
PAINTER contains all the knowledge about how to draw graphical object onto any particular output devi...
Definition: painter.h:58
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.

References KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), and PCB_DRAW_PANEL_GAL::GetView().

◆ GetBoard()

BOARD* FOOTPRINT_PREVIEW_PANEL::GetBoard ( )
inline

◆ GetDefaultViewBBox()

BOX2I PCB_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
overridevirtualinherited

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 483 of file pcb_draw_panel_gal.cpp.

484 {
486  return m_worksheet->ViewBBox();
487 
488  return BOX2I();
489 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEM > m_worksheet
Currently used worksheet
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible() Returns information about visibility of a particular layer.
Definition: view.h:405

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

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview().

◆ GetForegroundColor()

const COLOR4D & FOOTPRINT_PREVIEW_PANEL::GetForegroundColor ( )
overridevirtual

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 303 of file footprint_preview_panel.cpp.

304 {
305  KIGFX::PAINTER* painter = GetView()->GetPainter();
306  auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
307 
308  return settings->GetCursorColor();
309 }
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
PAINTER contains all the knowledge about how to draw graphical object onto any particular output devi...
Definition: painter.h:58
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.

References KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), and PCB_DRAW_PANEL_GAL::GetView().

◆ GetGAL()

KIGFX::GAL* EDA_DRAW_PANEL_GAL::GetGAL ( ) const
inlineinherited

◆ GetMsgPanelInfo()

void PCB_DRAW_PANEL_GAL::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtualinherited

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 383 of file pcb_draw_panel_gal.cpp.

385 {
386  BOARD* board = static_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() )->GetBoard();
387  wxString txt;
388  int viasCount = 0;
389  int trackSegmentsCount = 0;
390 
391  for( TRACK* item : board->Tracks() )
392  {
393  if( item->Type() == PCB_VIA_T )
394  viasCount++;
395  else
396  trackSegmentsCount++;
397  }
398 
399  txt.Printf( wxT( "%d" ), board->GetPadCount() );
400  aList.emplace_back( _( "Pads" ), txt, DARKGREEN );
401 
402  txt.Printf( wxT( "%d" ), viasCount );
403  aList.emplace_back( _( "Vias" ), txt, DARKGREEN );
404 
405  txt.Printf( wxT( "%d" ), trackSegmentsCount );
406  aList.emplace_back( _( "Track Segments" ), txt, DARKGREEN );
407 
408  txt.Printf( wxT( "%d" ), board->GetNodesCount() );
409  aList.emplace_back( _( "Nodes" ), txt, DARKCYAN );
410 
411  txt.Printf( wxT( "%d" ), board->GetNetCount() - 1 /* don't include "No Net" in count */ );
412  aList.emplace_back( _( "Nets" ), txt, RED );
413 
414  txt.Printf( wxT( "%d" ), board->GetConnectivity()->GetUnconnectedCount() );
415  aList.emplace_back( _( "Unrouted" ), txt, BLUE );
416 }
unsigned GetNodesCount(int aNet=-1)
Function GetNodesCount.
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:747
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:345
Definition: color4d.h:59
unsigned GetPadCount()
Function GetPadCount.
Definition: color4d.h:56
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
#define _(s)
Definition: 3d_actions.cpp:33
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
TRACKS & Tracks()
Definition: class_board.h:246

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

◆ GetParentEDAFrame()

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetView()

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

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

Returns
The instance of VIEW.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 558 of file pcb_draw_panel_gal.cpp.

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

References EDA_DRAW_PANEL_GAL::m_view.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), DIALOG_PRINT_PCBNEW::createPrintout(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), EVT_GRID_CMD_CELL_CHANGED(), PCB_BASE_FRAME::FocusOnItem(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GetBackgroundColor(), PCB_BASE_FRAME::GetCollectorsGuide(), GetForegroundColor(), DIALOG_SELECT_NET_FROM_LIST::highlightNetOnBoard(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), PCB_BASE_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::onChangePadMode(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), DIALOG_DRC::OnDRCItemRClick(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), PCB_LAYER_WIDGET::OnLayerColorChange(), APPEARANCE_CONTROLS::onLayerVisibilityChanged(), PCB_LAYER_WIDGET::OnLayerVisible(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorModeChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_SELECT_NET_FROM_LIST::onRenameNet(), PCB_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderEnable(), DIALOG_PAD_PROPERTIES::prepareCanvas(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), NET_GRID_TABLE::Rebuild(), APPEARANCE_CONTROLS::rebuildNets(), DIALOG_PAD_PROPERTIES::redraw(), refreshCallback(), renderFootprint(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_EDIT_FRAME::SetElementVisibility(), APPEARANCE_CONTROLS::SetLayerVisible(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_MODEDIT_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), NET_GRID_TABLE::updateNetColor(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), ~FOOTPRINT_PREVIEW_PANEL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ GetViewControls()

◆ GetWindow()

wxWindow * FOOTPRINT_PREVIEW_PANEL::GetWindow ( )
overridevirtual

Get the underlying wxWindow.

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 406 of file footprint_preview_panel.cpp.

407 {
408  return static_cast<wxWindow*>( this );
409 }

◆ GetWorksheet()

KIGFX::WS_PROXY_VIEW_ITEM* PCB_DRAW_PANEL_GAL::GetWorksheet ( ) const
inlineinherited

Definition at line 63 of file pcb_draw_panel_gal.h.

63 { return m_worksheet.get(); }
std::unique_ptr< KIGFX::WS_PROXY_VIEW_ITEM > m_worksheet
Currently used worksheet

References PCB_DRAW_PANEL_GAL::m_worksheet.

Referenced by EDIT_TOOL::Properties(), and DRC_TOOL::RunTests().

◆ IsDialogPreview()

bool EDA_DRAW_PANEL_GAL::IsDialogPreview ( ) const
inlineinherited

Definition at line 180 of file class_draw_panel_gal.h.

180 { return m_parent != (wxWindow*) m_edaFrame; }
wxWindow * m_parent
Pointer to the parent window.
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)

References EDA_DRAW_PANEL_GAL::m_edaFrame, and EDA_DRAW_PANEL_GAL::m_parent.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), PCB_DRAW_PANEL_GAL::OnShow(), and PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL().

◆ Kiway()

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 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_EDIT_FRAME::importFile(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), LIB_CONTROL::UpdateSymbolInSchematic(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ New()

FOOTPRINT_PREVIEW_PANEL * FOOTPRINT_PREVIEW_PANEL::New ( KIWAY aKiway,
wxWindow *  aParent 
)
static

Definition at line 412 of file footprint_preview_panel.cpp.

413 {
414  PCBNEW_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
415 
416  if( cfg->m_Window.grid.sizes.empty() )
417  {
418  cfg->m_Window.grid.sizes = { "1000 mil",
419  "500 mil",
420  "250 mil",
421  "200 mil",
422  "100 mil",
423  "50 mil",
424  "25 mil",
425  "20 mil",
426  "10 mil",
427  "5 mil",
428  "2 mil",
429  "1 mil",
430  "5.0 mm",
431  "2.5 mm",
432  "1.0 mm",
433  "0.5 mm",
434  "0.25 mm",
435  "0.2 mm",
436  "0.1 mm",
437  "0.05 mm",
438  "0.025 mm",
439  "0.01 mm" };
440  }
441 
442  if( cfg->m_Window.zoom_factors.empty() )
443  {
444  cfg->m_Window.zoom_factors = { 0.035,
445  0.05,
446  0.08,
447  0.13,
448  0.22,
449  0.35,
450  0.6,
451  1.0,
452  1.5,
453  2.2,
454  3.5,
455  5.0,
456  8.0,
457  13.0,
458  20.0,
459  35.0,
460  50.0,
461  80.0,
462  130.0,
463  220.0,
464  300.0 };
465  }
466 
467  for( double& factor : cfg->m_Window.zoom_factors )
468  factor = std::min( factor, MAX_ZOOM_FACTOR );
469 
470  std::unique_ptr<KIGFX::GAL_DISPLAY_OPTIONS> gal_opts;
471 
472  gal_opts = std::make_unique<KIGFX::GAL_DISPLAY_OPTIONS>();
473  gal_opts->ReadConfig( *Pgm().GetCommonSettings(), cfg->m_Window, aParent );
474 
475  auto canvasType = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( cfg->m_Graphics.canvas_type );
476  auto panel = new FOOTPRINT_PREVIEW_PANEL( aKiway, aParent, std::move( gal_opts ), canvasType );
477 
478  panel->UpdateColors();
479 
480  const GRID_SETTINGS& gridCfg = cfg->m_Window.grid;
481 
482  panel->GetGAL()->SetGridVisibility( gridCfg.show );
483 
484  //Bounds checking cannot include number of elements as an index!
485  int gridIdx = std::max( 0, std::min( gridCfg.last_size_idx, (int) gridCfg.sizes.size() - 1 ) );
486  int gridSize = (int) ValueFromString( EDA_UNITS::INCHES, gridCfg.sizes[ gridIdx ], true );
487  panel->GetGAL()->SetGridSize( VECTOR2D( gridSize, gridSize ) );
488 
489  return panel;
490 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
#define MAX_ZOOM_FACTOR
std::vector< double > zoom_factors
Definition: app_settings.h:86
std::vector< wxString > sizes
Definition: app_settings.h:52
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
GRID_SETTINGS grid
Definition: app_settings.h:89
FOOTPRINT_PREVIEW_PANEL(KIWAY *aKiway, wxWindow *aParent, std::unique_ptr< KIGFX::GAL_DISPLAY_OPTIONS > aOpts, GAL_TYPE aGalType)
Create a new panel.
WINDOW_SETTINGS m_Window
Definition: app_settings.h:171
long long int ValueFromString(EDA_UNITS aUnits, const wxString &aTextValue, bool aUseMils, EDA_DATA_TYPE aType)
Function ValueFromString converts aTextValue in aUnits to internal units used by the application.
Definition: base_units.cpp:471
Common grid settings, available to every frame.
Definition: app_settings.h:49

References APP_SETTINGS_BASE::GRAPHICS::canvas_type, FOOTPRINT_PREVIEW_PANEL(), WINDOW_SETTINGS::grid, INCHES, GRID_SETTINGS::last_size_idx, APP_SETTINGS_BASE::m_Graphics, APP_SETTINGS_BASE::m_Window, MAX_ZOOM_FACTOR, Pgm(), GRID_SETTINGS::show, GRID_SETTINGS::sizes, ValueFromString(), and WINDOW_SETTINGS::zoom_factors.

Referenced by PCB::IFACE::CreateWindow(), and PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS().

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxEvent &  aEvent)
protectedinherited

Definition at line 501 of file draw_panel_gal.cpp.

502 {
503  // Getting focus is necessary in order to receive key events properly
504  if( m_stealsFocus )
505  SetFocus();
506 
507  aEvent.Skip();
508 }
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 487 of file draw_panel_gal.cpp.

488 {
489  if( m_lostFocus && m_stealsFocus )
490  SetFocus();
491 
492  if( !m_eventDispatcher )
493  aEvent.Skip();
494  else
496 
497  Refresh();
498 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Processes wxEvents (mostly UI events), translates them to TOOL_EVENTs, and makes tools handle those.
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().

◆ OnLoaderThreadUpdate()

void FOOTPRINT_PREVIEW_PANEL::OnLoaderThreadUpdate ( wxCommandEvent &  aEvent)
private

Definition at line 394 of file footprint_preview_panel.cpp.

395 {
397 }
virtual void DisplayFootprint(const LIB_ID &aFPID) override
Set the currently displayed footprint.

References DisplayFootprint(), and m_currentFPID.

Referenced by FOOTPRINT_PREVIEW_PANEL().

◆ onLostFocus()

void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protectedinherited

Definition at line 511 of file draw_panel_gal.cpp.

512 {
513  m_lostFocus = true;
514 
515  aEvent.Skip();
516 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.

References EDA_DRAW_PANEL_GAL::m_lostFocus.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ onPaint()

void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protectedvirtualinherited

Reimplemented in SCH_PREVIEW_PANEL, and SCH_DRAW_PANEL.

Definition at line 159 of file draw_panel_gal.cpp.

160 {
161  DoRePaint();
162 }
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do no...

References EDA_DRAW_PANEL_GAL::DoRePaint().

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

◆ onRefreshTimer()

void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 519 of file draw_panel_gal.cpp.

520 {
521  if( !m_drawingEnabled )
522  {
523  if( m_gal && m_gal->IsInitialized() )
524  {
525  m_drawing = false;
526  m_pendingRefresh = true;
527  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
528  m_drawingEnabled = true;
529  }
530  else
531  {
532  // Try again soon
533  m_refreshTimer.StartOnce( 100 );
534  return;
535  }
536  }
537 
538  //wxPaintEvent redrawEvent;
539  //wxPostEvent( this, redrawEvent );
540  DoRePaint();
541 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors Usually called by a OnPaint event, but because it do no...
bool m_drawing
True if GAL is currently redrawing the view.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
virtual bool IsInitialized() const
Returns the initalization status for the canvas.

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

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ onSetCursor()

void EDA_DRAW_PANEL_GAL::onSetCursor ( wxSetCursorEvent &  event)
protectedinherited

Definition at line 570 of file draw_panel_gal.cpp.

571 {
572  event.SetCursor( m_currentCursor );
573 }
wxCursor m_currentCursor
Current mouse cursor shape id.

References EDA_DRAW_PANEL_GAL::m_currentCursor.

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

◆ OnShow()

void PCB_DRAW_PANEL_GAL::OnShow ( )
overridevirtualinherited

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

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 419 of file pcb_draw_panel_gal.cpp.

420 {
421  PCB_BASE_FRAME* frame = nullptr;
422 
423  if( !IsDialogPreview() )
424  frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
425 
426  try
427  {
428  // Check if the current rendering backend can be properly initialized
429  m_view->UpdateItems();
430  }
431  catch( const std::runtime_error& e )
432  {
433  DisplayError( GetParent(), e.what() );
434 
435  // Use the fallback if we have one
436  if( GAL_FALLBACK != m_backend )
437  {
439 
440  if( frame )
441  frame->ActivateGalCanvas();
442  }
443  }
444 
445  if( frame )
446  {
447  SetTopLayer( frame->GetActiveLayer() );
448  KIGFX::PAINTER* painter = m_view->GetPainter();
449  auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
450  settings->LoadDisplayOptions( frame->GetDisplayOptions(), frame->ShowPageLimits() );
451  }
452 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
GAL_TYPE m_backend
Currently used GAL.
static constexpr GAL_TYPE GAL_FALLBACK
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Function GetDisplayOptions Display options control the way tracks, vias, outlines and other things ar...
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
bool ShowPageLimits() const
virtual PCB_LAYER_ID GetActiveLayer() const
PAINTER contains all the knowledge about how to draw graphical object onto any particular output devi...
Definition: painter.h:58
virtual void ActivateGalCanvas() override
void UpdateItems()
Function UpdateItems() Iterates through the list of items that asked for updating and updates them.
Definition: view.cpp:1412
bool SwitchBackend(GAL_TYPE aGalType) override
Function SwitchBackend Switches method of rendering graphics.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Function GetParentEDAFrame() Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
virtual void SetTopLayer(int aLayer) override
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.

References PCB_BASE_FRAME::ActivateGalCanvas(), DisplayError(), EDA_DRAW_PANEL_GAL::GAL_FALLBACK, PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetDisplayOptions(), KIGFX::VIEW::GetPainter(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), EDA_DRAW_PANEL_GAL::IsDialogPreview(), EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_view, PCB_DRAW_PANEL_GAL::SetTopLayer(), EDA_DRAW_FRAME::ShowPageLimits(), PCB_DRAW_PANEL_GAL::SwitchBackend(), and KIGFX::VIEW::UpdateItems().

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 544 of file draw_panel_gal.cpp.

545 {
546  if( m_gal && m_gal->IsVisible() )
547  {
548  m_onShowTimer.Stop();
549  OnShow();
550  }
551 }
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 261 of file draw_panel_gal.cpp.

262 {
264  wxSize clientSize = GetClientSize();
265  clientSize.x = std::max( 10, clientSize.x );
266  clientSize.y = std::max( 10, clientSize.y );
267  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
268 
269  if( m_view )
270  {
273  }
274 }
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:574
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().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), PCB_INSPECTION_TOOL::reportCopperClearance(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), DRC_TOOL::RunTests(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ RedrawRatsnest()

void PCB_DRAW_PANEL_GAL::RedrawRatsnest ( )
inherited

Forces refresh of the ratsnest visual representation

Definition at line 476 of file pcb_draw_panel_gal.cpp.

477 {
478  if( m_ratsnest )
479  m_view->Update( m_ratsnest.get() );
480 }
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:1531
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

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

Referenced by PCB_INSPECTION_TOOL::doHideNet(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), APPEARANCE_CONTROLS::onRatsnestModeChanged(), BOARD_COMMIT::Push(), PCBNEW_CONTROL::ToggleRatsnest(), and NET_GRID_TABLE::updateNetColor().

◆ Refresh()

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

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

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

Reimplemented in SCH_PREVIEW_PANEL.

Definition at line 277 of file draw_panel_gal.cpp.

278 {
279  if( m_pendingRefresh )
280  return;
281 
282  m_pendingRefresh = true;
283 
284 #ifdef __WXMAC__
285  // Timers on OS X may have a high latency (seen up to 500ms and more) which
286  // makes repaints jerky. No negative impact seen without throttling, so just
287  // do an unconditional refresh for OS X.
288  ForceRefresh();
289 #else
290  wxLongLong t = wxGetLocalTimeMillis();
291  wxLongLong delta = t - m_lastRefresh;
292 
293  if( delta >= MinRefreshPeriod )
294  {
295  ForceRefresh();
296  }
297  else
298  {
299  // One shot timer
300  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
301  }
302 #endif
303 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
void ForceRefresh()
Function ForceRefresh() Forces a redraw.
static const int MinRefreshPeriod
60 FPS.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.

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

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AnnotateComponents(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_EDITOR_CONTROL::BackAnnotateFootprints(), SCH_EDIT_TOOL::BreakWire(), SCH_BASE_FRAME::CenterScreen(), ZONE_FILLER_TOOL::CheckAllZones(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::DeleteAnnotation(), DisplayFootprint(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_EDIT_TOOL::DoDelete(), PCB_INSPECTION_TOOL::doHideNet(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_TOOL::editGraphicProperties(), LIB_EDIT_TOOL::editTextProperties(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::Files_io(), ZONE_FILLER_TOOL::FillAllZones(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), PCB_BASE_FRAME::FocusOnItem(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_VIEWER_TOOLS::GraphicOutlines(), PL_EDITOR_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), DIALOG_SELECT_NET_FROM_LIST::highlightNetOnBoard(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), SCH_EDIT_FRAME::KiwayMailIn(), GERBVIEW_FRAME::loadListOfGerberAndDrillFiles(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_MIGRATE_BUSES::onAcceptClicked(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), DIALOG_INSPECTOR::onCellClicked(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnEraseDrcMarkersClick(), EDA_DRAW_PANEL_GAL::OnEvent(), EDA_DRAW_FRAME::OnGridSettings(), GERBER_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnLayerColorChange(), APPEARANCE_CONTROLS::OnLayerContextMenu(), GERBER_LAYER_WIDGET::OnLayerSelect(), PCB_LAYER_WIDGET::OnLayerSelect(), APPEARANCE_CONTROLS::onLayerVisibilityChanged(), GERBER_LAYER_WIDGET::OnLayerVisible(), PCB_LAYER_WIDGET::OnLayerVisible(), SCH_EDIT_FRAME::OnModify(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), GERBER_LAYER_WIDGET::onPopupSelection(), PCB_LAYER_WIDGET::onPopupSelection(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_SELECT_NET_FROM_LIST::onRenameNet(), GERBER_LAYER_WIDGET::OnRenderColorChange(), PCB_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), PCB_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectActiveDCode(), PL_EDITOR_FRAME::OnSelectCoordOriginCorner(), GERBVIEW_FRAME::OnSelectDisplayMode(), EDA_DRAW_FRAME::OnSelectGrid(), GERBVIEW_FRAME::OnSelectHighlightChoice(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), PL_EDITOR_FRAME::OnSelectPage(), EDA_DRAW_FRAME::OnSelectZoom(), PROPERTIES_FRAME::OnSetDefaultValues(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), GERBVIEW_CONTROL::OpenDrillFile(), GERBVIEW_CONTROL::OpenJobFile(), GERBVIEW_CONTROL::OpenZipFile(), PCB_VIEWER_TOOLS::PadDisplayMode(), PL_EDITOR_FRAME::PrintPage(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_TOOLS::Properties(), ReannotateFromPCBNew(), LIB_EDIT_FRAME::RebuildView(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListLib(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), SCH_EDITOR_CONTROL::Redo(), DIALOG_PAD_PROPERTIES::redraw(), DIALOG_ERC::RedrawDrawPanel(), SCH_BASE_FRAME::RedrawScreen(), SCH_PREVIEW_PANEL::Refresh(), Refresh(), DIALOG_DRC::refreshBoardEditor(), refreshCallback(), EDA_DRAW_FRAME::RefreshCanvas(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), SCH_EDITOR_CONTROL::RemapSymbols(), EDIT_TOOL::Remove(), renderFootprint(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), GERBVIEW_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridVisibility(), LIB_VIEW_FRAME::SetSelectedLibrary(), LIB_CONTROL::ShowElectricalTypes(), PCB_VIEWER_TOOLS::ShowPadNumbers(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), GERBVIEW_FRAME::SortLayersByX2Attributes(), GLOBAL_EDIT_TOOL::SwapLayers(), SCH_DRAW_PANEL::SwitchBackend(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_ERC::TestErc(), PCB_VIEWER_TOOLS::TextOutlines(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PCBNEW_CONTROL::ToggleRatsnest(), PCBNEW_CONTROL::TrackDisplayMode(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_EDIT_LINE_STYLE::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_UPDATE_FIELDS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), PANEL_LIBEDIT_SETTINGS::TransferDataFromWindow(), DIALOG_EDIT_SHEET_PIN::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::Undo(), GERBVIEW_FRAME::UpdateDisplayOptions(), SCH_EDIT_TOOL::UpdateFields(), SCH_EDITOR_CONTROL::UpdateFind(), NET_GRID_TABLE::updateNetColor(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), SCH_EDIT_FRAME::UpdateSymbolFromEditor(), PCBNEW_CONTROL::ViaDisplayMode(), PCBNEW_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ renderFootprint()

void FOOTPRINT_PREVIEW_PANEL::renderFootprint ( std::shared_ptr< MODULE aModule)
private

Definition at line 330 of file footprint_preview_panel.cpp.

331 {
332  if( m_currentModule )
333  {
334  GetView()->Remove( m_currentModule.get() );
335  GetView()->Clear();
336  m_currentModule->SetParent( nullptr );
337  }
338 
339  aModule->SetParent( m_dummyBoard.get() );
340 
341  // Ensure we are not using the high contrast mode to display the selected footprint
342  KIGFX::PAINTER* painter = GetView()->GetPainter();
343  auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
344  settings->SetContrastModeDisplay( HIGH_CONTRAST_MODE::NORMAL );
345 
346  GetView()->Add( aModule.get() );
347  GetView()->SetVisible( aModule.get(), true );
348  GetView()->Update( aModule.get(), KIGFX::ALL );
349 
350  // Save a reference to the module's shared pointer to say we are using it in the
351  // preview panel
352  m_currentModule = aModule;
353 
354  BOX2I bbox = aModule->ViewBBox();
355  bbox.Merge( aModule->Value().ViewBBox() );
356  bbox.Merge( aModule->Reference().ViewBBox() );
357 
358  if( bbox.GetSize().x > 0 && bbox.GetSize().y > 0 )
359  {
360  // Autozoom
361  GetView()->SetViewport( BOX2D( bbox.GetOrigin(), bbox.GetSize() ) );
362 
363  // Add a margin
364  GetView()->SetScale( GetView()->GetScale() * 0.7 );
365 
366  Refresh();
367  }
368 }
void SetViewport(const BOX2D &aViewport)
Function SetViewport() Sets the visible area of the VIEW.
Definition: view.cpp:549
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags) override
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: pcb_view.cpp:93
BOX2< VECTOR2D > BOX2D
Definition: box2.h:523
Item needs to be redrawn.
Definition: view_item.h:63
virtual void Remove(VIEW_ITEM *aItem) override
Function Remove() Removes a VIEW_ITEM from the view.
Definition: pcb_view.cpp:76
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
PAINTER contains all the knowledge about how to draw graphical object onto any particular output devi...
Definition: painter.h:58
std::shared_ptr< MODULE > m_currentModule
std::unique_ptr< BOARD > m_dummyBoard
void Clear()
Function Clear() Removes all items from the view.
Definition: view.cpp:1107
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:386
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
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...
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Function SetScale() Sets the scaling factor, zooming around a given anchor point.
Definition: view.cpp:577
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Sets the item visibility.
Definition: view.cpp:1477
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Function Add() Adds a VIEW_ITEM to the view.
Definition: pcb_view.cpp:59
const Vec & GetSize() const
Definition: box2.h:189
const Vec & GetOrigin() const
Definition: box2.h:193

References KIGFX::PCB_VIEW::Add(), KIGFX::ALL, KIGFX::VIEW::Clear(), BOX2< Vec >::GetOrigin(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), BOX2< Vec >::GetSize(), PCB_DRAW_PANEL_GAL::GetView(), m_currentModule, m_dummyBoard, BOX2< Vec >::Merge(), NORMAL, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::PCB_VIEW::Remove(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::SetViewport(), KIGFX::VIEW::SetVisible(), KIGFX::PCB_VIEW::Update(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DisplayFootprint().

◆ SetCurrentCursor() [1/2]

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( wxStockCursor  aStockCursorID)
inherited

Function SetCurrentCursor Set the current cursor shape for this panel.

Definition at line 554 of file draw_panel_gal.cpp.

555 {
556  if ( aStockCursorID <= wxCURSOR_NONE || aStockCursorID >= wxCURSOR_MAX )
557  aStockCursorID = wxCURSOR_ARROW;
558 
559  SetCurrentCursor( wxCursor( aStockCursorID ) );
560 }
void SetCurrentCursor(wxStockCursor aStockCursorID)
Function SetCurrentCursor Set the current cursor shape for this panel.

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

◆ SetCurrentCursor() [2/2]

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

Definition at line 563 of file draw_panel_gal.cpp.

564 {
565  m_currentCursor = aCursor;
566  SetCursor( m_currentCursor );
567 }
wxCursor m_currentCursor
Current mouse cursor shape id.

References EDA_DRAW_PANEL_GAL::m_currentCursor.

◆ setDefaultLayerDeps()

void PCB_DRAW_PANEL_GAL::setDefaultLayerDeps ( )
protectedinherited

Sets rendering targets & dependencies for layers.

Definition at line 492 of file pcb_draw_panel_gal.cpp.

493 {
494  // caching makes no sense for Cairo and other software renderers
496 
497  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
498  m_view->SetLayerTarget( i, target );
499 
500  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
501  {
502  LAYER_NUM layer = GAL_LAYER_ORDER[i];
503  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
504 
505  // Set layer display dependencies & targets
506  if( IsCopperLayer( layer ) )
507  {
508  m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
509  m_view->SetRequired( GetNetnameLayer( layer ), layer );
510  }
511  else if( IsNetnameLayer( layer ) )
512  m_view->SetLayerDisplayOnly( layer );
513  }
514 
517 
518  // Some more required layers settings
524 
525  // Via visibility
529 
530  // Pad visibility
534 
535  // Front modules
539 
540  // Back modules
544 
551 
555 }
to draw blind/buried vias
void SetRequired(int aLayerId, int aRequiredId, bool aRequired=true)
Function SetRequired() Marks the aRequiredId layer as required for the aLayerId layer.
Definition: view.cpp:415
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.
#define ZONE_LAYER_FOR(copperLayer)
Macro for getting the zone layer for a given copper 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:697
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:423
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Definition: view.h:411
Meta control for all pads opacity/visibility (color ignored)
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
Meta control for all vias opacity/visibility.
Main rendering target (cached)
Definition: definitions.h:48
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
currently selected items overlay
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
Additional netnames layers (not associated with a PCB layer)
bool IsNetnameLayer(LAYER_NUM aLayer)
Function IsNetnameLayer tests whether a layer is a netname layer.

References B_Cu, F_Cu, GAL_LAYER_ORDER, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, GetNetnameLayer(), IsCopperLayer(), IsNetnameLayer(), LAYER_ANCHOR, LAYER_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, LAYER_PADS_NETNAMES, LAYER_PADS_PLATEDHOLES, LAYER_PADS_TH, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_VIAS, 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, KIGFX::VIEW::VIEW_MAX_LAYERS, and ZONE_LAYER_FOR.

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

◆ setDefaultLayerOrder()

void PCB_DRAW_PANEL_GAL::setDefaultLayerOrder ( )
protectedinherited

Reassigns layer order to the initial settings.

Definition at line 455 of file pcb_draw_panel_gal.cpp.

456 {
457  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
458  {
459  LAYER_NUM layer = GAL_LAYER_ORDER[i];
460  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
461 
462  m_view->SetLayerOrder( layer, i );
463  }
464 }
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:697
const LAYER_NUM GAL_LAYER_ORDER[]
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

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

Referenced by PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), and PCB_DRAW_PANEL_GAL::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 314 of file draw_panel_gal.cpp.

315 {
316  m_eventDispatcher = aEventDispatcher;
317  const wxEventType eventTypes[] = { wxEVT_TOOL };
318 
319  if( m_eventDispatcher )
320  {
321  for( wxEventType type : eventTypes )
322  {
323  m_parent->Connect( type, wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
325  }
326  }
327  else
328  {
329  for( wxEventType type : eventTypes )
330  {
331  // While loop is used to be sure that all event handlers are removed.
332  while( m_parent->Disconnect( type,
333  wxCommandEventHandler( TOOL_DISPATCHER::DispatchWxCommand ),
334  NULL, m_eventDispatcher ) );
335  }
336  }
337 }
wxWindow * m_parent
Pointer to the parent window.
#define NULL
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
virtual void DispatchWxCommand(wxCommandEvent &aEvent)
Processes wxCommands (mostly menu related events) and runs appropriate actions (eg.

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

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

◆ SetFocus()

void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtualinherited

Definition at line 143 of file draw_panel_gal.cpp.

144 {
145 // Windows has a strange manner on bringing up and activating windows
146 // containing a GAL canvas just after moving the mouse cursor into its area.
147 // Feel free to uncomment or extend the following #ifdef if you experience
148 // similar problems on your platform.
149 #ifdef __WINDOWS__
150  if( !GetParent()->IsDescendant( wxWindow::FindFocus() ) )
151  return;
152 #endif
153 
154  wxScrolledCanvas::SetFocus();
155  m_lostFocus = false;
156 }
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.

References EDA_DRAW_PANEL_GAL::m_lostFocus.

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

◆ SetHighContrastLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( int  aLayer)
inlineoverridevirtualinherited

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

◆ SetHighContrastLayer() [2/2]

void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( PCB_LAYER_ID  aLayer)
inherited

SetHighContrastLayer(), with some extra smarts for PCB

Definition at line 244 of file pcb_draw_panel_gal.cpp.

245 {
246  // Set display settings for high contrast mode
248 
249  SetTopLayer( aLayer );
250 
251  rSettings->ClearActiveLayers();
252  rSettings->SetActiveLayer( aLayer );
253 
254  if( IsCopperLayer( aLayer ) )
255  {
256  // Bring some other layers to the front in case of copper layers and make them colored
257  // fixme do not like the idea of storing the list of layers here,
258  // should be done in some other way I guess..
259  LAYER_NUM layers[] = {
260  GetNetnameLayer( aLayer ),
261  ZONE_LAYER_FOR( aLayer ),
267  };
268 
269  for( unsigned int i : layers )
270  rSettings->SetActiveLayer( i );
271 
272  // Pads should be shown too
273  if( aLayer == B_Cu )
274  {
275  rSettings->SetActiveLayer( LAYER_PAD_BK );
276  rSettings->SetActiveLayer( LAYER_MOD_BK );
278  }
279  else if( aLayer == F_Cu )
280  {
281  rSettings->SetActiveLayer( LAYER_PAD_FR );
282  rSettings->SetActiveLayer( LAYER_MOD_FR );
284  }
285  }
286 
288 }
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
multilayer pads, usually with holes
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
#define ZONE_LAYER_FOR(copperLayer)
Macro for getting the zone layer for a given copper 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...
show modules on front
void ClearActiveLayers()
Function ClearActiveLayers Clears the list of active layers.
to draw usual through hole vias
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
layer for drc markers which have been individually excluded
layer for drc markers with SEVERITY_WARNING
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.
smd pads, front layer
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
currently selected items overlay
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
virtual void SetTopLayer(int aLayer) override
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:794
layer for drc markers with SEVERITY_ERROR
Additional netnames layers (not associated with a PCB layer)

References B_Cu, KIGFX::RENDER_SETTINGS::ClearActiveLayers(), F_Cu, GetNetnameLayer(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), IsCopperLayer(), LAYER_CURSOR, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, 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(), PCB_DRAW_PANEL_GAL::SetTopLayer(), KIGFX::VIEW::UpdateAllLayersColor(), and ZONE_LAYER_FOR.

◆ SetKiway()

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 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetStatusHandler()

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 400 of file footprint_preview_panel.cpp.

401 {
402  m_handler = aHandler;
403 }
FOOTPRINT_STATUS_HANDLER m_handler

References m_handler.

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

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

References EDA_DRAW_PANEL_GAL::m_stealsFocus.

Referenced by LIB_VIEW_FRAME::ClickOnCmpList(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME::ClickOnLibList(), FOOTPRINT_PREVIEW_PANEL(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), DIALOG_PAD_PROPERTIES::prepareCanvas(), LIB_VIEW_FRAME::SetSelectedLibrary(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

◆ SetTopLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
inlineoverridevirtualinherited

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

◆ SetTopLayer() [2/2]

void PCB_DRAW_PANEL_GAL::SetTopLayer ( PCB_LAYER_ID  aLayer)
inherited

SetTopLayer(), with some extra smarts for PCB

Definition at line 291 of file pcb_draw_panel_gal.cpp.

292 {
295  m_view->SetTopLayer( aLayer );
296 
297  // Layers that should always have on-top attribute enabled
298  const std::vector<LAYER_NUM> layers = {
303  };
304 
305  for( auto layer : layers )
306  m_view->SetTopLayer( layer );
307 
308  // Extra layers that are brought to the top if a F.* or B.* is selected
309  const std::vector<LAYER_NUM> frontLayers = {
312  };
313 
314  const std::vector<LAYER_NUM> backLayers = {
317  };
318 
319  const std::vector<LAYER_NUM>* extraLayers = NULL;
320 
321  // Bring a few more extra layers to the top depending on the selected board side
322  if( IsFrontLayer( aLayer ) )
323  extraLayers = &frontLayers;
324  else if( IsBackLayer( aLayer ) )
325  extraLayers = &backLayers;
326 
327  if( extraLayers )
328  {
329  for( auto layer : *extraLayers )
330  m_view->SetTopLayer( layer );
331 
332  // Move the active layer to the top
333  if( !IsCopperLayer( aLayer ) )
335  }
336  else if( IsCopperLayer( aLayer ) )
337  {
338  // Display labels for copper layers on the top
339  m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
340  m_view->SetTopLayer( ZONE_LAYER_FOR( aLayer ) );
341  }
342 
343  m_view->EnableTopLayer( true );
345 }
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:856
multilayer pads, usually with holes
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
#define ZONE_LAYER_FOR(copperLayer)
Macro for getting the zone layer for a given copper 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:923
virtual void EnableTopLayer(bool aEnable)
Function EnableTopLayer() Enables or disables display of the top layer.
Definition: view.cpp:883
const LAYER_NUM GAL_LAYER_ORDER[]
#define NULL
to draw usual through hole vias
void ClearTopLayers()
Function ClearTopLayers() Removes all layers from the on-the-top set (they are no longer displayed ov...
Definition: view.cpp:908
layer for drc markers which have been individually excluded
layer for drc markers with SEVERITY_WARNING
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.
layer for drc markers with SEVERITY_ERROR
Additional netnames layers (not associated with a PCB layer)

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

◆ SetWorksheet()

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

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

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

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems().

◆ StartDrawing()

void EDA_DRAW_PANEL_GAL::StartDrawing ( )
inherited

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

Definition at line 340 of file draw_panel_gal.cpp.

341 {
342  // Start querying GAL if it is ready
343  m_refreshTimer.StartOnce( 100 );
344 }
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.

References EDA_DRAW_PANEL_GAL::m_refreshTimer.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), EDA_DRAW_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), FOOTPRINT_PREVIEW_PANEL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), DIALOG_PAD_PROPERTIES::redraw(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), and SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL().

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

348 {
349  m_drawingEnabled = false;
350  Disconnect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), NULL, this );
351  m_pendingRefresh = false;
352  m_refreshTimer.Stop();
353 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
#define NULL
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.

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

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

◆ SwitchBackend()

bool PCB_DRAW_PANEL_GAL::SwitchBackend ( GAL_TYPE  aGalType)
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 467 of file pcb_draw_panel_gal.cpp.

468 {
469  bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
471  m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
472  return rv;
473 }
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, PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), KIGFX::GAL::SetWorldUnitLength(), and EDA_DRAW_PANEL_GAL::SwitchBackend().

Referenced by PCB_DRAW_PANEL_GAL::OnShow().

◆ SyncLayersVisibility()

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

349 {
350  // Load layer & elements visibility settings
351  for( LAYER_NUM i = 0; i < PCB_LAYER_ID_COUNT; ++i )
352  m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
353 
355  m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
356 
357  // Via layers controlled by dependencies
361 
362  // Pad layers controlled by dependencies
366 
367  // Always enable netname layers, as their visibility is controlled by layer dependencies
369  m_view->SetLayerVisible( i, true );
370 
371  for( LAYER_NUM i = LAYER_ZONE_START; i < LAYER_ZONE_END; i++ )
372  m_view->SetLayerVisible( i, true );
373 
374  // Enable some layers that are GAL specific
380 }
Virtual layers for stacking zones and tracks on a given copper layer.
to draw blind/buried vias
multilayer pads, usually with holes
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:
to draw usual through hole vias
void SetLayerVisible(int aLayer, bool aVisible=true)
Function SetLayerVisible() Controls the visibility of a particular layer.
Definition: view.h:388
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 ...
smd pads, front layer
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
currently selected items overlay

References GAL_LAYER_ID_END, GAL_LAYER_ID_START, BOARD::IsElementVisible(), BOARD::IsLayerVisible(), LAYER_GP_OVERLAY, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_PLATEDHOLES, LAYER_PADS_TH, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_VIAS_HOLES, LAYER_ZONE_END, LAYER_ZONE_START, EDA_DRAW_PANEL_GAL::m_view, NETNAMES_LAYER_ID_END, NETNAMES_LAYER_ID_START, PCB_LAYER_ID_COUNT, and KIGFX::VIEW::SetLayerVisible().

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

◆ UpdateColors()

void PCB_DRAW_PANEL_GAL::UpdateColors ( )
inherited

Updates the color settings in the painter and GAL.

Definition at line 212 of file pcb_draw_panel_gal.cpp.

213 {
214  COLOR_SETTINGS* cs = nullptr;
215 
216  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
217 
218  if( frame )
219  {
220  cs = frame->GetColorSettings();
221  }
222  else
223  {
224  PCBNEW_SETTINGS* app = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
225 
226  if( app )
227  cs = Pgm().GetSettingsManager().GetColorSettings( app->m_ColorTheme );
228  else
229  cs = Pgm().GetSettingsManager().GetColorSettings();
230  }
231 
232  wxCHECK_RET( cs, "null COLOR_SETTINGS" );
233 
234  Pgm().GetSettingsManager().SaveColorSettings( cs, "board" );
235 
236  auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
237  rs->LoadColors( cs );
238 
241 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
virtual COLOR_SETTINGS * GetColorSettings() override
Helper to retrieve the current color settings.
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.
COLOR4D GetColor(int aLayer) const
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.
Color settings are a bit different than most of the settings objects in that there can be more than o...
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:174

References COLOR_SETTINGS::GetColor(), PCB_BASE_FRAME::GetColorSettings(), KIGFX::VIEW::GetPainter(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), KIGFX::PAINTER::GetSettings(), LAYER_CURSOR, LAYER_GRID, APP_SETTINGS_BASE::m_ColorTheme, EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_view, Pgm(), KIGFX::GAL::SetCursorColor(), and KIGFX::GAL::SetGridColor().

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), FOOTPRINT_PREVIEW_PANEL(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), PCB_LAYER_WIDGET::OnLayerColorChange(), PCB_LAYER_WIDGET::OnRenderColorChange(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_BASE_EDIT_FRAME::SetBoard(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), and FOOTPRINT_EDIT_FRAME::updateView().

Friends And Related Function Documentation

◆ FP_LOADER_THREAD

friend class FP_LOADER_THREAD
friend

Definition at line 56 of file footprint_preview_panel.h.

Referenced by FOOTPRINT_PREVIEW_PANEL().

◆ FP_THREAD_IFACE

friend class FP_THREAD_IFACE
friend

Definition at line 55 of file footprint_preview_panel.h.

Member Data Documentation

◆ GAL_FALLBACK

◆ m_backend

◆ m_currentCursor

wxCursor EDA_DRAW_PANEL_GAL::m_currentCursor
protectedinherited

◆ m_currentFPID

LIB_ID FOOTPRINT_PREVIEW_PANEL::m_currentFPID
private

Definition at line 112 of file footprint_preview_panel.h.

Referenced by DisplayFootprint(), and OnLoaderThreadUpdate().

◆ m_currentModule

std::shared_ptr<MODULE> FOOTPRINT_PREVIEW_PANEL::m_currentModule
private

Definition at line 111 of file footprint_preview_panel.h.

Referenced by renderFootprint(), and ~FOOTPRINT_PREVIEW_PANEL().

◆ m_displayOptions

std::unique_ptr<KIGFX::GAL_DISPLAY_OPTIONS> FOOTPRINT_PREVIEW_PANEL::m_displayOptions
private

Definition at line 109 of file footprint_preview_panel.h.

◆ 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 247 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_dummyBoard

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

Definition at line 108 of file footprint_preview_panel.h.

Referenced by FOOTPRINT_PREVIEW_PANEL(), GetBoard(), and renderFootprint().

◆ m_edaFrame

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protectedinherited

Processes and forwards events to tools.

Definition at line 269 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_footprintDisplayed

bool FOOTPRINT_PREVIEW_PANEL::m_footprintDisplayed
private

Definition at line 113 of file footprint_preview_panel.h.

Referenced by DisplayFootprint().

◆ m_gal

◆ m_handler

FOOTPRINT_STATUS_HANDLER FOOTPRINT_PREVIEW_PANEL::m_handler
private

Definition at line 106 of file footprint_preview_panel.h.

Referenced by DisplayFootprint(), and SetStatusHandler().

◆ m_iface

std::shared_ptr<FP_THREAD_IFACE> FOOTPRINT_PREVIEW_PANEL::m_iface
private

◆ m_lastRefresh

wxLongLong EDA_DRAW_PANEL_GAL::m_lastRefresh
protectedinherited

Last timestamp when the panel was refreshed.

Definition at line 239 of file class_draw_panel_gal.h.

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

◆ m_loader

FP_LOADER_THREAD* FOOTPRINT_PREVIEW_PANEL::m_loader
private

Definition at line 104 of file footprint_preview_panel.h.

Referenced by FOOTPRINT_PREVIEW_PANEL().

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

Referenced by 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 250 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 266 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ m_painter

◆ m_parent

wxWindow* EDA_DRAW_PANEL_GAL::m_parent
protectedinherited

◆ m_pendingRefresh

bool EDA_DRAW_PANEL_GAL::m_pendingRefresh
protectedinherited

◆ m_ratsnest

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

Ratsnest view item

Definition at line 124 of file pcb_draw_panel_gal.h.

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), and PCB_DRAW_PANEL_GAL::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 277 of file class_draw_panel_gal.h.

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

◆ m_view

KIGFX::VIEW* EDA_DRAW_PANEL_GAL::m_view
protectedinherited

Stores view settings (scale, center, etc.) and items to be drawn.

Definition at line 256 of file class_draw_panel_gal.h.

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), EDA_DRAW_PANEL_GAL::DoRePaint(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GERBVIEW_DRAW_PANEL_GAL::GetDefaultViewBBox(), PCB_DRAW_PANEL_GAL::GetDefaultViewBBox(), SCH_DRAW_PANEL::GetView(), PCB_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetView(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), SCH_DRAW_PANEL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), EDA_DRAW_PANEL_GAL::onSize(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), SCH_DRAW_PANEL::SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), PL_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerOrder(), SCH_PREVIEW_PANEL::setDefaultLayerOrder(), PCB_DRAW_PANEL_GAL::setDefaultLayerOrder(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), EDA_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetWorksheet(), GERBVIEW_DRAW_PANEL_GAL::SetWorksheet(), PL_DRAW_PANEL_GAL::SwitchBackend(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), EDA_DRAW_PANEL_GAL::SwitchBackend(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), PCB_DRAW_PANEL_GAL::UpdateColors(), SCH_PREVIEW_PANEL::view(), and EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL().

◆ m_viewControls

◆ m_worksheet

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

◆ MinRefreshPeriod

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotectedinherited

60 FPS.

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