KiCad PCB EDA Suite
EDA_DRAW_PANEL_GAL Class Reference

#include <class_draw_panel_gal.h>

Inheritance diagram for EDA_DRAW_PANEL_GAL:
GERBVIEW_DRAW_PANEL_GAL PCB_DRAW_PANEL_GAL PL_DRAW_PANEL_GAL SCH_DRAW_PANEL SCH_PREVIEW_PANEL 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

 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. More...
 
 ~EDA_DRAW_PANEL_GAL ()
 
void SetFocus () override
 
bool StatusPopupHasFocus ()
 
void SetStatusPopup (wxWindow *aPopup)
 
virtual bool SwitchBackend (GAL_TYPE aGalType)
 Switch method of rendering graphics. More...
 
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...
 
virtual KIGFX::VIEWGetView () const
 Return a pointer to the #VIEW 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...
 
virtual void SetHighContrastLayer (int aLayer)
 Take care of display settings for the given layer to be displayed in high contrast mode. More...
 
virtual void SetTopLayer (int aLayer)
 Move the selected layer to the top, so it is displayed above all others. More...
 
virtual void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
 
EDA_DRAW_FRAMEGetParentEDAFrame () const
 Returns parent EDA_DRAW_FRAME, if available or NULL otherwise. More...
 
bool IsDialogPreview () const
 
virtual void OnShow ()
 Called when the window is shown for the first time. More...
 
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...
 
virtual BOX2I GetDefaultViewBBox () const
 Return the bounding box of the view that should be used if model is not valid. 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

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

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

Static Protected Attributes

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

Detailed Description

Definition at line 59 of file class_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

◆ EDA_DRAW_PANEL_GAL()

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

Create a drawing panel that is contained inside aParentWindow.

If aParentWindow is not an EDA frame, a search through all the parents of the parent window will be done to find the frame.

Parameters
aParentWindowis the window immediately containing this panel

Definition at line 57 of file draw_panel_gal.cpp.

