gerber_diff.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_DIFF_H
#define GERBER_DIFF_H
 
#include <geometry/shape_poly_set.h>
#include <math/vector2d.h>
#include <gal/color4d.h>
#include <nlohmann/json_fwd.hpp>
#include <wx/string.h>
 

struct GERBER_DIFF_RESULT
{
    SHAPE_POLY_SET overlap;   
    SHAPE_POLY_SET additions; 
    SHAPE_POLY_SET removals;  
 
    double referenceArea;  
    double comparisonArea; 
    double overlapArea;    
    double additionsArea;  
    double removalsArea;   
 
    double additionsPercent; 
    double removalsPercent;  
    double netChangePercent; 
 
    GERBER_DIFF_RESULT() :
            referenceArea( 0.0 ),
            comparisonArea( 0.0 ),
            overlapArea( 0.0 ),
            additionsArea( 0.0 ),
            removalsArea( 0.0 ),
            additionsPercent( 0.0 ),
            removalsPercent( 0.0 ),
            netChangePercent( 0.0 )
    {
    }
};
 

VECTOR2I CalculateAlignment( const SHAPE_POLY_SET& aReference, const SHAPE_POLY_SET& aComparison );
 

GERBER_DIFF_RESULT CalculateGerberDiff( const SHAPE_POLY_SET& aReference, const SHAPE_POLY_SET& aComparison );
 

enum class DIFF_UNITS
{
    MM,
    INCH,
    MILS
};
 

wxString FormatDiffResultText( const GERBER_DIFF_RESULT& aResult, const wxString& aFile1, const wxString& aFile2,
                               DIFF_UNITS aUnits = DIFF_UNITS::MM );
 

nlohmann::json FormatDiffResultJson( const GERBER_DIFF_RESULT& aResult, const wxString& aFile1, const wxString& aFile2,
                                     DIFF_UNITS aUnits = DIFF_UNITS::MM, double aMaxDiffPercent = 0.0 );
 

struct DIFF_RENDER_OPTIONS
{
    int  dpi = 300;
    int  width = 0;  
    int  height = 0; 
    bool antialias = true;
 
    KIGFX::COLOR4D colorOverlap = KIGFX::COLOR4D( 0.5, 0.5, 0.5, 1.0 );    
    KIGFX::COLOR4D colorAdditions = KIGFX::COLOR4D( 0.0, 1.0, 0.0, 1.0 );  
    KIGFX::COLOR4D colorRemovals = KIGFX::COLOR4D( 1.0, 0.0, 0.0, 1.0 );   
    KIGFX::COLOR4D colorBackground = KIGFX::COLOR4D( 1.0, 1.0, 1.0, 1.0 ); 
};
 

bool RenderDiffToPng( const GERBER_DIFF_RESULT& aResult, const wxString& aOutputPath,
                      const DIFF_RENDER_OPTIONS& aOptions );
 
 
#endif // GERBER_DIFF_H