formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Circle
Description
Creates a circle. The circle is centered at 0,0,0. The major axis is aligned with the x axis. The minor axis is alligned with the y axis. model_type determines if a smooth or facetted circle is created. The optional origin and rotation arguments represent the transformation into 3D space.
Plugin Prototype
fzrt_error_td fz_objt_cnstr_circle(
fzrt_int | windex, |
double | radius, |
model_type, | |
origin, | |
rotation, | |
refn_opts, | |
obj ) |
Parameters
windex [Input]
project window index
radius [Input]
radius
Range: radius > 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
See Also
, fz_objt_edit_circle_parm_get
Function Set
Defined in