/***********************************************************/ /* wxGerberFrame.h: */ /***********************************************************/ #ifndef WX_GERBER_STRUCT_H #define WX_GERBER_STRUCT_H #include "id.h" #include "class_gerbview_layer_widget.h" /** * Command IDs for the gerber file viewer. * * Please add IDs that are unique to the gerber file viewer here and not in the * global id.h file. This will prevent the entire project from being rebuilt * when adding new command to the gerber file viewer. */ enum id_gerbview_frm { // A MenuItem ID of Zero does not work under Mac,first id = 1 ID_GERBVIEW_SHOW_LIST_DCODES = 1, ID_GERBVIEW_LOAD_DRILL_FILE, ID_GERBVIEW_LOAD_DCODE_FILE, ID_TOOLBARH_GERBER_SELECT_TOOL, ID_MENU_INC_LAYER_AND_APPEND_FILE, ID_INC_LAYER_AND_APPEND_FILE, ID_GERBVIEW_SHOW_SOURCE, ID_GERBVIEW_EXPORT_TO_PCBNEW, ID_GERBVIEW_POPUP_DELETE_DCODE_ITEMS, }; /****************************************************************** class WinEDA_GerberFrame: this is the main window used in gerbview ******************************************************************/ class WinEDA_GerberFrame : public WinEDA_BasePcbFrame { friend class PCB_LAYER_WIDGET; protected: GERBER_LAYER_WIDGET* m_LayersManager; public: WinEDAChoiceBox* m_SelLayerBox; WinEDAChoiceBox* m_SelLayerTool; private: bool m_show_layer_manager_tools; public: WinEDA_GerberFrame( wxWindow* father, const wxString& title, const wxPoint& pos, const wxSize& size, long style = KICAD_DEFAULT_DRAWFRAME_STYLE ); ~WinEDA_GerberFrame(); void Update_config(); void OnCloseWindow( wxCloseEvent& Event ); /** Function IsGridVisible() , virtual * @return true if the grid must be shown */ virtual bool IsGridVisible(); /** Function SetGridVisibility() , virtual * It may be overloaded by derived classes * if you want to store/retrieve the grid visiblity in configuration. * @param aVisible = true if the grid must be shown */ virtual void SetGridVisibility(bool aVisible); /** Function GetGridColor() , virtual * @return the color of the grid */ virtual int GetGridColor(); /** Function SetGridColor() , virtual * @param aColor = the new color of the grid */ virtual void SetGridColor(int aColor); /** * Function IsElementVisible * tests whether a given element category is visible. Keep this as an * inline function. * @param aGERBER_VISIBLE is from the enum by the same name * @return bool - true if the element is visible. * @see enum PCB_VISIBLE */ bool IsElementVisible( int aGERBER_VISIBLE ) { return GetBoard()->IsElementVisible( aGERBER_VISIBLE ); } /** * Function SetElementVisibility * changes the visibility of an element category * @param aGERBER_VISIBLE is from the enum by the same name * @param aNewState = The new visibility state of the element category * @see enum PCB_VISIBLE */ void SetElementVisibility( int aGERBER_VISIBLE, bool aNewState ); /** * Function SetVisibleAlls * Set the status of all visible element categories and layers to VISIBLE */ void SetVisibleAlls( ); /** * Function ReFillLayerWidget * changes out all the layers in m_Layers and may be called upon * loading a new BOARD. */ void ReFillLayerWidget(); /** * Function setActiveLayer * will change the currently active layer to \a aLayer and also * update the PCB_LAYER_WIDGET. */ void setActiveLayer( int aLayer, bool doLayerWidgetUpdate = true ) { ( (PCB_SCREEN*) GetScreen() )->m_Active_Layer = aLayer; if( doLayerWidgetUpdate ) syncLayerWidget(); } /** * Function getActiveLayer * returns the active layer */ int getActiveLayer() { return ( (PCB_SCREEN*) GetScreen() )->m_Active_Layer; } /** * Function syncLayerWidget * updates the currently "selected" layer within the PCB_LAYER_WIDGET. * The currently active layer is defined by the return value of getActiveLayer(). *

