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

# fz_objt_cnstr_ellipse

Description

Creates an ellipse. The ellipse is centered at 0,0,0. The major axis is aligned with the x axis. The minor axis is aligned with the y axis. The x radius is measured along the x axis, the y radius along the y axis. model_type determines if a smooth or facetted ellipse is created. The optional origin and rotation arguments represent the transformation into 3D space.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_ellipse(

fzrt_int | windex,
fz_xy_td * | radii,
fz_objt_model_type_enum | model_type,
fz_xyz_td * | origin,
fz_xyz_td * | rotation,
fz_attr_refn_ptr | refn_opts,
fz_objt_ptr * | obj )

Parameters

windex [Input]

project window index

radii [Input]

x and y radii

Range: radii > 0.0

model_type [Input]

model type

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}

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_plin.fsl

See Also

fz_objt_edit_ellipse_parm_set, fz_objt_edit_ellipse_parm_get

Function Set

fz_model_fset

Defined in

fz_objt_plin_api.h