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

# fz_objt_alys_is_pnt_inside_face

Description

Finds if a point lies inside a face's boundaries. The returned information contains a flag that tells, whether the given point is inside (1), on (2) or outside (0) the face boundary. The point passed in should be contained in the face's surface. Otherwise, the outcome may not be accurate. Note, that when the model_type is facetted and the face is non planar, the result may not be accurate, as the plane equation of a non planar face is not well defined.

Plugin Prototype

fzrt_error_td fz_objt_alys_is_pnt_inside_face(

fzrt_int | windex,
fz_objt_ptr | obj,
fzrt_int | findx,
fz_objt_model_type_enum | model_type,
fz_xyz_td * | pt,
fzrt_int * | where )

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.

pt [Input]

the point to test.

where [Result]

0 if the point is outside, 1 if it is inside, and 2 if it is on the face boundary

Returns

Error codes

Availability

6.0.0.0

Function Set

fz_model_fset

Defined in

fz_objt_alys_api.h