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

fz_objt_cnstr_cone

Description

Creates a cone primitive

Plugin Prototype

fzrt_error_td fz_objt_cnstr_cone(

fzrt_int

windex,

fz_xyz_td *

rx_ry_h,

double

top_ratio,

fz_xyz_td *

origin,

fz_xyz_td *

rotation,

fz_objt_cone_cnstr_opts_ptr

opts,

fz_attr_refn_ptr

refn_opts,

fz_objt_ptr *

obj )

Parameters

windex [Input]

project window index

rx_ry_h [Input]

radius x, radius y, height

Range: rx_ry_h > 0.0

top_ratio [Input]

ratio of truncated top to cone base. If passed as 0.0, the cone is not truncated. Otherwise a flat top face is generated. For example, a value of 0.5 creates a truncated top which is half the size of the base.

Range: top_ratio >= 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_cone_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

fz_objt_edit_cone_parm_set,

Function Set

fz_model_fset


Defined in

fz_objt_prim_api.h