EDA_UNIT_UTILS Namespace Reference

Namespaces
namespace	UI

Functions
KICOMMON_API bool	IsImperialUnit (EDA_UNITS aUnit)
KICOMMON_API bool	IsMetricUnit (EDA_UNITS aUnit)
KICOMMON_API int	Mm2mils (double aVal)
	Convert mm to mils. More...
KICOMMON_API int	Mils2mm (double aVal)
	Convert mils to mm. More...
KICOMMON_API bool	FetchUnitsFromString (const wxString &aTextValue, EDA_UNITS &aUnits)
	Writes any unit info found in the string to aUnits. More...
KICOMMON_API wxString	GetText (EDA_UNITS aUnits, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Get the units string for a given units type. More...
KICOMMON_API wxString	GetLabel (EDA_UNITS aUnits, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Get the units string for a given units type. More...
KICOMMON_API std::string	FormatAngle (const EDA_ANGLE &aAngle)
	Converts aAngle from board units to a string appropriate for writing to file. More...
KICOMMON_API std::string	FormatInternalUnits (const EDA_IU_SCALE &aIuScale, int aValue)
	Converts aValue from internal units to a string appropriate for writing to file. More...
KICOMMON_API 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 72 of file eda_units.cpp.

References CENTIMETRES, DEGREES, INCHES, MICROMETRES, 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 145 of file eda_units.cpp.

References EDA_ANGLE::AsDegrees().

Referenced by 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 186 of file eda_units.cpp.

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 153 of file eda_units.cpp.

References EDA_IU_SCALE::IU_PER_MM.

Referenced by BOOST_AUTO_TEST_CASE(), EDA_TEXT::Format(), STROKE_PARAMS::Format(), formatArc(), formatBezier(), BOARD_STACKUP::FormatBoardStackup(), formatCircle(), FormatInternalUnits(), formatInternalUnits(), formatPoly(), formatRect(), 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 139 of file eda_units.cpp.

References GetText().

Referenced by UNIT_BINDER::ChangeValue(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), UNIT_BINDER::onKillFocus(), DIALOG_NET_INSPECTOR::onReport(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), UNIT_BINDER::SetDataType(), UNIT_BINDER::SetUnits(), UNIT_BINDER::SetValue(), UNIT_BINDER::UNIT_BINDER(), ERC_REPORT::WriteJsonReport(), and DRC_REPORT::WriteJsonReport().

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 110 of file eda_units.cpp.

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

Referenced by ComboBoxUnits(), KIGFX::PREVIEW::DimensionLabel(), PANEL_PREVIEW_3D_MODEL::formatOffsetValue(), PANEL_PREVIEW_3D_MODEL::formatRotationValue(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), GetLabel(), EDA_UNIT_UTILS::UI::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), EDA_UNIT_UTILS::UI::StringFromValue(), and PCB_DIMENSION_BASE::updateText().

IsImperialUnit()

bool EDA_UNIT_UTILS::IsImperialUnit

(

EDA_UNITS

aUnit

)

Definition at line 31 of file eda_units.cpp.

References INCHES, and MILS.

Referenced by getTickFormatForScale(), UNITS_PROVIDER::GetUnitPair(), 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 45 of file eda_units.cpp.

References CENTIMETRES, MICROMETRES, and 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 157 of file eda_units.h.

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 66 of file eda_units.cpp.

References KiROUND().

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

Mm2mils()

int EDA_UNIT_UTILS::Mm2mils

(

double

aVal

)

Convert mm to mils.

Definition at line 60 of file eda_units.cpp.

References KiROUND().