formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Screw/Bolt
Description
Creates a screw or bolt object.
Plugin Prototype
fzrt_error_td fz_objt_cnstr_screw(
fzrt_int | windex, |
ax_p1, | |
ax_p2, | |
ax_ref, | |
double | body_length, |
double | body_radius, |
double | neck_length, |
double | neck_radius, |
double | head_length, |
double | head_radius, |
double | tip_factor, |
double | thrd_depth_factor, |
fzrt_int | thrd_cycles, |
scrw_opts, | |
obj ) |
Parameters
windex [Input]
project window index
ax_p1 [Input]
first point on screw axis
ax_p2 [Input]
second point on screw axis
ax_ref [Input]
third point. Must be off the axis defined by ax_p1 and ax_p2. This point determines where the threads starts.
body_length [Input]
screw body length. This includes the length of the tip.
Range: body_length > 0.0
body_radius [Input]
screw body radius.
Range: body_radius > 0.0
neck_length [Input]
screw neck length.
Range: neck_length > 0.0
neck_radius [Input]
screw neck radius.
Range: neck_radius > 0.0
head_length [Input]
screw head length.
Range: head_length > 0.0
head_radius [Input]
screw head radius.
Range: head_radius > 0.0
tip_factor [Input]
Screw tip length as a factor of the body length.
Range: 0.0 < tip_factor < 1.0
thrd_depth_factor [Input]
Screw thread depth as a factor of the body radius.
Range: 0.0 < thrd_depth_factor < 1.0
thrd_cycles [Input]
Number of thread cycles.
Range: thrd_cycles >= 1
scrw_opts [Input, Optional]
construction options. For defaults see fz_objt_helix_parm_enum
obj [Result]
new object
Returns
Error codes
Availability
5.0.0.0
Example Files
See Also
,
Function Set
Defined in