plotter.h File Reference

Plot settings, and plotting engines (PostScript, Gerber, HPGL and DXF) More...

#include <eda_shape.h>
#include <vector>
#include <math/box2.h>
#include <gr_text.h>
#include <page_info.h>
#include <outline_mode.h>
#include <gal/color4d.h>
#include <stroke_params.h>
#include <render_settings.h>

Go to the source code of this file.

Classes
class	PLOTTER
	Base plotter engine class. More...

Enumerations
enum class	DXF_UNITS { INCHES = 0 , MILLIMETERS = 1 }
enum class	PLOT_FORMAT {   UNDEFINED = -1 , FIRST_FORMAT = 0 , HPGL = FIRST_FORMAT , GERBER ,   POST , DXF , PDF , SVG ,   LAST_FORMAT = SVG }
	The set of supported output plot formats. More...
enum class	PLOT_TEXT_MODE { STROKE , NATIVE , PHANTOM , DEFAULT }
	Which kind of text to output with the PSLIKE plotters. More...

Functions
void	PlotDrawingSheet (PLOTTER *plotter, const PROJECT *aProject, const TITLE_BLOCK &aTitleBlock, const PAGE_INFO &aPageInfo, const std::map< wxString, wxString > *aProperties, const wxString &aSheetNumber, int aSheetCount, const wxString &aSheetName, const wxString &aSheetPath, const wxString &aFilename, COLOR4D aColor=COLOR4D::UNSPECIFIED, bool aIsFirstPage=true)
wxString	GetDefaultPlotExtension (PLOT_FORMAT aFormat)
	Returns the default plot extension for a format. More...

Detailed Description

Plot settings, and plotting engines (PostScript, Gerber, HPGL and DXF)

Definition in file plotter.h.

Enumeration Type Documentation

DXF_UNITS

enum class DXF_UNITS

strong

Enumerator
INCHES
MILLIMETERS

Definition at line 57 of file plotter.h.

{
 INCHES = 0,
 MILLIMETERS = 1
};

PLOT_FORMAT

enum class PLOT_FORMAT

strong

The set of supported output plot formats.

They should be kept in order of the radio buttons in the plot panel/windows.

Enumerator
UNDEFINED
FIRST_FORMAT
HPGL
GERBER
POST
DXF
PDF
SVG
LAST_FORMAT

Definition at line 69 of file plotter.h.

{
 UNDEFINED = -1,
 FIRST_FORMAT = 0,
 HPGL = FIRST_FORMAT,
 GERBER,
 POST,
 DXF,
 PDF,
 SVG,
 LAST_FORMAT = SVG
};

PLOT_TEXT_MODE

enum class PLOT_TEXT_MODE

strong

Which kind of text to output with the PSLIKE plotters.

You can: 1) only use the internal vector font 2) only use native postscript fonts 3) use the internal vector font and add 'phantom' text to aid searching 4) keep the default for the plot driver

This is recognized by the DXF driver too, where NATIVE emits TEXT entities instead of stroking the text

Enumerator
STROKE
NATIVE
PHANTOM
DEFAULT

Definition at line 95 of file plotter.h.

{
 STROKE,
 NATIVE,
 PHANTOM,
 DEFAULT
};

Function Documentation

GetDefaultPlotExtension()

wxString GetDefaultPlotExtension

(

PLOT_FORMAT

aFormat

)

Returns the default plot extension for a format.

Definition at line 37 of file common_plot_functions.cpp.

{
 switch( aFormat )
 {
 case PLOT_FORMAT::DXF:
 return DXF_PLOTTER::GetDefaultFileExtension();
 case PLOT_FORMAT::POST:
 return PS_PLOTTER::GetDefaultFileExtension();
 case PLOT_FORMAT::PDF:
 return PDF_PLOTTER::GetDefaultFileExtension();
 case PLOT_FORMAT::HPGL:
 return HPGL_PLOTTER::GetDefaultFileExtension();
 case PLOT_FORMAT::GERBER:
 return GERBER_PLOTTER::GetDefaultFileExtension();
 case PLOT_FORMAT::SVG:
 return SVG_PLOTTER::GetDefaultFileExtension();
 default:
 wxASSERT( false );
 return wxEmptyString;
 }
}

