formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Draft Sweep

# fz_objt_dsweep_parm_enum

Description

Parameter identifiers for a parametric draft sweep object. Used for the "which" argument of fz_objt_edit_dsweep_parm_get, , fz_objt_cnstr_dsweep_opts_get and . After creating a sweep object, the source, path and curve objects can be replaced by passing in a new object using the API function. Note, that the same restrictions apply for the new objects as for the ones used to construct the sweep initially. When getting the source, path or curve objects from an existing sweep object via fz_objt_edit_dsweep_parm_get, a copy of the source or path or curve is made and passed back. It is the responsibility of the calling function to delete this new object afterwards, using fz_objt_edit_delete_objt.

enum fz_objt_dsweep_parm_enum {

FZ_OBJT_DSWEEP_PARM_SRC_ALIGN,

FZ_OBJT_DSWEEP_PARM_CAP_START_ON,

FZ_OBJT_DSWEEP_PARM_CAP_END_ON,

FZ_OBJT_DSWEEP_PARM_AXL_SRC_ROT_ON,

FZ_OBJT_DSWEEP_PARM_AXL_SRC_ROT,

FZ_OBJT_DSWEEP_PARM_TYPE,

FZ_OBJT_DSWEEP_PARM_SRC_OBJ,

FZ_OBJT_DSWEEP_PARM_PTH_OBJ,

FZ_OBJT_DSWEEP_PARM_CRV_OBJ,

FZ_OBJT_DSWEEP_PARM_ANGLE,

FZ_OBJT_DSWEEP_PARM_DISTANCE,

FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_ON,

FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_TYPE,

FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_FREQ,

FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_AMPL,

FZ_OBJT_DSWEEP_PARM_FUNC_CUSTOM };

Members

FZ_OBJT_DSWEEP_PARM_SRC_ALIGN

Construction - Source alignment.

Type: fz_objt_dsweep_srcalign_enum

Default Value: FZ_OBJT_DSWEEP_SRCALIGN_ORIGIN

FZ_OBJT_DSWEEP_PARM_CAP_START_ON

Construction and Editing - Start cap on/off.

Type: fzrt_boolean

Default Value: 0

FZ_OBJT_DSWEEP_PARM_CAP_END_ON

Construction and Editing - End cap on/off.

Type: fzrt_boolean

Default Value: 0

FZ_OBJT_DSWEEP_PARM_AXL_SRC_ROT_ON

Construction and Editing - Draft sweep, source rotation on/off.

Type: fzrt_boolean

Default Value: 0

FZ_OBJT_DSWEEP_PARM_AXL_SRC_ROT

Construction and Editing - Draft sweep, source rotation angle.

Type: double

Default Value: 0

FZ_OBJT_DSWEEP_PARM_TYPE

Editing - Draft Sweep type - by angle, distance, function or curve.

Type: fz_objt_dsweep_type_enum

FZ_OBJT_DSWEEP_PARM_SRC_OBJ

Editing - Draft Sweep source object.

Type: fz_objt_ptr

FZ_OBJT_DSWEEP_PARM_PTH_OBJ

Editing - Draft Sweep path object.

Type: fz_objt_ptr

FZ_OBJT_DSWEEP_PARM_CRV_OBJ

Editing - Draft Sweep curve object.

Type: fz_objt_ptr

FZ_OBJT_DSWEEP_PARM_ANGLE

Editing - draft angle, if by angle option is on.

Type: double

FZ_OBJT_DSWEEP_PARM_DISTANCE

Editing - draft distance, if by distance option is on.

Type: double

FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_ON

Editing - predefined function on/off, if by function option is on. TRUE means, a pre defined function is used. FALSE means, a custom function is used.

Type: boolean

FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_TYPE

Editing - predefined function type, if by function option is on and FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_ON is on.

Type: fz_objt_dsweep_pdef_enum

FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_FREQ

Editing - predefined function frequency, if by function option is on and FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_ON is on.

Type: double

Range: value > 0.0

FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_AMPL

Editing - predefined function amplitude, if by function option is on and FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_ON is on.

Type: double

FZ_OBJT_DSWEEP_PARM_FUNC_CUSTOM

Editing - custom function expression, if by function option is on and FZ_OBJT_DSWEEP_PARM_FUNC_PREDEF_ON is off. A valid function expression must be used, if this parameter is set.

Type: string

Availability

5.0.0.0

See Also

fz_objt_edit_dsweep_parm_get,, fz_objt_cnstr_dsweep_opts_get,

Defined in

fz_objt_dswp_api.h