KiCad PCB EDA Suite
legacy_wx/eda_draw_frame.cpp File Reference
#include <fctsys.h>
#include <pgm_base.h>
#include <kiface_i.h>
#include <gr_basic.h>
#include <common.h>
#include <bitmaps.h>
#include <macros.h>
#include <id.h>
#include <class_drawpanel.h>
#include <base_screen.h>
#include <msgpanel.h>
#include <draw_frame.h>
#include <confirm.h>
#include <kicad_device_context.h>
#include <dialog_helpers.h>
#include <base_units.h>
#include <math/box2.h>
#include <lockfile.h>
#include <trace_helpers.h>
#include <wx/clipbrd.h>
#include <wx/fontdlg.h>
#include <wx/snglinst.h>
#include <view/view.h>
#include <view/view_controls.h>
#include <gal/graphics_abstraction_layer.h>
#include <tool/tool_manager.h>
#include <tool/tool_dispatcher.h>
#include <tool/actions.h>
#include <advanced_config.h>
#include <menus_helpers.h>
#include <page_info.h>
#include <title_block.h>
#include <worksheet_shape_builder.h>

Go to the source code of this file.


#define VIRT_MIN   (-MAX_AXIS/2.0)
 min X or Y coordinate in virtual space More...
#define VIRT_MAX   (MAX_AXIS/2.0)
 max X or Y coordinate in virtual space More...


static const wxString traceScrollSettings (wxT("KicadScrollSettings"))
 Definition for enabling and disabling scroll bar setting trace output. More...
static const wxString MaxUndoItemsEntry (wxT("DevelMaxUndoItems"))
 Integer to set the maximum number of undo items on the stack. More...
wxWindow * findDialog (wxWindowList &aList)
static bool DrawPageOnClipboard (EDA_DRAW_FRAME *aFrame)
void DrawPageLayout (wxDC *aDC, EDA_RECT *aClipBox, const PAGE_INFO &aPageInfo, const wxString &aFullSheetName, const wxString &aFileName, TITLE_BLOCK &aTitleBlock, int aSheetCount, int aSheetNumber, int aPenWidth, double aScalar, COLOR4D aColor, COLOR4D aAltColor, const wxString &aSheetLayer)
 Function DrawPageLayout is a core function to draw the page layout with the frame and the basic inscriptions. More...
static const wxString FirstRunShownKeyword (wxT("FirstRunShown"))


static const double MAX_AXIS = INT_MAX - 100

Macro Definition Documentation


#define VIRT_MAX   (MAX_AXIS/2.0)

max X or Y coordinate in virtual space

Definition at line 955 of file legacy_wx/eda_draw_frame.cpp.


#define VIRT_MIN   (-MAX_AXIS/2.0)

min X or Y coordinate in virtual space

Definition at line 954 of file legacy_wx/eda_draw_frame.cpp.

Function Documentation

◆ DrawPageLayout()

