formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Helix

# fz_objt_cnstr_helix_from_src

Description

Creates a helix object from a source profile. The source object must have a single face. It can be an open or closed wire or a single face surface object.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_helix_from_src(

fzrt_int | windex,
fz_objt_ptr | src_obj,
fz_objt_model_type_enum | model_type,
fz_objt_smooth_type_enum | smooth_type,
fz_xyz_td * | ax_p1,
fz_xyz_td * | ax_p2,
double | n_cycles,
double | length,
fz_objt_helix_cnstr_opts_ptr | helx_opts,
fz_attr_refn_ptr | refn_opts,
fz_objt_ptr * | obj )

Parameters

windex [Input]

project window index

src_obj [Input]

source object

model_type [Input]

model type

smooth_type [Input]

smooth type

ax_p1 [Input]

first point on helix axis

ax_p2 [Input]

second point on helix axis

n_cycles [Input]

number of cycles

Range: n_cycles > 0.0

length [Input]

helix length

Range: length > 0.0

helx_opts [Input, Optional]

construction options. For defaults see fz_objt_helix_parm_enum

refn_opts [Input, Optional]

display resolution options For defaults see fz_attr_refn_parm_enum

obj [Result]

new object

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_cnstr_helx.fsl

See Also

fz_objt_edit_helix_parm_set,

Function Set

fz_model_fset

Defined in

fz_objt_helx_api.h