* This function cannot be inline without including layer_widget.h in * here and we do not want to do that. */ void syncLayerWidget( ); /** * Function syncLayerBox * updates the currently "selected" layer within m_SelLayerBox * The currently active layer, as defined by the return value of * getActiveLayer(). And updates the colored icon in the toolbar. */ void syncLayerBox(); /** * Load applications settings specific to the PCBNew. * * This overrides the base class WinEDA_BasePcbFrame::LoadSettings() to * handle settings specific common to the PCB layout application. It * calls down to the base class to load settings common to all PCB type * drawing frames. Please put your application settings for PCBNew here * to avoid having application settings loaded all over the place. */ virtual void LoadSettings(); /** * Save applications settings common to PCB draw frame objects. * * This overrides the base class WinEDA_BasePcbFrame::SaveSettings() to * save settings specific to the PCB layout application main window. It * calls down to the base class to save settings common to all PCB type * drawing frames. Please put your application settings for PCBNew here * to avoid having application settings saved all over the place. */ virtual void SaveSettings(); /** function SetLanguage * called on a language menu selection */ virtual void SetLanguage( wxCommandEvent& event ); void Process_Special_Functions( wxCommandEvent& event ); void RedrawActiveWindow( wxDC* DC, bool EraseBg ); void ReCreateHToolbar(); void ReCreateVToolbar(); void ReCreateOptToolbar(); void ReCreateMenuBar(); void OnLeftClick( wxDC* DC, const wxPoint& MousePos ); void OnLeftDClick( wxDC* DC, const wxPoint& MousePos ); bool OnRightClick( const wxPoint& MousePos, wxMenu* PopMenu ); int BestZoom(); void OnSelectOptionToolbar( wxCommandEvent& event ); void OnHotKey( wxDC* DC, int hotkey, EDA_BaseStruct* DrawStruct ); BOARD_ITEM* GerberGeneralLocateAndDisplay(); BOARD_ITEM* Locate( int typeloc ); void SetToolbars(); void Process_Settings( wxCommandEvent& event ); void Process_Config( wxCommandEvent& event ); void InstallConfigFrame( const wxPoint& pos ); void InstallGerberGeneralOptionsFrame( wxCommandEvent& event ); void InstallGerberDisplayOptionsDialog( wxCommandEvent& event ); void InstallPcbGlobalDeleteFrame( const wxPoint& pos ); /* handlers for block commands */ int ReturnBlockCommand( int key ); virtual void HandleBlockPlace( wxDC* DC ); virtual int HandleBlockEnd( wxDC* DC ); /* Block operations: */ /** * Function Block_Delete * deletes all tracks and segments within the selected block. * Defined separately in pcbnew and gerbview * * @param DC A device context to draw on. */ void Block_Delete( wxDC* DC ); void Block_Rotate( wxDC* DC ); void Block_Invert( wxDC* DC ); /** * Function Block_Move * moves all tracks and segments within the selected block. * New location is determined by the current offset from the selected * block's original location. * Defined separately in pcbnew and gerbview * * @param DC A device context to draw on. */ void Block_Move( wxDC* DC ); /** * Function Block_Mirror_X * mirrors all tracks and segments within the currently selected block * in the X axis. * * @param DC A device context to draw on. */ void Block_Mirror_X( wxDC* DC ); /** * Function Block_Duplicate * copies-and-moves all tracks and segments within the selected block. * New location is determined by the current offset from the selected * block's original location. * Defined separately in pcbnew and gerbview * * @param DC A device context to draw on. */ void Block_Duplicate( wxDC* DC ); void InstallDrillFrame( wxCommandEvent& event ); void ToPostProcess( wxCommandEvent& event ); /** Function ToPlotter * Open a dialog frame to create plot and drill files * relative to the current board */ void ToPlotter( wxCommandEvent& event ); /** Function ToPrinter * Open a dialog frame to print layers */ void ToPrinter( wxCommandEvent& event ); void Genere_HPGL( const wxString& FullFileName, int Layers ); void Genere_GERBER( const wxString& FullFileName, int Layers ); void Genere_PS( const wxString& FullFileName, int Layers ); void Plot_Layer_HPGL( FILE* File, int masque_layer, int garde, bool trace_via, GRTraceMode trace_mode ); void Plot_Layer_GERBER( FILE* File, int masque_layer, int garde, bool trace_via, GRTraceMode trace_mode ); int Gen_D_CODE_File( const wxString& Name_File ); void Plot_Layer_PS( FILE* File, int masque_layer, int garde, bool trace_via, GRTraceMode trace_mode ); void Files_io( wxCommandEvent& event ); void OnFileHistory( wxCommandEvent& event ); /** * Load a photoplot (Gerber) file. * * @param aFileName - File name with full path to open or empty string to open a new * file. * @param aOpenFileDialog - Set to true to display the open file dialog even if * aFileName is valid. * * @return - True if file was opened successfully. */ bool LoadOneGerberFile( const wxString& aFileName, bool aOpenFileDialog = false ); int ReadGerberFile( FILE* File, bool Append ); bool Read_GERBER_File( const wxString& GERBER_FullFileName, const wxString& D_Code_FullFileName ); bool SaveGerberFile( const wxString& FileName ); void GeneralControle( wxDC* DC, wxPoint Mouse ); /** * Function Read_D_Code_File * reads in a dcode file assuming ALSPCB file format with ';' indicating * comments. *

* Format is like CSV but with optional ';' delineated comments:
* tool, Horiz, Vert, drill, vitesse, acc. ,Type ; [DCODE (commentaire)]
* ex: 1, 12, 12, 0, 0, 0, 3 ; D10 *

* Format:
* Ver, Hor, Type, Tool [,Drill]
* example: 0.012, 0.012, L , D10
* * Categorize all found dcodes into a table of D_CODE instantiations. * @param D_CodeFullFileName The name of the file to read from. * @return int -
* -1 = file not found
* -2 = parsing problem
* 0 = the \a D_Code_FullFileName is empty, no reading * is done but an empty GERBER is put into * g_GERBER_List[]
* 1 = read OK
*/ int Read_D_Code_File( const wxString& D_Code_FullFileName ); void CopyDCodesSizeToItems(); void Liste_D_Codes( ); void Trace_Gerber( wxDC* DC, int draw_mode, int printmasklayer ); // PCB handling bool Clear_Pcb( bool query ); void Erase_Current_Layer( bool query ); void Delete_DCode_Items( wxDC* DC, int dcode_value, int layer_number ); TRACK* Delete_Segment( wxDC* DC, TRACK* Track ); // Conversion function void ExportDataInPcbnewFormat( wxCommandEvent& event ); /* SaveCopyInUndoList() virtual * currently: do nothing in gerbview. * but but be defined because it is a pure virtual in WinEDA_BasePcbFrame */ virtual void SaveCopyInUndoList( BOARD_ITEM* aItemToCopy, UndoRedoOpType aTypeCommand = UR_UNSPECIFIED, const wxPoint& aTransformPoint = wxPoint(0,0) ) { } /** Function SaveCopyInUndoList (overloaded). * Creates a new entry in undo list of commands. * add a list of pickers to handle a list of items * @param aItemsList = the list of items modified by the command to undo * @param aTypeCommand = command type (see enum UndoRedoOpType) * @param aTransformPoint = the reference point of the transformation, * for commands like move */ virtual void SaveCopyInUndoList( PICKED_ITEMS_LIST& aItemsList, UndoRedoOpType aTypeCommand, const wxPoint& aTransformPoint = wxPoint(0,0) ) { // currently: do nothing in gerbview. } /** Virtual function PrintPage * used to print a page * @param aDC = wxDC given by the calling print function * @param aPrint_Sheet_Ref = true to print page references * @param aPrintMask = not used here * @param aPrintMirrorMode = not used here (Set when printing in mirror mode) * @param aData = a pointer on an auxiliary data (not always used, NULL if not used) */ virtual void PrintPage( wxDC* aDC, bool aPrint_Sheet_Ref, int aPrintMask, bool aPrintMirrorMode, void * aData = NULL); DECLARE_EVENT_TABLE() }; #endif /* WX_GERBER_STRUCT_H */