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

fz_objt_alys_get_face_tors_parm

Description

Gets the parameters of a face's underlying surface geometry, if the geometry of the face is of type torus ( FZ_OBJT_FACE_GEOM_TYPE_TORS).
Call fz_objt_alys_get_face_geom_type to determine the geometry of the face.

Plugin Prototype

fzrt_error_td fz_objt_alys_get_face_tors_parm(

fzrt_int

windex,

fz_objt_ptr

obj,

fzrt_int

findx,

fz_xyz_td *

origin,

fz_xyz_td *

axis,

double *

radius_maj,

double *

radius_min )

Parameters

windex [Input]

project window index

obj [Input]

object

findx [Input]

face index

origin [Result, Optional]

point on the torus axis

axis [Result, Optional]

normalized vector for the axis

radius_maj [Result, Optional]

major radius

radius_min [Result, Optional]

minor radius

Returns

Error codes
MODEL_ERR_INVALID_FACE - invalid face type

Availability

5.0.0.0

Example Files

util_objt_alys_face.fsl

See Also

, fz_objt_alys_get_face_geom_type, fz_objt_alys_get_face_pnt_parm, fz_objt_alys_get_face_plne_parm, fz_objt_alys_get_face_sphr_parm, fz_objt_alys_get_face_cyln_parm, ,, fz_objt_alys_get_face_area, fz_objt_alys_get_face_circumference, fz_objt_alys_get_face_cog,

Function Set

fz_model_fset


Defined in

fz_objt_alys_api.h