PK_FACE_details_hole_o_t

struct PK_FACE_details_hole_o_s
    {
    int                 o_t_version;       --- options structure version number
    PK_VECTOR_t         up;                --- up vector for through holes
                                           --- ( 0.0, 0.0, 1.0 )
    PK_LOGICAL_t        include_zero_depth;--- whether zero depth components
                                           --- are to be returned
                                           --- ( PK_LOGICAL_true )
    PK_LOGICAL_t        want_profiles;     --- whether wire body profiles are
                                           --- to be returned
                                           --- ( PK_LOGICAL_false )
    PK_LOGICAL_t        simplify_geom;     --- whether simplified geometry is
                                           --- required ( PK_LOGICAL_false )
    PK_detail_hole_cb_f_t
                        cb;                --- callback function ( NULL )
    PK_POINTER_t        cb_context;        --- context for callback function
                                           --- ( NULL )
    PK_LOGICAL_t        face_tracking;     --- whether extra face tracking
                                           --- information is returned in
                                           --- PK_hole_component_t
                                           --- ( PK_LOGICAL_false )
    };
typedef struct PK_FACE_details_hole_o_s PK_FACE_details_hole_o_t;



This structure contains hole classification options.

Used in:

PK_FACE_classify_details_o_t

It has the following fields:

'up'                 for through holes, the hole's 'origin' will be placed at
                     that end of the hole which makes the DOT product of the
                     hole's 'origin's 'axis' and the 'up' vector positive.

'include_zero_depth' whether the array of 'components' in the
                     PK_detail_def_hole_t should include
                     PK_hole_comp_zero_depth_in_c and
                     PK_hole_comp_zero_depth_out_c components.  This setting
                     has no effect on the content of the 'faces' array
                     returned in the PK_detail_def_t.

'want_profiles'      whether wire body profiles are to be returned in the
                     'profile' field of a PK_detail_def_hole_t.  Such profiles,
                     if requested, produce the shape of the hole when spun
                     around the hole's axis.

'simplify_geom'      whether original model geometry or simplified geometry
                     should be returned in the 'entity' field of a
                     PK_hole_component_t. If this is set to PK_LOGICAL_false,
                     then the returned geometry will be the actual geometry of
                     the model. If this is set to PK_LOGICAL_true, then the
                     simplest geometry which can represent the shape of the
                     component will be returned.

'cb'                 callback function.  If this is not NULL, then it will be
                     called for each recognized hole and passed the
                     PK_detail_def_hole_t for that hole.  The callback
                     function must return an integer which will be copied into
                     the 'cb_result' result field of the PK_detail_def_hole_c
                     which is returned from PK_FACE_classify_details.  This
                     integer may record an application's classification of the
                     hole.

'cb_context'         context pointer for callback function.  This pointer
                     allows an application to pass any necessary information
                     into and out of its callback function.

'face_tracking'      whether surfaces or groups containing the surface and
                     split faces should be returned in the 'entity' field of a
                     PK_hole_component_t. If this is set to PK_LOGICAL_false,
                     then the returned 'entity' will be the surface. If this
                     is set to PK_LOGICAL_true, then new groups will be
                     created containing the surface and all faces that make up
                     the component and will be returned.