formZ SDK | 5.0 API Reference | Project | File Formats | Structured File Translator

# fz_ffmt_read_get_units_scale

Description

Gets the scale factor to convert from the file's units to the project's units. Internally, formZ stores all positional data in units of inches for English projects and in units of cm for metric projects. This function returns a scale factor which converts the file's units to one of formZ's 2 internal units. The scale factor returned is based on the "formZ Units" and "Format Units" options the user has selected. These options are contained in the flags parameter.

Plugin Prototype

fzrt_error_td fz_ffmt_read_get_units_scale(

double | toinches,
fzrt_int | flags,
fz_ffmt_data_formz_units_enum | formz_units,
fz_ffmt_data_file_units_enum | file_units,
double * | scale )

Parameters

toinches [Input]

A scale factor to convert from the files units to inches.

flags [Input]

The units flags. Usually obtained from the read options flags; fz_ffmt_model_read_opts_parm_get with FZ_FFMT_DATA_MODEL_READ_OPTS_PARM_FLAGS

Bit Flag Type: fz_ffmt_data_model_read_opts_flags_enum

formz_units [Input]

The units selection from the formZ Units menu on the Modeling or Drafting Import Options dialog.

file_units [Input]

The units selection from the Format Units menu on the Modeling or Drafting Import Options dialog.

scale [Result]

The scale factor.

Returns

FZRT_NOERR on success. An error otherwise.

Availability

5.0.0.0

Function Set

fz_ffmt_fset

Defined in

fz_ffmt_api.h