KiCad PCB EDA Suite
PCB_DRAW_PANEL_GAL Class Reference

#include <pcb_draw_panel_gal.h>

Inheritance diagram for PCB_DRAW_PANEL_GAL:
EDA_DRAW_PANEL_GAL FOOTPRINT_PREVIEW_PANEL

Public Types

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

Public Member Functions

 PCB_DRAW_PANEL_GAL (wxWindow *aParentWindow, wxWindowID aWindowId, const wxPoint &aPosition, const wxSize &aSize, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType=GAL_TYPE_OPENGL)
 
virtual ~PCB_DRAW_PANEL_GAL ()
 
void DisplayBoard (BOARD *aBoard)
 Add all items from the current board to the VIEW, so they can be displayed by GAL. More...
 
void SetDrawingSheet (DS_PROXY_VIEW_ITEM *aDrawingSheet)
 Sets (or updates) drawing-sheet used by the draw panel. More...
 
DS_PROXY_VIEW_ITEMGetDrawingSheet () const
 
void UpdateColors ()
 Update the color settings in the painter and GAL. More...
 
virtual void SetHighContrastLayer (int aLayer) override
 SetHighContrastLayer(), with some extra smarts for PCB. More...
 
void SetHighContrastLayer (PCB_LAYER_ID aLayer)
 Move the selected layer to the top, so it is displayed above all others. More...
 
virtual void SetTopLayer (int aLayer) override
 SetTopLayer(), with some extra smarts for PCB. More...
 
void SetTopLayer (PCB_LAYER_ID aLayer)
 
void SyncLayersVisibility (const BOARD *aBoard)
 Update "visibility" property of each layer of a given BOARD. More...
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Called when the window is shown for the first time. More...
 
void OnShow () override
 Called when the window is shown for the first time. More...
 
bool SwitchBackend (GAL_TYPE aGalType) override
 Force refresh of the ratsnest visual representation. More...
 
void RedrawRatsnest ()
 Return the bounding box of the view that should be used if model is not valid. More...
 
BOX2I GetDefaultViewBBox () const override
 Return the bounding box of the view that should be used if model is not valid. More...
 
virtual KIGFX::PCB_VIEWGetView () const override
 Return a pointer to the #VIEW instance used in the panel. More...
 
virtual void SetFocus () override
 
GAL_TYPE GetBackend () const
 Return the type of backend currently used by GAL canvas. More...
 
KIGFX::GALGetGAL () const
 Return a pointer to the GAL instance used in the panel. More...
 
KIGFX::VIEW_CONTROLSGetViewControls () const
 Return a pointer to the #VIEW_CONTROLS instance used in the panel. More...
 
virtual void Refresh (bool aEraseBackground=true, const wxRect *aRect=nullptr) 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 ()
 Force a redraw. More...
 
void SetEventDispatcher (TOOL_DISPATCHER *aEventDispatcher)
 Set a dispatcher that processes events and forwards them to tools. More...
 
void StartDrawing ()
 Begin drawing if it was stopped previously. More...
 
void StopDrawing ()
 Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called. More...
 
EDA_DRAW_FRAMEGetParentEDAFrame () const
 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 (KICURSOR aCursor)
 Set the current cursor shape for this panel. More...
 
void OnEvent (wxEvent &aEvent)
 Used to forward events to the canvas from popups, etc. More...
 
void DoRePaint ()
 Repaint the canvas, and fix scrollbar cursors. More...
 
std::shared_ptr< KIGFX::VIEW_OVERLAYDebugOverlay ()
 Create an overlay for rendering debug graphics. More...
 
void ClearDebugOverlay ()
 Clear the contents of the debug overlay and removes it from the VIEW. More...
 

Public Attributes

bool m_MouseCapturedLost
 used on wxMSW: true after a wxEVT_MOUSE_CAPTURE_LOST was received false after the mouse is recaptured. More...
 

Static Public Attributes

static constexpr GAL_TYPE GAL_FALLBACK = GAL_TYPE_CAIRO
 

Protected Member Functions

void setDefaultLayerOrder ()
 < Reassign layer order to the initial settings. More...
 
void setDefaultLayerDeps ()
 Currently used drawing-sheet. More...
 
virtual void onPaint (wxPaintEvent &WXUNUSED(aEvent))
 
void onSize (wxSizeEvent &aEvent)
 
void onEnter (wxMouseEvent &aEvent)
 
void onLostFocus (wxFocusEvent &aEvent)
 
void onRefreshTimer (wxTimerEvent &aEvent)
 
void onShowTimer (wxTimerEvent &aEvent)
 

Protected Attributes

std::unique_ptr< DS_PROXY_VIEW_ITEMm_drawingSheet
 Ratsnest view item. More...
 
std::unique_ptr< RATSNEST_VIEW_ITEMm_ratsnest
 
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...
 
std::shared_ptr< KIGFX::VIEW_OVERLAYm_debugOverlay
 Optional overlay for drawing transient debug objects. More...
 

Static Protected Attributes

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

Detailed Description

Definition at line 37 of file pcb_draw_panel_gal.h.

Member Enumeration Documentation

◆ GAL_TYPE

Enumerator
GAL_TYPE_UNKNOWN 

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

GAL_TYPE_NONE 

GAL not used (the legacy wxDC engine is used)

GAL_TYPE_OPENGL 

OpenGL implementation.

GAL_TYPE_CAIRO 

Cairo implementation.

GAL_TYPE_LAST 

Sentinel, do not use as a parameter.

Definition at line 60 of file class_draw_panel_gal.h.

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

Constructor & Destructor Documentation

◆ PCB_DRAW_PANEL_GAL()

PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL ( wxWindow *  aParentWindow,
wxWindowID  aWindowId,
const wxPoint &  aPosition,
const wxSize &  aSize,
KIGFX::GAL_DISPLAY_OPTIONS aOptions,
GAL_TYPE  aGalType = GAL_TYPE_OPENGL 
)

Definition at line 142 of file pcb_draw_panel_gal.cpp.

144  :
145  EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
146 {
147  m_view = new KIGFX::PCB_VIEW( true );
148  m_view->SetGAL( m_gal );
149 
150  m_painter = std::make_unique<KIGFX::PCB_PAINTER>( m_gal );
151  m_view->SetPainter( m_painter.get() );
152 
153  // This fixes the zoom in and zoom out limits:
155 
158 
159  // View controls is the first in the event handler chain, so the Tool Framework operates
160  // on updated viewport data.
162 
163  // Load display options (such as filled/outline display of items).
164  // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
165  // which is not always the case (namely when it is used from a wxDialog like the pad editor)
166  if( !IsDialogPreview() )
167  {
168  KIGFX::PCB_VIEW* view = static_cast<KIGFX::PCB_VIEW*>( m_view );
169  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
170 
171  if( frame )
172  view->UpdateDisplayOptions( frame->GetDisplayOptions() );
173  }
174 }
void SetScaleLimits(double aMaximum, double aMinimum)
Set minimum and maximum values for scale.
Definition: view.h:303
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void setDefaultLayerDeps()
Currently used drawing-sheet.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
An implementation of class VIEW_CONTROLS for wxWidgets library.
void setDefaultLayerOrder()
< Reassign layer order to the initial settings.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
void UpdateDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions)
Definition: pcb_view.cpp:125
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
#define ZOOM_MAX_LIMIT_PCBNEW
Definition: zoom_defines.h:62
EDA_DRAW_PANEL_GAL(wxWindow *aParentWindow, wxWindowID aWindowId, const wxPoint &aPosition, const wxSize &aSize, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType=GAL_TYPE_OPENGL)
Create a drawing panel that is contained inside aParentWindow.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
#define ZOOM_MIN_LIMIT_PCBNEW
Definition: zoom_defines.h:63
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
void SetPainter(PAINTER *aPainter)
Set the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:197
void SetGAL(GAL *aGal)
Assign a rendering device for the VIEW.
Definition: view.cpp:494
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.

