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

# fz_objt_cnstr_text_plain

Description

Creates a plain text object. The text is by default, left justified at the origin, extending along the x axis. The optional origin and rotation parameters transform it into a 3d space position.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_text_plain(

fzrt_int | windex,
char * | str,
double | height,
fz_xyz_td * | origin,
fz_xyz_td * | rotation,
fz_objt_text_cnstr_opts_ptr | opts,
fz_objt_ptr * | obj )

Parameters

windex [Input]

project window index

str [Input]

text string

height [Input]

height of text object

Range: height > 0.0

origin [Input, Optional]

origin of text object

Default Value: {0.0, 0.0, 0.0}

rotation [Input, Optional]

rotation of text object

Default Value: {0.0, 0.0, 0.0}

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