eda_units.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 EDA_UNITS_H
#define EDA_UNITS_H
 
#include <kicommon.h>
#include <wx/string.h>
#include <geometry/eda_angle.h>
#include <base_units.h>
#include <core/minoptmax.h>

enum class EDA_DATA_TYPE
{
    DISTANCE     = 0,
    AREA         = 1,
    VOLUME       = 2,
    UNITLESS     = 3,
    TIME         = 4,
    LENGTH_DELAY = 5
};
 
enum class EDA_UNITS
{
    INCH              = 0,       // Do not use IN: it conflicts with a Windows header
    MM                = 1,
    UNSCALED          = 2,
    DEGREES           = 3,
    PERCENT           = 4,
    MILS              = 5,
    UM                = 6,
    CM                = 7,
    FS                = 8,   // Femtoseconds
    PS                = 9,   // Picoseconds
    PS_PER_INCH       = 10,
    PS_PER_CM         = 11,
    PS_PER_MM         = 12
};
 
namespace EDA_UNIT_UTILS
{
    KICOMMON_API bool IsImperialUnit( EDA_UNITS aUnit );
 
    KICOMMON_API bool IsMetricUnit( EDA_UNITS aUnit );

    KICOMMON_API int Mm2mils( double aVal );

    KICOMMON_API int Mils2mm( double aVal );

    KICOMMON_API bool FetchUnitsFromString( const wxString& aTextValue, EDA_UNITS& aUnits );

    KICOMMON_API wxString GetText( EDA_UNITS aUnits,
                                   EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

    KICOMMON_API wxString GetLabel( EDA_UNITS     aUnits,
                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

    KICOMMON_API std::string FormatAngle( const EDA_ANGLE& aAngle );

    KICOMMON_API std::string FormatInternalUnits( const EDA_IU_SCALE& aIuScale, int aValue,
                                                  EDA_DATA_TYPE aDataType = EDA_DATA_TYPE::DISTANCE );
    KICOMMON_API std::string FormatInternalUnits( const EDA_IU_SCALE& aIuScale,
                                                  const VECTOR2I&     aPoint );

    KICOMMON_API double GetScaleForInternalUnitType( const EDA_IU_SCALE& aIuScale, EDA_DATA_TYPE aDataType );
 
#if 0 // No support for std::from_chars on MacOS yet
    KICOMMON_API bool ParseInternalUnits( const std::string& aInput, const EDA_IU_SCALE& aIuScale,
                                          int& aOut );

    KICOMMON_API bool ParseInternalUnits( const std::string& aInput, const EDA_IU_SCALE& aIuScale,
                                          VECTOR2I& aOut );
#endif
 
    constexpr inline int Mils2IU( const EDA_IU_SCALE& aIuScale, int mils )
    {
        double x = mils * aIuScale.IU_PER_MILS;
        return int( x < 0 ? x - 0.5 : x + 0.5 );
    }
 
    namespace UI
    {
        KICOMMON_API double ToUserUnit( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnit,
                                        double aValue );

        KICOMMON_API wxString StringFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                               double aValue,
                                               bool aAddUnitsText = false,
                                               EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

        KICOMMON_API wxString MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                    double aValue, bool aAddUnitsText = true,
                                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );
 
        KICOMMON_API wxString MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                    int aValue, bool aAddUnitLabel = true,
                                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );
 
        KICOMMON_API wxString MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                    long long int aValue, bool aAddUnitLabel = true,
                                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );
 
        KICOMMON_API wxString MessageTextFromValue( EDA_ANGLE aValue, bool aAddUnitLabel = true );
 
 
        KICOMMON_API wxString MessageTextFromMinOptMax( const EDA_IU_SCALE& aIuScale,
                                                        EDA_UNITS aUnits,
                                                        const MINOPTMAX<int>& aValue );
        KICOMMON_API double FromUserUnit( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnit,
                                          double aValue );
 

        KICOMMON_API double DoubleValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                   const wxString& aTextValue,
                                                   EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );
 
        KICOMMON_API double DoubleValueFromString( const wxString& aTextValue );
 
        KICOMMON_API bool DoubleValueFromString( const EDA_IU_SCALE& aIuScale, const wxString& aTextValue,
                                                 double& aDoubleValue );

        KICOMMON_API long long int ValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                    const wxString& aTextValue,
                                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );
 
        KICOMMON_API long long int ValueFromString( const wxString& aTextValue );
    }
}
 
#endif