59 :
60 wxScrolledCanvas( aParentWindow, aWindowId, aPosition, aSize ),
61 m_edaFrame( nullptr ),
62 m_gal( nullptr ),
63 m_view( nullptr ),
64 m_painter( nullptr ),
65 m_viewControls( nullptr ),
67 m_options( aOptions ),
68 m_eventDispatcher( nullptr ),
69 m_lostFocus( false ),
70 m_stealsFocus( true ),
71 m_statusPopup( nullptr )
72{
73 m_parent = aParentWindow;
74 m_MouseCapturedLost = false;
75
76 m_PaintEventCounter = std::make_unique<PROF_COUNTER>( "Draw panel paint events" );
77
78 SetLayoutDirection( wxLayout_LeftToRight );
79
80 m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( m_parent );
81
82 // If we're in a dialog, we have to go looking for our parent frame
83 if( !m_edaFrame )
84 {
85 wxWindow* ancestor = aParentWindow->GetParent();
86
87 while( ancestor && !dynamic_cast<EDA_DRAW_FRAME*>( ancestor ) )
88 ancestor = ancestor->GetParent();
89
90 if( ancestor )
91 m_edaFrame = dynamic_cast<EDA_DRAW_FRAME*>( ancestor );
92 }
93
94 SwitchBackend( aGalType );
95 SetBackgroundStyle( wxBG_STYLE_CUSTOM );
96
97 if( Pgm().GetCommonSettings()->m_Appearance.show_scrollbars )
98 {
99 ShowScrollbars( wxSHOW_SB_ALWAYS, wxSHOW_SB_ALWAYS );
100 }
101 else
102 {
103 ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
104 }
105
106 EnableScrolling( false, false ); // otherwise Zoom Auto disables GAL canvas
107 KIPLATFORM::UI::SetOverlayScrolling( this, false ); // Prevent excessive repaint on GTK
108
109 Connect( wxEVT_SIZE, wxSizeEventHandler( EDA_DRAW_PANEL_GAL::onSize ), nullptr, this );
110 Connect( wxEVT_ENTER_WINDOW, wxMouseEventHandler( EDA_DRAW_PANEL_GAL::onEnter ), nullptr,
111 this );
112 Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( EDA_DRAW_PANEL_GAL::onLostFocus ), nullptr,
113 this );
114
115 const wxEventType events[] = {
116 // Binding both EVT_CHAR and EVT_CHAR_HOOK ensures that all key events,
117 // especially special key like arrow keys, are handled by the GAL event dispatcher,
118 // and not sent to GUI without filtering, because they have a default action (scroll)
119 // that must not be called.
120 wxEVT_LEFT_UP,
121 wxEVT_LEFT_DOWN,
122 wxEVT_LEFT_DCLICK,
123 wxEVT_RIGHT_UP,
124 wxEVT_RIGHT_DOWN,
125 wxEVT_RIGHT_DCLICK,
126 wxEVT_MIDDLE_UP,
127 wxEVT_MIDDLE_DOWN,
128 wxEVT_MIDDLE_DCLICK,
129 wxEVT_AUX1_UP,
130 wxEVT_AUX1_DOWN,
131 wxEVT_AUX1_DCLICK,
132 wxEVT_AUX2_UP,
133 wxEVT_AUX2_DOWN,
134 wxEVT_AUX2_DCLICK,
135 wxEVT_MOTION,
136 wxEVT_MOUSEWHEEL,
137 wxEVT_CHAR,
138 wxEVT_CHAR_HOOK,
139#if wxCHECK_VERSION( 3, 1, 0 ) || defined( USE_OSX_MAGNIFY_EVENT )
140 wxEVT_MAGNIFY,
141#endif
143 };
144
145 for( wxEventType eventType : events )
146 Connect( eventType, wxEventHandler( EDA_DRAW_PANEL_GAL::OnEvent ), nullptr,
148
149 m_pendingRefresh = false;
150 m_drawing = false;
151 m_drawingEnabled = false;
152
153 // Set up timer that prevents too frequent redraw commands
154 m_refreshTimer.SetOwner( this );
155 Connect( m_refreshTimer.GetId(), wxEVT_TIMER,
156 wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onRefreshTimer ), nullptr, this );
157
158 // Set up timer to execute OnShow() method when the window appears on the screen
159 m_onShowTimer.SetOwner( this );
160 Connect( m_onShowTimer.GetId(), wxEVT_TIMER,
161 wxTimerEventHandler( EDA_DRAW_PANEL_GAL::onShowTimer ), nullptr, this );
162 m_onShowTimer.Start( 10 );
163}
The base class for create windows for drawing purpose.
std::unique_ptr< PROF_COUNTER > m_PaintEventCounter
EDA_DRAW_FRAME * m_edaFrame
Parent EDA_DRAW_FRAME (if available)
void onLostFocus(wxFocusEvent &aEvent)
std::unique_ptr< KIGFX::PAINTER > m_painter
Contains information about how to draw items using GAL.
void onSize(wxSizeEvent &aEvent)
bool m_stealsFocus
Flag to indicate whether the panel should take focus at certain times (when moused over,...
KIGFX::GAL_DISPLAY_OPTIONS & m_options
bool m_drawing
True if GAL is currently redrawing the view.
void onShowTimer(wxTimerEvent &aEvent)
KIGFX::GAL * m_gal
Interface for drawing objects on a 2D-surface.
bool m_pendingRefresh
Is there a redraw event requested?
void onRefreshTimer(wxTimerEvent &aEvent)
bool m_lostFocus
Flag to indicate that focus should be regained on the next mouse event.
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.
TOOL_DISPATCHER * m_eventDispatcher
Processes and forwards events to tools.
wxWindow * m_parent
Pointer to the parent window.
KIGFX::VIEW * m_view
Stores view settings (scale, center, etc.) and items to be drawn.
bool m_MouseCapturedLost
used on wxMSW: true after a wxEVT_MOUSE_CAPTURE_LOST was received false after the mouse is recaptured...
KIGFX::WX_VIEW_CONTROLS * m_viewControls
Control for VIEW (moving, zooming, etc.)
void onEnter(wxMouseEvent &aEvent)
virtual bool SwitchBackend(GAL_TYPE aGalType)
Switch method of rendering graphics.
void OnEvent(wxEvent &aEvent)
Used to forward events to the canvas from popups, etc.
bool m_drawingEnabled
Flag that determines if VIEW may use GAL for redrawing the screen.
GAL_TYPE m_backend
Currently used GAL.
wxTimer m_onShowTimer
Timer used to execute OnShow() when the window finally appears on the screen.
static const wxEventType EVT_REFRESH_MOUSE
void SetOverlayScrolling(const wxWindow *aWindow, bool overlay)
Used to set overlay/non-overlay scrolling mode in a window.
Definition: gtk/ui.cpp:133
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111

References KIGFX::WX_VIEW_CONTROLS::EVT_REFRESH_MOUSE, m_drawing, m_drawingEnabled, m_edaFrame, m_eventDispatcher, m_MouseCapturedLost, m_onShowTimer, m_PaintEventCounter, m_parent, m_pendingRefresh, m_refreshTimer, onEnter(), OnEvent(), onLostFocus(), onRefreshTimer(), onShowTimer(), onSize(), Pgm(), KIPLATFORM::UI::SetOverlayScrolling(), and SwitchBackend().

◆ ~EDA_DRAW_PANEL_GAL()

EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL ( )

Definition at line 166 of file draw_panel_gal.cpp.

167{
168 StopDrawing();
169
170 wxASSERT( !m_drawing );
171
172 delete m_viewControls;
173 delete m_view;
174 delete m_gal;
175}
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

References m_drawing, m_gal, m_view, m_viewControls, and StopDrawing().

Member Function Documentation

◆ ClearDebugOverlay()

void EDA_DRAW_PANEL_GAL::ClearDebugOverlay ( )

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

Definition at line 645 of file draw_panel_gal.cpp.

646{
647 if( m_debugOverlay )
648 {
649 m_view->Remove( m_debugOverlay.get() );
650 m_debugOverlay = nullptr;
651 }
652}
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:346

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

◆ DebugOverlay()

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

Create an overlay for rendering debug graphics.

Definition at line 633 of file draw_panel_gal.cpp.

634{
635 if( !m_debugOverlay )
636 {
637 m_debugOverlay.reset( new KIGFX::VIEW_OVERLAY() );
638 m_view->Add( m_debugOverlay.get() );
639 }
640
641 return m_debugOverlay;
642}
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
Definition: view.cpp:316

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

◆ DoRePaint()

void EDA_DRAW_PANEL_GAL::DoRePaint ( )

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

192{
193 if( !m_refreshMutex.try_lock() )
194 return;
195
196 std::lock_guard<std::mutex> lock( m_refreshMutex, std::adopt_lock );
197
198 // Repaint the canvas, and fix scrollbar cursors
199 // Usually called by a OnPaint event, but because it does not use a wxPaintDC,
200 // it can be called outside a wxPaintEvent.
201
202 // Update current zoom settings if the canvas is managed by a EDA frame
203 // (i.e. not by a preview panel in a dialog)
204 if( !IsDialogPreview() && GetParentEDAFrame() && GetParentEDAFrame()->GetScreen() )
206
208
209 if( !m_drawingEnabled )
210 return;
211
212 if( !m_gal->IsVisible() )
213 return;
214
215 m_pendingRefresh = false;
216
217 if( m_drawing )
218 return;
219
220 SCOPED_SET_RESET<bool> drawing( m_drawing, true );
221
222 ( *m_PaintEventCounter )++;
223
224 wxASSERT( m_painter );
225
226 KIGFX::RENDER_SETTINGS* settings =
227 static_cast<KIGFX::RENDER_SETTINGS*>( m_painter->GetSettings() );
228
229 PROF_TIMER cntUpd("view-upd-items");
230 PROF_TIMER cntTotal("view-total");
231 PROF_TIMER cntCtx("view-context-create");
232 PROF_TIMER cntCtxDestroy("view-context-destroy");
233 PROF_TIMER cntRedraw("view-redraw-rects");
234
235 bool isDirty = false;
236
237 cntTotal.Start();
238 try
239 {
240 cntUpd.Start();
241
242 try
243 {
245 }
246 catch( std::out_of_range& err )
247 {
248 // Don't do anything here but don't fail
249 // This can happen when we don't catch `at()` calls
250 wxString msg;
251 msg.Printf( wxT( "Out of Range error: %s" ), err.what() );
252 wxLogDebug( msg );
253 }
254
255 cntUpd.Stop();
256
257 cntCtx.Start();
259 cntCtx.Stop();
260
263 {
264 m_view->MarkDirty();
265 }
266
267 m_gal->SetClearColor( settings->GetBackgroundColor() );
268 m_gal->SetGridColor( settings->GetGridColor() );
269 m_gal->SetCursorColor( settings->GetCursorColor() );
270
271 // TODO: find why ClearScreen() must be called here in opengl mode
272 // and only if m_view->IsDirty() in Cairo mode to avoid display artifacts
273 // when moving the mouse cursor
276
277 if( m_view->IsDirty() )
278 {
279 if( m_backend != GAL_TYPE_OPENGL // Already called in opengl
281 {
283 }
284
286
287 // Grid has to be redrawn only when the NONCACHED target is redrawn
289 m_gal->DrawGrid();
290
291 cntRedraw.Start();
292 m_view->Redraw();
293 cntRedraw.Stop();
294 isDirty = true;
295 }
296
298
299 cntCtxDestroy.Start();
300 }
301 catch( std::exception& err )
302 {
303 if( GAL_FALLBACK != m_backend )
304 {
306
308 _( "Could not use OpenGL, falling back to software rendering" ),
309 wxString( err.what() ) );
310 }
311 else
312 {
313 // We're well and truly banjaxed if we get here without a fallback.
314 DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), wxString( err.what() ) );
315 }
316 }
317
318 // ctx goes out of scope here so destructor would be called
319 cntCtxDestroy.Stop();
320
321
322 if( isDirty )
323 {
324 KI_TRACE( traceGalProfile, "View timing: %s %s %s %s %s\n",
325 cntTotal.to_string(),
326 cntUpd.to_string(),
327 cntRedraw.to_string(),
328 cntCtx.to_string(),
329 cntCtxDestroy.to_string()
330 );
331 }
332
333 m_lastRefresh = wxGetLocalTimeMillis();
334}
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.
wxLongLong m_lastRefresh
Last timestamp when the panel was refreshed.
std::mutex m_refreshMutex
Blocks multiple calls to the draw.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
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:1111
virtual void Redraw()
Immediately redraws the whole view.
Definition: view.cpp:1130
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:1398
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:320
#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
#define KI_TRACE(aWhat,...)

