KiCad PCB EDA Suite
EDA_3D_VIEWER Class Reference

Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard. More...

#include <eda_3d_viewer.h>

Inheritance diagram for EDA_3D_VIEWER:
EDA_3D_BOARD_HOLDER KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER

Public Types

enum  UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
 Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 EDA_3D_VIEWER (KIWAY *aKiway, PCB_BASE_FRAME *aParent, const wxString &aTitle, long style=KICAD_DEFAULT_3D_DRAWFRAME_STYLE)
 
 ~EDA_3D_VIEWER ()
 
PCB_BASE_FRAMEParent () const
 
BOARDGetBoard ()
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
void ReloadRequest ()
 Request reloading the 3D view. More...
 
void NewDisplay (bool aForceImmediateRedraw=false)
 Reload and refresh (rebuild) the 3D scene. More...
 
void Redraw ()
 
BOARD_ADAPTERGetAdapter () override
 
CAMERAGetCurrentCamera () override
 
EDA_3D_CANVASGetCanvas ()
 
bool Set3DColorFromUser (SFVEC4F &aColor, const wxString &aTitle, CUSTOM_COLORS_LIST *aPredefinedColors, bool aAllowOpacityControl=false, KIGFX::COLOR4D aDefaultColor=KIGFX::COLOR4D(1.0, 1.0, 1.0, 1.0))
 Get a SFVEC3D from a color dialog. More...
 
bool Set3DSolderMaskColorFromUser ()
 Set the solder mask color from a set of colors. More...
 
bool Set3DSolderPasteColorFromUser ()
 Set the solder mask color from a set of colors. More...
 
bool Set3DCopperColorFromUser ()
 Set the copper color from a set of colors. More...
 
bool Set3DBoardBodyColorFromUser ()
 Set the copper color from a set of colors. More...
 
bool Set3DSilkScreenColorFromUser ()
 Set the silkscreen color from a set of colors. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Notification that common settings are updated. More...
 
void SynchroniseColoursWithBoard ()
 
virtual bool OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
 Open a project or set of files given by aFileList. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handle command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
 Show this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
virtual void KiwayMailIn (KIWAY_EXPRESS &aEvent)
 Receive KIWAY_EXPRESS messages from other players. More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal () const override
 Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
virtual void ToggleUserUnits ()
 
SETTINGS_MANAGERGetSettingsManager () const
 
virtual SEVERITY GetSeverity (int aErrorCode) const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &aKeyEvent)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
virtual void OnMove (wxMoveEvent &aEvent)
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
FRAME_T GetFrameType () const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
void CreateInfoBar ()
 
