page_info.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2007-2013 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2008-2013 Wayne Stambaugh <[email protected]>
 * 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/>.
 */
 
#pragma once
 
#include <map>
#include <kicommon.h>
#include <wx/string.h>
#include <math/vector2d.h>

#define MIN_PAGE_SIZE_MILS          1000
#define MAX_PAGE_SIZE_PCBNEW_MILS   48000
#define MAX_PAGE_SIZE_EESCHEMA_MILS 120000

#define MIN_PAGE_SIZE_MM            25.4
#define MAX_PAGE_SIZE_PCBNEW_MM     48000*.0254
#define MAX_PAGE_SIZE_EESCHEMA_MM   120000*.0254
 
class OUTPUTFORMATTER;
 
/*
 * @brief Standard paper sizes nicknames
 * Do not rename entires as these names are saved to file and parsed back
 */
enum class PAGE_SIZE_TYPE
{
    A5,
    A4,
    A3,
    A2,
    A1,
    A0,
    A,
    B,
    C,
    D,
    E,
    GERBER,
    USLetter,
    USLegal,
    USLedger,
    User
};

class KICOMMON_API PAGE_INFO
{
public:
    PAGE_INFO( PAGE_SIZE_TYPE aType = PAGE_SIZE_TYPE::A3, bool IsPortrait = false );
 
    // paper size names which are part of the public API, pass to SetType() or
    // above constructor.
 

    bool                  SetType( PAGE_SIZE_TYPE aPageSize, bool aIsPortrait = false );
    bool                  SetType( const wxString& aPageSize, bool aIsPortrait = false );
    const PAGE_SIZE_TYPE& GetType() const { return m_type; }
    wxString       GetTypeAsString() const;
 
    const wxString& GetPageFormatDescription() const { return m_description;  }

    bool IsDefault() const { return m_type == PAGE_SIZE_TYPE::A3 && !m_portrait; }

    bool IsCustom() const;

    void SetPortrait( bool aIsPortrait );
    bool IsPortrait() const { return m_portrait; }

    wxPrintOrientation  GetWxOrientation() const { return IsPortrait() ? wxPORTRAIT : wxLANDSCAPE; }

    wxPaperSize GetPaperId() const { return m_paper_id; }
 
    void SetWidthMM(  double aWidthInMM ) { SetWidthMils( aWidthInMM * 1000 / 25.4 ); }
    void SetWidthMils(  double aWidthInMils );
    double GetWidthMils() const { return m_size.x; }
    double GetWidthMM() const { return m_size.x * 25.4 / 1000; }
 
    void SetHeightMM( double aHeightInMM ) { SetHeightMils( aHeightInMM * 1000 / 25.4 ); }
    void SetHeightMils( double aHeightInMils );
    double GetHeightMils() const { return m_size.y; }
    double GetHeightMM() const { return m_size.y * 25.4 / 1000; }
 
    const VECTOR2D& GetSizeMils() const { return m_size; }

    int GetWidthIU( double aIUScale ) const { return aIUScale * GetWidthMils(); }

    int GetHeightIU( double aIUScale ) const { return aIUScale * GetHeightMils(); }

    const VECTOR2D GetSizeIU( double aIUScale ) const
    {
        return VECTOR2D( GetWidthIU( aIUScale ), GetHeightIU( aIUScale ) );
    }

    static void SetCustomWidthMils( double aWidthInMils );

    static void SetCustomHeightMils( double aHeightInMils );

    static double GetCustomWidthMils() { return s_user_width; }

    static double GetCustomHeightMils() { return s_user_height; }

    void Format( OUTPUTFORMATTER* aFormatter ) const;
 
    static const std::vector<PAGE_INFO>& GetPageFormatsList();
 
protected:
    // only the class implementation(s) may use this constructor
    PAGE_INFO( const VECTOR2D& aSizeMils, const PAGE_SIZE_TYPE& aType, wxPaperSize aPaperId,
               const wxString& aDescription = wxEmptyString );
 
    void    updatePortrait();
 
private:
    static std::vector<PAGE_INFO> standardPageSizes;
 
    // all dimensions here are in mils
 
    PAGE_SIZE_TYPE m_type;             
    VECTOR2D       m_size;             
 
    bool           m_portrait;         
 
    wxPaperSize    m_paper_id;         
    wxString       m_description;      
 
    static double s_user_height;
    static double s_user_width;
};