pcb_plot_params.h

Go to the documentation of this file.

#ifndef PCB_PLOT_PARAMS_H_
#define PCB_PLOT_PARAMS_H_
/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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
 */

#include <plotters/plotter.h>
#include <layer_ids.h>

class COLOR_SETTINGS;
class PCB_PLOT_PARAMS_PARSER;

class PCB_PLOT_PARAMS
{
public:
 enum DrillMarksType {
 NO_DRILL_SHAPE = 0,
 SMALL_DRILL_SHAPE = 1,
 FULL_DRILL_SHAPE = 2
 };

 PCB_PLOT_PARAMS();

 void SetSkipPlotNPTH_Pads( bool aSkip ) { m_skipNPTH_Pads = aSkip; }
 bool GetSkipPlotNPTH_Pads() const { return m_skipNPTH_Pads; }

 void Format( OUTPUTFORMATTER* aFormatter, int aNestLevel, int aControl=0 ) const;
 void Parse( PCB_PLOT_PARAMS_PARSER* aParser );

 bool IsSameAs( const PCB_PLOT_PARAMS &aPcbPlotParams ) const;

 void SetColorSettings( COLOR_SETTINGS* aSettings ) { m_colors = aSettings; }

 COLOR_SETTINGS* ColorSettings() const { return m_colors; }

 void SetTextMode( PLOT_TEXT_MODE aVal )
 {
 m_textMode = aVal;
 }

 PLOT_TEXT_MODE GetTextMode() const
 {
 return m_textMode;
 }

 void SetPlotMode( OUTLINE_MODE aPlotMode ) { m_plotMode = aPlotMode; }
 OUTLINE_MODE GetPlotMode() const { return m_plotMode; }

 void SetDXFPlotPolygonMode( bool aFlag ) { m_DXFplotPolygonMode = aFlag; }
 bool GetDXFPlotPolygonMode() const { return m_DXFplotPolygonMode; }

 void SetDXFPlotUnits( DXF_UNITS aUnit )
 {
 m_DXFplotUnits = aUnit;
 }

 DXF_UNITS GetDXFPlotUnits() const
 {
 return m_DXFplotUnits;
 }

 void SetDrillMarksType( DrillMarksType aVal ) { m_drillMarks = aVal; }
 DrillMarksType GetDrillMarksType() const { return m_drillMarks; }

 void SetScale( double aVal ) { m_scale = aVal; }
 double GetScale() const { return m_scale; }

 void SetFineScaleAdjustX( double aVal ) { m_fineScaleAdjustX = aVal; }
 double GetFineScaleAdjustX() const { return m_fineScaleAdjustX; }
 void SetFineScaleAdjustY( double aVal ) { m_fineScaleAdjustY = aVal; }
 double GetFineScaleAdjustY() const { return m_fineScaleAdjustY; }
 void SetWidthAdjust( int aVal ) { m_widthAdjust = aVal; }
 int GetWidthAdjust() const { return m_widthAdjust; }

 void SetAutoScale( bool aFlag ) { m_autoScale = aFlag; }
 bool GetAutoScale() const { return m_autoScale; }

 void SetMirror( bool aFlag ) { m_mirror = aFlag; }
 bool GetMirror() const { return m_mirror; }

 void SetSketchPadsOnFabLayers( bool aFlag ) { m_sketchPadsOnFabLayers = aFlag; }
 bool GetSketchPadsOnFabLayers() const { return m_sketchPadsOnFabLayers; }
 void SetSketchPadLineWidth( int aWidth ) { m_sketchPadLineWidth = aWidth; }
 int GetSketchPadLineWidth() const { return m_sketchPadLineWidth; }

 void SetPlotInvisibleText( bool aFlag ) { m_plotInvisibleText = aFlag; }
 bool GetPlotInvisibleText() const { return m_plotInvisibleText; }
 void SetPlotValue( bool aFlag ) { m_plotValue = aFlag; }
 bool GetPlotValue() const { return m_plotValue; }
 void SetPlotReference( bool aFlag ) { m_plotReference = aFlag; }
 bool GetPlotReference() const { return m_plotReference; }

 void SetNegative( bool aFlag ) { m_negative = aFlag; }
 bool GetNegative() const { return m_negative; }

 void SetPlotViaOnMaskLayer( bool aFlag ) { m_plotViaOnMaskLayer = aFlag; }
 bool GetPlotViaOnMaskLayer() const { return m_plotViaOnMaskLayer; }

 void SetPlotFrameRef( bool aFlag ) { m_plotFrameRef = aFlag; }
 bool GetPlotFrameRef() const { return m_plotFrameRef; }

 void SetExcludeEdgeLayer( bool aFlag ) { m_excludeEdgeLayer = aFlag; }
 bool GetExcludeEdgeLayer() const { return m_excludeEdgeLayer; }

 void SetFormat( PLOT_FORMAT aFormat ) { m_format = aFormat; }
 PLOT_FORMAT GetFormat() const { return m_format; }

 void SetOutputDirectory( const wxString& aDir ) { m_outputDirectory = aDir; }
 wxString GetOutputDirectory() const { return m_outputDirectory; }

