/********************/ /* basepcbframe.cpp */ /********************/ #ifdef __GNUG__ #pragma implementation #endif #include "fctsys.h" #include "wxstruct.h" #include "confirm.h" #include "appl_wxstruct.h" #include "dialog_helpers.h" #include "kicad_device_context.h" #include "pcbnew.h" #include "pcbnew_id.h" #include "class_board_design_settings.h" #include "collectors.h" #include "class_drawpanel.h" /* Configuration entry names. */ static const wxString UserGridSizeXEntry( wxT( "PcbUserGrid_X" ) ); static const wxString UserGridSizeYEntry( wxT( "PcbUserGrid_Y" ) ); static const wxString UserGridUnitsEntry( wxT( "PcbUserGrid_Unit" ) ); static const wxString DisplayPadFillEntry( wxT( "DiPadFi" ) ); static const wxString DisplayViaFillEntry( wxT( "DiViaFi" ) ); static const wxString DisplayPadNumberEntry( wxT( "DiPadNu" ) ); static const wxString DisplayModuleEdgeEntry( wxT( "DiModEd" ) ); static const wxString DisplayModuleTextEntry( wxT( "DiModTx" ) ); /****************************/ /* class PCB_BASE_FRAME */ /****************************/ BEGIN_EVENT_TABLE( PCB_BASE_FRAME, EDA_DRAW_FRAME ) EVT_MENU_RANGE( ID_POPUP_PCB_ITEM_SELECTION_START, ID_POPUP_PCB_ITEM_SELECTION_END, PCB_BASE_FRAME::ProcessItemSelection ) EVT_TOOL( ID_TB_OPTIONS_SHOW_POLAR_COORD, PCB_BASE_FRAME::OnTogglePolarCoords ) EVT_TOOL( ID_TB_OPTIONS_SHOW_PADS_SKETCH, PCB_BASE_FRAME::OnTogglePadDrawMode ) EVT_UPDATE_UI( ID_TB_OPTIONS_SHOW_POLAR_COORD, PCB_BASE_FRAME::OnUpdateCoordType ) EVT_UPDATE_UI( ID_TB_OPTIONS_SHOW_PADS_SKETCH, PCB_BASE_FRAME::OnUpdatePadDrawMode ) EVT_UPDATE_UI( ID_ON_GRID_SELECT, PCB_BASE_FRAME::OnUpdateSelectGrid ) EVT_UPDATE_UI( ID_ON_ZOOM_SELECT, PCB_BASE_FRAME::OnUpdateSelectZoom ) EVT_UPDATE_UI_RANGE( ID_ZOOM_IN, ID_ZOOM_PAGE, PCB_BASE_FRAME::OnUpdateSelectZoom ) END_EVENT_TABLE() PCB_BASE_FRAME::PCB_BASE_FRAME( wxWindow* father, int idtype, const wxString& title, const wxPoint& pos, const wxSize& size, long style) : EDA_DRAW_FRAME( father, idtype, title, pos, size, style ) { m_InternalUnits = PCB_INTERNAL_UNIT; // Internal unit = 1/10000 inch m_Pcb = NULL; m_DisplayPadFill = true; // How to draw pads m_DisplayViaFill = true; // How to draw vias m_DisplayPadNum = true; // show pads number m_DisplayModEdge = FILLED; // How to display module drawings (line/ filled / sketch) m_DisplayModText = FILLED; // How to display module texts (line/ filled / sketch) m_DisplayPcbTrackFill = true; /* false = sketch , true = filled */ m_Draw3DFrame = NULL; // Display Window in 3D mode (OpenGL) m_ModuleEditFrame = NULL; // Frame for footprint edition m_UserGridSize = wxRealPoint( 100.0, 100.0 ); m_UserGridUnit = INCHES; m_Collector = new GENERAL_COLLECTOR(); } PCB_BASE_FRAME::~PCB_BASE_FRAME() { delete m_Collector; } void PCB_BASE_FRAME::SetBoard( BOARD* aBoard ) { if( m_Pcb != g_ModuleEditor_Pcb ) delete m_Pcb; m_Pcb = aBoard; } /** * Return the "best" zoom, i.e. the zoom which shows the entire board on screen */ double PCB_BASE_FRAME::BestZoom( void ) { int dx, dy; double ii, jj; wxSize size; if( m_Pcb == NULL ) return 32.0; m_Pcb->ComputeBoundingBox(); dx = m_Pcb->m_BoundaryBox.GetWidth(); dy = m_Pcb->m_BoundaryBox.GetHeight(); size = DrawPanel->GetClientSize(); if( size.x ) ii = (double)(dx + ( size.x / 2) ) / (double) size.x; else ii = 32.0; if ( size.y ) jj = (double)( dy + (size.y / 2) ) / (double) size.y; else jj = 32.0; double bestzoom = MAX( ii, jj ); GetScreen()->SetScrollCenterPosition( m_Pcb->m_BoundaryBox.Centre() ); return bestzoom ; } void PCB_BASE_FRAME::CursorGoto( const wxPoint& aPos ) { // factored out of pcbnew/find.cpp PCB_SCREEN* screen = (PCB_SCREEN*)GetScreen(); wxClientDC dc( DrawPanel ); /* There may be need to reframe the drawing. */ if( !DrawPanel->IsPointOnDisplay( aPos ) ) { screen->SetCrossHairPosition( aPos ); RedrawScreen( aPos, true ); } else { // Put cursor on item position DrawPanel->CrossHairOff( &dc ); screen->SetCrossHairPosition( aPos ); DrawPanel->MoveCursorToCrossHair(); DrawPanel->CrossHairOn( &dc ); } } // Virtual function void PCB_BASE_FRAME::ReCreateMenuBar( void ) { } /* Virtual functions: Do nothing for PCB_BASE_FRAME window */ void PCB_BASE_FRAME::Show3D_Frame( wxCommandEvent& event ) { } // Note: virtual, overridden in PCB_EDIT_FRAME; void PCB_BASE_FRAME::SwitchLayer( wxDC* DC, int layer ) { int preslayer = ((PCB_SCREEN*)GetScreen())->m_Active_Layer; // Check if the specified layer matches the present layer if( layer == preslayer ) return; // Copper layers cannot be selected unconditionally; how many // of those layers are currently enabled needs to be checked. if( IsValidCopperLayerIndex( layer ) ) { // If only one copper layer is enabled, the only such layer // that can be selected to is the "Copper" layer (so the // selection of any other copper layer is disregarded). if( m_Pcb->GetCopperLayerCount() < 2 ) { if( layer != LAYER_N_BACK ) { return; } } // If more than one copper layer is enabled, the "Copper" // and "Component" layers can be selected, but the total // number of copper layers determines which internal // layers are also capable of being selected. else { if( ( layer != LAYER_N_BACK ) && ( layer != LAYER_N_FRONT ) && ( layer >= m_Pcb->GetCopperLayerCount() - 1 ) ) { return; } } } // Is yet more checking required? E.g. when the layer to be selected // is a non-copper layer, or when switching between a copper layer // and a non-copper layer, or vice-versa? // ... GetScreen()->m_Active_Layer = layer; if( DisplayOpt.ContrastModeDisplay ) DrawPanel->Refresh(); } void PCB_BASE_FRAME::OnTogglePolarCoords( wxCommandEvent& aEvent ) { SetStatusText( wxEmptyString ); DisplayOpt.DisplayPolarCood = !DisplayOpt.DisplayPolarCood; UpdateStatusBar(); } void PCB_BASE_FRAME::OnTogglePadDrawMode( wxCommandEvent& aEvent ) { m_DisplayPadFill = DisplayOpt.DisplayPadFill = !m_DisplayPadFill; DrawPanel->Refresh(); } void PCB_BASE_FRAME::OnUpdateCoordType( wxUpdateUIEvent& aEvent ) { aEvent.Check( DisplayOpt.DisplayPolarCood ); m_OptionsToolBar->SetToolShortHelp( ID_TB_OPTIONS_SHOW_POLAR_COORD, DisplayOpt.DisplayPolarCood ? _( "Display rectangular coordinates" ) : _( "Display polar coordinates" ) ); } void PCB_BASE_FRAME::OnUpdatePadDrawMode( wxUpdateUIEvent& aEvent ) { aEvent.Check( !m_DisplayPadFill ); m_OptionsToolBar->SetToolShortHelp( ID_TB_OPTIONS_SHOW_PADS_SKETCH, m_DisplayPadFill ? _( "Show pads in outline mode" ) : _( "Show pads in fill mode" ) ); } void PCB_BASE_FRAME::OnUpdateSelectGrid( wxUpdateUIEvent& aEvent ) { // No need to update the grid select box if it doesn't exist or the grid setting change // was made using the select box. if( m_SelGridBox == NULL || m_AuxiliaryToolBar == NULL ) return; int select = wxNOT_FOUND; for( size_t i = 0; i < GetScreen()->GetGridCount(); i++ ) { if( GetScreen()->GetGridId() == GetScreen()->GetGrid( i ).m_Id ) { select = (int) i; break; } } if( select != m_SelGridBox->GetSelection() ) m_SelGridBox->SetSelection( select ); } void PCB_BASE_FRAME::OnUpdateSelectZoom( wxUpdateUIEvent& aEvent ) { if( m_SelZoomBox == NULL || m_AuxiliaryToolBar == NULL ) return; int current = 0; for( size_t i = 0; i < GetScreen()->m_ZoomList.GetCount(); i++ ) { if( GetScreen()->GetZoom() == GetScreen()->m_ZoomList[i] ) { current = i + 1; break; } } if( current != m_SelZoomBox->GetSelection() ) m_SelZoomBox->SetSelection( current ); } void PCB_BASE_FRAME::ProcessItemSelection( wxCommandEvent& aEvent ) { int id = aEvent.GetId(); // index into the collector list: int itemNdx = id - ID_POPUP_PCB_ITEM_SELECTION_START; if( id >= ID_POPUP_PCB_ITEM_SELECTION_START && id <= ID_POPUP_PCB_ITEM_SELECTION_END ) { BOARD_ITEM* item = (*m_Collector)[itemNdx]; DrawPanel->m_AbortRequest = false; #if 0 && defined (DEBUG) item->Show( 0, std::cout ); #endif SetCurItem( item ); } } void PCB_BASE_FRAME::SetCurItem( BOARD_ITEM* aItem, bool aDisplayInfo ) { GetScreen()->SetCurItem( aItem ); if( aItem ) { if( aDisplayInfo ) aItem->DisplayInfo( this ); #if 0 && defined(DEBUG) aItem->Show( 0, std::cout ); #endif } else { // we can use either of these two: //MsgPanel->EraseMsgBox(); m_Pcb->DisplayInfo( this ); // show the BOARD stuff #if 0 && defined(DEBUG) std::cout << "SetCurItem(NULL)\n"; #endif } } BOARD_ITEM* PCB_BASE_FRAME::GetCurItem() { return GetScreen()->GetCurItem(); } GENERAL_COLLECTORS_GUIDE PCB_BASE_FRAME::GetCollectorsGuide() { GENERAL_COLLECTORS_GUIDE guide( m_Pcb->GetVisibleLayers(), ( (PCB_SCREEN*)GetScreen())->m_Active_Layer ); // account for the globals guide.SetIgnoreMTextsMarkedNoShow( ! m_Pcb->IsElementVisible( MOD_TEXT_INVISIBLE )); guide.SetIgnoreMTextsOnCopper( ! m_Pcb->IsElementVisible( MOD_TEXT_BK_VISIBLE )); guide.SetIgnoreMTextsOnCmp( ! m_Pcb->IsElementVisible( MOD_TEXT_FR_VISIBLE )); guide.SetIgnoreModulesOnCu( ! m_Pcb->IsElementVisible( MOD_BK_VISIBLE ) ); guide.SetIgnoreModulesOnCmp( ! m_Pcb->IsElementVisible( MOD_FR_VISIBLE ) ); guide.SetIgnorePadsOnBack( ! m_Pcb->IsElementVisible( PAD_BK_VISIBLE ) ); guide.SetIgnorePadsOnFront( ! m_Pcb->IsElementVisible( PAD_FR_VISIBLE ) ); return guide; } void PCB_BASE_FRAME::SetToolID( int aId, int aCursor, const wxString& aToolMsg ) { bool redraw = false; EDA_DRAW_FRAME::SetToolID( aId, aCursor, aToolMsg ); if( aId < 0 ) return; // handle color changes for transitions in and out of ID_TRACK_BUTT if( ( GetToolId() == ID_TRACK_BUTT && aId != ID_TRACK_BUTT ) || ( GetToolId() != ID_TRACK_BUTT && aId== ID_TRACK_BUTT ) ) { if( DisplayOpt.ContrastModeDisplay ) redraw = true; } // must do this after the tool has been set, otherwise pad::Draw() does // not show proper color when DisplayOpt.ContrastModeDisplay is true. if( redraw && DrawPanel) DrawPanel->Refresh(); } /* * Update the status bar information. */ void PCB_BASE_FRAME::UpdateStatusBar() { EDA_DRAW_FRAME::UpdateStatusBar(); if( DisplayOpt.DisplayPolarCood ) // display polar coordinates { PCB_SCREEN* screen = GetScreen(); if( !screen ) return; wxString Line; double theta, ro; int dx = screen->GetCrossHairPosition().x - screen->m_O_Curseur.x; int dy = screen->GetCrossHairPosition().y - screen->m_O_Curseur.y; if( dx==0 && dy==0 ) theta = 0.0; else theta = atan2( (double) -dy, (double) dx ); theta = theta * 180.0 / M_PI; ro = sqrt( ( (double) dx * dx ) + ( (double) dy * dy ) ); wxString formatter; switch( g_UserUnit ) { case INCHES: formatter = wxT( "Ro %.4f Th %.1f" ); break; case MILLIMETRES: formatter = wxT( "Ro %.3f Th %.1f" ); break; case UNSCALED_UNITS: formatter = wxT( "Ro %f Th %f" ); break; } Line.Printf( formatter, To_User_Unit( g_UserUnit, ro, m_InternalUnits ), theta ); // overwrite the absolute cartesian coordinates SetStatusText( Line, 2 ); } } void PCB_BASE_FRAME::unitsChangeRefresh() { EDA_DRAW_FRAME::unitsChangeRefresh(); // Update the status bar. updateGridSelectBox(); } /** * Load PCB base frame specific configuration settings. * * Don't forget to call this base method from any derived classes or the * settings will not get loaded. */ void PCB_BASE_FRAME::LoadSettings() { wxASSERT( wxGetApp().m_EDA_Config != NULL ); wxConfig* cfg = wxGetApp().m_EDA_Config; EDA_DRAW_FRAME::LoadSettings(); // Ensure grid id is an existent grid id: if( (m_LastGridSizeId <= 0) || (m_LastGridSizeId > (ID_POPUP_GRID_USER - ID_POPUP_GRID_LEVEL_1000)) ) m_LastGridSizeId = ID_POPUP_GRID_LEVEL_500 - ID_POPUP_GRID_LEVEL_1000; cfg->Read( m_FrameName + UserGridSizeXEntry, &m_UserGridSize.x, 0.01 ); cfg->Read( m_FrameName + UserGridSizeYEntry, &m_UserGridSize.y, 0.01 ); long itmp; cfg->Read( m_FrameName + UserGridUnitsEntry, &itmp, ( long )INCHES ); m_UserGridUnit = (EDA_UNITS_T) itmp; cfg->Read( m_FrameName + DisplayPadFillEntry, &m_DisplayPadFill, true ); cfg->Read( m_FrameName + DisplayViaFillEntry, &m_DisplayViaFill, true ); cfg->Read( m_FrameName + DisplayPadNumberEntry, &m_DisplayPadNum, true ); cfg->Read( m_FrameName + DisplayModuleEdgeEntry, &m_DisplayModEdge, ( long )FILLED ); if( m_DisplayModEdge < FILAIRE || m_DisplayModEdge > SKETCH ) m_DisplayModEdge = FILLED; cfg->Read( m_FrameName + DisplayModuleTextEntry, &m_DisplayModText, ( long )FILLED ); if( m_DisplayModText < FILAIRE || m_DisplayModText > SKETCH ) m_DisplayModText = FILLED; // WxWidgets 2.9.1 seems call setlocale( LC_NUMERIC, "" ) // when reading doubles in config, // but forget to back to current locale. So we call SetLocaleTo_Default SetLocaleTo_Default( ); } /** * Save PCB base frame specific configuration settings. * * Don't forget to call this base method from any derived classes or the * settings will not get saved. */ void PCB_BASE_FRAME::SaveSettings() { wxASSERT( wxGetApp().m_EDA_Config != NULL ); wxConfig* cfg = wxGetApp().m_EDA_Config; EDA_DRAW_FRAME::SaveSettings(); cfg->Write( m_FrameName + UserGridSizeXEntry, m_UserGridSize.x ); cfg->Write( m_FrameName + UserGridSizeYEntry, m_UserGridSize.y ); cfg->Write( m_FrameName + UserGridUnitsEntry, ( long )m_UserGridUnit ); cfg->Write( m_FrameName + DisplayPadFillEntry, m_DisplayPadFill ); cfg->Write( m_FrameName + DisplayViaFillEntry, m_DisplayViaFill ); cfg->Write( m_FrameName + DisplayPadNumberEntry, m_DisplayPadNum ); cfg->Write( m_FrameName + DisplayModuleEdgeEntry, ( long )m_DisplayModEdge ); cfg->Write( m_FrameName + DisplayModuleTextEntry, ( long )m_DisplayModText ); } /** * Function OnModify * Must be called after a schematic change * in order to set the "modify" flag of the current screen * and update the date in frame reference * do not forget to call this basic OnModify function to update info * in derived OnModify functions */ void PCB_BASE_FRAME::OnModify( ) { GetScreen()->SetModify( ); wxString date = GenDate(); GetScreen()->m_Date = date; } void PCB_BASE_FRAME::updateGridSelectBox() { UpdateStatusBar(); DisplayUnitsMsg(); if( m_SelGridBox == NULL ) return; // Update grid values with the current units setting. m_SelGridBox->Clear(); wxString msg; wxString format = _( "Grid"); switch( g_UserUnit ) { case INCHES: format += wxT( " %.1f" ); break; case MILLIMETRES: format += wxT( " %.3f" ); break; case UNSCALED_UNITS: format += wxT( " %f" ); break; } for( size_t i = 0; i < GetScreen()->GetGridCount(); i++ ) { GRID_TYPE& grid = GetScreen()->GetGrid( i ); double value = To_User_Unit( g_UserUnit, grid.m_Size.x, m_InternalUnits ); if( grid.m_Id != ID_POPUP_GRID_USER ) { switch( g_UserUnit ) { case INCHES: msg.Printf( format.GetData(), value * 1000 ); break; case MILLIMETRES: case UNSCALED_UNITS: msg.Printf( format.GetData(), value ); break; } } else msg = _( "User Grid" ); m_SelGridBox->Append( msg, (void*) &grid.m_Id ); if( ( m_LastGridSizeId + ID_POPUP_GRID_LEVEL_1000 ) == GetScreen()->GetGrid( i ).m_Id ) m_SelGridBox->SetSelection( i ); } } void PCB_BASE_FRAME::updateZoomSelectBox() { if( m_SelZoomBox == NULL ) return; wxString msg; m_SelZoomBox->Clear(); m_SelZoomBox->Append( _( "Auto" ) ); m_SelZoomBox->SetSelection( 0 ); for( int i = 0; i < (int)GetScreen()->m_ZoomList.GetCount(); i++ ) { msg = _( "Zoom " ); wxString value; value.Printf( wxT( "%g" ), GetScreen()->m_ZoomList[i]); msg += value; m_SelZoomBox->Append( msg ); if( GetScreen()->GetZoom() == GetScreen()->m_ZoomList[i] ) m_SelZoomBox->SetSelection( i + 1 ); } }