/* * 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 */ /** * @author Wayne Stambaugh * @file base_units.h * @brief Implementation of conversion functions that require both schematic and board * internal units. */ #ifndef _BASE_UNITS_H_ #define _BASE_UNITS_H_ #include #include #include #include #include //TODO: Abstract Base Units to a single class /** * Used for holding indeterminate values, such as with multiple selections * holding different values or controls which do not wish to set a value. */ #define INDETERMINATE_STATE _( "-- mixed values --" ) #define INDETERMINATE_ACTION _( "-- leave unchanged --" ) /** * Function To_User_Unit * convert \a aValue in internal units to the appropriate user units defined by \a aUnit. * * @return The converted value, in double * @param aUnit The units to convert \a aValue to. * @param aValue The value in internal units to convert. */ double To_User_Unit( EDA_UNITS aUnit, double aValue ); /** * Function MessageTextFromValue * is a helper to convert the \a double length \a aValue to a string in inches, * millimeters, or unscaled units. * * Should be used only to display a coordinate in status, but not in dialogs, * files, etc., because the mantissa of the number displayed has 4 digits max * for readability. The actual internal value could need up to 8 digits to be * printed. * * Use StringFromValue() instead where precision matters. * * @param aUnits The units to show the value in. The unit string is added to the * message text. * @param aValue The double value to convert. * @param aAddUnitLabel If true, adds the unit label to the end of the string * @param aType Type of the unit being used (e.g. distance, area, etc.) * @return The converted string for display in user interface elements. */ 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 MessageTextFromValue( EDA_ANGLE aValue, bool aAddUnitLabel = true ); /** * Function StringFromValue * returns the string from \a aValue according to units (inch, mm ...) for display, * and the initial unit for value. * * For readability, the mantissa has 3 or more digits (max 8 digits), * the trailing 0 are removed if the mantissa has more than 3 digits * and some trailing 0 * This function should be used to display values in dialogs because a value * entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa * if displayed in inch to avoid truncation or rounding made just by the printf function. * otherwise the actual value is rounded when read from dialog and converted * in internal units, and therefore modified. * * @param aUnit = display units (INCHES, MILLIMETRE ..) * @param aValue = value in Internal_Unit * @param aAddUnitSymbol = true to add symbol unit to the string value * @return A wxString object containing value and optionally the symbol unit (like 2.000 mm) */ wxString StringFromValue( EDA_UNITS aUnit, double aValue, bool aAddUnitSymbol = false, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ); /** * Return in internal units the value "val" given in a real unit * such as "in", "mm" or "deg" */ double From_User_Unit( EDA_UNITS aUnit, double aValue ); /** * Function DoubleValueFromString * converts \a aTextValue to a double * @warning This utilizes the current locale and will break if decimal formats differ * * @param aUnits The units of \a aTextValue. * @param aTextValue A reference to a wxString object containing the string to convert. * @return A double representing that value in internal units */ double DoubleValueFromString( EDA_UNITS aUnits, const wxString& aTextValue, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ); /** * Function ValueFromString * converts \a aTextValue in \a aUnits to internal units used by the application. * @warning This utilizes the current locale and will break if decimal formats differ * * @param aUnits The units of \a aTextValue. * @param aTextValue A reference to a wxString object containing the string to convert. * @return The string from Value, according to units (inch, mm ...) for display, */ long long int ValueFromString( EDA_UNITS aUnits, const wxString& aTextValue, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ); /** * Function FormatInternalUnits * converts \a aValue from internal units to a string appropriate for writing * to file. * * @note Internal units for board items can be either deci-mils or nanometers depending * on how KiCad is built. * * @param aValue A coordinate value to convert. * @return A std::string object containing the converted value. */ std::string FormatInternalUnits( int aValue ); std::string FormatInternalUnits( const wxPoint& aPoint ); std::string FormatInternalUnits( const wxSize& aSize ); std::string FormatInternalUnits( const VECTOR2I& aPoint ); #endif // _BASE_UNITS_H_