PLOT_CONTROLLER Class Reference

Batch plotter state object. More...

#include <plotcontroller.h>

Public Member Functions
	PLOT_CONTROLLER (BOARD *aBoard)
	Batch plotter constructor, nothing interesting here. More...
	~PLOT_CONTROLLER ()
	Ensure that the last plot is closed. More...
PCB_PLOT_PARAMS &	GetPlotOptions ()
	Accessor to the plot parameters and options. More...
void	SetLayer (LAYER_NUM aLayer)
LAYER_NUM	GetLayer ()
bool	IsPlotOpen () const
void	ClosePlot ()
	Close the current plot, nothing happens if it isn't open. More...
bool	OpenPlotfile (const wxString &aSuffix, PLOT_FORMAT aFormat, const wxString &aSheetDesc)
	Open a new plotfile; works as a factory for plotter objects/. More...
bool	PlotLayer ()
	Plot a single layer on the current plotfile m_plotLayer is the layer to plot. More...
const wxString	GetPlotFileName ()
const wxString	GetPlotDirName ()
void	SetColorMode (bool aColorMode)
	Choose color or bland and white plot mode. More...
bool	GetColorMode ()

Private Attributes
LAYER_NUM	m_plotLayer
	the layer to plot More...
PCB_PLOT_PARAMS	m_plotOptions
	Option bank. More...
PLOTTER *	m_plotter
	This is the plotter object; it starts NULL and become instantiated when a plotfile is requested. More...
BOARD *	m_board
	The board we're plotting. More...
wxFileName	m_plotFile
	The current plot filename, set by OpenPlotfile. More...

Detailed Description

Batch plotter state object.

Keeps the plot options and handles multiple plot requests. Useful in Python scripts.

Definition at line 44 of file plotcontroller.h.

Constructor & Destructor Documentation

PLOT_CONTROLLER()

PLOT_CONTROLLER::PLOT_CONTROLLER

(

BOARD *

aBoard

)

Batch plotter constructor, nothing interesting here.

Definition at line 404 of file pcbplot.cpp.

{
 m_plotter = nullptr;
 m_board = aBoard;
 m_plotLayer = UNDEFINED_LAYER;
}

References m_board, m_plotLayer, m_plotter, and UNDEFINED_LAYER.

~PLOT_CONTROLLER()

PLOT_CONTROLLER::~PLOT_CONTROLLER

(

)

Ensure that the last plot is closed.

Definition at line 412 of file pcbplot.cpp.

{
 ClosePlot();
}

References ClosePlot().

Member Function Documentation

ClosePlot()

void PLOT_CONTROLLER::ClosePlot

(

)

Close the current plot, nothing happens if it isn't open.

Definition at line 421 of file pcbplot.cpp.

{
 LOCALE_IO toggle;

 if( m_plotter )
 {
 m_plotter->EndPlot();

 delete m_plotter->RenderSettings();
 delete m_plotter;

 m_plotter = nullptr;
 }
}

References PLOTTER::EndPlot(), m_plotter, and PLOTTER::RenderSettings().

Referenced by OpenPlotfile(), and ~PLOT_CONTROLLER().

GetColorMode()

bool PLOT_CONTROLLER::GetColorMode

(

)

Returns

true if the current plot color mode is color or false if the current plot color mode is black and white.

Definition at line 515 of file pcbplot.cpp.

{
 if( !m_plotter )
 return false;

 return m_plotter->GetColorMode();
}

References PLOTTER::GetColorMode(), and m_plotter.

GetLayer()

LAYER_NUM PLOT_CONTROLLER::GetLayer ( )

inline

Definition at line 61 of file plotcontroller.h.

{ return m_plotLayer; }

References m_plotLayer.

Referenced by OpenPlotfile(), and PlotLayer().

GetPlotDirName()

const wxString PLOT_CONTROLLER::GetPlotDirName ( )

inline

Returns

the current plot full filename, set by OpenPlotfile

Definition at line 95 of file plotcontroller.h.

{ return m_plotFile.GetPathWithSep(); }

References m_plotFile.

GetPlotFileName()

const wxString PLOT_CONTROLLER::GetPlotFileName ( )

inline

Returns

the current plot full filename, set by OpenPlotfile

Definition at line 90 of file plotcontroller.h.

{ return m_plotFile.GetFullPath(); }

References m_plotFile.

GetPlotOptions()

PCB_PLOT_PARAMS& PLOT_CONTROLLER::GetPlotOptions ( )

inline

Accessor to the plot parameters and options.

Definition at line 58 of file plotcontroller.h.

{ return m_plotOptions; }

References m_plotOptions.

Referenced by OpenPlotfile(), and PlotLayer().

IsPlotOpen()

bool PLOT_CONTROLLER::IsPlotOpen ( ) const

inline

Returns

true if a plotter is initialized and can be used.

Definition at line 67 of file plotcontroller.h.

{ return m_plotter != nullptr; }

References m_plotter.

OpenPlotfile()

bool PLOT_CONTROLLER::OpenPlotfile	(	const wxString &	aSuffix,
		PLOT_FORMAT	aFormat,
		const wxString &	aSheetDesc
	)

Open a new plotfile; works as a factory for plotter objects/.

Parameters

aSuffix	is a string added to the base filename (derived from the board filename) to identify the plot file.
aFormat	is the plot file format identifier.

Definition at line 437 of file pcbplot.cpp.

