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

# fz_objt_cnstr_tors

Description

Creates a torus primitive

Plugin Prototype

fzrt_error_td fz_objt_cnstr_tors(

fzrt_int | windex,
double | maj_radius,
fz_xy_td * | rx_ry,
fz_xyz_td * | origin,
fz_xyz_td * | rotation,
fz_objt_tors_cnstr_opts_ptr | opts,
fz_attr_refn_ptr | refn_opts,
fz_objt_ptr * | obj )

Parameters

windex [Input]

project window index

maj_radius [Input]

major radius, from center to middle of cross section

Range: maj_radius > minor radius

rx_ry [Input]

minor radius x, minor radius y. The minor radius x must be smaller than the major radius.

Range: rx_ry > 0.0

origin [Input, Optional]

origin

Default Value: {0,0,0}

rotation [Input, Optional]

rotation angles, applied in z,y,x order

Default Value: {0,0,0}

opts [Input, Optional]

construction options For defaults see fz_objt_tors_parm_enum.

refn_opts [Input, Optional]

display resolution options For defaults see fz_attr_refn_parm_enum.

obj [Result]

new object

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_prim.fsl

See Also

,

Function Set

fz_model_fset

Defined in

fz_objt_prim_api.h