References _, KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayInfoMessage(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), GAL_FALLBACK, GAL_TYPE_OPENGL, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::VIEW::GetCenter(), KIGFX::RENDER_SETTINGS::GetCursorColor(), KIGFX::WX_VIEW_CONTROLS::GetCursorPosition(), KIGFX::RENDER_SETTINGS::GetGridColor(), GetParentEDAFrame(), EDA_DRAW_FRAME::GetScreen(), GetView(), KIGFX::GAL::HasTarget(), IsDialogPreview(), KIGFX::VIEW::IsDirty(), KIGFX::VIEW::IsTargetDirty(), KIGFX::GAL::IsVisible(), KI_TRACE, m_backend, m_drawing, m_drawingEnabled, m_gal, m_lastRefresh, m_painter, m_parent, m_pendingRefresh, m_refreshMutex, BASE_SCREEN::m_ScrollCenter, m_view, m_viewControls, KIGFX::VIEW::MarkDirty(), KIGFX::VIEW::Redraw(), KIGFX::GAL::SetClearColor(), KIGFX::GAL::SetCursorColor(), KIGFX::GAL::SetGridColor(), PROF_TIMER::Start(), PROF_TIMER::Stop(), SwitchBackend(), KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, PROF_TIMER::to_string(), traceGalProfile, KIGFX::VIEW::UpdateItems(), and KIGFX::WX_VIEW_CONTROLS::UpdateScrollbars().

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

