PK_BODY_find_facesets_o_t   

struct PK_BODY_find_facesets_o_s
    {
    int                  o_t_version;       --- version number of option struct
    PK_boolean_region_t  selector;          --- faceset selector
                                            --- (PK_boolean_off_c)
    PK_LOGICAL_t         alternate;         --- whether to return alternating
                                            --- facesets (PK_LOGICAL_false)
    int                  n_selecting_topol; --- no of selecting topologies (0)
    PK_TOPOL_t          *selecting_topol;   --- selecting topologies (NULL)
    PK_LOGICAL_t         want_bounds;       --- whether to return bounding
                                            --- edges (PK_LOGICAL_false)
    };

typedef struct PK_BODY_find_facesets_o_s PK_BODY_find_facesets_o_t;



This option structure contains optional controls for PK_BODY_find_facesets.

Used in:

PK_BODY_find_facesets



Description of fields:

'selector'              Used to specify which facesets are returned when one or
                        more 'selecting_topol' are specified.
                        Permitted values are:

                        o PK_boolean_off_c: all facesets will be returned,
                                            regardless of whether any
                                            'selecting_topol' are specified.
                                            This is the default.

                        o PK_boolean_include_c: if 'alternate' is
                                                PK_LOGICAL_false, only those
                                                facesets that include the
                                                specified 'selecting_topol'
                                                will be returned.

                        o PK_boolean_exclude_c: if 'alternate' is
                                                PK_LOGICAL_false, only those
                                                facesets that do not include
                                                the specified 'selecting_topol'
                                                will be returned.

                        See the description of 'alternate' for details about
                        how 'selector' works when 'alternate' is
                        PK_LOGICAL_true.

'alternate'             If it is set to PK_LOGICAL_true, alternating facesets,
                        will be returned starting with the supplied
                        'selecting_topol'.
                        The 'selecting_topol' must contain only one topology.
                        The default is PK_LOGICAL_false.

                        The exact facesets that are returned depends on the
                        value of 'selector', as follows:

                        o If 'selector' is PK_boolean_include_c, then the
                          facesets containing the 'selecting_topol' are
                          returned, the next outermost facesets are not
                          returned, the next outermost facesets are returned,
                          and so on.

                        o If 'selector' is PK_boolean_exclude_c, then the
                          facesets containing the 'selecting_topol' ARE NOT
                          returned, the next outermost facesets ARE returned,
                          the next outermost facesets are not returned,
                          and so on.

                        o If 'selector' is PK_boolean_off_c, all facesets are
                          returned, regardless of the value of 'alternate'.

                        See Finding facesets in the Functional
                        Description for more information.

'n_selecting_topol'     Indicates the number of elements in 'selecting_topol'.

'selecting_topol'       Contains topologies that will be used to select
                        the returned facesets (see 'alternate' and 'selector'
                        to understand the selection).
                        If 'selector' is set to PK_boolean_off_c
                        or if 'selecting_topol' is empty, then all found
                        facesets will be returned.
                        If 'alternate' is set to PK_LOGICAL_true, then
                        the array must contain only one topology.

                        If a topology in 'selecting_topol' belongs to several
                        facesets, all the facesets will be selected with
                        regards to 'selector'.

'want_bounds'           If it is set to PK_LOGICAL_false then no bounding
                        edges will be returned.

                        If it is set to PK_LOGICAL_true then bounding edges,
                        if any, will be returned for each faceset.

                        Note that facesets may not be bound by any of the
                        input edges. This can happen when a faceset contains
                        all the back faces of a shell in the body.

                        If no edges are supplied, then this option will have
                        no effect.