KiCad PCB EDA Suite
Loading...
Searching...
No Matches
FOOTPRINT_PREVIEW_PANEL Class Reference

Panel that renders a single footprint via Cairo GAL, meant to be exported through Kiface. More...

#include <footprint_preview_panel.h>

Inheritance diagram for FOOTPRINT_PREVIEW_PANEL:
PCB_DRAW_PANEL_GAL KIWAY_HOLDER FOOTPRINT_PREVIEW_PANEL_BASE EDA_DRAW_PANEL_GAL

Public Types

enum  GAL_TYPE {
  GAL_TYPE_UNKNOWN = -1 , GAL_TYPE_NONE = 0 , GAL_TYPE_OPENGL , GAL_TYPE_CAIRO ,
  GAL_TYPE_LAST
}
 
enum  HOLDER_TYPE { DIALOG , FRAME , PANEL }
 

Public Member Functions

virtual ~FOOTPRINT_PREVIEW_PANEL ()
 
virtual void SetUserUnits (EDA_UNITS aUnits) override
 
virtual void SetPinFunctions (const std::map< wxString, wxString > &aPinFunctions) override
 Set the pin functions from the symbol's netlist.
 
virtual bool DisplayFootprint (const LIB_ID &aFPID) override
 Set the currently displayed footprint.
 
virtual void DisplayFootprints (std::shared_ptr< FOOTPRINT > aFootprintA, std::shared_ptr< FOOTPRINT > aFootprintB) override
 Display a pair of footprints.
 
virtual const KIGFX::COLOR4DGetBackgroundColor () const override
 Get the colors to use in a preview widget to match the preview panel.
 
virtual const KIGFX::COLOR4DGetForegroundColor () const override
 
virtual wxWindow * GetWindow () override
 Get the underlying wxWindow.
 
BOARDGetBoard ()
 
virtual void RefreshAll () override
 Force the redrawing of all contents.
 
const FOOTPRINTGetCurrentFootprint () const
 
