formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Text Object

# fz_objt_text_parm_enum

Description

Parameter identifiers for a parametric text object. Used for the "which" argument of , fz_objt_edit_text_parm_set, fz_objt_cnstr_text_opts_get and .

enum fz_objt_text_parm_enum {

FZ_OBJT_TEXT_PARM_HORIZ_JUST,

FZ_OBJT_TEXT_PARM_VERT_JUST,

FZ_OBJT_TEXT_PARM_DEPTH_JUST,

FZ_OBJT_TEXT_PARM_HEIGHT_TYPE,

FZ_OBJT_TEXT_PARM_HEIGHT_CHAR,

FZ_OBJT_TEXT_PARM_ONLINE_SCALE,

FZ_OBJT_TEXT_PARM_WIDTH_FACTOR,

FZ_OBJT_TEXT_PARM_LEADING_FACTOR,

FZ_OBJT_TEXT_PARM_SMOOTHING,

FZ_OBJT_TEXT_PARM_PATH_ADJUST,

FZ_OBJT_TEXT_PARM_STANDING,

FZ_OBJT_TEXT_PARM_CHAR_ANGLE,

FZ_OBJT_TEXT_PARM_INCLINE_ANGLE,

FZ_OBJT_TEXT_PARM_RADIUS_ADJUST,

FZ_OBJT_TEXT_PARM_FONT_TYPE,

FZ_OBJT_TEXT_PARM_FONT_FACE,

FZ_OBJT_TEXT_PARM_FONT_NAME,

FZ_OBJT_TEXT_PARM_FRND_FRNT_TYPE,

FZ_OBJT_TEXT_PARM_FRND_FRNT_NSIDES,

FZ_OBJT_TEXT_PARM_FRND_FRNT_RADIUS,

FZ_OBJT_TEXT_PARM_FRND_FRNT_BEVEL,

FZ_OBJT_TEXT_PARM_SRND_FRNT_TYPE,

FZ_OBJT_TEXT_PARM_SRND_FRNT_RADIUS,

FZ_OBJT_TEXT_PARM_SRND_FRNT_RADIUS_MAJ,

FZ_OBJT_TEXT_PARM_SRND_FRNT_RADIUS_MIN,

FZ_OBJT_TEXT_PARM_SRND_FRNT_RADIUS_ROT,

FZ_OBJT_TEXT_PARM_SRND_FRNT_BEVEL_LEFT,

FZ_OBJT_TEXT_PARM_SRND_FRNT_BEVEL_RITE,

FZ_OBJT_TEXT_PARM_SRND_FRNT_BEVEL_BULGE_ON,

FZ_OBJT_TEXT_PARM_SRND_FRNT_BEVEL_BULGE,

FZ_OBJT_TEXT_PARM_FRND_BACK_TYPE,

FZ_OBJT_TEXT_PARM_FRND_BACK_NSIDES,

FZ_OBJT_TEXT_PARM_FRND_BACK_RADIUS,

FZ_OBJT_TEXT_PARM_FRND_BACK_BEVEL,

FZ_OBJT_TEXT_PARM_SRND_BACK_TYPE,

FZ_OBJT_TEXT_PARM_SRND_BACK_RADIUS,

FZ_OBJT_TEXT_PARM_SRND_BACK_RADIUS_MAJ,

FZ_OBJT_TEXT_PARM_SRND_BACK_RADIUS_MIN,

FZ_OBJT_TEXT_PARM_SRND_BACK_RADIUS_ROT,

FZ_OBJT_TEXT_PARM_SRND_BACK_BEVEL_LEFT,

FZ_OBJT_TEXT_PARM_SRND_BACK_BEVEL_RITE,

FZ_OBJT_TEXT_PARM_SRND_BACK_BEVEL_BULGE_ON,

FZ_OBJT_TEXT_PARM_SRND_BACK_BEVEL_BULGE,

FZ_OBJT_TEXT_PARM_HEIGHT,

FZ_OBJT_TEXT_PARM_ORIGIN,

FZ_OBJT_TEXT_PARM_ROTATION,

FZ_OBJT_TEXT_PARM_DEPTH,

FZ_OBJT_TEXT_PARM_DO_SOLID,

FZ_OBJT_TEXT_PARM_STRING,

FZ_OBJT_TEXT_PARM_PATH_OBJ1,

FZ_OBJT_TEXT_PARM_PATH_OBJ2,

FZ_OBJT_TEXT_PARM_MODEL_TYPE };

Members

FZ_OBJT_TEXT_PARM_HORIZ_JUST

Construction and Editing - Horizontal alignment.

Type: fz_objt_text_halign_enum

Default Value: FZ_OBJT_TEXT_HORIZ_JUST_LEFT

FZ_OBJT_TEXT_PARM_VERT_JUST

Construction and Editing - Vertical alignment.

Type: fz_objt_text_valign_enum

Default Value: FZ_OBJT_TEXT_VERT_JUST_BOTTOM