◆ ForceRefresh()

void EDA_DRAW_PANEL_GAL::ForceRefresh ( )

Force a redraw.

Definition at line 393 of file draw_panel_gal.cpp.

394{
395 m_pendingRefresh = true;
396 DoRePaint();
397}
void DoRePaint()
Repaint the canvas, and fix scrollbar cursors.

References DoRePaint(), and 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(), PCB_SELECTION_TOOL::FindItem(), PCB_CONTROL::FlipPcbView(), SCH_BASE_FRAME::HardRedraw(), SCH_EDIT_FRAME::HardRedraw(), FOOTPRINT_EDIT_FRAME::HardRedraw(), SYMBOL_PREVIEW_WIDGET::onSize(), 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()

virtual BOX2I EDA_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
inlinevirtual

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 in GERBVIEW_DRAW_PANEL_GAL, and PCB_DRAW_PANEL_GAL.

Definition at line 214 of file class_draw_panel_gal.h.

214{ return BOX2I(); }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:847

Referenced by COMMON_TOOLS::CenterContents(), and COMMON_TOOLS::doZoomFit().

◆ GetGAL()

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

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

virtual void EDA_DRAW_PANEL_GAL::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
inlinevirtual

Reimplemented in GERBVIEW_DRAW_PANEL_GAL, PL_DRAW_PANEL_GAL, and PCB_DRAW_PANEL_GAL.

Definition at line 178 of file class_draw_panel_gal.h.

179 {
180 wxASSERT( false );
181 }

◆ GetParentEDAFrame()

◆ GetView()

virtual KIGFX::VIEW * EDA_DRAW_PANEL_GAL::GetView ( ) const
inlinevirtual

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

Returns
The instance of #VIEW.

Reimplemented in SCH_DRAW_PANEL, and PCB_DRAW_PANEL_GAL.

Definition at line 127 of file class_draw_panel_gal.h.

127{ return m_view; }

