formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Plain Object Construction
Description
Creates an object with a single face which is an n-sided polygon (ngon). The center of the polyon is at 0,0,0. A corner is placed at the positive x axis at distance radius. The optional origin and rotation argments represent the transformation into 3D space. The optional opts contains options to construct the edge pattern.
Plugin Prototype
fzrt_error_td fz_objt_cnstr_ngon(
fzrt_int | windex, |
fzrt_int | nsides, |
double | radius, |
origin, | |
rotation, | |
opts, | |
obj ) |
Parameters
windex [Input]
project window index
nsides [Input]
number of sides
Range: nsides >= 3
radius [Input]
radius of object
Range: radius > 0.0
origin [Input, Optional]
origin
rotation [Input, Optional]
rotation
opts [Input, Optional]
construction options
obj [Result]
n-sided polygon object
Returns
Error codes
MODEL_ERR_INSUFFICIENT_PNTS - less than 3 unique points in closed case
Availability
5.0.0.0
Example Files
util_objt_cnstr_simp_poly.fsl
util_objt_cnstr_simple.fsl
See Also
fz_objt_cnstr_ngon_opts_init,, ,
Function Set
Defined in