References PCB_BASE_FRAME::GetDisplayOptions(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), EDA_DRAW_PANEL_GAL::IsDialogPreview(), EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_painter, EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::m_viewControls, setDefaultLayerDeps(), setDefaultLayerOrder(), KIGFX::VIEW::SetGAL(), KIGFX::VIEW::SetPainter(), KIGFX::VIEW::SetScaleLimits(), KIGFX::PCB_VIEW::UpdateDisplayOptions(), ZOOM_MAX_LIMIT_PCBNEW, and ZOOM_MIN_LIMIT_PCBNEW.

◆ ~PCB_DRAW_PANEL_GAL()

PCB_DRAW_PANEL_GAL::~PCB_DRAW_PANEL_GAL ( )
virtual

Definition at line 177 of file pcb_draw_panel_gal.cpp.

178 {
179 }

Member Function Documentation

◆ ClearDebugOverlay()

void EDA_DRAW_PANEL_GAL::ClearDebugOverlay ( )
inherited

Clear the contents of the debug overlay and removes it from the VIEW.

Definition at line 581 of file draw_panel_gal.cpp.

582 {
583  if( m_debugOverlay )
584  {
585  m_view->Remove( m_debugOverlay.get() );
586  m_debugOverlay = nullptr;
587  }
588 }
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:351
std::shared_ptr< KIGFX::VIEW_OVERLAY > m_debugOverlay
Optional overlay for drawing transient debug objects.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

References EDA_DRAW_PANEL_GAL::m_debugOverlay, EDA_DRAW_PANEL_GAL::m_view, and KIGFX::VIEW::Remove().

◆ DebugOverlay()

std::shared_ptr< KIGFX::VIEW_OVERLAY > EDA_DRAW_PANEL_GAL::DebugOverlay ( )
inherited

Create an overlay for rendering debug graphics.

Definition at line 569 of file draw_panel_gal.cpp.

570 {
571  if( !m_debugOverlay )
572  {
573  m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
574  m_view->Add( m_debugOverlay.get() );
575  }
576 
577  return m_debugOverlay;
578 }
std::shared_ptr< KIGFX::VIEW_OVERLAY > m_debugOverlay
Optional overlay for drawing transient debug objects.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:321

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

◆ DisplayBoard()

void PCB_DRAW_PANEL_GAL::DisplayBoard ( BOARD aBoard)

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

183 {
184 
185  m_view->Clear();
186 
187  auto zones = aBoard->Zones();
188  std::atomic<size_t> next( 0 );
189  std::atomic<size_t> count_done( 0 );
190  size_t parallelThreadCount = std::max<size_t>( std::thread::hardware_concurrency(), 2 );
191 
192  for( size_t ii = 0; ii < parallelThreadCount; ++ii )
193  {
194  std::thread t = std::thread( [ &count_done, &next, &zones ]( )
195  {
196  for( size_t i = next.fetch_add( 1 ); i < zones.size(); i = next.fetch_add( 1 ) )
197  zones[i]->CacheTriangulation();
198 
199  count_done++;
200  } );
201 
202  t.detach();
203  }
204 
205  if( m_drawingSheet )
206  m_drawingSheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
207 
208  // Load drawings
209  for( BOARD_ITEM* drawing : aBoard->Drawings() )
210  m_view->Add( drawing );
211 
212  // Load tracks
213  for( PCB_TRACK* track : aBoard->Tracks() )
214  m_view->Add( track );
215 
216  // Load footprints and its additional elements
217  for( FOOTPRINT* footprint : aBoard->Footprints() )
218  m_view->Add( footprint );
219 
220  // DRC markers
221  for( PCB_MARKER* marker : aBoard->Markers() )
222  m_view->Add( marker );
223 
224  // Finalize the triangulation threads
225  while( count_done < parallelThreadCount )
226  std::this_thread::sleep_for( std::chrono::milliseconds( 10 ) );
227 
228  // Load zones
229  for( ZONE* zone : aBoard->Zones() )
230  m_view->Add( zone );
231 
232  // Ratsnest
233  m_ratsnest = std::make_unique<RATSNEST_VIEW_ITEM>( aBoard->GetConnectivity() );
234  m_view->Add( m_ratsnest.get() );
235 }
CITER next(CITER it)
Definition: ptree.cpp:126
ZONES & Zones()
Definition: board.h:239
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:80
MARKERS & Markers()
Definition: board.h:242
const wxString & GetFileName() const
Definition: board.h:228
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
std::unique_ptr< DS_PROXY_VIEW_ITEM > m_drawingSheet
Ratsnest view item.
void Clear()
Remove all items from the view.
Definition: view.cpp:1091
FOOTPRINTS & Footprints()
Definition: board.h:233
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:344
Handle a list of polygons defining a copper zone.
Definition: zone.h:57
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:321
std::unique_ptr< RATSNEST_VIEW_ITEM > m_ratsnest
DRAWINGS & Drawings()
Definition: board.h:236
TRACKS & Tracks()
Definition: board.h:230

References KIGFX::VIEW::Add(), KIGFX::VIEW::Clear(), BOARD::Drawings(), BOARD::Footprints(), BOARD::GetConnectivity(), BOARD::GetFileName(), m_drawingSheet, m_ratsnest, EDA_DRAW_PANEL_GAL::m_view, BOARD::Markers(), next(), TO_UTF8, BOARD::Tracks(), and BOARD::Zones().

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

◆ DoRePaint()

void EDA_DRAW_PANEL_GAL::DoRePaint ( )
inherited

Repaint the canvas, and fix scrollbar cursors.

Usually called by a OnPaint event.

Because it does not use a wxPaintDC, it can be called outside a wxPaintEvent.

Definition at line 174 of file draw_panel_gal.cpp.

