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

# fz_objt_cnstr_arc

Description

Creates a circular or elliptical arc. The arc is centered at 0,0,0. The major axis is aligned with the x axis. The minor axis is aligned with the y axis. radius x is measured along the x axis and radius y along the y axis. start_ang and end_ang define the start and end of the arc and are measured from the positive x axis. If clockwise is TRUE, the arc goes in clockwise direction from start to end. Otherwise it goes in counterclockwise direction from start to end. model_type determines if a smooth or facetted arc is created. The optional origin and rotation arguments represent the transformation into 3D space. If start_ang and end_ang are the same, a full circle or ellipse is created.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_arc(

fzrt_int | windex,
fz_xy_td * | rx_ry,
double | start_ang,
double | end_ang,
fzrt_boolean | clockwise,
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

rx_ry [Input]

x and y radii

Range: rx_ry > 0.0

start_ang [Input]

start angle

Range: -2PI <= start_ang <= 2PI

end_ang [Input]

end angle

Range: -2PI <= end_ang <= 2PI

clockwise [Input]

If TRUE, the arc is generated clockwise from the start angle to the end angle. Otherwise it is generated counter clockwise

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