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, PROGRESS_REPORTER *aReporter=nullptr)
 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...
 
void SetFocus () override
 
bool StatusPopupHasFocus ()
 
void SetStatusPopup (wxWindow *aPopup)
 
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...
 
std::unique_ptr< PROF_COUNTERm_PaintEventCounter
 

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...
 
int m_minRefreshPeriod
 A minimum delay before another draw can start. 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...
 
std::mutex m_refreshMutex
 Blocks multiple calls to the draw. 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...
 
wxWindow * m_statusPopup
 
std::shared_ptr< KIGFX::VIEW_OVERLAYm_debugOverlay
 Optional overlay for drawing transient debug objects. More...
 

Detailed Description

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

62 {
63 GAL_TYPE_UNKNOWN = -1,
64 GAL_TYPE_NONE = 0,
68 };
@ GAL_TYPE_LAST
Sentinel, do not use as a parameter.
@ GAL_TYPE_UNKNOWN
not specified: a GAL engine must be set by the client
@ GAL_TYPE_OPENGL
OpenGL implementation.
@ GAL_TYPE_CAIRO
Cairo implementation.
@ GAL_TYPE_NONE
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 207 of file pcb_draw_panel_gal.cpp.

209 :
210 EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
211{
212 m_view = new KIGFX::PCB_VIEW( true );
213 m_view->SetGAL( m_gal );
214
216
217 if( EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( aParentWindow ) )
218 frameType = frame->GetFrameType();
219
220 m_painter = std::make_unique<KIGFX::PCB_PAINTER>( m_gal, frameType );
221 m_view->SetPainter( m_painter.get() );
222
223 // This fixes the zoom in and zoom out limits:
225
228
229 // View controls is the first in the event handler chain, so the Tool Framework operates
230 // on updated viewport data.
232
233 // Load display options (such as filled/outline display of items).
234 // Can be made only if the parent window is an EDA_DRAW_FRAME (or a derived class)
235 // which is not always the case (namely when it is used from a wxDialog like the pad editor)
236 if( !IsDialogPreview() )
237 {
238 KIGFX::PCB_VIEW* view = static_cast<KIGFX::PCB_VIEW*>( m_view );
239 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
240
241 if( frame )
242 view->UpdateDisplayOptions( frame->GetDisplayOptions() );
243 }
244}
The base frame for deriving all KiCad main window classes.
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
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.
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
void UpdateDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions)
Definition: pcb_view.cpp:125
void SetPainter(PAINTER *aPainter)
Set the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:203
void SetGAL(GAL *aGal)
Assign a rendering device for the VIEW.
Definition: view.cpp:492
void SetScaleLimits(double aMaximum, double aMinimum)
Set minimum and maximum values for scale.
Definition: view.h:309
An implementation of class VIEW_CONTROLS for wxWidgets library.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
void setDefaultLayerDeps()
Currently used drawing-sheet.
void setDefaultLayerOrder()
< Reassign layer order to the initial settings.
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:33
@ FRAME_FOOTPRINT_PREVIEW
Definition: frame_type.h:46
#define ZOOM_MAX_LIMIT_PCBNEW
Definition: zoom_defines.h:62
#define ZOOM_MIN_LIMIT_PCBNEW
Definition: zoom_defines.h:63

References FRAME_FOOTPRINT_PREVIEW, 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 247 of file pcb_draw_panel_gal.cpp.

248{
249}

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

658{
659 if( m_debugOverlay )
660 {
661 m_view->Remove( m_debugOverlay.get() );
662 m_debugOverlay = nullptr;
663 }
664}
std::shared_ptr< KIGFX::VIEW_OVERLAY > m_debugOverlay
Optional overlay for drawing transient debug objects.
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
Definition: view.cpp:349

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

646{
647 if( !m_debugOverlay )
648 {
649 m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
650 m_view->Add( m_debugOverlay.get() );
651 }
652
653 return m_debugOverlay;
654}
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:316

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,
PROGRESS_REPORTER aReporter = nullptr 
)

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