175 {
176  // Repaint the canvas, and fix scrollbar cursors
177  // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
178  // it can be called outside a wxPaintEvent.
179 
180  // Update current zoom settings if the canvas is managed by a EDA frame
181  // (i.e. not by a preview panel in a dialog)
182  if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
184 
186 
187  if( !m_gal->IsVisible() )
188  return;
189 
190  m_pendingRefresh = false;
191 
192  if( m_drawing )
193  return;
194 
195 #ifdef PROFILE
196  PROF_COUNTER totalRealTime;
197 #endif /* PROFILE */
198 
199  wxASSERT( m_painter );
200 
201  m_drawing = true;
202  KIGFX::RENDER_SETTINGS* settings =
203  static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
204 
205  try
206  {
207  m_view->UpdateItems();
208 
210 
213  {
214  m_view->MarkDirty();
215  }
216 
217  m_gal->SetClearColor( settings->GetBackgroundColor() );
218  m_gal->SetGridColor( settings->GetGridColor() );
219  m_gal->SetCursorColor( settings->GetCursorColor() );
220 
221  // TODO: find why ClearScreen() must be called here in opengl mode
222  // and only if m_view->IsDirty() in Cairo mode to avoid display artifacts
223  // when moving the mouse cursor
224  if( m_backend == GAL_TYPE_OPENGL )
225  m_gal->ClearScreen();
226 
227  if( m_view->IsDirty() )
228  {
229  if( m_backend != GAL_TYPE_OPENGL && // Already called in opengl
231  m_gal->ClearScreen();
232 
233  m_view->ClearTargets();
234 
235  // Grid has to be redrawn only when the NONCACHED target is redrawn
237  m_gal->DrawGrid();
238 
239  m_view->Redraw();
240  }
241 
243  }
244  catch( std::exception& err )
245  {
246  if( GAL_FALLBACK != m_backend )
247  {
249 
251  _( "Could not use OpenGL, falling back to software rendering" ),
252  wxString( err.what() ) );
253  }
254  else
255  {
256  // We're well and truly banjaxed if we get here without a fallback.
257  DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
258  }
259  }
260 
261 #ifdef PROFILE
262  totalRealTime.Stop();
263  wxLogTrace( traceGalProfile, "EDA_DRAW_PANEL_GAL::DoRePaint(): %.1f ms",
264  totalRealTime.msecs() );
265 #endif /* PROFILE */
266 
267  m_lastRefresh = wxGetLocalTimeMillis();
268  m_drawing = false;
269 }
void Stop()
Save the time when this function was called, and set the counter stane to stop.
Definition: profile.h:85
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
Return current grid color settings.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
GAL_TYPE m_backend
Currently used GAL.
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
virtual const COLOR4D & GetCursorColor()=0
Return current cursor color settings.
virtual const COLOR4D & GetBackgroundColor()=0
Return current background color settings.
double msecs(bool aSinceLast=false)
Definition: profile.h:146
const VECTOR2D & GetCenter() const
Return the center point of this VIEW (in world space coordinates).
Definition: view.h:333
virtual bool SwitchBackend(GAL_TYPE aGalType)
Switch method of rendering graphics.
static constexpr GAL_TYPE GAL_FALLBACK
virtual bool HasTarget(RENDER_TARGET aTarget)
Return true if the target exists.
const wxChar *const traceGalProfile
Flag to enable debug output of GAL performance profiling.
A small class to help profiling.
Definition: profile.h:45
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void UpdateScrollbars()
End any mouse drag action still in progress.
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()
Immediately redraws the whole view.
Definition: view.cpp:1125
bool IsTargetDirty(int aTarget) const
Return true if any of layers belonging to the target or the target itself should be redrawn.
Definition: view.h:561
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
#define _(s)
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1397
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.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
<
virtual bool IsVisible() const
Return true if the GAL canvas is visible on the screen.
void ClearTargets()
Clear targets that are marked as dirty.
Definition: view.cpp:1106
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:100
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:275
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:596
bool IsDirty() const
Return true if any of the VIEW layers needs to be refreshened.
Definition: view.h:544

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, traceGalProfile, 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()

◆ GetDefaultViewBBox()

BOX2I PCB_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
overridevirtual

Return the bounding box of the view that should be used if model is not valid.

For example, the drawing sheet bounding box for an empty PCB

Returns
the default bounding box for the panel.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 542 of file pcb_draw_panel_gal.cpp.

543 {
545  return m_drawingSheet->ViewBBox();
546 
547  return BOX2I();
548 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:506
std::unique_ptr< DS_PROXY_VIEW_ITEM > m_drawingSheet
Ratsnest view item.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
drawingsheet frame and titleblock
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:404

References KIGFX::VIEW::IsLayerVisible(), LAYER_DRAWINGSHEET, m_drawingSheet, and EDA_DRAW_PANEL_GAL::m_view.

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview().

◆ GetDrawingSheet()

DS_PROXY_VIEW_ITEM* PCB_DRAW_PANEL_GAL::GetDrawingSheet ( ) const
inline

Definition at line 61 of file pcb_draw_panel_gal.h.

61 { return m_drawingSheet.get(); }
std::unique_ptr< DS_PROXY_VIEW_ITEM > m_drawingSheet
Ratsnest view item.

References m_drawingSheet.

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

◆ GetGAL()

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

Return a pointer to the GAL instance used in the panel.

Returns
The instance of GAL.

Definition at line 108 of file class_draw_panel_gal.h.

108 { return m_gal; }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.

References EDA_DRAW_PANEL_GAL::m_gal.

Referenced by FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), EDA_DRAW_FRAME::GetNearestGridPosition(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), EDA_DRAW_FRAME::GetZoomLevelIndicator(), EDA_DRAW_FRAME::OnMove(), GERBER_LAYER_WIDGET::OnRenderEnable(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), PCB_BASE_EDIT_FRAME::SetBoard(), GERBVIEW_FRAME::SetGridColor(), EDA_DRAW_FRAME::SetGridVisibility(), PL_DRAW_PANEL_GAL::SwitchBackend(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), SYMBOL_EDIT_FRAME::SwitchCanvas(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), ZOOM_MENU::update(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview(), and EDA_DRAW_FRAME::UpdateZoomSelectBox().

◆ GetMsgPanelInfo()

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

Called when the window is shown for the first time.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 442 of file pcb_draw_panel_gal.cpp.

444 {
445  BOARD* board = static_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() )->GetBoard();
446  wxString txt;
447  int viasCount = 0;
448  int trackSegmentsCount = 0;
449 
450  for( PCB_TRACK* item : board->Tracks() )
451  {
452  if( item->Type() == PCB_VIA_T )
453  viasCount++;
454  else
455  trackSegmentsCount++;
456  }
457 
458  txt.Printf( wxT( "%d" ), board->GetPadCount() );
459  aList.emplace_back( _( "Pads" ), txt );
460 
461  txt.Printf( wxT( "%d" ), viasCount );
462  aList.emplace_back( _( "Vias" ), txt );
463 
464  txt.Printf( wxT( "%d" ), trackSegmentsCount );
465  aList.emplace_back( _( "Track Segments" ), txt );
466 
467  txt.Printf( wxT( "%d" ), board->GetNodesCount() );
468  aList.emplace_back( _( "Nodes" ), txt );
469 
470  txt.Printf( wxT( "%d" ), board->GetNetCount() - 1 /* don't include "No Net" in count */ );
471  aList.emplace_back( _( "Nets" ), txt );
472 
473  txt.Printf( wxT( "%d" ), board->GetConnectivity()->GetUnconnectedCount() );
474  aList.emplace_back( _( "Unrouted" ), txt );
475 }
unsigned GetNodesCount(int aNet=-1) const
Definition: board.cpp:1081
unsigned GetNetCount() const
Definition: board.h:715
unsigned GetPadCount() const
Definition: board.cpp:1927
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:51
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:344
#define _(s)
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
TRACKS & Tracks()
Definition: board.h:230

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

