EDA_UNIT_UTILS Namespace Reference

Namespaces
namespace	UI

Functions
bool	IsImperialUnit (EDA_UNITS aUnit)
bool	IsMetricUnit (EDA_UNITS aUnit)
int	Mm2mils (double aVal)
	Convert mm to mils. More...
int	Mils2mm (double aVal)
	Convert mils to mm. More...
bool	FetchUnitsFromString (const wxString &aTextValue, EDA_UNITS &aUnits)
	Writes any unit info found in the string to aUnits. More...
wxString	GetText (EDA_UNITS aUnits, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Get the units string for a given units type. More...
wxString	GetLabel (EDA_UNITS aUnits, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Get the units string for a given units type. More...
std::string	FormatAngle (const EDA_ANGLE &aAngle)
	Converts aAngle from board units to a string appropriate for writing to file. More...
std::string	FormatInternalUnits (const EDA_IU_SCALE &aIuScale, int aValue)
	Converts aValue from internal units to a string appropriate for writing to file. More...
std::string	FormatInternalUnits (const EDA_IU_SCALE &aIuScale, const VECTOR2I &aPoint)
constexpr int	Mils2IU (const EDA_IU_SCALE &aIuScale, int mils)

Function Documentation

FetchUnitsFromString()

bool EDA_UNIT_UTILS::FetchUnitsFromString	(	const wxString &	aTextValue,
		EDA_UNITS &	aUnits
	)

Writes any unit info found in the string to aUnits.

Returns

true - when unit was found, false - when unit could not be determined

Definition at line 68 of file eda_units.cpp.

{
 wxString buf( aTextValue.Strip( wxString::both ) );
 unsigned brk_point = 0;
 
 while( brk_point < buf.Len() )
 {
 wxChar c = buf[brk_point];
 
 if( !( ( c >= '0' && c <= '9' ) || ( c == '.' ) || ( c == ',' ) || ( c == '-' )
 || ( c == '+' ) ) )
 break;
 
 ++brk_point;
 }
 
 // Check the unit designator (2 ch significant)
 wxString unit( buf.Mid( brk_point ).Strip( wxString::leading ).Left( 2 ).Lower() );
 
 if( unit == wxT( "mm" ) )
 aUnits = EDA_UNITS::MILLIMETRES;
 else if( unit == wxT( "mi" ) || unit == wxT( "th" ) ) // "mils" or "thou"
 aUnits = EDA_UNITS::MILS;
 else if( unit == wxT( "in" ) || unit == wxT( "\"" ) )
 aUnits = EDA_UNITS::INCHES;
 else if( unit == wxT( "de" ) || unit == wxT( "ra" ) ) // "deg" or "rad"
 aUnits = EDA_UNITS::DEGREES;
 else
 return false;
 return true;
}

References DEGREES, INCHES, MILLIMETRES, and MILS.

Referenced by PCB_PARSER::parseDIMENSION().

FormatAngle()

std::string EDA_UNIT_UTILS::FormatAngle

(

const EDA_ANGLE &

aAngle

)

Converts aAngle from board units to a string appropriate for writing to file.

This should only be used for writing to files as it ignores locale

Note

Internal angles for board items can be either degrees or tenths of degree on how KiCad is built.

Parameters

aAngle

A angle value to convert.

Returns

std::string object containing the converted angle.

Definition at line 134 of file eda_units.cpp.

{
 std::string temp = fmt::format( "{:.10g}", aAngle.AsDegrees() );
 
 return temp;
}

References EDA_ANGLE::AsDegrees().

Referenced by DIALOG_PAD_PROPERTIES::displayPrimitivesList(), PCB_PLUGIN::format(), PCB_PLUGIN::formatRenderCache(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), and SCH_SEXPR_PLUGIN::saveTextBox().

FormatInternalUnits() [1/2]

std::string EDA_UNIT_UTILS::FormatInternalUnits	(	const EDA_IU_SCALE &	aIuScale,
		const VECTOR2I &	aPoint
	)

Definition at line 175 of file eda_units.cpp.

{
 return FormatInternalUnits( aIuScale, aPoint.x ) + " "
 + FormatInternalUnits( aIuScale, aPoint.y );
}

References FormatInternalUnits(), VECTOR2< T >::x, and VECTOR2< T >::y.

FormatInternalUnits() [2/2]

std::string EDA_UNIT_UTILS::FormatInternalUnits	(	const EDA_IU_SCALE &	aIuScale,
		int	aValue
	)

Converts aValue from internal units to a string appropriate for writing to file.

This should only be used for writing to files as it ignores locale

Note

Internal units for board items can be either deci-mils or nanometers depending on how KiCad is built.

Parameters

aValue

A coordinate value to convert.

Returns

A std::string object containing the converted value.

Definition at line 142 of file eda_units.cpp.

{
 std::string buf;
 double engUnits = aValue;
 
 engUnits /= aIuScale.IU_PER_MM;
 
 if( engUnits != 0.0 && fabs( engUnits ) <= 0.0001 )
 {
 buf = fmt::format( "{:.10f}", engUnits );
 
 // remove trailing zeros
 while( !buf.empty() && buf[buf.size() - 1] == '0' )
 {
 buf.pop_back();
 }
 
 // if the value was really small
 // we may have just stripped all the zeros after the decimal
 if( buf[buf.size() - 1] == '.' )
 {
 buf.pop_back();
 }
 }
 else
 {
 buf = fmt::format( "{:.10g}", engUnits );
 }
 
 return buf;
}

References EDA_IU_SCALE::IU_PER_MM.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_PLUGIN::format(), EDA_TEXT::Format(), STROKE_PARAMS::Format(), formatArc(), formatBezier(), BOARD_STACKUP::FormatBoardStackup(), formatCircle(), PCB_PLUGIN::formatGeneral(), FormatInternalUnits(), formatPoly(), PCB_PLUGIN::formatPolyPts(), formatRect(), PCB_PLUGIN::formatSetup(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), and SCH_SEXPR_PLUGIN::saveTextBox().

GetLabel()

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

Get the units string for a given units type.

This version is for setting a wxStaticText label.

Parameters

aUnits	The units requested.
aType	DISTANCE, AREA, or VOLUME

Returns

The human readable units string.

Definition at line 128 of file eda_units.cpp.

{
 return GetText( aUnits, aType ).Trim( false );
}

References GetText().

Referenced by UNIT_BINDER::ChangeValue(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), WX_COLLAPSIBLE_PANE_HEADER::DoGetBestClientSize(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), UNIT_BINDER::onKillFocus(), WX_COLLAPSIBLE_PANE_HEADER::onPaint(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), TOOLS_HOLDER::PopTool(), UNIT_BINDER::SetDataType(), UNIT_BINDER::SetUnits(), UNIT_BINDER::SetValue(), and UNIT_BINDER::UNIT_BINDER().

GetText()

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

Get the units string for a given units type.

This version is for appending to a value string.

Parameters

aUnits	The units requested.
aType	DISTANCE, AREA, or VOLUME

Returns

The human readable units string with appropriate separators.

Definition at line 101 of file eda_units.cpp.

{
 wxString label;
 
 switch( aUnits )
 {
 case EDA_UNITS::MILLIMETRES: label = wxT( " mm" ); break;
 case EDA_UNITS::DEGREES: label = wxT( "°" ); break;
 case EDA_UNITS::MILS: label = wxT( " mils" ); break;
 case EDA_UNITS::INCHES: label = wxT( " in" ); break;
 case EDA_UNITS::PERCENT: label = wxT( "%" ); break;
 case EDA_UNITS::UNSCALED: break;
 default: UNIMPLEMENTED_FOR( wxS( "Unknown units" ) ); break;
 }
 
 switch( aType )
 {
 case EDA_DATA_TYPE::VOLUME: label += wxT( "³" ); break;
 case EDA_DATA_TYPE::AREA: label += wxT( "²" ); break;
 case EDA_DATA_TYPE::DISTANCE: break;
 default: UNIMPLEMENTED_FOR( wxS( "Unknown measurement" ) ); break;
 }
 
 return label;
}

References AREA, DEGREES, DISTANCE, INCHES, MILLIMETRES, MILS, PERCENT, UNIMPLEMENTED_FOR, UNSCALED, and VOLUME.

Referenced by SCH_SYMBOL::AddSheetPathReferenceEntryIfMissing(), ComboBoxUnits(), KIGFX::PREVIEW::DimensionLabel(), SCH_LINE::FindWireSegmentNetNameRecursive(), PANEL_PREVIEW_3D_MODEL::formatOffsetValue(), PANEL_PREVIEW_3D_MODEL::formatRotationValue(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), SCH_SHEET::GetItemDescription(), GetLabel(), SCH_SHEET::GetMsgPanelInfo(), SCH_SYMBOL::GetRef(), TEXT_SEARCH_HANDLER::GetResultCell(), DIALOG_MIGRATE_BUSES::loadGraphData(), NETLIST_EXPORTER_XML::makeSymbols(), EDA_UNIT_UTILS::UI::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), SCH_SHEET::operator<(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_SHEET::SetFields(), EDA_UNIT_UTILS::UI::StringFromValue(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), and PCB_DIMENSION_BASE::updateText().

IsImperialUnit()

bool EDA_UNIT_UTILS::IsImperialUnit

(

EDA_UNITS

aUnit

)

Definition at line 29 of file eda_units.cpp.

{
 switch( aUnit )
 {
 case EDA_UNITS::INCHES:
 case EDA_UNITS::MILS:
 return true;
 
 default:
 return false;
 }
}

References INCHES, and MILS.

Referenced by getTickFormatForScale(), EDA_DRAW_FRAME::GetUnitPair(), COMMON_TOOLS::SetLastUnits(), COMMON_TOOLS::SwitchUnits(), COMMON_TOOLS::ToggleUnits(), and PCB_EDIT_FRAME::UpdateViaSizeSelectBox().

IsMetricUnit()

bool EDA_UNIT_UTILS::IsMetricUnit

(

EDA_UNITS

aUnit

)

Definition at line 43 of file eda_units.cpp.

{
 switch( aUnit )
 {
 case EDA_UNITS::MILLIMETRES:
 return true;
 
 default:
 return false;
 }
}

References MILLIMETRES.

Referenced by COMMON_TOOLS::SetLastUnits(), and COMMON_TOOLS::SwitchUnits().

Mils2IU()

constexpr int EDA_UNIT_UTILS::Mils2IU ( const EDA_IU_SCALE &  aIuScale, int  mils  )

inlineconstexpr

Definition at line 122 of file eda_units.h.

 {
 double x = mils * aIuScale.IU_PER_MILS;
 return int( x < 0 ? x - 0.5 : x + 0.5 );
 }

References EDA_IU_SCALE::IU_PER_MILS.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), EDA_TEXT::EDA_TEXT(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcMidKeepCenter(), PAD::PAD(), PCB_POINT_EDITOR::pinEditedCorner(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

Mils2mm()

int EDA_UNIT_UTILS::Mils2mm

(

double

aVal

)

Convert mils to mm.

Definition at line 62 of file eda_units.cpp.

{
 return KiROUND( aVal * 25.4 / 1000. );
}

References KiROUND().

Referenced by DIALOG_PRINT_GENERIC::initPrintData(), PCB_PARSER::parsePAGE_INFO(), PL_EDITOR_FRAME::ToPrinter(), and DIALOG_PRINT_USING_PRINTER::TransferDataToWindow().

Mm2mils()

int EDA_UNIT_UTILS::Mm2mils

(

double

aVal

)

Convert mm to mils.

Definition at line 56 of file eda_units.cpp.

{
 return KiROUND( aVal * 1000. / 25.4 );
}

References KiROUND().

Referenced by PCB_PARSER::parsePAGE_INFO(), and SCH_SEXPR_PARSER::parsePAGE_INFO().