References m_view.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ApplyDisplaySettingsToGAL(), EDITOR_CONDITIONS::bboxesFunc(), GERBVIEW_FRAME::Clear_DrawLayers(), GERBVIEW_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DIALOG_PRINT_GERBVIEW::createPrintout(), GERBVIEW_CONTROL::DisplayControl(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), GERBVIEW_FRAME::doCloseWindow(), DoRePaint(), SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), EDA_DRAW_FRAME::FocusOnLocation(), GERBVIEW_FRAME::GetVisibleLayers(), GERBVIEW_CONTROL::HighlightControl(), PROPERTIES_FRAME::OnAcceptPrms(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnLayerSelect(), EDA_DRAW_FRAME::OnMove(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectActiveLayer(), PL_EDITOR_FRAME::OnSelectPage(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), GERBER_LAYER_WIDGET::ReFill(), GERBVIEW_FRAME::RemapLayers(), PL_EDITOR_FRAME::RollbackFromUndo(), NL_SCHEMATIC_PLUGIN_IMPL::SetCanvas(), PCB_BASE_FRAME::SetDisplayOptions(), GERBVIEW_FRAME::SetElementVisibility(), EDA_DRAW_FRAME::SetGridVisibility(), GERBVIEW_FRAME::SetVisibleLayers(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), COMMON_TOOLS::ToggleBoundingBoxes(), GERBVIEW_FRAME::unarchiveFiles(), GERBVIEW_FRAME::UpdateDiffLayers(), PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), and SYMBOL_PREVIEW_WIDGET::~SYMBOL_PREVIEW_WIDGET().

◆ GetViewControls()

◆ IsDialogPreview()

bool EDA_DRAW_PANEL_GAL::IsDialogPreview ( ) const
inline

Definition at line 188 of file class_draw_panel_gal.h.

188{ return m_parent != (wxWindow*) m_edaFrame; }

References m_edaFrame, and m_parent.

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

◆ onEnter()

void EDA_DRAW_PANEL_GAL::onEnter ( wxMouseEvent &  aEvent)
protected

Definition at line 568 of file draw_panel_gal.cpp.

569{
570 bool shouldSetFocus = m_stealsFocus
571 && !KIUI::IsInputControlFocused() // Don't steal from input controls
572 && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
573 && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
574
575 // Getting focus is necessary in order to receive key events properly
576 if( shouldSetFocus )
577 SetFocus();
578
579 aEvent.Skip();
580}
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:253
bool IsModalDialogFocused()
Definition: ui_common.cpp:303

References KIUI::IsInputControlFocused(), KIUI::IsModalDialogFocused(), KIPLATFORM::UI::IsWindowActive(), m_edaFrame, m_stealsFocus, and SetFocus().

Referenced by EDA_DRAW_PANEL_GAL().

◆ OnEvent()

void EDA_DRAW_PANEL_GAL::OnEvent ( wxEvent &  aEvent)

Used to forward events to the canvas from popups, etc.

Definition at line 549 of file draw_panel_gal.cpp.

550{
551 bool shouldSetFocus = m_lostFocus && m_stealsFocus
552 && !KIUI::IsInputControlFocused() // Don't steal from input controls
553 && !KIUI::IsModalDialogFocused() // Don't steal from dialogs
554 && KIPLATFORM::UI::IsWindowActive( m_edaFrame ); // Don't steal from other windows
555
556 if( shouldSetFocus )
557 SetFocus();
558
559 if( !m_eventDispatcher )
560 aEvent.Skip();
561 else
563
564 Refresh();
565}
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...
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(), m_edaFrame, m_eventDispatcher, m_lostFocus, m_stealsFocus, Refresh(), and SetFocus().

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

◆ onLostFocus()

void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protected

Definition at line 583 of file draw_panel_gal.cpp.

584{
585 m_lostFocus = true;
586
588
589 aEvent.Skip();
590}

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

Referenced by EDA_DRAW_PANEL_GAL().

◆ onPaint()

void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protectedvirtual

Reimplemented in SCH_DRAW_PANEL, and SCH_PREVIEW_PANEL.

Definition at line 185 of file draw_panel_gal.cpp.

186{
187 DoRePaint();
188}

References DoRePaint().

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

◆ onRefreshTimer()

void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 593 of file draw_panel_gal.cpp.

594{
595 if( !m_drawingEnabled )
596 {
597 if( m_gal && m_gal->IsInitialized() )
598 {
599 m_pendingRefresh = true;
600 Connect( wxEVT_PAINT, wxPaintEventHandler( EDA_DRAW_PANEL_GAL::onPaint ), nullptr,
601 this );
602 m_drawingEnabled = true;
603 }
604 else
605 {
606 // Try again soon
607 m_refreshTimer.StartOnce( 100 );
608 return;
609 }
610 }
611
612 DoRePaint();
613}
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))
virtual bool IsInitialized() const
Return the initialization status for the canvas.

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

Referenced by EDA_DRAW_PANEL_GAL().

◆ OnShow()

virtual void EDA_DRAW_PANEL_GAL::OnShow ( )
inlinevirtual

Called when the window is shown for the first time.

Reimplemented in SCH_DRAW_PANEL, SCH_PREVIEW_PANEL, GERBVIEW_DRAW_PANEL_GAL, and PCB_DRAW_PANEL_GAL.

Definition at line 193 of file class_draw_panel_gal.h.

193{}

Referenced by onShowTimer().

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 616 of file draw_panel_gal.cpp.

617{
618 if( m_gal && m_gal->IsVisible() )
619 {
620 m_onShowTimer.Stop();
621 OnShow();
622 }
623}
virtual void OnShow()
Called when the window is shown for the first time.

References KIGFX::GAL::IsVisible(), m_gal, m_onShowTimer, and OnShow().

Referenced by EDA_DRAW_PANEL_GAL().

◆ onSize()

void EDA_DRAW_PANEL_GAL::onSize ( wxSizeEvent &  aEvent)
protected

Definition at line 337 of file draw_panel_gal.cpp.

338{
339 // If we get a second wx update call before the first finishes, don't crash
340 if( m_gal->IsContextLocked() )
341 return;
342
344 wxSize clientSize = GetClientSize();
345 WX_INFOBAR* infobar = GetParentEDAFrame() ? GetParentEDAFrame()->GetInfoBar() : nullptr;
346
347 if( VECTOR2I( clientSize ) == m_gal->GetScreenPixelSize() )
348 return;
349
350 clientSize.x = std::max( 10, clientSize.x );
351 clientSize.y = std::max( 10, clientSize.y );
352
353 VECTOR2D bottom( 0, 0 );
354
355 if( m_view )
356 bottom = m_view->ToWorld( m_gal->GetScreenPixelSize(), true );
357
358 m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
359
360 if( m_view )
361 {
362 if( infobar && infobar->IsLocked() )
363 m_view->SetCenter( bottom - m_view->ToWorld( clientSize, false ) / 2.0 );
364
367 }
368}
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:445
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:574
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: infobar.h:75
bool IsLocked()
Returns true if the infobar is being updated.
Definition: 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(), GetParentEDAFrame(), KIGFX::GAL::GetScreenPixelSize(), KIGFX::GAL::IsContextLocked(), WX_INFOBAR::IsLocked(), m_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().

