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

# fz_objt_cnstr_dsweep_predef

Description

Creates a Draft Sweep object by predefined function. This function constructs a Smooth object by sweeping the source object along the path object while offsetting the source by an amount specified by the given predefined function.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_dsweep_predef(

fzrt_int | windex,
fz_objt_ptr | src_obj,
fz_objt_ptr | pth_obj,
fz_objt_dsweep_pdef_enum | which,
double | frequency,
double | amplitude,
fz_objt_dsweep_cnstr_opts_ptr | dswp_opts,
fz_attr_refn_ptr | refn_opts,
fz_objt_ptr * | obj )

Parameters

windex [Input]

project window index

src_obj [Input]

Source object

pth_obj [Input]

Path object

which [Input]

Predefined function

frequency [Input]

Frequency

amplitude [Input]

Amplitude

dswp_opts [Input]

Draft Sweep construction options

refn_opts [Input]

obj [Result]

New object

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_dswp.fsl

See Also

fz_objt_cnstr_dsweep_opts_init, fz_objt_cnstr_dsweep_opts_get,

Function Set

fz_model_fset

Defined in

fz_objt_dswp_api.h