PK_FACE_delete_from_sheet

PK_ERROR_code_t                      PK_FACE_delete_from_sheet
(
--- received arguments ---
int                                  n_faces, --- number of faces
const PK_FACE_t                      faces[], --- array of faces
const PK_FACE_delete_from_sheet_o_t *options, --- options structure

--- returned arguments ---
int                           *const n_bodies,--- number of bodies
PK_BODY_t                    **const bodies   --- array of bodies
)


This function removes the specified 'faces' from a sheet body.


Specific Errors:
    PK_ERROR_bad_wire          deleting face or faces would result in an
                               invalid wire body
    PK_ERROR_not_in_same_body  supplied faces are not from same body
    PK_ERROR_not_sheet         body containing faces is not a sheet



Each face must be the face of a sheet body, with or without a surface attached.
The options structure allows control over whether splitting the body is
permissible or not.

If the input body is not disjoint and the 'allow_disjoint' option is
PK_LOGICAL_false, the function will return an array containing multiple
bodies if the body is split during the operation.  If set to PK_LOGICAL_true
the function will always return a single body which may be disjoint if the
sheet body has been split.  If the input body was originally disjoint then the
function will always return a single body, the function will essentially behave
as if 'allow_disjoint' was set to PK_LOGICAL_true.

If the sheet body possesses faces that are not in the deletion list, the body
will remain a sheet body consisting only of these faces. If 'faces' contains
all the faces of a sheet body then when these faces are deleted any laminar
edges of the original sheet body will be preserved as a wire body. If there
are no laminar edges the function will fail with PK_ERROR_bad_wire.

In the case that the received sheet body is disjoint, a disjoint wire body will
only be produced if all the faces of that body are deleted.  If some of the
faces of the body are to be preserved, the function will delete components of
the disjoint body in any region of the body where all faces are removed.

You can use this function to create a profile, which then may be swept to form
a solid. See Pierce for more information.

You can also use this function when importing data. See
Importing topology for more information.