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

# fz_objt_edit_helix_parm_get

Description

Gets a parameter of a helix object. When getting the source or path object using the FZ_OBJT_HELIX_PARM_SRC_OBJ or FZ_OBJT_HELIX_PARM_PATH_OBJ parameter id, creates the object as a copy from its internally stored source object. It is the responsibility of the calling function to delete this object.

Plugin Prototype

fzrt_error_td fz_objt_edit_helix_parm_get(

fzrt_int | windex,
fz_objt_ptr | obj,
fz_objt_helix_parm_enum | which,
fz_type_td * | data )

Parameters

windex [Input]

project window index

obj [Input]

object

which [Input]

parameter id

data [Result]

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

util_objt_cnstr_helx.fsl

See Also

fz_objt_edit_helix_parm_set, fz_objt_cnstr_helix_from_src, fz_objt_cnstr_helix_around_axis,,

Function Set

fz_model_fset

Defined in

fz_objt_helx_api.h