FZ_OBJT_TEXT_PARM_DEPTH_JUST

Construction and Editing - Depth alignment.

Type: fz_objt_text_dalign_enum

Default Value: FZ_OBJT_TEXT_DEPTH_JUST_FRONT

FZ_OBJT_TEXT_PARM_HEIGHT_TYPE

Construction and Editing - Height measurement method.

Type: fz_objt_text_htype_enum

Default Value: FZ_OBJT_TEXT_HEIGHT_TYPE_UPPER

FZ_OBJT_TEXT_PARM_HEIGHT_CHAR

Construction and Editing - Height character. A string with any one non white space character only (extra characters will be ignored). The height will be based on the geometry of this character.

Type: char*

FZ_OBJT_TEXT_PARM_ONLINE_SCALE

Construction and Editing - Text on line scale option.

Type: fz_objt_text_oscale_enum

Default Value: FZ_OBJT_TEXT_ONLINE_SCALE_WIDTH_HEIGHT

FZ_OBJT_TEXT_PARM_WIDTH_FACTOR

Construction and Editing - Text character width scale factor.

Type: double

Default Value: 1.0

Range: value > 0.0

FZ_OBJT_TEXT_PARM_LEADING_FACTOR

Construction and Editing - Text character leading factor.

Type: double

Default Value: 0.25

Range: value > 0.0

FZ_OBJT_TEXT_PARM_SMOOTHING

Construction and Editing - Text smoothness.

Type: double

Default Value: 0.5

Range: 0.0 <= value <= 1.0

FZ_OBJT_TEXT_PARM_PATH_ADJUST

Construction and Editing - Text between parallel lines/ between lines, adjust on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_TEXT_PARM_STANDING

Construction and Editing - Text standing on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_TEXT_PARM_CHAR_ANGLE

Construction and Editing - Character angle.

Type: double

Default Value: 0.0

FZ_OBJT_TEXT_PARM_INCLINE_ANGLE

Construction and Editing - Character incline angle.

Type: double

Default Value: 0.0

FZ_OBJT_TEXT_PARM_RADIUS_ADJUST