void DrawPageLayout ( wxDC *  aDC,
EDA_RECT aClipBox,
const PAGE_INFO aPageInfo,
const wxString &  aFullSheetName,
const wxString &  aFileName,
TITLE_BLOCK aTitleBlock,
int  aSheetCount,
int  aSheetNumber,
int  aPenWidth,
double  aScalar,
COLOR4D  aColor,
COLOR4D  aAltColor,
const wxString &  aSheetLayer = wxEmptyString 

Function DrawPageLayout is a core function to draw the page layout with the frame and the basic inscriptions.

aDCThe device context.
aClipBox= the clipping rect, or NULL if no clipping.
aPageInfofor margins and page size (in mils).
aFullSheetNameThe sheetpath (full sheet name), for basic inscriptions.
aFileNameThe file name, for basic inscriptions.
aTitleBlockThe sheet title block, for basic inscriptions.
aSheetCountThe number of sheets (for basic inscriptions).
aSheetNumberThe sheet number (for basic inscriptions).
aPenWidththe pen size The line width for drawing.
aScalarthe scale factor to convert from mils to internal units.
aColorThe color for drawing.
aAltColorThe color for items which need to be "hightlighted".
aSheetLayerThe layer from pcbnew.

Parameters used in aPageInfo

  • the size of the page layout.
  • the LTmargin The left top margin of the page layout.
  • the RBmargin The right bottom margin of the page layout.

Definition at line 2032 of file legacy_wx/eda_draw_frame.cpp.

2041 {
2042  WS_DRAW_ITEM_LIST drawList;
2044  drawList.SetPenSize( aPenWidth );
2045  drawList.SetMilsToIUfactor( aScalar );
2046  drawList.SetSheetNumber( aSheetNumber );
2047  drawList.SetSheetCount( aSheetCount );
2048  drawList.SetFileName( aFileName );
2049  drawList.SetSheetName( aFullSheetName );
2050  drawList.SetSheetLayer( aSheetLayer );
2052  drawList.BuildWorkSheetGraphicList( aPageInfo,
2053  aTitleBlock, aColor, aAltColor );
2055  // Draw item list
2056  drawList.Draw( aClipBox, aDC );
2057 }
void SetFileName(const wxString &aFileName)
Set the filename to draw/plot.
void SetPenSize(int aPenSize)
Function SetPenSize Set the default pen size to draw/plot lines and texts.
void SetSheetLayer(const wxString &aSheetLayer)
Set the sheet layer to draw/plot.
void SetSheetName(const wxString &aSheetName)
Set the sheet name to draw/plot.
void BuildWorkSheetGraphicList(const PAGE_INFO &aPageInfo, const TITLE_BLOCK &aTitleBlock, COLOR4D aColor, COLOR4D aAltColor)
Function BuildWorkSheetGraphicList is a core function for drawing or plotting the page layout with th...
void SetSheetCount(int aSheetCount)
Function SetSheetCount Set the value of the count of sheets, for basic inscriptions.
void SetMilsToIUfactor(double aScale)
Function SetMilsToIUfactor Set the scalar to convert pages units ( mils) to draw/plot units.
void SetSheetNumber(int aSheetNumber)
Function SetSheetNumber Set the value of the sheet number, for basic inscriptions.
void Draw(EDA_RECT *aClipBox, wxDC *aDC)
Draws the item list created by BuildWorkSheetGraphicList.

References WS_DRAW_ITEM_LIST::BuildWorkSheetGraphicList(), WS_DRAW_ITEM_LIST::Draw(), WS_DRAW_ITEM_LIST::SetFileName(), WS_DRAW_ITEM_LIST::SetMilsToIUfactor(), WS_DRAW_ITEM_LIST::SetPenSize(), WS_DRAW_ITEM_LIST::SetSheetCount(), WS_DRAW_ITEM_LIST::SetSheetLayer(), WS_DRAW_ITEM_LIST::SetSheetName(), and WS_DRAW_ITEM_LIST::SetSheetNumber().

◆ DrawPageOnClipboard()

bool DrawPageOnClipboard ( EDA_DRAW_FRAME aFrame)

Definition at line 1930 of file legacy_wx/eda_draw_frame.cpp.

1931 {
1932  bool DrawBlock = false;
1933  wxRect DrawArea;
1934  BASE_SCREEN* screen = aFrame->GetCanvas()->GetScreen();
1936  if( screen->IsBlockActive() )
1937  {
1938  DrawBlock = true;
1939  DrawArea.SetX( screen->m_BlockLocate.GetX() );
1940  DrawArea.SetY( screen->m_BlockLocate.GetY() );
1941  DrawArea.SetWidth( screen->m_BlockLocate.GetWidth() );
1942  DrawArea.SetHeight( screen->m_BlockLocate.GetHeight() );
1943  }
1944  else
1945  DrawArea.SetSize( aFrame->GetPageSizeIU() );
1947  // Calculate a reasonable dc size, in pixels, and the dc scale to fit
1948  // the drawings into the dc size
1949  // scale is the ratio resolution (in PPI) / internal units
1950  double ppi = 300; // Use 300 pixels per inch to create bitmap images on start
1951  double inch2Iu = 1000.0 * (double) screen->MilsToIuScalar();
1952  double scale = ppi / inch2Iu;
1954  wxSize dcsize = DrawArea.GetSize();
1956  int maxdim = std::max( dcsize.x, dcsize.y );
1958  // the max size in pixels of the bitmap used to byuild the sheet copy
1959  const int maxbitmapsize = 3000;
1961  while( int( maxdim * scale ) > maxbitmapsize )
1962  {
1963  ppi = ppi / 1.5;
1964  scale = ppi / inch2Iu;
1965  }
1967  dcsize.x *= scale;
1968  dcsize.y *= scale;
1970  // Set draw offset, zoom... to values needed to draw in the memory DC
1971  // after saving initial values:
1972  wxPoint tmp_startvisu = screen->m_StartVisu;
1973  double tmpzoom = screen->GetZoom();
1974  wxPoint old_org = screen->m_DrawOrg;
1975  screen->m_DrawOrg.x = screen->m_DrawOrg.y = 0;
1976  screen->m_StartVisu.x = screen->m_StartVisu.y = 0;
1978  screen->SetZoom( 1 ); // we use zoom = 1 in draw functions.
1980  wxMemoryDC dc;
1981  wxBitmap image( dcsize );
1982  dc.SelectObject( image );
1984  EDA_RECT tmp = *aFrame->GetCanvas()->GetClipBox();
1985  GRResetPenAndBrush( &dc );
1986  GRForceBlackPen( false );
1987  screen->m_IsPrinting = true;
1988  dc.SetUserScale( scale, scale );
1990  aFrame->GetCanvas()->SetClipBox( EDA_RECT( wxPoint( 0, 0 ),
1991  wxSize( 0x7FFFFF0, 0x7FFFFF0 ) ) );
1993  if( DrawBlock )
1994  {
1995  dc.SetClippingRegion( DrawArea );
1996  }
1998  dc.Clear();
1999  aFrame->GetCanvas()->EraseScreen( &dc );
2000  const LSET allLayersMask = LSET().set();
2001  aFrame->PrintPage( &dc, allLayersMask, false );
2002  screen->m_IsPrinting = false;
2003  aFrame->GetCanvas()->SetClipBox( tmp );
2005  bool success = true;
2007  if( wxTheClipboard->Open() )
2008  {
2009  // This data objects are held by the clipboard,
2010  // so do not delete them in the app.
2011  wxBitmapDataObject* clipbrd_data = new wxBitmapDataObject( image );
2012  wxTheClipboard->SetData( clipbrd_data );
2013  wxTheClipboard->Close();
2014  }
2015  else
2016  success = false;
2018  // Deselect Bitmap from DC in order to delete the MemoryDC safely
2019  // without deleting the bitmap
2020  dc.SelectObject( wxNullBitmap );
2022  GRForceBlackPen( false );
2024  screen->m_StartVisu = tmp_startvisu;
2025  screen->m_DrawOrg = old_org;
2026  screen->SetZoom( tmpzoom );
2028  return success;
2029 }
virtual BASE_SCREEN * GetScreen()=0
void GRResetPenAndBrush(wxDC *DC)
Definition: gr_basic.cpp:123
Block description for block commands.
Definition: base_screen.h:214
bool IsBlockActive() const
Definition: base_screen.h:499
int GetX() const
Definition: eda_rect.h:109
double GetZoom() const
Function GetZoom returns the current "zoom factor", which is a measure of "internal units per device ...
Definition: base_screen.h:340
int GetWidth() const
Definition: eda_rect.h:117
virtual EDA_RECT * GetClipBox()
virtual const wxSize GetPageSizeIU() const =0
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
void SetClipBox(const EDA_RECT &aRect)
wxPoint m_StartVisu
Coordinates in drawing units of the current view position (upper left corner of device)
Definition: base_screen.h:198
Class LSET is a set of PCB_LAYER_IDs.
virtual void PrintPage(wxDC *aDC, LSET aPrintMask, bool aPrintMirrorMode, void *aData=NULL)
Print the page pointed by current screen, set by the calling print function.
void GRForceBlackPen(bool flagforce)
Function GRForceBlackPen.
Definition: gr_basic.cpp:204
Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:76
virtual int MilsToIuScalar()
Function MilsToIuScalar returns the scalar required to convert mils to internal units.
Definition: base_screen.h:245
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
virtual EDA_DRAW_PANEL * GetCanvas() const
Definition: draw_frame.h:399
bool m_IsPrinting
Definition: base_screen.h:220
int GetHeight() const
Definition: eda_rect.h:118
const int scale
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxPoint m_DrawOrg
offsets for drawing the circuit on the screen
Definition: base_screen.h:183
int GetY() const
Definition: eda_rect.h:110
virtual void EraseScreen(wxDC *DC)
Function OnMouseWheel handles mouse wheel events.

References EDA_DRAW_PANEL::EraseScreen(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL::GetClipBox(), EDA_RECT::GetHeight(), EDA_DRAW_FRAME::GetPageSizeIU(), EDA_DRAW_PANEL::GetScreen(), EDA_RECT::GetWidth(), EDA_RECT::GetX(), EDA_RECT::GetY(), BASE_SCREEN::GetZoom(), GRForceBlackPen(), GRResetPenAndBrush(), BASE_SCREEN::IsBlockActive(), BASE_SCREEN::m_BlockLocate, BASE_SCREEN::m_DrawOrg, BASE_SCREEN::m_IsPrinting, BASE_SCREEN::m_StartVisu, max, BASE_SCREEN::MilsToIuScalar(), EDA_DRAW_FRAME::PrintPage(), scale, EDA_DRAW_PANEL::SetClipBox(), and BASE_SCREEN::SetZoom().


◆ findDialog()

wxWindow* findDialog ( wxWindowList &  aList)

Definition at line 1847 of file legacy_wx/eda_draw_frame.cpp.

1848 {
1849  for( wxWindow* window : aList )
1850  {
1851  if( dynamic_cast<DIALOG_SHIM*>( window ) )
1852  return window;
1853  }
1854  return NULL;
1855 }

◆ FirstRunShownKeyword()

static const wxString FirstRunShownKeyword ( wxT("FirstRunShown")  )

◆ MaxUndoItemsEntry()

static const wxString MaxUndoItemsEntry ( wxT("DevelMaxUndoItems")  )

Integer to set the maximum number of undo items on the stack.

If zero, undo items are unlimited.

Present as:

  • SchematicFrameDevelMaxUndoItems (file: eeschema)
  • LibeditFrameDevelMaxUndoItems (file: eeschema)
  • PcbFrameDevelMaxUndoItems (file: pcbnew)
  • ModEditFrameDevelMaxUndoItems (file: pcbnew)

◆ traceScrollSettings()

static const wxString traceScrollSettings ( wxT("KicadScrollSettings")  )

Definition for enabling and disabling scroll bar setting trace output.

See the wxWidgets documentation on useing the WXTRACE environment variable.

Variable Documentation



const double MAX_AXIS = INT_MAX - 100

Definition at line 952 of file legacy_wx/eda_draw_frame.cpp.