253{
254 m_view->Clear();
255
256 aBoard->CacheTriangulation( aReporter );
257
258 if( m_drawingSheet )
259 m_drawingSheet->SetFileName( TO_UTF8( aBoard->GetFileName() ) );
260
261 // Load drawings
262 for( BOARD_ITEM* drawing : aBoard->Drawings() )
263 m_view->Add( drawing );
264
265 // Load tracks
266 for( PCB_TRACK* track : aBoard->Tracks() )
267 m_view->Add( track );
268
269 // Load footprints and its additional elements
270 for( FOOTPRINT* footprint : aBoard->Footprints() )
271 m_view->Add( footprint );
272
273 // DRC markers
274 for( PCB_MARKER* marker : aBoard->Markers() )
275 m_view->Add( marker );
276
277 // Load zones
278 for( ZONE* zone : aBoard->Zones() )
279 m_view->Add( zone );
280
281 // Ratsnest
282 m_ratsnest = std::make_unique<RATSNEST_VIEW_ITEM>( aBoard->GetConnectivity() );
283 m_view->Add( m_ratsnest.get() );
284}
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:58
ZONES & Zones()
Definition: board.h:313
FOOTPRINTS & Footprints()
Definition: board.h:307
TRACKS & Tracks()
Definition: board.h:304
MARKERS & Markers()
Definition: board.h:316
const wxString & GetFileName() const
Definition: board.h:302
DRAWINGS & Drawings()
Definition: board.h:310
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:424
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
Definition: board.cpp:700
void Clear()
Remove all items from the view.
Definition: view.cpp:1099
std::unique_ptr< RATSNEST_VIEW_ITEM > m_ratsnest
std::unique_ptr< DS_PROXY_VIEW_ITEM > m_drawingSheet
Ratsnest view item.
Handle a list of polygons defining a copper zone.
Definition: zone.h:57
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96

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

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), PCB_EDIT_FRAME::RebuildAndRefresh(), PCB_BASE_EDIT_FRAME::SetBoard(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::UpdateView(), FOOTPRINT_VIEWER_FRAME::updateView(), and FOOTPRINT_WIZARD_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 193 of file draw_panel_gal.cpp.

194{
195 if( !m_refreshMutex.try_lock() )
196 return;
197
198 std::lock_guard<std::mutex> lock( m_refreshMutex, std::adopt_lock );
199
200 // Repaint the canvas, and fix scrollbar cursors
201 // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
202 // it can be called outside a wxPaintEvent.
203
204 // Update current zoom settings if the canvas is managed by a EDA frame
205 // (i.e. not by a preview panel in a dialog)
206 if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
208
209 if( Pgm().GetCommonSettings()->m_Appearance.show_scrollbars )
211
212 if( !m_drawingEnabled )
213 return;
214
215 if( !m_gal->IsVisible() )
216 return;
217
218 m_pendingRefresh = false;
219
220 if( m_drawing )
221 return;
222
223 SCOPED_SET_RESET<bool> drawing( m_drawing, true );
224
225 ( *m_PaintEventCounter )++;
226
227 wxASSERT( m_painter );
228
229 KIGFX::RENDER_SETTINGS* settings =
230 static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
231
232 PROF_TIMER cntUpd("view-upd-items");
233 PROF_TIMER cntTotal("view-total");
234 PROF_TIMER cntCtx("view-context-create");
235 PROF_TIMER cntCtxDestroy("view-context-destroy");
236 PROF_TIMER cntRedraw("view-redraw-rects");
237
238 bool isDirty = false;
239
240 cntTotal.Start();
241 try
242 {
243 cntUpd.Start();
244
245 try
246 {
248 }
249 catch( std::out_of_range& err )
250 {
251 // Don't do anything here but don't fail
252 // This can happen when we don't catch `at()` calls
253 wxString msg;
254 msg.Printf( wxT( "Out of Range error: %s" ), err.what() );
255 wxLogDebug( msg );
256 }
257
258 cntUpd.Stop();
259
260 // GAL_DRAWING_CONTEXT can throw in the dtor, so we need to scope
261 // the full lifetime inside the try block
262 {
263 cntCtx.Start();
265 cntCtx.Stop();
266
269 {
270 m_view->MarkDirty();
271 }
272
273 m_gal->SetClearColor( settings->GetBackgroundColor() );
274 m_gal->SetGridColor( settings->GetGridColor() );
275 m_gal->SetCursorColor( settings->GetCursorColor() );
276
277 // TODO: find why ClearScreen() must be called here in opengl mode
278 // and only if m_view->IsDirty() in Cairo mode to avoid display artifacts
279 // when moving the mouse cursor
282
283 if( m_view->IsDirty() )
284 {
285 if( m_backend != GAL_TYPE_OPENGL // Already called in opengl
287 {
289 }
290
292
293 // Grid has to be redrawn only when the NONCACHED target is redrawn
295 m_gal->DrawGrid();
296
297 cntRedraw.Start();
298 m_view->Redraw();
299 cntRedraw.Stop();
300 isDirty = true;
301 }
302
304
305 cntCtxDestroy.Start();
306 }
307
308 // ctx goes out of scope here so destructor would be called
309 cntCtxDestroy.Stop();
310 }
311 catch( std::exception& err )
312 {
313 if( GAL_FALLBACK != m_backend )
314 {
316
318 _( "Could not use OpenGL, falling back to software rendering" ),
319 wxString( err.what() ) );
320 }
321 else
322 {
323 // We're well and truly banjaxed if we get here without a fallback.
324 DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
325 }
326 }
327
328 if( isDirty )
329 {
330 KI_TRACE( traceGalProfile, "View timing: %s %s %s %s %s\n",
331 cntTotal.to_string(),
332 cntUpd.to_string(),
333 cntRedraw.to_string(),
334 cntCtx.to_string(),
335 cntCtxDestroy.to_string()
336 );
337 }
338
339 m_lastRefresh = wxGetLocalTimeMillis();
340}
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:100
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
static constexpr GAL_TYPE GAL_FALLBACK
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
bool m_drawing
True if GAL is currently redrawing the view.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
bool m_pendingRefresh
Is there a redraw event requested?
wxWindow * m_parent
Pointer to the parent window.
std::mutex m_refreshMutex
Blocks multiple calls to the draw.
virtual bool SwitchBackend(GAL_TYPE aGalType)
Switch method of rendering graphics.
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
GAL_TYPE m_backend
Currently used GAL.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
virtual bool HasTarget(RENDER_TARGET aTarget)
Return true if the target exists.
void SetCursorColor(const COLOR4D &aCursorColor)
Set the cursor color.
virtual void DrawGrid()
virtual void ClearScreen()
Clear the screen.
void SetClearColor(const COLOR4D &aColor)
virtual void DrawCursor(const VECTOR2D &aCursorPosition)
Draw the cursor.
virtual bool IsVisible() const
Return true if the GAL canvas is visible on the screen.
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
virtual const COLOR4D & GetGridColor()=0
Return current grid color settings.
virtual const COLOR4D & GetBackgroundColor() const =0
Return current background color settings.
virtual const COLOR4D & GetCursorColor()=0
Return current cursor color settings.
const VECTOR2D & GetCenter() const
Return the center point of this VIEW (in world space coordinates).
Definition: view.h:339
void ClearTargets()
Clear targets that are marked as dirty.
Definition: view.cpp:1114
virtual void Redraw()
Immediately redraws the whole view.
Definition: view.cpp:1133
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:606
void UpdateItems()
Iterate through the list of items that asked for updating and updates them.
Definition: view.cpp:1401
bool IsDirty() const
Return true if any of the VIEW layers needs to be refreshened.
Definition: view.h:589
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:641
VECTOR2D GetCursorPosition(bool aSnappingEnabled) const override
<
void UpdateScrollbars()
End any mouse drag action still in progress.
A small class to help profiling.
Definition: profile.h:47
RAII class that sets an value at construction and resets it to the original value at destruction.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:352
#define _(s)
const wxChar *const traceGalProfile
Flag to enable debug output of GAL performance profiling.
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition: definitions.h:49
@ TARGET_OVERLAY
Items that may change while the view stays the same (noncached)
Definition: definitions.h:50
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111
#define KI_TRACE(aWhat,...)

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(), KI_TRACE, EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_drawing, EDA_DRAW_PANEL_GAL::m_drawingEnabled, EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_lastRefresh, EDA_DRAW_PANEL_GAL::m_painter, EDA_DRAW_PANEL_GAL::m_parent, EDA_DRAW_PANEL_GAL::m_pendingRefresh, EDA_DRAW_PANEL_GAL::m_refreshMutex, BASE_SCREEN::m_ScrollCenter, EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::m_viewControls, KIGFX::VIEW::MarkDirty(), Pgm(), KIGFX::VIEW::Redraw(), KIGFX::GAL::SetClearColor(), KIGFX::GAL::SetCursorColor(), KIGFX::GAL::SetGridColor(), PROF_TIMER::Start(), PROF_TIMER::Stop(), EDA_DRAW_PANEL_GAL::SwitchBackend(), KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, PROF_TIMER::to_string(), 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()

void EDA_DRAW_PANEL_GAL::ForceRefresh ( )
inherited

Force a redraw.

Definition at line 399 of file draw_panel_gal.cpp.

400{
401 m_pendingRefresh = true;
402 DoRePaint();
403}
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors.

References EDA_DRAW_PANEL_GAL::DoRePaint(), and EDA_DRAW_PANEL_GAL::m_pendingRefresh.

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), PCB_SELECTION_TOOL::doSyncSelection(), PAD_TOOL::EditPad(), PCB_SELECTION_TOOL::FindItem(), PCB_CONTROL::FlipPcbView(), SCH_BASE_FRAME::HardRedraw(), SCH_EDIT_FRAME::HardRedraw(), FOOTPRINT_EDIT_FRAME::HardRedraw(), SYMBOL_PREVIEW_WIDGET::onSize(), EDA_DRAW_PANEL_GAL::Refresh(), PCB_SELECTION_TOOL::RequestSelection(), FOOTPRINT_EDITOR_CONTROL::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), PCB_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), NL_SCHEMATIC_PLUGIN_IMPL::SetTransaction(), NL_PCBNEW_PLUGIN_IMPL::SetTransaction(), COMMON_TOOLS::ToggleBoundingBoxes(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().

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

605{
607 return m_drawingSheet->ViewBBox();
608
609 return BOX2I();
610}
BOX2< VECTOR2I > BOX2I
Definition: box2.h:847
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:410
@ LAYER_DRAWINGSHEET
drawingsheet frame and titleblock
Definition: layer_ids.h:217

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 62 of file pcb_draw_panel_gal.h.

62{ return m_drawingSheet.get(); }

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

120{ return m_gal; }

References EDA_DRAW_PANEL_GAL::m_gal.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), SCH_BASE_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), PANEL_EESCHEMA_COLOR_SETTINGS::createSwatches(), PANEL_PCBNEW_COLOR_SETTINGS::createSwatches(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), GERBVIEW_FRAME::DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), NL_SCHEMATIC_PLUGIN_IMPL::GetModelExtents(), NL_PCBNEW_PLUGIN_IMPL::GetModelExtents(), EDA_DRAW_FRAME::GetNearestGridPosition(), EDA_DRAW_FRAME::GetNearestHalfGridPosition(), NL_SCHEMATIC_PLUGIN_IMPL::GetViewExtents(), NL_PCBNEW_PLUGIN_IMPL::GetViewExtents(), EDA_DRAW_FRAME::GetZoomLevelIndicator(), EDA_DRAW_FRAME::OnMove(), GERBER_LAYER_WIDGET::OnRenderEnable(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), PCB_EDIT_FRAME::RebuildAndRefresh(), PCB_BASE_EDIT_FRAME::SetBoard(), GERBVIEW_FRAME::SetGridColor(), PCB_EDIT_FRAME::SetGridColor(), EDA_DRAW_FRAME::SetGridVisibility(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), PL_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_EESCHEMA_COLOR_SETTINGS::updatePreview(), PANEL_PCBNEW_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 495 of file pcb_draw_panel_gal.cpp.