void DisplayBoard (BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
 Add all items from the current board to the VIEW, so they can be displayed by GAL.
 
void SetDrawingSheet (DS_PROXY_VIEW_ITEM *aDrawingSheet)
 Sets (or updates) drawing-sheet used by the draw panel.
 
DS_PROXY_VIEW_ITEMGetDrawingSheet () const
 
void UpdateColors ()
 Update the color settings in the painter and GAL.
 
virtual void SetHighContrastLayer (int aLayer) override
 SetHighContrastLayer(), with some extra smarts for PCB.
 
void SetHighContrastLayer (PCB_LAYER_ID aLayer)
 Move the selected layer to the top, so it is displayed above all others.
 
virtual void SetTopLayer (int aLayer) override
 SetTopLayer(), with some extra smarts for PCB.
 
void SetTopLayer (PCB_LAYER_ID aLayer)
 
void SyncLayersVisibility (const BOARD *aBoard)
 Update "visibility" property of each layer of a given BOARD.
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Called when the window is shown for the first time.
 
void OnShow () override
 Called when the window is shown for the first time.
 
bool SwitchBackend (GAL_TYPE aGalType) override
 Force refresh of the ratsnest visual representation.
 
void RedrawRatsnest ()
 Return the bounding box of the view that should be used if model is not valid.
 
BOX2I GetDefaultViewBBox () const override
 Return the bounding box of the view that should be used if model is not valid.
 
virtual KIGFX::PCB_VIEWGetView () const override
 Return a pointer to the #VIEW instance used in the panel.
 
void SetFocus () override
 
bool StatusPopupHasFocus ()
 
void SetStatusPopup (wxWindow *aPopup)
 
GAL_TYPE GetBackend () const
 Return the type of backend currently used by GAL canvas.
 
KIGFX::GALGetGAL () const
 Return a pointer to the GAL instance used in the panel.
 
KIGFX::VIEW_CONTROLSGetViewControls () const
 Return a pointer to the #VIEW_CONTROLS instance used in the panel.
 
virtual void Refresh (bool aEraseBackground=true, const wxRect *aRect=nullptr) override
 
void ForceRefresh ()
 Force a redraw.
 
void RequestRefresh ()
 Make sure a refresh gets done on the next idle event if it hasn't already.
 
void SetEventDispatcher (TOOL_DISPATCHER *aEventDispatcher)
 Set a dispatcher that processes events and forwards them to tools.
 
void StartDrawing ()
 Begin drawing if it was stopped previously.
 
void StopDrawing ()
 Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
 
EDA_DRAW_FRAMEGetParentEDAFrame () const
 Returns parent EDA_DRAW_FRAME, if available or NULL otherwise.
 
bool IsDialogPreview () const
 
void SetStealsFocus (bool aStealsFocus)
 Set whether focus is taken on certain events (mouseover, keys, etc).
 
void SetCurrentCursor (KICURSOR aCursor)
 Set the current cursor shape for this panel.
 
void OnEvent (wxEvent &aEvent)
 Used to forward events to the canvas from popups, etc.
 
bool DoRePaint ()
 Repaint the canvas, and fix scrollbar cursors.
 
std::shared_ptr< KIGFX::VIEW_OVERLAYDebugOverlay ()
 Create an overlay for rendering debug graphics.
 
void ClearDebugOverlay ()
 Clear the contents of the debug overlay and removes it from the VIEW.
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in.
 
bool HasKiway () const
 Safety check before asking for the Kiway reference.
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY.
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*.
 

Static Public Member Functions

static FOOTPRINT_PREVIEW_PANELNew (KIWAY *aKiway, wxWindow *aParent, UNITS_PROVIDER *aUnitsProvider)
 
static KIGFX::VC_SETTINGS GetVcSettings ()
 Gets a populated View Controls settings object dervived from our program settings.
 
static FOOTPRINT_PREVIEW_PANEL_BASECreate (wxWindow *aParent, KIWAY &aKiway)
 Return a footprint preview panel instance via Kiface.
 

Public Attributes

bool m_MouseCapturedLost
 used on wxMSW: true after a wxEVT_MOUSE_CAPTURE_LOST was received false after the mouse is recaptured.
 
std::unique_ptr< PROF_COUNTERm_PaintEventCounter
 

Static Public Attributes

static constexpr GAL_TYPE GAL_FALLBACK = GAL_TYPE_CAIRO
 

Protected Member Functions

void setDefaultLayerOrder ()
 < Reassign layer order to the initial settings.
 
void setDefaultLayerDeps ()
 
virtual void onPaint (wxPaintEvent &WXUNUSED(aEvent))
 
void onSize (wxSizeEvent &aEvent)
 
void onEnter (wxMouseEvent &aEvent)
 
void onLostFocus (wxFocusEvent &aEvent)
 
void onIdle (wxIdleEvent &aEvent)
 
void onRefreshTimer (wxTimerEvent &aEvent)
 
void onShowTimer (wxTimerEvent &aEvent)
 

Protected Attributes

std::unique_ptr< DS_PROXY_VIEW_ITEMm_drawingSheet
 Currently used drawing-sheet.
 
std::unique_ptr< RATSNEST_VIEW_ITEMm_ratsnest
 Ratsnest view item.
 
wxWindow * m_parent
 Pointer to the parent window.
 
EDA_DRAW_FRAMEm_edaFrame
 Parent EDA_DRAW_FRAME (if available)
 
wxLongLong m_lastRepaintStart
 Timestamp of the last repaint start.
 
wxLongLong m_lastRepaintEnd
 Timestamp of the last repaint end.
 
wxTimer m_refreshTimer
 Timer to prevent too-frequent refreshing.
 
std::mutex m_refreshMutex
 Blocks multiple calls to the draw.
 
bool m_drawing
 True if GAL is currently redrawing the view.
 
bool m_drawingEnabled
 Flag that determines if VIEW may use GAL for redrawing the screen.
 
bool m_needIdleRefresh
 True when canvas needs to be refreshed from idle handler.
 
wxTimer m_onShowTimer
 Timer used to execute OnShow() when the window finally appears on the screen.
 
KIGFX::GALm_gal
 Interface for drawing objects on a 2D-surface.
 
KIGFX::VIEWm_view
 Stores view settings (scale, center, etc.) and items to be drawn.
 
std::unique_ptr< KIGFX::PAINTERm_painter
 Contains information about how to draw items using GAL.
 
KIGFX::WX_VIEW_CONTROLSm_viewControls
 Control for VIEW (moving, zooming, etc.)
 
GAL_TYPE m_backend
 Currently used GAL.
 
KIGFX::GAL_DISPLAY_OPTIONSm_options
 
TOOL_DISPATCHERm_eventDispatcher
 Processes and forwards events to tools.
 
bool m_lostFocus
 Flag to indicate that focus should be regained on the next mouse event.
 
bool m_stealsFocus
 Flag to indicate whether the panel should take focus at certain times (when moused over, and on various mouse/key events)
 
wxWindow * m_statusPopup
 
std::shared_ptr< KIGFX::VIEW_OVERLAYm_debugOverlay
 Optional overlay for drawing transient debug objects.
 

Private Member Functions

 FOOTPRINT_PREVIEW_PANEL (KIWAY *aKiway, wxWindow *aParent, UNITS_PROVIDER *aUnitsProvider, std::unique_ptr< KIGFX::GAL_DISPLAY_OPTIONS > aOpts, GAL_TYPE aGalType)
 Create a new panel.
 
void renderFootprint (std::shared_ptr< FOOTPRINT > aFootprint)
 
void fitToCurrentFootprint ()
 

Private Attributes

std::unique_ptr< BOARDm_dummyBoard
 
std::unique_ptr< KIGFX::GAL_DISPLAY_OPTIONSm_displayOptions
 
EDA_UNITS m_userUnits
 
std::map< wxString, wxString > m_pinFunctions
 
std::shared_ptr< FOOTPRINTm_currentFootprint
 
std::shared_ptr< FOOTPRINTm_otherFootprint
 
KIWAYm_kiway
 
HOLDER_TYPE m_type
 

Detailed Description

Panel that renders a single footprint via Cairo GAL, meant to be exported through Kiface.

Definition at line 49 of file footprint_preview_panel.h.

Member Enumeration Documentation

◆ GAL_TYPE

Enumerator
GAL_TYPE_UNKNOWN 

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

GAL_TYPE_NONE 

GAL not used (the legacy wxDC engine is used)

GAL_TYPE_OPENGL 

OpenGL implementation.

GAL_TYPE_CAIRO 

Cairo implementation.

GAL_TYPE_LAST 

Sentinel, do not use as a parameter.

Definition at line 63 of file class_draw_panel_gal.h.

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 41 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ ~FOOTPRINT_PREVIEW_PANEL()

FOOTPRINT_PREVIEW_PANEL::~FOOTPRINT_PREVIEW_PANEL ( )
virtual

◆ FOOTPRINT_PREVIEW_PANEL()

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

Create a new panel.

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

Definition at line 50 of file footprint_preview_panel.cpp.

References UNITS_PROVIDER::GetUserUnits(), m_dummyBoard, m_userUnits, EDA_DRAW_PANEL_GAL::SetStealsFocus(), EDA_DRAW_PANEL_GAL::StartDrawing(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), and PCB_DRAW_PANEL_GAL::UpdateColors().

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

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

◆ Create()

FOOTPRINT_PREVIEW_PANEL_BASE * FOOTPRINT_PREVIEW_PANEL_BASE::Create ( wxWindow *  aParent,
KIWAY aKiway 
)
staticinherited

Return a footprint preview panel instance via Kiface.

May return null if Kiway is not available or there is any error on load.

Definition at line 135 of file footprint_preview_widget.cpp.

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

Referenced by FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET().

◆ DebugOverlay()

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

Create an overlay for rendering debug graphics.

Definition at line 670 of file draw_panel_gal.cpp.

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

◆ DisplayBoard()

◆ DisplayFootprint()

bool FOOTPRINT_PREVIEW_PANEL::DisplayFootprint ( const LIB_ID aFPID)
overridevirtual

◆ DisplayFootprints()

void FOOTPRINT_PREVIEW_PANEL::DisplayFootprints ( std::shared_ptr< FOOTPRINT aFootprintA,
std::shared_ptr< FOOTPRINT aFootprintB 
)
overridevirtual

◆ DoRePaint()

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

Returns
true if the repaint attempt was successful.

Definition at line 197 of file draw_panel_gal.cpp.

References _, KIGFX::GAL::ClearScreen(), KIGFX::VIEW::ClearTargets(), DisplayErrorMessage(), DisplayInfoMessage(), KIGFX::GAL::DrawCursor(), KIGFX::GAL::DrawGrid(), EDA_DRAW_PANEL_GAL::GAL_FALLBACK, 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_lastRepaintEnd, EDA_DRAW_PANEL_GAL::m_lastRepaintStart, EDA_DRAW_PANEL_GAL::m_painter, EDA_DRAW_PANEL_GAL::m_parent, 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(), EDA_DRAW_PANEL_GAL::StartDrawing(), PROF_TIMER::Stop(), EDA_DRAW_PANEL_GAL::StopDrawing(), EDA_DRAW_PANEL_GAL::SwitchBackend(), KIGFX::TARGET_NONCACHED, KIGFX::TARGET_OVERLAY, PROF_TIMER::to_string(), traceDrawPanel, 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::Refresh().

◆ fitToCurrentFootprint()

◆ ForceRefresh()

void EDA_DRAW_PANEL_GAL::ForceRefresh ( )
inherited

Force a redraw.

Definition at line 393 of file draw_panel_gal.cpp.

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_refreshTimer, EDA_DRAW_PANEL_GAL::onIdle(), and EDA_DRAW_PANEL_GAL::onPaint().

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(), DisplayFootprint(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), PCB_SELECTION_TOOL::doSyncSelection(), PAD_TOOL::ExitPadEditMode(), PCB_SELECTION_TOOL::FindItem(), PCB_CONTROL::FlipPcbView(), COMMON_TOOLS::GridOrigin(), SCH_BASE_FRAME::HardRedraw(), SCH_EDIT_FRAME::HardRedraw(), FOOTPRINT_EDIT_FRAME::HardRedraw(), GERBVIEW_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), EDA_DRAW_PANEL_GAL::onRefreshTimer(), SYMBOL_PREVIEW_WIDGET::onSize(), SYMBOL_DIFF_WIDGET::onSlider(), RefreshAll(), 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(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), PCB_SELECTION_TOOL::UnselectAll(), PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PCB_SELECTION_TOOL::zoomFitSelection().

