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

# fz_objt_cnstr_text_unistr_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.
The text is made up of unicode (utf16) characters (two bytes per character). The string must terminated with two NULL bytes (one NULL character).
Only one text style can be applied to the object during creation. If other styles need to be applied this can be done using after the object is created. If NULL is passed in for the style, the default font (as set in the Project: Fonts section of the Preferences dialog) will be used.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_text_unistr_plain(

fzrt_int | windex,
fzrt_uni_char * | str,
fz_text_style_ptr | style,
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]

unicode (utf16) text string

style [Input, Optional]

the style to apply to the text

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.5.0.0

Example Files

util_objt_unistr_text.fsl

See Also

fz_objt_cnstr_text_opts_get,

Function Set

fz_model_fset

Defined in

fz_objt_text_api.h