/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2013 CERN * Copyright (C) 2017-2019 KiCad Developers, see AUTHORS.txt for contributors. * @author Jean-Pierre Charras, jp.charras at wanadoo.fr * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ /** * @file pl_editor_frame.cpp */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include PL_EDITOR_FRAME::PL_EDITOR_FRAME( KIWAY* aKiway, wxWindow* aParent ) : EDA_DRAW_FRAME( aKiway, aParent, FRAME_PL_EDITOR, wxT( "PlEditorFrame" ), wxDefaultPosition, wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, PL_EDITOR_FRAME_NAME ) { m_UserUnits = MILLIMETRES; m_zoomLevelCoeff = 290.0; // Adjusted to roughly displays zoom level = 1 // when the screen shows a 1:1 image // obviously depends on the monitor, // but this is an acceptable value m_showAxis = false; // true to show X and Y axis on screen m_showGridAxis = true; m_showBorderAndTitleBlock = true; // true for reference drawings. m_hotkeysDescrList = PlEditorHotkeysDescr; m_originSelectChoice = 0; SetDrawBgColor( WHITE ); // default value, user option (WHITE/BLACK) SetShowPageLimits( true ); m_AboutTitle = "PlEditor"; m_designTreeWidth = 150; m_propertiesFrameWidth = 200; if( m_canvas ) m_canvas->SetEnableBlockCommands( true ); // Give an icon wxIcon icon; icon.CopyFromBitmap( KiBitmap( icon_pagelayout_editor_xpm ) ); SetIcon( icon ); wxSize pageSizeIU = GetPageLayout().GetPageSettings().GetSizeIU(); SetScreen( new PL_EDITOR_SCREEN( pageSizeIU ) ); LoadSettings( config() ); SetSize( m_FramePos.x, m_FramePos.y, m_FrameSize.x, m_FrameSize.y ); if( ! GetScreen()->GridExists( m_LastGridSizeId + ID_POPUP_GRID_LEVEL_1000 ) ) m_LastGridSizeId = ID_POPUP_GRID_LEVEL_1MM - ID_POPUP_GRID_LEVEL_1000; GetScreen()->SetGrid( m_LastGridSizeId + ID_POPUP_GRID_LEVEL_1000 ); ReCreateMenuBar(); ReCreateHToolbar(); wxWindow* stsbar = GetStatusBar(); int dims[] = { // balance of status bar on far left is set to a default or whatever is left over. -1, // When using GetTextSize() remember the width of '1' is not the same // as the width of '0' unless the font is fixed width, and it usually won't be. // zoom: GetTextSize( wxT( "Z 762000" ), stsbar ).x + 10, // cursor coords GetTextSize( wxT( "X 0234.567 Y 0234.567" ), stsbar ).x + 10, // delta distances GetTextSize( wxT( "dx 0234.567 dx 0234.567" ), stsbar ).x + 10, // grid size GetTextSize( wxT( "grid 0234.567" ), stsbar ).x + 10, // Coord origin (use the bigger message) GetTextSize( _( "coord origin: Right Bottom page corner" ), stsbar ).x + 10, // units display, Inches is bigger than mm GetTextSize( _( "Inches" ), stsbar ).x + 20 }; SetStatusWidths( arrayDim( dims ), dims ); m_auimgr.SetManagedWindow( this ); m_auimgr.SetArtProvider( new EDA_DOCKART( this ) ); m_propertiesPagelayout = new PROPERTIES_FRAME( this ); m_treePagelayout = new DESIGN_TREE_FRAME( this ); m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) ); m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) ); m_auimgr.AddPane( m_treePagelayout, EDA_PANE().Palette().Name( "Design" ).Left().Layer(1) .Caption( _( "Design" ) ).MinSize( m_treePagelayout->GetMinSize() ) .BestSize( m_designTreeWidth, -1 ) ); m_auimgr.AddPane( m_propertiesPagelayout, EDA_PANE().Palette().Name( "Props" ).Right().Layer(1) .Caption( _( "Properties" ) ).MinSize( m_propertiesPagelayout->GetMinSize() ) .BestSize( m_propertiesFrameWidth, -1 ) ); m_auimgr.AddPane( m_canvas, EDA_PANE().Canvas().Name( "DrawFrame" ).Center() ); m_auimgr.Update(); // Initialize the current page layout WORKSHEET_LAYOUT& pglayout = WORKSHEET_LAYOUT::GetTheInstance(); #if 0 //start with empty layout pglayout.AllowVoidList( true ); pglayout.ClearList(); #else // start with the default Kicad layout pglayout.SetPageLayout(); #endif OnNewPageLayout(); } PL_EDITOR_FRAME::~PL_EDITOR_FRAME() { } bool PL_EDITOR_FRAME::OpenProjectFiles( const std::vector& aFileSet, int aCtl ) { wxString fn = aFileSet[0]; if( !LoadPageLayoutDescrFile( fn ) ) { wxString msg = wxString::Format( _( "Error when loading file \"%s\"" ), GetChars( fn ) ); wxMessageBox( msg ); return false; } else { OnNewPageLayout(); return true; } } void PL_EDITOR_FRAME::OnCloseWindow( wxCloseEvent& Event ) { if( GetScreen()->IsModify() ) { if( !HandleUnsavedChanges( this, _( "The current page layout has been modified. Save changes?" ), [&]()->bool { return saveCurrentPageLayout(); } ) ) { Event.Veto(); return; } } // do not show the window because we do not want any paint event Show( false ); // was: Pgm().SaveCurrentSetupValues( m_configSettings ); wxConfigSaveSetups( Kiface().KifaceSettings(), m_configSettings ); // On Linux, m_propertiesPagelayout must be destroyed // before deleting the main frame to avoid a crash when closing m_propertiesPagelayout->Destroy(); Destroy(); } double PL_EDITOR_FRAME::BestZoom() { double sizeX = (double) GetPageLayout().GetPageSettings().GetWidthIU(); double sizeY = (double) GetPageLayout().GetPageSettings().GetHeightIU(); wxPoint centre( sizeX / 2, sizeY / 2 ); // The sheet boundary already affords us some margin, so add only an // additional 5%. double margin_scale_factor = 1.05; return bestZoom( sizeX, sizeY, margin_scale_factor, centre ); } static const wxChar designTreeWidthKey[] = wxT( "DesignTreeWidth" ); static const wxChar propertiesFrameWidthKey[] = wxT( "PropertiesFrameWidth" ); static const wxChar cornerOriginChoiceKey[] = wxT( "CornerOriginChoice" ); static const wxChar blackBgColorKey[] = wxT( "BlackBgColor" ); void PL_EDITOR_FRAME::LoadSettings( wxConfigBase* aCfg ) { EDA_DRAW_FRAME::LoadSettings( aCfg ); aCfg->Read( designTreeWidthKey, &m_designTreeWidth, 100); aCfg->Read( propertiesFrameWidthKey, &m_propertiesFrameWidth, 150); aCfg->Read( cornerOriginChoiceKey, &m_originSelectChoice ); bool tmp; aCfg->Read( blackBgColorKey, &tmp, false ); SetDrawBgColor( tmp ? BLACK : WHITE ); } void PL_EDITOR_FRAME::SaveSettings( wxConfigBase* aCfg ) { EDA_DRAW_FRAME::SaveSettings( aCfg ); m_designTreeWidth = m_treePagelayout->GetSize().x; m_propertiesFrameWidth = m_propertiesPagelayout->GetSize().x; aCfg->Write( designTreeWidthKey, m_designTreeWidth); aCfg->Write( propertiesFrameWidthKey, m_propertiesFrameWidth); aCfg->Write( cornerOriginChoiceKey, m_originSelectChoice ); aCfg->Write( blackBgColorKey, GetDrawBgColor() == BLACK ); // was: wxGetApp().SaveCurrentSetupValues( GetConfigurationSettings() ); wxConfigSaveSetups( aCfg, GetConfigurationSettings() ); } void PL_EDITOR_FRAME::UpdateTitleAndInfo() { wxString title; wxString file = GetCurrFileName(); title.Printf( _( "Page Layout Editor" ) + wxT( " \u2014 %s" ), file.Length() ? file : _( "no file selected" ) ); SetTitle( title ); } const wxString& PL_EDITOR_FRAME::GetCurrFileName() const { return BASE_SCREEN::m_PageLayoutDescrFileName; } void PL_EDITOR_FRAME::SetCurrFileName( const wxString& aName ) { BASE_SCREEN::m_PageLayoutDescrFileName = aName; } void PL_EDITOR_FRAME::SetPageSettings( const PAGE_INFO& aPageSettings ) { m_pageLayout.SetPageSettings( aPageSettings ); if( GetScreen() ) GetScreen()->InitDataPoints( aPageSettings.GetSizeIU() ); } const PAGE_INFO& PL_EDITOR_FRAME::GetPageSettings() const { return m_pageLayout.GetPageSettings(); } const wxSize PL_EDITOR_FRAME::GetPageSizeIU() const { // this function is only needed because EDA_DRAW_FRAME is not compiled // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route // into an application specific source file. return m_pageLayout.GetPageSettings().GetSizeIU(); } const TITLE_BLOCK& PL_EDITOR_FRAME::GetTitleBlock() const { return GetPageLayout().GetTitleBlock(); } void PL_EDITOR_FRAME::SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_pageLayout.SetTitleBlock( aTitleBlock ); } /* * Display the grid status. */ void PL_EDITOR_FRAME::DisplayGridMsg() { wxString line; wxString gridformatter; switch( m_UserUnits ) { case INCHES: gridformatter = "grid %.3f"; break; case MILLIMETRES: gridformatter = "grid %.4f"; break; default: gridformatter = "grid %f"; break; } wxRealPoint curr_grid_size = GetScreen()->GetGridSize(); double grid = To_User_Unit( m_UserUnits, curr_grid_size.x ); line.Printf( gridformatter, grid ); SetStatusText( line, 4 ); } void PL_EDITOR_FRAME::UpdateStatusBar() { PL_EDITOR_SCREEN* screen = (PL_EDITOR_SCREEN*) GetScreen(); if( !screen ) return; // Display Zoom level: EDA_DRAW_FRAME::UpdateStatusBar(); // coordinate origin can be the paper Top Left corner, // or each of 4 page corners // We know the origin, and the orientation of axis wxPoint originCoord; int Xsign = 1; int Ysign = 1; WORKSHEET_DATAITEM dummy( WORKSHEET_DATAITEM::WS_SEGMENT ); switch( m_originSelectChoice ) { default: case 0: // Origin = paper Left Top corner break; case 1: // Origin = page Right Bottom corner Xsign = -1; Ysign = -1; dummy.SetStart( 0, 0, RB_CORNER ); originCoord = dummy.GetStartPosUi(); break; case 2: // Origin = page Left Bottom corner Ysign = -1; dummy.SetStart( 0, 0, LB_CORNER ); originCoord = dummy.GetStartPosUi(); break; case 3: // Origin = page Right Top corner Xsign = -1; dummy.SetStart( 0, 0, RT_CORNER ); originCoord = dummy.GetStartPosUi(); break; case 4: // Origin = page Left Top corner dummy.SetStart( 0, 0, LT_CORNER ); originCoord = dummy.GetStartPosUi(); break; } SetGridOrigin( originCoord ); // Display absolute coordinates: wxPoint coord = GetCrossHairPosition() - originCoord; double dXpos = To_User_Unit( GetUserUnits(), coord.x*Xsign ); double dYpos = To_User_Unit( GetUserUnits(), coord.y*Ysign ); wxString pagesizeformatter = _( "Page size: width %.4g height %.4g" ); wxString absformatter = wxT( "X %.4g Y %.4g" ); wxString locformatter = wxT( "dx %.4g dy %.4g" ); switch( GetUserUnits() ) { case INCHES: // Should not be used in page layout editor SetStatusText( _("inches"), 6 ); break; case MILLIMETRES: SetStatusText( _("mm"), 6 ); break; case UNSCALED_UNITS: SetStatusText( wxEmptyString, 6 ); break; case DEGREES: wxASSERT( false ); break; } wxString line; // Display page size #define milsTomm (25.4/1000) DSIZE size = GetPageSettings().GetSizeMils(); size = size * milsTomm; line.Printf( pagesizeformatter, size.x, size.y ); SetStatusText( line, 0 ); // Display abs coordinates line.Printf( absformatter, dXpos, dYpos ); SetStatusText( line, 2 ); // Display relative coordinates: int dx = GetCrossHairPosition().x - screen->m_O_Curseur.x; int dy = GetCrossHairPosition().y - screen->m_O_Curseur.y; dXpos = To_User_Unit( GetUserUnits(), dx * Xsign ); dYpos = To_User_Unit( GetUserUnits(), dy * Ysign ); line.Printf( locformatter, dXpos, dYpos ); SetStatusText( line, 3 ); DisplayGridMsg(); // Display corner reference for coord origin line.Printf( _("coord origin: %s"), m_originSelectBox->GetString( m_originSelectChoice ). GetData() ); SetStatusText( line, 5 ); // Display units } void PL_EDITOR_FRAME::PrintPage( wxDC* aDC, LSET aPrintMasklayer, bool aPrintMirrorMode, void * aData ) { GetScreen()-> m_ScreenNumber = GetPageNumberOption() ? 1 : 2; DrawWorkSheet( aDC, GetScreen(), 0, IU_PER_MILS, wxEmptyString ); } void PL_EDITOR_FRAME::RedrawActiveWindow( wxDC* aDC, bool aEraseBg ) { GetScreen()-> m_ScreenNumber = GetPageNumberOption() ? 1 : 2; if( aEraseBg ) m_canvas->EraseScreen( aDC ); m_canvas->DrawBackGround( aDC ); const WORKSHEET_LAYOUT& pglayout = WORKSHEET_LAYOUT::GetTheInstance(); WORKSHEET_DATAITEM* selecteditem = GetSelectedItem(); // the color to draw selected items if( GetDrawBgColor() == WHITE ) WORKSHEET_DATAITEM::m_SelectedColor = DARKCYAN; else WORKSHEET_DATAITEM::m_SelectedColor = YELLOW; for( unsigned ii = 0; ; ii++ ) { WORKSHEET_DATAITEM* item = pglayout.GetItem( ii ); if( item == NULL ) break; item->SetSelected( item == selecteditem ); } DrawWorkSheet( aDC, GetScreen(), 0, IU_PER_MILS, GetCurrFileName() ); #ifdef USE_WX_OVERLAY if( IsShown() ) { m_overlay.Reset(); wxDCOverlay overlaydc( m_overlay, (wxWindowDC*)aDC ); overlaydc.Clear(); } #endif if( m_canvas->IsMouseCaptured() ) m_canvas->CallMouseCapture( aDC, wxDefaultPosition, false ); m_canvas->DrawCrossHair( aDC ); // Display the filename UpdateTitleAndInfo(); } void PL_EDITOR_FRAME::RebuildDesignTree() { const WORKSHEET_LAYOUT& pglayout = WORKSHEET_LAYOUT::GetTheInstance(); int rectId = 0; int lineId = 0; int textId = 0; int polyId = 0; int bitmapId = 0; for( unsigned ii = 0; ii < pglayout.GetCount(); ii++ ) { WORKSHEET_DATAITEM* item = pglayout.GetItem( ii ); switch( item->GetType() ) { case WORKSHEET_DATAITEM::WS_TEXT: item->m_Name = wxString::Format( wxT( "text%d:%s" ), ++textId, GetChars(item->GetClassName()) ); break; case WORKSHEET_DATAITEM:: WS_SEGMENT: item->m_Name = wxString::Format( wxT( "segm%d:%s" ), ++lineId, GetChars(item->GetClassName()) ); break; case WORKSHEET_DATAITEM::WS_RECT: item->m_Name = wxString::Format( wxT( "rect%d:%s" ), ++rectId, GetChars(item->GetClassName()) ); break; case WORKSHEET_DATAITEM::WS_POLYPOLYGON: item->m_Name = wxString::Format( wxT( "poly%d:%s" ), ++polyId, GetChars(item->GetClassName()) ); break; case WORKSHEET_DATAITEM::WS_BITMAP: item->m_Name = wxString::Format( wxT( "bm%d:%s" ), ++bitmapId, GetChars(item->GetClassName()) ); break; } } m_treePagelayout->ReCreateDesignTree(); } WORKSHEET_DATAITEM * PL_EDITOR_FRAME::AddPageLayoutItem( int aType, int aIdx ) { WORKSHEET_DATAITEM * item = NULL; switch( aType ) { case WORKSHEET_DATAITEM::WS_TEXT: item = new WORKSHEET_DATAITEM_TEXT( wxT( "Text") ); break; case WORKSHEET_DATAITEM::WS_SEGMENT: item = new WORKSHEET_DATAITEM( WORKSHEET_DATAITEM::WS_SEGMENT ); break; case WORKSHEET_DATAITEM::WS_RECT: item = new WORKSHEET_DATAITEM( WORKSHEET_DATAITEM::WS_RECT ); break; case WORKSHEET_DATAITEM::WS_POLYPOLYGON: item = new WORKSHEET_DATAITEM_POLYPOLYGON(); break; case WORKSHEET_DATAITEM::WS_BITMAP: { wxFileDialog fileDlg( this, _( "Choose Image" ), wxEmptyString, wxEmptyString, _( "Image Files " ) + wxImage::GetImageExtWildcard(), wxFD_OPEN ); if( fileDlg.ShowModal() != wxID_OK ) return NULL; wxString fullFilename = fileDlg.GetPath(); if( !wxFileExists( fullFilename ) ) { wxMessageBox( _( "Couldn't load image from \"%s\"" ), GetChars( fullFilename ) ); break; } BITMAP_BASE* image = new BITMAP_BASE(); if( !image->ReadImageFile( fullFilename ) ) { wxMessageBox( _( "Couldn't load image from \"%s\"" ), GetChars( fullFilename ) ); delete image; break; } item = new WORKSHEET_DATAITEM_BITMAP( image ); } break; } if( item == NULL ) return NULL; WORKSHEET_LAYOUT& pglayout = WORKSHEET_LAYOUT::GetTheInstance(); pglayout.Insert( item, aIdx ); RebuildDesignTree(); return item; } WORKSHEET_DATAITEM * PL_EDITOR_FRAME::GetSelectedItem() { WORKSHEET_DATAITEM* item = m_treePagelayout->GetPageLayoutSelectedItem(); return item; } WORKSHEET_DATAITEM* PL_EDITOR_FRAME::Locate( wxDC* aDC, const wxPoint& aPosition ) { const PAGE_INFO& pageInfo = GetPageSettings(); TITLE_BLOCK t_block = GetTitleBlock(); COLOR4D color = COLOR4D( RED ); // Needed, not used PL_EDITOR_SCREEN* screen = (PL_EDITOR_SCREEN*) GetScreen(); screen-> m_ScreenNumber = GetPageNumberOption() ? 1 : 2; WS_DRAW_ITEM_LIST drawList; drawList.SetPenSize( 0 ); drawList.SetMilsToIUfactor( IU_PER_MILS ); drawList.SetSheetNumber( screen->m_ScreenNumber ); drawList.SetSheetCount( screen->m_NumberOfScreens ); drawList.SetFileName( GetCurrFileName() ); // GetScreenDesc() returns a temporary string. Store it to avoid issues. wxString descr = GetScreenDesc(); drawList.SetSheetName( descr ); drawList.BuildWorkSheetGraphicList( pageInfo, t_block, color, color ); // locate items. // We do not use here the COLLECTOR classes in use in pcbnew and eeschema // because the locate requirements are very basic. std::vector list; drawList.Locate( aDC, list, aPosition ); if( list.size() == 0 ) return NULL; WS_DRAW_ITEM_BASE* drawitem = list[0]; // Choose item in list if more than 1 item if( list.size() > 1 ) { wxArrayString choices; wxString text; wxPoint cursPos = GetCrossHairPosition(); for( unsigned ii = 0; ii < list.size(); ++ii ) { drawitem = list[ii]; text = drawitem->GetParent()->m_Name; if( (drawitem->m_Flags & (LOCATE_STARTPOINT|LOCATE_ENDPOINT)) == (LOCATE_STARTPOINT|LOCATE_ENDPOINT) ) text << wxT( " " ) << _( "(start or end point)" ); else { if( (drawitem->m_Flags & LOCATE_STARTPOINT) ) text << wxT( " " ) << _( "(start point)" ); if( (drawitem->m_Flags & LOCATE_ENDPOINT) ) text << wxT( " " ) << _( "(end point)" ); } if( ! drawitem->GetParent()->m_Info.IsEmpty() ) text << wxT( " \"" ) << drawitem->GetParent()->m_Info << wxT( "\"" ); choices.Add( text ); } int selection = wxGetSingleChoiceIndex ( wxEmptyString, _( "Selection Clarification" ), choices, this ); if( selection < 0 ) return NULL; SetCrossHairPosition( cursPos ); m_canvas->MoveCursorToCrossHair(); drawitem = list[selection]; } WORKSHEET_DATAITEM* item = drawitem->GetParent(); item->ClearFlags( LOCATE_STARTPOINT|LOCATE_ENDPOINT ); if( (drawitem->m_Flags & LOCATE_STARTPOINT) ) item->SetFlags( LOCATE_STARTPOINT ); if( (drawitem->m_Flags & LOCATE_ENDPOINT) ) item->SetFlags( LOCATE_ENDPOINT ); return item; } void PL_EDITOR_FRAME::OnNewPageLayout() { GetScreen()->ClearUndoRedoList(); GetScreen()->ClrModify(); m_propertiesPagelayout->CopyPrmsFromGeneralToPanel(); RebuildDesignTree(); Zoom_Automatique( false ); m_canvas->Refresh(); } const wxString PL_EDITOR_FRAME::GetZoomLevelIndicator() const { return EDA_DRAW_FRAME::GetZoomLevelIndicator(); }