◆ GetBackend()

◆ GetBackgroundColor()

const COLOR4D & FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor ( ) const
overridevirtual

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

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 95 of file footprint_preview_panel.cpp.

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

◆ GetBoard()

BOARD * FOOTPRINT_PREVIEW_PANEL::GetBoard ( )
inline

◆ GetCurrentFootprint()

const FOOTPRINT * FOOTPRINT_PREVIEW_PANEL::GetCurrentFootprint ( ) const
inline

Definition at line 77 of file footprint_preview_panel.h.

References m_currentFootprint.

◆ GetDefaultViewBBox()

BOX2I PCB_DRAW_PANEL_GAL::GetDefaultViewBBox ( ) const
overridevirtualinherited

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

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

Returns
the default bounding box for the panel.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 635 of file pcb_draw_panel_gal.cpp.

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

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), and PANEL_ZONE_GAL::ZoomFitScreen().

◆ GetDrawingSheet()

DS_PROXY_VIEW_ITEM * PCB_DRAW_PANEL_GAL::GetDrawingSheet ( ) const
inlineinherited

◆ GetForegroundColor()

const COLOR4D & FOOTPRINT_PREVIEW_PANEL::GetForegroundColor ( ) const
overridevirtual

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

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(), 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(), FP_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), PL_DRAW_PANEL_GAL::SwitchBackend(), SYMBOL_EDIT_FRAME::SwitchCanvas(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), ZOOM_MENU::update(), PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), and EDA_DRAW_FRAME::UpdateZoomSelectBox().