void FinishAUIInitialization ()
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
virtual void InstallPreferences (PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
 Allow a frame to load its preference panels (if any) into the preferences dialog. More...
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file. More...
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Load window settings from the given settings object. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Save window settings to the given settings object. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Return a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 Get the configuration base name. More...
 
virtual void SaveProjectSettings ()
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
virtual wxString GetCurrentFileName () const
 Get the full filename + path of the currently opened file in the frame. More...
 
virtual void ReCreateMenuBar ()
 Recreates the menu bar. More...
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
virtual void UpdateStatusBar ()
 Update the status bar information. More...
 
virtual void ShowChangedLanguage ()
 Redraw the menus and what not in current language. More...
 
virtual void ThemeChanged ()
 Process light/dark theme change. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
virtual bool IsContentModified ()
 Get if the contents of the frame have been modified since the last save. More...
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
 
virtual void ClearUndoRedoList ()
 Clear the undo and redo list using ClearUndoORRedoList() More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list. More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors. More...
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual SELECTIONGetCurrentSelection ()
 Get the current selection from the canvas area. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
virtual void DisplayToolMsg (const wxString &msg)
 
bool GetDoImmediateActions () const
 Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
 
MOUSE_DRAG_ACTION GetDragAction () const
 Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
 
bool GetMoveWarpsCursor () const
 Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
 
virtual void RefreshCanvas ()
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

static void HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
 Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g. More...
 

Protected Member Functions

void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 An event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
virtual bool isAutoSaveRequired () const
 Return the auto save status of the application. More...
 
virtual bool doAutoSave ()
 This should be overridden by the derived class to handle the auto save feature. More...
 
virtual bool canCloseWindow (wxCloseEvent &aCloseEvent)
 
virtual void doCloseWindow ()
 
void onSystemColorChange (wxSysColourChangedEvent &aEvent)
 
virtual void unitsChangeRefresh ()
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...
 
void initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 

Static Protected Member Functions

static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 < Points to nested event_loop. NULL means not modal and dismissed. More...
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
int m_undoRedoCountMax
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 Map containing the UI update handlers registered with wx for each action. More...
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 Set by the close window event handler after frames are asked if they can close. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 < Default style flags used for wxAUI toolbars. More...
 

Private Member Functions

void Exit3DFrame (wxCommandEvent &event)
 Called when user press the File->Exit. More...
 
void OnCloseWindow (wxCloseEvent &event)
 
void Process_Special_Functions (wxCommandEvent &event)
 
void OnRenderEngineSelection (wxCommandEvent &event)
 
void OnDisableRayTracing (wxCommandEvent &aEvent)
 
void OnActivate (wxActivateEvent &event)
 
void OnSetFocus (wxFocusEvent &event)
 
void Install3DViewOptionDialog (wxCommandEvent &event)
 
void CreateMenuBar ()
 
void ReCreateMainToolbar ()
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Save common frame parameters to a configuration data file. More...
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void takeScreenshot (wxCommandEvent &event)
 Create a Screenshot of the current 3D view. More...
 
void RenderEngineChanged ()
 RenderEngineChanged - Update toolbar icon and call canvas RenderEngineChanged. More...
 
void refreshRender ()
 
void loadCommonSettings ()
 Load configuration from common settings. More...
 

Private Attributes

wxFileName m_defaultSaveScreenshotFileName
 
ACTION_TOOLBARm_mainToolBar
 
EDA_3D_CANVASm_canvas
 
BOARD_ADAPTER m_boardAdapter
 
CAMERAm_currentCamera
 
TRACK_BALL m_trackBallCamera
 
bool m_disable_ray_tracing
 

Static Private Attributes

static const wxChar * m_logTrace = wxT( "KI_TRACE_EDA_3D_VIEWER" )
 Trace mask used to enable or disable the trace output of this class. More...
 

Detailed Description

Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.

Definition at line 66 of file eda_3d_viewer.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ UNDO_REDO_LIST

Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.

Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.

Parameters
aList= the UNDO_REDO_CONTAINER of commands.
aItemCountnumber of old commands to delete. -1 to remove all old commands this will empty the list of commands.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 525 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ EDA_3D_VIEWER()

EDA_3D_VIEWER::EDA_3D_VIEWER ( KIWAY aKiway,
PCB_BASE_FRAME aParent,
const wxString &  aTitle,
long  style = KICAD_DEFAULT_3D_DRAWFRAME_STYLE 
)

◆ ~EDA_3D_VIEWER()

EDA_3D_VIEWER::~EDA_3D_VIEWER ( )

Definition at line 171 of file eda_3d_viewer.cpp.

172 {
173  m_canvas->SetEventDispatcher( nullptr );
174 
175  m_auimgr.UnInit();
176 
177  // m_canvas delete will be called by wxWidget manager
178  //delete m_canvas;
179  //m_canvas = nullptr;
180 }
wxAuiManager m_auimgr
EDA_3D_CANVAS * m_canvas
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.

References EDA_BASE_FRAME::m_auimgr, m_canvas, and EDA_3D_CANVAS::SetEventDispatcher().

Member Function Documentation

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 418 of file eda_base_frame.cpp.

419 {
420  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
421  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
422 
423  helpMenu->Add( ACTIONS::help );
424  helpMenu->Add( ACTIONS::gettingStarted );
425  helpMenu->Add( ACTIONS::listHotKeys );
426  helpMenu->Add( ACTIONS::getInvolved );
427  helpMenu->Add( ACTIONS::donate );
428  helpMenu->Add( ACTIONS::reportBug );
429 
430  helpMenu->AppendSeparator();
431  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
432 
433  aMenuBar->Append( helpMenu, _( "&Help" ) );
434 }
static TOOL_ACTION listHotKeys
Definition: actions.h:180
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:47
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:183
static TOOL_ACTION donate
Definition: actions.h:181
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:179
static TOOL_ACTION getInvolved
Definition: actions.h:182
static TOOL_ACTION gettingStarted
Definition: actions.h:178

References _, about, ACTIONS::donate, ACTIONS::getInvolved, ACTIONS::gettingStarted, TOOL_MANAGER::GetTool(), ACTIONS::help, ACTIONS::listHotKeys, TOOLS_HOLDER::m_toolManager, and ACTIONS::reportBug.

Referenced by CreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ canCloseWindow()

virtual bool EDA_BASE_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
inlineprotectedvirtualinherited

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 1093 of file eda_base_frame.cpp.

1094 {
1095  SetUserUnits( aUnits );
1097 
1098  wxCommandEvent e( UNITS_CHANGED );
1099  ProcessEventLocally( e );
1100 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

References EDA_BASE_FRAME::SetUserUnits(), and EDA_BASE_FRAME::unitsChangeRefresh().

Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName &  aFileName)
inherited

Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input.

If an auto save file exists for aFileName, the user is prompted if they wish to replace file aFileName with the auto saved file. If the user chooses to replace the file, the backup file of aFileName is removed, aFileName is renamed to the backup file name, and the auto save file is renamed to aFileName. If user chooses to keep the existing version of aFileName, the auto save file is removed.

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 981 of file eda_base_frame.cpp.

982 {
983  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
984 
985  wxFileName autoSaveFileName = aFileName;
986 
987  // Check for auto save file.
988  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
989 
990  wxLogTrace( traceAutoSave,
991  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
992 
993  if( !autoSaveFileName.FileExists() )
994  return;
995 
996  wxString msg = wxString::Format( _(
997  "Well this is potentially embarrassing!\n"
998  "It appears that the last time you were editing the file\n"
999  "\"%s\"\n"
1000  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
1001  aFileName.GetFullName()
1002  );
1003 
1004  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1005  this );
1006 
1007  // Make a backup of the current file, delete the file, and rename the auto save file to
1008  // the file name.
1009  if( response == wxYES )
1010  {
1011  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1012  {
1013  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1014  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1015  }
1016  }
1017  else
1018  {
1019  wxLogTrace( traceAutoSave,
1020  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1021 
1022  // Remove the auto save file when using the previous file as is.
1023  wxRemoveFile( autoSaveFileName.GetFullPath() );
1024  }
1025 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), Pgm(), and traceAutoSave.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( FILE_HISTORY aFileHistory = nullptr)
inherited

Removes all files from the file history.

Parameters
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used

Definition at line 878 of file eda_base_frame.cpp.

879 {
880  if( !aFileHistory )
881  aFileHistory = m_fileHistory;
882 
883  wxASSERT( aFileHistory );
884 
885  aFileHistory->ClearFileHistory();
886 
887  // Update the menubar to update the file history menu
888  if( GetMenuBar() )
889  {
890  ReCreateMenuBar();
891  GetMenuBar()->Refresh();
892  }
893 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References FILE_HISTORY::ClearFileHistory(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), PCB_EDIT_FRAME::OnClearFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().

◆ ClearUndoORRedoList()

virtual void EDA_BASE_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST  aList,
int  aItemCount = -1 
)
inlinevirtualinherited

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

void EDA_3D_VIEWER::CommonSettingsChanged ( bool  aEnvVarsChanged,
bool  aTextVarsChanged 
)
overridevirtual

Notification that common settings are updated.

This would be private (and only called by the Kiway), but we need to do this manually from the PCB frame because the 3D viewer isn't updated via the KIWAY.

Reimplemented from TOOLS_HOLDER.

Definition at line 786 of file eda_3d_viewer.cpp.

787 {
788  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::CommonSettingsChanged" );
789 
790  // Regen menu bars, etc
791  EDA_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
792 
793  // There is no base class that handles toolbars for this frame
795 
797 
798  NewDisplay( true );
799 }
void loadCommonSettings()
Load configuration from common settings.
void ReCreateMainToolbar()
Definition: 3d_toolbar.cpp:36
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
void NewDisplay(bool aForceImmediateRedraw=false)
Reload and refresh (rebuild) the 3D scene.

References EDA_BASE_FRAME::CommonSettingsChanged(), loadCommonSettings(), m_logTrace, NewDisplay(), and ReCreateMainToolbar().

Referenced by PCB_BASE_FRAME::CommonSettingsChanged().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

Reimplemented in SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 719 of file eda_base_frame.cpp.

720 {
721  // KICAD_MANAGER_FRAME overrides this
722  return Kiface().KifaceSettings();
723 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

References Kiface(), and KIFACE_I::KifaceSettings().

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited

Get the configuration base name.

This is usually the name of the frame set by CTOR, except for frames shown in multiple modes in which case the m_configName must be set to the base name so that a single configuration can be used.

Returns
a base name prefix used in Load/Save settings to build the full name of keys used in configuration.

Reimplemented from TOOLS_HOLDER.

Definition at line 339 of file eda_base_frame.h.

340  {
341  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
342  return baseCfgName;
343  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 744 of file eda_base_frame.cpp.

745 {
746 #if defined( __WXOSX_MAC__ )
748 #else
749  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
750 
751  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
752 #endif
753 }
wxAuiManager m_auimgr
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
Specialization of the wxAuiPaneInfo class for KiCad panels.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:73
WX_INFOBAR * m_infoBar

References TOOLS_HOLDER::GetToolCanvas(), EDA_BASE_FRAME::m_auimgr, and EDA_BASE_FRAME::m_infoBar.

◆ CreateMenuBar()

void EDA_3D_VIEWER::CreateMenuBar ( )
private

Definition at line 38 of file 3d_menubar.cpp.

39 {
40  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::CreateMenuBar" );
41 
43  WX_MENUBAR* menuBar = new WX_MENUBAR();
44 
45 
46  //-- File menu -----------------------------------------------------------
47  //
48  ACTION_MENU* fileMenu = new ACTION_MENU( false, tool );
49 
50  fileMenu->Add( _( "Export Current View as PNG..." ),
51  "",
54 
55  fileMenu->Add( _( "Export Current View as JPEG..." ),
56  "",
59 
60  fileMenu->AppendSeparator();
61  fileMenu->AddClose( _( "3D Viewer" ) );
62 
63 
64  //-- Edit menu -------------------------------------------------------
65  // Avoid to translate hotkey modifiers like Ctrl and Shift.
66  // The translated modifiers do not always work
67  ACTION_MENU* editMenu = new ACTION_MENU( false, tool );
68 
69  editMenu->Add( _( "Copy 3D Image" ),
70  "",
72  BITMAPS::copy );
73 
74 
75  //-- View menu -------------------------------------------------------
76  //
77  ACTION_MENU* viewMenu = new ACTION_MENU( false, tool );
78 
79  viewMenu->Add( ACTIONS::zoomIn );
80  viewMenu->Add( ACTIONS::zoomOut );
81  viewMenu->Add( ACTIONS::zoomFitScreen );
82  viewMenu->Add( ACTIONS::zoomRedraw );
83 
84  viewMenu->AppendSeparator();
85  viewMenu->Add( EDA_3D_ACTIONS::rotateXCW );
86  viewMenu->Add( EDA_3D_ACTIONS::rotateXCCW );
87 
88  viewMenu->AppendSeparator();
89  viewMenu->Add( EDA_3D_ACTIONS::rotateYCW );
90  viewMenu->Add( EDA_3D_ACTIONS::rotateYCCW );
91 
92  viewMenu->AppendSeparator();
93  viewMenu->Add( EDA_3D_ACTIONS::rotateZCW );
94  viewMenu->Add( EDA_3D_ACTIONS::rotateZCCW );
95 
96  viewMenu->AppendSeparator();
97  viewMenu->Add( EDA_3D_ACTIONS::moveLeft );
98  viewMenu->Add( EDA_3D_ACTIONS::moveRight );
99  viewMenu->Add( EDA_3D_ACTIONS::moveUp );
100  viewMenu->Add( EDA_3D_ACTIONS::moveDown );
101 
102 
103  //-- Preferences menu -----------------------------------------------
104  //
105  ACTION_MENU* prefsMenu = new ACTION_MENU( false, tool );
106 
107  prefsMenu->Add( _( "Display Options" ), "",
109  BITMAPS::config );
110 
111  prefsMenu->Add( _( "Raytracing" ), "",
115 
116  // Render options submenu
117  ACTION_MENU* optsSubmenu = new ACTION_MENU( false, tool );
118  optsSubmenu->SetTitle( _( "Render Options" ) );
119  optsSubmenu->SetIcon( BITMAPS::options_3drender );
120 
121  // Material properties submenu
122  ACTION_MENU* propsSubmenu = new ACTION_MENU( false, tool );
123  propsSubmenu->SetTitle( _( "Material Properties" ) );
124 
128 
129  optsSubmenu->Add( propsSubmenu );
130 
132 
133  // Raytracing submenu
134  ACTION_MENU* raySubmenu = new ACTION_MENU( false, tool );
135  raySubmenu->SetTitle( _( "Raytracing Options" ) );
136 
144 
145  optsSubmenu->Add( raySubmenu );
146  prefsMenu->Add( optsSubmenu );
147 
148  prefsMenu->AppendSeparator();
149 
150  // Color submenu
151  ACTION_MENU* colorSubmenu = new ACTION_MENU( false, tool );
152  colorSubmenu->SetTitle( _( "Choose Colors" ) );
153  colorSubmenu->SetIcon( BITMAPS::color_materials );
154 
155  colorSubmenu->Add( _( "Background Top Color..." ),
158 
159  colorSubmenu->Add( _( "Background Bottom Color..." ),
162 
163  colorSubmenu->Add( _( "Silkscreen Color..." ),
166 
167  colorSubmenu->Add( _( "Solder Mask Color..." ),
170 
171  colorSubmenu->Add( _( "Solder Paste Color..." ),
174 
175  colorSubmenu->Add( _( "Copper/Surface Finish Color..." ),
178 
179  colorSubmenu->Add( _( "Board Body Color..." ),
182 
183  // Only allow the stackup to be used in the PCB editor, since it isn't editable in the other frames
184  if( Parent()->IsType( FRAME_PCB_EDITOR ) )
185  {
186  colorSubmenu->Add( _( "Get colors from physical stackup" ),
189  }
190 
191  prefsMenu->Add( colorSubmenu );
192 
194 
195  // Grid submenu
196  ACTION_MENU* gridSubmenu = new ACTION_MENU( false, tool );
197  gridSubmenu->SetTitle( _( "3D Grid" ) );
198  gridSubmenu->SetIcon( BITMAPS::grid );
199 
205 
206  prefsMenu->Add( gridSubmenu );
207 
208  prefsMenu->AppendSeparator();
209  prefsMenu->Add( _( "Reset to Default Settings" ), ID_MENU3D_RESET_DEFAULTS, BITMAPS::tools );
210 
211 #ifdef __APPLE__ // Note: will get moved to Apple menu by wxWidgets
212  prefsMenu->Add( _( "Preferences..." ) + "\tCtrl+,",
213  _( "Show preferences for all open tools" ),
214  wxID_PREFERENCES,
216 #endif
217 
218  //-- Menubar -------------------------------------------------------------
219  //
220  menuBar->Append( fileMenu, _( "&File" ) );
221  menuBar->Append( editMenu, _( "&Edit" ) );
222  menuBar->Append( viewMenu, _( "&View" ) );
223  menuBar->Append( prefsMenu, _( "&Preferences" ) );
224  AddStandardHelpMenu( menuBar );
225 
226  SetMenuBar( menuBar );
227 }
static TOOL_ACTION rotateXCW
Definition: 3d_actions.h:47
static TOOL_ACTION show10mmGrid
Definition: 3d_actions.h:70
static TOOL_ACTION materialCAD
Definition: 3d_actions.h:77
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:47
static TOOL_ACTION showBoundingBoxes
Definition: 3d_actions.h:83
void SetIcon(BITMAPS aIcon)
Assign an icon for the entry.
Definition: action_menu.cpp:72
static TOOL_ACTION zoomFitScreen
Definition: actions.h:99
static TOOL_ACTION showRefractions
Definition: 3d_actions.h:87
Wrapper around a wxMenuBar object that prevents the accelerator table from being used.
Definition: wx_menubar.h:45
static TOOL_ACTION antiAliasing
Definition: 3d_actions.h:89
static TOOL_ACTION moveLeft
Definition: 3d_actions.h:53
static TOOL_ACTION show5mmGrid
Definition: 3d_actions.h:71
static TOOL_ACTION rotateYCW
Definition: 3d_actions.h:49
void AddStandardHelpMenu(wxMenuBar *aMenuBar)
Adds the standard KiCad help menu to the menubar.
static TOOL_ACTION rotateXCCW
Definition: 3d_actions.h:48
static TOOL_ACTION materialNormal
Definition: 3d_actions.h:75
static TOOL_ACTION rotateZCCW
Definition: 3d_actions.h:52
static TOOL_ACTION addFloor
Definition: 3d_actions.h:86
static TOOL_ACTION showAxis
Definition: 3d_actions.h:93
Handle actions that are shared between different applications.
static TOOL_ACTION rotateZCW
Definition: 3d_actions.h:51
static TOOL_ACTION materialDiffuse
Definition: 3d_actions.h:76
static TOOL_ACTION moveDown
Definition: 3d_actions.h:56
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
static TOOL_ACTION proceduralTextures
Definition: 3d_actions.h:85
static constexpr bool CHECK
Definition: action_menu.h:182
static TOOL_ACTION show2_5mmGrid
Definition: 3d_actions.h:72
static TOOL_ACTION show1mmGrid
Definition: 3d_actions.h:73
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
void SetTitle(const wxString &aTitle) override
Set title for the menu.
Definition: action_menu.cpp:90
bool IsType(FRAME_T aType) const
static TOOL_ACTION rotateYCCW
Definition: 3d_actions.h:50
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION zoomRedraw
Definition: actions.h:93
static TOOL_ACTION postProcessing
Definition: 3d_actions.h:90
wxMenuItem * Add(const wxString &aLabel, int aId, BITMAPS aIcon)
Add a wxWidgets-style entry to the menu.
PCB_BASE_FRAME * Parent() const
Definition: eda_3d_viewer.h:74
static TOOL_ACTION moveUp
Definition: 3d_actions.h:55
static TOOL_ACTION noGrid
Definition: 3d_actions.h:69
static TOOL_ACTION zoomIn
Definition: actions.h:94
static TOOL_ACTION zoomOut
Definition: actions.h:95
static TOOL_ACTION showReflections
Definition: 3d_actions.h:88
static TOOL_ACTION renderShadows
Definition: 3d_actions.h:84
static TOOL_ACTION moveRight
Definition: 3d_actions.h:54
void AddClose(wxString aAppname="")
Add a standard close item to the menu with the accelerator key CTRL-W.

References _, ACTION_MENU::Add(), ACTION_MENU::AddClose(), EDA_3D_ACTIONS::addFloor, EDA_BASE_FRAME::AddStandardHelpMenu(), EDA_3D_ACTIONS::antiAliasing, ACTION_MENU::CHECK, color_materials, config, copy, export_file, export_png, FRAME_PCB_EDITOR, TOOL_MANAGER::GetTool(), grid, ID_MENU3D_BGCOLOR_BOTTOM, ID_MENU3D_BGCOLOR_TOP, ID_MENU3D_COPPER_COLOR, ID_MENU3D_PCB_BODY_COLOR, ID_MENU3D_RESET_DEFAULTS, ID_MENU3D_SILKSCREEN_COLOR, ID_MENU3D_SOLDERMASK_COLOR, ID_MENU3D_SOLDERPASTE_COLOR, ID_MENU3D_STACKUP_COLORS, ID_MENU_SCREENCOPY_JPEG, ID_MENU_SCREENCOPY_PNG, ID_RENDER_CURRENT_VIEW, ID_TOOL_SCREENCOPY_TOCLIBBOARD, ID_TOOL_SET_VISIBLE_ITEMS, INVALID_BITMAP, EDA_BASE_FRAME::IsType(), m_logTrace, TOOLS_HOLDER::m_toolManager, EDA_3D_ACTIONS::materialCAD, EDA_3D_ACTIONS::materialDiffuse, EDA_3D_ACTIONS::materialNormal, EDA_3D_ACTIONS::moveDown, EDA_3D_ACTIONS::moveLeft, EDA_3D_ACTIONS::moveRight, EDA_3D_ACTIONS::moveUp, EDA_3D_ACTIONS::noGrid, options_3drender, Parent(), EDA_3D_ACTIONS::postProcessing, preference, EDA_3D_ACTIONS::proceduralTextures, EDA_3D_ACTIONS::renderShadows, EDA_3D_ACTIONS::rotateXCCW, EDA_3D_ACTIONS::rotateXCW, EDA_3D_ACTIONS::rotateYCCW, EDA_3D_ACTIONS::rotateYCW, EDA_3D_ACTIONS::rotateZCCW, EDA_3D_ACTIONS::rotateZCW, ACTION_MENU::SetIcon(), ACTION_MENU::SetTitle(), EDA_3D_ACTIONS::show10mmGrid, EDA_3D_ACTIONS::show1mmGrid, EDA_3D_ACTIONS::show2_5mmGrid, EDA_3D_ACTIONS::show5mmGrid, EDA_3D_ACTIONS::showAxis, EDA_3D_ACTIONS::showBoundingBoxes, EDA_3D_ACTIONS::showReflections, EDA_3D_ACTIONS::showRefractions, tools, ACTIONS::zoomFitScreen, ACTIONS::zoomIn, ACTIONS::zoomOut, and ACTIONS::zoomRedraw.

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const
inherited

Definition at line 99 of file tools_holder.cpp.

100 {
101  if( m_toolStack.empty() )
102  return ACTIONS::selectionTool.GetName();
103  else
104  return m_toolStack.back();
105 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:163
static TOOL_ACTION selectionTool
Definition: actions.h:156

References TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

◆ DismissModal()

void KIWAY_PLAYER::DismissModal ( bool  aRetVal,
const wxString &  aResult = wxEmptyString 
)
inherited

Definition at line 161 of file kiway_player.cpp.

162 {
163  m_modal_ret_val = aRetVal;
164  m_modal_string = aResult;
165 
166  if( m_modal_loop )
167  {
168  m_modal_loop->Exit();
169  m_modal_loop = nullptr; // this marks it as dismissed.
170  }
171 
172  Show( false );
173 }
bool m_modal_ret_val
Definition: kiway_player.h:199
wxString m_modal_string
Definition: kiway_player.h:198
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:196

References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), and SYMBOL_VIEWER_FRAME::FinishModal().

◆ DisplayToolMsg()

virtual void TOOLS_HOLDER::DisplayToolMsg ( const wxString &  msg)
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 122 of file tools_holder.h.

122 {};

Referenced by TOOLS_HOLDER::PopTool(), and TOOLS_HOLDER::PushTool().

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

This should be overridden by the derived class to handle the auto save feature.

Returns
true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 301 of file eda_base_frame.cpp.

302 {
303  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
304 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

◆ Exit3DFrame()

void EDA_3D_VIEWER::Exit3DFrame ( wxCommandEvent &  event)
private

Called when user press the File->Exit.

Definition at line 286 of file eda_3d_viewer.cpp.

287 {
288  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::Exit3DFrame" );
289 
290  Close( true );
291 }
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.

References m_logTrace.

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 756 of file eda_base_frame.cpp.

757 {
758 #if defined( __WXOSX_MAC__ )
759  m_auimgr.Update();
760 #else
761  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
762  // hiding it.
763  m_auimgr.Update();
764 
765  // We don't want the infobar displayed right away
766  m_auimgr.GetPane( "InfoBar" ).Hide();
767  m_auimgr.Update();
768 #endif
769 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetAdapter()

BOARD_ADAPTER& EDA_3D_VIEWER::GetAdapter ( )
inlineoverridevirtual

Implements EDA_3D_BOARD_HOLDER.

Definition at line 106 of file eda_3d_viewer.h.

106 { return m_boardAdapter; }
BOARD_ADAPTER m_boardAdapter

References m_boardAdapter.

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited
Returns
the string to prepend to a file name for automatic save.

Definition at line 583 of file eda_base_frame.h.

584  {
585  return wxT( "_autosave-" );
586  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::OnExportSTEP(), SCH_EDIT_FRAME::SaveEEFile(), and PCB_EDIT_FRAME::SavePcbFile().

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 190 of file eda_base_frame.h.

190 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetBoard()

BOARD* EDA_3D_VIEWER::GetBoard ( )
inline

Definition at line 76 of file eda_3d_viewer.h.

76 { return Parent()->GetBoard(); }
PCB_BASE_FRAME * Parent() const
Definition: eda_3d_viewer.h:74
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), and Parent().

Referenced by ReloadRequest(), and SynchroniseColoursWithBoard().

◆ GetCanvas()

EDA_3D_CANVAS* EDA_3D_VIEWER::GetCanvas ( )
inline

Definition at line 109 of file eda_3d_viewer.h.

109 { return m_canvas; }
EDA_3D_CANVAS * m_canvas

References m_canvas.

◆ GetCurrentCamera()

CAMERA& EDA_3D_VIEWER::GetCurrentCamera ( )
inlineoverridevirtual

Implements EDA_3D_BOARD_HOLDER.

Definition at line 107 of file eda_3d_viewer.h.

107 { return m_currentCamera; }
CAMERA & m_currentCamera

References m_currentCamera.

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const
inlinevirtualinherited

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns
the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 420 of file eda_base_frame.h.

420 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

virtual SELECTION& TOOLS_HOLDER::GetCurrentSelection ( )
inlinevirtualinherited

Get the current selection from the canvas area.

Returns
the current selection.

Reimplemented in PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_VIEWER_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, DISPLAY_FOOTPRINTS_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 102 of file tools_holder.h.

103  {
104  return m_dummySelection;
105  }
SELECTION m_dummySelection
Definition: tools_holder.h:161

References TOOLS_HOLDER::m_dummySelection.

Referenced by EDA_BASE_FRAME::HandleUpdateUIEvent(), and ACTION_MANAGER::RunHotKey().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

Indicate that hotkeys should perform an immediate action even if another tool is currently active.

If false, the first hotkey should select the relevant tool.

Definition at line 128 of file tools_holder.h.

128 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:170

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const
inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 134 of file tools_holder.h.

134 { return m_dragAction; }
MOUSE_DRAG_ACTION m_dragAction
Definition: tools_holder.h:174

References TOOLS_HOLDER::m_dragAction.

Referenced by PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().

◆ GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory ( int  cmdId,
const wxString &  type,
FILE_HISTORY aFileHistory = nullptr 
)
inherited

Fetches the file name from the file history list.

This removes the selected file, if this file does not exist. The menu is also updated, if #FILE_HISTORY::UseMenu was called at initialization time.

Parameters
cmdIdThe command ID associated with the aFileHistory object.
typePlease document me!
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used
Returns
a wxString containing the selected filename

Definition at line 838 of file eda_base_frame.cpp.

840 {
841  if( !aFileHistory )
842  aFileHistory = m_fileHistory;
843 
844  wxASSERT( aFileHistory );
845 
846  int baseId = aFileHistory->GetBaseId();
847 
848  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
849 
850  unsigned i = cmdId - baseId;
851 
852  if( i < aFileHistory->GetCount() )
853  {
854  wxString fn = aFileHistory->GetHistoryFile( i );
855 
856  if( wxFileName::FileExists( fn ) )
857  return fn;
858  else
859  {
860  wxString msg = wxString::Format( _( "File \"%s\" was not found." ), fn );
861  wxMessageBox( msg );
862 
863  aFileHistory->RemoveFileFromHistory( i );
864  }
865  }
866 
867  // Update the menubar to update the file history menu
868  if( GetMenuBar() )
869  {
870  ReCreateMenuBar();
871  GetMenuBar()->Refresh();
872  }
873 
874  return wxEmptyString;
875 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References _, Format(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

Get the frame's main file history.

Returns
the main file history

Definition at line 404 of file eda_base_frame.h.

405  {
406  return *m_fileHistory;
407  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const
inlineinherited

Definition at line 193 of file eda_base_frame.h.

193 { return m_ident; }

References EDA_BASE_FRAME::m_ident.

◆ GetInfoBar()

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 563 of file eda_base_frame.h.

563 { return m_undoRedoCountMax; }

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

Indicate that a move operation should warp the mouse pointer to the origin of the move object.

This improves snapping, but some users are allergic to mouse warping.

Definition at line 140 of file tools_holder.h.

140 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:176

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::InlineDrag(), SYMBOL_EDITOR_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::Main().

◆ GetMruPath()

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetSettingsManager()

◆ GetSeverity()

virtual SEVERITY EDA_BASE_FRAME::GetSeverity ( int  aErrorCode) const
inlinevirtualinherited

Reimplemented in PCB_BASE_FRAME.

Definition at line 130 of file eda_base_frame.h.

References RPT_SEVERITY_UNDEFINED.

Referenced by RC_TREE_MODEL::GetValue().

◆ GetToolCanvas()

wxWindow* EDA_3D_VIEWER::GetToolCanvas ( ) const
inlineoverridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 78 of file eda_3d_viewer.h.

78 { return m_canvas; }
EDA_3D_CANVAS * m_canvas

References m_canvas.

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

55 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::doGlobalDeletions(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_NAVIGATE_TOOL::HypertextCommand(), ROUTER_TOOL::InlineBreakTrack(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::LoadPart(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), SYMBOL_TREE_PANE::onComponentSelected(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), DIALOG_INSPECTION_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), SIM_PLOT_FRAME::onProbe(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), DIALOG_FIELDS_EDITOR_GLOBAL::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_3D_VIEW_OPTIONS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST::~DIALOG_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:79

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const
inlinevirtualinherited

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 114 of file eda_base_frame.h.

115  {
116  return m_userUnits;
117  }
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References EDA_BASE_FRAME::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), BOARD_INSPECTION_TOOL::getItemDescription(), LIB_ARC::GetMsgPanelInfo(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), PL_EDITOR_LAYOUT::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), ALIGNED_DIMENSION::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_NET_INSPECTOR::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_PREV_3D::PANEL_PREV_3D(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), GERBVIEW_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PL_EDITOR_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), and DRC_TOOL::userUnits().

◆ GetWindowSettings()

WINDOW_SETTINGS * EDA_BASE_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
virtualinherited

Return a pointer to the window settings for this frame.

By default, points to aCfg->m_Window for top-level frames.

Parameters
aCfgis this frame's config object

Reimplemented in SIM_PLOT_FRAME, FOOTPRINT_WIZARD_FRAME, FOOTPRINT_VIEWER_FRAME, SYMBOL_VIEWER_FRAME, and DISPLAY_FOOTPRINTS_FRAME.

Definition at line 713 of file eda_base_frame.cpp.

714 {
715  return &aCfg->m_Window;
716 }
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181

References APP_SETTINGS_BASE::m_Window.

Referenced by EDA_BASE_FRAME::LoadSettings(), EDA_DRAW_FRAME::LoadSettings(), EDA_BASE_FRAME::SaveSettings(), and EDA_DRAW_FRAME::SaveSettings().

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )
inherited

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns
the undecorated window size

Definition at line 1125 of file eda_base_frame.cpp.

1126 {
1127 #ifdef __WXGTK__
1128  // GTK includes the window decorations in the normal GetSize call,
1129  // so we have to use a GTK-specific sizing call that returns the
1130  // non-decorated window size.
1131  int width = 0;
1132  int height = 0;
1133  GTKDoGetSize( &width, &height );
1134 
1135  wxSize winSize( width, height );
1136 #else
1137  wxSize winSize = GetSize();
1138 #endif
1139 
1140  return winSize;
1141 }

Referenced by EDA_BASE_FRAME::OnMaximize(), and EDA_BASE_FRAME::SaveWindowSettings().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

Update the UI in response to a change in the system colors.

Definition at line 1144 of file eda_base_frame.cpp.

1145 {
1146  // Update the icon theme when the system theme changes and update the toolbars
1147  if( GetBitmapStore()->ThemeChanged() )
1148  ThemeChanged();
1149 
1150  // This isn't handled by ThemeChanged()
1151  if( GetMenuBar() )
1152  {
1153  // For icons in menus, icon scaling & hotkeys
1154  ReCreateMenuBar();
1155  GetMenuBar()->Refresh();
1156  }
1157 }
virtual void ThemeChanged()
Process light/dark theme change.
virtual void ReCreateMenuBar()
Recreates the menu bar.
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:92

References GetBitmapStore(), EDA_BASE_FRAME::ReCreateMenuBar(), and EDA_BASE_FRAME::ThemeChanged().

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

void EDA_BASE_FRAME::HandleUpdateUIEvent ( wxUpdateUIEvent &  aEvent,
EDA_BASE_FRAME aFrame,
ACTION_CONDITIONS  aCond 
)
staticinherited

Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.

enabled, checked, etc.).

Parameters
aEventis the wxUpdateUIEvent to be processed.
aFrameis the frame to get the selection from
aCondare the #UI SELECTION_CONDITIONS used

Definition at line 350 of file eda_base_frame.cpp.

352 {
353  bool checkRes = false;
354  bool enableRes = true;
355  bool showRes = true;
356  SELECTION& selection = aFrame->GetCurrentSelection();
357 
358  try
359  {
360  checkRes = aCond.checkCondition( selection );
361  enableRes = aCond.enableCondition( selection );
362  showRes = aCond.showCondition( selection );
363  }
364  catch( std::exception& )
365  {
366  // Something broke with the conditions, just skip the event.
367  aEvent.Skip();
368  return;
369  }
370 
371  aEvent.Enable( enableRes );
372  aEvent.Show( showRes );
373 
374  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
375  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
376 #if wxCHECK_VERSION( 3, 1, 5 )
377  if( aEvent.IsCheckable() )
378  aEvent.Check( checkRes );
379 #else
380  bool canCheck = true;
381 
382  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to check to
383  // see if they can be and can't just universally apply a check in this event.
384  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
385  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
386 
387  if( canCheck )
388  aEvent.Check( checkRes );
389 #endif
390 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:102

References ACTION_CONDITIONS::checkCondition, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 732 of file eda_base_frame.cpp.

733 {
734  return Kiface().GetHelpFileName();
735 }
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
Definition: kiface_i.h:109
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

References KIFACE_I::GetHelpFileName(), and Kiface().

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile ( std::map< std::string, TOOL_ACTION * >  aActionMap,
const wxString &  aDefaultShortname 
)
inherited

Prompt the user for a hotkey file to read, and read it.

Parameters
aActionMapcurrent hotkey map (over which the imported hotkeys will be applied).
aDefaultShortnamea default short name (extension not needed) like Eeschema, KiCad...

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )
protectedinherited

Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.

This is useful in sub-applications to pass the event up to a non-owning window.

Definition at line 1035 of file eda_base_frame.cpp.

1036 {
1037  wxAcceleratorEntry entries[1];
1038  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1039  wxAcceleratorTable accel( 1, entries );
1040  SetAcceleratorTable( accel );
1041 }

◆ Install3DViewOptionDialog()

void EDA_3D_VIEWER::Install3DViewOptionDialog ( wxCommandEvent &  event)
private

Definition at line 59 of file dialog_3D_view_option.cpp.

60 {
61  DIALOG_3D_VIEW_OPTIONS dlg( this );
62 
63  if( dlg.ShowModal() == wxID_OK )
64  {
65  NewDisplay( true );
66  }
67 }
void NewDisplay(bool aForceImmediateRedraw=false)
Reload and refresh (rebuild) the 3D scene.

References NewDisplay().

◆ InstallPreferences()

virtual void EDA_BASE_FRAME::InstallPreferences ( PAGED_DIALOG ,
PANEL_HOTKEYS_EDITOR  
)
inlinevirtualinherited

Allow a frame to load its preference panels (if any) into the preferences dialog.

Parameters
aParenta paged dialog into which the preference panels should be installed.

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 279 of file eda_base_frame.h.

279 { }

Referenced by EDA_BASE_FRAME::OnPreferences().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

Override this function if your derived frame supports automatic file saving.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 598 of file eda_base_frame.h.

598 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( )
virtualinherited

Get if the contents of the frame have been modified since the last save.

Returns
true if the contents of the frame have not been saved

Reimplemented in SCH_EDIT_FRAME, CVPCB_MAINFRAME, PL_EDITOR_FRAME, PCB_EDIT_FRAME, SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 1028 of file eda_base_frame.cpp.

1029 {
1030  // This function should be overridden in child classes
1031  return false;
1032 }

Referenced by EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

bool TOOLS_HOLDER::IsCurrentTool ( const TOOL_ACTION aAction) const
inherited

Definition at line 108 of file tools_holder.cpp.

109 {
110  if( m_toolStack.empty() )
111  return &aAction == &ACTIONS::selectionTool;
112  else
113  return m_toolStack.back() == aAction.GetName();
114 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:163
static TOOL_ACTION selectionTool
Definition: actions.h:156
const std::string & GetName() const
Return name of the action.
Definition: tool_action.h:83

References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by BOARD_INSPECTION_TOOL::HighlightNetTool(), SCH_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )
inherited
Returns
false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). True if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 155 of file kiway_player.cpp.

156 {
157  return !m_modal_loop;
158 }
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:196

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), and FOOTPRINT_WIZARD_FRAME::doCloseWindow().

◆ IsModal()

bool KIWAY_PLAYER::IsModal ( ) const
inlineoverridevirtualinherited

Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame.

In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing.

Reimplemented from EDA_BASE_FRAME.

Definition at line 170 of file kiway_player.h.

170 { return m_modal; }

References KIWAY_PLAYER::m_modal.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), KIWAY_PLAYER::ShowModal(), and SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME().

◆ IsType()

bool EDA_BASE_FRAME::IsType ( FRAME_T  aType) const
inlineinherited

Definition at line 192 of file eda_base_frame.h.

192 { return m_ident == aType; }

References EDA_BASE_FRAME::m_ident.

Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOARD_COMMIT::BOARD_COMMIT(), CreateMenuBar(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySheet(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), COMMON_TOOLS::doZoomFit(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), FOOTPRINT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), DIALOG_EDIT_ONE_FIELD::init(), PCB_SELECTION_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), CONVERT_TOOL::LinesToPoly(), PCB_SELECTION_TOOL::Main(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_CONTROL::Paste(), SYMBOL_EDITOR_CONTROL::PinLibrary(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SYMBOL_EDITOR_CONTROL::Revert(), SYMBOL_EDITOR_CONTROL::Save(), APPEARANCE_CONTROLS::setVisibleObjects(), EE_INSPECTION_TOOL::ShowDatasheet(), EE_INSPECTION_TOOL::ShowERCDialog(), SYMBOL_EDITOR_CONTROL::ToggleSymbolTree(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

◆ IsWritable()

bool EDA_BASE_FRAME::IsWritable ( const wxFileName &  aFileName)
inherited

Checks if aFileName can be written.

The function performs a number of tests on aFileName to verify that it can be saved. If aFileName defines a path with no file name, them the path is tested for user write permission. If aFileName defines a file name that does not exist in the path, the path is tested for user write permission. If aFileName defines a file that already exits, the file name is tested for user write permissions.

Note
The file name path must be set or an assertion will be raised on debug builds and return false on release builds.
Parameters
aFileNameThe full path and/or file name of the file to test.
Returns
False if aFileName cannot be written.

Definition at line 937 of file eda_base_frame.cpp.

938 {
939  wxString msg;
940  wxFileName fn = aFileName;
941 
942  // Check for absence of a file path with a file name. Unfortunately KiCad
943  // uses paths relative to the current project path without the ./ part which
944  // confuses wxFileName. Making the file name path absolute may be less than
945  // elegant but it solves the problem.
946  if( fn.GetPath().IsEmpty() && fn.HasName() )
947  fn.MakeAbsolute();
948 
949  wxCHECK_MSG( fn.IsOk(), false,
950  wxT( "File name object is invalid. Bad programmer!" ) );
951  wxCHECK_MSG( !fn.GetPath().IsEmpty(), false,
952  wxT( "File name object path <" ) + fn.GetFullPath() +
953  wxT( "> is not set. Bad programmer!" ) );
954 
955  if( fn.IsDir() && !fn.IsDirWritable() )
956  {
957  msg.Printf( _( "You do not have write permissions to folder \"%s\"." ),
958  fn.GetPath() );
959  }
960  else if( !fn.FileExists() && !fn.IsDirWritable() )
961  {
962  msg.Printf( _( "You do not have write permissions to save file \"%s\" to folder \"%s\"." ),
963  fn.GetFullName(), fn.GetPath() );
964  }
965  else if( fn.FileExists() && !fn.IsFileWritable() )
966  {
967  msg.Printf( _( "You do not have write permissions to save file \"%s\"." ),
968  fn.GetFullPath() );
969  }
970 
971  if( !msg.IsEmpty() )
972  {
973  wxMessageBox( msg );
974  return false;
975  }
976 
977  return true;
978 }
#define _(s)
Definition: 3d_actions.cpp:33

References _.

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveEEFile(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProjectSettings().

◆ 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 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:78

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurPart(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ kiway_express()

void KIWAY_PLAYER::kiway_express ( KIWAY_EXPRESS aEvent)
protectedinherited

event handler, routes to derivative specific virtual KiwayMailIn()

Definition at line 176 of file kiway_player.cpp.

177 {
178  // logging support
179  KiwayMailIn( aEvent ); // call the virtual, override in derived.
180 }
virtual void KiwayMailIn(KIWAY_EXPRESS &aEvent)
Receive KIWAY_EXPRESS messages from other players.

References KIWAY_PLAYER::KiwayMailIn().

◆ KiwayMailIn()

void KIWAY_PLAYER::KiwayMailIn ( KIWAY_EXPRESS aEvent)
virtualinherited

Receive KIWAY_EXPRESS messages from other players.

Override it in derived classes.

Reimplemented in SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, SCH_EDIT_FRAME, PCB_EDIT_FRAME, and CVPCB_MAINFRAME.

Definition at line 70 of file kiway_player.cpp.

71 {
72  // override this in derived classes.
73 }

Referenced by KIWAY_PLAYER::kiway_express(), and KIWAY::ProcessEvent().

◆ language_change()

void KIWAY_PLAYER::language_change ( wxCommandEvent &  event)
protectedinherited

An event handler called on a language menu selection.

Definition at line 183 of file kiway_player.cpp.

184 {
185  int id = event.GetId();
186 
187  // tell all the KIWAY_PLAYERs about the language change.
188  Kiway().SetLanguage( id );
189 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
Definition: kiway.cpp:470

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

◆ loadCommonSettings()

void EDA_3D_VIEWER::loadCommonSettings ( )
private

Load configuration from common settings.

Definition at line 1057 of file eda_3d_viewer.cpp.

1058 {
1059  wxCHECK_RET( m_canvas, "Cannot load settings to null canvas" );
1060 
1061  COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
1062 
1063  const DPI_SCALING dpi{ settings, this };
1064  m_canvas->SetScaleFactor( dpi.GetScaleFactor() );
1065  // TODO(JE) use all control options
1067 }
void SetFlag(DISPLAY3D_FLG aFlag, bool aState)
Set the status of a flag.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
Class to handle configuration and automatic determination of the DPI scale to use for canvases.
Definition: dpi_scaling.h:36
EDA_3D_CANVAS * m_canvas
BOARD_ADAPTER m_boardAdapter
void SetScaleFactor(double aFactor)
Set the canvas scale factor, probably for a hi-DPI display.

References FL_MOUSEWHEEL_PANNING, m_boardAdapter, m_canvas, COMMON_SETTINGS::m_Input, Pgm(), COMMON_SETTINGS::INPUT::scroll_modifier_zoom, BOARD_ADAPTER::SetFlag(), and HIDPI_GL_CANVAS::SetScaleFactor().

Referenced by CommonSettingsChanged().

◆ LoadSettings()

void EDA_3D_VIEWER::LoadSettings ( APP_SETTINGS_BASE aCfg)
overrideprivatevirtual

Load common frame parameters from a configuration file.

Don't forget to call the base method or your frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 446 of file eda_3d_viewer.cpp.

447 {
449 
450  EDA_3D_VIEWER_SETTINGS* cfg = dynamic_cast<EDA_3D_VIEWER_SETTINGS*>( aCfg );
451  wxASSERT( cfg );
452 
453  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::LoadSettings" );
454 
455  COLOR_SETTINGS* colors = Pgm().GetSettingsManager().GetColorSettings();
456 
457  auto set_color =
458  [] ( const COLOR4D& aColor, SFVEC4F& aTarget )
459  {
460  aTarget.r = aColor.r;
461  aTarget.g = aColor.g;
462  aTarget.b = aColor.b;
463  aTarget.a = aColor.a;
464  };
465 
468  set_color( colors->GetColor( LAYER_3D_BOARD ), m_boardAdapter.m_BoardBodyColor );
469  set_color( colors->GetColor( LAYER_3D_COPPER ), m_boardAdapter.m_CopperColor );
470  set_color( colors->GetColor( LAYER_3D_SILKSCREEN_BOTTOM ),
476 
477  if( cfg )
478  {
485 
488 
489  for( size_t i = 0; i < cfg->m_Render.raytrace_lightColor.size(); ++i )
490  {
493 
494  SFVEC2F sphericalCoord =
495  SFVEC2F( ( cfg->m_Render.raytrace_lightElevation[i] + 90.0f ) / 180.0f,
496  cfg->m_Render.raytrace_lightAzimuth[i] / 180.0f );
497 
498  sphericalCoord.x = glm::clamp( sphericalCoord.x, 0.0f, 1.0f );
499  sphericalCoord.y = glm::clamp( sphericalCoord.y, 0.0f, 2.0f );
500 
501  m_boardAdapter.m_RtLightSphericalCoords[i] = sphericalCoord;
502  }
503 
504 #define TRANSFER_SETTING( flag, field ) m_boardAdapter.SetFlag( flag, cfg->m_Render.field )
505 
507  TRANSFER_SETTING( FL_SUBTRACT_MASK_FROM_SILK, subtract_mask_from_silk );
508 
509  // OpenGL options
510  TRANSFER_SETTING( FL_RENDER_OPENGL_COPPER_THICKNESS, opengl_copper_thickness );
511  TRANSFER_SETTING( FL_RENDER_OPENGL_SHOW_MODEL_BBOX, opengl_show_model_bbox );
512  TRANSFER_SETTING( FL_RENDER_OPENGL_AA_DISABLE_ON_MOVE, opengl_AA_disableOnMove );
514  opengl_thickness_disableOnMove );
515  TRANSFER_SETTING( FL_RENDER_OPENGL_VIAS_DISABLE_ON_MOVE, opengl_vias_disableOnMove );
516  TRANSFER_SETTING( FL_RENDER_OPENGL_HOLES_DISABLE_ON_MOVE, opengl_holes_disableOnMove );
517 
518  // Raytracing options
519  TRANSFER_SETTING( FL_RENDER_RAYTRACING_SHADOWS, raytrace_shadows );
520  TRANSFER_SETTING( FL_RENDER_RAYTRACING_BACKFLOOR, raytrace_backfloor );
521  TRANSFER_SETTING( FL_RENDER_RAYTRACING_REFRACTIONS, raytrace_refractions );
522  TRANSFER_SETTING( FL_RENDER_RAYTRACING_REFLECTIONS, raytrace_reflections );
523  TRANSFER_SETTING( FL_RENDER_RAYTRACING_POST_PROCESSING, raytrace_post_processing );
524  TRANSFER_SETTING( FL_RENDER_RAYTRACING_ANTI_ALIASING, raytrace_anti_aliasing );
525  TRANSFER_SETTING( FL_RENDER_RAYTRACING_PROCEDURAL_TEXTURES, raytrace_procedural_textures );
526 
527  TRANSFER_SETTING( FL_AXIS, show_axis );
528  TRANSFER_SETTING( FL_FP_ATTRIBUTES_NORMAL, show_footprints_normal );
529  TRANSFER_SETTING( FL_FP_ATTRIBUTES_NORMAL_INSERT, show_footprints_insert );
530  TRANSFER_SETTING( FL_FP_ATTRIBUTES_VIRTUAL, show_footprints_virtual );
531  TRANSFER_SETTING( FL_ZONE, show_zones );
532  TRANSFER_SETTING( FL_ADHESIVE, show_adhesive );
533  TRANSFER_SETTING( FL_SILKSCREEN, show_silkscreen );
534  TRANSFER_SETTING( FL_SOLDERMASK, show_soldermask );
535  TRANSFER_SETTING( FL_SOLDERPASTE, show_solderpaste );
536  TRANSFER_SETTING( FL_COMMENTS, show_comments );
537  TRANSFER_SETTING( FL_ECO, show_eco );
538  TRANSFER_SETTING( FL_SHOW_BOARD_BODY, show_board_body );
539  TRANSFER_SETTING( FL_CLIP_SILK_ON_VIA_ANNULUS, clip_silk_on_via_annulus );
540  TRANSFER_SETTING( FL_RENDER_PLATED_PADS_AS_PLATED, renderPlatedPadsAsPlated );
541 
542  m_boardAdapter.SetGridType( static_cast<GRID3D_TYPE>( cfg->m_Render.grid_type ) );
544  static_cast<ANTIALIASING_MODE>( cfg->m_Render.opengl_AA_mode ) );
545 
548 
552 
556 
561 
562  // When opening the 3D viewer, we use the opengl mode, not the ray tracing engine
563  // because the ray tracing is very time consumming, and can be seen as not working
564  // (freeze window) with large boards.
565 #if 0
566  RENDER_ENGINE engine = static_cast<RENDER_ENGINE>( cfg->m_Render.engine );
567  wxLogTrace( m_logTrace, engine == RENDER_ENGINE::RAYTRACING ?
568  "EDA_3D_VIEWER::LoadSettings render setting Ray Trace" :
569  "EDA_3D_VIEWER::LoadSettings render setting OpenGL" );
570 #else
572 #endif
573 
574  m_boardAdapter.SetMaterialMode( static_cast<MATERIAL_MODE>( cfg->m_Render.material_mode ) );
575 
578 
579 #undef TRANSFER_SETTING
580  }
581 }
void AnimationEnabledSet(bool aAnimationEnabled)
Enable or disable camera animation when switching to a pre-defined view.
SFVEC4F GetColor(COLOR4D aColor) const
int m_RtShadowSampleCount
SFVEC4F m_SilkScreenColorBot
in realistic mode: SilkScreen color ( bot )
void SetAntiAliasingMode(ANTIALIASING_MODE aAAmode)
Set the current antialiasing mode value.
glm::vec4 SFVEC4F
Definition: xv3d_types.h:46
SFVEC4F m_SolderMaskColorTop
in realistic mode: solder mask color ( top )
std::vector< SFVEC2F > m_RtLightSphericalCoords
SFVEC4F m_BoardBodyColor
in realistic mode: FR4 board color
SFVEC4F m_SolderPasteColor
in realistic mode: solder paste color
double g
Green component.
Definition: color4d.h:359
SFVEC4F m_SolderMaskColorBot
in realistic mode: solder mask color ( bot )
void SetGridType(GRID3D_TYPE aGridType) noexcept
Set the current grid.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
float m_RtSpreadRefractions
SFVEC3F m_RtCameraLightColor
double b
Blue component.
Definition: color4d.h:360
EDA_3D_CANVAS * m_canvas
void MovingSpeedMultiplierSet(int aMovingSpeedMultiplier)
Set the camera animation moving speed multiplier option.
BOARD_ADAPTER m_boardAdapter
double a
Alpha component.
Definition: color4d.h:361
int m_RtRecursiveReflectionCount
float m_RtSpreadReflections
SFVEC4F m_BgColorTop
background top color
glm::vec2 SFVEC2F
Definition: xv3d_types.h:42
#define TRANSFER_SETTING(flag, field)
SFVEC3F m_RtLightColorTop
void SetMaterialMode(MATERIAL_MODE aMaterialMode) noexcept
SFVEC4F m_BgColorBot
background bottom color
int m_RtRecursiveRefractionCount
std::vector< SFVEC3F > m_RtLightColor
int m_RtRefractionSampleCount
void SetRenderEngine(RENDER_ENGINE aRenderEngine) noexcept
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
COLOR4D GetColor(int aLayer) const
SFVEC4F m_CopperColor
in realistic mode: copper color
std::vector< KIGFX::COLOR4D > raytrace_lightColor
RENDER_ENGINE
Render engine mode.
Definition: 3d_enums.h:109
SFVEC3F m_OpenGlSelectionColor
Color settings are a bit different than most of the settings objects in that there can be more than o...
SFVEC4F m_SilkScreenColorTop
in realistic mode: SilkScreen color ( top )
double r
Red component.
Definition: color4d.h:358
SFVEC3F m_RtLightColorBottom
float m_RtSpreadShadows
int m_RtReflectionSampleCount
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References KIGFX::COLOR4D::a, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::animation_enabled, EDA_3D_CANVAS::AnimationEnabledSet(), KIGFX::COLOR4D::b, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::engine, FL_ADHESIVE, FL_AXIS, FL_CLIP_SILK_ON_VIA_ANNULUS, FL_COMMENTS, FL_ECO, FL_FP_ATTRIBUTES_NORMAL, FL_FP_ATTRIBUTES_NORMAL_INSERT, FL_FP_ATTRIBUTES_VIRTUAL, FL_RENDER_OPENGL_AA_DISABLE_ON_MOVE, FL_RENDER_OPENGL_COPPER_THICKNESS, FL_RENDER_OPENGL_HOLES_DISABLE_ON_MOVE, FL_RENDER_OPENGL_SHOW_MODEL_BBOX, FL_RENDER_OPENGL_THICKNESS_DISABLE_ON_MOVE, FL_RENDER_OPENGL_VIAS_DISABLE_ON_MOVE, FL_RENDER_PLATED_PADS_AS_PLATED, FL_RENDER_RAYTRACING_ANTI_ALIASING, FL_RENDER_RAYTRACING_BACKFLOOR, FL_RENDER_RAYTRACING_POST_PROCESSING, FL_RENDER_RAYTRACING_PROCEDURAL_TEXTURES, FL_RENDER_RAYTRACING_REFLECTIONS, FL_RENDER_RAYTRACING_REFRACTIONS, FL_RENDER_RAYTRACING_SHADOWS, FL_SHOW_BOARD_BODY, FL_SILKSCREEN, FL_SOLDERMASK, FL_SOLDERPASTE, FL_SUBTRACT_MASK_FROM_SILK, FL_USE_REALISTIC_MODE, FL_ZONE, KIGFX::COLOR4D::g, COLOR_SETTINGS::GetColor(), BOARD_ADAPTER::GetColor(), EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::grid_type, LAYER_3D_BACKGROUND_BOTTOM, LAYER_3D_BACKGROUND_TOP, LAYER_3D_BOARD, LAYER_3D_COPPER, LAYER_3D_SILKSCREEN_BOTTOM, LAYER_3D_SILKSCREEN_TOP, LAYER_3D_SOLDERMASK, LAYER_3D_SOLDERPASTE, EDA_BASE_FRAME::LoadSettings(), BOARD_ADAPTER::m_BgColorBot, BOARD_ADAPTER::m_BgColorTop, m_boardAdapter, BOARD_ADAPTER::m_BoardBodyColor, EDA_3D_VIEWER_SETTINGS::m_Camera, m_canvas, BOARD_ADAPTER::m_CopperColor, m_logTrace, BOARD_ADAPTER::m_OpenGlSelectionColor, EDA_3D_VIEWER_SETTINGS::m_Render, BOARD_ADAPTER::m_RtCameraLightColor, BOARD_ADAPTER::m_RtLightColor, BOARD_ADAPTER::m_RtLightColorBottom, BOARD_ADAPTER::m_RtLightColorTop, BOARD_ADAPTER::m_RtLightSphericalCoords, BOARD_ADAPTER::m_RtRecursiveReflectionCount, BOARD_ADAPTER::m_RtRecursiveRefractionCount, BOARD_ADAPTER::m_RtReflectionSampleCount, BOARD_ADAPTER::m_RtRefractionSampleCount, BOARD_ADAPTER::m_RtShadowSampleCount, BOARD_ADAPTER::m_RtSpreadReflections, BOARD_ADAPTER::m_RtSpreadRefractions, BOARD_ADAPTER::m_RtSpreadShadows, BOARD_ADAPTER::m_SilkScreenColorBot, BOARD_ADAPTER::m_SilkScreenColorTop, BOARD_ADAPTER::m_SolderMaskColorBot, BOARD_ADAPTER::m_SolderMaskColorTop, BOARD_ADAPTER::m_SolderPasteColor, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::material_mode, EDA_3D_VIEWER_SETTINGS::CAMERA_SETTINGS::moving_speed_multiplier, EDA_3D_CANVAS::MovingSpeedMultiplierSet(), EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_AA_mode, OPENGL_LEGACY, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::opengl_selection_color, Pgm(), KIGFX::COLOR4D::r, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightAzimuth, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColor, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColorBottom, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColorCamera, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColorTop, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightElevation, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_nrsamples_reflections, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_nrsamples_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_nrsamples_shadows, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_recursivelevel_reflections, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_recursivelevel_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_spread_reflections, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_spread_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_spread_shadows, RAYTRACING, BOARD_ADAPTER::SetAntiAliasingMode(), BOARD_ADAPTER::SetGridType(), BOARD_ADAPTER::SetMaterialMode(), BOARD_ADAPTER::SetRenderEngine(), and TRANSFER_SETTING.

Referenced by Process_Special_Functions().

◆ LoadWindowSettings()

void EDA_BASE_FRAME::LoadWindowSettings ( const WINDOW_SETTINGS aCfg)
inherited

Load window settings from the given settings object.

Normally called by LoadSettings() unless the window in question is a child window that* stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 613 of file eda_base_frame.cpp.

614 {
615  LoadWindowState( aCfg->state );
616 
617  if( m_hasAutoSave )
618  m_autoSaveInterval = Pgm().GetCommonSettings()->m_System.autosave_interval;
619 
620  m_perspective = aCfg->perspective;
621  m_mruPath = aCfg->mru_path;
622 
623  TOOLS_HOLDER::CommonSettingsChanged( false, false );
624 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void LoadWindowState(const wxString &aFileName)
wxString m_perspective
wxString perspective
Definition: app_settings.h:85
WINDOW_STATE state
Definition: app_settings.h:83
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.

References TOOLS_HOLDER::CommonSettingsChanged(), EDA_BASE_FRAME::LoadWindowState(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_perspective, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), and WINDOW_SETTINGS::state.

Referenced by EDA_BASE_FRAME::LoadSettings().

◆ LoadWindowState() [1/2]

void EDA_BASE_FRAME::LoadWindowState ( const wxString &  aFileName)
inherited

Definition at line 488 of file eda_base_frame.cpp.

489 {
490  if( !Pgm().GetCommonSettings()->m_Session.remember_open_files )
491  return;
492 
493  const PROJECT_FILE_STATE* state = Prj().GetLocalSettings().GetFileState( aFileName );
494 
495  if( state != nullptr )
496  {
497  LoadWindowState( state->window );
498  }
499 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void LoadWindowState(const wxString &aFileName)
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:151
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
struct WINDOW_STATE window
const PROJECT_FILE_STATE * GetFileState(const wxString &aFileName)

References PROJECT_LOCAL_SETTINGS::GetFileState(), PROJECT::GetLocalSettings(), Pgm(), KIWAY_HOLDER::Prj(), and PROJECT_FILE_STATE::window.

Referenced by KICAD_MANAGER_FRAME::LoadProject(), PCB_EDIT_FRAME::LoadProjectSettings(), EDA_BASE_FRAME::LoadWindowSettings(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ LoadWindowState() [2/2]

void EDA_BASE_FRAME::LoadWindowState ( const WINDOW_STATE aState)
virtualinherited

Load frame state info from a configuration file.

Definition at line 502 of file eda_base_frame.cpp.

503 {
504  bool wasDefault = false;
505 
506  m_framePos.x = aState.pos_x;
507  m_framePos.y = aState.pos_y;
508  m_frameSize.x = aState.size_x;
509  m_frameSize.y = aState.size_y;
510 
511  wxLogTrace( traceDisplayLocation, "Config position (%d, %d) with size (%d, %d)",
513 
514  // Ensure minimum size is set if the stored config was zero-initialized
515  if( m_frameSize.x < minSize( m_ident ).x || m_frameSize.y < minSize( m_ident ).y )
516  {
518  wasDefault = true;
519 
520  wxLogTrace( traceDisplayLocation, "Using minimum size (%d, %d)", m_frameSize.x, m_frameSize.y );
521  }
522 
523  wxLogTrace( traceDisplayLocation, "Number of displays: %d", wxDisplay::GetCount() );
524 
525  if( aState.display >= wxDisplay::GetCount() )
526  {
527  wxLogTrace( traceDisplayLocation, "Previous display not found" );
528 
529  // If it isn't attached, use the first display
530  // Warning wxDisplay has 2 ctor variants. the parameter needs a type:
531  const unsigned int index = 0;
532  wxDisplay display( index );
533  wxRect clientSize = display.GetGeometry();
534 
535  m_framePos = wxDefaultPosition;
536 
537  // Ensure the window fits on the display, since the other one could have been larger
538  if( m_frameSize.x > clientSize.width )
539  m_frameSize.x = clientSize.width;
540 
541  if( m_frameSize.y > clientSize.height )
542  m_frameSize.y = clientSize.height;
543  }
544  else
545  {
546  wxPoint upperRight( m_framePos.x + m_frameSize.x, m_framePos.y );
547  wxPoint upperLeft( m_framePos.x, m_framePos.y );
548 
549  wxDisplay display( aState.display );
550  wxRect clientSize = display.GetClientArea();
551 
552 #ifndef _WIN32
553  // The percentage size (represented in decimal) of the region around the screen's border where
554  // an upper corner is not allowed
555  #define SCREEN_BORDER_REGION 0.10
556 #else
557  // Windows uses a very rectangular clearly defined display region, there is no ambigious "screen border region"
558  // GetClientArea already accounts for the taskbar stealing display space
559  #define SCREEN_BORDER_REGION 0
560 #endif
561 
562  int yLimTop = clientSize.y + ( clientSize.height * ( SCREEN_BORDER_REGION ) );
563  int yLimBottom = clientSize.y + ( clientSize.height * ( 1.0 - SCREEN_BORDER_REGION ) );
564  int xLimLeft = clientSize.x + ( clientSize.width * SCREEN_BORDER_REGION );
565  int xLimRight = clientSize.x + ( clientSize.width * ( 1.0 - SCREEN_BORDER_REGION ) );
566 
567  if( upperLeft.x > xLimRight || // Upper left corner too close to right edge of screen
568  upperRight.x < xLimLeft || // Upper right corner too close to left edge of screen
569  upperLeft.y < yLimTop || // Upper corner too close to the bottom of the screen
570  upperLeft.y > yLimBottom )
571  {
572  m_framePos = wxDefaultPosition;
573  wxLogTrace( traceDisplayLocation, "Resetting to default position" );
574  }
575  }
576 
577  // Ensure Window title bar is visible
578 #if defined( __WXOSX__ )
579  // for macOSX, the window must be below system (macOSX) toolbar
580  int Ypos_min = 20;
581 #else
582  int Ypos_min = 0;
583 #endif
584  if( m_framePos.y < Ypos_min )
585  m_framePos.y = Ypos_min;
586 
587  wxLogTrace( traceDisplayLocation, "Final window position (%d, %d) with size (%d, %d)",
589 
590  SetSize( m_framePos.x, m_framePos.y, m_frameSize.x, m_frameSize.y );
591 
592  // Center the window if we reset to default
593  if( m_framePos.x == -1 )
594  {
595  wxLogTrace( traceDisplayLocation, "Centering window" );
596  Center();
597  m_framePos = GetPosition();
598  }
599 
600  // Record the frame sizes in an un-maximized state
603 
604  // Maximize if we were maximized before
605  if( aState.maximized || ( wasDefault && m_maximizeByDefault ) )
606  {
607  wxLogTrace( traceDisplayLocation, "Maximizing window" );
608  Maximize();
609  }
610 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
#define SCREEN_BORDER_REGION
wxSize m_normalFrameSize
static const wxSize defaultSize(FRAME_T aFrameType)
static const wxSize minSize(FRAME_T aFrameType)
unsigned int display
Definition: app_settings.h:75

References PCAD2KICAD::Center, defaultSize(), WINDOW_STATE::display, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_ident, EDA_BASE_FRAME::m_maximizeByDefault, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, minSize(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, SCREEN_BORDER_REGION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, and traceDisplayLocation.

◆ NewDisplay()

void EDA_3D_VIEWER::NewDisplay ( bool  aForceImmediateRedraw = false)

Reload and refresh (rebuild) the 3D scene.

Warning
Rebuilding the 3D scene can take a bit of time, so rebuilding the scene can be immediate, or made later, during the next 3D canvas refresh (on zoom for instance).
Parameters
aForceImmediateRedrawtrue to immediately rebuild the 3D scene or false to wait refresh later.

Definition at line 258 of file eda_3d_viewer.cpp.

259 {
260  ReloadRequest();
261 
262  // After the ReloadRequest call, the refresh often takes a bit of time,
263  // and it is made here only on request.
264  if( aForceImmediateRedraw )
265  m_canvas->Refresh();
266 }
EDA_3D_CANVAS * m_canvas
void ReloadRequest()
Request reloading the 3D view.

References m_canvas, and ReloadRequest().

Referenced by CommonSettingsChanged(), Install3DViewOptionDialog(), PCB_EDIT_FRAME::OpenProjectFiles(), Process_Special_Functions(), refreshRender(), and EDA_3D_CONTROLLER::ToggleVisibility().

◆ NonUserClose()

bool EDA_BASE_FRAME::NonUserClose ( bool  aForce)
inlineinherited

Definition at line 565 of file eda_base_frame.h.

566  {
567  m_isNonUserClose = true;
568  return Close( aForce );
569  }

References EDA_BASE_FRAME::m_isNonUserClose.

Referenced by KIWAY::PlayerClose().

◆ OnActivate()

void EDA_3D_VIEWER::OnActivate ( wxActivateEvent &  event)
private

Definition at line 417 of file eda_3d_viewer.cpp.

418 {
419  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::OnActivate" );
420 
421  if( aEvent.GetActive() && m_canvas )
422  {
423  // Reload data if 3D frame shows a board,
424  // because it can be changed since last frame activation
427 
428  // Activates again the focus of the canvas so it will catch mouse and key events
429  m_canvas->SetFocus();
430  }
431 
432  aEvent.Skip(); // required under wxMAC
433 }
bool IsReloadRequestPending() const
Query if there is a pending reload request.
Definition: eda_3d_canvas.h:91
void Request_refresh(bool aRedrawImmediately=true)
Schedule a refresh update of the canvas.
EDA_3D_CANVAS * m_canvas
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.

References EDA_3D_CANVAS::IsReloadRequestPending(), m_canvas, m_logTrace, and EDA_3D_CANVAS::Request_refresh().

◆ onAutoSaveTimer()

void EDA_BASE_FRAME::onAutoSaveTimer ( wxTimerEvent &  aEvent)
protectedinherited

Handle the auto save timer event.

Definition at line 294 of file eda_base_frame.cpp.

295 {
296  if( !doAutoSave() )
297  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
298 }
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
wxTimer * m_autoSaveTimer

References EDA_BASE_FRAME::doAutoSave(), EDA_BASE_FRAME::m_autoSaveInterval, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_BASE_FRAME::EDA_BASE_FRAME().

◆ OnCharHook()

void EDA_BASE_FRAME::OnCharHook ( wxKeyEvent &  aKeyEvent)
virtualinherited

Capture the key event before it is sent to the GUI.

The basic frame does not capture this event. Editor frames should override this event function to capture and filter these keys when they are used as hotkeys, and skip it if the key is not used as hotkey (otherwise the key events will be not sent to menus).

Reimplemented in FOOTPRINT_VIEWER_FRAME.

Definition at line 307 of file eda_base_frame.cpp.

308 {
309  wxLogTrace( kicadTraceKeyEvent, "EDA_BASE_FRAME::OnCharHook %s", dump( aKeyEvent ) );
310 
311  // Key events can be filtered here.
312  // Currently no filtering is made.
313  aKeyEvent.Skip();
314 }
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.

References dump(), and kicadTraceKeyEvent.

◆ OnCloseWindow()

void EDA_3D_VIEWER::OnCloseWindow ( wxCloseEvent &  event)
private

Definition at line 294 of file eda_3d_viewer.cpp.

295 {
296  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::OnCloseWindow" );
297 
298  if( m_canvas )
299  m_canvas->Close();
300 
301  // m_canvas delete will be called by wxWidget manager
302  //delete m_canvas;
303  //m_canvas = nullptr;
304 
305  Destroy();
306  event.Skip( true );
307 }
EDA_3D_CANVAS * m_canvas
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.

References KIWAY_PLAYER::Destroy(), m_canvas, and m_logTrace.

◆ OnDisableRayTracing()

void EDA_3D_VIEWER::OnDisableRayTracing ( wxCommandEvent &  aEvent)
private

Definition at line 408 of file eda_3d_viewer.cpp.

409 {
410  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::%s disabling ray tracing.", __WXFUNCTION__ );
411 
412  m_disable_ray_tracing = true;
414 }
BOARD_ADAPTER m_boardAdapter
void SetRenderEngine(RENDER_ENGINE aRenderEngine) noexcept
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
bool m_disable_ray_tracing

References m_boardAdapter, m_disable_ray_tracing, m_logTrace, OPENGL_LEGACY, and BOARD_ADAPTER::SetRenderEngine().

◆ OnKicadAbout()

void EDA_BASE_FRAME::OnKicadAbout ( wxCommandEvent &  event)
inherited

Definition at line 896 of file eda_base_frame.cpp.

897 {
898  void ShowAboutDialog(EDA_BASE_FRAME * aParent); // See AboutDialog_main.cpp
899  ShowAboutDialog( this );
900 }
void ShowAboutDialog(EDA_BASE_FRAME *aParent)
The base frame for deriving all KiCad main window classes.

References ShowAboutDialog().

◆ OnMaximize()

void EDA_BASE_FRAME::OnMaximize ( wxMaximizeEvent &  aEvent)
inherited

Definition at line 1103 of file eda_base_frame.cpp.

1104 {
1105  // When we maximize the window, we want to save the old information
1106  // so that we can add it to the settings on next window load.
1107  // Contrary to the documentation, this event seems to be generated
1108  // when the window is also being unmaximized on OSX, so we only
1109  // capture the size information when we maximize the window when on OSX.
1110 #ifdef __WXOSX__
1111  if( !IsMaximized() )
1112 #endif
1113  {
1115  m_normalFramePos = GetPosition();
1116  wxLogTrace( traceDisplayLocation, "Maximizing window - Saving position (%d, %d) with size (%d, %d)",
1118  }
1119 
1120  // Skip event to actually maximize the window
1121  aEvent.Skip();
1122 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
wxSize m_normalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.

References EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, and traceDisplayLocation.

◆ OnMenuEvent()

void EDA_BASE_FRAME::OnMenuEvent ( wxMenuEvent &  event)
inherited

The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves.

Definition at line 317 of file eda_base_frame.cpp.

318 {
319  if( !m_toolDispatcher )
320  aEvent.Skip();
321  else
323 }
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:159

References TOOL_DISPATCHER::DispatchWxEvent(), and TOOLS_HOLDER::m_toolDispatcher.

◆ OnMove()

virtual void EDA_BASE_FRAME::OnMove ( wxMoveEvent &  aEvent)
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 181 of file eda_base_frame.h.

182  {
183  aEvent.Skip();
184  }

◆ OnPreferences()

void EDA_BASE_FRAME::OnPreferences ( wxCommandEvent &  event)
inherited

Definition at line 903 of file eda_base_frame.cpp.

904 {
905  PAGED_DIALOG dlg( this, _( "Preferences" ), true );
906  wxTreebook* book = dlg.GetTreebook();
907 
908  book->AddPage( new PANEL_COMMON_SETTINGS( &dlg, book ), _( "Common" ) );
909 
910  book->AddPage( new PANEL_MOUSE_SETTINGS( &dlg, book ), _( "Mouse and Touchpad" ) );
911 
912  PANEL_HOTKEYS_EDITOR* hotkeysPanel = new PANEL_HOTKEYS_EDITOR( this, book, false );
913  book->AddPage( hotkeysPanel, _( "Hotkeys" ) );
914 
915  for( unsigned i = 0; i < KIWAY_PLAYER_COUNT; ++i )
916  {
917  KIWAY_PLAYER* frame = dlg.Kiway().Player( (FRAME_T) i, false );
918 
919  if( frame )
920  frame->InstallPreferences( &dlg, hotkeysPanel );
921  }
922 
923  // The Kicad manager frame is not a player so we have to add it by hand
924  wxWindow* manager = wxFindWindowByName( KICAD_MANAGER_FRAME_NAME );
925 
926  if( manager )
927  static_cast<EDA_BASE_FRAME*>( manager )->InstallPreferences( &dlg, hotkeysPanel );
928 
929  for( size_t i = 0; i < book->GetPageCount(); ++i )
930  book->GetPage( i )->Layout();
931 
932  if( dlg.ShowModal() == wxID_OK )
933  dlg.Kiway().CommonSettingsChanged( false, false );
934 }
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:61
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:32
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:368
#define KICAD_MANAGER_FRAME_NAME
#define _(s)
Definition: 3d_actions.cpp:33
virtual void InstallPreferences(PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
Allow a frame to load its preference panels (if any) into the preferences dialog.

References _, KIWAY::CommonSettingsChanged(), PAGED_DIALOG::GetTreebook(), EDA_BASE_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME_NAME, KIWAY_HOLDER::Kiway(), KIWAY_PLAYER_COUNT, and KIWAY::Player().

Referenced by APPEARANCE_CONTROLS::onReadOnlySwatch().

◆ OnRenderEngineSelection()

void EDA_3D_VIEWER::OnRenderEngineSelection ( wxCommandEvent &  event)
private

Definition at line 390 of file eda_3d_viewer.cpp.

391 {
392  const RENDER_ENGINE old_engine = m_boardAdapter.GetRenderEngine();
393 
394  if( old_engine == RENDER_ENGINE::OPENGL_LEGACY )
396  else
398 
399  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::OnRenderEngineSelection type %s ",
401  "OpenGL Legacy" );
402 
403  if( old_engine != m_boardAdapter.GetRenderEngine() )
405 }
RENDER_ENGINE GetRenderEngine() const noexcept
BOARD_ADAPTER m_boardAdapter
void SetRenderEngine(RENDER_ENGINE aRenderEngine) noexcept
void RenderEngineChanged()
RenderEngineChanged - Update toolbar icon and call canvas RenderEngineChanged.
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
RENDER_ENGINE
Render engine mode.
Definition: 3d_enums.h:109

References BOARD_ADAPTER::GetRenderEngine(), m_boardAdapter, m_logTrace, OPENGL_LEGACY, RAYTRACING, RenderEngineChanged(), and BOARD_ADAPTER::SetRenderEngine().

◆ OnSetFocus()

void EDA_3D_VIEWER::OnSetFocus ( wxFocusEvent &  event)
private

Definition at line 436 of file eda_3d_viewer.cpp.

437 {
438  // Activates again the focus of the canvas so it will catch mouse and key events
439  if( m_canvas )
440  m_canvas->SetFocus();
441 
442  aEvent.Skip();
443 }
EDA_3D_CANVAS * m_canvas

References m_canvas.

◆ onSystemColorChange()

void EDA_BASE_FRAME::onSystemColorChange ( wxSysColourChangedEvent &  aEvent)
protectedinherited

Definition at line 1160 of file eda_base_frame.cpp.

1161 {
1162  // Call the handler to update the colors used in the frame
1164 
1165  // Skip the change event to ensure the rest of the window controls get it
1166  aEvent.Skip();
1167 }
virtual void HandleSystemColorChange()
Update the UI in response to a change in the system colors.

References EDA_BASE_FRAME::HandleSystemColorChange().

◆ OpenProjectFiles()

virtual bool KIWAY_PLAYER::OpenProjectFiles ( const std::vector< wxString > &  aFileList,
int  aCtl = 0 
)
inlinevirtualinherited

Open a project or set of files given by aFileList.

This is generalized in the direction of worst case. In a typical case aFileList will only hold a single file, like "myboard.kicad_pcb" because any KIWAY_PLAYER is only in one KIWAY and the KIWAY owns the PROJECT. Therefore opening files from multiple projects into the same KIWAY_PLAYER is precluded.

Each derived class should handle this in a way specific to its needs. No filename prompting is done inside here for any file or project. There should be no need to call this with aFileList which is empty. However, calling it with a single filename which does not exist should indicate to the implementer that a new session is being started and that the given name is the desired name for the data file at time of save.

This function does not support "appending". Use a different function for that. Any prior project data tree should be cleared before loading the new stuff. Therefore, one of the first things an implementation should do is test for existence of the first file in the list, and if it does not exist, treat it as a new session, possibly with a UI notification to that effect.

After loading the window should update its Title as part of this operation. If the KIWAY_PLAYER needs to, it can load the *.pro file as part of this operation.

If the KIWAY_PLAYER cannot load any of the file(s) in the list, then it should say why through some GUI interface, and return false.

Parameters
aFileListincludes files that this frame should open according to the knowledge in the derived wxFrame. In almost every case, the list will have only a single file in it.
aCtlis a set of bit flags ORed together from the set of KICTL_* #defined above.
Returns
true if all requested files were opened OK, else false.

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, CVPCB_MAINFRAME, BM2CMP_FRAME, PL_EDITOR_FRAME, and GERBVIEW_FRAME.

Definition at line 115 of file kiway_player.h.

116  {
117  // overload me for your wxFrame type.
118 
119  // Any overload should probably do this also:
120  // Prj().MaybeLoadProjectSettings();
121 
122  // Then update the window title.
123 
124  return false;
125  }

Referenced by BACK_ANNOTATE::FetchNetlistFromPCB(), PGM_TEST_FRAME::MacOpenFile(), PGM_SINGLE_TOP::MacOpenFile(), PGM_MOCK_EESCHEMA_FRAME::MacOpenFile(), SCH_EDIT_FRAME::OnOpenPcbnew(), PGM_SINGLE_TOP::OnPgmInit(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::RunEeschema(), and PCB_EDIT_FRAME::TestStandalone().

◆ Parent()

PCB_BASE_FRAME* EDA_3D_VIEWER::Parent ( ) const
inline

Definition at line 74 of file eda_3d_viewer.h.

74 { return (PCB_BASE_FRAME*)GetParent(); }
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.

Referenced by CreateMenuBar(), GetBoard(), and takeScreenshot().

◆ ParseArgs()

virtual void KIWAY_PLAYER::ParseArgs ( wxCmdLineParser &  aParser)
inlinevirtualinherited

Handle command-line arguments in a frame-specific way.

The given argument parser has already been initialized with the command line and any options/switches that are handled by the top-level launcher before passing control to the child frame.

Parameters
aParseris the argument parser created by the top-level launcher.

Definition at line 136 of file kiway_player.h.

137  {
138  WXUNUSED( aParser );
139  }

Referenced by PGM_SINGLE_TOP::OnPgmInit().

◆ PopCommandFromRedoList()

PICKED_ITEMS_LIST * EDA_BASE_FRAME::PopCommandFromRedoList ( )
virtualinherited

Return the last command to undo and remove it from list, nothing is deleted.

Definition at line 1087 of file eda_base_frame.cpp.

1088 {
1089  return m_redoList.PopCommand();
1090 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_redoList

References EDA_BASE_FRAME::m_redoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), and SCH_EDITOR_CONTROL::Redo().

◆ PopCommandFromUndoList()

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const std::string &  actionName)
virtualinherited

Definition at line 60 of file tools_holder.cpp.

61 {
62  // Push/pop events can get out of order (such as when they're generated by the Simulator
63  // frame but not processed until the mouse is back in the Schematic frame), so make sure
64  // we're popping the right stack frame.
65 
66  for( int i = (int) m_toolStack.size() - 1; i >= 0; --i )
67  {
68  if( m_toolStack[ i ] == actionName )
69  {
70  m_toolStack.erase( m_toolStack.begin() + i );
71 
72  // If there's something underneath us, and it's now the top of the stack, then
73  // re-activate it
74  if( ( --i ) >= 0 && i == (int)m_toolStack.size() - 1 )
75  {
76  std::string back = m_toolStack[ i ];
78 
79  if( action )
80  {
81  // Pop the action as running it will push it back onto the stack
82  m_toolStack.pop_back();
83 
84  TOOL_EVENT evt = action->MakeEvent();
85  evt.SetHasPosition( false );
86  evt.SetReactivate( true );
87  GetToolManager()->PostEvent( evt );
88  }
89  }
90  else
92 
93  return;
94  }
95  }
96 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:122
void SetReactivate(bool aReactivate=true)
Returns information about difference between current mouse cursor position and the place where draggi...
Definition: tool_event.h:274
TOOL_ACTION * FindAction(const std::string &aActionName) const
Find an action with a given name (if there is one available).
Generic, UI-independent tool event.
Definition: tool_event.h:173
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
std::vector< std::string > m_toolStack
Definition: tools_holder.h:163
Represent a single user action.
Definition: tool_action.h:49
TOOL_EVENT MakeEvent() const
Return the event associated with the action (i.e.
Definition: tool_action.h:123
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:197
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
void PostEvent(const TOOL_EVENT &aEvent)
Put an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:267
static TOOL_ACTION selectionTool
Definition: actions.h:156
void SetHasPosition(bool aHasPosition)
Returns if the action associated with this event should be treated as immediate regardless of the cur...
Definition: tool_event.h:262

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOLS_HOLDER::GetToolManager(), TOOLS_HOLDER::m_toolManager, TOOLS_HOLDER::m_toolStack, TOOL_ACTION::MakeEvent(), TOOL_MANAGER::PostEvent(), ACTIONS::selectionTool, TOOL_EVENT::SetHasPosition(), and TOOL_EVENT::SetReactivate().

Referenced by EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PrintMsg()

void EDA_BASE_FRAME::PrintMsg ( const wxString &  text)
inherited

Definition at line 738 of file eda_base_frame.cpp.

739 {
740  SetStatusText( text );
741 }

References text.

Referenced by KICAD_MANAGER_CONTROL::Execute(), TERMINATE_HANDLER::OnTerminate(), and KICAD_MANAGER_FRAME::OnUnarchiveFiles().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:184

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), 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_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), 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(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ Process_Special_Functions()

void EDA_3D_VIEWER::Process_Special_Functions ( wxCommandEvent &  event)
private

Definition at line 310 of file eda_3d_viewer.cpp.

311 {
312  int id = event.GetId();
313  bool isChecked = event.IsChecked();
314 
315  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::Process_Special_Functions id %d isChecked %d",
316  id, isChecked );
317 
318  if( m_canvas == nullptr )
319  return;
320 
321  switch( id )
322  {
323  case ID_RELOAD3D_BOARD:
324  NewDisplay( true );
325  break;
326 
330  takeScreenshot( event );
331  return;
332 
334  if( Set3DColorFromUser( m_boardAdapter.m_BgColorBot, _( "Background Color, Bottom" ),
335  nullptr ) )
336  refreshRender();
337  return;
338 
340  if( Set3DColorFromUser( m_boardAdapter.m_BgColorTop, _( "Background Color, Top" ),
341  nullptr ) )
342  refreshRender();
343  return;
344 
347  return;
348 
351  return;
352 
355  return;
356 
359  break;
360 
363  break;
364 
367  refreshRender();
368  break;
369 
371  {
372  auto cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
373  cfg->ResetToDefaults();
374  LoadSettings( cfg );
375 
376  // Tell canvas that we (may have) changed the render engine
378 
379  NewDisplay( true );
380  }
381  return;
382 
383  default:
384  wxFAIL_MSG( "Invalid event in EDA_3D_VIEWER::Process_Special_Functions()" );
385  return;
386  }
387 }
void ResetToDefaults()
Resets all parameters to default values.
bool Set3DCopperColorFromUser()
Set the copper color from a set of colors.
bool Set3DSolderMaskColorFromUser()
Set the solder mask color from a set of colors.
void SynchroniseColoursWithBoard()
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
EDA_3D_CANVAS * m_canvas
BOARD_ADAPTER m_boardAdapter
SFVEC4F m_BgColorTop
background top color
bool Set3DSilkScreenColorFromUser()
Set the silkscreen color from a set of colors.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
SFVEC4F m_BgColorBot
background bottom color
bool Set3DColorFromUser(SFVEC4F &aColor, const wxString &aTitle, CUSTOM_COLORS_LIST *aPredefinedColors, bool aAllowOpacityControl=false, KIGFX::COLOR4D aDefaultColor=KIGFX::COLOR4D(1.0, 1.0, 1.0, 1.0))
Get a SFVEC3D from a color dialog.
bool Set3DSolderPasteColorFromUser()
Set the solder mask color from a set of colors.
void RenderEngineChanged()
RenderEngineChanged - Update toolbar icon and call canvas RenderEngineChanged.
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
#define _(s)
Definition: 3d_actions.cpp:33
void NewDisplay(bool aForceImmediateRedraw=false)
Reload and refresh (rebuild) the 3D scene.
bool Set3DBoardBodyColorFromUser()
Set the copper color from a set of colors.
void takeScreenshot(wxCommandEvent &event)
Create a Screenshot of the current 3D view.

References _, ID_MENU3D_BGCOLOR_BOTTOM, ID_MENU3D_BGCOLOR_TOP, ID_MENU3D_COPPER_COLOR, ID_MENU3D_PCB_BODY_COLOR, ID_MENU3D_RESET_DEFAULTS, ID_MENU3D_SILKSCREEN_COLOR, ID_MENU3D_SOLDERMASK_COLOR, ID_MENU3D_SOLDERPASTE_COLOR, ID_MENU3D_STACKUP_COLORS, ID_MENU_SCREENCOPY_JPEG, ID_MENU_SCREENCOPY_PNG, ID_RELOAD3D_BOARD, ID_TOOL_SCREENCOPY_TOCLIBBOARD, LoadSettings(), BOARD_ADAPTER::m_BgColorBot, BOARD_ADAPTER::m_BgColorTop, m_boardAdapter, m_canvas, m_logTrace, NewDisplay(), Pgm(), refreshRender(), RenderEngineChanged(), JSON_SETTINGS::ResetToDefaults(), Set3DBoardBodyColorFromUser(), Set3DColorFromUser(), Set3DCopperColorFromUser(), Set3DSilkScreenColorFromUser(), Set3DSolderMaskColorFromUser(), Set3DSolderPasteColorFromUser(), SynchroniseColoursWithBoard(), and takeScreenshot().

◆ ProcessEvent()

bool EDA_BASE_FRAME::ProcessEvent ( wxEvent &  aEvent)
overrideinherited

Override the default process event handler to implement the auto save feature.

Warning
If you override this function in a derived class, make sure you call down to this or the auto save feature will be disabled.

Definition at line 236 of file eda_base_frame.cpp.

237 {
238 #ifdef __WXMAC__
239  // Apple in its infinite wisdom will raise a disabled window before even passing
240  // us the event, so we have no way to stop it. Instead, we have to catch an
241  // improperly ordered disabled window and quasi-modal dialog here and reorder
242  // them.
243  if( !IsEnabled() && IsActive() )
244  {
245  wxWindow* dlg = findQuasiModalDialog();
246  if( dlg )
247  dlg->Raise();
248  }
249 #endif
250 
251  if( !wxFrame::ProcessEvent( aEvent ) )
252  return false;
253 
254  if( IsShown() && m_hasAutoSave && IsActive() &&
256  {
257  if( !m_autoSaveState )
258  {
259  wxLogTrace( traceAutoSave, wxT( "Starting auto save timer." ) );
260  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
261  m_autoSaveState = true;
262  }
263  else if( m_autoSaveTimer->IsRunning() )
264  {
265  wxLogTrace( traceAutoSave, wxT( "Stopping auto save timer." ) );
266  m_autoSaveTimer->Stop();
267  m_autoSaveState = false;
268  }
269  }
270 
271  return true;
272 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
virtual bool isAutoSaveRequired() const
Return the auto save status of the application.
wxTimer * m_autoSaveTimer
wxWindow * findQuasiModalDialog()

References EDA_BASE_FRAME::findQuasiModalDialog(), EDA_BASE_FRAME::isAutoSaveRequired(), EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_autoSaveState, EDA_BASE_FRAME::m_autoSaveTimer, EDA_BASE_FRAME::m_hasAutoSave, and traceAutoSave.

Referenced by COMMON_TOOLS::GridProperties(), SYMBOL_VIEWER_FRAME::onSelectNextSymbol(), SYMBOL_VIEWER_FRAME::onSelectPreviousSymbol(), KIWAY::ProcessEvent(), and SYMBOL_VIEWER_FRAME::ReCreateSymbolList().

◆ ProjectChanged()

virtual void EDA_BASE_FRAME::ProjectChanged ( )
inlinevirtualinherited

Notification event that the project has changed.

Reimplemented in PCB_EDIT_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 492 of file eda_base_frame.h.

492 {}

Referenced by KIWAY::ProjectChanged().

◆ PushCommandToRedoList()

void EDA_BASE_FRAME::PushCommandToRedoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

Add a command to redo in the redo list.

Delete the very old commands when the max count of redo commands is reached.

Definition at line 1066 of file eda_base_frame.cpp.

1067 {
1068  m_redoList.PushCommand( aNewitem );
1069 
1070  // Delete the extra items, if count max reached
1071  if( m_undoRedoCountMax > 0 )
1072  {
1073  int extraitems = GetRedoCommandCount() - m_undoRedoCountMax;
1074 
1075  if( extraitems > 0 )
1076  ClearUndoORRedoList( REDO_LIST, extraitems );
1077  }
1078 }
virtual int GetRedoCommandCount() const
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)
UNDO_REDO_CONTAINER m_redoList

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetRedoCommandCount(), EDA_BASE_FRAME::m_redoList, EDA_BASE_FRAME::m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::REDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

void EDA_BASE_FRAME::PushCommandToUndoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

Add a command to undo in the undo list.

Delete the very old commands when the max count of undo commands is reached.

Definition at line 1051 of file eda_base_frame.cpp.

1052 {
1053  m_undoList.PushCommand( aNewitem );
1054 
1055  // Delete the extra items, if count max reached
1056  if( m_undoRedoCountMax > 0 )
1057  {
1058  int extraitems = GetUndoCommandCount() - m_undoRedoCountMax;
1059 
1060  if( extraitems > 0 )
1061  ClearUndoORRedoList( UNDO_LIST, extraitems );
1062  }
1063 }
UNDO_REDO_CONTAINER m_undoList
virtual void ClearUndoORRedoList(UNDO_REDO_LIST aList, int aItemCount=-1)
void PushCommand(PICKED_ITEMS_LIST *aCommand)
virtual int GetUndoCommandCount() const

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::GetUndoCommandCount(), EDA_BASE_FRAME::m_undoList, EDA_BASE_FRAME::m_undoRedoCountMax, UNDO_REDO_CONTAINER::PushCommand(), and EDA_BASE_FRAME::UNDO_LIST.

Referenced by PL_EDITOR_FRAME::GetLayoutFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::StartNewUndo().

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const std::string &  actionName)
virtualinherited

NB: the definition of "tool" is different at the user level.

The implementation uses a single TOOL_BASE derived class to implement several user "tools", such as rectangle and circle, or wire and bus. So each user-level tool is actually a TOOL_ACTION.

Definition at line 43 of file tools_holder.cpp.

44 {
45  m_toolStack.push_back( actionName );
46 
47  // Human cognitive stacking is very shallow; deeper tool stacks just get annoying
48  if( m_toolStack.size() > 3 )
49  m_toolStack.erase( m_toolStack.begin() );
50 
51  TOOL_ACTION* action = m_toolManager->GetActionManager()->FindAction( actionName );
52 
53  if( action )
54  DisplayToolMsg( action->GetLabel() );
55  else
56  DisplayToolMsg( actionName );
57 }
virtual void DisplayToolMsg(const wxString &msg)
Definition: tools_holder.h:122
TOOL_ACTION * FindAction(const std::string &aActionName) const
Find an action with a given name (if there is one available).
wxString GetLabel() const
Definition: tool_action.cpp:70
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
std::vector< std::string > m_toolStack
Definition: tools_holder.h:163
Represent a single user action.
Definition: tool_action.h:49
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:197

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_ACTION::GetLabel(), TOOLS_HOLDER::m_toolManager, and TOOLS_HOLDER::m_toolStack.

Referenced by EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), DRAWING_TOOL::InteractivePlaceWithPreview(), ZOOM_TOOL::Main(), PCB_PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ ReCreateMainToolbar()

void EDA_3D_VIEWER::ReCreateMainToolbar ( )
private

Definition at line 36 of file 3d_toolbar.cpp.

37 {
38  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::ReCreateMainToolbar" );
39 
40  wxWindowUpdateLocker dummy( this );
41 
42  if( m_mainToolBar )
43  {
45  }
46  else
47  {
48  m_mainToolBar = new ACTION_TOOLBAR( this, ID_H_TOOLBAR, wxDefaultPosition, wxDefaultSize,
49  KICAD_AUI_TB_STYLE | wxAUI_TB_HORZ_LAYOUT | wxAUI_TB_HORIZONTAL );
51  }
52 
53  // Set up toolbar
54  m_mainToolBar->AddTool( ID_RELOAD3D_BOARD, wxEmptyString,
55  KiScaledBitmap( BITMAPS::import3d, this ), _( "Reload board" ) );
56 
58  m_mainToolBar->AddTool( ID_TOOL_SCREENCOPY_TOCLIBBOARD, wxEmptyString,
60  _( "Copy 3D image to clipboard" ) );
61 
63  m_mainToolBar->AddTool( ID_TOOL_SET_VISIBLE_ITEMS, wxEmptyString,
65  _( "Set display options, and some layers visibility" ) );
66 
68  m_mainToolBar->AddTool( ID_RENDER_CURRENT_VIEW, wxEmptyString,
70  _( "Render current view using Raytracing" ), wxITEM_CHECK );
71 
77 
81 
85 
89 
92 
98 
101 
103 }
static TOOL_ACTION rotateXCW
Definition: 3d_actions.h:47
Define the structure of a toolbar with buttons that invoke ACTIONs.
static TOOL_ACTION zoomInCenter
Definition: actions.h:96
static constexpr bool TOGGLE
void AddScaledSeparator(wxWindow *aWindow)
Add a separator that introduces space on either side to not squash the tools when scaled.
void Add(const TOOL_ACTION &aAction, bool aIsToggleEntry=false, bool aIsCancellable=false)
Add a TOOL_ACTION-based button to the toolbar.
static TOOL_ACTION zoomFitScreen
Definition: actions.h:99
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
void SetAuiManager(wxAuiManager *aManager)
Set the AUI manager that this toolbar belongs to.
wxAuiManager m_auimgr
bool KiRealize()
Use this over Realize() to avoid a rendering glitch with fixed orientation toolbars.
static TOOL_ACTION zoomOutCenter
Definition: actions.h:97
static TOOL_ACTION flipView
Definition: 3d_actions.h:59
static TOOL_ACTION moveLeft
Definition: 3d_actions.h:53
static TOOL_ACTION rotateYCW
Definition: 3d_actions.h:49
static TOOL_ACTION rotateXCCW
Definition: 3d_actions.h:48
static TOOL_ACTION rotateZCCW
Definition: 3d_actions.h:52
static TOOL_ACTION rotateZCW
Definition: 3d_actions.h:51
static TOOL_ACTION moveDown
Definition: 3d_actions.h:56
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
static TOOL_ACTION rotateYCCW
Definition: 3d_actions.h:50
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION zoomRedraw
Definition: actions.h:93
static TOOL_ACTION moveUp
Definition: 3d_actions.h:55
static constexpr int KICAD_AUI_TB_STYLE
< Default style flags used for wxAUI toolbars.
ACTION_TOOLBAR * m_mainToolBar
static TOOL_ACTION toggleOrtho
Definition: 3d_actions.h:60
static TOOL_ACTION moveRight
Definition: 3d_actions.h:54
wxBitmap KiScaledBitmap(BITMAPS aBitmap, wxWindow *aWindow, int aHeight)
Construct a wxBitmap from a memory record, scaling it if device DPI demands it.
Definition: bitmap.cpp:147
void ClearToolbar()
Clear the toolbar and remove all associated menus.

References _, ACTION_TOOLBAR::Add(), ACTION_TOOLBAR::AddScaledSeparator(), ACTION_TOOLBAR::ClearToolbar(), config, copy, dummy(), EDA_3D_ACTIONS::flipView, ID_H_TOOLBAR, ID_RELOAD3D_BOARD, ID_RENDER_CURRENT_VIEW, ID_TOOL_SCREENCOPY_TOCLIBBOARD, ID_TOOL_SET_VISIBLE_ITEMS, import3d, EDA_BASE_FRAME::KICAD_AUI_TB_STYLE, ACTION_TOOLBAR::KiRealize(), KiScaledBitmap(), EDA_BASE_FRAME::m_auimgr, m_logTrace, m_mainToolBar, EDA_3D_ACTIONS::moveDown, EDA_3D_ACTIONS::moveLeft, EDA_3D_ACTIONS::moveRight, EDA_3D_ACTIONS::moveUp, render_mode, EDA_3D_ACTIONS::rotateXCCW, EDA_3D_ACTIONS::rotateXCW, EDA_3D_ACTIONS::rotateYCCW, EDA_3D_ACTIONS::rotateYCW, EDA_3D_ACTIONS::rotateZCCW, EDA_3D_ACTIONS::rotateZCW, ACTION_TOOLBAR::SetAuiManager(), ACTION_TOOLBAR::TOGGLE, EDA_3D_ACTIONS::toggleOrtho, ACTIONS::zoomFitScreen, ACTIONS::zoomInCenter, ACTIONS::zoomOutCenter, and ACTIONS::zoomRedraw.

Referenced by CommonSettingsChanged().

◆ ReCreateMenuBar()

◆ Redraw()

void EDA_3D_VIEWER::Redraw ( )

Definition at line 269 of file eda_3d_viewer.cpp.

270 {
271  // Only update in OpenGL for an interactive interaction
273  m_canvas->Request_refresh( true );
274 }
void Request_refresh(bool aRedrawImmediately=true)
Schedule a refresh update of the canvas.
EDA_3D_CANVAS * m_canvas
RENDER_ENGINE GetRenderEngine() const noexcept
BOARD_ADAPTER m_boardAdapter

References BOARD_ADAPTER::GetRenderEngine(), m_boardAdapter, m_canvas, OPENGL_LEGACY, and EDA_3D_CANVAS::Request_refresh().

Referenced by PCB_BASE_FRAME::Update3DView().

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )
inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 152 of file tools_holder.h.

152 { }

Referenced by TOOL_MANAGER::ProcessEvent().

◆ refreshRender()

void EDA_3D_VIEWER::refreshRender ( )
private

Definition at line 277 of file eda_3d_viewer.cpp.

278 {
281  else
282  NewDisplay( true );
283 }
void Request_refresh(bool aRedrawImmediately=true)
Schedule a refresh update of the canvas.
EDA_3D_CANVAS * m_canvas
RENDER_ENGINE GetRenderEngine() const noexcept
BOARD_ADAPTER m_boardAdapter
void NewDisplay(bool aForceImmediateRedraw=false)
Reload and refresh (rebuild) the 3D scene.

References BOARD_ADAPTER::GetRenderEngine(), m_boardAdapter, m_canvas, NewDisplay(), OPENGL_LEGACY, and EDA_3D_CANVAS::Request_refresh().

Referenced by Process_Special_Functions(), Set3DBoardBodyColorFromUser(), Set3DCopperColorFromUser(), Set3DSilkScreenColorFromUser(), Set3DSolderMaskColorFromUser(), and Set3DSolderPasteColorFromUser().

◆ RegisterUIUpdateHandler() [1/2]

virtual void TOOLS_HOLDER::RegisterUIUpdateHandler ( const TOOL_ACTION aAction,
const ACTION_CONDITIONS aConditions 
)
inlinevirtualinherited

Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

Parameters
aActionis the action to register.
aConditionsare the UI conditions to use for the control states.

Definition at line 64 of file tools_holder.h.

66  {
67  RegisterUIUpdateHandler( aAction.GetUIId(), aConditions );
68  }
int GetUIId() const
Definition: tool_action.h:112
virtual void RegisterUIUpdateHandler(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Register an action's update conditions with the UI layer to allow the UI to appropriately display the...
Definition: tools_holder.h:64

References TOOL_ACTION::GetUIId().

Referenced by ACTION_TOOLBAR::doSelectAction(), and ACTION_MANAGER::SetConditions().

◆ RegisterUIUpdateHandler() [2/2]

void EDA_BASE_FRAME::RegisterUIUpdateHandler ( int  aID,
const ACTION_CONDITIONS aConditions 
)
overridevirtualinherited

Register a UI update handler for the control with ID aID.

Parameters
aIDis the control ID to register the handler for
aConditionsare the UI conditions to use for the control states

Reimplemented from TOOLS_HOLDER.

Definition at line 326 of file eda_base_frame.cpp.

327 {
329  std::placeholders::_1,
330  this,
331  aConditions );
332 
333  m_uiUpdateMap[aID] = evtFunc;
334 
335  Bind( wxEVT_UPDATE_UI, evtFunc, aID );
336 }
static void HandleUpdateUIEvent(wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
Handle events generated when the UI is trying to figure out the current state of the UI controls rela...
std::function< void(wxUpdateUIEvent &) > UIUpdateHandler
This is the handler functor for the update UI events.
std::map< int, UIUpdateHandler > m_uiUpdateMap
Set by the close window event handler after frames are asked if they can close.

References EDA_BASE_FRAME::HandleUpdateUIEvent(), and EDA_BASE_FRAME::m_uiUpdateMap.

Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::setupUIConditions(), setupUIConditions(), and EDA_BASE_FRAME::setupUIConditions().

◆ ReloadRequest()

void EDA_3D_VIEWER::ReloadRequest ( )

Request reloading the 3D view.

However the request will be executed only when the 3D canvas is refreshed. It allows one to prepare changes and request for 3D rebuild only when all changes are committed. This is made because the 3D rebuild can take a long time, and this rebuild cannot always made after each change, for calculation time reason.

Definition at line 250 of file eda_3d_viewer.cpp.

251 {
252  // This will schedule a request to load later
253  if( m_canvas )
254  m_canvas->ReloadRequest( GetBoard(), Prj().Get3DCacheManager() );
255 }
EDA_3D_CANVAS * m_canvas
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void ReloadRequest(BOARD *aBoard=nullptr, S3D_CACHE *aCachePointer=nullptr)
BOARD * GetBoard()
Definition: eda_3d_viewer.h:76

References GetBoard(), m_canvas, KIWAY_HOLDER::Prj(), and EDA_3D_CANVAS::ReloadRequest().

Referenced by NewDisplay(), and PCB_BASE_FRAME::Update3DView().

◆ RenderEngineChanged()

void EDA_3D_VIEWER::RenderEngineChanged ( )
private

RenderEngineChanged - Update toolbar icon and call canvas RenderEngineChanged.

Definition at line 896 of file eda_3d_viewer.cpp.

897 {
898  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::RenderEngineChanged()" );
899 
900  if( m_canvas )
902 }
EDA_3D_CANVAS * m_canvas
void RenderEngineChanged()
Notify that the render engine was changed.
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.

References m_canvas, m_logTrace, and EDA_3D_CANVAS::RenderEngineChanged().

Referenced by OnRenderEngineSelection(), and Process_Special_Functions().

◆ SaveProjectSettings()

virtual void EDA_BASE_FRAME::SaveProjectSettings ( )
inlinevirtualinherited

Save changes to the project settings to the project (.pro) file.

The method is virtual so you can override it to call the suitable save method. The base method does nothing.

Parameters
aAskForSavetrue to open a dialog before saving the settings.

Reimplemented in PCB_EDIT_FRAME, and SCH_EDIT_FRAME.

Definition at line 353 of file eda_base_frame.h.

353 {};

Referenced by DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ SaveSettings()

void EDA_3D_VIEWER::SaveSettings ( APP_SETTINGS_BASE aCfg)
overrideprivatevirtual

Save common frame parameters to a configuration data file.

Don't forget to call the base class's SaveSettings() from your derived SaveSettings() otherwise the frames won't remember their positions and sizes.

Reimplemented from EDA_BASE_FRAME.

Definition at line 584 of file eda_3d_viewer.cpp.

585 {
586  auto cfg = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>();
587 
589 
590  wxLogTrace( m_logTrace, "EDA_3D_VIEWER::SaveSettings" );
591 
592  COLOR_SETTINGS* colors = Pgm().GetSettingsManager().GetColorSettings();
593 
594  auto save_color =
595  [colors] ( SFVEC4F& aSource, LAYER_3D_ID aTarget )
596  {
597  // You could think just copy the new color in config is enough.
598  // unfortunately, SFVEC4F uses floats, and COLOR4D uses doubles,
599  // and the conversion SFVEC4F from/to COLOR4D creates small diffs.
600  //
601  // This has no matter to draw colors, but creates slight differences
602  // in config file, that appears always modified.
603  // So we must compare the SFVEC4F old and new values and update only
604  // actual changes.
605  SFVEC4F newSFVEC4Fcolor( float( colors->GetColor( aTarget ).r ),
606  float( colors->GetColor( aTarget ).g ),
607  float( colors->GetColor( aTarget ).b ),
608  float( colors->GetColor( aTarget ).a ) );
609 
610  if( aSource != newSFVEC4Fcolor )
611  colors->SetColor( aTarget, COLOR4D( aSource.r, aSource.g, aSource.b,
612  aSource.a ) );
613  };
614 
623 
624  Pgm().GetSettingsManager().SaveColorSettings( colors, "3d_viewer" );
625 
627  "EDA_3D_VIEWER::SaveSettings render setting Ray Trace" :
628  "EDA_3D_VIEWER::SaveSettings render setting OpenGL" );
629 
630  if( cfg )
631  {
632 
633  auto save_color =
634  [] ( const SFVEC3F& aSource, COLOR4D& aTarget )
635  {
636  aTarget = COLOR4D( aSource.r, aSource.g, aSource.b, 1.0 );
637  };
638 
639  save_color( m_boardAdapter.m_RtCameraLightColor, cfg->m_Render.raytrace_lightColorCamera );
640  save_color( m_boardAdapter.m_RtLightColorTop, cfg->m_Render.raytrace_lightColorTop );
641  save_color( m_boardAdapter.m_RtLightColorBottom, cfg->m_Render.raytrace_lightColorBottom );
642 
643  for( size_t i = 0; i < cfg->m_Render.raytrace_lightColor.size(); ++i )
644  {
645  save_color( m_boardAdapter.m_RtLightColor[i], cfg->m_Render.raytrace_lightColor[i] );
646 
647  cfg->m_Render.raytrace_lightElevation[i] =
648  (int)( m_boardAdapter.m_RtLightSphericalCoords[i].x * 180.0f - 90.0f );
649  cfg->m_Render.raytrace_lightAzimuth[i] =
650  (int)( m_boardAdapter.m_RtLightSphericalCoords[i].y * 180.0f );
651  }
652 
653  cfg->m_Render.raytrace_nrsamples_shadows = m_boardAdapter.m_RtShadowSampleCount;
654  cfg->m_Render.raytrace_nrsamples_reflections = m_boardAdapter.m_RtReflectionSampleCount;
655  cfg->m_Render.raytrace_nrsamples_refractions = m_boardAdapter.m_RtRefractionSampleCount;
656 
657  cfg->m_Render.raytrace_spread_shadows = m_boardAdapter.m_RtSpreadShadows;
658  cfg->m_Render.raytrace_spread_reflections = m_boardAdapter.m_RtSpreadReflections;
659  cfg->m_Render.raytrace_spread_refractions = m_boardAdapter.m_RtSpreadRefractions;
660 
661  cfg->m_Render.raytrace_recursivelevel_refractions =
663  cfg->m_Render.raytrace_recursivelevel_reflections =
665 
666 #define TRANSFER_SETTING( field, flag ) cfg->m_Render.field = m_boardAdapter.GetFlag( flag )
667 
668  cfg->m_Render.engine = static_cast<int>( m_boardAdapter.GetRenderEngine() );
669  cfg->m_Render.grid_type = static_cast<int>( m_boardAdapter.GetGridType() );
670  cfg->m_Render.material_mode = static_cast<int>( m_boardAdapter.GetMaterialMode() );
671  cfg->m_Render.opengl_AA_mode = static_cast<int>( m_boardAdapter.GetAntiAliasingMode() );
672 
673  save_color( m_boardAdapter.m_OpenGlSelectionColor, cfg->m_Render.opengl_selection_color );
674 
675  cfg->m_Camera.animation_enabled = m_canvas->AnimationEnabledGet();
676  cfg->m_Camera.moving_speed_multiplier = m_canvas->MovingSpeedMultiplierGet();
677 
678  if( EDA_3D_CONTROLLER* ctrlTool = GetToolManager()->GetTool<EDA_3D_CONTROLLER>() )
679  cfg->m_Camera.rotation_increment = ctrlTool->GetRotationIncrement();
680 
681  TRANSFER_SETTING( opengl_AA_disableOnMove, FL_RENDER_OPENGL_AA_DISABLE_ON_MOVE );
682  TRANSFER_SETTING( opengl_copper_thickness, FL_RENDER_OPENGL_COPPER_THICKNESS );
683  TRANSFER_SETTING( opengl_show_model_bbox, FL_RENDER_OPENGL_SHOW_MODEL_BBOX );
684  TRANSFER_SETTING( opengl_thickness_disableOnMove,
686  TRANSFER_SETTING( opengl_vias_disableOnMove, FL_RENDER_OPENGL_VIAS_DISABLE_ON_MOVE );
687  TRANSFER_SETTING( opengl_holes_disableOnMove, FL_RENDER_OPENGL_HOLES_DISABLE_ON_MOVE );
688 
689  TRANSFER_SETTING( raytrace_anti_aliasing, FL_RENDER_RAYTRACING_ANTI_ALIASING );
690  TRANSFER_SETTING( raytrace_backfloor, FL_RENDER_RAYTRACING_BACKFLOOR );
691  TRANSFER_SETTING( raytrace_post_processing, FL_RENDER_RAYTRACING_POST_PROCESSING );
692  TRANSFER_SETTING( raytrace_procedural_textures, FL_RENDER_RAYTRACING_PROCEDURAL_TEXTURES );
693  TRANSFER_SETTING( raytrace_reflections, FL_RENDER_RAYTRACING_REFLECTIONS );
694  TRANSFER_SETTING( raytrace_refractions, FL_RENDER_RAYTRACING_REFRACTIONS );
695  TRANSFER_SETTING( raytrace_shadows, FL_RENDER_RAYTRACING_SHADOWS );
696 
698  TRANSFER_SETTING( show_adhesive, FL_ADHESIVE );
699  TRANSFER_SETTING( show_axis, FL_AXIS );
700  TRANSFER_SETTING( show_board_body, FL_SHOW_BOARD_BODY );
701  TRANSFER_SETTING( clip_silk_on_via_annulus, FL_CLIP_SILK_ON_VIA_ANNULUS );
702  TRANSFER_SETTING( renderPlatedPadsAsPlated, FL_RENDER_PLATED_PADS_AS_PLATED );
703  TRANSFER_SETTING( show_comments, FL_COMMENTS );
704  TRANSFER_SETTING( show_eco, FL_ECO );
705  TRANSFER_SETTING( show_footprints_insert, FL_FP_ATTRIBUTES_NORMAL_INSERT );
706  TRANSFER_SETTING( show_footprints_normal, FL_FP_ATTRIBUTES_NORMAL );
707  TRANSFER_SETTING( show_footprints_virtual, FL_FP_ATTRIBUTES_VIRTUAL );
708  TRANSFER_SETTING( show_silkscreen, FL_SILKSCREEN );
709  TRANSFER_SETTING( show_soldermask, FL_SOLDERMASK );
710  TRANSFER_SETTING( show_solderpaste, FL_SOLDERPASTE );
711  TRANSFER_SETTING( show_zones, FL_ZONE );
712  TRANSFER_SETTING( subtract_mask_from_silk, FL_SUBTRACT_MASK_FROM_SILK );
713 
714 #undef TRANSFER_SETTING
715  }
716 }
GRID3D_TYPE GetGridType() const noexcept
Get the current grid.
int m_RtShadowSampleCount
SFVEC4F m_SilkScreenColorBot
in realistic mode: SilkScreen color ( bot )
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Save common frame parameters to a configuration data file.
glm::vec4 SFVEC4F
Definition: xv3d_types.h:46
SFVEC4F m_SolderMaskColorTop
in realistic mode: solder mask color ( top )
LAYER_3D_ID
3D Viewer virtual layers for color settings
std::vector< SFVEC2F > m_RtLightSphericalCoords
SFVEC4F m_BoardBodyColor
in realistic mode: FR4 board color
SFVEC4F m_SolderPasteColor
in realistic mode: solder paste color
double g
Green component.
Definition: color4d.h:359
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
float m_RtSpreadRefractions
SFVEC3F m_RtCameraLightColor
double b
Blue component.
Definition: color4d.h:360
EDA_3D_CANVAS * m_canvas
RENDER_ENGINE GetRenderEngine() const noexcept
BOARD_ADAPTER m_boardAdapter
double a
Alpha component.
Definition: color4d.h:361
int m_RtRecursiveReflectionCount
float m_RtSpreadReflections
SFVEC4F m_BgColorTop
background top color
#define TRANSFER_SETTING(flag, field)
EDA_3D_CONTROLLER.
Definition: 3d_controller.h:39
MATERIAL_MODE GetMaterialMode() const noexcept
SFVEC3F m_RtLightColorTop
bool AnimationEnabledGet() const
Return whether camera animation is enabled when switching to a pre-defined view.
SFVEC4F m_BgColorBot
background bottom color
int m_RtRecursiveRefractionCount
std::vector< SFVEC3F > m_RtLightColor
int m_RtRefractionSampleCount
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
COLOR4D GetColor(int aLayer) const
int MovingSpeedMultiplierGet() const
Return the current camera animation moving speed multiplier option.
ANTIALIASING_MODE GetAntiAliasingMode() const
Get the current antialiasing mode value.
glm::vec3 SFVEC3F
Definition: xv3d_types.h:44
SFVEC4F m_CopperColor
in realistic mode: copper color
SFVEC3F m_OpenGlSelectionColor
Color settings are a bit different than most of the settings objects in that there can be more than o...
SFVEC4F m_SilkScreenColorTop
in realistic mode: SilkScreen color ( top )
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
double r
Red component.
Definition: color4d.h:358
SFVEC3F m_RtLightColorBottom
float m_RtSpreadShadows
int m_RtReflectionSampleCount
void SetColor(int aLayer, COLOR4D aColor)
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References KIGFX::COLOR4D::a, EDA_3D_CANVAS::AnimationEnabledGet(), KIGFX::COLOR4D::b, FL_ADHESIVE, FL_AXIS, FL_CLIP_SILK_ON_VIA_ANNULUS, FL_COMMENTS, FL_ECO, FL_FP_ATTRIBUTES_NORMAL, FL_FP_ATTRIBUTES_NORMAL_INSERT, FL_FP_ATTRIBUTES_VIRTUAL, FL_RENDER_OPENGL_AA_DISABLE_ON_MOVE, FL_RENDER_OPENGL_COPPER_THICKNESS, FL_RENDER_OPENGL_HOLES_DISABLE_ON_MOVE, FL_RENDER_OPENGL_SHOW_MODEL_BBOX, FL_RENDER_OPENGL_THICKNESS_DISABLE_ON_MOVE, FL_RENDER_OPENGL_VIAS_DISABLE_ON_MOVE, FL_RENDER_PLATED_PADS_AS_PLATED, FL_RENDER_RAYTRACING_ANTI_ALIASING, FL_RENDER_RAYTRACING_BACKFLOOR, FL_RENDER_RAYTRACING_POST_PROCESSING, FL_RENDER_RAYTRACING_PROCEDURAL_TEXTURES, FL_RENDER_RAYTRACING_REFLECTIONS, FL_RENDER_RAYTRACING_REFRACTIONS, FL_RENDER_RAYTRACING_SHADOWS, FL_SHOW_BOARD_BODY, FL_SILKSCREEN, FL_SOLDERMASK, FL_SOLDERPASTE, FL_SUBTRACT_MASK_FROM_SILK, FL_USE_REALISTIC_MODE, FL_ZONE, KIGFX::COLOR4D::g, BOARD_ADAPTER::GetAntiAliasingMode(), COLOR_SETTINGS::GetColor(), BOARD_ADAPTER::GetGridType(), BOARD_ADAPTER::GetMaterialMode(), BOARD_ADAPTER::GetRenderEngine(), TOOLS_HOLDER::GetToolManager(), LAYER_3D_BACKGROUND_BOTTOM, LAYER_3D_BACKGROUND_TOP, LAYER_3D_BOARD, LAYER_3D_COPPER, LAYER_3D_SILKSCREEN_BOTTOM, LAYER_3D_SILKSCREEN_TOP, LAYER_3D_SOLDERMASK, LAYER_3D_SOLDERPASTE, BOARD_ADAPTER::m_BgColorBot, BOARD_ADAPTER::m_BgColorTop, m_boardAdapter, BOARD_ADAPTER::m_BoardBodyColor, m_canvas, BOARD_ADAPTER::m_CopperColor, m_logTrace, BOARD_ADAPTER::m_OpenGlSelectionColor, BOARD_ADAPTER::m_RtCameraLightColor, BOARD_ADAPTER::m_RtLightColor, BOARD_ADAPTER::m_RtLightColorBottom, BOARD_ADAPTER::m_RtLightColorTop, BOARD_ADAPTER::m_RtLightSphericalCoords, BOARD_ADAPTER::m_RtRecursiveReflectionCount, BOARD_ADAPTER::m_RtRecursiveRefractionCount, BOARD_ADAPTER::m_RtReflectionSampleCount, BOARD_ADAPTER::m_RtRefractionSampleCount, BOARD_ADAPTER::m_RtShadowSampleCount, BOARD_ADAPTER::m_RtSpreadReflections, BOARD_ADAPTER::m_RtSpreadRefractions, BOARD_ADAPTER::m_RtSpreadShadows, BOARD_ADAPTER::m_SilkScreenColorBot, BOARD_ADAPTER::m_SilkScreenColorTop, BOARD_ADAPTER::m_SolderMaskColorTop, BOARD_ADAPTER::m_SolderPasteColor, EDA_3D_CANVAS::MovingSpeedMultiplierGet(), Pgm(), KIGFX::COLOR4D::r, RAYTRACING, EDA_BASE_FRAME::SaveSettings(), COLOR_SETTINGS::SetColor(), and TRANSFER_SETTING.

◆ SaveWindowSettings()

void EDA_BASE_FRAME::SaveWindowSettings ( WINDOW_SETTINGS aCfg)
inherited

Save window settings to the given settings object.

Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window.

Definition at line 627 of file eda_base_frame.cpp.

628 {
629  wxString text;
630 
631  if( IsIconized() )
632  return;
633 
634  wxString baseCfgName = ConfigBaseName();
635 
636  // If the window is maximized, we use the saved window size from before it was maximized
637  if( IsMaximized() )
638  {
641  }
642  else
643  {
645  m_framePos = GetPosition();
646  }
647 
648  aCfg->state.pos_x = m_framePos.x;
649  aCfg->state.pos_y = m_framePos.y;
650  aCfg->state.size_x = m_frameSize.x;
651  aCfg->state.size_y = m_frameSize.y;
652  aCfg->state.maximized = IsMaximized();
653  aCfg->state.display = wxDisplay::GetFromWindow( this );
654 
655  wxLogTrace( traceDisplayLocation, "Saving window maximized: %s", IsMaximized() ? "true" : "false" );
656  wxLogTrace( traceDisplayLocation, "Saving config position (%d, %d) with size (%d, %d)",
658 
659  // TODO(JE) should auto-save in common settings be overwritten by every app?
660  if( m_hasAutoSave )
661  Pgm().GetCommonSettings()->m_System.autosave_interval = m_autoSaveInterval;
662 
663  // Once this is fully implemented, wxAuiManager will be used to maintain
664  // the persistence of the main frame and all it's managed windows and
665  // all of the legacy frame persistence position code can be removed.
666  aCfg->perspective = m_auimgr.SavePerspective().ToStdString();
667 
668  aCfg->mru_path = m_mruPath;
669 }
wxString mru_path
Definition: app_settings.h:84
wxString m_mruPath
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxPoint m_normalFramePos
wxAuiManager m_auimgr
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
wxString perspective
Definition: app_settings.h:85
wxSize m_normalFrameSize
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.
wxString ConfigBaseName() override
Get the configuration base name.
WINDOW_STATE state
Definition: app_settings.h:83
unsigned int display
Definition: app_settings.h:75

References EDA_BASE_FRAME::ConfigBaseName(), WINDOW_STATE::display, EDA_BASE_FRAME::GetWindowSize(), EDA_BASE_FRAME::m_auimgr, EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_framePos, EDA_BASE_FRAME::m_frameSize, EDA_BASE_FRAME::m_hasAutoSave, EDA_BASE_FRAME::m_mruPath, EDA_BASE_FRAME::m_normalFramePos, EDA_BASE_FRAME::m_normalFrameSize, WINDOW_STATE::maximized, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, Pgm(), WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, text, and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ Set3DBoardBodyColorFromUser()

bool EDA_3D_VIEWER::Set3DBoardBodyColorFromUser ( )

Set the copper color from a set of colors.

Returns
true if a new color is chosen, false if no change or aborted by user.

Definition at line 1011 of file eda_3d_viewer.cpp.

1012 {
1013  CUSTOM_COLORS_LIST colors;
1014 
1015  colors.push_back( CUSTOM_COLOR_ITEM( 51/255.0, 43/255.0, 22/255.0, 0.9,
1016  "FR4 natural, dark" ) );
1017  colors.push_back( CUSTOM_COLOR_ITEM( 109/255.0, 116/255.0, 75/255.0, 0.9, "FR4 natural" ) );
1018  colors.push_back( CUSTOM_COLOR_ITEM( 78/255.0, 14/255.0, 5/255.0, 0.9, "brown/red" ) );
1019  colors.push_back( CUSTOM_COLOR_ITEM( 146/255.0, 99/255.0, 47/255.0, 0.9, "brown 1" ) );
1020  colors.push_back( CUSTOM_COLOR_ITEM( 160/255.0, 123/255.0, 54/255.0, 0.9, "brown 2" ) );
1021  colors.push_back( CUSTOM_COLOR_ITEM( 146/255.0, 99/255.0, 47/255.0, 0.9, "brown 3" ) );
1022  colors.push_back( CUSTOM_COLOR_ITEM( 63/255.0, 126/255.0, 71/255.0, 0.9, "green 1" ) );
1023  colors.push_back( CUSTOM_COLOR_ITEM( 117/255.0, 122/255.0, 90/255.0, 0.9, "green 2" ) );
1024 
1025  if( Set3DColorFromUser( m_boardAdapter.m_BoardBodyColor, _( "Board Body Color" ), &colors,
1026  true, colors[0].m_Color ) )
1027  {
1028  refreshRender();
1029 
1030  return true;
1031  }
1032 
1033  return false;
1034 }
SFVEC4F m_BoardBodyColor
in realistic mode: FR4 board color
A class to handle a custom color (predefined color) for the color picker dialog.
std::vector< CUSTOM_COLOR_ITEM > CUSTOM_COLORS_LIST
BOARD_ADAPTER m_boardAdapter
bool Set3DColorFromUser(SFVEC4F &aColor, const wxString &aTitle, CUSTOM_COLORS_LIST *aPredefinedColors, bool aAllowOpacityControl=false, KIGFX::COLOR4D aDefaultColor=KIGFX::COLOR4D(1.0, 1.0, 1.0, 1.0))
Get a SFVEC3D from a color dialog.
#define _(s)
Definition: 3d_actions.cpp:33

References _, m_boardAdapter, BOARD_ADAPTER::m_BoardBodyColor, refreshRender(), and Set3DColorFromUser().

Referenced by Process_Special_Functions().

◆ Set3DColorFromUser()

bool EDA_3D_VIEWER::Set3DColorFromUser ( SFVEC4F aColor,
const wxString &  aTitle,
CUSTOM_COLORS_LIST aPredefinedColors,
bool  aAllowOpacityControl = false,
KIGFX::COLOR4D  aDefaultColor = KIGFX::COLOR4D( 1.0, 1.0, 1.0, 1.0 ) 
)

Get a SFVEC3D from a color dialog.

Parameters
aColoris the SFVEC3D to change.
aTitleis the title displayed in the colordialog selector.
aPredefinedColorsis a reference to a CUSTOM_COLOR_ITEM list which contains. a few predefined colors

Definition at line 905 of file eda_3d_viewer.cpp.

909 {
910  KIGFX::COLOR4D newcolor;
911  KIGFX::COLOR4D oldcolor( aColor.r,aColor.g, aColor.b, aColor.a );
912 
913  DIALOG_COLOR_PICKER picker( this, oldcolor, aAllowOpacityControl, aPredefinedColors,
914  aDefaultColor );
915 
916  if( picker.ShowModal() != wxID_OK )
917  return false;
918 
919  newcolor = picker.GetColor();
920 
921  if( newcolor == oldcolor )
922  return false;
923 
924  aColor.r = newcolor.r;
925  aColor.g = newcolor.g;
926  aColor.b = newcolor.b;
927  aColor.a = newcolor.a;
928 
929  return true;
930 }
double g
Green component.
Definition: color4d.h:359
double b
Blue component.
Definition: color4d.h:360
double a
Alpha component.
Definition: color4d.h:361
double r
Red component.
Definition: color4d.h:358
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, DIALOG_COLOR_PICKER::GetColor(), and KIGFX::COLOR4D::r.

Referenced by Process_Special_Functions(), Set3DBoardBodyColorFromUser(), Set3DCopperColorFromUser(), Set3DSilkScreenColorFromUser(), Set3DSolderMaskColorFromUser(), and Set3DSolderPasteColorFromUser().

◆ Set3DCopperColorFromUser()

bool EDA_3D_VIEWER::Set3DCopperColorFromUser ( )

Set the copper color from a set of colors.

Returns
true if a new color is chosen, false if no change or aborted by user.

Definition at line 990 of file eda_3d_viewer.cpp.

991 {
992  CUSTOM_COLORS_LIST colors;
993 
994  colors.push_back( CUSTOM_COLOR_ITEM( 184/255.0, 115/255.0, 50/255.0, "Copper" ) );
995  colors.push_back( CUSTOM_COLOR_ITEM( 178/255.0, 156/255.0, 0.0, "Gold" ) );
996  colors.push_back( CUSTOM_COLOR_ITEM( 213/255.0, 213/255.0, 213/255.0, "Silver" ) );
997  colors.push_back( CUSTOM_COLOR_ITEM( 160/255.0, 160/255.0, 160/255.0, "Tin" ) );
998 
999  if( Set3DColorFromUser( m_boardAdapter.m_CopperColor, _( "Copper Color" ), &colors, false,
1000  colors[0].m_Color ) )
1001  {
1002  refreshRender();
1003 
1004  return true;
1005  }
1006 
1007  return false;
1008 }
A class to handle a custom color (predefined color) for the color picker dialog.
std::vector< CUSTOM_COLOR_ITEM > CUSTOM_COLORS_LIST
BOARD_ADAPTER m_boardAdapter
bool Set3DColorFromUser(SFVEC4F &aColor, const wxString &aTitle, CUSTOM_COLORS_LIST *aPredefinedColors, bool aAllowOpacityControl=false, KIGFX::COLOR4D aDefaultColor=KIGFX::COLOR4D(1.0, 1.0, 1.0, 1.0))
Get a SFVEC3D from a color dialog.
#define _(s)
Definition: 3d_actions.cpp:33
SFVEC4F m_CopperColor
in realistic mode: copper color

References _, m_boardAdapter, BOARD_ADAPTER::m_CopperColor, refreshRender(), and Set3DColorFromUser().

Referenced by Process_Special_Functions().

◆ Set3DSilkScreenColorFromUser()

bool EDA_3D_VIEWER::Set3DSilkScreenColorFromUser ( )

Set the silkscreen color from a set of colors.

Returns
true if a new color is chosen, false if no change or aborted by user.

Definition at line 933 of file eda_3d_viewer.cpp.

934 {
935  CUSTOM_COLORS_LIST colors;
936 
937  colors.push_back( CUSTOM_COLOR_ITEM( 241.0/255.0, 241.0/255.0, 241.0/255.0, "White" ) );
938  colors.push_back( CUSTOM_COLOR_ITEM( 4.0/255.0, 18.0/255.0, 21.0/255.0, "Dark" ) );
939 
940  if( Set3DColorFromUser( m_boardAdapter.m_SilkScreenColorTop, _( "Silkscreen Color" ),
941  &colors, false, colors[0].m_Color ) )
942  {
944 
945  refreshRender();
946 
947  return true;
948  }
949 
950  return false;
951 }
SFVEC4F m_SilkScreenColorBot
in realistic mode: SilkScreen color ( bot )
A class to handle a custom color (predefined color) for the color picker dialog.
std::vector< CUSTOM_COLOR_ITEM > CUSTOM_COLORS_LIST
BOARD_ADAPTER m_boardAdapter
bool Set3DColorFromUser(SFVEC4F &aColor, const wxString &aTitle, CUSTOM_COLORS_LIST *aPredefinedColors, bool aAllowOpacityControl=false, KIGFX::COLOR4D aDefaultColor=KIGFX::COLOR4D(1.0, 1.0, 1.0, 1.0))
Get a SFVEC3D from a color dialog.
#define _(s)
Definition: 3d_actions.cpp:33
SFVEC4F m_SilkScreenColorTop
in realistic mode: SilkScreen color ( top )

References _, m_boardAdapter, BOARD_ADAPTER::m_SilkScreenColorBot, BOARD_ADAPTER::m_SilkScreenColorTop, refreshRender(), and Set3DColorFromUser().

Referenced by Process_Special_Functions().

◆ Set3DSolderMaskColorFromUser()

bool EDA_3D_VIEWER::Set3DSolderMaskColorFromUser ( )

Set the solder mask color from a set of colors.

Returns
true if a new color is chosen, false if no change or aborted by user.

Definition at line 954 of file eda_3d_viewer.cpp.

955 {
956  CUSTOM_COLORS_LIST colors;
957 
958  colors.push_back( CUSTOM_COLOR_ITEM( 20/255.0, 51/255.0, 36/255.0, 0.83, "Green" ) );
959  colors.push_back( CUSTOM_COLOR_ITEM( 91/255.0, 168/255.0, 12/255.0, 0.83, "Light Green" ) );
960  colors.push_back( CUSTOM_COLOR_ITEM( 13/255.0, 104/255.0, 11/255.0, 0.83,
961  "Saturated Green" ) );
962  colors.push_back( CUSTOM_COLOR_ITEM( 181/255.0, 19/255.0, 21/255.0, 0.83, "Red" ) );
963  colors.push_back( CUSTOM_COLOR_ITEM( 239/255.0, 53/255.0, 41/255.0, 0.83,
964  "Red Light Orange" ) );
965  colors.push_back( CUSTOM_COLOR_ITEM( 210/255.0, 40/255.0, 14/255.0, 0.83, "Red 2" ) );
966  colors.push_back( CUSTOM_COLOR_ITEM( 2/255.0, 59/255.0, 162/255.0, 0.83, "Blue" ) );
967  colors.push_back( CUSTOM_COLOR_ITEM( 54/255.0, 79/255.0, 116/255.0, 0.83, "Light blue 1" ) );
968  colors.push_back( CUSTOM_COLOR_ITEM( 61/255.0, 85/255.0, 130/255.0, 0.83, "Light blue 2" ) );
969  colors.push_back( CUSTOM_COLOR_ITEM( 21/255.0, 70/255.0, 80/255.0, 0.83,
970  "Green blue (dark)" ) );
971  colors.push_back( CUSTOM_COLOR_ITEM( 11/255.0, 11/255.0, 11/255.0, 0.83, "Black" ) );
972  colors.push_back( CUSTOM_COLOR_ITEM( 245/255.0, 245/255.0, 245/255.0, 0.83, "White" ) );
973  colors.push_back( CUSTOM_COLOR_ITEM( 119/255.0, 31/255.0, 91/255.0, 0.83, "Purple" ) );
974  colors.push_back( CUSTOM_COLOR_ITEM( 32/255.0, 2/255.0, 53/255.0, 0.83, "Purple Dark" ) );
975 
976  if( Set3DColorFromUser( m_boardAdapter.m_SolderMaskColorTop, _( "Solder Mask Color" ),
977  &colors, true, colors[0].m_Color ) )
978  {
980 
981  refreshRender();
982 
983  return true;
984  }
985 
986  return false;
987 }
SFVEC4F m_SolderMaskColorTop
in realistic mode: solder mask color ( top )
A class to handle a custom color (predefined color) for the color picker dialog.
SFVEC4F m_SolderMaskColorBot
in realistic mode: solder mask color ( bot )
std::vector< CUSTOM_COLOR_ITEM > CUSTOM_COLORS_LIST
BOARD_ADAPTER m_boardAdapter
bool Set3DColorFromUser(SFVEC4F &aColor, const wxString &aTitle, CUSTOM_COLORS_LIST *aPredefinedColors, bool aAllowOpacityControl=false, KIGFX::COLOR4D aDefaultColor=KIGFX::COLOR4D(1.0, 1.0, 1.0, 1.0))
Get a SFVEC3D from a color dialog.
#define _(s)
Definition: 3d_actions.cpp:33

References _, m_boardAdapter, BOARD_ADAPTER::m_SolderMaskColorBot, BOARD_ADAPTER::m_SolderMaskColorTop, refreshRender(), and Set3DColorFromUser().

Referenced by Process_Special_Functions().

◆ Set3DSolderPasteColorFromUser()

bool EDA_3D_VIEWER::Set3DSolderPasteColorFromUser ( )

Set the solder mask color from a set of colors.

Returns
true if a new color is chosen, false if no change or aborted by user.

Definition at line 1037 of file eda_3d_viewer.cpp.

1038 {
1039  CUSTOM_COLORS_LIST colors;
1040 
1041  colors.push_back( CUSTOM_COLOR_ITEM( 128/255.0, 128/255.0, 128/255.0, "grey" ) );
1042  colors.push_back( CUSTOM_COLOR_ITEM( 213/255.0, 213/255.0, 213/255.0, "Silver" ) );
1043  colors.push_back( CUSTOM_COLOR_ITEM( 90/255.0, 90/255.0, 90/255.0, "grey 2" ) );
1044 
1045  if( Set3DColorFromUser( m_boardAdapter.m_SolderPasteColor, _( "Solder Paste Color" ), &colors,
1046  false, colors[0].m_Color ) )
1047  {
1048  refreshRender();
1049 
1050  return true;
1051  }
1052 
1053  return false;
1054 }
SFVEC4F m_SolderPasteColor
in realistic mode: solder paste color
A class to handle a custom color (predefined color) for the color picker dialog.
std::vector< CUSTOM_COLOR_ITEM > CUSTOM_COLORS_LIST
BOARD_ADAPTER m_boardAdapter
bool Set3DColorFromUser(SFVEC4F &aColor, const wxString &aTitle, CUSTOM_COLORS_LIST *aPredefinedColors, bool aAllowOpacityControl=false, KIGFX::COLOR4D aDefaultColor=KIGFX::COLOR4D(1.0, 1.0, 1.0, 1.0))
Get a SFVEC3D from a color dialog.
#define _(s)
Definition: 3d_actions.cpp:33

References _, m_boardAdapter, BOARD_ADAPTER::m_SolderPasteColor, refreshRender(), and Set3DColorFromUser().

Referenced by Process_Special_Functions().

◆ SetAutoSaveInterval()

void EDA_BASE_FRAME::SetAutoSaveInterval ( int  aInterval)
inherited

Definition at line 275 of file eda_base_frame.cpp.

276 {
277  m_autoSaveInterval = aInterval;
278 
279  if( m_autoSaveTimer->IsRunning() )
280  {
281  if( m_autoSaveInterval > 0 )
282  {
283  m_autoSaveTimer->Start( m_autoSaveInterval * 1000, wxTIMER_ONE_SHOT );
284  }
285  else
286  {
287  m_autoSaveTimer->Stop();
288  m_autoSaveState = false;
289  }
290  }
291 }
wxTimer * m_autoSaveTimer

References EDA_BASE_FRAME::m_autoSaveInterval, EDA_BASE_FRAME::m_autoSaveState, and EDA_BASE_FRAME::m_autoSaveTimer.

Referenced by EDA_DRAW_FRAME::CommonSettingsChanged().

◆ 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::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

43 {
44 #if defined(DEBUG)
45  // offer a trap point for debugging most any window
46  wxASSERT( aDest );
47  if( !strcmp(