KiCad PCB EDA Suite
Loading...
Searching...
No Matches
units_provider.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2022-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef UNITS_PROVIDER_H
25#define UNITS_PROVIDER_H
26
27#include <eda_units.h>
28#include <origin_transforms.h>
29#include <core/minoptmax.h>
30
31
33{
34public:
35 UNITS_PROVIDER( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits ) :
36 m_iuScale( aIuScale ),
37 m_userUnits( aUnits )
38 {}
39
41 {}
42
44 void SetUserUnits( EDA_UNITS aUnits ) { m_userUnits = aUnits; }
45
46 virtual void GetUnitPair( EDA_UNITS& aPrimaryUnit, EDA_UNITS& aSecondaryUnits )
47 {
48 aPrimaryUnit = GetUserUnits();
49 aSecondaryUnits = EDA_UNITS::MILS;
50
51 if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
52 aSecondaryUnits = EDA_UNITS::MILLIMETRES;
53 else
54 aSecondaryUnits = EDA_UNITS::MILS;
55 }
56
57 const EDA_IU_SCALE& GetIuScale() const { return m_iuScale; }
58 // No SetIuScale(); scale is invariant
59
61 {
62 static ORIGIN_TRANSFORMS identityTransform;
63
64 return identityTransform;
65 }
66
81 wxString StringFromValue( double aValue, bool aAddUnitLabel = false,
82 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
83 {
85 aAddUnitLabel, aType );
86 }
87
88 wxString StringFromValue( const EDA_ANGLE& aValue, bool aAddUnitLabel = false ) const
89 {
90 return EDA_UNIT_UTILS::UI::StringFromValue( unityScale, EDA_UNITS::DEGREES,
91 aValue.AsDegrees(), aAddUnitLabel,
92 EDA_DATA_TYPE::DISTANCE );
93 }
94
101 wxString MessageTextFromValue( double aValue, bool aAddUnitLabel = true,
102 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
103 {
105 aAddUnitLabel, aType );
106 }
107
108 wxString MessageTextFromValue( const EDA_ANGLE& aValue, bool aAddUnitLabel = true ) const
109 {
110 return EDA_UNIT_UTILS::UI::MessageTextFromValue( unityScale, EDA_UNITS::DEGREES,
111 aValue.AsDegrees(), aAddUnitLabel,
112 EDA_DATA_TYPE::DISTANCE );
113 }
114
115 wxString MessageTextFromMinOptMax( const MINOPTMAX<int>& aValue ) const
116 {
118 };
119
129 int ValueFromString( const wxString& aTextValue,
130 EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE ) const
131 {
133 aTextValue, aType );
134
135 return KiROUND<double, int>( value );
136 }
137
138 EDA_ANGLE AngleValueFromString( const wxString& aTextValue ) const
139 {
140 double angle = EDA_UNIT_UTILS::UI::DoubleValueFromString( GetIuScale(), EDA_UNITS::DEGREES,
141 aTextValue );
142
143 return EDA_ANGLE( angle, DEGREES_T );
144 }
145
146private:
149};
150
151#endif // UNITS_PROVIDER_H
constexpr EDA_IU_SCALE unityScale
Definition: base_units.h:111
double AsDegrees() const
Definition: eda_angle.h:155
A class to perform either relative or absolute display origin transforms for a single axis of a point...
wxString MessageTextFromMinOptMax(const MINOPTMAX< int > &aValue) const
wxString MessageTextFromValue(const EDA_ANGLE &aValue, bool aAddUnitLabel=true) const
EDA_UNITS m_userUnits
EDA_ANGLE AngleValueFromString(const wxString &aTextValue) const
const EDA_IU_SCALE & m_iuScale
const EDA_IU_SCALE & GetIuScale() const
virtual void GetUnitPair(EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
virtual ~UNITS_PROVIDER()
virtual ORIGIN_TRANSFORMS & GetOriginTransforms()
UNITS_PROVIDER(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits)
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
EDA_UNITS GetUserUnits() const
void SetUserUnits(EDA_UNITS aUnits)
wxString StringFromValue(double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
Converts aValue in internal units into a united string.
wxString StringFromValue(const EDA_ANGLE &aValue, bool aAddUnitLabel=false) const
int ValueFromString(const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
Converts aTextValue in aUnits to internal units used by the frame.
@ DEGREES_T
Definition: eda_angle.h:31
EDA_DATA_TYPE
The type of unit.
Definition: eda_units.h:38
EDA_UNITS
Definition: eda_units.h:46
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)
A helper to convert the double length aValue to a string in inches, millimeters, or unscaled units.
Definition: eda_units.cpp:411
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)
Returns the string from aValue according to aUnits (inch, mm ...) for display.
Definition: eda_units.cpp:300
KICOMMON_API wxString MessageTextFromMinOptMax(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, const MINOPTMAX< int > &aValue)
Definition: eda_units.cpp:501
KICOMMON_API double DoubleValueFromString(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Function DoubleValueFromString converts aTextValue to a double.
Definition: eda_units.cpp:598
KICOMMON_API bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:47