units_provider.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022-2023 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 UNITS_PROVIDER_H
#define UNITS_PROVIDER_H
 
#include <eda_units.h>
#include <origin_transforms.h>
#include <core/minoptmax.h>
#include <optional>
#include <utility>
 
 
class UNITS_PROVIDER
{
public:
 UNITS_PROVIDER( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits ) :
 m_iuScale( aIuScale ),
 m_userUnits( aUnits )
 {}
 
 virtual ~UNITS_PROVIDER()
 {}
 
 EDA_UNITS GetUserUnits() const { return m_userUnits; }
 void SetUserUnits( EDA_UNITS aUnits ) { m_userUnits = aUnits; }
 
 virtual void GetUnitPair( EDA_UNITS& aPrimaryUnit, EDA_UNITS& aSecondaryUnits )
 {
 aPrimaryUnit = GetUserUnits();
 aSecondaryUnits = EDA_UNITS::MILS;
 
 if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
 aSecondaryUnits = EDA_UNITS::MILLIMETRES;
 else
 aSecondaryUnits = EDA_UNITS::MILS;
 }
 
 const EDA_IU_SCALE& GetIuScale() const { return m_iuScale; }
 // No SetIuScale(); scale is invariant
 
 virtual ORIGIN_TRANSFORMS& GetOriginTransforms()
 {
 static ORIGIN_TRANSFORMS identityTransform;
 
 return identityTransform;
 }
 
 wxString StringFromValue( double aValue, bool aAddUnitLabel = false,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
 {
 return EDA_UNIT_UTILS::UI::StringFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }
 
 wxString StringFromOptionalValue( std::optional<int> aValue, bool aAddUnitLabel = false,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
 {
 if( !aValue )
 return NullUiString;
 else
 return EDA_UNIT_UTILS::UI::StringFromValue( GetIuScale(), GetUserUnits(),
 aValue.value(), aAddUnitLabel, aType );
 }
 
 wxString StringFromValue( const EDA_ANGLE& aValue, bool aAddUnitLabel = false ) const
 {
 return EDA_UNIT_UTILS::UI::StringFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }
 
 wxString MessageTextFromValue( double aValue, bool aAddUnitLabel = true,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( GetIuScale(), GetUserUnits(), aValue,
 aAddUnitLabel, aType );
 }
 
 wxString MessageTextFromValue( const EDA_ANGLE& aValue, bool aAddUnitLabel = true ) const
 {
 return EDA_UNIT_UTILS::UI::MessageTextFromValue( unityScale, EDA_UNITS::DEGREES,
 aValue.AsDegrees(), aAddUnitLabel,
 EDA_DATA_TYPE::DISTANCE );
 }
 
 wxString MessageTextFromMinOptMax( const MINOPTMAX<int>& aValue ) const
 {
 return EDA_UNIT_UTILS::UI::MessageTextFromMinOptMax( GetIuScale(), GetUserUnits(), aValue );
 };
 
 int ValueFromString( const wxString& aTextValue,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
 {
 double value = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), GetUserUnits(),
 aTextValue, aType );
 
 return KiROUND<double, int>( value );
 }
 
 std::optional<int>
 OptionalValueFromString( const wxString& aTextValue,
 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
 {
 // Handle null (empty) values
 if( aTextValue == NullUiString )
 return {};
 
 double value = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), GetUserUnits(),
 aTextValue, aType );
 
 return KiROUND<double, int>( value );
 }
 
 EDA_ANGLE AngleValueFromString( const wxString& aTextValue ) const
 {
 double angle = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), EDA_UNITS::DEGREES,
 aTextValue );
 
 return EDA_ANGLE( angle, DEGREES_T );
 }
 
 static inline const wxString NullUiString = "";
 
private:
 const EDA_IU_SCALE& m_iuScale;
 EDA_UNITS m_userUnits;
};
 
#endif // UNITS_PROVIDER_H