KiCad PCB EDA Suite
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 ()
 Batch plotter destructor, ensures that the last plot is closed. More...
 
PCB_PLOT_PARAMSGetPlotOptions ()
 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)
 Plotters can plot in Black and White mode or Color mode SetColorMode activate/de-actiavte the Color mode. More...
 
bool GetColorMode ()
 

Private Attributes

LAYER_NUM m_plotLayer
 the layer to plot More...
 
PCB_PLOT_PARAMS m_plotOptions
 Option bank. More...
 
PLOTTERm_plotter
 This is the plotter object; it starts NULL and become instantiated when a plotfile is requested. More...
 
BOARDm_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 Especially useful in Python scripts

Definition at line 45 of file plotcontroller.h.

Constructor & Destructor Documentation

◆ PLOT_CONTROLLER()

PLOT_CONTROLLER::PLOT_CONTROLLER ( BOARD aBoard)

Batch plotter constructor, nothing interesting here.

Definition at line 405 of file pcbplot.cpp.

406 {
407  m_plotter = NULL;
408  m_board = aBoard;
410 }
PLOTTER * m_plotter
This is the plotter object; it starts NULL and become instantiated when a plotfile is requested.
BOARD * m_board
The board we're plotting.
#define NULL
LAYER_NUM m_plotLayer
the layer to plot

References m_board, m_plotLayer, m_plotter, NULL, and UNDEFINED_LAYER.

◆ ~PLOT_CONTROLLER()

PLOT_CONTROLLER::~PLOT_CONTROLLER ( )

Batch plotter destructor, ensures that the last plot is closed.

Definition at line 413 of file pcbplot.cpp.

414 {
415  ClosePlot();
416 }
void ClosePlot()
Close the current plot, nothing happens if it isn't open.
Definition: pcbplot.cpp:423

References ClosePlot().

Member Function Documentation

◆ ClosePlot()

void PLOT_CONTROLLER::ClosePlot ( )

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

Definition at line 423 of file pcbplot.cpp.

424 {
425  LOCALE_IO toggle;
426 
427  if( m_plotter )
428  {
429  m_plotter->EndPlot();
430 
431  delete m_plotter->RenderSettings();
432  delete m_plotter;
433 
434  m_plotter = NULL;
435  }
436 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
PLOTTER * m_plotter
This is the plotter object; it starts NULL and become instantiated when a plotfile is requested.
virtual bool EndPlot()=0
#define NULL
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:147

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

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

◆ GetColorMode()

bool PLOT_CONTROLLER::GetColorMode ( )
Returns
true if the current plot color mode is Color, false if the current plot color mode is Black and White

Definition at line 506 of file pcbplot.cpp.

507 {
508  if( !m_plotter )
509  return false;
510 
511  return m_plotter->GetColorMode();
512 }
PLOTTER * m_plotter
This is the plotter object; it starts NULL and become instantiated when a plotfile is requested.
bool GetColorMode() const
Definition: plotter.h:144

References PLOTTER::GetColorMode(), and m_plotter.

◆ GetLayer()

LAYER_NUM PLOT_CONTROLLER::GetLayer ( )
inline

Definition at line 61 of file plotcontroller.h.

61 { return m_plotLayer; }
LAYER_NUM m_plotLayer
the layer to plot

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 94 of file plotcontroller.h.

94 { return m_plotFile.GetPathWithSep(); }
wxFileName m_plotFile
The current plot filename, set by OpenPlotfile.

References m_plotFile.

◆ GetPlotFileName()

const wxString PLOT_CONTROLLER::GetPlotFileName ( )
inline
Returns
the current plot full filename, set by OpenPlotfile

Definition at line 89 of file plotcontroller.h.

89 { return m_plotFile.GetFullPath(); }
wxFileName m_plotFile
The current plot filename, set by OpenPlotfile.

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.

58 { return m_plotOptions; }
PCB_PLOT_PARAMS m_plotOptions
Option bank.

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.

67 { return m_plotter != NULL; }
PLOTTER * m_plotter
This is the plotter object; it starts NULL and become instantiated when a plotfile is requested.
#define NULL

References m_plotter, and NULL.

◆ 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
aSuffixis a string added to the base filename (derived from the board filename) to identify the plot file
aFormatis the plot file format identifier
aSheetDesc

Definition at line 439 of file pcbplot.cpp.

441 {
442  LOCALE_IO toggle;
443 
444  /* Save the current format: sadly some plot routines depends on this
445  but the main reason is that the StartPlot method uses it to
446  dispatch the plotter creation */
447  GetPlotOptions().SetFormat( aFormat );
448 
449  // Ensure that the previous plot is closed
450  ClosePlot();
451 
452  // Now compute the full filename for the output and start the plot
453  // (after ensuring the output directory is OK)
454  wxString outputDirName = GetPlotOptions().GetOutputDirectory() ;
455  wxFileName outputDir = wxFileName::DirName( outputDirName );
456  wxString boardFilename = m_board->GetFileName();
457 
458  if( EnsureFileDirectoryExists( &outputDir, boardFilename ) )
459  {
460  // outputDir contains now the full path of plot files
461  m_plotFile = boardFilename;
462  m_plotFile.SetPath( outputDir.GetPath() );
463  wxString fileExt = GetDefaultPlotExtension( aFormat );
464 
465  // Gerber format can use specific file ext, depending on layers
466  // (now not a good practice, because the official file ext is .gbr)
467  if( GetPlotOptions().GetFormat() == PLOT_FORMAT::GERBER
468  && GetPlotOptions().GetUseGerberProtelExtensions() )
469  fileExt = GetGerberProtelExtension( GetLayer() );
470 
471  // Build plot filenames from the board name and layer names:
472  BuildPlotFileName( &m_plotFile, outputDir.GetPath(), aSuffix, fileExt );
473 
475  m_plotFile.GetFullPath(), aSheetDesc );
476  }
477 
478  return( m_plotter != NULL );
479 }
PCB_PLOT_PARAMS & GetPlotOptions()
Accessor to the plot parameters and options.
LAYER_NUM GetLayer()
void ClosePlot()
Close the current plot, nothing happens if it isn't open.
Definition: pcbplot.cpp:423
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
PLOTTER * m_plotter
This is the plotter object; it starts NULL and become instantiated when a plotfile is requested.
wxString GetDefaultPlotExtension(PLOT_FORMAT aFormat)
Returns the default plot extension for a format.
const wxString GetGerberProtelExtension(LAYER_NUM aLayer)
Function GetGerberProtelExtension.
Definition: pcbplot.cpp:48
wxFileName m_plotFile
The current plot filename, set by OpenPlotfile.
const wxString & GetFileName() const
Definition: class_board.h:242
BOARD * m_board
The board we're plotting.
#define NULL
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.
Definition: common.cpp:609
void SetFormat(PLOT_FORMAT aFormat)
wxString GetOutputDirectory() const
void BuildPlotFileName(wxFileName *aFilename, const wxString &aOutputDir, const wxString &aSuffix, const wxString &aExtension)
Function BuildPlotFileName (helper function) Complete a plot filename: forces the output directory,...
Definition: pcbplot.cpp:373
PLOTTER * StartPlotBoard(BOARD *aBoard, PCB_PLOT_PARAMS *aPlotOpts, int aLayer, const wxString &aFullFileName, const wxString &aSheetDesc)
Open a new plotfile using the options (and especially the format) specified in the options and prepar...
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:886

