KiCad PCB EDA Suite
SCH_DRAW_PANEL Class Reference

#include <sch_draw_panel.h>

Inheritance diagram for SCH_DRAW_PANEL:
EDA_DRAW_PANEL_GAL

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

 SCH_DRAW_PANEL (wxWindow *aParentWindow, wxWindowID aWindowId, const wxPoint &aPosition, const wxSize &aSize, KIGFX::GAL_DISPLAY_OPTIONS &aOptions, GAL_TYPE aGalType=GAL_TYPE_OPENGL)
 
 ~SCH_DRAW_PANEL ()
 
void DisplaySymbol (LIB_SYMBOL *aSymbol)
 
void DisplaySheet (SCH_SCREEN *aScreen)
 
bool SwitchBackend (GAL_TYPE aGalType) override
 Switch method of rendering graphics. More...
 
KIGFX::SCH_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...
 
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
 
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)) 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...
 
void setDefaultLayerOrder ()
 Reassign layer order to the initial settings. More...
 
void setDefaultLayerDeps ()
 Set rendering targets & dependencies for layers. More...
 
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...
 
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 37 of file sch_draw_panel.h.

Member Enumeration Documentation

◆ GAL_TYPE

Enumerator
GAL_TYPE_UNKNOWN 

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

GAL_TYPE_NONE 

GAL not used (the legacy wxDC engine is used)

GAL_TYPE_OPENGL 

OpenGL implementation.

GAL_TYPE_CAIRO 

Cairo implementation.

GAL_TYPE_LAST 

Sentinel, do not use as a parameter.

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

◆ SCH_DRAW_PANEL()

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

Definition at line 54 of file sch_draw_panel.cpp.

57 : EDA_DRAW_PANEL_GAL( aParentWindow, aWindowId, aPosition, aSize, aOptions, aGalType )
58{
59 m_view = new KIGFX::SCH_VIEW( true, dynamic_cast<SCH_BASE_FRAME*>( GetParentEDAFrame() ) );
61
63
64 m_painter.reset( new KIGFX::SCH_PAINTER( m_gal ) );
65
66 COLOR_SETTINGS* cs = nullptr;
67
68 if( auto frame = dynamic_cast<SCH_BASE_FRAME*>( GetParentEDAFrame() ) )
69 cs = frame->GetColorSettings();
70 else
71 cs = Pgm().GetSettingsManager().GetColorSettings();
72
73 wxASSERT( cs );
74 m_painter->GetSettings()->LoadColors( cs );
75
76 m_view->SetPainter( m_painter.get() );
77 // This fixes the zoom in and zoom out limits:
79 m_view->SetMirror( false, false );
80
81 // Early initialization of the canvas background color,
82 // before any OnPaint event is fired for the canvas using a wrong bg color
83 auto settings = m_painter->GetSettings();
84 m_gal->SetClearColor( settings->GetBackgroundColor() );
85
88
90
91 // View controls is the first in the event handler chain, so the Tool Framework operates
92 // on updated viewport data.
94
95 SetEvtHandlerEnabled( true );
96 SetFocus();
97 Show( true );
98 Raise();
100}
Color settings are a bit different than most of the settings objects in that there can be more than o...
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.)
void SetFocus() override
void StartDrawing()
Begin drawing if it was stopped previously.
EDA_DRAW_FRAME * GetParentEDAFrame() const
Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
void SetWorldUnitLength(double aWorldUnitLength)
Set the unit length.
void SetClearColor(const COLOR4D &aColor)
Contains methods for drawing schematic-specific items.
Definition: sch_painter.h:134
void SetMirror(bool aMirrorX, bool aMirrorY)
Control the mirroring of the VIEW.
Definition: view.cpp:538
void UpdateAllLayersOrder()
Do everything that is needed to apply the rendering order of layers.
Definition: view.cpp:892
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.
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void setDefaultLayerOrder()
Reassign layer order to the initial settings.
void setDefaultLayerDeps()
Set rendering targets & dependencies for layers.
constexpr double SCH_WORLD_UNIT(1e-7/0.0254)
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111
#define ZOOM_MIN_LIMIT_EESCHEMA
Definition: zoom_defines.h:48
#define ZOOM_MAX_LIMIT_EESCHEMA
Definition: zoom_defines.h:47

References EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), GetView(), EDA_DRAW_PANEL_GAL::m_gal, EDA_DRAW_PANEL_GAL::m_painter, EDA_DRAW_PANEL_GAL::m_view, EDA_DRAW_PANEL_GAL::m_viewControls, Pgm(), SCH_WORLD_UNIT(), KIGFX::GAL::SetClearColor(), setDefaultLayerDeps(), setDefaultLayerOrder(), EDA_DRAW_PANEL_GAL::SetFocus(), KIGFX::VIEW::SetGAL(), KIGFX::VIEW::SetMirror(), KIGFX::VIEW::SetPainter(), KIGFX::VIEW::SetScaleLimits(), KIGFX::GAL::SetWorldUnitLength(), EDA_DRAW_PANEL_GAL::StartDrawing(), KIGFX::VIEW::UpdateAllLayersOrder(), ZOOM_MAX_LIMIT_EESCHEMA, and ZOOM_MIN_LIMIT_EESCHEMA.

◆ ~SCH_DRAW_PANEL()

SCH_DRAW_PANEL::~SCH_DRAW_PANEL ( )

Definition at line 103 of file sch_draw_panel.cpp.

104{
105}

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.

◆ DisplaySheet()

void SCH_DRAW_PANEL::DisplaySheet ( SCH_SCREEN aScreen)

Definition at line 115 of file sch_draw_panel.cpp.

116{
117 GetView()->Clear();
118
119 if( aScreen )
120 GetView()->DisplaySheet( aScreen );
121 else
122 GetView()->Cleanup();
123}
void DisplaySheet(const SCH_SCREEN *aScreen)
Definition: sch_view.cpp:93
void Cleanup()
Definition: sch_view.cpp:65
void Clear()
Remove all items from the view.
Definition: view.cpp:1099

References KIGFX::SCH_VIEW::Cleanup(), KIGFX::VIEW::Clear(), KIGFX::SCH_VIEW::DisplaySheet(), and GetView().

Referenced by SCH_EDIT_FRAME::HardRedraw(), SCH_EDIT_FRAME::SetCurrentSheet(), and SCH_EDIT_FRAME::SetScreen().

◆ DisplaySymbol()

void SCH_DRAW_PANEL::DisplaySymbol ( LIB_SYMBOL aSymbol)

Definition at line 108 of file sch_draw_panel.cpp.

109{
110 GetView()->Clear();
111 GetView()->DisplaySymbol( aSymbol );
112}
void DisplaySymbol(LIB_SYMBOL *aSymbol)
Definition: sch_view.cpp:135

References KIGFX::VIEW::Clear(), KIGFX::SCH_VIEW::DisplaySymbol(), and GetView().

Referenced by SYMBOL_EDIT_FRAME::RebuildView(), and SYMBOL_EDIT_FRAME::SetCurSymbol().

◆ 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->IsInitialized() || !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.
virtual bool IsInitialized() const
Return the initialization status for the canvas.
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
#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::GAL::IsInitialized(), 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()

virtual BOX2I EDA_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
inlinevirtualinherited

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

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

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

KIGFX::SCH_VIEW * SCH_DRAW_PANEL::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 181 of file sch_draw_panel.cpp.

182{
183 return static_cast<KIGFX::SCH_VIEW*>( m_view );
184}

References EDA_DRAW_PANEL_GAL::m_view.

