ds_data_model.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * 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 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef  DS_DATA_MODEL_H
#define  DS_DATA_MODEL_H
 
#include <math/vector2d.h>
#include <eda_text.h>
#include <bitmap_base.h>
 
class DS_DATA_ITEM;
class PAGE_INFO;

class DS_DATA_MODEL
{
public:
    DS_DATA_MODEL();
 
    ~DS_DATA_MODEL()
    {
        ClearList();
    }

    static DS_DATA_MODEL& GetTheInstance();

    static void SetAltInstance( DS_DATA_MODEL* aLayout = nullptr );
 
    int GetFileFormatVersionAtLoad() { return m_fileFormatVersionAtLoad; }
    void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
 
    const wxString& GetGenerator() const { return m_generator; }
    void SetGenerator( const wxString& aGenerator ) { m_generator = aGenerator; }
 
    double GetLeftMargin() { return m_leftMargin; }
    void SetLeftMargin( double aMargin ) { m_leftMargin = aMargin; }
 
    double GetRightMargin() { return m_rightMargin; }
    void SetRightMargin( double aMargin ) { m_rightMargin = aMargin; }
 
    double GetTopMargin() { return m_topMargin; }
    void SetTopMargin( double aMargin ) { m_topMargin = aMargin; }
 
    double GetBottomMargin() { return m_bottomMargin; }
    void SetBottomMargin( double aMargin ) { m_bottomMargin = aMargin; }
 
    void SetupDrawEnvironment( const PAGE_INFO& aPageInfo, double aMilsToIU );

    void AllowVoidList( bool Allow ) { m_allowVoidList = Allow; }

    bool VoidListAllowed() { return m_allowVoidList; }

    void ClearList();

    void Save( const wxString& aFullFileName );

    void SaveInString( wxString* aOutputString );

    void SaveInString( std::vector<DS_DATA_ITEM*>& aItemsList, wxString* aOutputString );
 
    void Append( DS_DATA_ITEM* aItem );
    void Remove( DS_DATA_ITEM* aItem );

    DS_DATA_ITEM* GetItem( unsigned aIdx ) const;

    std::vector<DS_DATA_ITEM*>& GetItems() { return m_list; }

    unsigned GetCount() const { return m_list.size(); }
 
    void SetDefaultLayout();
    void SetEmptyLayout();

    static wxString EmptyLayout();

    static wxString DefaultLayout();

    bool LoadDrawingSheet( const wxString& aFullFileName, wxString* aMsg, bool aAppend = false );

    void SetPageLayout( const char* aPageLayout, bool aAppend = false,
                        const wxString& aSource = wxT( "Sexpr_string" )  );

    static const wxString ResolvePath( const wxString& aPath, const wxString& aProjectPath );
 
    double   m_WSunits2Iu;            // conversion factor between
                                      // ws units (mils) and draw/plot units
    VECTOR2D m_RB_Corner;             // coordinates of the right bottom corner (in mm)
    VECTOR2D m_LT_Corner;             // coordinates of the left top corner (in mm)
    double   m_DefaultLineWidth;      // Used when object line width is 0
    VECTOR2D m_DefaultTextSize;       // Used when object text size is 0
    double   m_DefaultTextThickness;  // Used when object text stroke width is 0
    bool     m_EditMode;              // Used in drawing sheet editor to toggle variable substitution
                                      // In normal mode (m_EditMode = false) the %format is
                                      // replaced by the corresponding text.
                                      // In edit mode (m_EditMode = true) the %format is
                                      // displayed "as this"
 
private:
    std::vector <DS_DATA_ITEM*> m_list;
    bool     m_allowVoidList;         // If false, the default drawing sheet will be loaded the
                                      // first time DS_DRAW_ITEM_LIST::BuildDrawItemsList is run
                                      // (useful mainly for drawing sheet editor)
    int      m_fileFormatVersionAtLoad;
    wxString m_generator;             // Tool name written in the generator field
    double   m_leftMargin;            // the left page margin in mm
    double   m_rightMargin;           // the right page margin in mm
    double   m_topMargin;             // the top page margin in mm
    double   m_bottomMargin;          // the bottom page margin in mm
};
 
#endif      // DS_DATA_MODEL_H