References BuildPlotFileName(), ClosePlot(), EnsureFileDirectoryExists(), GERBER, GetDefaultPlotExtension(), BOARD::GetFileName(), GetGerberProtelExtension(), GetLayer(), PCB_PLOT_PARAMS::GetOutputDirectory(), GetPlotOptions(), m_board, m_plotFile, m_plotter, NULL, 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 482 of file pcbplot.cpp.

483 {
484  LOCALE_IO toggle;
485 
486  // No plot open, nothing to do...
487  if( !m_plotter )
488  return false;
489 
490  // Fully delegated to the parent
492 
493  return true;
494 }
PCB_PLOT_PARAMS & GetPlotOptions()
Accessor to the plot parameters and options.
LAYER_NUM GetLayer()
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
PLOTTER * m_plotter
This is the plotter object; it starts NULL and become instantiated when a plotfile is requested.
void PlotOneBoardLayer(BOARD *aBoard, PLOTTER *aPlotter, PCB_LAYER_ID aLayer, const PCB_PLOT_PARAMS &aPlotOpt)
Function PlotOneBoardLayer main function to plot one copper or technical layer.
BOARD * m_board
The board we're plotting.
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:886

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

◆ SetColorMode()

void PLOT_CONTROLLER::SetColorMode ( bool  aColorMode)

Plotters can plot in Black and White mode or Color mode SetColorMode activate/de-actiavte the Color mode.

Parameters
aColorMode= true to activate the plot color mode

Definition at line 497 of file pcbplot.cpp.

498 {
499  if( !m_plotter )
500  return;
501 
502  m_plotter->SetColorMode( aColorMode );
503 }
PLOTTER * m_plotter
This is the plotter object; it starts NULL and become instantiated when a plotfile is requested.
virtual void SetColorMode(bool aColorMode)
Plot in B/W or color.
Definition: plotter.h:143

References m_plotter, and PLOTTER::SetColorMode().

◆ SetLayer()

void PLOT_CONTROLLER::SetLayer ( LAYER_NUM  aLayer)
inline

Definition at line 60 of file plotcontroller.h.

60 { m_plotLayer = aLayer; }
LAYER_NUM m_plotLayer
the layer to plot

References m_plotLayer.

Member Data Documentation

◆ m_board

BOARD* PLOT_CONTROLLER::m_board
private

The board we're plotting.

Definition at line 121 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 124 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 111 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 114 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 118 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: