formZ SDK | 5.0 API Reference | System | User Interface (FUIM)
Description
Default unit conversion function. This function is used to set default values for dimensional values. It takes a default English (inches) and metric (cm) value at a specified scale and converts it to the proper value in the requested units and at the requested scale. This function is useful to keep dimensional values reasonable for the available units and scales.
Plugin Prototype
fzrt_error_td fz_fuim_unit_convert(
double | english_value, |
double | metric_value, |
scale_value, | |
unit_out, | |
scale_out, | |
double * | value ) |
Parameters
english_value [Input]
default English unit dimensional value
metric_value [Input]
default metric unit dimensional value
scale_value [Input]
scale which the English_value and metric_value parameters represent
unit_out [Input]
The desired unit type for the returned value
scale_out [Input]
The desired scale for the returned value
value [Result]
pointer to dimensional value to be set
Availability
5.0.0.0
See Also
fz_notf_cbak_syst_units,, fz_notf_cbak_wind_units, fz_notf_cbak_pref_default
Function Set
Defined in