formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Analysis

fz_objt_alys_get_segt_arc_parm

Description

Gets the parameters of the underlying curve geometry of a segment of an object, if the geometry of the segment is of type arc ( FZ_OBJT_SEGT_GEOM_TYPE_ARC). The arc can be elliptical or circular.
The y axis of the arc can be computed as the cross product of the arc's zaxis and xaxis : yaxis = zaxis x xaxis.
If the start and end points are coincident, the arc is considered to be a complete circle or ellipse.

Plugin Prototype

fzrt_error_td fz_objt_alys_get_segt_arc_parm(

fzrt_int

windex,

fz_objt_ptr

obj,

fzrt_int

sindx,

fz_xyz_td *

center,

fz_xyz_td *

zaxis,

fz_xyz_td *

xaxis,

double *

radius_x,

double *

radius_y,

fz_xyz_td *

start,

fz_xyz_td *

end,

fzrt_boolean *

clockwise )

Parameters

windex [Input]

project window index

obj [Input]

object

sindx [Input]

segment index

center [Result, Optional]

arc center

zaxis [Result, Optional]

normalized vector for arc's plane

xaxis [Result, Optional]

normalized vector for the x axis of the arc

radius_x [Result, Optional]

radius of the x axis of the ellipse or circle

radius_y [Result, Optional]

radius of the y axis

start [Result, Optional]

start point

end [Result, Optional]

end point

clockwise [Result, Optional]

is the arc clockwise

Returns

Error codes
MODEL_ERR_INVALID_SEGT - invalid segment type

Availability

5.0.0.0

Example Files

util_objt_alys_face.fsl

See Also

fz_objt_alys_get_segt_geom_type, fz_objt_alys_get_segt_bbox,, fz_objt_alys_get_pnt_on_segt, fz_objt_alys_get_segt_spline_parm, fz_objt_alys_get_segt_pspace_arc_parm, fz_objt_alys_get_segt_pspace_spline_parm

Function Set

fz_model_fset


Defined in

fz_objt_alys_api.h