diff_renderer_plotter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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, you may find one here:
 * http://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef KICAD_DIFF_RENDERER_PLOTTER_H
#define KICAD_DIFF_RENDERER_PLOTTER_H
 
#include <kicommon.h>
 
#include <diff_merge/diff_scene.h>
 
#include <wx/string.h>
 
 
namespace KICAD_DIFF
{

struct PLOTTER_RENDER_OPTIONS
{
    int  dpi        = 300;
    int  pixelWidth = 0;   // 0 = auto from bbox + dpi
    int  pixelHeight = 0;
    bool antialias  = true;
    DIFF_COLOR_THEME theme;
};
 

bool RenderSceneToPng( const DIFF_SCENE&             aScene,
                                    const wxString&               aOutputPath,
                                    const PLOTTER_RENDER_OPTIONS& aOptions );
 

bool RenderSceneToSvg( const DIFF_SCENE&             aScene,
                                    const wxString&               aOutputPath,
                                    const PLOTTER_RENDER_OPTIONS& aOptions );
 

constexpr int PLOT_HAIRLINE_IU = 10;
 

constexpr int EffectivePlotWidth( int aWidth )
{
    return aWidth > 0 ? aWidth : PLOT_HAIRLINE_IU;
}
 
} // namespace KICAD_DIFF
 
#endif // KICAD_DIFF_RENDERER_PLOTTER_H