497{
498 BOARD* board = static_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() )->GetBoard();
499 int padCount = 0;
500 int viaCount = 0;
501 int trackSegmentCount = 0;
502 std::set<int> netCodes;
503 int unconnected = board->GetConnectivity()->GetUnconnectedCount( true );
504
505 for( PCB_TRACK* item : board->Tracks() )
506 {
507 if( item->Type() == PCB_VIA_T )
508 viaCount++;
509 else
510 trackSegmentCount++;
511
512 if( item->GetNetCode() > 0 )
513 netCodes.insert( item->GetNetCode() );
514 }
515
516 for( FOOTPRINT* footprint : board->Footprints() )
517 {
518 for( PAD* pad : footprint->Pads() )
519 {
520 padCount++;
521
522 if( pad->GetNetCode() > 0 )
523 netCodes.insert( pad->GetNetCode() );
524 }
525 }
526
527 aList.emplace_back( _( "Pads" ), wxString::Format( wxT( "%d" ), padCount ) );
528 aList.emplace_back( _( "Vias" ), wxString::Format( wxT( "%d" ), viaCount ) );
529 aList.emplace_back( _( "Track Segments" ), wxString::Format( wxT( "%d" ), trackSegmentCount ) );
530 aList.emplace_back( _( "Nets" ), wxString::Format( wxT( "%d" ), (int) netCodes.size() ) );
531 aList.emplace_back( _( "Unrouted" ), wxString::Format( wxT( "%d" ), unconnected ) );
532}
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:265
Definition: pad.h:59
BOARD * GetBoard()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:102

References _, BOARD::Footprints(), Format(), GetBoard(), BOARD::GetConnectivity(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), pad, 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 705 of file pcb_draw_panel_gal.cpp.

706{
707 return static_cast<KIGFX::PCB_VIEW*>( m_view );
708}

References EDA_DRAW_PANEL_GAL::m_view.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), DIALOG_NET_INSPECTOR::buildNetsList(), PCB_BASE_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), DIALOG_PRINT_PCBNEW::createPrintout(), APPEARANCE_CONTROLS::doApplyViewport(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EditPad(), EVT_GRID_CMD_CELL_CHANGED(), DIALOG_DRC::ExcludeMarker(), PCB_SELECTION_TOOL::FindItem(), PCB_BASE_FRAME::FocusOnItems(), FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor(), FOOTPRINT_PREVIEW_PANEL::GetForegroundColor(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), PCB_BASE_FRAME::HideSolderMask(), PCB_EDIT_FRAME::ImportSpecctraSession(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_BASE_FRAME::LoadSettings(), NL_PCBNEW_PLUGIN_IMPL::NL_PCBNEW_PLUGIN_IMPL(), PCB_EDIT_FRAME::onBoardLoaded(), DIALOG_PAD_PROPERTIES::onChangePadMode(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), DIALOG_NET_INSPECTOR::onDeleteNet(), DIALOG_DRC::OnDRCItemRClick(), APPEARANCE_CONTROLS::onLayerVisibilityToggled(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorMode(), PCB_EDIT_FRAME::OnNetlistChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_NET_INSPECTOR::onRenameNet(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_NET_INSPECTOR::onSortingChanged(), APPEARANCE_CONTROLS::onViewportChanged(), BOARD_EDITOR_CONTROL::PageSettings(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), NET_GRID_TABLE::Rebuild(), PCB_EDIT_FRAME::RebuildAndRefresh(), APPEARANCE_CONTROLS::rebuildNets(), DIALOG_PAD_PROPERTIES::redraw(), PCB_EDIT_FRAME::redrawNetnames(), ZONE_FILLER_TOOL::refresh(), refreshCallback(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), PCB_EDIT_FRAME::ResolveDRCExclusions(), DIALOG_FOOTPRINT_CHECKER::runChecks(), PCB_EDIT_FRAME::SaveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), NETS_SEARCH_HANDLER::SelectItems(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetBoard(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_EDIT_FRAME::SetElementVisibility(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_BASE_EDIT_FRAME::ShowBitmapPropertiesDialog(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_BASE_FRAME::ShowSolderMask(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), NET_GRID_TABLE::updateNetColor(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), PCB_EDIT_FRAME::UpdateUserInterface(), PCB_BASE_FRAME::UpdateUserUnits(), 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

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxMouseEvent &  aEvent)
protectedinherited

Definition at line 580 of file draw_panel_gal.cpp.

581{
582 bool shouldSetFocus = m_stealsFocus
583 && !KIUI::IsInputControlFocused() // Don't steal from input controls
584 && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
585 && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
586
587 // Getting focus is necessary in order to receive key events properly
588 if( shouldSetFocus )
589 SetFocus();
590
591 aEvent.Skip();
592}
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...
void SetFocus() override
bool IsWindowActive(wxWindow *aWindow)
Check to see if the given window is the currently active window (e.g.
Definition: gtk/ui.cpp:50
bool IsInputControlFocused(wxWindow *aFocus=nullptr)
Check if a input control has focus.
Definition: ui_common.cpp:265
bool IsModalDialogFocused()
Definition: ui_common.cpp:315

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

562{
563 bool shouldSetFocus = m_lostFocus && m_stealsFocus
564 && !KIUI::IsInputControlFocused() // Don't steal from input controls
565 && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
566 && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
567
568 if( shouldSetFocus )
569 SetFocus();
570
571 if( !m_eventDispatcher )
572 aEvent.Skip();
573 else
575
576 Refresh();
577}
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
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...
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.

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

◆ onPaint()

void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protectedvirtualinherited

◆ onRefreshTimer()

void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 605 of file draw_panel_gal.cpp.

606{
607 if( !m_drawingEnabled )
608 {
609 if( m_gal && m_gal->IsInitialized() )
610 {
611 m_pendingRefresh = true;
612 Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr,
613 this );
614 m_drawingEnabled = true;
615 }
616 else
617 {
618 // Try again soon
619 m_refreshTimer.StartOnce( 100 );
620 return;
621 }
622 }
623
624 DoRePaint();
625}
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
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_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 535 of file pcb_draw_panel_gal.cpp.

536{
537 PCB_BASE_FRAME* frame = nullptr;
538
539 if( !IsDialogPreview() )
540 frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
541
542 try
543 {
544 // Check if the current rendering back end can be properly initialized
546 }
547 catch( const std::runtime_error& e )
548 {
549 DisplayError( GetParent(), e.what() );
550
551 // Use the fallback if we have one
552 if( GAL_FALLBACK != m_backend )
553 {
555
556 if( frame )
557 frame->ActivateGalCanvas();
558 }
559 }
560
561 if( frame )
562 {
563 SetTopLayer( frame->GetActiveLayer() );
564 KIGFX::PAINTER* painter = m_view->GetPainter();
565 auto settings = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( painter->GetSettings() );
566 settings->LoadDisplayOptions( frame->GetDisplayOptions() );
567 }
568}
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition: painter.h:58
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
PCB specific render settings.
Definition: pcb_painter.h:72
void LoadDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions)
Load settings related to display options (high-contrast mode, full or outline modes for vias/pads/tra...
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:213
virtual PCB_LAYER_ID GetActiveLayer() const
virtual void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
virtual void SetTopLayer(int aLayer) override
SetTopLayer(), with some extra smarts for PCB.
bool SwitchBackend(GAL_TYPE aGalType) override
Force refresh of the ratsnest visual representation.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:300

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(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::IsDialogPreview(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_view, SetTopLayer(), SwitchBackend(), and KIGFX::VIEW::UpdateItems().

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protectedinherited

Definition at line 628 of file draw_panel_gal.cpp.

629{
630 if( m_gal && m_gal->IsVisible() )
631 {
632 m_onShowTimer.Stop();
633 OnShow();
634 }
635}
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.

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

344{
345 // If we get a second wx update call before the first finishes, don't crash
346 if( m_gal->IsContextLocked() )
347 return;
348
350 wxSize clientSize = GetClientSize();
351 WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
352
353 if( VECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
354 return;
355
356 clientSize.x = std::max( 10, clientSize.x );
357 clientSize.y = std::max( 10, clientSize.y );
358
359 VECTOR2D bottom( 0, 0 );
360
361 if( m_view )
362 bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
363
364 m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
365
366 if( m_view )
367 {
368 if( infobar && infobar->IsLocked() )
369 m_view->SetCenter( bottom - m_view->ToWorld( clientSize, false ) / 2.0 );
370
373 }
374}
WX_INFOBAR * GetInfoBar()
virtual void ResizeScreen(int aWidth, int aHeight)
Resize the canvas.
virtual bool IsContextLocked()
Checks the state of the context lock.
const VECTOR2I & GetScreenPixelSize() const
Return GAL canvas size in pixels.
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:448
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:577
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:617
A modified version of the wxInfoBar class that allows us to:
Definition: wx_infobar.h:75
bool IsLocked()
Returns true if the infobar is being updated.
Definition: wx_infobar.h:212
@ TARGET_CACHED
Main rendering target (cached)
Definition: definitions.h:48
VECTOR2< int > VECTOR2I
Definition: vector2d.h:618

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

598{
599 if( m_ratsnest )
600 m_view->Update( m_ratsnest.get() );
601}
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:1591

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

Referenced by BOARD_INSPECTION_TOOL::doHideRatsnestNet(), DIALOG_DRC::OnDRCItemRClick(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_EDIT_FRAME::OnRemoveTeardropTool(), BOARD_COMMIT::Push(), PCB_CONTROL::RatsnestModeCycle(), PCB_BASE_FRAME::rebuildConnectivity(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), 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 377 of file draw_panel_gal.cpp.

378{
379 wxLongLong t = wxGetLocalTimeMillis();
380 wxLongLong delta = t - m_lastRefresh;
381
382 // If it has been too long since the last frame (possible depending on platform timer latency),
383 // just do a refresh. Otherwise, start the refresh timer if it hasn't already been started.
384 // This ensures that we will render often enough but not too often.
386 {
387 if( !m_pendingRefresh )
388 ForceRefresh();
389
390 m_refreshTimer.Start( m_minRefreshPeriod, true );
391 }
392 else if( !m_refreshTimer.IsRunning() )
393 {
394 m_refreshTimer.Start( ( m_minRefreshPeriod - delta ).ToLong(), true );
395 }
396}
int m_minRefreshPeriod
A minimum delay before another draw can start.
void ForceRefresh()
Force a redraw.
constexpr int delta

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

Referenced by PCB_EDIT_FRAME::ActivateGalCanvas(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_TOOL::BreakWire(), DIALOG_NET_INSPECTOR::buildNetsList(), GERBVIEW_CONTROL::ClearAllLayers(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SCH_EDIT_FRAME::DeleteAnnotation(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::DeleteItems(), GERBVIEW_CONTROL::DisplayControl(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), APPEARANCE_CONTROLS::doApplyLayerPreset(), APPEARANCE_CONTROLS::doApplyViewport(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_EDIT_TOOL::DoDelete(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), EE_INSPECTION_TOOL::ExcludeMarker(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), PCB_BASE_FRAME::FocusOnItems(), 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(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), GERBVIEW_CONTROL::LoadZipfile(), 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(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), EDA_DRAW_PANEL_GAL::OnEvent(), EDA_DRAW_FRAME::OnGridSettings(), GERBER_LAYER_WIDGET::OnLayerColorChange(), APPEARANCE_CONTROLS::OnLayerContextMenu(), GERBER_LAYER_WIDGET::OnLayerSelect(), APPEARANCE_CONTROLS::onLayerVisibilityToggled(), GERBER_LAYER_WIDGET::OnLayerVisible(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), SCH_EDIT_FRAME::OnModify(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), PCB_EDIT_FRAME::OnRemoveTeardropTool(), 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::OpenJobFile(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), GERBVIEW_CONTROL::OpenZipFile(), PCB_VIEWER_TOOLS::PadDisplayMode(), SCH_EDITOR_CONTROL::PageSetup(), ROUTER_TOOL::performRouting(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::prepareInteractive(), PL_EDITOR_FRAME::PrintPage(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_CONTROL::Properties(), PCB_CONTROL::RatsnestModeCycle(), PCB_EDIT_FRAME::RebuildAndRefresh(), 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(), PCB_EDIT_FRAME::redrawNetnames(), SCH_BASE_FRAME::RedrawScreen(), ZONE_FILLER_TOOL::refresh(), SCH_PREVIEW_PANEL::Refresh(), refreshCallback(), EDA_DRAW_FRAME::RefreshCanvas(), DIALOG_DRC::refreshEditor(), DIALOG_FOOTPRINT_CHECKER::refreshEditor(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), GERBVIEW_FRAME::RemapLayers(), SCH_EDITOR_CONTROL::RemapSymbols(), EDIT_TOOL::Remove(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDITOR_CONTROL::rescueProject(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), PCB_BASE_EDIT_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), FOOTPRINT_SEARCH_HANDLER::SelectItems(), ZONE_SEARCH_HANDLER::SelectItems(), TEXT_SEARCH_HANDLER::SelectItems(), NETS_SEARCH_HANDLER::SelectItems(), FOOTPRINT_EDIT_FRAME::SelectLayer(), GERBVIEW_FRAME::SetActiveLayer(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_BASE_FRAME::SetDisplayOptions(), EDA_DRAW_FRAME::SetGridVisibility(), APPEARANCE_CONTROLS::SetObjectVisible(), SYMBOL_VIEWER_FRAME::SetSelectedLibrary(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_VIEWER_TOOLS::ShowPadNumbers(), SYMBOL_EDITOR_CONTROL::ShowPinNumbers(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), 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::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LINE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::Undo(), SCH_FIND_REPLACE_TOOL::UpdateFind(), NET_GRID_TABLE::updateNetColor(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), 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 638 of file draw_panel_gal.cpp.

639{
640 if( m_gal )
641 m_gal->SetNativeCursorStyle( aCursor );
642}
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(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::finishInteractive(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_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::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), ROUTER_TOOL::RouteSelected(), EE_SELECTION_TOOL::selectMultiple(), PL_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(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ setDefaultLayerDeps()

void PCB_DRAW_PANEL_GAL::setDefaultLayerDeps ( )
protected

Currently used drawing-sheet.

Definition at line 613 of file pcb_draw_panel_gal.cpp.

614{
615 // caching makes no sense for Cairo and other software renderers
617
618 for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
619 m_view->SetLayerTarget( i, target );
620
621 for( int i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( int ); ++i )
622 {
623 int layer = GAL_LAYER_ORDER[i];
624 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
625
626 // Set layer display dependencies & targets
627 if( IsCopperLayer( layer ) )
628 {
629 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
630 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
632 m_view->SetRequired( GetNetnameLayer( layer ), layer );
633 }
634 else if( IsNonCopperLayer( layer ) )
635 {
636 m_view->SetRequired( ZONE_LAYER_FOR( layer ), layer );
638 m_view->SetRequired( BITMAP_LAYER_FOR( layer ), layer );
639 }
640 else if( IsNetnameLayer( layer ) )
641 {
642 m_view->SetLayerDisplayOnly( layer );
643 }
644 }
645
648
650
653
654 // Some more required layers settings
657
658 // Holes can be independent of their host objects (cf: printing drill marks)
664
665 // Via visibility
669
670 // Pad visibility
674
675 // Front footprints
678
679 // Back footprints
682
689
698
702}
void SetRequired(int aLayerId, int aRequiredId, bool aRequired=true)
Mark the aRequiredId layer as required for the aLayerId layer.
Definition: view.cpp:389
void SetLayerDisplayOnly(int aLayer, bool aDisplayOnly=true)
Set a layer display-only (ie: to be rendered but not returned by hit test queries).
Definition: view.h:457
void SetLayerTarget(int aLayer, RENDER_TARGET aTarget)
Change the rendering target for a particular layer.
Definition: view.h:469
static constexpr int VIEW_MAX_LAYERS
Rendering order modifier for layers that are marked as top layers.
Definition: view.h:727
@ LAYER_PAD_FR_NETNAMES
Additional netnames layers (not associated with a PCB layer)
Definition: layer_ids.h:165
@ LAYER_PAD_BK_NETNAMES
Definition: layer_ids.h:166
@ LAYER_PAD_NETNAMES
Definition: layer_ids.h:167
@ LAYER_VIA_NETNAMES
Definition: layer_ids.h:168
#define BITMAP_LAYER_FOR(boardLayer)
Macros for getting the extra layers for a given board layer.
Definition: layer_ids.h:267
bool IsNonCopperLayer(int aLayerId)
Test whether a layer is a non copper layer.
Definition: layer_ids.h:836
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
Definition: layer_ids.h:966
bool IsCopperLayer(int aLayerId)
Tests whether a layer is a copper layer.
Definition: layer_ids.h:825
@ LAYER_GRID
Definition: layer_ids.h:205
@ LAYER_LOCKED_ITEM_SHADOW
shadow layer for locked items
Definition: layer_ids.h:239
@ LAYER_VIA_HOLEWALLS
Definition: layer_ids.h:234
@ LAYER_CONFLICTS_SHADOW
shadow layer for items flagged conficting
Definition: layer_ids.h:241
@ LAYER_NON_PLATEDHOLES
handle color for not plated holes (holes, not pads)
Definition: layer_ids.h:197
@ LAYER_PAD_FR
smd pads, front layer
Definition: layer_ids.h:202
@ LAYER_DRC_EXCLUSION
layer for drc markers which have been individually excluded
Definition: layer_ids.h:236
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored)
Definition: layer_ids.h:230
@ LAYER_DRC_WARNING
layer for drc markers with SEVERITY_WARNING
Definition: layer_ids.h:235
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
Definition: layer_ids.h:214
@ LAYER_GP_OVERLAY
general purpose overlay
Definition: layer_ids.h:218
@ LAYER_RATSNEST
Definition: layer_ids.h:204
@ LAYER_ANCHOR
anchor of items having an anchor point (texts, footprints)
Definition: layer_ids.h:201
@ LAYER_PAD_BK
smd pads, back layer
Definition: layer_ids.h:203
@ LAYER_PADS_TH
multilayer pads, usually with holes
Definition: layer_ids.h:213
@ LAYER_MARKER_SHADOWS
shadows for drc markers
Definition: layer_ids.h:237
@ LAYER_VIA_HOLES
to draw via holes (pad holes do not use this layer)
Definition: layer_ids.h:215
@ LAYER_VIA_MICROVIA
to draw micro vias
Definition: layer_ids.h:194
@ LAYER_SELECT_OVERLAY
currently selected items overlay
Definition: layer_ids.h:219
@ LAYER_VIA_THROUGH
to draw usual through hole vias
Definition: layer_ids.h:196
@ LAYER_DRC_ERROR
layer for drc markers with SEVERITY_ERROR
Definition: layer_ids.h:216
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
Definition: layer_ids.h:193
@ LAYER_VIA_BBLIND
to draw blind/buried vias
Definition: layer_ids.h:195
@ LAYER_PAD_HOLEWALLS
Definition: layer_ids.h:233
bool IsNetnameLayer(int aLayer)
Test whether a layer is a netname layer.
Definition: layer_ids.h:989
@ B_Cu
Definition: layer_ids.h:95
@ F_Cu
Definition: layer_ids.h:64
#define ZONE_LAYER_FOR(boardLayer)
Definition: layer_ids.h:268
const int GAL_LAYER_ORDER[]

References B_Cu, BITMAP_LAYER_FOR, F_Cu, GAL_LAYER_ORDER, EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, GetNetnameLayer(), IsCopperLayer(), IsNetnameLayer(), IsNonCopperLayer(), LAYER_ANCHOR, LAYER_CONFLICTS_SHADOW, LAYER_DRAWINGSHEET, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_GP_OVERLAY, LAYER_GRID, LAYER_LOCKED_ITEM_SHADOW, 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, 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 571 of file pcb_draw_panel_gal.cpp.

572{
573 for( int i = 0; (unsigned) i < sizeof( GAL_LAYER_ORDER ) / sizeof( int ); ++i )
574 {
575 int layer = GAL_LAYER_ORDER[i];
576 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
577
578 // MW: Gross hack to make SetTopLayer bring the correct bitmap layer to
579 // the top of the other bitmaps, but still below all the other layers
580 if( layer < LAYER_BITMAP_START )
581 m_view->SetLayerOrder( layer, i );
582 else
584 }
585}
static constexpr int TOP_LAYER_MODIFIER
Definition: view.h:730
void SetLayerOrder(int aLayer, int aRenderingOrder)
Set rendering order of a particular layer.
Definition: view.cpp:634
@ LAYER_BITMAP_START
Virtual layers for background images per board layer.
Definition: layer_ids.h:257

References GAL_LAYER_ORDER, LAYER_BITMAP_START, EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::SetLayerOrder(), KIGFX::VIEW::TOP_LAYER_MODIFIER, 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 287 of file pcb_draw_panel_gal.cpp.

288{
289 m_drawingSheet.reset( aDrawingSheet );
290 m_view->Add( m_drawingSheet.get() );
291}

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

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), and PCB_EDIT_FRAME::SetPageSettings().

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

407{
408 m_eventDispatcher = aEventDispatcher;
409}

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(), SCH_EDIT_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), and FOOTPRINT_EDIT_FRAME::setupTools().

◆ SetFocus()

◆ 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 71 of file pcb_draw_panel_gal.h.

References SetHighContrastLayer().

Referenced by FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), and SetHighContrastLayer().

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

326{
327 // Set display settings for high contrast mode
329
330 SetTopLayer( aLayer );
331 rSettings->SetActiveLayer( aLayer );
332
333 rSettings->ClearHighContrastLayers();
334 rSettings->SetLayerIsHighContrast( aLayer );
335
336 if( IsCopperLayer( aLayer ) )
337 {
338 // Bring some other layers to the front in case of copper layers and make them colored
339 // fixme do not like the idea of storing the list of layers here,
340 // should be done in some other way I guess..
341 int layers[] = {
345 ZONE_LAYER_FOR( aLayer ),
346 BITMAP_LAYER_FOR( aLayer ),
353 };
354
355 for( unsigned int i : layers )
356 rSettings->SetLayerIsHighContrast( i );
357
358 // Pads should be shown too
359 if( aLayer == B_Cu )
360 {
363 }
364 else if( aLayer == F_Cu )
365 {
368 }
369 }
370
372}
void ClearHighContrastLayers()
Clear the list of active layers.
void SetActiveLayer(PCB_LAYER_ID aLayer)
void SetLayerIsHighContrast(int aLayerId, bool aEnabled=true)
Set the specified layer as high-contrast.
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:761
@ LAYER_CURSOR
PCB cursor.
Definition: layer_ids.h:221
@ LAYER_MOD_FR
show footprints on front
Definition: layer_ids.h:208
@ LAYER_MOD_BK
show footprints on back
Definition: layer_ids.h:209

References B_Cu, BITMAP_LAYER_FOR, KIGFX::RENDER_SETTINGS::ClearHighContrastLayers(), F_Cu, GetNetnameLayer(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), IsCopperLayer(), LAYER_ANCHOR, LAYER_CONFLICTS_SHADOW, LAYER_CURSOR, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_GP_OVERLAY, LAYER_LOCKED_ITEM_SHADOW, 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.

◆ SetStatusPopup()

void EDA_DRAW_PANEL_GAL::SetStatusPopup ( wxWindow *  aPopup)
inlineinherited

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

201{ m_stealsFocus = aStealsFocus; }

References EDA_DRAW_PANEL_GAL::m_stealsFocus.

Referenced by SYMBOL_VIEWER_FRAME::ClickOnSymbolList(), PANEL_EESCHEMA_COLOR_SETTINGS::createSwatches(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), 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 80 of file pcb_draw_panel_gal.h.

References SetTopLayer().

Referenced by OnShow(), SetHighContrastLayer(), and SetTopLayer().

◆ SetTopLayer() [2/2]

void PCB_DRAW_PANEL_GAL::SetTopLayer ( PCB_LAYER_ID  aLayer)

Definition at line 375 of file pcb_draw_panel_gal.cpp.

376{
379 m_view->SetTopLayer( aLayer );
380
381 // Layers that should always have on-top attribute enabled
382 const std::vector<int> layers = {
391 };
392
393 for( auto layer : layers )
394 m_view->SetTopLayer( layer );
395
396 // Extra layers that are brought to the top if a F.* or B.* is selected
397 const std::vector<int> frontLayers = {
400 };
401
402 const std::vector<int> backLayers = {
405 };
406
407 const std::vector<int>* extraLayers = nullptr;
408
409 // Bring a few more extra layers to the top depending on the selected board side
410 if( IsFrontLayer( aLayer ) )
411 extraLayers = &frontLayers;
412 else if( IsBackLayer( aLayer ) )
413 extraLayers = &backLayers;
414
415 if( extraLayers )
416 {
417 for( auto layer : *extraLayers )
418 {
419 m_view->SetTopLayer( layer );
420
421 if( layer < PCB_LAYER_ID_COUNT )
422 m_view->SetTopLayer( ZONE_LAYER_FOR( layer ) );
423 }
424
425 // Move the active layer to the top of the stack but below all the overlay layers
426 if( !IsCopperLayer( aLayer ) )
427 {
431
432 // Fix up pad and via netnames to be below. This is hacky, we need a rethink
433 // of layer ordering...
438 }
439 }
440
441 if( IsCopperLayer( aLayer ) )
442 {
443 m_view->SetTopLayer( ZONE_LAYER_FOR( aLayer ) );
444
445 // Display labels for copper layers on the top
446 m_view->SetTopLayer( GetNetnameLayer( aLayer ) );
447 }
448
449 m_view->SetTopLayer( BITMAP_LAYER_FOR( aLayer ) );
450 m_view->EnableTopLayer( true );
452}
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:892
int GetLayerOrder(int aLayer) const
Return rendering order of a particular layer.
Definition: view.cpp:642
virtual void EnableTopLayer(bool aEnable)
Enable or disable display of the top layer.
Definition: view.cpp:852
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
Definition: view.cpp:877
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:825
#define NETNAMES_LAYER_INDEX(layer)
Macro for obtaining netname layer for a given PCB layer.
Definition: layer_ids.h:174
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
Definition: layer_ids.h:899
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
Definition: layer_ids.h:922
@ F_CrtYd
Definition: layer_ids.h:117
@ B_Adhes
Definition: layer_ids.h:97
@ F_Paste
Definition: layer_ids.h:101
@ F_Adhes
Definition: layer_ids.h:98
@ B_Mask
Definition: layer_ids.h:106
@ F_Mask
Definition: layer_ids.h:107
@ B_Paste
Definition: layer_ids.h:100
@ F_Fab
Definition: layer_ids.h:120
@ F_SilkS
Definition: layer_ids.h:104
@ B_CrtYd
Definition: layer_ids.h:116
@ B_SilkS
Definition: layer_ids.h:103
@ PCB_LAYER_ID_COUNT
Definition: layer_ids.h:137
@ B_Fab
Definition: layer_ids.h:119

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, BITMAP_LAYER_FOR, 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

◆ StatusPopupHasFocus()

bool EDA_DRAW_PANEL_GAL::StatusPopupHasFocus ( )
inlineinherited

Definition at line 93 of file class_draw_panel_gal.h.

94 {
95 return m_statusPopup && m_statusPopup->HasFocus();
96 }

References EDA_DRAW_PANEL_GAL::m_statusPopup.

Referenced by KIGFX::WX_VIEW_CONTROLS::onTimer().

◆ StopDrawing()

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

589{
590 bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
592 m_gal->SetWorldUnitLength( 1e-9 /* 1 nm */ / 0.0254 /* 1 inch in meters */ );
593 return rv;
594}
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 455 of file pcb_draw_panel_gal.cpp.

456{
457 // Load layer & elements visibility settings
458 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
459 m_view->SetLayerVisible( i, aBoard->IsLayerVisible( PCB_LAYER_ID( i ) ) );
460
462 m_view->SetLayerVisible( i, aBoard->IsElementVisible( i ) );
463
464 // Via layers controlled by dependencies
468
469 // Pad layers controlled by dependencies
472
473 // Always enable netname layers, as their visibility is controlled by layer dependencies
474 for( int i = NETNAMES_LAYER_ID_START; i < NETNAMES_LAYER_ID_END; ++i )
475 m_view->SetLayerVisible( i, true );
476
477 for( int i = LAYER_ZONE_START; i < LAYER_ZONE_END; i++ )
478 m_view->SetLayerVisible( i, true );
479
480 for( int i = LAYER_BITMAP_START; i < LAYER_BITMAP_END; i++ )
481 m_view->SetLayerVisible( i, true );
482
483 // Enable some layers that are GAL specific
492}
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:631
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:571
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:393
@ NETNAMES_LAYER_ID_START
Definition: layer_ids.h:157
@ NETNAMES_LAYER_ID_END
Definition: layer_ids.h:170
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:190
@ GAL_LAYER_ID_START
Definition: layer_ids.h:191
@ LAYER_ZONE_END
Definition: layer_ids.h:254
@ GAL_LAYER_ID_END
Definition: layer_ids.h:260
@ LAYER_ZONE_START
Virtual layers for stacking zones and tracks on a given copper layer.
Definition: layer_ids.h:253
@ LAYER_BITMAP_END
Definition: layer_ids.h:258
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:59

References GAL_LAYER_ID_END, GAL_LAYER_ID_START, BOARD::IsElementVisible(), BOARD::IsLayerVisible(), LAYER_BITMAP_END, LAYER_BITMAP_START, 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(), PCB_EDIT_FRAME::onBoardLoaded(), APPEARANCE_CONTROLS::OnLayerContextMenu(), and PCB_EDIT_FRAME::RebuildAndRefresh().

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

295{
296 COLOR_SETTINGS* cs = nullptr;
297
298 PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( GetParentEDAFrame() );
299
300 if( frame )
301 {
302 cs = frame->GetColorSettings();
303 }
304 else
305 {
306 PCBNEW_SETTINGS* app = Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
307
308 if( app )
309 cs = Pgm().GetSettingsManager().GetColorSettings( app->m_ColorTheme );
310 else
311 cs = Pgm().GetSettingsManager().GetColorSettings();
312 }
313
314 wxCHECK_RET( cs, wxT( "null COLOR_SETTINGS" ) );
315
316 auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( m_view->GetPainter()->GetSettings() );
317 rs->LoadColors( cs );
318
322}
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:190
Color settings are a bit different than most of the settings objects in that there can be more than o...
COLOR4D GetColor(int aLayer) const
void SetAxesColor(const COLOR4D &aAxesColor)
Set the axes color.
void LoadColors(const COLOR_SETTINGS *aSettings) override
virtual COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
@ LAYER_GRID_AXES
Definition: layer_ids.h:206

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, KIGFX::PCB_RENDER_SETTINGS::LoadColors(), 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 PCB_EDIT_FRAME::ActivateGalCanvas(), 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_EDIT_FRAME::UpdateView(), FOOTPRINT_VIEWER_FRAME::updateView(), and FOOTPRINT_WIZARD_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 307 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

True if GAL is currently redrawing the view.

Definition at line 269 of file class_draw_panel_gal.h.

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

◆ m_drawingEnabled

bool EDA_DRAW_PANEL_GAL::m_drawingEnabled
protectedinherited

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

Definition at line 272 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), 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 119 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 294 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 262 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 298 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_minRefreshPeriod

int EDA_DRAW_PANEL_GAL::m_minRefreshPeriod
protectedinherited

A minimum delay before another draw can start.

Definition at line 261 of file class_draw_panel_gal.h.

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

◆ 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 246 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 275 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 291 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ m_painter

◆ m_PaintEventCounter

std::unique_ptr<PROF_COUNTER> EDA_DRAW_PANEL_GAL::m_PaintEventCounter
inherited

Definition at line 248 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ 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 122 of file pcb_draw_panel_gal.h.

Referenced by DisplayBoard(), and RedrawRatsnest().

◆ m_refreshMutex

std::mutex EDA_DRAW_PANEL_GAL::m_refreshMutex
protectedinherited

Blocks multiple calls to the draw.

Definition at line 266 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint().

◆ m_refreshTimer

wxTimer EDA_DRAW_PANEL_GAL::m_refreshTimer
protectedinherited

◆ m_statusPopup

wxWindow* EDA_DRAW_PANEL_GAL::m_statusPopup
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 302 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 281 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(), EDA_DRAW_PANEL_GAL::GetView(), SCH_DRAW_PANEL::GetView(), GetView(), SCH_DRAW_PANEL::OnShow(), GERBVIEW_DRAW_PANEL_GAL::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(), SCH_DRAW_PANEL::setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), PL_DRAW_PANEL_GAL::setDefaultLayerDeps(), setDefaultLayerDeps(), SCH_DRAW_PANEL::setDefaultLayerOrder(), SCH_PREVIEW_PANEL::setDefaultLayerOrder(), setDefaultLayerOrder(), GERBVIEW_DRAW_PANEL_GAL::SetDrawingSheet(), SetDrawingSheet(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), SetHighContrastLayer(), EDA_DRAW_PANEL_GAL::SetTopLayer(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), SetTopLayer(), EDA_DRAW_PANEL_GAL::SwitchBackend(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), SyncLayersVisibility(), UpdateColors(), SCH_PREVIEW_PANEL::view(), and EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL().

◆ m_viewControls


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