◆ Refresh()

void EDA_DRAW_PANEL_GAL::Refresh ( bool  aEraseBackground = true,
const wxRect *  aRect = nullptr 
)
overridevirtual

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

372{
373 wxLongLong t = wxGetLocalTimeMillis();
374 wxLongLong delta = t - m_lastRefresh;
375
376 // If it has been too long since the last frame (possible depending on platform timer latency),
377 // just do a refresh. Otherwise, start the refresh timer if it hasn't already been started.
378 // This ensures that we will render often enough but not too often.
379 if( delta >= MinRefreshPeriod )
380 {
381 if( !m_pendingRefresh )
382 ForceRefresh();
383
384 m_refreshTimer.Start( MinRefreshPeriod, true );
385 }
386 else if( !m_refreshTimer.IsRunning() )
387 {
388 m_refreshTimer.Start( ( MinRefreshPeriod - delta ).ToLong(), true );
389 }
390}
void ForceRefresh()
Force a redraw.
static const int MinRefreshPeriod
60 FPS.
constexpr int delta

References delta, ForceRefresh(), m_lastRefresh, m_pendingRefresh, m_refreshTimer, and MinRefreshPeriod.

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(), ZONE_FILLER_TOOL::CheckAllZones(), 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(), 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(), ZONE_FILLER_TOOL::FillAllZones(), SCH_EDITOR_CONTROL::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(), 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(), 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(), 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(), 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(), FOOTPRINT_EDIT_FRAME::SelectLayer(), GERBVIEW_FRAME::SetActiveLayer(), FOOTPRINT_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_EDITOR_CONTROL::UpdateFind(), NET_GRID_TABLE::updateNetColor(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillDirty(), ZONE_FILLER_TOOL::ZoneUnfill(), ZONE_FILLER_TOOL::ZoneUnfillAll(), and DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES().

◆ SetCurrentCursor()

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( KICURSOR  aCursor)

Set the current cursor shape for this panel.

Definition at line 626 of file draw_panel_gal.cpp.

627{
628 if( m_gal )
629 m_gal->SetNativeCursorStyle( aCursor );
630}
virtual bool SetNativeCursorStyle(KICURSOR aCursor)
Set the cursor in the native panel.

References 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(), SwitchBackend(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ SetEventDispatcher()

void EDA_DRAW_PANEL_GAL::SetEventDispatcher ( TOOL_DISPATCHER aEventDispatcher)

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

401{
402 m_eventDispatcher = aEventDispatcher;
403}

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

void EDA_DRAW_PANEL_GAL::SetHighContrastLayer ( int  aLayer)
virtual

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

Reimplemented in GERBVIEW_DRAW_PANEL_GAL, and PCB_DRAW_PANEL_GAL.

Definition at line 422 of file draw_panel_gal.cpp.

423{
424 // Set display settings for high contrast mode
426
427 SetTopLayer( aLayer );
428
429 rSettings->ClearHighContrastLayers();
430 rSettings->SetLayerIsHighContrast( aLayer );
431
433}
virtual void SetTopLayer(int aLayer)
Move the selected layer to the top, so it is displayed above all others.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
void ClearHighContrastLayers()
Clear the list of active layers.
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:758
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:213

References KIGFX::RENDER_SETTINGS::ClearHighContrastLayers(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), m_view, KIGFX::RENDER_SETTINGS::SetLayerIsHighContrast(), SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersColor().

Referenced by GERBVIEW_FRAME::SetActiveLayer(), and PCB_BASE_FRAME::SetDisplayOptions().

◆ SetStatusPopup()

void EDA_DRAW_PANEL_GAL::SetStatusPopup ( wxWindow *  aPopup)
inline

◆ SetStealsFocus()

void EDA_DRAW_PANEL_GAL::SetStealsFocus ( bool  aStealsFocus)
inline

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

void EDA_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
virtual

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

Reimplemented in GERBVIEW_DRAW_PANEL_GAL, PL_DRAW_PANEL_GAL, and PCB_DRAW_PANEL_GAL.

Definition at line 436 of file draw_panel_gal.cpp.

437{
439 m_view->SetTopLayer( aLayer );
441}
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:889
void ClearTopLayers()
Remove all layers from the on-the-top set (they are no longer displayed over the rest of layers).
Definition: view.cpp:874
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:822

References KIGFX::VIEW::ClearTopLayers(), m_view, KIGFX::VIEW::SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersOrder().

Referenced by SetHighContrastLayer().

◆ StartDrawing()

void EDA_DRAW_PANEL_GAL::StartDrawing ( )

◆ StatusPopupHasFocus()

bool EDA_DRAW_PANEL_GAL::StatusPopupHasFocus ( )
inline

Definition at line 93 of file class_draw_panel_gal.h.

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

References m_statusPopup.

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

◆ StopDrawing()

◆ SwitchBackend()

bool EDA_DRAW_PANEL_GAL::SwitchBackend ( GAL_TYPE  aGalType)
virtual

Switch method of rendering graphics.

Parameters
aGalTypeis a type of rendering engine that you want to use.

Reimplemented in SCH_DRAW_PANEL, GERBVIEW_DRAW_PANEL_GAL, PL_DRAW_PANEL_GAL, and PCB_DRAW_PANEL_GAL.

Definition at line 444 of file draw_panel_gal.cpp.

445{
446 // Do not do anything if the currently used GAL is correct
447 if( aGalType == m_backend && m_gal != nullptr )
448 return true;
449
450 VECTOR2D grid_size = m_gal ? m_gal->GetGridSize() : VECTOR2D();
451 bool grid_visibility = m_gal ? m_gal->GetGridVisibility() : true;
452 bool result = true; // assume everything will be fine
453
454 // Prevent refreshing canvas during backend switch
455 StopDrawing();
456
457 KIGFX::GAL* new_gal = nullptr;
458
459 try
460 {
461 switch( aGalType )
462 {
463 case GAL_TYPE_OPENGL:
464 {
465 wxString errormsg = KIGFX::OPENGL_GAL::CheckFeatures( m_options );
466
467 if( errormsg.empty() )
468 {
469 new_gal = new KIGFX::OPENGL_GAL( m_options, this, this, this );
470 }
471 else
472 {
473 if( GAL_FALLBACK != aGalType )
474 {
475 aGalType = GAL_FALLBACK;
477 m_parent,
478 _( "Could not use OpenGL, falling back to software rendering" ),
479 errormsg );
480 new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this );
481 }
482 else
483 {
484 // We're well and truly banjaxed if we get here without a fallback.
485 DisplayInfoMessage( m_parent, _( "Could not use OpenGL" ), errormsg );
486 }
487 }
488 break;
489 }
490
491 case GAL_TYPE_CAIRO: new_gal = new KIGFX::CAIRO_GAL( m_options, this, this, this ); break;
492
493 default:
494 wxASSERT( false );
496 // warn about unhandled GAL canvas type, but continue with the fallback option
497
498 case GAL_TYPE_NONE:
499 // KIGFX::GAL is a stub - it actually does cannot display anything,
500 // but prevents code relying on GAL canvas existence from crashing
501 new_gal = new KIGFX::GAL( m_options );
502 break;
503 }
504 }
505 catch( std::runtime_error& err )
506 {
507 // Create a dummy GAL
508 new_gal = new KIGFX::GAL( m_options );
509 aGalType = GAL_TYPE_NONE;
510 DisplayError( m_parent, wxString( err.what() ) );
511 result = false;
512 }
513
514 // trigger update of the gal options in case they differ from the defaults
516
517 delete m_gal;
518 m_gal = new_gal;
519
520 wxSize clientSize = GetClientSize();
521 clientSize.x = std::max( 10, clientSize.x );
522 clientSize.y = std::max( 10, clientSize.y );
523 m_gal->ResizeScreen( clientSize.GetX(), clientSize.GetY() );
524
525 if( grid_size.x > 0 && grid_size.y > 0 )
526 m_gal->SetGridSize( grid_size );
527
528 m_gal->SetGridVisibility( grid_visibility );
529
530 // Make sure the cursor is set on the new canvas
532
533 if( m_painter )
534 m_painter->SetGAL( m_gal );
535
536 if( m_view )
537 {
538 m_view->SetGAL( m_gal );
539 // Note: OpenGL requires reverse draw order when draw priority is enabled
541 }
542
543 m_backend = aGalType;
544
545 return result;
546}
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
Abstract interface for drawing on a 2D-surface.
void SetGridSize(const VECTOR2D &aGridSize)
Set the grid size.
const VECTOR2D & GetGridSize() const
Return the grid size.
bool GetGridVisibility() const
void SetGridVisibility(bool aVisibility)
Set the visibility setting of the grid.
OpenGL implementation of the Graphics Abstraction Layer.
Definition: opengl_gal.h:70
static wxString CheckFeatures(GAL_DISPLAY_OPTIONS &aOptions)
Checks OpenGL features.
Definition: opengl_gal.cpp:360
void ReverseDrawOrder(bool aFlag)
Only takes effect if UseDrawPriority is true.
Definition: view.h:698
void SetGAL(GAL *aGal)
Assign a rendering device for the VIEW.
Definition: view.cpp:489
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:280
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
VECTOR2< double > VECTOR2D
Definition: vector2d.h:617

