plotcontroller.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 Lorenzo Marcantonio, <[email protected]>
 * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * 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 PLOTCONTROLLER_H_
#define PLOTCONTROLLER_H_
 
#include <pcb_plot_params.h>
#include <layer_ids.h>
 
class PLOTTER;
class BOARD;
class LSEQ;
 
 
class PLOT_CONTROLLER
{
public:
    PLOT_CONTROLLER( BOARD *aBoard );
 
    ~PLOT_CONTROLLER();
 
    PCB_PLOT_PARAMS& GetPlotOptions() { return m_plotOptions; }
 
    void SetLayer( int aLayer ) { m_plotLayer = aLayer; }
    int GetLayer() { return m_plotLayer; }
 
 
    bool IsPlotOpen() const { return m_plotter != nullptr; }
 
    void ClosePlot();
 
    bool OpenPlotfile( const wxString& aSuffix, PLOT_FORMAT aFormat,
                       const wxString& aSheetName = wxEmptyString,
                       const wxString& aSheetPath = wxEmptyString );
 
    bool PlotLayer();
 
    bool PlotLayers( const LSEQ& aLayerSequence );
 
    const wxString GetPlotFileName() { return m_plotFile.GetFullPath(); }
 
    const wxString GetPlotDirName() { return m_plotFile.GetPathWithSep(); }
 
    void SetColorMode( bool aColorMode );
 
    bool GetColorMode();
 
    PLOTTER* GetPlotter() { return m_plotter; }
 
private:
    int             m_plotLayer;
    PCB_PLOT_PARAMS m_plotOptions;
 
    // requested
    PLOTTER*        m_plotter;
 
    BOARD*          m_board;
    wxFileName      m_plotFile;
};
 
#endif