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

# fz_objt_alys_face_is_planar

Description

Checks whether a given face is planar. This is the case if :
the face belongs to a facetted object and all its points are on the same plane.
the face belongs to a smooth object and the face's underlying geometry is a plane.
the face belongs to a smooth object and the face's underlying geometry is a spline surface and the spline is perfectly flat.

Plugin Prototype

fzrt_error_td fz_objt_alys_face_is_planar(

fzrt_int | windex,
fz_objt_ptr | obj,
fzrt_int | findx,
fz_objt_model_type_enum | model_type,
fzrt_boolean * | is_planar )

Parameters

windex [Input]

project window index

obj [Input]

object

findx [Input]

face index

model_type [Input]

object topology type. FZ_OBJT_MODEL_TYPE_UNSPEC may be used to use the object's natural model type.

is_planar [Result]

face is planar

Returns

Error codes
MODEL_ERR_INVALID_FACE - cannot get face normal

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_tors_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