formZ SDK | 5.0 API Reference | Project | Utility

# fz_proj_unit_enum

Description

Working unit parameters. Used for the "which" argument of fz_proj_units_get_parm_data and fz_proj_units_set_parm_data.

enum fz_proj_unit_enum {

FZ_UNITS_PARM_UNITS_TYPE,

FZ_UNITS_PARM_ENGLISH_BASE,

FZ_UNITS_PARM_DISPLAY_TYPE,

FZ_UNITS_PARM_METRIC_BASE,

FZ_UNITS_PARM_ACCURACY,

FZ_UNITS_PARM_DEC_DECIMAL_PLACES,

FZ_UNITS_PARM_ANG_DECIMAL_PLACES,

FZ_UNITS_PARM_DEC_TRAILING_0_FLAG,

FZ_UNITS_PARM_ANG_TRAILING_0_FLAG,

FZ_UNITS_PARM_ANG_TYPE,

FZ_UNITS_PARM_ANG_DIRECTION,

FZ_UNITS_PARM_ANG_ORIENTATION,

FZ_UNITS_PARM_ANG_MEASUREMENT_METHOD,

FZ_UNITS_PARM_ANG_ACCURACY,

FZ_UNITS_PARM_ABSOLUTE_COORD,

FZ_UNITS_PARM_WORLD_SPACE,

FZ_UNITS_PARM_CARTESIAN,

FZ_UNITS_PARM_SCALE };

Members

FZ_UNITS_PARM_UNITS_TYPE

Unit type.

Type: fz_unit_type_enum

FZ_UNITS_PARM_ENGLISH_BASE

Base English units type.

Type: fz_unit_english_enum

Default Value: FZ_UNIT_ENGLISH_INCH

FZ_UNITS_PARM_DISPLAY_TYPE

Display format of numeric values in a numeric display.

Type: fz_unit_num_disp_enum

Default Value: FZ_UNIT_NUM_DISP_ARCH

FZ_UNITS_PARM_METRIC_BASE

Base Metric units type.

Type: fz_unit_metric_enum

Default Value: FZ_UNIT_METRIC_CENTIMETER

FZ_UNITS_PARM_ACCURACY

Numeric accuracy.

Type: double

Default Value: 1/16" (or 0.001 m metric)

Range: value > 0

FZ_UNITS_PARM_DEC_DECIMAL_PLACES

Number of digits displayed after the decimal point in a numeric display.

Type: fzrt_int

Default Value: 3

Range: 0 <= value <= 16

FZ_UNITS_PARM_ANG_DECIMAL_PLACES

Number of digits displayed after the decimal point in an angular display.

Type: fzrt_int

Default Value: 2

Range: 0 <= value <= 16

FZ_UNITS_PARM_DEC_TRAILING_0_FLAG

If set, trailing zeros after the decimal point will be shown in a numeric display.

Type: fzrt_boolean

Default Value: TRUE

FZ_UNITS_PARM_ANG_TRAILING_0_FLAG

If set, trailing zeros after the decimal point will be shown in an angular display.

Type: fzrt_boolean

Default Value: TRUE

FZ_UNITS_PARM_ANG_TYPE

Display format of numeric values in a numeric display.

Type: fz_unit_ang_disp_enum

Default Value: FZ_UNIT_ANG_DISP_DEG

FZ_UNITS_PARM_ANG_DIRECTION

If set, positive angles are counterclockwise, otherwise positive angles are clockwise.

Type: fzrt_boolean

Default Value: TRUE

FZ_UNITS_PARM_ANG_ORIENTATION

Indicates where orientation angles sre measured from.

Type: fz_unit_ang_orient_enum

Default Value: FZ_UNIT_ANG_ORIENT_EAST

FZ_UNITS_PARM_ANG_MEASUREMENT_METHOD

Determines how to read and interpret angles.

Type: fz_unit_ang_measure_enum

Default Value: FZ_UNIT_ANG_MEASURE_SMALL

FZ_UNITS_PARM_ANG_ACCURACY

Angle accuracy.

Type: double

Default Value: 0.01 degree

Range: value > 0

FZ_UNITS_PARM_ABSOLUTE_COORD

Determines if absolute or relative coordinates are used.
If set, the absolute method is used where coordinates are displayed relative to the origin of the coordinate . Otherwise, the relative method is used where coordinates are displayed relative to the last entered point.

Type: fzrt_boolean

Default Value: TRUE

FZ_UNITS_PARM_WORLD_SPACE

Determines if the world space or reference plane coordinate is used.
If set, the world space method is used where coordinate values of world space are used. Otherwise, the reference plane method is used where coordinate values of the reference plane are used.

Type: fzrt_boolean

Default Value: TRUE

FZ_UNITS_PARM_CARTESIAN

Determines if Cartesian or polar coordinates are used.
If set, Cartesian coordinates are used. Otherwise, polar coordinates are used.

Type: fzrt_boolean

Default Value: TRUE

FZ_UNITS_PARM_SCALE

Indicates the scale of the working units.

Type: fz_unit_scale_enum

Default Value: FZ_UNIT_SCAL_MEDIUM

Availability

5.0.0.0

See Also

fz_proj_units_get_parm_data, fz_proj_units_set_parm_data

Defined in

fz_proj_api.h