Construction and Editing - Adjust rounding radius on (TRUE) or off (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_TEXT_PARM_FONT_TYPE

Construction and Editing - Text font type.

Type: fz_objt_text_fonttype_enum

Default Value: FZ_OBJT_TEXT_FONT_TYPE_TRUETYPE

FZ_OBJT_TEXT_PARM_FONT_FACE

Construction and Editing - Text font face.

Type: fzrt_int

FZ_OBJT_TEXT_PARM_FONT_NAME

Construction and Editing - Text font name.

Type: char*

Default Value: default font name on current OS

FZ_OBJT_TEXT_PARM_FRND_FRNT_TYPE

Construction and Editing - Text rounding front, type. Valid for : Facetted model type except Plain Text.

Type: fz_objt_text_rndtype_enum

Default Value: FZ_OBJT_TEXT_ROUND_TYPE_NONE

FZ_OBJT_TEXT_PARM_FRND_FRNT_NSIDES

Construction and Editing - Text rounding front, # of sides. Valid for : Facetted model type except Plain Text.

Type: fzrt_int

Range: value >= 2

Default Value: 4

FZ_OBJT_TEXT_PARM_FRND_FRNT_RADIUS

Construction and Editing - Text rounding front, radius. Valid for : Facetted model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_FRND_FRNT_BEVEL

Construction and Editing - Text rounding front, bevel distance. Valid for : Facetted model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_FRNT_TYPE

Construction and Editing - Text smooth rounding front, type. Valid for : Smooth model type except Plain Text.

Type: fz_objt_srnd_edge_type_enum

Default Value: FZ_OBJT_SRND_EDGE_TYPE_NONE

FZ_OBJT_TEXT_PARM_SRND_FRNT_RADIUS

Construction and Editing - Text rounding front, radius. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_FRNT_RADIUS_MAJ

Construction and Editing - Text rounding front, major radius. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_FRNT_RADIUS_MIN

Construction and Editing - Text rounding front, minor radius. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 2.0 in, Metric 5.0 cm

FZ_OBJT_TEXT_PARM_SRND_FRNT_RADIUS_ROT

Construction and Editing - Text rounding front, rotation angle. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: 0.0

FZ_OBJT_TEXT_PARM_SRND_FRNT_BEVEL_LEFT

Construction and Editing - Text rounding front, bevel left distance. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_FRNT_BEVEL_RITE

Construction and Editing - Text rounding front, bevel right distance. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_FRNT_BEVEL_BULGE_ON

Construction and Editing - Text rounding front, bevel bulge flag. Valid for : Smooth model type except Plain Text.

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_TEXT_PARM_SRND_FRNT_BEVEL_BULGE

Construction and Editing - Text rounding front, bevel bulge value. Valid for : Smooth model type except Plain Text.

Type: double

Range: 0.0 <= value <= 1.0

Default Value: 0.0

FZ_OBJT_TEXT_PARM_FRND_BACK_TYPE

Construction and Editing - Text rounding back, type. Valid for : Facetted model type except Plain Text.

Type: fz_objt_text_rndtype_enum

Default Value: FZ_OBJT_TEXT_ROUND_TYPE_NONE

FZ_OBJT_TEXT_PARM_FRND_BACK_NSIDES

Construction and Editing - Text rounding back, # of sides. Valid for : Facetted model type except Plain Text.

Type: fzrt_int

Range: value >= 2

Default Value: 4

FZ_OBJT_TEXT_PARM_FRND_BACK_RADIUS

Construction and Editing - Text rounding back, radius. Valid for : Facetted model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_FRND_BACK_BEVEL

Construction and Editing - Text rounding back, bevel distance. Valid for : Facetted model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_BACK_TYPE

Construction and Editing - Text smooth rounding back, type. Valid for : Smooth model type except Plain Text.

Type: fz_objt_srnd_edge_type_enum

Default Value: FZ_OBJT_SRND_EDGE_TYPE_NONE

FZ_OBJT_TEXT_PARM_SRND_BACK_RADIUS

Construction and Editing - Text rounding back, radius. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_BACK_RADIUS_MAJ

Construction and Editing - Text rounding back, major radius. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_BACK_RADIUS_MIN

Construction and Editing - Text rounding back, minor radius. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 2.0 in, Metric 5.0 cm

FZ_OBJT_TEXT_PARM_SRND_BACK_RADIUS_ROT

Construction and Editing - Text rounding back, rotation angle. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: 0.0

FZ_OBJT_TEXT_PARM_SRND_BACK_BEVEL_LEFT

Construction and Editing - Text rounding back, bevel left distance. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_BACK_BEVEL_RITE

Construction and Editing - Text rounding back, bevel right distance. Valid for : Smooth model type except Plain Text.

Type: double

Range: value > 0.0

Default Value: English 4.0 in, Metric 10.0 cm

FZ_OBJT_TEXT_PARM_SRND_BACK_BEVEL_BULGE_ON

Construction and Editing - Text rounding back, bevel bulge flag. Valid for : Smooth model type except Plain Text.

Type: fzrt_boolean

Default Value: FALSE

FZ_OBJT_TEXT_PARM_SRND_BACK_BEVEL_BULGE

Construction and Editing - Text rounding back, bevel bulge. Valid for : Smooth model type except Plain Text.

Type: double

Range: 0.0 <= value <= 1.0

Default Value: 0.0

FZ_OBJT_TEXT_PARM_HEIGHT

Editing - Text height. Valid for : Plain Text, Object Text, Text On Line, Text Between Parallel Lines.

Type: double

Range: value > 0.0

FZ_OBJT_TEXT_PARM_ORIGIN

Editing - Text origin. Valid for : Plain Text, Object Text.

Type: fz_xyz_td

FZ_OBJT_TEXT_PARM_ROTATION

Editing - Text rotation. Valid for : Plain Text, Object Text.

Type: fz_xyz_td

FZ_OBJT_TEXT_PARM_DEPTH

Editing - Text depth. Valid for : all except Plain Text.

Type: double

Range: value > 0.0

FZ_OBJT_TEXT_PARM_DO_SOLID

Editing - Text Solid on (TRUE) or off (FALSE). Valid for : all except Plain Text.

Type: fzrt_boolean

FZ_OBJT_TEXT_PARM_STRING

Editing - Text string.

Type: char*

FZ_OBJT_TEXT_PARM_PATH_OBJ1

Editing - Text path object 1. Valid for : Text On Line, Text Between Parallel Lines, Text Between Lines. After creating a text object, the path object itself can be replaced by passing in a new object using the fz_objt_edit_text_parm_set API function. Note, that the same restrictions apply for this object as for the one used to construct the text object initially. When getting this parameter from an existing text object, a copy of the path is made and passed back. It is the responsibility of the calling function to delete this new object afterwards, using fz_objt_edit_delete_objt.

Type: fz_objt_ptr

FZ_OBJT_TEXT_PARM_PATH_OBJ2

Editing - Text path object 2. Valid for : Text Between Lines After creating a text object, the path object itself can be replaced by passing in a new object using the fz_objt_edit_text_parm_set API function. Note, that the same restrictions apply for this object as for the one used to construct the text object initially. When getting this parameter from an existing text object, a copy of the path is made and passed back. It is the responsibility of the calling function to delete this new object afterwards, using fz_objt_edit_delete_objt.

Type: fz_objt_ptr

FZ_OBJT_TEXT_PARM_MODEL_TYPE

Editing - Model type.

Type: fz_objt_model_type_enum

Availability

5.0.0.0

Example Files

util_objt_text.fsl

See Also

fz_objt_cnstr_text_opts_get, , , fz_objt_edit_text_parm_set, fz_objt_text_search_text_parm_get,

Defined in

fz_objt_text_api.h