PK_LATTICE_clip_o_t

struct PK_LATTICE_clip_o_s
    {
    int                    o_t_version;     --- version number of options
                                            --- structure.
    int                    n_clip_entities; --- the number of 'clip_entities'
                                            --- supplied. (0)
    const PK_ENTITY_t     *clip_entities;   --- entities with which to clip the
                                            --- lattice. (NULL)
    const PK_clip_fence_t *fence;           --- which side of each entity clips
                                            --- the lattice. (NULL)
    PK_LROD_clip_t         lrod_clip;       --- specifies whether lrods survive
                                            --- when clipped.
                                            --- (PK_LROD_clip_keep_connected_c)
    double                 lrod_min_length; --- length below which clipped
                                            --- lrods are deleted. (0.0)
    PK_LROD_coi_t          lrod_coi;        --- specifies whether lrods
                                            --- coincident with one or more
                                            --- clipping entities survive.
                                            --- (PK_LROD_coi_keep_connected_c)
    PK_LBALL_radius_t      lball_radius;    --- controls the radius of any new
                                            --- lballs created by clipping.
                                            --- (PK_LBALL_radius_interpolate_c)
    PK_LOGICAL_t           want_clipped_lballs;
                                            --- whether lballs created or
                                            --- affected by the clip should be
                                            --- returned. (PK_LOGICAL_false)
    PK_LTOPOL_dup_merge_t  merge_duplicates;
                                            --- whether duplicate ltopologies
                                            --- created by the clip should be
                                            --- merged.
                                            --- (PK_LTOPOL_dup_merge_no_c)
    double                 duplicate_tolerance;
                                            --- tolerance used in merging of
                                            --- duplicate ltopologies. (0.0)
    };
typedef struct PK_LATTICE_clip_o_s PK_LATTICE_clip_o_t;



This structure contains optional controls for PK_LATTICE_clip.

Used in:

PK_LATTICE_clip

The options provided are:

'n_clip_entities'           The number of entities supplied in 'clip_entities'
                            with which the lattice will be clipped.

'clip_entities'             An array of 'n_clip_entities' entities with which
                            to clip the lattice. These must be faces or a
                            single surface.

'fence'                     An array of 'n_clip_entities' flags specifying
                            the side of the corresponding entry in
                            'clip_entities' on which lattice topologies
                            survive.

'lrod_clip'                 Specifies the survival conditions for clipped
                            lrods.

'lrod_min_length'           If set to a value greater than session precision,
                            specifies the minimum length for a clipped lrod to
                            survive.

'lrod_coi'                  Specifies the survival conditions for lrods
                            coincident with one or more clipping entities.

'lball_radius'              Controls the radii of any new lballs created at
                            surviving lrods.

'want_clipped_lballs'       Controls whether an array of lballs affected by the
                            clipping operation is returned.

'merge_duplicates'          Whether duplicate ltopologies created by the clip
                            should be merged. If this is
                            PK_LTOPOL_dup_merge_yes_c, then
                            'duplicate_tolerance' sets the maximum distance
                            between lball positions, variation in lball radii,
                            and variation in lball_lrod_radii at which lballs
                            can be considered duplicates of one another. If
                            this is PK_LTOPOL_dup_merge_no_c, then
                            'duplicate_tolerance' is ignored.

'duplicate_tolerance'       The tolerance used in the merging of duplicate
                            ltopologies if 'merge_duplicates' is
                            PK_LTOPOL_dup_merge_yes_c. If this is not provided
                            then the merging will be performed to session
                            precision.