References _, ARROW, KIGFX::OPENGL_GAL::CheckFeatures(), DisplayError(), DisplayInfoMessage(), GAL_FALLBACK, GAL_TYPE_CAIRO, GAL_TYPE_NONE, GAL_TYPE_OPENGL, KIGFX::GAL::GetGridSize(), KIGFX::GAL::GetGridVisibility(), KI_FALLTHROUGH, m_backend, m_gal, m_options, m_painter, m_parent, m_view, KIGFX::GAL_DISPLAY_OPTIONS::NotifyChanged(), KIGFX::GAL::ResizeScreen(), KIGFX::VIEW::ReverseDrawOrder(), SetCurrentCursor(), KIGFX::VIEW::SetGAL(), KIGFX::GAL::SetGridSize(), KIGFX::GAL::SetGridVisibility(), StopDrawing(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged(), DoRePaint(), EDA_DRAW_PANEL_GAL(), SCH_DRAW_PANEL::SwitchBackend(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), PL_DRAW_PANEL_GAL::SwitchBackend(), PCB_DRAW_PANEL_GAL::SwitchBackend(), and EDA_DRAW_FRAME::SwitchCanvas().

Member Data Documentation

◆ GAL_FALLBACK

◆ m_backend

◆ m_debugOverlay

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

Optional overlay for drawing transient debug objects.

Definition at line 308 of file class_draw_panel_gal.h.

Referenced by ClearDebugOverlay(), and DebugOverlay().

◆ m_drawing

bool EDA_DRAW_PANEL_GAL::m_drawing
protected

True if GAL is currently redrawing the view.

Definition at line 270 of file class_draw_panel_gal.h.

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

◆ m_drawingEnabled

bool EDA_DRAW_PANEL_GAL::m_drawingEnabled
protected

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

Definition at line 273 of file class_draw_panel_gal.h.

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

◆ m_edaFrame

EDA_DRAW_FRAME* EDA_DRAW_PANEL_GAL::m_edaFrame
protected

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protected

Processes and forwards events to tools.

Definition at line 295 of file class_draw_panel_gal.h.

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

◆ m_gal

◆ m_lastRefresh

wxLongLong EDA_DRAW_PANEL_GAL::m_lastRefresh
protected

Last timestamp when the panel was refreshed.

Definition at line 263 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), and Refresh().