References DXF, GERBER, DXF_PLOTTER::GetDefaultFileExtension(), GERBER_PLOTTER::GetDefaultFileExtension(), HPGL_PLOTTER::GetDefaultFileExtension(), PS_PLOTTER::GetDefaultFileExtension(), PDF_PLOTTER::GetDefaultFileExtension(), SVG_PLOTTER::GetDefaultFileExtension(), HPGL, PDF, POST, and SVG.

Referenced by GENDRILL_WRITER_BASE::CreateMapFilesSet(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().

PlotDrawingSheet()

void PlotDrawingSheet	(	PLOTTER *	plotter,
		const PROJECT *	aProject,
		const TITLE_BLOCK &	aTitleBlock,
		const PAGE_INFO &	aPageInfo,
		const std::map< wxString, wxString > *	aProperties,
		const wxString &	aSheetNumber,
		int	aSheetCount,
		const wxString &	aSheetName,
		const wxString &	aSheetPath,
		const wxString &	aFilename,
		COLOR4D	aColor = COLOR4D::UNSPECIFIED,
		bool	aIsFirstPage = true
	)

Definition at line 60 of file common_plot_functions.cpp.

{
 /* Note: Page sizes values are given in mils
 */
 double iusPerMil = plotter->GetIUsPerDecimil() * 10.0;
 COLOR4D plotColor = plotter->GetColorMode() ? aColor : COLOR4D::BLACK;
 RENDER_SETTINGS* settings = plotter->RenderSettings();
 int defaultPenWidth = settings->GetDefaultPenWidth();
 
 if( plotColor == COLOR4D::UNSPECIFIED )
 plotColor = COLOR4D( RED );
 
 DS_DRAW_ITEM_LIST drawList;
 
 // Print only a short filename, if aFilename is the full filename
 wxFileName fn( aFilename );
 
 // Prepare plot parameters
 drawList.SetDefaultPenSize( PLOTTER::USE_DEFAULT_LINE_WIDTH );
 drawList.SetMilsToIUfactor( iusPerMil );
 drawList.SetPageNumber( aSheetNumber );
 drawList.SetSheetCount( aSheetCount );
 drawList.SetFileName( fn.GetFullName() ); // Print only the short filename
 drawList.SetSheetName( aSheetName );
 drawList.SetSheetPath( aSheetPath );
 drawList.SetSheetLayer( settings->GetLayerName() );
 drawList.SetProject( aProject );
 drawList.SetIsFirstPage( aIsFirstPage );
 drawList.SetProperties( aProperties );
 
 drawList.BuildDrawItemsList( aPageInfo, aTitleBlock );
 
 // Draw item list
 for( DS_DRAW_ITEM_BASE* item = drawList.GetFirst(); item; item = drawList.GetNext() )
 {
 plotter->SetColor( plotColor );
 plotter->SetCurrentLineWidth( PLOTTER::USE_DEFAULT_LINE_WIDTH );
 
 switch( item->Type() )
 {
 case WSG_LINE_T:
 {
 DS_DRAW_ITEM_LINE* line = (DS_DRAW_ITEM_LINE*) item;
 plotter->SetCurrentLineWidth( std::max( line->GetPenWidth(), defaultPenWidth ) );
 plotter->MoveTo( line->GetStart() );
 plotter->FinishTo( line->GetEnd() );
 }
 break;
 
 case WSG_RECT_T:
 {
 DS_DRAW_ITEM_RECT* rect = (DS_DRAW_ITEM_RECT*) item;
 plotter->SetCurrentLineWidth( std::max( rect->GetPenWidth(), defaultPenWidth ) );
 plotter->MoveTo( rect->GetStart() );
 plotter->LineTo( VECTOR2I( rect->GetEnd().x, rect->GetStart().y ) );
 plotter->LineTo( VECTOR2I( rect->GetEnd().x, rect->GetEnd().y ) );
 plotter->LineTo( VECTOR2I( rect->GetStart().x, rect->GetEnd().y ) );
 plotter->FinishTo( rect->GetStart() );
 }
 break;
 
 case WSG_TEXT_T:
 {
 DS_DRAW_ITEM_TEXT* text = (DS_DRAW_ITEM_TEXT*) item;
 KIFONT::FONT* font = text->GetFont();
 COLOR4D color = plotColor;
 
 if( !font )
 {
 font = KIFONT::FONT::GetFont( settings->GetDefaultFont(), text->IsBold(),
 text->IsItalic() );
 }
 
 if( plotter->GetColorMode() && text->GetTextColor() != COLOR4D::UNSPECIFIED )
 color = text->GetTextColor();
 
 int penWidth = std::max( text->GetEffectiveTextPenWidth(), defaultPenWidth );
 
 plotter->Text( text->GetTextPos(), color, text->GetShownText(), text->GetTextAngle(),
 text->GetTextSize(), text->GetHorizJustify(), text->GetVertJustify(),
 penWidth, text->IsItalic(), text->IsBold(), text->IsMultilineAllowed(),
 font );
 }
 break;
 
 case WSG_POLY_T:
 {
 DS_DRAW_ITEM_POLYPOLYGONS* poly = (DS_DRAW_ITEM_POLYPOLYGONS*) item;
 int penWidth = std::max( poly->GetPenWidth(), defaultPenWidth );
 std::vector<VECTOR2I> points;
 
 for( int idx = 0; idx < poly->GetPolygons().OutlineCount(); ++idx )
 {
 points.clear();
 SHAPE_LINE_CHAIN& outline = poly->GetPolygons().Outline( idx );
 
 for( int ii = 0; ii < outline.PointCount(); ii++ )
 points.emplace_back( outline.CPoint( ii ).x, outline.CPoint( ii ).y );
 
 plotter->PlotPoly( points, FILL_T::FILLED_SHAPE, penWidth );
 }
 }
 break;
 
 case WSG_BITMAP_T:
 {
 DS_DRAW_ITEM_BITMAP* drawItem = (DS_DRAW_ITEM_BITMAP*) item;
 DS_DATA_ITEM_BITMAP* bitmap = (DS_DATA_ITEM_BITMAP*) drawItem->GetPeer();
 
 if( bitmap->m_ImageBitmap == nullptr )
 break;
 
 bitmap->m_ImageBitmap->PlotImage( plotter, drawItem->GetPosition(), plotColor,
 PLOTTER::USE_DEFAULT_LINE_WIDTH );
 }
 break;
 
 default:
 wxFAIL_MSG( "PlotDrawingSheet(): Unknown drawing sheet item." );
 break;
 }
 }
}

References BLACK, DS_DRAW_ITEM_LIST::BuildDrawItemsList(), color, SHAPE_LINE_CHAIN::CPoint(), FILLED_SHAPE, PLOTTER::FinishTo(), PLOTTER::GetColorMode(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), DS_DRAW_ITEM_LINE::GetEnd(), DS_DRAW_ITEM_RECT::GetEnd(), DS_DRAW_ITEM_LIST::GetFirst(), KIFONT::FONT::GetFont(), PLOTTER::GetIUsPerDecimil(), KIGFX::RENDER_SETTINGS::GetLayerName(), DS_DRAW_ITEM_LIST::GetNext(), DS_DRAW_ITEM_BASE::GetPeer(), DS_DRAW_ITEM_BASE::GetPenWidth(), DS_DRAW_ITEM_POLYPOLYGONS::GetPolygons(), DS_DRAW_ITEM_BITMAP::GetPosition(), DS_DRAW_ITEM_LINE::GetStart(), DS_DRAW_ITEM_RECT::GetStart(), PLOTTER::LineTo(), DS_DATA_ITEM_BITMAP::m_ImageBitmap, PLOTTER::MoveTo(), SHAPE_POLY_SET::Outline(), BITMAP_BASE::PlotImage(), PLOTTER::PlotPoly(), SHAPE_LINE_CHAIN::PointCount(), RED, PLOTTER::RenderSettings(), PLOTTER::SetColor(), PLOTTER::SetCurrentLineWidth(), DS_DRAW_ITEM_LIST::SetDefaultPenSize(), DS_DRAW_ITEM_LIST::SetFileName(), DS_DRAW_ITEM_LIST::SetIsFirstPage(), DS_DRAW_ITEM_LIST::SetMilsToIUfactor(), DS_DRAW_ITEM_LIST::SetPageNumber(), DS_DRAW_ITEM_LIST::SetProject(), DS_DRAW_ITEM_LIST::SetProperties(), DS_DRAW_ITEM_LIST::SetSheetCount(), DS_DRAW_ITEM_LIST::SetSheetLayer(), DS_DRAW_ITEM_LIST::SetSheetName(), DS_DRAW_ITEM_LIST::SetSheetPath(), text, PLOTTER::Text(), PLOTTER::USE_DEFAULT_LINE_WIDTH, WSG_BITMAP_T, WSG_LINE_T, WSG_POLY_T, WSG_RECT_T, WSG_TEXT_T, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetHpgl(), SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), and StartPlotBoard().