gerber_to_png.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2025 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef GERBER_TO_PNG_H
#define GERBER_TO_PNG_H
 
#include <wx/string.h>
#include <wx/arrstr.h>
#include <gal/color4d.h>
#include <math/box2.h>
#include <math/vector2d.h>
#include <memory>
 
class GERBER_FILE_IMAGE;
class JOB_GERBER_EXPORT_PNG;
 

bool IsExcellonFile( const wxString& aPath );
 

BOX2I CalculateGerberBoundingBox( GERBER_FILE_IMAGE* aImage );
 

std::unique_ptr<GERBER_FILE_IMAGE> LoadGerberOrExcellon( const wxString& aPath, wxString* aErrorMsg,
                                                         wxArrayString* aMessages = nullptr );
 

struct GERBER_RENDER_OPTIONS
{
    int            dpi = 300;
    int            width = 0;  
    int            height = 0; 
    bool           antialias = true;
    KIGFX::COLOR4D foregroundColor = KIGFX::COLOR4D::BLACK;
    KIGFX::COLOR4D backgroundColor = KIGFX::COLOR4D( 1.0, 1.0, 1.0, 0.0 ); 
 
    double originXMm = 0.0;        
    double originYMm = 0.0;        
    double windowWidthMm = 0.0;    
    double windowHeightMm = 0.0;   
 
    bool HasViewportOverride() const
    {
        return windowWidthMm > 0.0 && windowHeightMm > 0.0;
    }
};
 

struct GERBER_PLOTTER_VIEWPORT
{
    int      width;
    int      height;
    double   plotScale;
    double   iuPerDecimil;
    VECTOR2I offset;
};
 
static constexpr int MIN_PIXEL_SIZE = 10;

GERBER_PLOTTER_VIEWPORT CalculatePlotterViewport( const BOX2I& aBBox, int aDpi, int aWidth, int aHeight );
 

bool RenderGerberToPng( const wxString& aInputPath, const wxString& aOutputPath, const GERBER_RENDER_OPTIONS& aOptions,
                        wxString* aErrorMsg = nullptr, wxArrayString* aMessages = nullptr );
 

bool RenderGerberToPng( const wxString& aInputPath, const wxString& aOutputPath, const JOB_GERBER_EXPORT_PNG& aJob,
                        wxString* aErrorMsg = nullptr, wxArrayString* aMessages = nullptr );
 
 
#endif // GERBER_TO_PNG_H