base_units.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 CERN
 * Copyright (C) 1992-2019 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 _BASE_UNITS_H_
#define _BASE_UNITS_H_

#include <string>

#include <eda_units.h>
#include <convert_to_biu.h>
#include <math/vector2d.h>

//TODO: Abstract Base Units to a single class

#define INDETERMINATE_STATE _( "-- mixed values --" )
#define INDETERMINATE_ACTION _( "-- leave unchanged --" )


// PCBNew doesn't support a bold style so we want to allow text thicknesses
// that achieve the same effect
#if defined( PCBNEW )
#define ALLOW_BOLD_THICKNESS true
#else
#define ALLOW_BOLD_THICKNESS IsBold()
#endif

int Mm2mils( double x );

int Mils2mm( double x );

double To_User_Unit( EDA_UNITS aUnit, double aValue );

wxString MessageTextFromValue( EDA_UNITS aUnits, double aValue, bool aAddUnitLabel = true,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

wxString MessageTextFromValue( EDA_UNITS aUnits, int aValue, bool aAddUnitLabel = true,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

wxString MessageTextFromValue( EDA_UNITS aUnits, long long int aValue, bool aAddUnitLabel = true,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

wxString StringFromValue( EDA_UNITS aUnit, double aValue, bool aAddUnitSymbol = false,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

double From_User_Unit( EDA_UNITS aUnit, double aValue );


double DoubleValueFromString( EDA_UNITS aUnits, const wxString& aTextValue,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

long long int ValueFromString( EDA_UNITS aUnits, const wxString& aTextValue,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

void FetchUnitsFromString( const wxString& aTextValue, EDA_UNITS& aUnits );

wxString GetAbbreviatedUnitsLabel( EDA_UNITS aUnit, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

std::string FormatInternalUnits( int aValue );

std::string FormatAngle( double aAngle );

std::string FormatInternalUnits( const wxPoint& aPoint );

std::string FormatInternalUnits( const wxSize& aSize );

std::string FormatInternalUnits( const VECTOR2I& aPoint );


#endif // _BASE_UNITS_H_