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

# fz_objt_cnstr_helix_around_axis

Description

Creates a wire helix around an axis.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_helix_around_axis(

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

Parameters

windex [Input]

project window index

model_type [Input]

model type

ax_p1 [Input]

first point on helix axis

ax_p2 [Input]

second point on helix axis

ax_ref [Input]

third point. Must be off the axis defined by ax_p1 and ax_p2. This point determines where the helix starts.

n_cycles [Input]

number of cycles.

Range: n_cycles > 0.0

length [Input]

helix length

Range: length > 0.0

radius [Input]

helix radius

Range: radius > 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