Referenced by SCH_EDIT_FRAME::AddJunction(), SCH_BASE_FRAME::AddToScreen(), SCH_NAVIGATE_TOOL::changeSheet(), SCH_BASE_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::DisplayCurrentSheet(), DisplaySheet(), DisplaySymbol(), EE_INSPECTION_TOOL::ExcludeMarker(), DIALOG_ERC::ExcludeMarker(), SCH_EDIT_FRAME::GetDocumentExtents(), SCH_BASE_FRAME::HardRedraw(), SCH_EDIT_TOOL::Init(), SCH_EDIT_FRAME::KiwayMailIn(), EE_SELECTION_TOOL::Main(), DIALOG_ERC::OnERCItemRClick(), SCH_EDIT_FRAME::OnPageSettingsChange(), SCH_EDITOR_CONTROL::PageSetup(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), SYMBOL_EDIT_FRAME::RebuildView(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_BASE_FRAME::RedrawScreen(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_BASE_FRAME::RemoveFromScreen(), SCH_EDITOR_CONTROL::Revert(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_DRAW_PANEL(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SCH_EDIT_FRAME::ShowAllIntersheetRefs(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), SYMBOL_EDITOR_CONTROL::ShowPinNumbers(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), SCH_BASE_FRAME::SyncView(), SCH_EDIT_FRAME::TestDanglingEnds(), DIALOG_ERC::testErc(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), SCH_BASE_FRAME::UpdateItem(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_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,...
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 SCH_DRAW_PANEL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
overrideprotectedvirtual

Called when the window is shown for the first time.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 212 of file sch_draw_panel.cpp.

213{
214 // The first wxPaintEvent can be fired at startup before the GAL engine is fully initialized
215 // (depending on platforms). Do nothing in this case
216 if( !m_gal->IsInitialized() || !m_gal->IsVisible() )
217 return;
218
220}
virtual void onPaint(wxPaintEvent &WXUNUSED(aEvent))

References KIGFX::GAL::IsInitialized(), KIGFX::GAL::IsVisible(), EDA_DRAW_PANEL_GAL::m_gal, and EDA_DRAW_PANEL_GAL::onPaint().

◆ 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}
wxTimer m_refreshTimer
Timer to prevent too-frequent refreshing.

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 SCH_DRAW_PANEL::OnShow ( )
overrideprotectedvirtual

Called when the window is shown for the first time.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 187 of file sch_draw_panel.cpp.

188{
189 SCH_BASE_FRAME* frame = dynamic_cast<SCH_BASE_FRAME*>( GetParentEDAFrame() );
190
191 try
192 {
193 // Check if the current rendering backend can be properly initialized
195 }
196 catch( const std::runtime_error& e )
197 {
198 DisplayInfoMessage( frame, e.what() );
199
200 // Use fallback if one is available
201 if( GAL_FALLBACK != m_backend )
202 {
204
205 if( frame )
206 frame->ActivateGalCanvas();
207 }
208 }
209}
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
bool SwitchBackend(GAL_TYPE aGalType) override
Switch method of rendering graphics.

References SCH_BASE_FRAME::ActivateGalCanvas(), DisplayInfoMessage(), EDA_DRAW_PANEL_GAL::GAL_FALLBACK, EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_view, 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( ToVECTOR2I( 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( ToVECTOR2I(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
VECTOR2I ToVECTOR2I(const wxSize &aSize)
Definition: vector2wx.h:30

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, ToVECTOR2I(), and KIGFX::VIEW::ToWorld().

Referenced by EDA_DRAW_PANEL_GAL::EDA_DRAW_PANEL_GAL().

◆ 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(), SIMULATOR_FRAME::onPlotClosed(), 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(), SIMULATOR_FRAME::onSimFinished(), 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(), 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(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), 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 SCH_DRAW_PANEL::setDefaultLayerDeps ( )
protected

Set rendering targets & dependencies for layers.

Definition at line 150 of file sch_draw_panel.cpp.

151{
152 // caching makes no sense for Cairo and other software renderers
154
155 for( int i = 0; i < KIGFX::VIEW::VIEW_MAX_LAYERS; i++ )
156 m_view->SetLayerTarget( i, target );
157
158 // Bitmaps are draw on a non cached GAL layer:
160
161 // Some draw layers need specific settings
164
167
170
175
178}
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_DRAWINGSHEET
drawingsheet frame and titleblock
Definition: layer_ids.h:217
@ LAYER_DRAW_BITMAPS
to handle and draw images bitmaps
Definition: layer_ids.h:223
@ LAYER_GP_OVERLAY
general purpose overlay
Definition: layer_ids.h:218
@ LAYER_SELECT_OVERLAY
currently selected items overlay
Definition: layer_ids.h:219
@ LAYER_OP_CURRENTS
Definition: layer_ids.h:388
@ LAYER_SELECTION_SHADOWS
Definition: layer_ids.h:381
@ LAYER_OP_VOLTAGES
Definition: layer_ids.h:387

References EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL, LAYER_DRAW_BITMAPS, LAYER_DRAWINGSHEET, LAYER_GP_OVERLAY, LAYER_OP_CURRENTS, LAYER_OP_VOLTAGES, LAYER_SELECT_OVERLAY, LAYER_SELECTION_SHADOWS, EDA_DRAW_PANEL_GAL::m_backend, EDA_DRAW_PANEL_GAL::m_view, KIGFX::VIEW::SetLayerDisplayOnly(), KIGFX::VIEW::SetLayerTarget(), KIGFX::TARGET_CACHED, KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, and KIGFX::VIEW::VIEW_MAX_LAYERS.

Referenced by SCH_DRAW_PANEL(), and SwitchBackend().

◆ setDefaultLayerOrder()

void SCH_DRAW_PANEL::setDefaultLayerOrder ( )
protected

Reassign layer order to the initial settings.

Definition at line 126 of file sch_draw_panel.cpp.

127{
128 for( int i = 0; (unsigned) i < sizeof( SCH_LAYER_ORDER ) / sizeof( int ); ++i )
129 {
130 int layer = SCH_LAYER_ORDER[i];
131 wxASSERT( layer < KIGFX::VIEW::VIEW_MAX_LAYERS );
132
133 m_view->SetLayerOrder( layer, i );
134 }
135}
void SetLayerOrder(int aLayer, int aRenderingOrder)
Set rendering order of a particular layer.
Definition: view.cpp:634
static const int SCH_LAYER_ORDER[]
Definition: sch_view.h:45

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

Referenced by SCH_DRAW_PANEL().

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

void EDA_DRAW_PANEL_GAL::SetHighContrastLayer ( int  aLayer)
virtualinherited

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

429{
430 // Set display settings for high contrast mode
432
433 SetTopLayer( aLayer );
434
435 rSettings->ClearHighContrastLayers();
436 rSettings->SetLayerIsHighContrast( aLayer );
437
439}
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:761
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(), EDA_DRAW_PANEL_GAL::m_view, KIGFX::RENDER_SETTINGS::SetLayerIsHighContrast(), EDA_DRAW_PANEL_GAL::SetTopLayer(), and KIGFX::VIEW::UpdateAllLayersColor().

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

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

void EDA_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
virtualinherited

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

443{
445 m_view->SetTopLayer( aLayer );
447}
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

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

Referenced by EDA_DRAW_PANEL_GAL::SetHighContrastLayer().

◆ 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 SCH_DRAW_PANEL::SwitchBackend ( GAL_TYPE  aGalType)
overridevirtual

Switch method of rendering graphics.

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

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 138 of file sch_draw_panel.cpp.

139{
140 bool rv = EDA_DRAW_PANEL_GAL::SwitchBackend( aGalType );
143
144 Refresh();
145
146 return rv;
147}

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

Referenced by OnShow().

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(), 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::onRefreshTimer(), and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ 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(), 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_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(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), EDA_DRAW_PANEL_GAL::DoRePaint(), GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL(), GERBVIEW_DRAW_PANEL_GAL::GetDefaultViewBBox(), PCB_DRAW_PANEL_GAL::GetDefaultViewBBox(), EDA_DRAW_PANEL_GAL::GetView(), GetView(), PCB_DRAW_PANEL_GAL::GetView(), OnShow(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), EDA_DRAW_PANEL_GAL::onSize(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), PL_DRAW_PANEL_GAL::PL_DRAW_PANEL_GAL(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), SCH_DRAW_PANEL(), SCH_PREVIEW_PANEL::SCH_PREVIEW_PANEL(), setDefaultLayerDeps(), SCH_PREVIEW_PANEL::setDefaultLayerDeps(), GERBVIEW_DRAW_PANEL_GAL::setDefaultLayerDeps(), PL_DRAW_PANEL_GAL::setDefaultLayerDeps(), PCB_DRAW_PANEL_GAL::setDefaultLayerDeps(), setDefaultLayerOrder(), SCH_PREVIEW_PANEL::setDefaultLayerOrder(), PCB_DRAW_PANEL_GAL::setDefaultLayerOrder(), GERBVIEW_DRAW_PANEL_GAL::SetDrawingSheet(), PCB_DRAW_PANEL_GAL::SetDrawingSheet(), EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), PCB_DRAW_PANEL_GAL::SetHighContrastLayer(), EDA_DRAW_PANEL_GAL::SetTopLayer(), GERBVIEW_DRAW_PANEL_GAL::SetTopLayer(), PL_DRAW_PANEL_GAL::SetTopLayer(), PCB_DRAW_PANEL_GAL::SetTopLayer(), EDA_DRAW_PANEL_GAL::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::~EDA_DRAW_PANEL_GAL().

◆ m_viewControls


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