{
 LOCALE_IO toggle;

 /* Save the current format: sadly some plot routines depends on this
 but the main reason is that the StartPlot method uses it to
 dispatch the plotter creation */
 GetPlotOptions().SetFormat( aFormat );

 // Ensure that the previous plot is closed
 ClosePlot();

 // Now compute the full filename for the output and start the plot (after ensuring the
 // output directory is OK).

 std::function<bool( wxString* )> textResolver =
 [&]( wxString* token ) -> bool
 {
 // Handles m_board->GetTitleBlock() *and* m_board->GetProject()
 return m_board->ResolveTextVar( token, 0 );
 };

 wxString outputDirName = GetPlotOptions().GetOutputDirectory();
 outputDirName = ExpandTextVars( outputDirName, &textResolver, nullptr, nullptr );
 outputDirName = ExpandEnvVarSubstitutions( outputDirName, nullptr );

 wxFileName outputDir = wxFileName::DirName( outputDirName );
 wxString boardFilename = m_board->GetFileName();

 if( EnsureFileDirectoryExists( &outputDir, boardFilename ) )
 {
 // outputDir contains now the full path of plot files
 m_plotFile = boardFilename;
 m_plotFile.SetPath( outputDir.GetPath() );
 wxString fileExt = GetDefaultPlotExtension( aFormat );

 // Gerber format can use specific file ext, depending on layers
 // (now not a good practice, because the official file ext is .gbr)
 if( GetPlotOptions().GetFormat() == PLOT_FORMAT::GERBER
 && GetPlotOptions().GetUseGerberProtelExtensions() )
 fileExt = GetGerberProtelExtension( GetLayer() );

 // Build plot filenames from the board name and layer names:
 BuildPlotFileName( &m_plotFile, outputDir.GetPath(), aSuffix, fileExt );

 m_plotter = StartPlotBoard( m_board, &GetPlotOptions(), ToLAYER_ID( GetLayer() ),
 m_plotFile.GetFullPath(), aSheetDesc );
 }

 return ( m_plotter != nullptr );
}

References BuildPlotFileName(), ClosePlot(), EnsureFileDirectoryExists(), ExpandEnvVarSubstitutions(), ExpandTextVars(), GERBER, GetDefaultPlotExtension(), BOARD::GetFileName(), GetGerberProtelExtension(), GetLayer(), PCB_PLOT_PARAMS::GetOutputDirectory(), GetPlotOptions(), m_board, m_plotFile, m_plotter, BOARD::ResolveTextVar(), PCB_PLOT_PARAMS::SetFormat(), StartPlotBoard(), and ToLAYER_ID().

PlotLayer()

bool PLOT_CONTROLLER::PlotLayer

(

)

Plot a single layer on the current plotfile m_plotLayer is the layer to plot.

Definition at line 491 of file pcbplot.cpp.

{
 LOCALE_IO toggle;

 // No plot open, nothing to do...
 if( !m_plotter )
 return false;

 // Fully delegated to the parent
 PlotOneBoardLayer( m_board, m_plotter, ToLAYER_ID( GetLayer() ), GetPlotOptions() );

 return true;
}

References GetLayer(), GetPlotOptions(), m_board, m_plotter, PlotOneBoardLayer(), and ToLAYER_ID().

SetColorMode()

void PLOT_CONTROLLER::SetColorMode

(

bool

aColorMode

)

Choose color or bland and white plot mode.

Parameters

aColorMode

set to true to activate the plot color mode or false for black and white.

Definition at line 506 of file pcbplot.cpp.

{
 if( !m_plotter )
 return;

 m_plotter->SetColorMode( aColorMode );
}

References m_plotter, and PLOTTER::SetColorMode().

SetLayer()

void PLOT_CONTROLLER::SetLayer ( LAYER_NUM  aLayer )

inline

Definition at line 60 of file plotcontroller.h.

{ m_plotLayer = aLayer; }

References m_plotLayer.

Member Data Documentation

m_board

BOARD* PLOT_CONTROLLER::m_board

private

The board we're plotting.

Definition at line 122 of file plotcontroller.h.

Referenced by OpenPlotfile(), PLOT_CONTROLLER(), and PlotLayer().

m_plotFile

wxFileName PLOT_CONTROLLER::m_plotFile

private

The current plot filename, set by OpenPlotfile.

Definition at line 125 of file plotcontroller.h.

Referenced by GetPlotDirName(), GetPlotFileName(), and OpenPlotfile().

m_plotLayer

LAYER_NUM PLOT_CONTROLLER::m_plotLayer

private

the layer to plot

Definition at line 112 of file plotcontroller.h.

Referenced by GetLayer(), PLOT_CONTROLLER(), and SetLayer().

m_plotOptions

PCB_PLOT_PARAMS PLOT_CONTROLLER::m_plotOptions

private

Option bank.

Definition at line 115 of file plotcontroller.h.

Referenced by GetPlotOptions().

m_plotter

PLOTTER* PLOT_CONTROLLER::m_plotter

private

This is the plotter object; it starts NULL and become instantiated when a plotfile is requested.

Definition at line 119 of file plotcontroller.h.

Referenced by ClosePlot(), GetColorMode(), IsPlotOpen(), OpenPlotfile(), PLOT_CONTROLLER(), PlotLayer(), and SetColorMode().

---

The documentation for this class was generated from the following files:

• plotcontroller.h
• pcbplot.cpp