◆ GetMsgPanelInfo()

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

Called when the window is shown for the first time.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 523 of file pcb_draw_panel_gal.cpp.

References _, BOARD::Footprints(), GetBoard(), BOARD::GetConnectivity(), EDA_DRAW_PANEL_GAL::GetParentEDAFrame(), pad, PCB_VIA_T, and BOARD::Tracks().

◆ GetParentEDAFrame()

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 48 of file kiway_holder.h.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetVcSettings()

KIGFX::VC_SETTINGS EDA_DRAW_PANEL_GAL::GetVcSettings ( )
staticinherited

Gets a populated View Controls settings object dervived from our program settings.

Definition at line 692 of file draw_panel_gal.cpp.

References COMMON_SETTINGS::INPUT::auto_pan, COMMON_SETTINGS::INPUT::auto_pan_acceleration, COMMON_SETTINGS::INPUT::center_on_zoom, COMMON_SETTINGS::INPUT::drag_left, COMMON_SETTINGS::INPUT::drag_middle, COMMON_SETTINGS::INPUT::drag_right, COMMON_SETTINGS::INPUT::focus_follow_sch_pcb, PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::INPUT::horizontal_pan, KIGFX::VC_SETTINGS::m_autoPanAcceleration, KIGFX::VC_SETTINGS::m_autoPanSettingEnabled, KIGFX::VC_SETTINGS::m_dragLeft, KIGFX::VC_SETTINGS::m_dragMiddle, KIGFX::VC_SETTINGS::m_dragRight, KIGFX::VC_SETTINGS::m_focusFollowSchPcb, KIGFX::VC_SETTINGS::m_horizontalPan, COMMON_SETTINGS::m_Input, KIGFX::VC_SETTINGS::m_scrollModifierPanH, KIGFX::VC_SETTINGS::m_scrollModifierPanV, KIGFX::VC_SETTINGS::m_scrollModifierZoom, KIGFX::VC_SETTINGS::m_scrollReversePanH, KIGFX::VC_SETTINGS::m_warpCursor, KIGFX::VC_SETTINGS::m_zoomAcceleration, KIGFX::VC_SETTINGS::m_zoomSpeed, KIGFX::VC_SETTINGS::m_zoomSpeedAuto, Pgm(), COMMON_SETTINGS::INPUT::reverse_scroll_pan_h, COMMON_SETTINGS::INPUT::scroll_modifier_pan_h, COMMON_SETTINGS::INPUT::scroll_modifier_pan_v, COMMON_SETTINGS::INPUT::scroll_modifier_zoom, COMMON_SETTINGS::INPUT::zoom_acceleration, COMMON_SETTINGS::INPUT::zoom_speed, and COMMON_SETTINGS::INPUT::zoom_speed_auto.

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

◆ GetView()

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

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

