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

# fz_objt_cnstr_text_parl_lines

Description

Creates a solid or surface text object between two parallel lines. The path object defines the centerline between the parallel lines. The distance between the parallel lines is the text height. If do_solid is TRUE, the text is extruded by "depth". Otherwise a surface object is created.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_text_parl_lines(

fzrt_int | windex,
char * | str,
fz_objt_ptr | path_obj,
double | height,
double | depth,
fzrt_boolean | do_solid,
fz_objt_model_type_enum | model_type,
fz_attr_refn_ptr | refn_opts,
fz_objt_text_cnstr_opts_ptr | opts,
fz_objt_ptr * | obj )

Parameters

windex [Input]

project window index

str [Input]

text string

path_obj [Input]

object path

height [Input]

height of text object

Range: height > 0.0

depth [Input]

depth of text object

Range: depth > 0.0

do_solid [Input]

if TRUE, extrudes by depth, otherwise creates a surface object.

model_type [Input]

model type

refn_opts [Input, Optional]

display resolution options. For defaults see see fz_attr_refn_parm_enum

opts [Input, Optional]

construction options. For defaults see fz_objt_text_parm_enum

obj [Result]

text object

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_text.fsl

See Also

fz_objt_cnstr_text_opts_get,

Function Set

fz_model_fset

Defined in

fz_objt_text_api.h