pcbplot.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2023 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
 */
 
#ifndef PCBPLOT_H_
#define PCBPLOT_H_
 
#include <lset.h>
#include <padstack.h>         // for PAD_DRILL_SHAPE
#include <pcb_plot_params.h>
#include <settings/color_settings.h>
#include <settings/settings_manager.h>
#include <board.h>
#include <board_design_settings.h>
#include <board_item.h>
 
class EDA_TEXT;
class PLOTTER;
class PCB_TEXT;
class PAD;
class PCB_SHAPE;
class PCB_TABLE;
class PCB_DIMENSION_BASE;
class FOOTPRINT;
class PCB_TARGET;
class ZONE;
class REPORTER;
class wxFileName;
 
namespace KIFONT
{
class FONT;
class METRICS;
}
 
 
// Define min and max reasonable values for plot/print scale
#define PLOT_MIN_SCALE 0.01
#define PLOT_MAX_SCALE 100.0
 
 
 
// A helper class to plot board items
class BRDITEMS_PLOTTER : public PCB_PLOT_PARAMS
{
public:
    BRDITEMS_PLOTTER( PLOTTER* aPlotter, BOARD* aBoard, const PCB_PLOT_PARAMS& aPlotOpts ) :
            PCB_PLOT_PARAMS( aPlotOpts ),
            m_plotter( aPlotter ),
            m_board( aBoard )
    { }
 
    int getFineWidthAdj() const
    {
        if( GetFormat() == PLOT_FORMAT::POST )
            return GetWidthAdjust();
        else
            return 0;
    }
 
    // Basic functions to plot a board item
    void SetLayerSet( LSET aLayerMask ) { m_layerMask = aLayerMask; }
    void PlotFootprintGraphicItems( const FOOTPRINT* aFootprint );
    void PlotFootprintTextItems( const FOOTPRINT* aFootprint );
 
    void PlotDimension( const PCB_DIMENSION_BASE* aDim );
    void PlotPcbTarget( const PCB_TARGET* aMire );
    void PlotZone( const ZONE* aZone, PCB_LAYER_ID aLayer, const SHAPE_POLY_SET& aPolysList );
    void PlotText( const EDA_TEXT* aText, PCB_LAYER_ID aLayer, bool aIsKnockout,
                   const KIFONT::METRICS& aFontMetrics, bool aStrikeout = false );
    void PlotShape( const PCB_SHAPE* aShape );
    void PlotTableBorders( const PCB_TABLE* aTable );
 
    void PlotPad( const PAD* aPad, PCB_LAYER_ID aLayer, const COLOR4D& aColor,
                  OUTLINE_MODE aPlotMode );
 
    void PlotPadNumber( const PAD* aPad, const COLOR4D& aColor );
 
    void PlotBoardGraphicItem( const BOARD_ITEM* item );
 
    void PlotDrillMarks();
 
    COLOR4D getColor( int aLayer ) const;
 
private:
    bool hideDNPItems( PCB_LAYER_ID aLayer )
    {
        return GetHideDNPFPsOnFabLayers() && ( aLayer == F_Fab || aLayer == B_Fab );
    }
 
    bool crossoutDNPItems( PCB_LAYER_ID aLayer )
    {
        return GetCrossoutDNPFPsOnFabLayers() && ( aLayer == F_Fab || aLayer == B_Fab );
    }
 
    void plotOneDrillMark( PAD_DRILL_SHAPE aDrillShape, const VECTOR2I& aDrillPos,
                           const VECTOR2I& aDrillSize, const VECTOR2I& aPadSize,
                           const EDA_ANGLE& aOrientation, int aSmallDrill );
 
    PLOTTER*  m_plotter;
    BOARD*    m_board;
    LSET      m_layerMask;
};
 
 
PLOTTER* StartPlotBoard( BOARD* aBoard, const PCB_PLOT_PARAMS* aPlotOpts, int aLayer,
                         const wxString& aLayerName, const wxString& aFullFileName,
                         const wxString& aSheetName, const wxString& aSheetPath );
 
void PlotBoardLayers( BOARD* aBoard, PLOTTER* aPlotter, const LSEQ& aLayerSequence,
                      const PCB_PLOT_PARAMS& aPlotOptions );
 
void PlotInteractiveLayer( BOARD* aBoard, PLOTTER* aPlotter, const PCB_PLOT_PARAMS& aPlotOpt );
 
void PlotOneBoardLayer( BOARD* aBoard, PLOTTER* aPlotter, PCB_LAYER_ID aLayer,
                        const PCB_PLOT_PARAMS& aPlotOpt );
 
void PlotStandardLayer( BOARD* aBoard, PLOTTER* aPlotter, LSET aLayerMask,
                        const PCB_PLOT_PARAMS& aPlotOpt );
 
void PlotLayerOutlines( BOARD* aBoard, PLOTTER* aPlotter, LSET aLayerMask,
                        const PCB_PLOT_PARAMS& aPlotOpt );
 
void BuildPlotFileName( wxFileName* aFilename, const wxString& aOutputDir, const wxString& aSuffix,
                        const wxString& aExtension );
 
 
const wxString GetGerberProtelExtension( int aLayer );
 
const wxString GetGerberFileFunctionAttribute( const BOARD* aBoard, int aLayer );
 
void AddGerberX2Header( PLOTTER* aPlotter, const BOARD* aBoard,
                        bool aUseX1CompatibilityMode = false );
 
void AddGerberX2Attribute( PLOTTER* aPlotter, const BOARD* aBoard, int aLayer,
                           bool aUseX1CompatibilityMode );
 
#endif // PCBPLOT_H_