References EDA_DRAW_PANEL_GAL::m_view.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), PCB_BASE_FRAME::CommonSettingsChanged(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), DIALOG_PRINT_PCBNEW::createPrintout(), DisplayFootprint(), DisplayFootprints(), APPEARANCE_CONTROLS::doApplyLayerPreset(), APPEARANCE_CONTROLS::doApplyViewport(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::enterPadEditMode(), EVT_GRID_CMD_CELL_CHANGED(), DIALOG_DRC::ExcludeMarker(), PAD_TOOL::ExitPadEditMode(), PCB_SELECTION_TOOL::FindItem(), fitToCurrentFootprint(), PCB_BASE_FRAME::FocusOnItems(), GetBackgroundColor(), GetForegroundColor(), PCB_TUNING_PATTERN::GetPreviewItems(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), PCB_BASE_FRAME::HideSolderMask(), PCB_NET_INSPECTOR_PANEL::highlightSelectedNets(), PCB_EDIT_FRAME::ImportSpecctraSession(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_BASE_FRAME::LoadSettings(), NL_PCBNEW_PLUGIN_IMPL::NL_PCBNEW_PLUGIN_IMPL(), PCB_EDIT_FRAME::onBoardLoaded(), DIALOG_PAD_PROPERTIES::onChangePadMode(), PCB_NET_INSPECTOR_PANEL::onClearHighlighting(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), PCB_NET_INSPECTOR_PANEL::onDeleteSelectedNet(), DIALOG_DRC::OnDRCItemRClick(), APPEARANCE_CONTROLS::onLayerVisibilityToggled(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorMode(), PCB_EDIT_FRAME::OnNetlistChanged(), PCB_NET_INSPECTOR_PANEL::OnNetsListContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_NET_INSPECTOR_PANEL::onRenameSelectedNet(), APPEARANCE_CONTROLS::onViewportChanged(), BOARD_EDITOR_CONTROL::PageSettings(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), NET_GRID_TABLE::Rebuild(), PCB_EDIT_FRAME::RebuildAndRefresh(), APPEARANCE_CONTROLS::rebuildNets(), DIALOG_PAD_PROPERTIES::redraw(), PCB_EDIT_FRAME::redrawNetnames(), ZONE_FILLER_TOOL::refresh(), RefreshAll(), refreshCallback(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), renderFootprint(), PCB_EDIT_FRAME::ResolveDRCExclusions(), DIALOG_FOOTPRINT_CHECKER::runChecks(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), FOOTPRINT_VIEWER_FRAME::SaveSettings(), NETS_SEARCH_HANDLER::SelectItems(), RATSNEST_SEARCH_HANDLER::SelectItems(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetBoard(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_EDIT_FRAME::SetElementVisibility(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), PCB_BASE_FRAME::SetPlotSettings(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), PCB_BASE_FRAME::ShowSolderMask(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), NET_GRID_TABLE::updateNetColor(), PANEL_PCBNEW_COLOR_SETTINGS::updatePreview(), PCB_EDIT_FRAME::UpdateUserInterface(), GLOBAL_EDIT_TOOL::ZonesManager(), PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), ~FOOTPRINT_PREVIEW_PANEL(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ GetViewControls()

◆ GetWindow()

wxWindow * FOOTPRINT_PREVIEW_PANEL::GetWindow ( )
overridevirtual

Get the underlying wxWindow.

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 240 of file footprint_preview_panel.cpp.

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const
inlineinherited

Safety check before asking for the Kiway reference.

Returns
true if kiway is non-null

Definition at line 65 of file kiway_holder.h.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ IsDialogPreview()

bool EDA_DRAW_PANEL_GAL::IsDialogPreview ( ) const
inlineinherited

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 55 of file kiway_holder.h.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), BOARD_INSPECTION_TOOL::constructDiffPanel(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SIMULATOR_CONTROL::ExportPlotToSchematic(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), IMPORT_PROJ_HELPER::ImportIndividualFile(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), SAVE_AS_TRAVERSER::OnFile(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), FP_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), COMMON_CONTROL::ShowProjectManager(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), DIALOG_ERC::testErc(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ New()

◆ onEnter()

◆ OnEvent()

◆ onIdle()

void EDA_DRAW_PANEL_GAL::onIdle ( wxIdleEvent &  aEvent)
protectedinherited

◆ onLostFocus()

void EDA_DRAW_PANEL_GAL::onLostFocus ( wxFocusEvent &  aEvent)
protectedinherited

◆ onPaint()

void EDA_DRAW_PANEL_GAL::onPaint ( wxPaintEvent &  WXUNUSEDaEvent)
protectedvirtualinherited

◆ onRefreshTimer()

void EDA_DRAW_PANEL_GAL::onRefreshTimer ( wxTimerEvent &  aEvent)
protectedinherited

◆ OnShow()

◆ onShowTimer()

void EDA_DRAW_PANEL_GAL::onShowTimer ( wxTimerEvent &  aEvent)
protectedinherited

◆ onSize()

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_LIBRARY_MANAGER::addLibrary(), DIALOG_PLOT::applyPlotSettings(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), DIALOG_FOOTPRINT_CHOOSER::build3DCanvas(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesList(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), PANEL_SETUP_NETCLASSES::checkReload(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), EE_INSPECTION_TOOL::DiffSymbol(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_EDITOR_CONTROL::ExportView(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), FIELDS_GRID_TABLE::GetAttr(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SIMULATOR_CONTROL::getDefaultFilename(), SIMULATOR_CONTROL::getDefaultPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_NAVIGATE_TOOL::HypertextCommand(), SCH_EDITOR_CONTROL::ImportFPAssignments(), PANEL_SETUP_RULES::ImportSettingsFrom(), DIALOG_EXPORT_2581::Init(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), FIELDS_GRID_TABLE::initGrid(), SIMULATOR_FRAME_UI::InitWorkbook(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SIMULATOR_FRAME::LoadSettings(), SIMULATOR_FRAME::LoadSimulator(), EDA_BASE_FRAME::LoadWindowState(), SIMULATOR_FRAME_UI::LoadWorkbook(), EDA_3D_VIEWER_FRAME::NewDisplay(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_EXPORT_STEP::onBrowseClicked(), DIALOG_EXPORT_2581::onBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_IMPORT_NETLIST::onBrowseNetlistFiles(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), DIALOG_EXPORT_STEP::onExportButton(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_BASE_FRAME::OnSymChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), FOOTPRINT_EDITOR_CONTROL::OpenDirectory(), FOOTPRINT_EDITOR_CONTROL::OpenWithTextEditor(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), LIBRARY_EDITOR_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), SCH_DRAWING_TOOLS::PlaceSymbol(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), EDA_DRAW_FRAME::PrintDrawingSheet(), KICAD_MANAGER_FRAME::PrintPrjInfo(), SCH_EDITOR_CONTROL::prunePastedSymbolInstances(), CVPCB_MAINFRAME::readNetListAndFpFiles(), APPEARANCE_CONTROLS::rebuildNets(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), SIMULATOR_FRAME::ReloadSimulator(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SIMULATOR_CONTROL::SaveWorkbook(), SIMULATOR_FRAME_UI::SaveWorkbook(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_BASE_FRAME::SelectSymLibTable(), PCB_BASE_FRAME::setFPWatcher(), GERBVIEW_FRAME::SetPageSettings(), SCH_BASE_FRAME::setSymWatcher(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), EE_INSPECTION_TOOL::ShowDatasheet(), PANEL_SYMBOL_CHOOSER::showFootprintFor(), COMMON_CONTROL::ShowHelp(), APPEARANCE_CONTROLS::showNetclass(), SCH_EDITOR_CONTROL::SimProbe(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), EDA_3D_VIEWER_FRAME::takeScreenshot(), DIALOG_ERC::testErc(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_ASSIGN_NETCLASS::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), LIBRARY_EDITOR_CONTROL::UnpinLibrary(), LIB_TREE_MODEL_ADAPTER::UnpinLibrary(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SIMULATOR_FRAME::UpdateTitle(), SIMULATOR_FRAME_UI::UpdateTunerValue(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), and PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL().

◆ RedrawRatsnest()

◆ Refresh()

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

Reimplemented in SCH_PREVIEW_PANEL.

Definition at line 386 of file draw_panel_gal.cpp.

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

Referenced by PCB_EDIT_FRAME::ActivateGalCanvas(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDITOR_CONTROL::AssignFootprints(), COMMON_TOOLS::CenterContents(), GERBVIEW_CONTROL::ClearAllLayers(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), EDIT_TOOL::DeleteItems(), GERBVIEW_CONTROL::DisplayControl(), APPEARANCE_CONTROLS::doApplyLayerPreset(), APPEARANCE_CONTROLS::doApplyViewport(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomToPreset(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), 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(), PCB_NET_INSPECTOR_PANEL::highlightSelectedNets(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PCB_CONTROL::InteractiveDelete(), SCH_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), GERBVIEW_CONTROL::LoadZipfile(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SCH_EDITOR_CONTROL::MarkSimExclusions(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_MIGRATE_BUSES::onAcceptClicked(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_LIB_EDIT_PIN_TABLE::OnCellSelected(), PCB_NET_INSPECTOR_PANEL::onClearHighlighting(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), 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(), SCH_EDIT_FRAME::onNetNavigatorSelection(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), SIMULATOR_FRAME_UI::onPlotClosed(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), PCB_NET_INSPECTOR_PANEL::onRenameSelectedNet(), GERBER_LAYER_WIDGET::OnRenderColorChange(), GERBER_LAYER_WIDGET::OnRenderEnable(), KIGFX::WX_VIEW_CONTROLS::onScroll(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnSelectActiveLayer(), PL_EDITOR_FRAME::OnSelectCoordOriginCorner(), 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_UPDATE_FROM_PCB::OnUpdateClick(), GERBVIEW_CONTROL::OpenJobFile(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), GERBVIEW_CONTROL::OpenZipFile(), PCB_VIEWER_TOOLS::PadDisplayMode(), SCH_EDITOR_CONTROL::PageSetup(), ROUTER_TOOL::performRouting(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), ROUTER_TOOL::prepareInteractive(), PL_EDITOR_FRAME::PrintPage(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_CONTROL::Properties(), SCH_COMMIT::pushSchEdit(), 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(), SCH_BASE_FRAME::RedrawScreen(), ZONE_FILLER_TOOL::refresh(), SCH_PREVIEW_PANEL::Refresh(), refreshCallback(), EDA_DRAW_FRAME::RefreshCanvas(), DIALOG_DRC::refreshEditor(), DIALOG_FOOTPRINT_CHECKER::refreshEditor(), FOOTPRINT_WIZARD_FRAME::RegenerateFootprint(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), GERBVIEW_FRAME::RemapLayers(), SCH_EDITOR_CONTROL::RemapSymbols(), EDIT_TOOL::Remove(), 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(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_SEARCH_HANDLER::SelectItems(), PCB_SEARCH_HANDLER::SelectItems(), NETS_SEARCH_HANDLER::SelectItems(), RATSNEST_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(), GERBVIEW_FRAME::SetLayerDrawPrms(), APPEARANCE_CONTROLS::SetObjectVisible(), PCB_BASE_FRAME::SetPlotSettings(), SYMBOL_VIEWER_FRAME::SetSelectedLibrary(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), SYMBOL_EDIT_FRAME::ShowChangedLanguage(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), APPEARANCE_CONTROLS::showNetclass(), PCB_VIEWER_TOOLS::ShowPadNumbers(), SYMBOL_EDITOR_CONTROL::ShowPinNumbers(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_ERC::testErc(), PCB_VIEWER_TOOLS::TextOutlines(), SCH_EDITOR_CONTROL::ToggleDirectiveLabels(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_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(), DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES(), and DIALOG_LIB_EDIT_PIN_TABLE::~DIALOG_LIB_EDIT_PIN_TABLE().

◆ RefreshAll()

void FOOTPRINT_PREVIEW_PANEL::RefreshAll ( )
overridevirtual

◆ renderFootprint()

◆ RequestRefresh()

void EDA_DRAW_PANEL_GAL::RequestRefresh ( )
inherited

Make sure a refresh gets done on the next idle event if it hasn't already.

Definition at line 380 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_needIdleRefresh.

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

◆ SetCurrentCursor()

void EDA_DRAW_PANEL_GAL::SetCurrentCursor ( KICURSOR  aCursor)
inherited

Set the current cursor shape for this panel.

Definition at line 650 of file draw_panel_gal.cpp.

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

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::finishInteractive(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), ROUTER_TOOL::InlineDrag(), PCB_CONTROL::InteractiveDelete(), DRAWING_TOOL::InteractivePlaceWithPreview(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), EE_SELECTION_TOOL::OnIdle(), PCB_SELECTION_TOOL::OnIdle(), ROUTER_TOOL::performRouting(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), 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()

◆ setDefaultLayerOrder()

void PCB_DRAW_PANEL_GAL::setDefaultLayerOrder ( )
protectedinherited

< Reassign layer order to the initial settings.

Set rendering targets & dependencies for layers.

Definition at line 602 of file pcb_draw_panel_gal.cpp.

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

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

◆ SetDrawingSheet()

void PCB_DRAW_PANEL_GAL::SetDrawingSheet ( DS_PROXY_VIEW_ITEM aDrawingSheet)
inherited

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

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

Definition at line 306 of file pcb_draw_panel_gal.cpp.

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

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

◆ SetEventDispatcher()

void EDA_DRAW_PANEL_GAL::SetEventDispatcher ( TOOL_DISPATCHER aEventDispatcher)
inherited

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

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

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

Definition at line 418 of file draw_panel_gal.cpp.

References EDA_DRAW_PANEL_GAL::m_eventDispatcher.

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

◆ SetFocus()

◆ SetHighContrastLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetHighContrastLayer ( int  aLayer)
inlineoverridevirtualinherited

◆ SetHighContrastLayer() [2/2]

◆ SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateKiWindow().

Definition at line 43 of file kiway_holder.cpp.

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by PCB::IFACE::CreateKiWindow(), InvokePcbLibTableEditor(), and InvokeSchEditSymbolLibTable().

◆ SetPinFunctions()

virtual void FOOTPRINT_PREVIEW_PANEL::SetPinFunctions ( const std::map< wxString, wxString > &  aPinFunctions)
inlineoverridevirtual

Set the pin functions from the symbol's netlist.

This allows us to display them in the corresponding pads.

Parameters
aPinFunctionsa map from pin_number to pin_function

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 58 of file footprint_preview_panel.h.

References m_pinFunctions.

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

References EDA_DRAW_PANEL_GAL::m_stealsFocus.

Referenced by SYMBOL_VIEWER_FRAME::ClickOnSymbolList(), PANEL_EESCHEMA_COLOR_SETTINGS::createSwatches(), FOOTPRINT_PREVIEW_PANEL(), DIALOG_PAD_PROPERTIES::prepareCanvas(), SYMBOL_VIEWER_FRAME::SetSelectedLibrary(), and SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET().

◆ SetTopLayer() [1/2]

virtual void PCB_DRAW_PANEL_GAL::SetTopLayer ( int  aLayer)
inlineoverridevirtualinherited

◆ SetTopLayer() [2/2]

◆ SetUserUnits()

virtual void FOOTPRINT_PREVIEW_PANEL::SetUserUnits ( EDA_UNITS  aUnits)
inlineoverridevirtual

Implements FOOTPRINT_PREVIEW_PANEL_BASE.

Definition at line 57 of file footprint_preview_panel.h.

References m_userUnits.

◆ StartDrawing()

◆ StatusPopupHasFocus()

bool EDA_DRAW_PANEL_GAL::StatusPopupHasFocus ( )
inlineinherited

◆ StopDrawing()

◆ SwitchBackend()

bool PCB_DRAW_PANEL_GAL::SwitchBackend ( GAL_TYPE  aGalType)
overridevirtualinherited

Force refresh of the ratsnest visual representation.

Reimplemented from EDA_DRAW_PANEL_GAL.

Definition at line 619 of file pcb_draw_panel_gal.cpp.

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

Referenced by PCB_DRAW_PANEL_GAL::OnShow().

◆ SyncLayersVisibility()

◆ UpdateColors()

Member Data Documentation

◆ GAL_FALLBACK

◆ m_backend

◆ m_currentFootprint

std::shared_ptr<FOOTPRINT> FOOTPRINT_PREVIEW_PANEL::m_currentFootprint
private

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

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

◆ m_displayOptions

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

Definition at line 97 of file footprint_preview_panel.h.

◆ m_drawing

bool EDA_DRAW_PANEL_GAL::m_drawing
protectedinherited

True if GAL is currently redrawing the view.

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

Referenced by EDA_DRAW_PANEL_GAL::DoRePaint(), EDA_DRAW_PANEL_GAL::ForceRefresh(), and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ m_drawingSheet

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

◆ m_dummyBoard

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

Definition at line 96 of file footprint_preview_panel.h.

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

◆ m_edaFrame

◆ m_eventDispatcher

TOOL_DISPATCHER* EDA_DRAW_PANEL_GAL::m_eventDispatcher
protectedinherited

Processes and forwards events to tools.

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

KIWAY* KIWAY_HOLDER::m_kiway
privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by KIWAY_HOLDER::SetKiway().

◆ m_lastRepaintEnd

wxLongLong EDA_DRAW_PANEL_GAL::m_lastRepaintEnd
protectedinherited

Timestamp of the last repaint end.

Definition at line 277 of file class_draw_panel_gal.h.

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

◆ m_lastRepaintStart

wxLongLong EDA_DRAW_PANEL_GAL::m_lastRepaintStart
protectedinherited

Timestamp of the last repaint start.

Definition at line 276 of file class_draw_panel_gal.h.

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

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

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

◆ m_MouseCapturedLost

bool EDA_DRAW_PANEL_GAL::m_MouseCapturedLost
inherited

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

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

Definition at line 260 of file class_draw_panel_gal.h.

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

◆ m_needIdleRefresh

bool EDA_DRAW_PANEL_GAL::m_needIdleRefresh
protectedinherited

True when canvas needs to be refreshed from idle handler.

Definition at line 289 of file class_draw_panel_gal.h.

Referenced by EDA_DRAW_PANEL_GAL::onIdle(), and EDA_DRAW_PANEL_GAL::RequestRefresh().

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

Referenced by EDA_DRAW_PANEL_GAL::SwitchBackend().

◆ m_otherFootprint

std::shared_ptr<FOOTPRINT> FOOTPRINT_PREVIEW_PANEL::m_otherFootprint
private

Definition at line 101 of file footprint_preview_panel.h.

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

◆ m_painter

◆ m_PaintEventCounter

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

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

std::map<wxString, wxString> FOOTPRINT_PREVIEW_PANEL::m_pinFunctions
private

Definition at line 99 of file footprint_preview_panel.h.

Referenced by renderFootprint(), and SetPinFunctions().

◆ m_ratsnest

std::unique_ptr<RATSNEST_VIEW_ITEM> PCB_DRAW_PANEL_GAL::m_ratsnest
protectedinherited

Ratsnest view item.

Definition at line 120 of file pcb_draw_panel_gal.h.

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), and PCB_DRAW_PANEL_GAL::RedrawRatsnest().

◆ m_refreshMutex

std::mutex EDA_DRAW_PANEL_GAL::m_refreshMutex
protectedinherited

Blocks multiple calls to the draw.

Definition at line 280 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 319 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_type

HOLDER_TYPE KIWAY_HOLDER::m_type
privateinherited

Definition at line 87 of file kiway_holder.h.

◆ m_userUnits

EDA_UNITS FOOTPRINT_PREVIEW_PANEL::m_userUnits
private

Definition at line 98 of file footprint_preview_panel.h.

Referenced by FOOTPRINT_PREVIEW_PANEL(), and SetUserUnits().

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

Referenced by PANEL_ZONE_GAL::ActivateSelectedZone(), 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(), SCH_DRAW_PANEL::GetView(), PCB_DRAW_PANEL_GAL::GetView(), PANEL_ZONE_GAL::OnLayerSelected(), SCH_DRAW_PANEL::OnShow(), GERBVIEW_DRAW_PANEL_GAL::OnShow(), PCB_DRAW_PANEL_GAL::OnShow(), EDA_DRAW_PANEL_GAL::onSize(), PANEL_ZONE_GAL::PANEL_ZONE_GAL(), 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(), 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(), PANEL_ZONE_GAL::ZoomFitScreen(), and EDA_DRAW_PANEL_GAL::~EDA_DRAW_PANEL_GAL().

◆ m_viewControls


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