◆ GetParentEDAFrame()

◆ GetView()

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

Return a pointer to the #VIEW instance used in the panel.

Returns
The instance of #VIEW.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 636 of file pcb_draw_panel_gal.cpp.

637 {
638  return static_cast<KIGFX::PCB_VIEW*>( m_view );
639 }
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_NET_INSPECTOR::buildNetsList(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), DIALOG_PRINT_PCBNEW::createPrintout(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), EVT_GRID_CMD_CELL_CHANGED(), DIALOG_DRC::ExcludeMarker(), PCB_BASE_FRAME::FocusOnItem(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor(), PCB_BASE_FRAME::GetCollectorsGuide(), FOOTPRINT_PREVIEW_PANEL::GetForegroundColor(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PCB_BASE_FRAME::LoadSettings(), DIALOG_PAD_PROPERTIES::onChangePadMode(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), DIALOG_NET_INSPECTOR::onDeleteNet(), DIALOG_DRC::OnDRCItemRClick(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), APPEARANCE_CONTROLS::onLayerVisibilityChanged(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorModeChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_NET_INSPECTOR::onRenameNet(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_NET_INSPECTOR::onSortingChanged(), DIALOG_PAD_PROPERTIES::prepareCanvas(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), NET_GRID_TABLE::Rebuild(), APPEARANCE_CONTROLS::rebuildNets(), DIALOG_PAD_PROPERTIES::redraw(), refreshCallback(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), DIALOG_FOOTPRINT_CHECKER::runChecks(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::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_PREVIEW_PANEL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ GetViewControls()

◆ IsDialogPreview()

bool EDA_DRAW_PANEL_GAL::IsDialogPreview ( ) const
inlineinherited

Definition at line 176 of file class_draw_panel_gal.h.

176 { 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(), OnShow(), and PCB_DRAW_PANEL_GAL().

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxMouseEvent &  aEvent)
protectedinherited

Definition at line 503 of file draw_panel_gal.cpp.

504 {
505  bool shouldSetFocus = m_stealsFocus
506  && !KIUI::IsInputControlFocused() // Don't steal from input controls
507  && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
508  && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
509 
510  // Getting focus is necessary in order to receive key events properly
511  if( shouldSetFocus )
512  SetFocus();
513 
514  aEvent.Skip();
515 }
bool IsModalDialogFocused()
Definition: ui_common.cpp:233
bool IsInputControlFocused(wxWindow *aFocus=nullptr)
Checks if a input control has focus.
Definition: ui_common.cpp:176
bool IsWindowActive(wxWindow *aWindow)
Check to see if the given window is the currently active window (e.g.
Definition: gtk/ui.cpp:50
virtual void SetFocus() override
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

References KIUI::IsInputControlFocused(), KIUI::IsModalDialogFocused(), KIPLATFORM::UI::IsWindowActive(), EDA_DRAW_PANEL_GAL::m_edaFrame, 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 484 of file draw_panel_gal.cpp.

485 {
486  bool shouldSetFocus = m_lostFocus && m_stealsFocus
487  && !KIUI::IsInputControlFocused() // Don't steal from input controls
488  && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
489  && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
490 
491  if( shouldSetFocus )
492  SetFocus();
493 
494  if( !m_eventDispatcher )
495  aEvent.Skip();
496  else
498 
499  Refresh();
500 }
bool IsModalDialogFocused()
Definition: ui_common.cpp:233
bool IsInputControlFocused(wxWindow *aFocus=nullptr)
Checks if a input control has focus.
Definition: ui_common.cpp:176
bool IsWindowActive(wxWindow *aWindow)
Check to see if the given window is the currently active window (e.g.
Definition: gtk/ui.cpp:50
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
virtual void SetFocus() override
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...

References TOOL_DISPATCHER::DispatchWxEvent(), KIUI::IsInputControlFocused(), KIUI::IsModalDialogFocused(), KIPLATFORM::UI::IsWindowActive(), EDA_DRAW_PANEL_GAL::m_edaFrame, EDA_DRAW_PANEL_GAL::m_eventDispatcher, EDA_DRAW_PANEL_GAL::m_lostFocus, EDA_DRAW_PANEL_GAL::m_stealsFocus, EDA_DRAW_PANEL_GAL::Refresh(), and EDA_DRAW_PANEL_GAL::SetFocus().

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

◆ onLostFocus()

void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protectedinherited

Definition at line 518 of file draw_panel_gal.cpp.

519 {
520  m_lostFocus = true;
521 
523 
524  aEvent.Skip();
525 }
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.

References KIGFX::WX_VIEW_CONTROLS::CancelDrag(), EDA_DRAW_PANEL_GAL::m_lostFocus, and EDA_DRAW_PANEL_GAL::m_viewControls.

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

169 {
170  DoRePaint();
171 }
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors.

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

529 {
530  if( !m_drawingEnabled )
531  {
532  if( m_gal && m_gal->IsInitialized() )
533  {
534  m_drawing = false;
535  m_pendingRefresh = true;
536  Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr,
537  this );
538  m_drawingEnabled = true;
539  }
540  else
541  {
542  // Try again soon
543  m_refreshTimer.StartOnce( 100 );
544  return;
545  }
546  }
547 
548  DoRePaint();
549 }
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.
bool m_drawing
True if GAL is currently redrawing the view.
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
virtual bool IsInitialized() const
Return the initialization 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, and EDA_DRAW_PANEL_GAL::onPaint().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ OnShow()

void PCB_DRAW_PANEL_GAL::OnShow ( )
overridevirtual

Called when the window is shown for the first time.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 478 of file pcb_draw_panel_gal.cpp.

479 {
480  PCB_BASE_FRAME* frame = nullptr;
481 
482  if( !IsDialogPreview() )
483  frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
484 
485  try
486  {
487  // Check if the current rendering back end can be properly initialized
488  m_view->UpdateItems();
489  }
490  catch( const std::runtime_error& e )
491  {
492  DisplayError( GetParent(), e.what() );
493 
494  // Use the fallback if we have one
495  if( GAL_FALLBACK != m_backend )
496  {
498 
499  if( frame )
500  frame->ActivateGalCanvas();
501  }
502  }
503 
504  if( frame )
505  {
506  SetTopLayer( frame->GetActiveLayer() );
507  KIGFX::PAINTER* painter = m_view->GetPainter();
508  auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
509  settings->LoadDisplayOptions( frame->GetDisplayOptions(), frame->ShowPageLimits() );
510  }
511 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:247
GAL_TYPE m_backend
Currently used GAL.
static constexpr GAL_TYPE GAL_FALLBACK
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:207
bool ShowPageLimits() const
virtual PCB_LAYER_ID GetActiveLayer() const
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition: painter.h:57
virtual void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1397
bool SwitchBackend(GAL_TYPE aGalType) override
Force refresh of the ratsnest visual representation.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
virtual void SetTopLayer(int aLayer) override
SetTopLayer(), with some extra smarts for PCB.
Base 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, SetTopLayer(), EDA_DRAW_FRAME::ShowPageLimits(), SwitchBackend(), and KIGFX::VIEW::UpdateItems().

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 552 of file draw_panel_gal.cpp.

553 {
554  if( m_gal && m_gal->IsVisible() )
555  {
556  m_onShowTimer.Stop();
557  OnShow();
558  }
559 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
virtual void 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
Return 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 272 of file draw_panel_gal.cpp.

273 {
274  // If we get a second wx update call before the first finishes, don't crash
275  if( m_gal->IsContextLocked() )
276  return;
277 
279  wxSize clientSize = GetClientSize();
280  WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
281 
282  if( VECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
283  return;
284 
285  clientSize.x = std::max( 10, clientSize.x );
286  clientSize.y = std::max( 10, clientSize.y );
287 
288  VECTOR2D bottom( 0, 0 );
289 
290  if( m_view )
291  bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
292 
293  m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
294 
295  if( m_view )
296  {
297  if( infobar && infobar->IsLocked() )
298  m_view->SetCenter( bottom - m_view->ToWorld( clientSize, false ) / 2.0 );
299 
302  }
303 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:450
VECTOR2< int > VECTOR2I
Definition: vector2d.h:623
Auxiliary rendering target (noncached)
Definition: definitions.h:49
const VECTOR2I & GetScreenPixelSize() const
Return GAL canvas size in pixels.
bool IsLocked()
Returns true if the infobar is being updated.
Definition: infobar.h:212
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:579
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:572
virtual void ResizeScreen(int aWidth, int aHeight)
Resize the canvas.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:73
Main rendering target (cached)
Definition: definitions.h:48
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
WX_INFOBAR * GetInfoBar()
virtual bool IsContextLocked()
Checks the state of the context lock.

References EDA_BASE_FRAME::GetInfoBar(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), KIGFX::GAL::GetScreenPixelSize(), KIGFX::GAL::IsContextLocked(), WX_INFOBAR::IsLocked(), EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::MarkTargetDirty(), KIGFX::GAL::ResizeScreen(), KIGFX::VIEW::SetCenter(), KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, and KIGFX::VIEW::ToWorld().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ RedrawRatsnest()

void PCB_DRAW_PANEL_GAL::RedrawRatsnest ( )

Return the bounding box of the view that should be used if model is not valid.

For example, the drawing sheet bounding box for an empty PCB

Returns
the default bounding box for the panel.

Definition at line 535 of file pcb_draw_panel_gal.cpp.

536 {
537  if( m_ratsnest )
538  m_view->Update( m_ratsnest.get() );
539 }
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
std::unique_ptr< RATSNEST_VIEW_ITEM > m_ratsnest
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: view.cpp:1503

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

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

◆ Refresh()

void EDA_DRAW_PANEL_GAL::Refresh ( bool  aEraseBackground = true,
const wxRect *  aRect = nullptr 
)
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 306 of file draw_panel_gal.cpp.

307 {
308  wxLongLong t = wxGetLocalTimeMillis();
309  wxLongLong delta = t - m_lastRefresh;
310 
311  // If it has been too long since the last frame (possible depending on platform timer latency),
312  // just do a refresh. Otherwise, start the refresh timer if it hasn't already been started.
313  // This ensures that we will render often enough but not too often.
314  if( delta >= MinRefreshPeriod )
315  {
316  if( !m_pendingRefresh )
317  ForceRefresh();
318 
319  m_refreshTimer.Start( MinRefreshPeriod, true );
320  }
321  else if( !m_refreshTimer.IsRunning() )
322  {
323  m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
324  }
325 }
bool m_pendingRefresh
Is there a redraw event requested?
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
void ForceRefresh()
Force 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 SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_TOOL::BreakWire(), DIALOG_NET_INSPECTOR::buildNetsList(), SCH_BASE_FRAME::CenterScreen(), ZONE_FILLER_TOOL::CheckAllZones(), GERBVIEW_CONTROL::ClearAllLayers(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SCH_EDIT_FRAME::DeleteAnnotation(), PCB_CONTROL::DeleteItemCursor(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_EDIT_TOOL::DoDelete(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), BOARD_INSPECTION_TOOL::doHideNet(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawZone(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SYMBOL_EDITOR_EDIT_TOOL::editGraphicProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), EE_INSPECTION_TOOL::ExcludeMarker(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), ZONE_FILLER_TOOL::FillAllZones(), SCH_EDITOR_CONTROL::FindNext(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), PCB_BASE_FRAME::FocusOnItem(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_VIEWER_TOOLS::GraphicOutlines(), PL_EDITOR_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), 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(), APPEARANCE_CONTROLS::OnLayerContextMenu(), GERBER_LAYER_WIDGET::OnLayerSelect(), APPEARANCE_CONTROLS::onLayerVisibilityChanged(), GERBER_LAYER_WIDGET::OnLayerVisible(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), SCH_EDIT_FRAME::OnModify(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), DIALOG_NET_INSPECTOR::onRenameNet(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), KIGFX::WX_VIEW_CONTROLS::onScroll(), DIALOG_NET_INSPECTOR::onSelChanged(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectActiveLayer(), PL_EDITOR_FRAME::OnSelectCoordOriginCorner(), GERBVIEW_FRAME::OnSelectDisplayMode(), EDA_DRAW_FRAME::OnSelectGrid(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), PL_EDITOR_FRAME::OnSelectPage(), EDA_DRAW_FRAME::OnSelectZoom(), PROPERTIES_FRAME::OnSetDefaultValues(), DIALOG_NET_INSPECTOR::onSortingChanged(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), KIGFX::WX_VIEW_CONTROLS::onWheel(), GERBVIEW_CONTROL::OpenDrillFile(), GERBVIEW_CONTROL::OpenJobFile(), GERBVIEW_CONTROL::OpenZipFile(), PCB_VIEWER_TOOLS::PadDisplayMode(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), PL_EDITOR_FRAME::PrintPage(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_CONTROL::Properties(), SYMBOL_EDIT_FRAME::RebuildView(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), SCH_EDITOR_CONTROL::Redo(), DIALOG_PAD_PROPERTIES::redraw(), DIALOG_ERC::redrawDrawPanel(), SCH_BASE_FRAME::RedrawScreen(), SCH_PREVIEW_PANEL::Refresh(), Refresh(), refreshCallback(), EDA_DRAW_FRAME::RefreshCanvas(), DIALOG_FOOTPRINT_CHECKER::refreshEditor(), DIALOG_DRC::refreshEditor(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), SCH_EDITOR_CONTROL::RemapSymbols(), EDIT_TOOL::Remove(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), GERBVIEW_FRAME::SetActiveLayer(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridVisibility(), APPEARANCE_CONTROLS::SetObjectVisible(), SYMBOL_VIEWER_FRAME::SetSelectedLibrary(), SYMBOL_EDITOR_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(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), PANEL_SYM_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_GAL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), PANEL_GERBVIEW_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::Undo(), GERBVIEW_FRAME::UpdateDisplayOptions(), SCH_EDITOR_CONTROL::UpdateFind(), NET_GRID_TABLE::updateNetColor(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneUnfill(), ZONE_FILLER_TOOL::ZoneUnfillAll(), and DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES().

◆ SetCurrentCursor()

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( KICURSOR  aCursor)
inherited

Set the current cursor shape for this panel.

Definition at line 562 of file draw_panel_gal.cpp.

563 {
564  if( m_gal )
565  m_gal->SetNativeCursorStyle( aCursor );
566 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
virtual bool SetNativeCursorStyle(KICURSOR aCursor)
Set the cursor in the native panel.

References EDA_DRAW_PANEL_GAL::m_gal, and KIGFX::GAL::SetNativeCursorStyle().

Referenced by PCB_CONTROL::DeleteItemCursor(), 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(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PL_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), EE_SELECTION_TOOL::OnIdle(), PCB_SELECTION_TOOL::OnIdle(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), PL_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), DRAWING_TOOL::SetAnchor(), EE_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), EDA_DRAW_PANEL_GAL::SwitchBackend(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ setDefaultLayerDeps()

void PCB_DRAW_PANEL_GAL::setDefaultLayerDeps ( )
protected

Currently used drawing-sheet.

Definition at line 551 of file pcb_draw_panel_gal.cpp.

552 {
553  // caching makes no sense for Cairo and other software renderers
555 
556  for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
557  m_view->SetLayerTarget( i, target );
558 
559  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
560  {
561  LAYER_NUM layer = GAL_LAYER_ORDER[i];
562  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
563 
564  // Set layer display dependencies & targets
565  if( IsCopperLayer( layer ) )
566  {
567  m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
568  m_view->SetRequired( GetNetnameLayer( layer ), layer );
569  }
570  else if( IsNonCopperLayer( layer ) )
571  {
572  m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
573  }
574  else if( IsNetnameLayer( layer ) )
575  {
576  m_view->SetLayerDisplayOnly( layer );
577  }
578  }
579 
582 
583  // Some more required layers settings
586 
587  // Holes can be independent of their host objects (cf: printing drill marks)
593 
594  // Via visibility
598 
599  // Pad visibility
603 
604  // Front footprints
608 
609  // Back footprints
613 
620 
629 
633 }
to draw blind/buried vias
void SetRequired(int aLayerId, int aRequiredId, bool aRequired=true)
Mark the aRequiredId layer as required for the aLayerId layer.
Definition: view.cpp:391
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.
to draw via holes (pad holes do not use this layer)
handle color for not plated holes (holes, not pads)
anchor of items having an anchor point (texts, footprints)
show footprints on back
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:680
const LAYER_NUM GAL_LAYER_ORDER[]
bool IsNonCopperLayer(LAYER_NUM aLayerId)
Test whether a layer is a non copper layer.
Auxiliary rendering target (noncached)
Definition: definitions.h:49
show footprints on front
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Change the rendering target for a particular layer.
Definition: view.h:424
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Definition: view.h:412
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
This can be replaced with int and removed.
layer for drc markers which have been individually excluded
layer for drc markers with SEVERITY_WARNING
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)
Tests whether a layer is a copper layer.
drawingsheet frame and titleblock
layer for drc markers with SEVERITY_ERROR
Additional netnames layers (not associated with a PCB layer)
bool IsNetnameLayer(LAYER_NUM aLayer)
Test 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(), IsNonCopperLayer(), LAYER_ANCHOR, LAYER_DRAWINGSHEET, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_GP_OVERLAY, LAYER_GRID, LAYER_MARKER_SHADOWS, 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_PAD_HOLEWALLS, LAYER_PAD_NETNAMES, LAYER_PAD_PLATEDHOLES, LAYER_PADS, LAYER_PADS_TH, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIA_BBLIND, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_NETNAMES, LAYER_VIA_THROUGH, LAYER_VIAS, 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(), and SwitchBackend().

◆ setDefaultLayerOrder()

void PCB_DRAW_PANEL_GAL::setDefaultLayerOrder ( )
protected

< Reassign layer order to the initial settings.

Set rendering targets & dependencies for layers.

Definition at line 514 of file pcb_draw_panel_gal.cpp.

515 {
516  for( LAYER_NUM i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( LAYER_NUM ); ++i )
517  {
518  LAYER_NUM layer = GAL_LAYER_ORDER[i];
519  wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
520 
521  m_view->SetLayerOrder( layer, i );
522  }
523 }
void SetLayerOrder(int aLayer, int aRenderingOrder)
Set rendering order of a particular layer.
Definition: view.cpp:640
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:680
const LAYER_NUM GAL_LAYER_ORDER[]
int LAYER_NUM
This can be replaced with int and removed.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.

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

Referenced by PCB_DRAW_PANEL_GAL(), and SetTopLayer().

◆ SetDrawingSheet()

void PCB_DRAW_PANEL_GAL::SetDrawingSheet ( DS_PROXY_VIEW_ITEM aDrawingSheet)

Sets (or updates) drawing-sheet used by the draw panel.

Parameters
aDrawingSheetis the drawing-sheet to be used. The object is then owned by PCB_DRAW_PANEL_GAL.

Definition at line 238 of file pcb_draw_panel_gal.cpp.

239 {
240  m_drawingSheet.reset( aDrawingSheet );
241  m_view->Add( m_drawingSheet.get() );
242 }
std::unique_ptr< DS_PROXY_VIEW_ITEM > m_drawingSheet
Ratsnest view item.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:321

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

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems().

◆ SetEventDispatcher()

void EDA_DRAW_PANEL_GAL::SetEventDispatcher ( TOOL_DISPATCHER aEventDispatcher)
inherited

Set a dispatcher that processes events and forwards them to tools.

#DRAW_PANEL_GAL does not take over the ownership. Passing NULL disconnects all event handlers from the #DRAW_PANEL_GAL and parent frame.

Parameters
aEventDispatcheris the object that will be used for dispatching events.

Definition at line 335 of file draw_panel_gal.cpp.

336 {
337  m_eventDispatcher = aEventDispatcher;
338 }
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.

References EDA_DRAW_PANEL_GAL::m_eventDispatcher.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), and SCH_EDIT_FRAME::setupTools().

◆ SetFocus()

void EDA_DRAW_PANEL_GAL::SetFocus ( )
overridevirtualinherited

◆ SetHighContrastLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( int  aLayer)
inlineoverridevirtual

SetHighContrastLayer(), with some extra smarts for PCB.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 70 of file pcb_draw_panel_gal.h.

◆ SetHighContrastLayer() [2/2]

void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( PCB_LAYER_ID  aLayer)

Move the selected layer to the top, so it is displayed above all others.

Definition at line 276 of file pcb_draw_panel_gal.cpp.

277 {
278  // Set display settings for high contrast mode
280 
281  SetTopLayer( aLayer );
282  rSettings->SetActiveLayer( aLayer );
283 
284  rSettings->ClearHighContrastLayers();
285  rSettings->SetLayerIsHighContrast( aLayer );
286 
287  if( IsCopperLayer( aLayer ) )
288  {
289  // Bring some other layers to the front in case of copper layers and make them colored
290  // fixme do not like the idea of storing the list of layers here,
291  // should be done in some other way I guess..
292  LAYER_NUM layers[] = {
295  ZONE_LAYER_FOR( aLayer ),
302  };
303 
304  for( unsigned int i : layers )
305  rSettings->SetLayerIsHighContrast( i );
306 
307  // Pads should be shown too
308  if( aLayer == B_Cu )
309  {
310  rSettings->SetLayerIsHighContrast( LAYER_PAD_BK );
311  rSettings->SetLayerIsHighContrast( LAYER_MOD_BK );
312  }
313  else if( aLayer == F_Cu )
314  {
315  rSettings->SetLayerIsHighContrast( LAYER_PAD_FR );
316  rSettings->SetLayerIsHighContrast( LAYER_MOD_FR );
317  }
318  }
319 
321 }
to draw blind/buried vias
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
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.
to draw via holes (pad holes do not use this layer)
handle color for not plated holes (holes, not pads)
anchor of items having an anchor point (texts, footprints)
show footprints on back
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:207
show footprints on front
to draw usual through hole vias
void SetLayerIsHighContrast(int aLayerId, bool aEnabled=true)
Set the specified layer as high-contrast.
int LAYER_NUM
This 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
Return a 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
void ClearHighContrastLayers()
Clear the list of active layers.
bool IsCopperLayer(LAYER_NUM aLayerId)
Tests whether a layer is a copper layer.
virtual void SetTopLayer(int aLayer) override
SetTopLayer(), with some extra smarts for PCB.
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:773
void SetActiveLayer(PCB_LAYER_ID aLayer)
layer for drc markers with SEVERITY_ERROR
Additional netnames layers (not associated with a PCB layer)

References B_Cu, KIGFX::RENDER_SETTINGS::ClearHighContrastLayers(), F_Cu, GetNetnameLayer(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), IsCopperLayer(), LAYER_ANCHOR, LAYER_CURSOR, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_GP_OVERLAY, LAYER_MARKER_SHADOWS, LAYER_MOD_BK, LAYER_MOD_FR, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK, LAYER_PAD_BK_NETNAMES, LAYER_PAD_FR, LAYER_PAD_FR_NETNAMES, LAYER_PAD_HOLEWALLS, LAYER_PAD_NETNAMES, LAYER_PAD_PLATEDHOLES, LAYER_PADS_TH, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIA_BBLIND, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_NETNAMES, LAYER_VIA_THROUGH, EDA_DRAW_PANEL_GAL::m_view, KIGFX::RENDER_SETTINGS::SetActiveLayer(), KIGFX::RENDER_SETTINGS::SetLayerIsHighContrast(), SetTopLayer(), KIGFX::VIEW::UpdateAllLayersColor(), and ZONE_LAYER_FOR.

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

189 { 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 SYMBOL_VIEWER_FRAME::ClickOnCmpList(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SYMBOL_VIEWER_FRAME::SetSelectedLibrary(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

◆ SetTopLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
inlineoverridevirtual

SetTopLayer(), with some extra smarts for PCB.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 79 of file pcb_draw_panel_gal.h.

Referenced by OnShow(), and SetHighContrastLayer().

◆ SetTopLayer() [2/2]

void PCB_DRAW_PANEL_GAL::SetTopLayer ( PCB_LAYER_ID  aLayer)

Definition at line 324 of file pcb_draw_panel_gal.cpp.

325 {
328  m_view->SetTopLayer( aLayer );
329 
330  // Layers that should always have on-top attribute enabled
331  const std::vector<LAYER_NUM> layers = {
340  };
341 
342  for( auto layer : layers )
343  m_view->SetTopLayer( layer );
344 
345  // Extra layers that are brought to the top if a F.* or B.* is selected
346  const std::vector<LAYER_NUM> frontLayers = {
349  };
350 
351  const std::vector<LAYER_NUM> backLayers = {
354  };
355 
356  const std::vector<LAYER_NUM>* extraLayers = nullptr;
357 
358  // Bring a few more extra layers to the top depending on the selected board side
359  if( IsFrontLayer( aLayer ) )
360  extraLayers = &frontLayers;
361  else if( IsBackLayer( aLayer ) )
362  extraLayers = &backLayers;
363 
364  if( extraLayers )
365  {
366  for( auto layer : *extraLayers )
367  {
368  m_view->SetTopLayer( layer );
369 
370  if( layer < PCB_LAYER_ID_COUNT )
371  m_view->SetTopLayer( ZONE_LAYER_FOR( layer ) );
372  }
373 
374  // Move the active layer to the top of the stack but below all the overlay layers
375  if( !IsCopperLayer( aLayer ) )
376  {
378  m_view->SetLayerOrder( ZONE_LAYER_FOR( aLayer ),
380 
381  // Fix up pad and via netnames to be below. This is hacky, we need a rethink
382  // of layer ordering...
387  }
388  }
389  else if( IsCopperLayer( aLayer ) )
390  {
391  // Display labels for copper layers on the top
392  m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
393  m_view->SetTopLayer( ZONE_LAYER_FOR( aLayer ) );
394  }
395  else
396  {
397  m_view->SetTopLayer( ZONE_LAYER_FOR( aLayer ) );
398  }
399 
400  m_view->EnableTopLayer( true );
402 }
to draw blind/buried vias
void SetLayerOrder(int aLayer, int aRenderingOrder)
Set rendering order of a particular layer.
Definition: view.cpp:640
virtual void SetTopLayer(int aLayer, bool aEnabled=true)
Set given layer to be displayed on the top or sets back the default order of layers.
Definition: view.cpp:837
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.
to draw via holes (pad holes do not use this 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()
< Reassign layer order to the initial settings.
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:904
virtual void EnableTopLayer(bool aEnable)
Enable or disable display of the top layer.
Definition: view.cpp:864
to draw usual through hole vias
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
Definition: view.cpp:889
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
Return rendering order of a particular layer.
Definition: view.cpp:648
currently selected items overlay
bool IsCopperLayer(LAYER_NUM aLayerId)
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, KIGFX::VIEW::GetLayerOrder(), GetNetnameLayer(), IsBackLayer(), IsCopperLayer(), IsFrontLayer(), LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_GP_OVERLAY, LAYER_MARKER_SHADOWS, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK, LAYER_PAD_BK_NETNAMES, LAYER_PAD_FR, LAYER_PAD_FR_NETNAMES, LAYER_PAD_HOLEWALLS, LAYER_PAD_NETNAMES, LAYER_PAD_PLATEDHOLES, LAYER_PADS_TH, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIA_BBLIND, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_NETNAMES, LAYER_VIA_THROUGH, EDA_DRAW_PANEL_GAL::m_view, NETNAMES_LAYER_INDEX, PCB_LAYER_ID_COUNT, setDefaultLayerOrder(), KIGFX::VIEW::SetLayerOrder(), KIGFX::VIEW::SetTopLayer(), KIGFX::VIEW::UpdateAllLayersOrder(), and ZONE_LAYER_FOR.

◆ StartDrawing()

void EDA_DRAW_PANEL_GAL::StartDrawing ( )
inherited

◆ StopDrawing()

void EDA_DRAW_PANEL_GAL::StopDrawing ( )
inherited

Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

Definition at line 348 of file draw_panel_gal.cpp.

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

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

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

◆ SwitchBackend()

bool PCB_DRAW_PANEL_GAL::SwitchBackend ( GAL_TYPE  aGalType)
overridevirtual

Force refresh of the ratsnest visual representation.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 526 of file pcb_draw_panel_gal.cpp.

527 {
528  bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
530  m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
531  return rv;
532 }
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
void setDefaultLayerDeps()
Currently used drawing-sheet.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Switch method of rendering graphics.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.

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

Referenced by OnShow().

◆ SyncLayersVisibility()

void PCB_DRAW_PANEL_GAL::SyncLayersVisibility ( const BOARD aBoard)

Update "visibility" property of each layer of a given BOARD.

Parameters
aBoardcontains layers visibility settings to be applied.

Definition at line 405 of file pcb_draw_panel_gal.cpp.

406 {
407  // Load layer & elements visibility settings
408  for( LAYER_NUM i = 0; i < PCB_LAYER_ID_COUNT; ++i )
409  m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
410 
412  m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
413 
414  // Via layers controlled by dependencies
418 
419  // Pad layers controlled by dependencies
422 
423  // Always enable netname layers, as their visibility is controlled by layer dependencies
425  m_view->SetLayerVisible( i, true );
426 
427  for( LAYER_NUM i = LAYER_ZONE_START; i < LAYER_ZONE_END; i++ )
428  m_view->SetLayerVisible( i, true );
429 
430  // Enable some layers that are GAL specific
439 }
Virtual layers for stacking zones and tracks on a given copper layer.
to draw blind/buried vias
to draw via holes (pad holes do not use this layer)
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
PCB_LAYER_ID
A quick note on layer IDs:
to draw usual through hole vias
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:387
int LAYER_NUM
This can be replaced with int and removed.
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:531
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
Definition: board.cpp:471
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_MARKER_SHADOWS, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PAD_HOLEWALLS, LAYER_PAD_PLATEDHOLES, LAYER_RATSNEST, LAYER_SELECT_OVERLAY, LAYER_VIA_BBLIND, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, 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::FOOTPRINT_PREVIEW_PANEL(), and APPEARANCE_CONTROLS::OnLayerContextMenu().

◆ UpdateColors()

void PCB_DRAW_PANEL_GAL::UpdateColors ( )

Update the color settings in the painter and GAL.

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

Definition at line 245 of file pcb_draw_panel_gal.cpp.

246 {
247  COLOR_SETTINGS* cs = nullptr;
248 
249  PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
250 
251  if( frame )
252  {
253  cs = frame->GetColorSettings();
254  }
255  else
256  {
257  PCBNEW_SETTINGS* app = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
258 
259  if( app )
260  cs = Pgm().GetSettingsManager().GetColorSettings( app->m_ColorTheme );
261  else
262  cs = Pgm().GetSettingsManager().GetColorSettings();
263  }
264 
265  wxCHECK_RET( cs, "null COLOR_SETTINGS" );
266 
267  auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
268  rs->LoadColors( cs );
269 
273 }
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:106
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:207
virtual COLOR_SETTINGS * GetColorSettings() const override
Helper to retrieve the current color settings.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
void SetAxesColor(const COLOR4D &aAxesColor)
Set the axes color.
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual RENDER_SETTINGS * GetSettings()=0
Return a 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
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...
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:184

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

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

Member Data Documentation

◆ GAL_FALLBACK

◆ m_backend

◆ m_debugOverlay

std::shared_ptr<KIGFX::VIEW_OVERLAY> EDA_DRAW_PANEL_GAL::m_debugOverlay
protectedinherited

Optional overlay for drawing transient debug objects.

Definition at line 290 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::ClearDebugOverlay(), and EDA_DRAW_PANEL_GAL::DebugOverlay().

◆ 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 257 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_drawingSheet

std::unique_ptr<DS_PROXY_VIEW_ITEM> PCB_DRAW_PANEL_GAL::m_drawingSheet
protected

Ratsnest view item.

Definition at line 118 of file pcb_draw_panel_gal.h.

Referenced by DisplayBoard(), GetDefaultViewBBox(), GetDrawingSheet(), and SetDrawingSheet().

◆ m_edaFrame

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protectedinherited

Processes and forwards events to tools.

Definition at line 279 of file class_draw_panel_gal.h.

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

◆ m_gal

◆ m_lastRefresh

wxLongLong EDA_DRAW_PANEL_GAL::m_lastRefresh
protectedinherited

Last timestamp when the panel was refreshed.

Definition at line 249 of file class_draw_panel_gal.h.

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

◆ m_lostFocus

bool EDA_DRAW_PANEL_GAL::m_lostFocus
protectedinherited

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

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

Definition at line 283 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_MouseCapturedLost

bool EDA_DRAW_PANEL_GAL::m_MouseCapturedLost
inherited

used on wxMSW: true after a wxEVT_MOUSE_CAPTURE_LOST was received false after the mouse is recaptured.

Used to avoid calling twice a CaptureMouse(), not accepted by wxMSW

Definition at line 234 of file class_draw_panel_gal.h.

Referenced by KIGFX::WX_VIEW_CONTROLS::CaptureCursor(), EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL(), and KIGFX::WX_VIEW_CONTROLS::onCaptureLost().

◆ 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 260 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 276 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<RATSNEST_VIEW_ITEM> PCB_DRAW_PANEL_GAL::m_ratsnest
protected

Definition at line 121 of file pcb_draw_panel_gal.h.

Referenced by DisplayBoard(), and RedrawRatsnest().

◆ m_refreshTimer

wxTimer EDA_DRAW_PANEL_GAL::m_refreshTimer
protectedinherited

◆ m_stealsFocus

bool EDA_DRAW_PANEL_GAL::m_stealsFocus
protectedinherited

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

Definition at line 287 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 266 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::ClearDebugOverlay(), EDA_DRAW_PANEL_GAL::DebugOverlay(), DisplayBoard(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), EDA_DRAW_PANEL_GAL::DoRePaint(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GERBVIEW_DRAW_PANEL_GAL::GetDefaultViewBBox(), GetDefaultViewBBox(), SCH_DRAW_PANEL::GetView(), GetView(), EDA_DRAW_PANEL_GAL::GetView(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), SCH_DRAW_PANEL::OnShow(), OnShow(), EDA_DRAW_PANEL_GAL::onSize(), PCB_DRAW_PANEL_GAL(), PL_DRAW_PANEL_GAL::PL_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(), setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerOrder(), SCH_PREVIEW_PANEL::setDefaultLayerOrder(), setDefaultLayerOrder(), SetDrawingSheet(), GERBVIEW_DRAW_PANEL_GAL::SetDrawingSheet(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), SetHighContrastLayer(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), SetTopLayer(), EDA_DRAW_PANEL_GAL::SetTopLayer(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), EDA_DRAW_PANEL_GAL::SwitchBackend(), SyncLayersVisibility(), UpdateColors(), SCH_PREVIEW_PANEL::view(), and EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL().

◆ m_viewControls

◆ MinRefreshPeriod

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotectedinherited

60 FPS.

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