formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Helix
Description
Sets a parameter of a helix object. When setting a new
source or path object using the FZ_OBJT_HELIX_PARM_SRC_OBJ or
FZ_OBJT_HELIX_PARM_PATH_OBJ parameter id,
the calling code must create and delete this
object. fz_objt_edit_helix_parm_set() makes an internal copy.
Note that the shape of the helix object is not changed until
the function has been called.
Plugin Prototype
fzrt_error_td fz_objt_edit_helix_parm_set(
fzrt_int | windex, |
obj, | |
which, | |
data ) |
Parameters
windex [Input]
project window index
obj [Input]
object
which [Input]
parameter id
data [Input]
parameter data
Returns
Error codes
MODEL_ERR_WRONG_OBJT_TYPE - object passed in is not a helix object
Availability
5.0.0.0
Example Files
See Also
, fz_objt_cnstr_helix_from_src, fz_objt_cnstr_helix_around_axis,,
Function Set
Defined in