 void SetDisableGerberMacros( bool aDisable ) { m_gerberDisableApertMacros = aDisable; }
 bool GetDisableGerberMacros() const { return m_gerberDisableApertMacros; }

 void SetUseGerberX2format( bool aUse ) { m_useGerberX2format = aUse; }
 bool GetUseGerberX2format() const { return m_useGerberX2format; }

 void SetIncludeGerberNetlistInfo( bool aUse ) { m_includeGerberNetlistInfo = aUse; }
 bool GetIncludeGerberNetlistInfo() const { return m_includeGerberNetlistInfo; }

 void SetCreateGerberJobFile( bool aCreate ) { m_createGerberJobFile = aCreate; }
 bool GetCreateGerberJobFile() const { return m_createGerberJobFile; }

 void SetUseGerberProtelExtensions( bool aUse ) { m_useGerberProtelExtensions = aUse; }
 bool GetUseGerberProtelExtensions() const { return m_useGerberProtelExtensions; }

 void SetGerberPrecision( int aPrecision );
 int GetGerberPrecision() const { return m_gerberPrecision; }

 void SetSvgPrecision( unsigned aPrecision, bool aUseInch );
 unsigned GetSvgPrecision() const { return m_svgPrecision; }
 bool GetSvgUseInch() const { return m_svgUseInch; }

 static int GetGerberDefaultPrecision() { return 6; }

 void SetSubtractMaskFromSilk( bool aSubtract ) { m_subtractMaskFromSilk = aSubtract; };
 bool GetSubtractMaskFromSilk() const { return m_subtractMaskFromSilk; }

 void SetLayerSelection( LSET aSelection ) { m_layerSelection = aSelection; };
 LSET GetLayerSelection() const { return m_layerSelection; };

 void SetUseAuxOrigin( bool aAux ) { m_useAuxOrigin = aAux; };
 bool GetUseAuxOrigin() const { return m_useAuxOrigin; };

 void SetScaleSelection( int aSelection ) { m_scaleSelection = aSelection; };
 int GetScaleSelection() const { return m_scaleSelection; };

 void SetA4Output( int aForce ) { m_A4Output = aForce; };
 bool GetA4Output() const { return m_A4Output; };

 // For historical reasons, this parameter is stored in mils
 // (but is in mm in hpgl files...)
 double GetHPGLPenDiameter() const { return m_HPGLPenDiam; };
 bool SetHPGLPenDiameter( double aValue );

 // This parameter is always in cm, due to hpgl file format constraint
 int GetHPGLPenSpeed() const { return m_HPGLPenSpeed; };
 bool SetHPGLPenSpeed( int aValue );

 void SetHPGLPenNum( int aVal ) { m_HPGLPenNum = aVal; }
 int GetHPGLPenNum() const { return m_HPGLPenNum; }

private:
 friend class PCB_PLOT_PARAMS_PARSER;

 // If true, do not plot NPTH pads
 // (mainly used to disable NPTH pads plotting on copper layers)
 bool m_skipNPTH_Pads;

 OUTLINE_MODE m_plotMode;

 bool m_DXFplotPolygonMode;

 DXF_UNITS m_DXFplotUnits;

 PLOT_FORMAT m_format;

 DrillMarksType m_drillMarks;

 PLOT_TEXT_MODE m_textMode;

 bool m_autoScale;

 double m_scale;

 bool m_mirror;

 bool m_negative;

 bool m_plotViaOnMaskLayer;

 bool m_plotFrameRef;

 bool m_excludeEdgeLayer;

 LSET m_layerSelection;

 bool m_useGerberProtelExtensions;

 bool m_useGerberX2format;

 bool m_gerberDisableApertMacros;

 bool m_includeGerberNetlistInfo;

 bool m_createGerberJobFile;

 int m_gerberPrecision;

 unsigned m_svgPrecision;

 bool m_svgUseInch;

 bool m_useAuxOrigin;

 bool m_subtractMaskFromSilk;

 bool m_A4Output;

 int m_scaleSelection;

 wxString m_outputDirectory;

 bool m_plotReference;

 bool m_plotValue;

 bool m_plotInvisibleText;

 bool m_sketchPadsOnFabLayers;
 int m_sketchPadLineWidth;

 /* These next two scale factors are intended to compensate plotters
 * (mainly printers) X and Y scale error. Therefore they are expected very
 * near 1.0; only X and Y dimensions are adjusted: circles are plotted as
 * circles, even if X and Y fine scale differ; because of this it is mostly
 * useful for printers: postscript plots would be best adjusted using
 * the prologue (that would change the whole output matrix
 */

 double m_fineScaleAdjustX; 
 double m_fineScaleAdjustY; 

 int m_widthAdjust;

 int m_HPGLPenNum; 
 int m_HPGLPenSpeed; 
 double m_HPGLPenDiam; 

 COLOR_SETTINGS* m_colors;

 std::shared_ptr<COLOR_SETTINGS> m_default_colors;
};


#endif // PCB_PLOT_PARAMS_H_