◆ m_lostFocus

bool EDA_DRAW_PANEL_GAL::m_lostFocus
protected

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

Referenced by OnEvent(), onLostFocus(), and SetFocus().

◆ m_MouseCapturedLost

bool EDA_DRAW_PANEL_GAL::m_MouseCapturedLost

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(), and KIGFX::WX_VIEW_CONTROLS::onCaptureLost().

◆ m_onShowTimer

wxTimer EDA_DRAW_PANEL_GAL::m_onShowTimer
protected

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

Definition at line 276 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), and onShowTimer().

◆ m_options

KIGFX::GAL_DISPLAY_OPTIONS& EDA_DRAW_PANEL_GAL::m_options
protected

Definition at line 292 of file class_draw_panel_gal.h.

Referenced by SwitchBackend().

◆ m_painter

◆ m_PaintEventCounter

std::unique_ptr<PROF_COUNTER> EDA_DRAW_PANEL_GAL::m_PaintEventCounter

Definition at line 248 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL().

◆ m_parent

wxWindow* EDA_DRAW_PANEL_GAL::m_parent
protected

Pointer to the parent window.

Definition at line 260 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), IsDialogPreview(), and SwitchBackend().

◆ m_pendingRefresh

bool EDA_DRAW_PANEL_GAL::m_pendingRefresh
protected

Is there a redraw event requested?

Definition at line 264 of file class_draw_panel_gal.h.

Referenced by DoRePaint(), EDA_DRAW_PANEL_GAL(), ForceRefresh(), onRefreshTimer(), Refresh(), and StopDrawing().

◆ m_refreshMutex

std::mutex EDA_DRAW_PANEL_GAL::m_refreshMutex
protected

Blocks multiple calls to the draw.

Definition at line 267 of file class_draw_panel_gal.h.

Referenced by DoRePaint().

◆ m_refreshTimer

wxTimer EDA_DRAW_PANEL_GAL::m_refreshTimer
protected

Timer to prevent too-frequent refreshing.

Definition at line 265 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL(), onRefreshTimer(), Refresh(), StartDrawing(), and StopDrawing().

◆ m_statusPopup

wxWindow* EDA_DRAW_PANEL_GAL::m_statusPopup
protected

Definition at line 305 of file class_draw_panel_gal.h.

Referenced by SetStatusPopup(), and StatusPopupHasFocus().

◆ m_stealsFocus

bool EDA_DRAW_PANEL_GAL::m_stealsFocus
protected

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

Definition at line 303 of file class_draw_panel_gal.h.

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

◆ m_view

KIGFX::VIEW* EDA_DRAW_PANEL_GAL::m_view
protected

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

Definition at line 282 of file class_draw_panel_gal.h.

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

◆ m_viewControls

◆ MinRefreshPeriod

const int EDA_DRAW_PANEL_GAL::MinRefreshPeriod = 17
staticprotected

60 FPS.

Definition at line 258 of file class_draw_panel_gal.h.

Referenced by Refresh().


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