formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Plain Object Construction

# fz_objt_cnstr_unfold

Description

Constructs an unfolded object from a source. origin, xaxis_pt and yaxis_pt specify the plane on which the unfolded object is placed. If passed as NULL, the xy plane is used.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_unfold(

fzrt_int | windex,
fz_objt_ptr | src_obj,
fzrt_int | sindx,
fz_xyz_td * | origin,
fz_xyz_td * | xaxis_pt,
fz_xyz_td * | yaxis_pt,
fz_objt_unfold_cnstr_opts_ptr | opts,
fz_objt_ptr * | obj )

Parameters

windex [Input]

project window index

src_obj [Input]

source object

sindx [Input]

The index of the segment where the unfold starts

origin [Input, Optional]

The origin of the unfold operation

Default Value: {0.0,0.0,0.0}

xaxis_pt [Input, Optional]

The x axis point for the plane of the unfold operation

Default Value: {1.0,0.0,0.0}

yaxis_pt [Input, Optional]

The y axis point for the plane of the unfold operation

Default Value: {0.0,1.0,0.0}

opts [Input, Optional]

construction options. For defaults see fz_objt_unfold_parm_enum.

obj [Result]

new object

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_cnstr_derv.fsl

See Also

,, fz_objt_cnstr_unfold_opts_get,

Function Set

fz_model_fset

Defined in

fz_objt_api.h