PK_clip_lattice_r_t

struct PK_clip_lattice_r_s
    {
    PK_clip_status_t     status;           --- status of clipped lattice
    PK_LATTICE_t         lattice;          --- lattice created by clipping
    int                  n_error_ltopols;  --- number of error ltopols
    PK_LTOPOL_t         *error_ltopols;    --- error ltopols
    int                  n_clipped_lballs; --- number of clipped lballs
    PK_LBALL_t          *clipped_lballs;   --- lballs affected by clipping
    PK_LBALL_clipped_t  *lball_clip_types; --- how each 'clipped_lball' was
                                           --- affected by the clip
    };
typedef struct PK_clip_lattice_r_s PK_clip_lattice_r_t;


A structure packaging a lattice created by clipping and associated information.

Used in:

PK_LATTICE_clip_r_t

The structure has the following fields:

'status'           The status of the lattice.

'lattice'          The lattice created by the clipping operation.

'n_error_ltopols'  The length of the 'error_ltopols' array.

'error_ltopols'    This array may contain lattice topologies related to the
                   clip status.

'n_clipped_lballs' If requested, the length of the 'clipped_lballs' and
                   'lball_clip_types' arrays, otherwise zero.

'clipped_lballs'   The lballs that have been created by the clipping operation
                   or that were touched by one of the clipping entities. This
                   will be set to NULL if 'want_clipped_lballs' was set to
                   PK_LOGICAL_false.

'lball_clip_types' Whether each 'clipped_lball' was created at a clipped lrod
                   or touched by a clipping entity. This will be set to NULL if
                   'want_clipped_lballs' was set to PK_LOGICAL_false.